Built by Maven

Introduction

This is a brief introduction for the functionality of the TP-ACL module. An Open Source an free usage project, also for commercial purpose under Apache License 2.

The usage of this library is strict defined by the implicit API and layer architecture. All functions are described in the Java Docs Comments of the Interfaces, located in the business package.

<dependency>
    <groupId>io.github.together.modules</groupId>
    <artifactId>acl</artifactId>
    <version>${version}</version>
</dependency>

All released artifacts are deployed to Maven Central. Here you will find an overview of available versions and components. Each deployed Release is tagged in the SCM.

Kick Start: Build & modify the last revision from the SCM

To run an own build in a local development environment, its necessary to follow some simple prerequisite:

  • checkout source repository TP-ACL
  • checkout source repository TP-CM
  • have an PostgreSQL DBMS installation (check the readme.md for details)

The together platform use the Maven filter technology for token replacement. The specific property files database and mail in the /src/main/filter directory holds configuration parameters which are changeable during the build. The necessity of a change is only for configure an own workspace to run your own builds. The in the JAR included configuration files can be used as templates to integrate functionality in your own project.

Exceptions

The module contains a set of custom Exceptions, which defined for the implemented services. The following list gives an overview which Exception is available:

Utils

org.europa.together.utils.Constraints: is a collection of helpful system wide constants.

org.europa.together.utils.Validator: is an simple helper based on regular expressions (RegEx). The most checks are defined as RegEx pattern which can be used in the validate() method.

org.europa.together.utils.StringUtils: contains a collection of some useful methods e. g. Hash, UUID, Converters and a File Write.

org.europa.together.utils.FileUtils: provides some simple file operations like read, write and append.

Architectural overview

All TP applications following an internal layer architecture, were each layer is represented by a own package. The Access between the layers is from TOP to DOWN. That means the lowest prioritized Layer, the Domain Layer can accessed from all layers above. itself has the no other layers then himself. Technically it means that Domain Objects has no import from other layers. The image below demonstrate the used layer architecture.

Layer Architecture