|
SMILA (incubation) API documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.smila.http.server.util.ARequestHandler
org.eclipse.smila.http.server.json.JsonRequestHandler
org.eclipse.smila.jobmanager.httphandler.JobHandler
public class JobHandler
Implements the handling of HTTP requests on a single job definition.
URL pattern: smila/jobmanager/jobs/-jobname-/
Methods allowed: GET, DELETE, POST
Field Summary | |
---|---|
static java.lang.String |
KEY_CURRENT
The key for the current. |
static java.lang.String |
KEY_DEFINITION
The key for the definition. |
static java.lang.String |
KEY_HISTORY
The key for the history. |
static java.lang.String |
KEY_JOB_ID
The key for the job id. |
static java.lang.String |
KEY_MODE
The key for the mode. |
static java.lang.String |
KEY_RUNS
The key for the runs. |
static java.lang.String |
KEY_STATE
The key for the state. |
static java.lang.String |
KEY_URL
The key for the url. |
Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler |
---|
FACTORY |
Constructor Summary | |
---|---|
JobHandler()
|
Method Summary | |
---|---|
protected void |
activate(ComponentContext context)
OSGi Declarative Services service activation method. |
protected void |
deactivate(ComponentContext context)
clean up JobManager on service shutdown. |
protected int |
getErrorStatus(java.lang.String method,
java.lang.String requestUri,
java.lang.Throwable ex)
Adds HTTP result code 400 ("BAD_REQUEST") for IllegalArgumentException, IllegalJobStateException or InvalidConfigException (bad input format) 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 |
setJobManager(JobManager jobManager)
Sets the reference to the JobManager service. |
void |
unsetJobManager(JobManager jobManager)
Resets the reference to the JobManager service to null if the given jobManager instance is set. |
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 |
---|
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 |
---|
public static final java.lang.String KEY_DEFINITION
public static final java.lang.String KEY_JOB_ID
public static final java.lang.String KEY_STATE
public static final java.lang.String KEY_URL
public static final java.lang.String KEY_CURRENT
public static final java.lang.String KEY_RUNS
public static final java.lang.String KEY_HISTORY
public static final java.lang.String KEY_MODE
Constructor Detail |
---|
public JobHandler()
Method Detail |
---|
protected void activate(ComponentContext context)
activate
in class ARequestHandler
context
- OSGi service component context.protected void deactivate(ComponentContext context)
context
- OSGi service context.public java.lang.Object process(java.lang.String method, java.lang.String requestUri, Record inputRecord) throws java.lang.Exception
process
in class JsonRequestHandler
method
- HTTP methodrequestUri
- request URI.inputRecord
- input record parsed either from request body, if it has content, or from request URI parameters.
Record
, you have to provide a
JsonRequestHandler.writeResultObject(OutputStream, Object)
method, too.
java.lang.Exception
- any failure during processing.protected int getErrorStatus(java.lang.String method, java.lang.String requestUri, java.lang.Throwable ex)
JsonRequestHandler.getErrorStatus(String, String, Throwable)
.
getErrorStatus
in class JsonRequestHandler
method
- HTTP methodrequestUri
- request URIex
- an exception
JsonHttpUtils#getErrorStatus(String, String, Throwable)
protected boolean isValidMethod(java.lang.String method, java.lang.String requestUri)
isValidMethod
in class JsonRequestHandler
method
- HTTP methodrequestUri
- request URI
public void setJobManager(JobManager jobManager)
jobManager
- the reference to the JobManager service.public void unsetJobManager(JobManager jobManager)
jobManager
- the reference to the current JobManager service.
|
SMILA (incubation) API documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |