Skip to content

Integration

Jump to bottom Edit New page
Andreas Rudolph edited this page Nov 11, 2015 · 32 revisions

Integration

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

Download release package

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

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

  • OpenEstate-IS24-REST folder contains the core library.

    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.3-SNAPSHOT.jar is the compiled core library.
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.3-SNAPSHOT-javadoc.jar contains javadocs of the core library.
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.3-SNAPSHOT-sources.jar contains sources of the core library.
    • OpenEstate-IS24-REST/lib folder contains dependencies for the core library.

  • OpenEstate-IS24-REST-examples folder contains the library with usage examples.

    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-examples-0.3-SNAPSHOT.jar is the compiled examples library.
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-examples-0.3-SNAPSHOT-javadoc.jar contains javadocs of the examples library.
    • OpenEstate-IS24-REST/OpenEstate-IS24-REST-examples-0.3-SNAPSHOT-sources.jar contains sources of the examples library.

  • OpenEstate-IS24-REST-hc42 folder contains the addon library for Apache HttpComponents 4.2.

    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.3-SNAPSHOT.jar is the compiled addon library.
    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.3-SNAPSHOT-javadoc.jar contains javadocs of the addon library.
    • OpenEstate-IS24-REST-hc42/OpenEstate-IS24-REST-hc42-0.3-SNAPSHOT-sources.jar contains sources of the addon library.
    • OpenEstate-IS24-REST-hc42/lib folder contains dependencies for the addon library.

  • OpenEstate-IS24-REST-hc43 folder contains the addon library for Apache HttpComponents 4.3.

    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.3-SNAPSHOT.jar is the compiled addon library.
    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.3-SNAPSHOT-javadoc.jar contains javadocs of the addon library.
    • OpenEstate-IS24-REST-hc43/OpenEstate-IS24-REST-hc43-0.3-SNAPSHOT-sources.jar contains sources of the addon library.
    • OpenEstate-IS24-REST-hc43/lib folder contains dependencies for the addon library.

  • OpenEstate-IS24-REST-webapp folder contains the example web application.

    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.3-SNAPSHOT.war is the web archive with the complete web application.
    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.3-SNAPSHOT-javadoc.jar contains javadocs of the web application.
    • OpenEstate-IS24-REST-webapp/OpenEstate-IS24-REST-webapp-0.3-SNAPSHOT-sources.jar contains sources of the web application.

  • 3rdparty folder contains sources, javadocs and license texts of third party libraries.

  • docs folder contains documentations from the project wiki.

  • javadoc folder contains generated javadoc for the complete library.

  • xsd folder contains XML schemas, that were used to generate JAXB classes in the core library.

  • CONTRIBUTING.md contains notes about how to contribute to this project.

  • LICENSE.txt contains the license text.

  • README.md contains the project readme.

  • TERMS-IS24.md contains a copy of the terms of use by IS24.

Add dependencies to your application

At least you need to add OpenEstate-IS24-REST/OpenEstate-IS24-REST-0.3-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.3-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.3-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