org.sandev.TaskHeap.ExternalSync
Class ExternalSyncNodeCtrl

java.lang.Object
  org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeCtrl

All Implemented Interfaces:

org.sandev.basics.nodecommon.ControlWrapper, ExternalSyncNodeCtrlMBean

public class ExternalSyncNodeCtrl

extends java.lang.Object

implements ExternalSyncNodeCtrlMBean, org.sandev.basics.nodecommon.ControlWrapper

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.ExternalSync.ExternalSyncNodeDecl
generator: org.sandev.generator.NodeStdMBeanGenerator
time: Dec 2, 2005 6:38:53 PM

Field Summary

protected ExternalSyncNode

node Aggregated node class instance

Constructor Summary

ExternalSyncNodeCtrl()
Default ctor initializes a new node instance.

ExternalSyncNodeCtrl(org.sandev.basics.nodecommon.Controllable node)
Controllable constructor.

ExternalSyncNodeCtrl(ExternalSyncNode node)
Node constructor.

Method Summary

org.sandev.basics.nodecommon.Controllable	getControllable() Wraps getNode
java.lang.String	getExternalPlanFailure() accessor for externalPlanFailure
java.lang.String	getExternalPlanSuccess() accessor for externalPlanSuccess
java.lang.String	getHttpAgentID() accessor for httpAgentID
int	getLogLevel() accessor for logLevel
java.lang.String	getLogLevelEnumSummary() enum value summary for logLevel
ExternalSyncNode	getNode() Initializing accessor for our local node instance.
java.lang.String	getNodeInstanceName() accessor for nodeInstanceName
java.lang.String	getSandNodeErrorMessage() accessor for sandNodeErrorMessage
int	getSandNodeState() accessor for sandNodeState
java.lang.String	getSandNodeStateEnumSummary() enum value summary for sandNodeState
java.lang.String	getServername() accessor for servername
void	info(java.lang.String text) Utility to log an informational message.
void	paramChanged(java.lang.String paramName) Our current MBean UIs are web browser pages that read the parameters each time the page is generated, so we don't currently react to parameter changes.
void	sandInitialize() Register and create this MBean
void	setControllable(org.sandev.basics.nodecommon.Controllable node) Passthrough to setNode
void	setExternalPlanFailure(java.lang.String val) mutator for externalPlanFailure
void	setExternalPlanSuccess(java.lang.String val) mutator for externalPlanSuccess
void	setHttpAgentID(java.lang.String val) mutator for httpAgentID
void	setLogLevel(int val) mutator for logLevel
void	setNode(ExternalSyncNode node) set the aggregated node instance.
void	setSandNodeErrorMessage(java.lang.String val) mutator for sandNodeErrorMessage
void	setSandNodeState(int val) mutator for sandNodeState
void	startService() Call the node startup processing when the service starts.
void	stateChanged(int prevState, int currState) React to a state change.
void	stopService() Call the node shutdown processing when the service stops.

Methods inherited from class java.lang.Object

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

Field Detail

node

protected ExternalSyncNode node

Aggregated node class instance

Constructor Detail

ExternalSyncNodeCtrl

public ExternalSyncNodeCtrl()

Default ctor initializes a new node instance. Do not use this to set up control for an existing node.

ExternalSyncNodeCtrl

public ExternalSyncNodeCtrl(ExternalSyncNode node)

Node constructor. Sets our node reference to the given node instance

ExternalSyncNodeCtrl

public ExternalSyncNodeCtrl(org.sandev.basics.nodecommon.Controllable node)

Controllable constructor. Sets our node reference by casting the given Controllable reference to a ExternalSyncNode

Method Detail

getNode

public ExternalSyncNode getNode()

Initializing accessor for our local node instance. If no instance was defined on creation, then this method creates a new instance to return.

setNode

public void setNode(ExternalSyncNode node)

set the aggregated node instance. This should generally be done at construction time.

info

public void info(java.lang.String text)

Utility to log an informational message. This calls through to our node log method if we have a node reference, otherwise it just calls System.out.println with the given text. This method does not call getNode(), so it is safe to use it during ctor and initialization processing.

stateChanged

public void stateChanged(int prevState,
                         int currState)

React to a state change. The state change may have come from this bean, or it may have come from another control interface. The node has embedded state change logic which protects against invalid or redundent state transitions, so we don't need to worry about protecting the calls here.

There are more state changes in SAND then there are in the ServiceMBean, so we only pick up on some of the more major state changes here, like running or stopped. Here's how the other ServiceMBean state transitions are handled:

