org.eclipse.smila.processing.httphandler
Class PipeletHandler

java.lang.Object
  org.eclipse.smila.http.server.util.ARequestHandler
      org.eclipse.smila.http.server.json.JsonRequestHandler
          org.eclipse.smila.processing.httphandler.PipeletHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class PipeletHandler
extends JsonRequestHandler

Implements the handling of HTTP requests for reading the description file of a pipelet.

Field Summary

static java.lang.String

EXCEPTION_MESSAGE Exception message if no description has been found.

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

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

PipeletHandler()

Method Summary

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	setPipeletTracker(PipeletTracker pipeletTracker) set PipeletTracker reference.
void	unsetPipeletTracker(PipeletTracker pipeletTracker) remove PipeletTracker reference.

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

getErrorStatus, 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

Field Detail

EXCEPTION_MESSAGE

public static final java.lang.String EXCEPTION_MESSAGE

Exception message if no description has been found.

See Also:

Constant Field Values

Constructor Detail

PipeletHandler

public PipeletHandler()

Method Detail

isValidMethod

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

Checks if the handler allows the HTTP method. Only GET is supported.

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. 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.

setPipeletTracker

public void setPipeletTracker(PipeletTracker pipeletTracker)

set PipeletTracker reference.

Parameters:

pipeletTracker - PipeletTracker

unsetPipeletTracker

public void unsetPipeletTracker(PipeletTracker pipeletTracker)

remove PipeletTracker reference.

Parameters:

pipeletTracker - PipeletTracker