SMILA (incubation) API documentation

org.eclipse.smila.processing.httphandler
Class PipelineHandler

java.lang.Object
  extended by org.eclipse.smila.http.server.util.ARequestHandler
      extended by org.eclipse.smila.http.server.json.JsonRequestHandler
          extended by org.eclipse.smila.processing.httphandler.PipelineHandler
All Implemented Interfaces:
HttpHandler, RequestHandler

public class PipelineHandler
extends JsonRequestHandler

Implements the handling of HTTP requests for reading workflow definitions.

Author:
drazen

Field Summary
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
 
Constructor Summary
PipelineHandler()
           
 
Method Summary
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 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, getSuccessStatus, handle, 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

PipelineHandler

public PipelineHandler()
Method Detail

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.

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.

Specified by:
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.

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:
JsonHttpUtils#getErrorStatus(String, String, Throwable)

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

SMILA (incubation) API documentation