org.dmd.dmp.server.servlet.base.interfaces

Interface RequestTrackerIF

All Known Implementing Classes:

BasicRequestTrackerPlugin

public interface RequestTrackerIF

The RequestTrackerIF defines a component that decouples the handling of incoming Dark Matter Protocol Requests from the various components that service those Requests.

Method Summary

Modifier and Type	Method and Description
void	bindDefaultRequestHandler(DmpRequestProcessorIF requestProcessor) If you bind a default request handler, any requests that aren't handled by your class specific request processors will be sent to this handler.
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 request, DmpResponseHandlerIF handler, int timeoutSeconds) This method allows you to submit a request with a specified timeout value.
void	processResponse(org.dmd.dmp.server.extended.Response response) This method forwards the specified response back to the appropriate response handler.
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.

Method Detail

bindDefaultRequestHandler

void bindDefaultRequestHandler(DmpRequestProcessorIF requestProcessor)

If you bind a default request handler, any requests that aren't handled by your class specific request processors will be sent to this handler.

Parameters:

requestProcessor -

bindRequestProcessor

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.

Parameters:

clazz - The class of Request handled by the processor.

requestProcessor - The request processor.

processRequest

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.

Parameters:

req - The request.

responseHandler - Where to send the responses.

Returns:

the integer ID of this processing operation.

processRequest

int processRequest(org.dmd.dmp.server.extended.Request request,
                   DmpResponseHandlerIF handler,
                   int timeoutSeconds)

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

Parameters:

request - The request.

handler - Where to send the response.

timeoutSeconds - The time out delay.

processSynchronousRequest

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.

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.

processResponse

void processResponse(org.dmd.dmp.server.extended.Response response)

This method forwards the specified response back to the appropriate response handler.

Parameters:

response - the response to be forwarded.