SMILA 1.0 API documentation

org.eclipse.smila.jobmanager.httphandler
Class WorkflowRunHandler

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.jobmanager.httphandler.AJobManagerHandler
              extended by org.eclipse.smila.jobmanager.httphandler.WorkflowRunHandler
All Implemented Interfaces:
HttpHandler, RequestHandler

public class WorkflowRunHandler
extends AJobManagerHandler

Implements the handling of HTTP requests to get workflow run information. URL pattern: smila/jobmanager/jobs/-jobname-/-jobid-/workflowrun/-workflowrunid-


Field Summary
 
Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler
FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS
 
Constructor Summary
WorkflowRunHandler()
           
 
Method Summary
protected  int getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex)
          Adapt error handling of JsonRequestHandler.getErrorStatus(String, String, Throwable). to JobManager exceptions: IllegalArgumentException, InvalidConfigException, InvalidDefinitionException, InvalidValueTypeException: 400 BAD REQUEST PersistenceException : 500 INTERNAL SERVER ERROR
 java.lang.Object process(java.lang.String method, java.lang.String requestUri, Record inputRecord)
          process input record and return result object.
 
Methods inherited from class org.eclipse.smila.jobmanager.httphandler.AJobManagerHandler
getDefinitionPersistence, getJobRunDataProvider, getJobRunEngine, getJobTaskProcessor, isDeleteRequest, isGetOrDeleteRequest, isGetOrPostRequest, isGetRequest, isPostRequest, isValidMethod, setDefinitionPersistence, setJobRunDataProvider, setJobRunEngine, setJobTaskProcessor, unsetDefinitionPersistence, unsetJobRunDataProvider, unsetJobRunEngine, unsetJobTaskProcessor
 
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

WorkflowRunHandler

public WorkflowRunHandler()
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.

getErrorStatus

protected int getErrorStatus(java.lang.String method,
                             java.lang.String requestUri,
                             java.lang.Throwable ex)
Description copied from class: AJobManagerHandler
Adapt error handling of JsonRequestHandler.getErrorStatus(String, String, Throwable). to JobManager exceptions:

Overrides:
getErrorStatus in class AJobManagerHandler
See Also:
HTTP_UTILS#getErrorStatus(String, String, Throwable)

SMILA 1.0 API documentation