Skip to content

Integration

Jump to bottom Edit New page
Andreas Rudolph edited this page Oct 28, 2014 · 32 revisions

Integration

The following page describes, how to integrate the library into your Java application. If you're using Maven, please follow the advices for Integration with Maven.

Download binary package

With each release we're providing a binary package, that contains all necessary files to work with OpenEstate-IS24-REST.

After you've extracted the binary package, you can find the following files and folders:

  • OpenEstate-IS24-REST - contains the core library
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.2-SNAPSHOT.jar - compiled core library
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.2-SNAPSHOT-javadoc.jar - javadocs of the core library
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.2-SNAPSHOT-sources.jar - sources of the core library
    • OpenEstate-IS24-REST/lib/* - dependencies for the core library
  • OpenEstate-IS24-REST-hc42 - additional files for Apache HttpComponents 4.2
    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.2-SNAPSHOT.jar - compiled addon library
    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.2-SNAPSHOT-javadoc.jar - javadocs of the addon library
    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.2-SNAPSHOT-sources.jar - sources of the addon library
    • OpenEstate-IS24-REST-hc42/lib/* - dependencies for the addon library
  • OpenEstate-IS24-REST-hc43 - additional files for Apache HttpComponents 4.3
    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.2-SNAPSHOT.jar - compiled addon library
    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.2-SNAPSHOT-javadoc.jar - javadocs of the addon library
    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.2-SNAPSHOT-sources.jar - sources of the addon library
    • OpenEstate-IS24-REST-hc43/lib/* - dependencies for the addon library
  • OpenEstate-IS24-REST-webapp - additional files for Apache HttpComponents 4.3
    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.2-SNAPSHOT.war - web archive with the complete web application
    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.2-SNAPSHOT-javadoc.jar - javadocs of the web application
    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.2-SNAPSHOT-sources.jar - sources of the web application
  • docs - documentations from the project wiki
  • javadoc - generated javadoc for the library including all addons
  • xsd - XML schemas, that were used to generate JAXB classes
  • LICENSE.txt - license text
  • README.md - project readme
  • TERMS-IS24.md - a copy of the terms of use by IS24

Add dependencies

At least you need to add OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.2-SNAPSHOT.jar and OpenEstate-IS24-REST/lib/*.jar to the dependencies of your application. In addition you can add one of the following addons:

  • If you want to use Apache HttpComponents 4.2, you also need to add OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.2-SNAPSHOT.jar and OpenEstate-IS24-REST-hc42/lib/*.jar to the dependencies of your application.

  • If you want to use Apache HttpComponents 4.3, you also need to add OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.2-SNAPSHOT.jar and OpenEstate-IS24-REST-hc43/lib/*.jar to the dependencies of your application.

Happy coding

From now on you can use OpenEstate-IS24-REST within your application. Have a look at the usage page for some example code.

Add a custom footer

Clone this wiki locally