org.eclipse.smila.scripting.httphandler

Class ScriptsHandler

java.lang.Object

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

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

org.eclipse.smila.scripting.httphandler.ScriptsHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class ScriptsHandler
extends JsonRequestHandler

Handles ReST calls for displaying infos about all scripts and functions.

Field Summary

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

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

Constructors

Constructor and Description
ScriptsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isGetRequest(java.lang.String method) accept GET requests.
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.
void	setScriptingEngine(ScriptingEngine scriptingEngine) set OSGI service.
void	unsetScriptingEngine(ScriptingEngine scriptingEngine) unset OSGI service.

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

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

ScriptsHandler

public ScriptsHandler()

Method Detail

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.

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.

setScriptingEngine

public void setScriptingEngine(ScriptingEngine scriptingEngine)

set OSGI service.

unsetScriptingEngine

public void unsetScriptingEngine(ScriptingEngine scriptingEngine)

unset OSGI service.