org.ow2.jasmine.probe.rest
Interface Outputs

All Known Implementing Classes:

JOutputs

public interface Outputs

Root resource class for outputs management. Contains methods to treat HTTP requests on "output" resources.

Author:

danesa

Field Summary

static String

RESOURCE_NAME

Method Summary

javax.ws.rs.core.Response	changeOutput(org.ow2.jasmine.probe.api.generated.OutputBaseType outputDef, String name) Process HTTP PUT requests having /output/{name} URI and updated output definition in its body.
javax.ws.rs.core.Response	createOutput(org.ow2.jasmine.probe.api.generated.OutputBaseType outputDef) Process HTTP POST requests having /output URI and new output definition in its body.
javax.ws.rs.core.Response	deleteOutput(String name) Process HTTP DELETE requests having /output/{name} URI Corresponds to output-remove name
javax.ws.rs.core.Response	getOutput(String name, javax.ws.rs.core.UriInfo ui) Process HTTP GET requests having /output/{name} URI Correspond to output-list -n name
javax.ws.rs.core.Response	getOutputs(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

getOutputs

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

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

Returns:

response containing the existent outputs

getOutput

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

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

Parameters:

name - output name

type -

Returns:

response

createOutput

javax.ws.rs.core.Response createOutput(org.ow2.jasmine.probe.api.generated.OutputBaseType outputDef)

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

Parameters:

outputDef - new output's definition

Returns:

response with state OK or BAD_REQUEST if create failed

changeOutput

javax.ws.rs.core.Response changeOutput(org.ow2.jasmine.probe.api.generated.OutputBaseType outputDef,
                                       String name)

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

Parameters:

outputDef - updated output definition

Returns:

response with state OK or NOT_FOUND or BAD_REQUEST if change failed

deleteOutput

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

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

Parameters:

name - the name of the output to remove

Returns:

response with state OK or NOT_FOUND