com.sonicsw.mf.mgmtapi.runtime
Interface IActivationDaemonProxy

public interface IActivationDaemonProxy

Remote interface to a runtime instance of an ActivationDaemon.

Management attributes and operations are documented in this interface.

An implementation of this interface can be created using the MFProxyFactory class. Each implementation instance is valid for the life of the provided JMS/JMX Connector and MBean ObjectName. The implementation is built using remote JMX MBeanServer calls.

For each JMX MBean attribute, this interface provides an associated get method (for readable attributes) and/or a set method (for writable attributes).

For each JMX MBean operation, this interface provides an associated method with a signature as described by the MBean's operation meta-data. Each JMX MBean operation has an associated impact:

• ACTION - Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.
• INFO - Indicates that the operation is read-like, it basically returns information.
• ACTION/INFO - Indicates that the operation is both read-like and write-like.
• UNKNOWN - Indicates that the operation has an "unknown" nature.

All exceptions emitted by implementations are wrapped as a ProxyRuntimeException.

See Also:

ActivationDaemon Notifications,

Field Summary

static java.lang.String	SYSTEM_STATE_ACTIVATE_NOTIFICATION_ID Notification type constant for the notification system.state.Activate.
static java.lang.String	SYSTEM_STATE_DEACTIVATE_NOTIFICATION_ID Notification type constant for the notification system.state.Deactivate.
static java.lang.String	SYSTEM_STATE_FAILURE_NOTIFICATION_ID Notification type constant for the notification system.state.Failure.
static java.lang.String	SYSTEM_STATE_OFFLINE_NOTIFICATION_ID Notification type constant for the notification system.state.Offline.
static java.lang.String	SYSTEM_STATE_ONLINE_NOTIFICATION_ID Notification type constant for the notification system.state.Online.

Method Summary

void	activate(java.lang.String id) Invokes the activate operation.
void	addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback) Adds a notification listener.
void	clearError() Invokes the clearError operation.
void	deactivate(java.lang.String id) Invokes the deactivate operation.
AttributeList	getAttributes(java.lang.String[] attributeNames) Gets the values of several attributes of an ActivationDaemon component.
IChildContainerState[]	getChildStates() Invokes the getChildStates operation.
java.lang.String	getClassname() Gets the value of the Classname attribute.
java.lang.String	getClasspath() Gets the value of the Classpath attribute.
java.lang.String	getConfigID() Gets the value of the ConfigID attribute.
java.lang.String	getLastError() Gets the value of the LastError attribute.
java.lang.Integer	getLastErrorLevel() Gets the value of the LastErrorLevel attribute.
java.lang.String	getLastErrorLevelString() Gets the value of the LastErrorLevelString attribute.
java.lang.String	getReleaseVersion() Gets the value of the ReleaseVersion attribute.
java.lang.Short	getState() Gets the value of the State attribute.
java.lang.String	getStateString() Gets the value of the StateString attribute.
java.lang.Integer	getTraceMask() Gets the value of the TraceMask attribute.
java.lang.String	getTraceMaskValues() Gets the value of the TraceMaskValues attribute.
java.lang.Long	getUptime() Gets the value of the Uptime attribute.
void	launch(java.lang.String configID) Invokes the launch operation.
void	reload() Invokes the reload operation.
void	removeNotificationListener(NotificationListener listener) Removes a notification listener.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of an ActivationDaemon component.
void	setTraceMask(java.lang.Integer value) Sets the value of the TraceMask attribute.
void	start() Invokes the start operation.
void	stop() Invokes the stop operation.

Field Detail

SYSTEM_STATE_ACTIVATE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_ACTIVATE_NOTIFICATION_ID

Notification type constant for the notification system.state.Activate.

Description: Child container (re)launch complete.

See Also:

system.state.Activate

See Also:

Constant Field Values

SYSTEM_STATE_DEACTIVATE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_DEACTIVATE_NOTIFICATION_ID

Notification type constant for the notification system.state.Deactivate.

Description: Child container shutdown complete.

See Also:

system.state.Deactivate

See Also:

Constant Field Values

SYSTEM_STATE_FAILURE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_FAILURE_NOTIFICATION_ID

Notification type constant for the notification system.state.Failure.

Description: Child container process has died.

See Also:

system.state.Failure

See Also:

Constant Field Values

SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Offline.

Description: Component stop complete.

See Also:

system.state.Offline

See Also:

Constant Field Values

SYSTEM_STATE_ONLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Online.

Description: Component start complete.

See Also:

system.state.Online

See Also:

Constant Field Values

Method Detail

activate

void activate(java.lang.String id)

Invokes the activate operation.

(Re)Activates a child container according to the schedule and activation rules defined for the container.

Impact: ACTION

Parameters:

id - Runtime identity of the container to activate (e.g. "Domain1.Container1")

addNotificationListener

void addNotificationListener(NotificationListener listener,
                             NotificationFilter filter,
                             java.lang.Object handback)

Adds a notification listener.

An ActivationDaemon component publishes the following notifications:

• system.state.Activate
• system.state.Deactivate
• system.state.Failure
• system.state.Offline
• system.state.Online

Parameters:

