4 Getting started

Currently the library is only available as source code files, which are managed using Maven5 projects. However, there will be a binary version as part of a Maven repository in the future.

For now you need to clone the repository and import the different Maven projects into your Java development environment and install (Maven Goal "install") them to use them. To make the import easier, the repository consists of two umbrella Maven projects, which contain several sub projects. The first umbrella project is named jtnc-core and contains all the core files sorted into Maven projects by their purpose that make up the TNC implementation. The second umbrella project is called jtnc-examples and contains all currently available implementation examples sorted into Maven projects by their purpose these should show you how to use the core files for your own project. For example to build an Access Requestor, a Policy Decision Point, an Integrity Measurement Collector or an Integrity Measurement Verifier.

The source files contain Javadoc6 style comments. If you want to create a documentation to look into, the Maven configuration includes entries to generate Javadoc based HTML documentation pages as well as JXR7 based HTML code pages. There are also configuration entries for UMLGraph8 which enable the inclusion of class diagrams in the Javadoc based HTML documentation pages. For UMLGraph to work properly, you should install Graphviz in your development environment (see the UMLGraph documentation for further instructions about this). To create a documentation use the Maven Goals "javadoc:javadoc" and "jxr:jxr". You can also find a current version of the source documentation here. Additionally most of the projects have a folder called doc. These folders contains further documentation elements such as *.ucls files containing UML class diagrams of chosen code parts, which can be read using ObjectAid9.

5Apache Maven: https://maven.apache.org/

6Javadoc: http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html

7Maven JXR: http://maven.apache.org/jxr/

8UMLGraph: http://www.umlgraph.org/

9ObjectAid: http://www.objectaid.com/