• create: a new MBean instance is created by the root node in the process of walking the NodeInstance[]s in the Configuration. This gets called once, regardless of what happens to the contained node.
• destroy: typically the container calls the service, and the service shuts down the node. Notifications aren't necessary.

Specified by:

stateChanged in interface org.sandev.basics.nodecommon.ControlWrapper

paramChanged

public void paramChanged(java.lang.String paramName)

Our current MBean UIs are web browser pages that read the parameters each time the page is generated, so we don't currently react to parameter changes.

Specified by:

paramChanged in interface org.sandev.basics.nodecommon.ControlWrapper

setControllable

public void setControllable(org.sandev.basics.nodecommon.Controllable node)

Passthrough to setNode

Specified by:

setControllable in interface org.sandev.basics.nodecommon.ControlWrapper

getControllable

public org.sandev.basics.nodecommon.Controllable getControllable()

Wraps getNode

Specified by:

getControllable in interface org.sandev.basics.nodecommon.ControlWrapper

sandInitialize

public void sandInitialize()
                    throws org.sandev.basics.nodecommon.ControlWrapperException

Register and create this MBean

Specified by:

sandInitialize in interface org.sandev.basics.nodecommon.ControlWrapper

Throws:

org.sandev.basics.nodecommon.ControlWrapperException

startService

public void startService()
                  throws java.lang.Exception

Call the node startup processing when the service starts. This is public to allow for reflective access from an external control adaptor.

Throws:

java.lang.Exception

stopService

public void stopService()
                 throws java.lang.Exception

Call the node shutdown processing when the service stops. This is public to allow for reflective access from an external control adaptor.

Throws:

java.lang.Exception

getExternalPlanSuccess

public java.lang.String getExternalPlanSuccess()

accessor for externalPlanSuccess

Specified by:

getExternalPlanSuccess in interface ExternalSyncNodeCtrlMBean

setExternalPlanSuccess

public void setExternalPlanSuccess(java.lang.String val)

mutator for externalPlanSuccess

Specified by:

setExternalPlanSuccess in interface ExternalSyncNodeCtrlMBean

getExternalPlanFailure

public java.lang.String getExternalPlanFailure()

accessor for externalPlanFailure

Specified by:

getExternalPlanFailure in interface ExternalSyncNodeCtrlMBean

setExternalPlanFailure

public void setExternalPlanFailure(java.lang.String val)

mutator for externalPlanFailure

Specified by:

setExternalPlanFailure in interface ExternalSyncNodeCtrlMBean

getHttpAgentID

public java.lang.String getHttpAgentID()

accessor for httpAgentID

Specified by:

getHttpAgentID in interface ExternalSyncNodeCtrlMBean

setHttpAgentID

public void setHttpAgentID(java.lang.String val)

mutator for httpAgentID

Specified by:

setHttpAgentID in interface ExternalSyncNodeCtrlMBean

getNodeInstanceName

public java.lang.String getNodeInstanceName()

accessor for nodeInstanceName

Specified by:

getNodeInstanceName in interface ExternalSyncNodeCtrlMBean

getServername

public java.lang.String getServername()

accessor for servername

Specified by:

getServername in interface ExternalSyncNodeCtrlMBean

getSandNodeState

public int getSandNodeState()

accessor for sandNodeState

Specified by:

getSandNodeState in interface ExternalSyncNodeCtrlMBean

getSandNodeStateEnumSummary

public java.lang.String getSandNodeStateEnumSummary()

enum value summary for sandNodeState

Specified by:

getSandNodeStateEnumSummary in interface ExternalSyncNodeCtrlMBean

setSandNodeState

public void setSandNodeState(int val)

mutator for sandNodeState

Specified by:

setSandNodeState in interface ExternalSyncNodeCtrlMBean

getSandNodeErrorMessage

public java.lang.String getSandNodeErrorMessage()

accessor for sandNodeErrorMessage

Specified by:

getSandNodeErrorMessage in interface ExternalSyncNodeCtrlMBean

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.String val)

mutator for sandNodeErrorMessage

Specified by:

setSandNodeErrorMessage in interface ExternalSyncNodeCtrlMBean

getLogLevel

public int getLogLevel()

accessor for logLevel

Specified by:

getLogLevel in interface ExternalSyncNodeCtrlMBean

getLogLevelEnumSummary

public java.lang.String getLogLevelEnumSummary()

enum value summary for logLevel

Specified by:

getLogLevelEnumSummary in interface ExternalSyncNodeCtrlMBean

setLogLevel

public void setLogLevel(int val)

mutator for logLevel

Specified by:

setLogLevel in interface ExternalSyncNodeCtrlMBean