org.eclipse.smila.jobmanager.httphandler
Class InitialTaskHandler

java.lang.Object
  org.eclipse.smila.http.server.util.ARequestHandler
      org.eclipse.smila.http.server.json.JsonRequestHandler
          org.eclipse.smila.jobmanager.httphandler.InitialTaskHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class InitialTaskHandler
extends JsonRequestHandler

Implements the handling of HTTP requests of a worker to obtain an initial task. URL pattern: -workerName-/initialTask/-jobName-/

Field Summary

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

FACTORY

Constructor Summary

InitialTaskHandler()

Method Summary

protected int	getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex) Adds HTTP result code 400 ("BAD_REQUEST") for IllegalArgumentException to the exception handling of JsonRequestHandler.getErrorStatus(String, String, Throwable).
protected int	getSuccessStatus(java.lang.String requestMethod, java.lang.String requestUri, Record inputRecord, java.lang.Object resultObject) return NO_CONTENT if no task was found.
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	setJobManager(JobManager jobManager) Called by DS to set the reference to the JobManager service.
void	unsetJobManager(JobManager jobManager) Called by DS to reset the reference to the JobManager service.

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

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

Constructor Detail

InitialTaskHandler

public InitialTaskHandler()

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.

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)

Adds HTTP result code 400 ("BAD_REQUEST") for IllegalArgumentException to the exception handling of JsonRequestHandler.getErrorStatus(String, String, Throwable).

Overrides:

getErrorStatus in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI

ex - an exception

Returns:

error status code.

See Also:

JsonHttpUtils#getErrorStatus(String, String, Throwable)

getSuccessStatus

protected int getSuccessStatus(java.lang.String requestMethod,
                               java.lang.String requestUri,
                               Record inputRecord,
                               java.lang.Object resultObject)

return NO_CONTENT if no task was found. Returns the success code.

Overrides:

getSuccessStatus in class JsonRequestHandler

Parameters:

requestMethod - HTTP method

requestUri - request URI

inputRecord - input record

resultObject - result object returned from process

Returns:

the status code to return for successful requests using the method and request URI.

isValidMethod

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

Checks if the handler allows the HTTP method. GET is currently the only valid method.

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.

setJobManager

public void setJobManager(JobManager jobManager)

Called by DS to set the reference to the JobManager service.

unsetJobManager

public void unsetJobManager(JobManager jobManager)

Called by DS to reset the reference to the JobManager service.