org.sandev.tools.SANDPlatformRoot
Class SANDPlatformRootNodeCtrl

java.lang.Object
  org.sandev.tools.SANDPlatformRoot.SANDPlatformRootNodeCtrl

All Implemented Interfaces:

org.sandev.basics.nodecommon.ControlWrapper, SANDPlatformRootNodeCtrlMBean

public class SANDPlatformRootNodeCtrl
extends java.lang.Object
implements SANDPlatformRootNodeCtrlMBean, org.sandev.basics.nodecommon.ControlWrapper

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.tools.SANDPlatformRoot.SANDPlatformRootNodeDecl
generator: org.sandev.generator.NodeStdMBeanGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary

protected SANDPlatformRootNode

node Aggregated node class instance

Constructor Summary

SANDPlatformRootNodeCtrl()
Default ctor initializes a new node instance.

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

SANDPlatformRootNodeCtrl(SANDPlatformRootNode node)
Node constructor.

Method Summary

java.lang.String	getCharSerializerClassName() accessor for charSerializerClassName
org.sandev.basics.nodecommon.Controllable	getControllable() Wraps getNode
int	getLogLevel() accessor for logLevel
java.lang.String	getLogLevelEnumSummary() enum value summary for logLevel
SANDPlatformRootNode	getNode() Initializing accessor for our local node instance.
java.lang.String	getNodeInstanceFactoryClassName() accessor for nodeInstanceFactoryClassName
java.lang.String	getNodeInstanceName() accessor for nodeInstanceName
java.lang.String	getPropertiesPath() accessor for propertiesPath
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	setCharSerializerClassName(java.lang.String val) mutator for charSerializerClassName
void	setControllable(org.sandev.basics.nodecommon.Controllable node) Passthrough to setNode
void	setLogLevel(int val) mutator for logLevel
void	setNode(SANDPlatformRootNode node) set the aggregated node instance.
void	setNodeInstanceFactoryClassName(java.lang.String val) mutator for nodeInstanceFactoryClassName
void	setPropertiesPath(java.lang.String val) mutator for propertiesPath
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 SANDPlatformRootNode node

Aggregated node class instance

Constructor Detail

SANDPlatformRootNodeCtrl

public SANDPlatformRootNodeCtrl()

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

SANDPlatformRootNodeCtrl

public SANDPlatformRootNodeCtrl(SANDPlatformRootNode node)

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

SANDPlatformRootNodeCtrl

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

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

Method Detail

getNode

public SANDPlatformRootNode 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(SANDPlatformRootNode 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

getCharSerializerClassName

public java.lang.String getCharSerializerClassName()

accessor for charSerializerClassName

Specified by:

getCharSerializerClassName in interface SANDPlatformRootNodeCtrlMBean

setCharSerializerClassName

public void setCharSerializerClassName(java.lang.String val)

mutator for charSerializerClassName

Specified by:

setCharSerializerClassName in interface SANDPlatformRootNodeCtrlMBean

getNodeInstanceFactoryClassName

public java.lang.String getNodeInstanceFactoryClassName()

accessor for nodeInstanceFactoryClassName

Specified by:

getNodeInstanceFactoryClassName in interface SANDPlatformRootNodeCtrlMBean

setNodeInstanceFactoryClassName

public void setNodeInstanceFactoryClassName(java.lang.String val)

mutator for nodeInstanceFactoryClassName

Specified by:

setNodeInstanceFactoryClassName in interface SANDPlatformRootNodeCtrlMBean

getPropertiesPath

public java.lang.String getPropertiesPath()

accessor for propertiesPath

Specified by:

getPropertiesPath in interface SANDPlatformRootNodeCtrlMBean

setPropertiesPath

public void setPropertiesPath(java.lang.String val)

mutator for propertiesPath

Specified by:

setPropertiesPath in interface SANDPlatformRootNodeCtrlMBean

getNodeInstanceName

public java.lang.String getNodeInstanceName()

accessor for nodeInstanceName

Specified by:

getNodeInstanceName in interface SANDPlatformRootNodeCtrlMBean

getServername

public java.lang.String getServername()

accessor for servername

Specified by:

getServername in interface SANDPlatformRootNodeCtrlMBean

getSandNodeState

public int getSandNodeState()

accessor for sandNodeState

Specified by:

getSandNodeState in interface SANDPlatformRootNodeCtrlMBean

getSandNodeStateEnumSummary

public java.lang.String getSandNodeStateEnumSummary()

enum value summary for sandNodeState

Specified by:

getSandNodeStateEnumSummary in interface SANDPlatformRootNodeCtrlMBean

setSandNodeState

public void setSandNodeState(int val)

mutator for sandNodeState

Specified by:

setSandNodeState in interface SANDPlatformRootNodeCtrlMBean

getSandNodeErrorMessage

public java.lang.String getSandNodeErrorMessage()

accessor for sandNodeErrorMessage

Specified by:

getSandNodeErrorMessage in interface SANDPlatformRootNodeCtrlMBean

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.String val)

mutator for sandNodeErrorMessage

Specified by:

setSandNodeErrorMessage in interface SANDPlatformRootNodeCtrlMBean

getLogLevel

public int getLogLevel()

accessor for logLevel

Specified by:

getLogLevel in interface SANDPlatformRootNodeCtrlMBean

getLogLevelEnumSummary

public java.lang.String getLogLevelEnumSummary()

enum value summary for logLevel

Specified by:

getLogLevelEnumSummary in interface SANDPlatformRootNodeCtrlMBean

setLogLevel

public void setLogLevel(int val)

mutator for logLevel

Specified by:

setLogLevel in interface SANDPlatformRootNodeCtrlMBean