org.dmd.dmp.server.servlet.base.actions

Class ActionHandler

java.lang.Object

org.dmd.dmp.server.servlet.base.actions.ActionHandler

All Implemented Interfaces:

Runnable

public abstract class ActionHandler
extends Object
implements Runnable

The ActionImplementation serves as a common base for all actions that can be run in an asynchronous manner and cancelled if required.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ActionHandler.HeartbeatTask

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionManagerIF	actionManager
protected CacheIF	cache
protected org.dmd.util.BooleanVar	cancelled
static long	DEFAULT_HEARTBEAT_MS
protected org.slf4j.Logger	logger
protected org.dmd.dmp.server.extended.ActionRequest	request
protected Integer	serverActionID

Constructor Summary

Constructors

Constructor and Description
ActionHandler(Integer serverActionID, org.dmd.dmp.server.extended.ActionRequest request, ActionManagerIF actionManager, CacheIF cache, RequestTrackerIF requestTracker)

Method Summary

Modifier and Type	Method and Description
ActionManagerIF	actionManager()
void	cancel() We set the cancelled flag to true.
boolean	cancelled()
abstract org.dmd.dmp.server.extended.ActionResponse	canProceed() Derived implementations should overload this method to validate the parameters to the action or perform any other contextual checks to see if the action can proceed.
protected long	lastResponseTime()
protected void	lastResponseTime(long time)
org.dmd.dmp.server.extended.ActionRequest	request()
protected void	sendError(String message) This method sends an ActionResponse of type ERROR and sets it to be the last response.
protected void	sendProgressObject(org.dmd.dmc.DmcObject object) Sends a PROGRESSOBJECTS message with a single object.
protected void	sendProgressObjects(ArrayList<org.dmd.dmc.DmcObject> objects) Sends a PROGRESSOBJECTS message with multiple objects.
protected void	sendProgressText(String message) Sends a PROGRESSTEXT message.
protected void	sendResponse(org.dmd.dmp.server.extended.ActionResponse response) Call this to send associated responses back to the client.
Integer	serverActionID()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

DEFAULT_HEARTBEAT_MS

public static final long DEFAULT_HEARTBEAT_MS

See Also:

Constant Field Values

request

protected org.dmd.dmp.server.extended.ActionRequest request

actionManager

protected ActionManagerIF actionManager

cache

protected CacheIF cache

serverActionID

protected final Integer serverActionID

cancelled

protected volatile org.dmd.util.BooleanVar cancelled

logger

protected org.slf4j.Logger logger

Constructor Detail

ActionHandler

public ActionHandler(Integer serverActionID,
                     org.dmd.dmp.server.extended.ActionRequest request,
                     ActionManagerIF actionManager,
                     CacheIF cache,
                     RequestTrackerIF requestTracker)

Method Detail

actionManager

public ActionManagerIF actionManager()

Returns:

our associated action manager.

request

public org.dmd.dmp.server.extended.ActionRequest request()

Returns:

the request being serviced.

serverActionID

public Integer serverActionID()

Returns:

our unique action identifier.

cancel

public void cancel()

We set the cancelled flag to true. We don't know exactly when the action will stop, so we let the heartbeat timer continue.

cancelled

public boolean cancelled()

sendResponse

protected void sendResponse(org.dmd.dmp.server.extended.ActionResponse response)

Call this to send associated responses back to the client.

Note: this automatically adds the serverActionID that uniquely identifies the action running on the server.

Parameters:

response - the response to be sent.

lastResponseTime

protected long lastResponseTime()

lastResponseTime

protected void lastResponseTime(long time)

canProceed

public abstract org.dmd.dmp.server.extended.ActionResponse canProceed()

Derived implementations should overload this method to validate the parameters to the action or perform any other contextual checks to see if the action can proceed.

Returns:

an ActionResponse with a type of ERROR if a problem was found and null otherwise.

sendProgressObject

protected void sendProgressObject(org.dmd.dmc.DmcObject object)

Sends a PROGRESSOBJECTS message with a single object.

Parameters:

objects - the objects to be sent

sendProgressObjects

protected void sendProgressObjects(ArrayList<org.dmd.dmc.DmcObject> objects)

Sends a PROGRESSOBJECTS message with multiple objects.

Parameters:

objects - the objects to be sent

sendProgressText

protected void sendProgressText(String message)

Sends a PROGRESSTEXT message.

Parameters:

message - the progress message.

sendError

protected void sendError(String message)

This method sends an ActionResponse of type ERROR and sets it to be the last response. YOU SHOULD IMMEDIATELY RETURN FROM YOUR ACTION AFTER CALLING THIS!

Parameters:

message - the error message.