org.eclipse.smila.jobmanager.httphandler
Class JobHandler

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

All Implemented Interfaces:

HttpHandler, RequestHandler

public class JobHandler
extends JsonRequestHandler

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.
static java.lang.String	PARAM_RETURNRUNS key for the showJobRuns request parameter.

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

PARAM_RETURNRUNS

public static final java.lang.String PARAM_RETURNRUNS

key for the showJobRuns request parameter.

See Also:

Constant Field Values

KEY_DEFINITION

public static final java.lang.String KEY_DEFINITION

The key for the definition.

See Also:

Constant Field Values

KEY_JOB_ID

public static final java.lang.String KEY_JOB_ID

The key for the job id.

See Also:

Constant Field Values

KEY_STATE

public static final java.lang.String KEY_STATE

The key for the state.

See Also:

Constant Field Values

KEY_URL

public static final java.lang.String KEY_URL

The key for the url.

See Also:

Constant Field Values

KEY_CURRENT

public static final java.lang.String KEY_CURRENT

The key for the current.

See Also:

Constant Field Values

KEY_RUNS

public static final java.lang.String KEY_RUNS

The key for the runs.

See Also:

Constant Field Values

KEY_HISTORY

public static final java.lang.String KEY_HISTORY

The key for the history.

See Also:

Constant Field Values

KEY_MODE

public static final java.lang.String KEY_MODE

The key for the mode.

See Also:

Constant Field Values

Constructor Detail

JobHandler

public JobHandler()

Method Detail

activate

protected void activate(ComponentContext context)

OSGi Declarative Services service activation method. Must be explicitly called of the subclass implements its own activation method.

Overrides:

activate in class ARequestHandler

Parameters:

context - OSGi service component context.

deactivate

protected void deactivate(ComponentContext context)

clean up JobManager on service shutdown.

Parameters:

context - OSGi service context.

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, IllegalJobStateException or InvalidConfigException (bad input format) 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, DELETE and POST 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.

setJobManager

public void setJobManager(JobManager jobManager)

Sets the reference to the JobManager service.

Parameters:

jobManager - the reference to the JobManager service.

unsetJobManager

public void unsetJobManager(JobManager jobManager)

Resets the reference to the JobManager service to null if the given jobManager instance is set.

Parameters:

jobManager - the reference to the current JobManager service.