Skip to content
seb-kro edited this page May 27, 2015 · 41 revisions

Welcome

to the REST-OCD-Services wiki, the home of the RESTful Overlapping Community Detection (OCD) Service!

Note that this service is based on the LAS2peer Template Project. For general information on LAS2peer services, please refer also to that project and to the documentation of the underlying LAS2peer framework. This includes e.g. more detailed information in particularly on user management, running LAS2peer services or Swagger Documentation.

The OCD Service API and Web Client

The OCD Service is publicly accessible via https://api.learning-layers.eu/ocd/. Please note that you should get a user account to ensure that your data is safe since otherwise anybody can access, alter and delete it anonymously. To obtain a user account, please contact a responsible person from Chair i5 of RWTH Aachen University. For information on user authentication please refer to [User Management and Authentication](User Management and Authentication).

Along with the service we also provide a web client which also has its own project

The OCD Service

Important

The OCD Service is largely based on the commercial yFiles library. You will only be able to run it yourself if you have access to the archive y.jar. The Chair i5 of RWTH Aachen University has a license for that library. If you are affiliated with that institute, please contact somebody to obtain the library. Also, keep in mind that the archive mentioned above must under no circumstances be publicly deployed or otherwise made publicly available. Please refer to [Deploying the OCD Service](Deploying the OCD Service) for more information.

OCD Service

The service is developed using the Eclipse IDE, so we recommend you to stick to that tool for any work on this project.

Please refer to the following pages in order to obtain more information about the OCD Service.

  • [Project Structure](Project Structure)
  • [Build Process](Build Process)
  • [Running the OCD Service](Running the OCD Service)
  • [User Management and Authentication](User Management and Authentication)
  • [Deploying the OCD Service](Deploying the OCD Service)
  • [Database Configuration](Database Configuration)