listener - The listener object which will handle the notifications emitted component.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - The context to be sent to the listener when a notification is emitted.

See Also:

removeNotificationListener(javax.management.NotificationListener)

clearError

void clearError()

Invokes the clearError operation.

Clear existing error condition.

Impact: ACTION

See Also:

getLastErrorLevel()

deactivate

void deactivate(java.lang.String id)

Invokes the deactivate operation.

Shuts down an active child container and disables the child from being re-launched due to the activation schedule and rules defined for the container.

Impact: ACTION

Parameters:

id - Runtime identity of the container to deactivate (e.g. "Domain1.Container1")

getAttributes

AttributeList getAttributes(java.lang.String[] attributeNames)

Gets the values of several attributes of an ActivationDaemon component.

Getting multiple attribute values at once is typically more efficient than getting individual attribute values.

Readable attributes (and their datatypes) exposed by an ActivationDaemon are:

• Classname (java.lang.String)
• Classpath (java.lang.String)
• ConfigID (java.lang.String)
• LastError (java.lang.String)
• LastErrorLevel (java.lang.Integer)
• LastErrorLevelString (java.lang.String)
• ReleaseVersion (java.lang.String)
• State (java.lang.Short)
• StateString (java.lang.String)
• TraceMask (java.lang.Integer)
• TraceMaskValues (java.lang.String)
• Uptime (java.lang.Long)

Parameters:

attributeNames - A list of the attribute names of attributes to be retrieved.

Returns:

The list of the retrieved attributes.

See Also:

setAttributes(AttributeList)

getChildStates

IChildContainerState[] getChildStates()

Invokes the getChildStates operation.

Gets the runtime state for all of the child containers managemed by this daemon.

Impact: INFO

getClassname

java.lang.String getClassname()

Gets the value of the Classname attribute.

Returns:

Component classname.

getClasspath

java.lang.String getClasspath()

Gets the value of the Classpath attribute.

Returns:

Component classpath.

getConfigID

java.lang.String getConfigID()

Gets the value of the ConfigID attribute.

Returns:

Configuration identity.

getLastError

java.lang.String getLastError()

Gets the value of the LastError attribute.

Returns:

Last (uncleared) error condition.

getLastErrorLevel

java.lang.Integer getLastErrorLevel()

Gets the value of the LastErrorLevel attribute.

Returns:

Last (uncleared) error severity.

getLastErrorLevelString

java.lang.String getLastErrorLevelString()

Gets the value of the LastErrorLevelString attribute.

Returns:

Last (uncleared) error severity description.

getReleaseVersion

java.lang.String getReleaseVersion()

Gets the value of the ReleaseVersion attribute.

Returns:

Component release version.

getState

java.lang.Short getState()

Gets the value of the State attribute.

Returns:

Execution state of the component.

See Also:

getStateString(), IComponentState

getStateString

java.lang.String getStateString()

Gets the value of the StateString attribute.

Returns:

Description of the execution state of the component.

See Also:

getState(), IComponentState.STATE_TEXT

getTraceMask

java.lang.Integer getTraceMask()

Gets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

• 1 - verbose
• 2 - set attributes
• 4 - operation invoked
• 8 - notification sent
• 16 - child container exec
• 32 - child container stdout
• 64 - child container stderr

Returns:

Debug bit mask.

See Also:

setTraceMask(java.lang.Integer), getTraceMaskValues()

getTraceMaskValues

java.lang.String getTraceMaskValues()

Gets the value of the TraceMaskValues attribute.

Returns:

Possible TraceMask values.

See Also:

getTraceMask(), setTraceMask(java.lang.Integer)

getUptime

java.lang.Long getUptime()

Gets the value of the Uptime attribute.

Returns:

Execution time (milliseconds).

launch

void launch(java.lang.String configID)

Invokes the launch operation.

Dynamically launches the specified child container.

Impact: ACTION

Parameters:

configID - The configuration identity of the container to launch.

reload

void reload()

Invokes the reload operation.

Asynchronously reload the component and restart the component if it was previously online.

Impact: ACTION

removeNotificationListener

void removeNotificationListener(NotificationListener listener)

Removes a notification listener.

This method will remove all the information related to the given listener.

Parameters:

listener - The listener object which will handle the notifications emitted by the registered MBean.

See Also:

addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, Object)

setAttributes

AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of an ActivationDaemon component.

Setting multiple attribute values at once is typically more efficient than setting individual attribute values.

Settable attributes (and their datatypes) exposed by an ActivationDaemon are:

• TraceMask (java.lang.Integer)

Parameters:

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

See Also:

getAttributes(String[])

setTraceMask

void setTraceMask(java.lang.Integer value)

Sets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

• 1 - verbose
• 2 - set attributes
• 4 - operation invoked
• 8 - notification sent
• 16 - child container exec
• 32 - child container stdout
• 64 - child container stderr

Parameters:

value - Debug bit mask.

See Also:

getTraceMask(), getTraceMaskValues()

start

void start()

Invokes the start operation.

Start providing service.

Impact: ACTION

See Also:

stop()

stop

void stop()

Invokes the stop operation.

Stop providing service.

Impact: ACTION

See Also:

start()