org.dmd.dmp.server.servlet.base.plugins

Class BasicRequestTrackerPlugin

java.lang.Object

org.dmd.dmp.server.servlet.base.DmpServletPlugin

org.dmd.dmp.server.servlet.base.plugins.BasicRequestTrackerPlugin

All Implemented Interfaces:

RequestTrackerIF

public class BasicRequestTrackerPlugin
extends DmpServletPlugin
implements RequestTrackerIF

The RequestTrackerPlugin implements the RequestTrackerIF interface and provides a standard mechanism of handling both synchronous and asynchronous Dark Matter Protocol Requests.

Field Summary

Fields inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

cache, pluginConfig, pluginManager, servlet

Constructor Summary

Constructors

Constructor and Description
BasicRequestTrackerPlugin() Constructs a new RequestTrackerPlugin.

Method Summary

Modifier and Type	Method and Description
void	bindDefaultRequestHandler(DmpRequestProcessorIF requestHandler) This method allows you to bind a fall back request handler that will be called in the case that no handler has been bound for a particular class of request.
void	bindRequestProcessor(Class<? extends org.dmd.dmp.server.extended.Request> clazz, DmpRequestProcessorIF requestProcessor) This method binds a request processor to a particular class that's derived from the the DMP Request class.
int	processRequest(org.dmd.dmp.server.extended.Request req, DmpResponseHandlerIF responseHandler) This method allows you to submit a request and receive asynchronous responses via the response handler.
int	processRequest(org.dmd.dmp.server.extended.Request req, DmpResponseHandlerIF responseHandler, int timeoutSeconds) This method allows you to submit a request with a specified timeout value.
void	processResponse(org.dmd.dmp.server.extended.Response resp) When a request handler has a response available, it sends it back to the RequestTracker via this method.
org.dmd.dmp.server.extended.Response	processSynchronousRequest(org.dmd.dmp.server.extended.Request req, DmpResponseHandlerIF asyncResponseHandler, int timeoutSeconds) This method allows for synchronous processing of a request; this is generally used when service DMP requests that arrive via GWT RPC.

Methods inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

getID, getPluginName, init, preInit, setManagerAndConfig, shutdown, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicRequestTrackerPlugin

public BasicRequestTrackerPlugin()

Constructs a new RequestTrackerPlugin.

Method Detail

bindDefaultRequestHandler

public void bindDefaultRequestHandler(DmpRequestProcessorIF requestHandler)

This method allows you to bind a fall back request handler that will be called in the case that no handler has been bound for a particular class of request.

Specified by:

bindDefaultRequestHandler in interface RequestTrackerIF

Parameters:

requestHandler - the handler to call when a Request doesn't have a bound handler

bindRequestProcessor

public void bindRequestProcessor(Class<? extends org.dmd.dmp.server.extended.Request> clazz,
                                 DmpRequestProcessorIF requestProcessor)

This method binds a request processor to a particular class that's derived from the the DMP Request class. Generally speaking, the plugin that implements the CacheIF will register handlers for the Get, Set, Create and Delete requests; these are the standard CRUD operations. However, since the Dark Matter Protocol is extensible, you may have to register other handlers for new types of requests.

Specified by:

bindRequestProcessor in interface RequestTrackerIF

Parameters:

clazz - The class of Request handled by the processor.

requestProcessor - The request processor.

processRequest

public int processRequest(org.dmd.dmp.server.extended.Request req,
                          DmpResponseHandlerIF responseHandler)

This method allows you to submit a request and receive asynchronous responses via the response handler. In this case the default timeout of 2 seconds is applied to the request.

Specified by:

processRequest in interface RequestTrackerIF

Parameters:

req - The request.

responseHandler - Where to send the responses.

Returns:

the integer ID of this processing operation.

processSynchronousRequest

public org.dmd.dmp.server.extended.Response processSynchronousRequest(org.dmd.dmp.server.extended.Request req,
                                                                      DmpResponseHandlerIF asyncResponseHandler,
                                                                      int timeoutSeconds)

This method allows for synchronous processing of a request; this is generally used when service DMP requests that arrive via GWT RPC. Most operations will have a single response, but, in cases where asynchronous responses can occur e.g. when a GetRequest has a blockingFactor specified or for ActionRequests, the subsequent responses will be relayed via the event channel for the client.

Specified by:

processSynchronousRequest in interface RequestTrackerIF

Parameters:

req - The request.

asyncResponseHandler - The handler that will handle any responses beyond the first one.

timeoutSeconds - The timeout. This should be less than the standard HTTP session timeout.

Returns:

The initial response. If there are any others, they will be sent to the response handler.

processRequest

public int processRequest(org.dmd.dmp.server.extended.Request req,
                          DmpResponseHandlerIF responseHandler,
                          int timeoutSeconds)

This method allows you to submit a request with a specified timeout value.

Specified by:

processRequest in interface RequestTrackerIF

Parameters:

req - The request.

responseHandler - Where to send the response.

timeoutSeconds - The time out delay.

processResponse

public void processResponse(org.dmd.dmp.server.extended.Response resp)

When a request handler has a response available, it sends it back to the RequestTracker via this method.

Specified by:

processResponse in interface RequestTrackerIF

Parameters:

resp - A response for an outstanding request.