The artifacts provided through this repository are a collection of various "helper classes" extracted from and in use throughout several VATPlanner components.
The following artifacts are available, all prefixed vatplanner- to avoid naming confusion with another well-known
project:
vatplanner-commons-baseis the main module that tries to keep external dependencies as low as reasonably possible. It contains various utility classes incl. some basic handling of geo-coordinates as well as interfaces for separation from other modules.vatplanner-commons-amqpcontains abstractions to more conveniently work with AMQP using RabbitMQ. It has been separated from the base module because it relies on additional dependencies such ascom.rabbitmq:amqp-clientthat are generally not needed unless you actually want to communicate via AMQP.
You may want to combine this module withvatplanner-commons-cryptofor a really, really basic end-to-end encrypted message transport via AMQP (but heed the warnings below).vatplanner-commons-cryptocontains a very basic frontend to employ a stupidly simplified level of cryptography through PGP via PGPainless and Bouncy Castle.
Please note that security cannot be ensured. Do not blindly rely on this module unless you know what you are doing and have reviewed the code to be free of any concerns for your project. Functionality is specific to the scope of the VATPlanner project which means some (if not most) functionality may be insufficient and maybe not even cryptographically sane when used in other scopes.vatplanner-commons-adapter-jgitadds implementations to connect common interfaces to Eclipse JGit™ for handling Git® repository access (implemented:FileAccessProviderandVCSRepositoryControl).
Note that this is only a bridge to such repositories using the implementation provided by the upstream project. This module shall not be confused with any of the mentioned projects or organizations, see the Acknowledgements section below for more information.
Some of these classes may also be useful for projects other than just those associated with VATPlanner. Nevertheless, this repository should primarily be understood as an essential part of "just" VATPlanner.
At this point no particular guarantees for API stability will be given. Interfaces and availability of classes/methods may change seemingly "at random" as they are solely aligned with ongoing development of VATPlanner.
API documentation can be read online on javadoc.io:
vatplanner-commons-basevatplanner-commons-amqpvatplanner-commons-cryptovatplanner-commons-adapter-jgit
This project is released under MIT license.
Usage for AI training is subject to individual source licenses, there is no exception. This generally means that proper attribution must be given and disclaimers may need to be retained when reproducing relevant portions of training data. When incorporating source code, AI models generally become derived projects. As such, they remain subject to the requirements set out by individual licenses associated with the input used during training. When in doubt, all files shall be regarded as proprietary until clarified.
Unless you can comply with the licenses of this project you obviously are not permitted to use it for your AI training set. Although it may not be required by those licenses, you are additionally asked to make your AI model publicly available under an open license and for free, to play fair and contribute back to the open community you take from.
AI tools are not permitted to be used for contributions to this project. The main reason is that, as of time of writing, no tool/model offers traceability nor can today's AI models understand and reason about what they are actually doing. Apart from potential copyright/license violations the quality of AI output is doubtful and generally requires more effort to be reviewed and cleaned/fixed than actually contributing original work. Contributors will be asked to confirm and permanently record compliance with these guidelines.
Eclipse and Eclipse JGit are trademarks of Eclipse Foundation, Inc.
Git and the Git logo are either registered trademarks or trademarks of Software Freedom Conservancy, Inc., corporate home of the Git Project, in the United States and/or other countries.
This project (VATPlanner) has no affiliation with the mentioned trademark holders and shall not be confused with any of these projects and/or organizations. JGit and Git are only being mentioned to describe this project's dependencies and to acknowledge the trademarks as requested by the respective parties.
Please note that VATPlanner is a flight simulation project; check the other repositories and the main website for
more information. You may find several classes, particularly within vatplanner-commons-base that could theoretically
seem useful for "real-world" applications. However, due to the nature of this project,
using this project for real-world aviation purposes (in particular, but not limited to)
is highly discouraged.
This project is intended for flight simulation and may deviate from actual real-world standards.