My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
RestApiSpecification  
This page defines the REST API for all the services
Featured
Updated Aug 23, 2009 by harveysi...@gmail.com

Overview

The Hackystat Service Manager has an Agent , wich is a SOA service, for each Hackystat Service. These Agents are implemented in RESTlet and are presented here with their REST API specification. The Hackystat Service Manager is not a SOA service itself, it just communicates with the Agents. As the Agents are services they are intended to by very light by providing service to the HSM that implement just simple functions. The complex business logic is held in the Hackystat Service Manager itself. These functions are limits to two types: monitoring functions and execution functions.

For example: Monitoring the excessive heapsize of a service is a monitoring function and reconfiguring a configuration file of a service is an execution function. Restarting the service after reconfiguration should be another execution function.

Agents

Sensorbase Agent

METHOD URI EFFECT
GET {host}/start Starts the Hackystat service
GET {host}/stop Stops the Hackystat service
GET {host}/ping Pings the Hackystat service
GET {host}/heapsize Returns the maximal associated Heapsize of the service
PUT {host}/heapsize Sets the maximal heapsize of a service

DPD Agent

METHOD URI EFFECT
GET {host}/start Starts the Hackystat service
GET {host}/stop Stops the Hackystat service
GET {host}/ping Pings the Hackystat service

Telemetry Agent

METHOD URI EFFECT
GET {host}/start Starts the Hackystat service
GET {host}/stop Stops the Hackystat service
GET {host}/ping Pings the Hackystat service

Projectbrowser Agent

|| Stops the Hackystat service and returns its success
METHOD URI EFFECT
GET {host}/start Starts the Hackystat service and returns its success
GET {host}/stop

Tickertape Agent

METHOD URI EFFECT
GET {host}/start Starts the Hackystat service and returns its success
GET {host}/stops Stops the Hackystat service and returns its success

Details

As you can see all agents are following the same structure in the REST API, this is because the services should provide the same functionality for the HSM in order to apply monitoring and solutions service independent. This allows a growing knowledge for all services where solution for one service can be applied to any other service.

Here the REST API methods in detail:

All calls should follow a certain convention in order to let them operate with the HSM independently:

/start

Returns a String Representation "started" if successful

/stop

Returns a String Representation "stopped" if successful

/ping

Returns a String Representation "successful" if successful, otherwise the REST error from the previous call to the Hackystat service or "error" if the calls fails at all.

/heapsize

  • GET - Returns a String Representation with the number of Heap allocated f.ex. "512"
  • PUT - Interpretes a String Representation with the number of Heap allocated f.ex. "128"

Sign in to add a comment
Powered by Google Project Hosting