|
|
| (8 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | Make sure your environment is setup for OSLC4J development as instructed on [[Lyo/General_Setup_for_OSLC4J_Development | General Setup for OSLC4J development]]
| + | This page has moved to [http://oslc.github.io/developing-oslc-applications/eclipse_lyo/setup-an-oslc-provider-consumer-application.html Lyo's new documentation]. |
| − | | + | |
| − | = Sample Project =
| + | |
| − | | + | |
| − | As a complement when following the instructions below, this [[Media:OSLC4JSampleAdaptor.zip | sample OSLC4J project]] contains a basic but complete Eclipse project that can be used as a starting point and/or a reference.
| + | |
| − | | + | |
| − | The project is configured with the following values:
| + | |
| − | | + | |
| − | '''ProjectName''': ''SampleAdaptor''
| + | |
| − | '''PackageName''': ''your.basepackage.name''
| + | |
| − | | + | |
| − | If you desire to change the project configuration, search and replace in the files below each of the above keywords with the specific values for your project
| + | |
| − | | + | |
| − | * <code>.project</code>
| + | |
| − | * <code>pom.xml</code>
| + | |
| − | * <code>adaptorModel/my.adaptorInterface</code>
| + | |
| − | * <code>src/main/webapp/WEB-INF/web.xml</code>
| + | |
| − | * <code>src/test/resources/launches/Launch SampleAdaptor.launch</code>
| + | |
| − | | + | |
| − | If you get the error "Project configuration is not up-to-date with pom.xml", simply right click on the eclipse project and select '''Maven-->Update Project...'''.
| + | |
| − | | + | |
| − | = Setup an OSLC4J project =
| + | |
| − | '''Note''': This information is based on the tutorial from [[Media:The MBAT Tutorial on Implementing OSLC Consumers and Providers with OSLC4J - By Stefan Paschke ViF.pdf | The MBAT Tutorial on Implementing OSLC Consumers and Providers with OSLC4J - By Stefan Paschke ViF]].
| + | |
| − | | + | |
| − | The steps below guide you through the necessary steps of creating an Eclipse project with the necessary configurations to develop any OSLC4J adaptor.
| + | |
| − | | + | |
| − | In the instructions below, we assume an eclipse project named ''SampleAdaptor'', where the java classes are managed under the base package named <code>your.basepackage.name</code>.
| + | |
| − | | + | |
| − | ; Create a JAVA EE Web Application
| + | |
| − | :- '''File-->New-->Project...'''
| + | |
| − | :- Select ''Web/Dynamic Web Project''
| + | |
| − | :- As project name, specify ''SampleAdaptor''
| + | |
| − | :- On the final step of the wizard, check the '''Generate web.xml...''' option
| + | |
| − | :- Select '''Finish'''
| + | |
| − | ; Convert project to Maven
| + | |
| − | :- Right click on the project, and select '''Configure --> Convert to Maven Project'''
| + | |
| − | :- In the window that appears, select ''war'' under '''Packaging'''
| + | |
| − | ; Configure the project
| + | |
| − | :- Create a folder '''test''' at the root of the project
| + | |
| − | :- Create the sub-folders '''launches''' & '''resources''' under the new folder '''test'''
| + | |
| − | :- Copy the 3 configuration files from the [[Media:OSLC4JCodeGeneratorconfigurationFileTemplates.zip | Configuration File Templates]] into the corresponding folders:
| + | |
| − | ::- ''/SampleAdaptor/pom.xml''
| + | |
| − | ::- ''/SampleAdaptor/src/main/webapp/WEB-INF/web.xml''
| + | |
| − | ::- ''/SampleAdaptor/src/main/webapp/WEB-INF/jetty.xml''
| + | |
| − | ::- If necessary, refresh your Eclipse workspace by right clicking on ''SampleAdaptor -> Refresh''
| + | |
| − | :- If you choose a different name for your project and/or java package, search and replace these values in the project files as instructed under the [[Lyo/creating_OSLC4J_project#Sample_Project | Sample Project]] above.
| + | |
| − | ; Activate Project Facet JAX-RS
| + | |
| − | :- Right click the project & Select '''properties'''
| + | |
| − | :- Select the '''Project Facets''' window
| + | |
| − | :- Select '''JAX-RS (REST Web Services)'''
| + | |
| − | :- Click '''OK''' to commit the changes.
| + | |
| − | :- Right click again on the project & Select '''properties'''
| + | |
| − | :- select the new '''JAX-RS''' sub-window under '''Project Facets'''
| + | |
| − | :- Set '''Type:''' to ''Disable Library Configuration''
| + | |
| − | :- Enter '''JAX-RS servlet class name''': ''org.apache.wink.server.internal.servlet.RestServlet''
| + | |
| − | :- Under '''URL mapping patterns''':
| + | |
| − | ::- Remove the existing pattern
| + | |
| − | ::- Add a new pattern ''/services/*''
| + | |
| − | : '''Note:''' the above two steps (editing the JAX-RS servlet class name and the URL mapping patterns) are no longer available in the Eclipse Mars 4.5 Java EE dialog for the JAX-RS facet. The web.xml file can, of course, be manually edited to make the indicated changes.
| + | |
| − | :- Click '''OK''' to commit the changes.
| + | |
| − | ; Further project configuration
| + | |
| − | :- right click the project & select '''Properties'''
| + | |
| − | :- select '''Deployment Assembly'''
| + | |
| − | :- '''Add...'''
| + | |
| − | :- In the new window that appears
| + | |
| − | ::- select '''Java Build Path Entries'''
| + | |
| − | ::- click '''Next >'''
| + | |
| − | ::- select '''Maven Dependencies'''
| + | |
| − | ::- click '''Finish'''
| + | |
| − | ::- click '''Apply'''
| + | |
| − | ::- click '''OK'''
| + | |
| − | ; Create a new Run configuration
| + | |
| − | :- Select the menu '''Run-->Run Configurations...'''
| + | |
| − | :- Select '''Maven Build'''
| + | |
| − | :- Create a new Configuration (Right click on '''Maven Build -> New''')
| + | |
| − | :- Enter a '''name''' for the new configuration (such as ''"Launch SampleAdaptor"'')
| + | |
| − | :- Set the '''Base directory''' to ''${workspace_loc:/SampleAdaptor}''
| + | |
| − | :- Set '''Goal''' as ''jetty:run-exploded''
| + | |
| − | :- Switch to tab '''JRE'''
| + | |
| − | ::- Set '''Runtime JRE''' to ''Workspace default JRE...''
| + | |
| − | :- Switch to tab '''Source'''
| + | |
| − | ::- Click '''Add...'''
| + | |
| − | ::- In the new window, select '''Project''' and click '''OK'''
| + | |
| − | :::- Check the ''SampleAdaptor'' project
| + | |
| − | :::- Check the '''add required projects of selected projects''' option
| + | |
| − | :::- Click '''OK'''
| + | |
| − | :- Switch to Tab '''Common'''
| + | |
| − | ::- Select '''Shared file'''
| + | |
| − | ::- Click '''Browse...'''
| + | |
| − | ::- In the window that appears, select the recently created folder ''test/launches'' under the ''SampleAdaptor'' project
| + | |
| − | ::- click '''OK'''
| + | |
| − | :- Click '''Apply'''
| + | |
| − | :- Clock '''Close'''
| + | |
