|
|
| (13 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | = 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]. |
| − | You first need to setup an Eclipse environment for general OSLC4J development:
| + | |
| − | # Unless already installed, you need to first install the JDK 8 (see the [[Lyo/prereqs|prerequisites]]).
| + | |
| − | # Install your preferred Eclipse distribution. Which distribution to use?
| + | |
| − | #* [https://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/lunasr2 Eclipse IDE for Java EE Developers] seems to cover the necessary [[Lyo/prereqs|prerequisites for Building Lyo Projects]].
| + | |
| − | #* [https://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr2 Eclipse IDE for Java Developers] can be used, together with the following 2 additional plugins:
| + | |
| − | #** ''Eclipse Java EE Developer Tools''
| + | |
| − | #** ''Eclipse Java Web Developer Tools''
| + | |
| − | # Once Eclipse is installed, you need to make sure the '''JAVA_HOME''' environment variable is set to the installed JDK (instead of the default JRE).
| + | |
| − | ## Select '''''Window-->Preferences'''''
| + | |
| − | ## Select '''''Java-->Installed JREs'''''
| + | |
| − | ## Click '''''Add...'''''
| + | |
| − | ## In the new window that appears,
| + | |
| − | ### choose '''''Standard VM''''' as JRE Type
| + | |
| − | ### click '''''Next'''''.
| + | |
| − | ### As '''''JRE home''''' choose the installation dir of your JDK
| + | |
| − | ### click '''''Finish'''''.
| + | |
| − | ## Back to the preferences screen
| + | |
| − | ### select the old JRE
| + | |
| − | ### click '''''Remove'''''
| + | |
| − | ### check the newly added JDK and
| + | |
| − | ### click '''''OK'''''.
| + | |
| − | | + | |
| − | = 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 has a complete setup.
| + | |
| − | | + | |
| − | = Setup an OSLC4J project =
| + | |
| − | '''Note''': This information is based on the tutorial from [https://www.mbat-artemis.eu/home/index.php/dissemination/education-and-training?download=37:mbat-tutorial-implementing-oslc-consumers-and-providers-in-java-oslc4j-eclipse the MBAT Tutorial on Implementing OSLC Consumers and Providers with OSLC4J]
| + | |
| − | | + | |
| − | 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 will refer to the following generic terms, which need to be replaced with the appropriate values for your particular project.
| + | |
| − | '''ProjectName''': ''YourProviderProjectName''
| + | |
| − | '''PackageName''': ''your.basepackage.name''
| + | |
| − | | + | |
| − | # Create a JAVA EE Web Application
| + | |
| − | ## '''File-->New-->Project...'''
| + | |
| − | ## Select ''Web/Dynamic Web Project''
| + | |
| − | ## As project name, specify ''YourProviderProjectName''
| + | |
| − | ## 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:
| + | |
| − | ### ''/YourProviderProjectName/pom.xml''
| + | |
| − | ### ''/YourProviderProjectName/src/main/webapp/WEB-INF/web.xml''
| + | |
| − | ### ''/YourProviderProjectName/src/main/webapp/WEB-INF/jetty.xml''
| + | |
| − | ### If necessary, refresh your Eclipse workspace by right clicking on ''YourProviderProjectName -> Refresh''
| + | |
| − | ## Search and replace each of the following keywords with the specific values for your project
| + | |
| − | ### '''ProjectName:''' ''YourProviderProjectName''
| + | |
| − | ### '''PackageName:''' ''your.basepackage.name''
| + | |
| − | ## If you get the error "Project configuration is not up-to-date with pom.xml", simply right click on the ''YourProviderProjectName'' project and select '''Maven-->Update Project...'''.
| + | |
| − | # 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 (8 and 9) 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 YourProviderProjectName"'')
| + | |
| − | ## Set the '''Base directory''' to ''${workspace_loc:/YourProviderProjectName}''
| + | |
| − | ## 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 ''YourProviderProjectName'' 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 ''YourProviderProjectName'' project
| + | |
| − | ### click '''OK'''
| + | |
| − | ## Click '''Apply'''
| + | |
| − | ## Clock '''Close'''
| + | |
