SMILA 1.0 API documentation

org.eclipse.smila.jobmanager.httphandler
Class AJobManagerHandler

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
All Implemented Interfaces:
HttpHandler, RequestHandler
Direct Known Subclasses:
BucketHandler, BucketsHandler, DataObjectTypeHandler, DataObjectTypesHandler, InitialTaskHandler, JobHandler, JobManagerHandler, JobRunControlHandler, JobRunHandler, JobsHandler, WorkerHandler, WorkersHandler, WorkflowHandler, WorkflowRunHandler, WorkflowsHandler

public abstract class AJobManagerHandler
extends JsonRequestHandler

base class for JobManager ReST call handlers. Manages service reference to jobmanager, and adds common error handling.


Field Summary
 
Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler
FACTORY, HTTP_UTILS
 
Constructor Summary
AJobManagerHandler()
           
 
Method Summary
 DefinitionPersistence getDefinitionPersistence()
          get DefinitionPersistence service.
protected  int getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex)
          Adapt error handling of JsonRequestHandler.getErrorStatus(String, String, Throwable).
 JobRunDataProvider getJobRunDataProvider()
          get JobRunDataProvider service.
 JobRunEngine getJobRunEngine()
          get JobRunEngine service.
 JobTaskProcessor getJobTaskProcessor()
          get JobTaskProcessor service.
protected  boolean isDeleteRequest(java.lang.String method)
          accept DELETE requests.
protected  boolean isGetOrDeleteRequest(java.lang.String method)
          accept GET or DELETE requests.
protected  boolean isGetOrPostRequest(java.lang.String method)
          accept GET or POST requests.
protected  boolean isGetRequest(java.lang.String method)
          accept GET requests.
protected  boolean isPostRequest(java.lang.String method)
          accept POST requests.
protected  boolean isValidMethod(java.lang.String method, java.lang.String requestUri)
          Set GET instead of POST as basic method.
 void setDefinitionPersistence(DefinitionPersistence defPersistence)
          set OSGI service.
 void setJobRunDataProvider(JobRunDataProvider jobRunDataProvider)
          set OSGI service.
 void setJobRunEngine(JobRunEngine jobRunEngine)
          set OSGI service.
 void setJobTaskProcessor(JobTaskProcessor jobTaskProcessor)
          set OSGI service.
 void unsetDefinitionPersistence(DefinitionPersistence defPersistence)
          unset OSGI service.
 void unsetJobRunDataProvider(JobRunDataProvider jobRunDataProvider)
          unset OSGI service.
 void unsetJobRunEngine(JobRunEngine jobRunEngine)
          unset OSGI service.
 void unsetJobTaskProcessor(JobTaskProcessor jobTaskProcessor)
          unset OSGI service.
 
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

AJobManagerHandler

public AJobManagerHandler()
Method Detail

getJobRunDataProvider

public JobRunDataProvider getJobRunDataProvider()
get JobRunDataProvider service.


getJobRunEngine

public JobRunEngine getJobRunEngine()
get JobRunEngine service.


getJobTaskProcessor

public JobTaskProcessor getJobTaskProcessor()
get JobTaskProcessor service.


getDefinitionPersistence

public DefinitionPersistence getDefinitionPersistence()
get DefinitionPersistence service.


isValidMethod

protected boolean isValidMethod(java.lang.String method,
                                java.lang.String requestUri)
Set GET instead of POST as basic 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.

isGetRequest

protected boolean isGetRequest(java.lang.String method)
accept GET requests.


isPostRequest

protected boolean isPostRequest(java.lang.String method)
accept POST requests.


isDeleteRequest

protected boolean isDeleteRequest(java.lang.String method)
accept DELETE requests.


isGetOrDeleteRequest

protected boolean isGetOrDeleteRequest(java.lang.String method)
accept GET or DELETE requests.


isGetOrPostRequest

protected boolean isGetOrPostRequest(java.lang.String method)
accept GET or POST requests.


getErrorStatus

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:

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

setJobRunDataProvider

public void setJobRunDataProvider(JobRunDataProvider jobRunDataProvider)
set OSGI service.


unsetJobRunDataProvider

public void unsetJobRunDataProvider(JobRunDataProvider jobRunDataProvider)
unset OSGI service.


setJobRunEngine

public void setJobRunEngine(JobRunEngine jobRunEngine)
set OSGI service.


unsetJobRunEngine

public void unsetJobRunEngine(JobRunEngine jobRunEngine)
unset OSGI service.


setJobTaskProcessor

public void setJobTaskProcessor(JobTaskProcessor jobTaskProcessor)
set OSGI service.


unsetJobTaskProcessor

public void unsetJobTaskProcessor(JobTaskProcessor jobTaskProcessor)
unset OSGI service.


setDefinitionPersistence

public void setDefinitionPersistence(DefinitionPersistence defPersistence)
set OSGI service.


unsetDefinitionPersistence

public void unsetDefinitionPersistence(DefinitionPersistence defPersistence)
unset OSGI service.


SMILA 1.0 API documentation