SMILA (incubation) API documentation

org.eclipse.smila.taskmanager.httphandler
Class TaskStateHandler

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.taskmanager.httphandler.TaskStateHandler
All Implemented Interfaces:
HttpHandler, RequestHandler

public class TaskStateHandler
extends JsonRequestHandler

Implements the handling of HTTP requests for the task state API. URL pattern: smila/tasks/


Field Summary
 
Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler
FACTORY
 
Constructor Summary
TaskStateHandler()
           
 
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  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 setTaskManager(TaskManager taskManager)
           
 void unsetTaskManager(TaskManager taskManager)
           
 
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
 

Constructor Detail

TaskStateHandler

public TaskStateHandler()
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)

isValidMethod

protected boolean isValidMethod(java.lang.String method,
                                java.lang.String requestUri)
Checks if the handler allows the HTTP method. GET and DELETE are currently the only valid methods.

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.

setTaskManager

public void setTaskManager(TaskManager taskManager)
Parameters:
taskManager - the reference to the JobManager service.

unsetTaskManager

public void unsetTaskManager(TaskManager taskManager)
Parameters:
taskManager - the reference to the current JobManager service.

SMILA (incubation) API documentation