org.eclipse.smila.processing.httphandler

Class PipelinesHandler

java.lang.Object

org.eclipse.smila.http.server.util.ARequestHandler

org.eclipse.smila.http.server.json.JsonRequestHandler

org.eclipse.smila.processing.httphandler.PipelinesHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class PipelinesHandler
extends JsonRequestHandler

Implements the handling of HTTP requests for adding and listing pipeline definitions.

Author:

drazen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXCEPTION_MESSAGE Exception message if no definition has been found.

Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

Constructors

Constructor and Description
PipelinesHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex) Return a status code for an exception.
protected int	getSuccessStatus(java.lang.String method, java.lang.String requestUri) result status for POST requests should be CREATED.
protected boolean	isValidMethod(java.lang.String method, java.lang.String requestUri) Checks if the handler allows the HTTP method.
java.lang.Object	process(java.lang.String method, java.lang.String requestUri, Record inputRecord, HttpExchange exchange) process input record and return result object.
void	setProcessor(WorkflowProcessor processor) set workflow processor reference.
void	unsetProcessor(WorkflowProcessor processor) remove workflow processor reference.

Methods inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler

getRequestHost, getSuccessStatus, handle, process, writeErrorResult, writeResultObject, writeSuccessResult

Methods inherited from class org.eclipse.smila.http.server.util.ARequestHandler

activate, getDynamicUriParts, getRootContextPath, getStaticUriParts, getUriPattern, matches, urlDecode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCEPTION_MESSAGE

public static final java.lang.String EXCEPTION_MESSAGE

Exception message if no definition has been found.

See Also:

Constant Field Values

Constructor Detail

PipelinesHandler

public PipelinesHandler()

Method Detail

isValidMethod

protected boolean isValidMethod(java.lang.String method,
                    java.lang.String requestUri)

Checks if the handler allows the HTTP method. PipelineListHandler supports GET.

Overrides:

isValidMethod in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI

Returns:

true if the method can be used for the URI, else false.

process

public java.lang.Object process(java.lang.String method,
                       java.lang.String requestUri,
                       Record inputRecord,
                       HttpExchange exchange)
                         throws java.lang.Exception

process input record and return result object. Override this method in your handler if you need access to HttpExchange object, e.g. to read http header fields

Overrides:

process in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI.

inputRecord - input record parsed either from request body, if it has content, or from request URI parameters.

exchange - http exchange object, contains e.g. the http header fields

Returns:

result object, may be null. If this is not a Record, you have to provide a JsonRequestHandler.writeResultObject(OutputStream, Object) method, too.

Throws:

java.lang.Exception - any failure during processing.

getErrorStatus

protected int getErrorStatus(java.lang.String method,
                 java.lang.String requestUri,
                 java.lang.Throwable ex)

Description copied from class: JsonRequestHandler

Return a status code for an exception.

Overrides:

getErrorStatus in class JsonRequestHandler

See Also:

HTTP_UTILS#getErrorStatus(String, String, Throwable)

getSuccessStatus

protected int getSuccessStatus(java.lang.String method,
                   java.lang.String requestUri)

result status for POST requests should be CREATED.

Overrides:

getSuccessStatus in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI

Returns:

the status code to return for successful requests using the method and request URI. By default it is "OK" (200).

setProcessor

public void setProcessor(WorkflowProcessor processor)

set workflow processor reference.

Parameters:

processor - workflow processor

unsetProcessor

public void unsetProcessor(WorkflowProcessor processor)

remove workflow processor reference.

Parameters:

processor - workflow processor