org.eclipse.smila.processing.httphandler

Class AProcessHandler

java.lang.Object

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

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

org.eclipse.smila.processing.httphandler.AProcessHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

Direct Known Subclasses:

PipeletProcessHandler, PipelineProcessHandler

public abstract class AProcessHandler
extends JsonRequestHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AProcessHandler.EmptyQueryException special exception to denote empty queries ( -> BAD_REQUEST, not SERVER_ERROR).

Field Summary

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

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

Constructors

Constructor and Description
AProcessHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.String[]	doProcess(java.lang.String elementName, Blackboard blackboard, java.lang.String[] strings)
protected void	ensureQueryId(java.lang.String pipeletName, Record query) ensure that the query object has a Id set.
protected java.lang.String	getElementName(java.lang.String requestUri) get name of processing element to use.
protected int	getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex) Return a status code for an exception.
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) process input record and return result object.
void	setBlackboardFactory(BlackboardFactory factory) set blackboard factory reference (used by DS).
void	unsetBlackboardFactory(BlackboardFactory factory) remove blackboard factory reference (used by DS).

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

getRequestHost, getSuccessStatus, 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

Constructor Detail

AProcessHandler

public AProcessHandler()

Method Detail

process

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

process input record and return result object. Override this method in your handler if you do not need access to HttpExchange object, e.g. to read http header fields. Otherwise use overloaded method with HttpExchange parameter.

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.

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.

doProcess

protected abstract java.lang.String[] doProcess(java.lang.String elementName,
                           Blackboard blackboard,
                           java.lang.String[] strings)
                                         throws BlackboardAccessException,
                                                ProcessingException

Throws:

BlackboardAccessException

ProcessingException

getElementName

protected java.lang.String getElementName(java.lang.String requestUri)

get name of processing element to use.

setBlackboardFactory

public void setBlackboardFactory(BlackboardFactory factory)

set blackboard factory reference (used by DS).

unsetBlackboardFactory

public void unsetBlackboardFactory(BlackboardFactory factory)

remove blackboard factory reference (used by DS).

isValidMethod

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

Checks if the handler allows the HTTP method. PipelineHandler supports GET and POST.

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.

getErrorStatus

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

Return a status code for an exception. empty queries return BAD_REQUEST, not INTERNAL_SERVER_ERROR.

Overrides:

getErrorStatus in class JsonRequestHandler

See Also:

HTTP_UTILS#getErrorStatus(String, String, Throwable)

ensureQueryId

protected void ensureQueryId(java.lang.String pipeletName,
                 Record query)

ensure that the query object has a Id set. If none is provided by the client create one using the pipeline name as source and a random UUID as key.

Parameters:

pipeletName - pipeline name

query - query record.