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

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.AgentsHandler

All Implemented Interfaces:

HttpHandler, RequestHandler

public class AgentsHandler
extends BaseConnectivityHandler

Implements the handling of HTTP requests to request the agents list.
URL pattern: smila/agents/
Methods allowed: GET

Field Summary

static java.lang.String	KEY_AGENTS key for the agents.
static java.lang.String	KEY_NAME key for the name.
static java.lang.String	KEY_STATE key for the state.
static java.lang.String	KEY_URL key for the url.

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

FACTORY, HTTP_UTILS

Constructor Summary

AgentsHandler()

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

public static final java.lang.String KEY_AGENTS

key for the agents.

See Also:

Constant Field Values

KEY_NAME

public static final java.lang.String KEY_NAME

key for the name.

See Also:

Constant Field Values

KEY_STATE

public static final java.lang.String KEY_STATE

key for the state.

See Also:

Constant Field Values

KEY_URL

public static final java.lang.String KEY_URL

key for the url.

See Also:

Constant Field Values

Constructor Detail

AgentsHandler

public AgentsHandler()

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.

isValidMethod

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

Checks if the handler allows the HTTP method. only GET is 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 -