Integration

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:

• The docs folder contains the documentation files of OpenEstate-IS24-REST in Markdown format.

• The docs/javadoc subfolder contains the API documentation of all OpenEstate-IS24-REST components in HTML format.

• The docs/specs subfolder contains the format specifications used by the OpenEstate-IS24-REST components.

• The lib folder contains the JAR and WAR files of OpenEstate-IS24-REST.

• The lib/3rdparty subfolder contains the JAR files of 3rd party dependencies.

• CHANGELOG.md contains the changelog of this project.

• 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 lib/OpenEstate-IS24-REST-Core-0.6.jar and possibly required 3rd party libraries from lib/3rdparty to the dependencies of your application.

In addition you might add lib/OpenEstate-IS24-REST-HC4-0.6.jar in order to use Apache HttpClient.

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.