Integration

Integration

The following page describes how to integrate OpenEstate-IO 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-IO.

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

• docs folder contains documentations from the project wiki

• javadoc folder contains the complete API documentation of OpenEstate-IO

• lib folder contains compiled code, sources and javadocs of the OpenEstate-IO libraries

• lib/3rdparty folder contains compiled code, sources and javadocs of the dependencies

• specs folder contains specifications of the implemented formats

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

• LICENSE.txt contains the license text

• README.md contains the project readme

• README-*.md contains the readme of specific sub projects

• TERMS-OpenImmo.md contains a copy of the terms of use by OpenImmo e.V.

Add dependencies to your application

You need to add lib/OpenEstate-IO-Core-1.2-SNAPSHOT.jar, the library of the format you want to implement and the libraries from lib/3rdparty/*.jar to the dependencies of your application.

Happy coding

From now on you can use OpenEstate-IO within your application.