Introduction

This page gives you an overview over the file structure of the OCD Service Project. The focus will be set on the ocd directory where most service specific files are located (aside from the source code). Some other files will be discussed as well. For more information on the remaining files you may refer to the LAS2peer Template Project or LAS2peer documentation.

Source Code

The actual source code of the service is located under rest_ocd_services/src/main/java. The most important class here is probably the i5/las2peer/services/ocd/ServiceClass.java which contains the entire Service API.

The source code for the jUnit tests is in rest_ocd_services/src/test.

ArangoDB database configuration file config.properties is located in ocd/arangoDB directory. This file can be modified to adjust database used for WebOCD Service as well as tests. For more information please refer to Build Process.

OCD Directory

The ocd directory contains most files apart from the source code which are specific to the OCD Service. You will find the following subdirectories.

  • arangoDB: Contains the database configuration file.
  • eclipselink: Any log files for database creation or dropping created by the EclipseLink JPA persitence provider will be stored here.
  • test: Contains a folder with data files for jUnit test input. An additional folder for test output files may be created during the build.

Other Important Resources

  • bin: Comprises scripts for launching the service and generating Agents.
  • rest_ocd_services/export: This directory contains a copy of the service jar, the obfuscated service jar and jUnit test reports. Please refer to Build Process for more information.
  • service: This directory contains the service jar. Please refer to Build Process for more information.
  • bin/start_network.bat and bin/start_network.sh: Skripts for launching the OCD Service. Please refer to Running the OCD Service for more information.
  • etc/startup/passphrases.txt: Password storage for preinstalled users. Please refer to User Management and Authentication for more information.