org.ow2.jasmine.probe.rest
Interface Indicators

All Known Implementing Classes:

JIndicators

public interface Indicators

Root resource class for indicators management. Contains methods to treat HTTP requests on "indicator" resources.

Author:

danesa

Field Summary

static String

RESOURCE_NAME

Method Summary

javax.ws.rs.core.Response	changeIndicator(IndicatorBaseType indicatorDef, String name) Process HTTP PUT requests having /indicator/{name} URI and new indicator definition in its body.
javax.ws.rs.core.Response	createIndicator(IndicatorBaseType indicatorDef) Process HTTP POST requests having /indicator URI and new indicator definition in its body.
javax.ws.rs.core.Response	deleteIndicator(String name) Process HTTP DELETE requests having /indicator/{name} URI Corresponds to indicator-remove name
javax.ws.rs.core.Response	getIndicator(String name, javax.ws.rs.core.UriInfo ui) Process HTTP GET requests having /indicator/{name} URI Correspond to indicator-list -n name
javax.ws.rs.core.Response	getIndicators(String type, boolean verbose, javax.ws.rs.core.UriInfo ui) Process HTTP GET requests.

Field Detail

RESOURCE_NAME

static final String RESOURCE_NAME

See Also:

Constant Field Values

Method Detail

getIndicators

javax.ws.rs.core.Response getIndicators(String type,
                                        boolean verbose,
                                        @Context
                                        javax.ws.rs.core.UriInfo ui)

Process HTTP GET requests. Possible URIs are: /indicator that corresponds to 'indicator-list' command or /indicator?type={typeName} that corresponds to 'indicator-list -t typeName' command or /indicator?verbose="true" that corresponds to 'indicator-list -v' command

Returns:

response containing the existent indicators

getIndicator

javax.ws.rs.core.Response getIndicator(String name,
                                       @Context
                                       javax.ws.rs.core.UriInfo ui)

Process HTTP GET requests having /indicator/{name} URI Correspond to indicator-list -n name

Parameters:

name - indicator name

type -

Returns:

response

createIndicator

javax.ws.rs.core.Response createIndicator(IndicatorBaseType indicatorDef)

Process HTTP POST requests having /indicator URI and new indicator definition in its body. Corresponds to indicator-create command

Parameters:

indicatorDef - new indicator definition

Returns:

changeIndicator

javax.ws.rs.core.Response changeIndicator(IndicatorBaseType indicatorDef,
                                          String name)

Process HTTP PUT requests having /indicator/{name} URI and new indicator definition in its body. Corresponds to indicator-change -n name command.

Parameters:

indicatorDef - updated indicator definition

name - indicator name

Returns:

response with state OK or NOT_FOUND or BAD_REQUEST if change failed

deleteIndicator

javax.ws.rs.core.Response deleteIndicator(String name)

Process HTTP DELETE requests having /indicator/{name} URI Corresponds to indicator-remove name

Parameters:

name - the name of the indicator to remove