com.whizzosoftware.hobson.api.action

Class SingleAction

java.lang.Object

com.whizzosoftware.hobson.api.action.SingleAction

All Implemented Interfaces:

Action

public abstract class SingleAction
extends java.lang.Object
implements Action

Represents an action that does a single operation.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
SingleAction(PluginContext pluginContext, ActionExecutionContext executionContext, EventLoopExecutor executor) Constructor.

Method Summary

Modifier and Type	Method and Description
protected ActionExecutionContext	getContext()
boolean	isAssociatedWithPlugin(PluginContext ctx) Indicates whether this action is associated with a particular plugin.
abstract void	onMessage(ActionLifecycleContext ctx, java.lang.String msgName, java.lang.Object prop) Callback received when the action is sent a message.
abstract void	onStart(ActionLifecycleContext ctx) Callback received when the action is started.
abstract void	onStop(ActionLifecycleContext ctx) Callback received when the action is manually stopped.
Future	sendMessage(ActionLifecycleContext ctx, java.lang.String msgName, java.lang.Object prop) Sends a message to the action.
Future	start(ActionLifecycleContext ctx) Starts the action.
Future	stop(ActionLifecycleContext ctx) Stops the action.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleAction

public SingleAction(PluginContext pluginContext,
                    ActionExecutionContext executionContext,
                    EventLoopExecutor executor)

Constructor.

Parameters:

pluginContext - the plugin that provides this action

executionContext - an ActionExecutionContext implementation

executor - the event loop executor to use when executing this action

Method Detail

isAssociatedWithPlugin

public boolean isAssociatedWithPlugin(PluginContext ctx)

Description copied from interface: Action

Indicates whether this action is associated with a particular plugin.

Specified by:

isAssociatedWithPlugin in interface Action

Parameters:

ctx - the plugin context

Returns:

a boolean

onStart

public abstract void onStart(ActionLifecycleContext ctx)

Callback received when the action is started.

Parameters:

ctx - the lifecycle context

onMessage

public abstract void onMessage(ActionLifecycleContext ctx,
                               java.lang.String msgName,
                               java.lang.Object prop)

Callback received when the action is sent a message.

Parameters:

ctx - the lifecycle context

msgName - the name of the event

prop - a property object (specific to the event)

onStop

public abstract void onStop(ActionLifecycleContext ctx)

Callback received when the action is manually stopped.

Parameters:

ctx - the lifecycle context

getContext

protected ActionExecutionContext getContext()

sendMessage

public Future sendMessage(ActionLifecycleContext ctx,
                          java.lang.String msgName,
                          java.lang.Object prop)

Description copied from interface: Action

Sends a message to the action.

Specified by:

sendMessage in interface Action

Parameters:

ctx - the lifecycle context

msgName - the name of the message

prop - a property object

Returns:

a Future

start

public Future start(ActionLifecycleContext ctx)

Description copied from interface: Action

Starts the action.

Specified by:

start in interface Action

Parameters:

ctx - the lifecycle context

Returns:

a Future

stop

public Future stop(ActionLifecycleContext ctx)

Description copied from interface: Action

Stops the action.

Specified by:

stop in interface Action

Parameters:

ctx - the lifecycle context

Returns:

a Future