atavism.server.engine
Class EnginePlugin.PluginStateMessage

java.lang.Object
  atavism.msgsys.Message
      atavism.server.engine.EnginePlugin.PluginStateMessage

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

EnginePlugin

public static class EnginePlugin.PluginStateMessage
extends Message

Message used by plugins to announce various control states. for example, when a plugin comes up, it by default sends out an "Available" state so that other plugins know about its existance.

See Also:

Serialized Form

Field Summary

static java.lang.String	BuiltInStateAvailable The string that indicates that the plugin has finished initialization.
static java.lang.String	BuiltInStateStarting The string that indicates that the plugin has notified us that it has started initialization.
static java.lang.String	BuiltInStateUnknown The string that indicates that the plugin hasn't been heard from.

Constructor Summary

EnginePlugin.PluginStateMessage()
No-args constructor, required by marshalling.

EnginePlugin.PluginStateMessage(java.lang.String pluginName, java.lang.String state)
The constructor used by plugins.

Method Summary

java.lang.String	getPluginName() Getter for pluginName.
java.lang.String	getState() Getter for plugin state.
java.lang.String	getTargetPluginName() Getter for the string targetPluginName.
java.lang.String	getTargetSession() Getter for the sessionId
void	setPluginName(java.lang.String pluginName) Setter for pluginName.
void	setState(java.lang.String state) Setter for plugin state.
void	setTargetPluginName(java.lang.String pluginName) Setter for the string targetPluginName.
void	setTargetSession(java.lang.String sessionId) Setter for the string sessionId.

Methods inherited from class atavism.msgsys.Message

getEnqueueTime, getMsgId, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgType, toBytes

Methods inherited from class java.lang.Object

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

Field Detail

BuiltInStateAvailable

public static final java.lang.String BuiltInStateAvailable

The string that indicates that the plugin has finished initialization.

See Also:

Constant Field Values

BuiltInStateUnknown

public static final java.lang.String BuiltInStateUnknown

The string that indicates that the plugin hasn't been heard from.

See Also:

Constant Field Values

BuiltInStateStarting

public static final java.lang.String BuiltInStateStarting

The string that indicates that the plugin has notified us that it has started initialization.

See Also:

Constant Field Values

Constructor Detail

EnginePlugin.PluginStateMessage

public EnginePlugin.PluginStateMessage()

No-args constructor, required by marshalling.

EnginePlugin.PluginStateMessage

public EnginePlugin.PluginStateMessage(java.lang.String pluginName,
                                       java.lang.String state)

The constructor used by plugins.

Parameters:

pluginName - The string name of the plugin

state - The state of the plugin, one of BuiltInStateAvailable, BuiltInStateUnknown and BuiltInStateStarting.

Method Detail

setPluginName

public void setPluginName(java.lang.String pluginName)

Setter for pluginName.

Parameters:

pluginName - The string name of the plugin.

getPluginName

public java.lang.String getPluginName()

Getter for pluginName.

Returns:

The string name of the plugin

setState

public void setState(java.lang.String state)

Setter for plugin state.

Parameters:

state - The string plugin state.

getState

public java.lang.String getState()

Getter for plugin state.

Returns:

The string plugin state.

setTargetSession

public void setTargetSession(java.lang.String sessionId)

Setter for the string sessionId. When this is a response messsage, it needs to indicate both the sessionID and plugin name its responding to.

Parameters:

sessionId - The string sessionId.

getTargetSession

public java.lang.String getTargetSession()

Getter for the sessionId

Returns:

The string sessionId.

setTargetPluginName

public void setTargetPluginName(java.lang.String pluginName)

Setter for the string targetPluginName. When this is a response message, it needs to indicate what the target plugin for the response, also needs the session id.

Parameters:

pluginName - The string target plugin name.

getTargetPluginName

public java.lang.String getTargetPluginName()

Getter for the string targetPluginName.

Returns:

The string target plugin name.