|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
All exceptions emitted by implementations are wrapped as a ProxyRuntimeException.
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 |
---|
static final java.lang.String SYSTEM_STATE_ACTIVATE_NOTIFICATION_ID
Description: Child container (re)launch complete.
system.state.Activate
static final java.lang.String SYSTEM_STATE_DEACTIVATE_NOTIFICATION_ID
Description: Child container shutdown complete.
system.state.Deactivate
static final java.lang.String SYSTEM_STATE_FAILURE_NOTIFICATION_ID
Description: Child container process has died.
system.state.Failure
static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID
Description: Component stop complete.
system.state.Offline
static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID
Description: Component start complete.
system.state.Online
Method Detail |
---|
void activate(java.lang.String id)
(Re)Activates a child container according to the schedule and activation rules defined for the container.
Impact: ACTION
id
- Runtime identity of the container to activate (e.g. "Domain1.Container1")void addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback)
An ActivationDaemon component publishes the following notifications:
system.state.Activate
system.state.Deactivate
system.state.Failure
system.state.Offline
system.state.Online
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.removeNotificationListener(javax.management.NotificationListener)
void clearError()
Clear existing error condition.
Impact: ACTION
getLastErrorLevel()
void deactivate(java.lang.String id)
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
id
- Runtime identity of the container to deactivate (e.g. "Domain1.Container1")AttributeList getAttributes(java.lang.String[] attributeNames)
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)
attributeNames
- A list of the attribute names of attributes to be retrieved.
setAttributes(AttributeList)
IChildContainerState[] getChildStates()
Gets the runtime state for all of the child containers managemed by this daemon.
Impact: INFO
java.lang.String getClassname()
java.lang.String getClasspath()
java.lang.String getConfigID()
java.lang.String getLastError()
java.lang.Integer getLastErrorLevel()
java.lang.String getLastErrorLevelString()
java.lang.String getReleaseVersion()
java.lang.Short getState()
getStateString()
,
IComponentState
java.lang.String getStateString()
getState()
,
IComponentState.STATE_TEXT
java.lang.Integer getTraceMask()
setTraceMask(java.lang.Integer)
,
getTraceMaskValues()
java.lang.String getTraceMaskValues()
getTraceMask()
,
setTraceMask(java.lang.Integer)
java.lang.Long getUptime()
void launch(java.lang.String configID)
Dynamically launches the specified child container.
Impact: ACTION
configID
- The configuration identity of the container to launch.void reload()
Asynchronously reload the component and restart the component if it was previously online.
Impact: ACTION
void removeNotificationListener(NotificationListener listener)
This method will remove all the information related to the given listener.
listener
- The listener object which will handle the notifications emitted by the registered MBean.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, Object)
AttributeList setAttributes(AttributeList attributes)
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)
attributes
- A list of attributes: The identification of the attributes to be set and the values they are to be set to.
getAttributes(String[])
void setTraceMask(java.lang.Integer value)
value
- Debug bit mask.getTraceMask()
,
getTraceMaskValues()
void start()
Start providing service.
Impact: ACTION
stop()
void stop()
Stop providing service.
Impact: ACTION
start()
|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |