org.eclipse.smila.jobmanager.httphandler
Class JobRunHandler

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

All Implemented Interfaces:

HttpHandler, RequestHandler

public class JobRunHandler
extends JsonRequestHandler

Implements the handling of HTTP requests on a single job run. URL pattern: smila/jobmanager/jobs/-jobname-/-jobid-

Field Summary

static java.lang.String

KEY_SHOW_DETAILS The key for the details.

Fields inherited from class org.eclipse.smila.http.server.json.JsonRequestHandler

FACTORY

Constructor Summary

JobRunHandler()

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 java.lang.String	getJobId(java.lang.String requestUri) Gets the job id from the requestUri.
protected java.lang.String	getJobName(java.lang.String requestUri) Gets the job name from the requestUri.
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

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

Field Detail

KEY_SHOW_DETAILS

public static final java.lang.String KEY_SHOW_DETAILS

The key for the details.

See Also:

Constant Field Values

Constructor Detail

JobRunHandler

public JobRunHandler()

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)

getJobName

protected java.lang.String getJobName(java.lang.String requestUri)

Gets the job name from the requestUri.

Parameters:

requestUri - the request URI.

Returns:

he job name from the requestUri.

getJobId

protected java.lang.String getJobId(java.lang.String requestUri)

Gets the job id from the requestUri.

Parameters:

requestUri - the request URI.

Returns:

he job name from the requestUri.

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.

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.