Modules

java.lang.Object

org.palladiosimulator.protocom.framework.java.ee.api.http.Modules

public final class Modules extends Object

API class for retrieving module data and starting modules.

Method Summary

Modifier and Type

Method

Description

javax.ws.rs.core.Response

getModules()

Gets all modules.

javax.ws.rs.core.Response

startModule(javax.ws.rs.core.UriInfo uriInfo, String id)

Starts the specified module.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getModules
  
  public javax.ws.rs.core.Response getModules()
  
  Gets all modules.
  
  Returns:
  
  a JSON array containing information about all modules
- startModule
  
  public javax.ws.rs.core.Response startModule(@Context javax.ws.rs.core.UriInfo uriInfo, String id)
  
  Starts the specified module.
  
  Parameters:
  
  uriInfo - the URI
  
  id - the ID of the module
  
  Returns:
  
  an HTTP 200 response if the module was started successfully