Integration

Andreas Rudolph edited this page Dec 9, 2018 · 17 revisions

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:

  • The docs folder contains documentations from the project wiki.

  • The docs/javadoc subfolder contains the complete API documentation of OpenEstate-IO.

  • The docs/specs subfolder contains specifications of the implemented formats.

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

  • The lib/3rdparty subfolder contains compiled code, sources and javadocs of the dependencies.

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

  • The LICENSE.txt file contains the license text.

  • The README.md file contains the project description.

  • The README-*.md files contain the descriptions for supported formats.

  • The TERMS-OpenImmo.md file 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.4.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.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.