org.eclipse.smila.connectivity.framework.httphandler
Class AgentControlHandler

java.lang.Object
  org.eclipse.smila.http.server.util.ARequestHandler
      org.eclipse.smila.http.server.json.JsonRequestHandler
          org.eclipse.smila.connectivity.framework.httphandler.BaseConnectivityHandler
              org.eclipse.smila.connectivity.framework.httphandler.AgentControlHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class AgentControlHandler
extends BaseConnectivityHandler

Implements the handling of HTTP requests to control (i.e. stop) an agent of a data-source.
URL pattern: smila/agents/<ds-id>/finish
Methods allowed: POST

Field Summary

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

FACTORY, HEADER_REQUEST_HOST, HTTP_UTILS

Constructor Summary

AgentControlHandler()

Method Summary

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.
protected void	setAgentController(AgentController agentController) OSGi method to set the AgentController.
protected void	unsetAgentController(AgentController agentController) OSGi method to unset the AgentController.

Methods inherited from class org.eclipse.smila.connectivity.framework.httphandler.BaseConnectivityHandler

getErrorStatus

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

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

AgentControlHandler

public AgentControlHandler()

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. Override this method in your handler if you do not need access to HttpExchange object, e.g. to read http header fields. Otherwise use overloaded method with HttpExchange parameter.

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.

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.

isValidMethod

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

Checks if the handler allows the HTTP method. only POST allowed.

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.

setAgentController

protected void setAgentController(AgentController agentController)

OSGi method to set the AgentController. Called by DS.

Parameters:

agentController -

unsetAgentController

protected void unsetAgentController(AgentController agentController)

OSGi method to unset the AgentController. Called by DS.

Parameters:

agentController -