org.eclipse.smila.jobmanager.httphandler

Class JobsHandler

java.lang.Object

org.eclipse.smila.http.server.util.ARequestHandler

org.eclipse.smila.http.server.json.JsonRequestHandler

org.eclipse.smila.jobmanager.httphandler.AJobManagerHandler

org.eclipse.smila.jobmanager.httphandler.JobsHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class JobsHandler
extends AJobManagerHandler

Implements the handling of HTTP requests to request the job list or to define new jobs.
URL pattern: smila/jobmanager/jobs/
Methods allowed: GET, POST

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_LATEST_JOB_RUN job run data of the most current job run.
static java.lang.String	KEY_RETURN_DETAILS The key for the details.

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

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

Constructors

Constructor and Description
JobsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	getSuccessStatus(java.lang.String method, java.lang.String requestUri) result status for POST requests should be CREATED.
protected boolean	isValidMethod(java.lang.String method, java.lang.String requestUri) Set GET instead of POST as basic method.
java.lang.Object	process(java.lang.String method, java.lang.String requestUri, Record inputRecord, HttpExchange exchange) process input record and return result object.

Methods inherited from class org.eclipse.smila.jobmanager.httphandler.AJobManagerHandler

getDefinitionPersistence, getErrorStatus, getJobRunDataProvider, getJobRunEngine, getJobTaskProcessor, isDeleteRequest, isGetOrDeleteRequest, isGetOrPostRequest, isGetRequest, isPostRequest, setDefinitionPersistence, setJobRunDataProvider, setJobRunEngine, setJobTaskProcessor, unsetDefinitionPersistence, unsetJobRunDataProvider, unsetJobRunEngine, unsetJobTaskProcessor

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

getRequestHost, 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

Field Detail

KEY_RETURN_DETAILS

public static final java.lang.String KEY_RETURN_DETAILS

The key for the details.

See Also:

Constant Field Values

KEY_LATEST_JOB_RUN

public static final java.lang.String KEY_LATEST_JOB_RUN

job run data of the most current job run.

See Also:

Constant Field Values

Constructor Detail

JobsHandler

public JobsHandler()

Method Detail

process

public java.lang.Object process(java.lang.String method,
                       java.lang.String requestUri,
                       Record inputRecord,
                       HttpExchange exchange)
                         throws java.lang.Exception

process input record and return result object. Override this method in your handler if you need access to HttpExchange object, e.g. to read http header fields

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.

exchange - http exchange object, contains e.g. the http header fields

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.

getSuccessStatus

protected int getSuccessStatus(java.lang.String method,
                   java.lang.String requestUri)

result status for POST requests should be CREATED.

Overrides:

getSuccessStatus in class JsonRequestHandler

Parameters:

method - HTTP method

requestUri - request URI

Returns:

the status code to return for successful requests using the method and request URI. By default it is "OK" (200).

isValidMethod

protected boolean isValidMethod(java.lang.String method,
                    java.lang.String requestUri)

Set GET instead of POST as basic method. GET and POST are currently the only valid methods.

Overrides:

isValidMethod in class AJobManagerHandler

Parameters:

method - HTTP method

requestUri - request URI

Returns:

true if the method can be used for the URI, else false.