com.sonicsw.mf.mgmtapi.runtime
Interface IAgentManagerProxy

public interface IAgentManagerProxy

Remote interface to a runtime instance of an AgentManager.

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.

Note: The Agent Manager receives and forwards all system state notifications published by all deployed components. Subscriptions to such notifications are allowed even though the Agent Manager does not describe those notifications in it's MBeanInfo.

See Also:

AgentManager Notifications, AgentManager Metrics

Field Summary

static java.lang.String	GLOBAL_ID The well known global component identity for this singleton component.
static java.lang.String	SYSTEM_ALERT_SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_NOTIFICATION_ID Notification type constant for the notification system.alert.system.pollthreads.CurrentPoolSize.
static java.lang.String	SYSTEM_ALERT_SYSTEM_POLLTHREADS_POOLWAITS_NOTIFICATION_ID Notification type constant for the notification system.alert.system.pollthreads.PoolWaits.
static java.lang.String	SYSTEM_LOG_FAILURE_NOTIFICATION_ID Notification type constant for the notification system.log.Failure.
static java.lang.String	SYSTEM_LOG_THRESHOLD_NOTIFICATION_ID Notification type constant for the notification system.log.Threshold.
static IMetricIdentity	SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_METRIC_ID Metric identity constant for the metric system.pollthreads.CurrentPoolSize.
static IMetricIdentity	SYSTEM_POLLTHREADS_MAXPOOLSIZE_METRIC_ID Metric identity constant for the metric system.pollthreads.MaxPoolSize.
static IMetricIdentity	SYSTEM_POLLTHREADS_POOLWAITS_METRIC_ID Metric identity constant for the metric system.pollthreads.PoolWaits.
static java.lang.String	SYSTEM_STATE_FAILOVER_NOTIFICATION_ID Notification type constant for the notification system.state.Failover.
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.
static java.lang.String	SYSTEM_STATE_STARTUP_NOTIFICATION_ID Notification type constant for the notification system.state.Startup.
static java.lang.String	SYSTEM_STATE_UNREACHABLE_NOTIFICATION_ID Notification type constant for the notification system.state.Unreachable.

Method Summary

void	addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback) Adds a notification listener.
void	clearError() Invokes the clearError operation.
void	clearLogFile() Invokes the clearLogFile operation.
void	disableAlerts(IAlert[] alerts) Invokes the disableAlerts operation.
void	disableMetrics(IMetricIdentity[] ids) Invokes the disableMetrics operation.
void	enableAlerts(IAlert[] alerts) Invokes the enableAlerts operation.
void	enableMetrics(IMetricIdentity[] ids) Invokes the enableMetrics operation.
IMetricIdentity[]	getActiveMetrics(IMetricIdentity[] ids) Invokes the getActiveMetrics operation.
java.lang.Boolean	getAllowFailover() Gets the value of the AllowFailover attribute.
AttributeList	getAttributes(java.lang.String[] attributeNames) Gets the values of several attributes of an AgentManager component.
java.lang.String	getClassname() Gets the value of the Classname attribute.
java.lang.String	getClasspath() Gets the value of the Classpath attribute.
IState[]	getCollectiveState() Invokes the getCollectiveState operation.
IState[]	getCollectiveState(java.lang.String configID) Invokes the getCollectiveState operation.
IState[]	getCollectiveState(java.lang.String[] runtimeIds) Invokes the getCollectiveState operation.
java.lang.String	getConfigID() Gets the value of the ConfigID attribute.
IAlert[]	getEnabledAlerts(IMetricIdentity[] ids) Invokes the getEnabledAlerts operation.
IMetricIdentity[]	getEnabledMetrics(IMetricIdentity[] ids) Invokes the getEnabledMetrics operation.
java.lang.String	getFaultToleranceRole() Gets the value of the FaultToleranceRole attribute.
java.lang.Short	getFaultTolerantState() Gets the value of the FaultTolerantState attribute.
java.lang.String	getFaultTolerantStateString() Gets the value of the FaultTolerantStateString 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	getLogExtract(java.lang.Long fromPosition, java.lang.Long readLength) Invokes the getLogExtract operation.
javax.management.openmbean.CompositeData	getLogExtractAndLogFileSize(java.lang.Long fromPosition, java.lang.Long readLength) Invokes the getLogExtractAndLogFileSize operation.
java.lang.String	getLogFile() Gets the value of the LogFile attribute.
java.lang.Long	getLogFileRolloverSizeThreshold() Gets the value of the LogFileRolloverSizeThreshold attribute.
java.lang.Long	getLogFileSize() Gets the value of the LogFileSize attribute.
java.lang.Long	getLogFileSizeThreshold() Gets the value of the LogFileSizeThreshold attribute.
java.lang.Integer	getMaxPollingThreads() Gets the value of the MaxPollingThreads attribute.
java.lang.Integer	getMetricsCollectionInterval() Gets the value of the MetricsCollectionInterval attribute.
IMetricsData	getMetricsData(IMetricIdentity[] ids, java.lang.Boolean returnTriggeredAlerts) Invokes the getMetricsData operation.
IMetricInfo[]	getMetricsInfo() Invokes the getMetricsInfo operation.
java.lang.Integer	getMetricsRefreshInterval() Gets the value of the MetricsRefreshInterval attribute.
java.lang.Integer	getMinPollingThreads() Gets the value of the MinPollingThreads attribute.
java.lang.String	getReleaseVersion() Gets the value of the ReleaseVersion attribute.
java.lang.Boolean	getRepeatMetricAlerts() Gets the value of the RepeatMetricAlerts 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.
java.lang.Object	invoke(java.lang.String configID, java.lang.String operationName, java.lang.Object[] operationParams, java.lang.String[] operationSignature, java.lang.Boolean sync, java.lang.Long timeout) Invokes the invoke operation.
void	reload() Invokes the reload operation.
void	removeNotificationListener(NotificationListener listener) Removes a notification listener.
void	resetMetrics() Invokes the resetMetrics operation.
void	saveLogFile(java.lang.String filename) Invokes the saveLogFile operation.
void	setAllowFailover(java.lang.Boolean value) Sets the value of the AllowFailover attribute.
ICollectiveOpStatus	setAttribute(java.lang.String configID, java.lang.String attributeName, java.lang.Object attributeValue, java.lang.Boolean sync, java.lang.Long timeout) Invokes the setAttribute operation.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of an AgentManager component.
ICollectiveOpStatus	setAttributes(java.lang.String configID, java.lang.String[] attributeNames, java.lang.Object[] attributeValues, java.lang.Boolean sync, java.lang.Long timeout) Invokes the setAttributes operation.
void	setLogFile(java.lang.String value) Sets the value of the LogFile attribute.
void	setLogFileRolloverSizeThreshold(java.lang.Long value) Sets the value of the LogFileRolloverSizeThreshold attribute.
void	setLogFileSizeThreshold(java.lang.Long value) Sets the value of the LogFileSizeThreshold attribute.
void	setMetricsCollectionInterval(java.lang.Integer value) Sets the value of the MetricsCollectionInterval attribute.
void	setMetricsRefreshInterval(java.lang.Integer value) Sets the value of the MetricsRefreshInterval attribute.
void	setRepeatMetricAlerts(java.lang.Boolean value) Sets the value of the RepeatMetricAlerts attribute.
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.
void	suspendActiveRole(java.lang.Integer seconds) Invokes the suspendActiveRole operation.

Field Detail

GLOBAL_ID

static final java.lang.String GLOBAL_ID

The well known global component identity for this singleton component.

See Also:

Constant Field Values

SYSTEM_ALERT_SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_NOTIFICATION_ID

static final java.lang.String SYSTEM_ALERT_SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_NOTIFICATION_ID

Notification type constant for the notification system.alert.system.pollthreads.CurrentPoolSize.

Description: Alert for metric system.pollthreads.CurrentPoolSize

See Also:

system.alert.system.pollthreads.CurrentPoolSize

See Also:

Constant Field Values

SYSTEM_ALERT_SYSTEM_POLLTHREADS_POOLWAITS_NOTIFICATION_ID

static final java.lang.String SYSTEM_ALERT_SYSTEM_POLLTHREADS_POOLWAITS_NOTIFICATION_ID

Notification type constant for the notification system.alert.system.pollthreads.PoolWaits.

Description: Alert for metric system.pollthreads.PoolWaits

See Also:

system.alert.system.pollthreads.PoolWaits

See Also:

Constant Field Values

SYSTEM_LOG_FAILURE_NOTIFICATION_ID

static final java.lang.String SYSTEM_LOG_FAILURE_NOTIFICATION_ID

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

Description: Failure to write to the centralized log file.

See Also:

system.log.Failure

See Also:

Constant Field Values

SYSTEM_LOG_THRESHOLD_NOTIFICATION_ID

static final java.lang.String SYSTEM_LOG_THRESHOLD_NOTIFICATION_ID

Notification type constant for the notification system.log.Threshold.

Description: The size of the current centralized log has reached or exceeded (by a 10% increment) the configured threshold.

See Also:

system.log.Threshold

See Also:

Constant Field Values

SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_METRIC_ID

static final IMetricIdentity SYSTEM_POLLTHREADS_CURRENTPOOLSIZE_METRIC_ID

Metric identity constant for the metric system.pollthreads.CurrentPoolSize.

Description: Size of thread pool used to poll for container(s) state.

See Also:

system.pollthreads.CurrentPoolSize

SYSTEM_POLLTHREADS_MAXPOOLSIZE_METRIC_ID

static final IMetricIdentity SYSTEM_POLLTHREADS_MAXPOOLSIZE_METRIC_ID

Metric identity constant for the metric system.pollthreads.MaxPoolSize.

Description: Maximum size of thread pool used to poll for container(s) state since last metrics reset.

See Also:

system.pollthreads.MaxPoolSize

SYSTEM_POLLTHREADS_POOLWAITS_METRIC_ID

static final IMetricIdentity SYSTEM_POLLTHREADS_POOLWAITS_METRIC_ID

Metric identity constant for the metric system.pollthreads.PoolWaits.

Description: Number of times requests for container state had to wait because a pooled thread was not immediately available to service a poll request. Evaluated over the last 30 minutes.

See Also:

system.pollthreads.PoolWaits

SYSTEM_STATE_FAILOVER_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_FAILOVER_NOTIFICATION_ID

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

Description: Standby service has failed over to become the active service.

See Also:

system.state.Failover

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

SYSTEM_STATE_STARTUP_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_STARTUP_NOTIFICATION_ID

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

Description: Agent/Container startup completed.

See Also:

system.state.Startup

See Also:

Constant Field Values

SYSTEM_STATE_UNREACHABLE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_UNREACHABLE_NOTIFICATION_ID

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

Description: Container unreachable.

See Also:

system.state.Unreachable

See Also:

Constant Field Values

Method Detail

addNotificationListener

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

Adds a notification listener.

An AgentManager component publishes the following notifications:

• system.alert.system.pollthreads.CurrentPoolSize
• system.alert.system.pollthreads.PoolWaits
• system.log.Failure
• system.log.Threshold
• system.state.Failover
• system.state.Offline
• system.state.Online
• system.state.Startup
• system.state.Unreachable

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()

clearLogFile

void clearLogFile()

Invokes the clearLogFile operation.

Clear the centralized log file.

Impact: ACTION

disableAlerts

void disableAlerts(IAlert[] alerts)

Invokes the disableAlerts operation.

Disable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

• system.pollthreads.CurrentPoolSize
• system.pollthreads.PoolWaits

Parameters:

alerts - A list of alerts to disable.

See Also:

enableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

disableMetrics

void disableMetrics(IMetricIdentity[] ids)

Invokes the disableMetrics operation.

Disable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

• system.pollthreads.CurrentPoolSize
• system.pollthreads.MaxPoolSize
• system.pollthreads.PoolWaits

Parameters:

ids - A list of metrics identity patterns.

See Also:

enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

enableAlerts

void enableAlerts(IAlert[] alerts)

Invokes the enableAlerts operation.

Enable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

• system.pollthreads.CurrentPoolSize
• system.pollthreads.PoolWaits

Parameters:

alerts - A list of alerts to enable.

See Also:

disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

enableMetrics

void enableMetrics(IMetricIdentity[] ids)

Invokes the enableMetrics operation.

Enable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

• system.pollthreads.CurrentPoolSize
• system.pollthreads.MaxPoolSize
• system.pollthreads.PoolWaits

Parameters:

ids - A list of metrics identity patterns.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

getActiveMetrics

IMetricIdentity[] getActiveMetrics(IMetricIdentity[] ids)

Invokes the getActiveMetrics operation.

Gets the the list of metrics currently active in this component.

Impact: INFO

Parameters:

ids - A list of metrics identity patterns.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

getAllowFailover

java.lang.Boolean getAllowFailover()

Gets the value of the AllowFailover attribute.

Returns:

When this Agent Manager is in a standby state and this attribute is set to 'false', fault tolerant failover to active will not occur.

See Also:

setAllowFailover(java.lang.Boolean)

getAttributes

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

Gets the values of several attributes of an AgentManager component.

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

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

• AllowFailover (java.lang.Boolean)
• Classname (java.lang.String)
• Classpath (java.lang.String)
• ConfigID (java.lang.String)
• FaultToleranceRole (java.lang.String)
• FaultTolerantState (java.lang.Short)
• FaultTolerantStateString (java.lang.String)
• LastError (java.lang.String)
• LastErrorLevel (java.lang.Integer)
• LastErrorLevelString (java.lang.String)
• LogFile (java.lang.String)
• LogFileRolloverSizeThreshold (java.lang.Long)
• LogFileSize (java.lang.Long)
• LogFileSizeThreshold (java.lang.Long)
• MaxPollingThreads (java.lang.Integer)
• MetricsCollectionInterval (java.lang.Integer)
• MetricsRefreshInterval (java.lang.Integer)
• MinPollingThreads (java.lang.Integer)
• ReleaseVersion (java.lang.String)
• RepeatMetricAlerts (java.lang.Boolean)
• 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(javax.management.AttributeList)

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.

getCollectiveState

IState[] getCollectiveState()

Invokes the getCollectiveState operation.

Gets the runtime state of the whole domain as recorded by the Agent Manager. Returns an array of IContainerState instances.

Impact: INFO

getCollectiveState

IState[] getCollectiveState(java.lang.String configID)

Invokes the getCollectiveState operation.

Gets the runtime state of the given collection as recorded by the Agent Manager.

Impact: INFO

Parameters:

configID - The configuration ID of the collection for which the status is being sought. Returns an array of IContainerState or IComponentState instances that describe the state of the given collection. If an item in the collection no longer represents a known runtime identity then no runtime status will be provided in the returned array.

getCollectiveState

IState[] getCollectiveState(java.lang.String[] runtimeIds)

Invokes the getCollectiveState operation.

Gets the runtime state for the given list of containers as recorded by the Agent Manager. Returns an array of IContainerState instances.

Impact: INFO

Parameters:

runtimeIds - The list of the containers runtime identities for which the status is being sought.

getConfigID

java.lang.String getConfigID()

Gets the value of the ConfigID attribute.

Returns:

Configuration identity.

getEnabledAlerts

IAlert[] getEnabledAlerts(IMetricIdentity[] ids)

Invokes the getEnabledAlerts operation.

Get all metric threshold alerts enabled by this component.

Impact: INFO

Parameters:

ids - A list of metrics identities for which to get the enabled alerts.

See Also:

disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), enableAlerts(com.sonicsw.mf.common.metrics.IAlert[])

getEnabledMetrics

IMetricIdentity[] getEnabledMetrics(IMetricIdentity[] ids)

Invokes the getEnabledMetrics operation.

Get the list of metric patterns that have been enabled for this component.

Impact: INFO

Parameters:

ids - A list of metrics identities for which to get the enabled alerts.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

getFaultToleranceRole

java.lang.String getFaultToleranceRole()

Gets the value of the FaultToleranceRole attribute.

Returns:

The fault tolerant role of the AM (primary or backup) or null if not fault tolerant.

getFaultTolerantState

java.lang.Short getFaultTolerantState()

Gets the value of the FaultTolerantState attribute.

Returns:

The current fault tolerant state of this Agent Manager.

getFaultTolerantStateString

java.lang.String getFaultTolerantStateString()

Gets the value of the FaultTolerantStateString attribute.

Returns:

The description of the current fault tolerant state of this Agent Manager.

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.

getLogExtract

java.lang.String getLogExtract(java.lang.Long fromPosition,
                               java.lang.Long readLength)

Invokes the getLogExtract operation.

Reads the requested bytes from the centralized log file and returns them as a String.

Impact: INFO

Parameters:

fromPosition - The starting position from which to read the log for the given date. If null, then the total log length minus the given readLength is assumed (i.e. the tail of the logging output). The total log length is calculated by summing the size of all log files (current + previous versions.

readLength - The maximum amount of bytes to read from the given (or assumed) starting position. The max size for this value is 1Mb. If null, 200Kb is assumed.

getLogExtractAndLogFileSize

javax.management.openmbean.CompositeData getLogExtractAndLogFileSize(java.lang.Long fromPosition,
                                                                     java.lang.Long readLength)

Invokes the getLogExtractAndLogFileSize operation.

Reads the requested bytes from the centralized log file and returns them as a String encapsulated with the current log size. The current log size is the size of the current log file plus the sum of all available prior versions. When evaluating log output to be read, the current log file and previous versions (due to rollover activity) will be effectively viewed as a single file.

Impact: INFO

Parameters:

fromPosition - The starting position from which to read the log for the given date. If null, then the total log length minus the given readLength is assumed (i.e. the tail of the logging output). The total log length is calculated by summing the size of all log files (current + previous versions.

readLength - The maximum amount of bytes to read from the given (or assumed) starting position. The max size for this value is 1Mb. If null, 200Kb is assumed.

getLogFile

java.lang.String getLogFile()

Gets the value of the LogFile attribute.

Returns:

The directory pathname of the centralized log file. Defaults to {.log} in the container's working directory.

See Also:

setLogFile(java.lang.String)

getLogFileRolloverSizeThreshold

java.lang.Long getLogFileRolloverSizeThreshold()

Gets the value of the LogFileRolloverSizeThreshold attribute.

Returns:

If the current centralized log file size equals or exceeds this threshold at midnight, then the Agent Manager will roll over the old contents to an archive file and create a new empty centralized log file.

See Also:

setLogFileRolloverSizeThreshold(java.lang.Long)

getLogFileSize

java.lang.Long getLogFileSize()

Gets the value of the LogFileSize attribute.

Returns:

The number of bytes written to the centralized log file. This value gets reset to 0 when the log is cleared or archived.

getLogFileSizeThreshold

java.lang.Long getLogFileSizeThreshold()

Gets the value of the LogFileSizeThreshold attribute.

Returns:

Once size of the the centralized log file reaches this threshold or for each time the size exceeds this threshold by a further 10%, the Agent Manager will send a warning notification.

See Also:

setLogFileSizeThreshold(java.lang.Long)

getMaxPollingThreads

java.lang.Integer getMaxPollingThreads()

Gets the value of the MaxPollingThreads attribute.

Returns:

The maximum number of threads that the Agent Manager can create to poll containers for their state.

getMetricsCollectionInterval

java.lang.Integer getMetricsCollectionInterval()

Gets the value of the MetricsCollectionInterval attribute.

Returns:

Metrics collection interval (in minutes)

See Also:

setMetricsCollectionInterval(java.lang.Integer)

getMetricsData

IMetricsData getMetricsData(IMetricIdentity[] ids,
                            java.lang.Boolean returnTriggeredAlerts)

Invokes the getMetricsData operation.

Gets metric values for a given set of metrics. If a requested metric was not enabled or is otherwise unknown, then no data for that metric will be included in the results.

Impact: INFO

Parameters:

ids - A list of active metrics, either individual metrics or instances.

returnTriggeredAlerts - If true, each metric returned should include a list of triggered (exceeded) alerts for these metrics.

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsInfo(), resetMetrics()

getMetricsInfo

IMetricInfo[] getMetricsInfo()

Invokes the getMetricsInfo operation.

Gets the meta-data for all metrics supported by this component.

Impact: INFO

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), resetMetrics()

getMetricsRefreshInterval

java.lang.Integer getMetricsRefreshInterval()

Gets the value of the MetricsRefreshInterval attribute.

Returns:

Metrics refresh interval (in seconds)

See Also:

setMetricsRefreshInterval(java.lang.Integer)

getMinPollingThreads

java.lang.Integer getMinPollingThreads()

Gets the value of the MinPollingThreads attribute.

Returns:

The minimum number of threads that the Agent Manager will cache for reuse to poll containers for their state.

getReleaseVersion

java.lang.String getReleaseVersion()

Gets the value of the ReleaseVersion attribute.

Returns:

Component release version.

getRepeatMetricAlerts

java.lang.Boolean getRepeatMetricAlerts()

Gets the value of the RepeatMetricAlerts attribute.

Returns:

Repeat metric alert notifications.

See Also:

setRepeatMetricAlerts(java.lang.Boolean)

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 - status polling
• 32 - container unreachable
• 64 - forwarded notifications
• 128 - fault detection

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).

invoke

java.lang.Object invoke(java.lang.String configID,
                        java.lang.String operationName,
                        java.lang.Object[] operationParams,
                        java.lang.String[] operationSignature,
                        java.lang.Boolean sync,
                        java.lang.Long timeout)

Invokes the invoke operation.

Invokes an operation on the given component collection. If synchronous execution is requested, returns the return values or exceptions of the individual requests to member of the collection. The return object is an aggregation of return values and/or exceptions wrapped in a ICollectiveOpStatus. Returns null if asynchronous execution is requested.

Impact: ACTION/INFO

Parameters:

configID - The path to the component collection configuration (either storage or logical).

operationName - The name of the operation to invoke on each of the containers/components in the collection.

operationParams - The parameters to the operation.

operationSignature - The signature of the operation.

sync - If false, aynchronously invoke the operation on the collection and return null, otherwise build and return a collective result.

timeout - The time in milliseconds to wait for all responses to be received. The value should be greater than the request timeout value. The value is ignored if asynchronous execution is specified.

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)

resetMetrics

void resetMetrics()

Invokes the resetMetrics operation.

Reset all metrics to their initial state.

Impact: ACTION

See Also:

disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo()

saveLogFile

void saveLogFile(java.lang.String filename)

Invokes the saveLogFile operation.

Saves the contents of the centralized log file to the given file name.

Impact: ACTION

Parameters:

filename - A valid filename (including path) to save the centralized log file to.

setAllowFailover

void setAllowFailover(java.lang.Boolean value)

Sets the value of the AllowFailover attribute.

Parameters:

value - When this Agent Manager is in a standby state and this attribute is set to 'false', fault tolerant failover to active will not occur.

See Also:

getAllowFailover()

setAttribute

ICollectiveOpStatus setAttribute(java.lang.String configID,
                                 java.lang.String attributeName,
                                 java.lang.Object attributeValue,
                                 java.lang.Boolean sync,
                                 java.lang.Long timeout)

Invokes the setAttribute operation.

Sets an attribute on the given component collection. If synchronous execution is requested, returns the return values or exceptions of the individual requests to member of the collection. Returns null if asynchronous execution is requested.

Impact: ACTION

Parameters:

configID - The path to the component collection configuration (either storage or logical).

attributeName - The name of the attribute.

attributeValue - The value of the attribute.

sync - If false, aynchronously invoke the operation on the collection and return null, otherwise build and return a collective result.

timeout - The time in milliseconds to wait for all responses to be received. The value should be greater than the request timeout value. The value is ignored if asynchronous execution is specified.

setAttributes

AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of an AgentManager component.

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

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

• AllowFailover (java.lang.Boolean)
• LogFile (java.lang.String)
• LogFileRolloverSizeThreshold (java.lang.Long)
• LogFileSizeThreshold (java.lang.Long)
• MetricsCollectionInterval (java.lang.Integer)
• MetricsRefreshInterval (java.lang.Integer)
• RepeatMetricAlerts (java.lang.Boolean)
• 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(java.lang.String[])

setAttributes

ICollectiveOpStatus setAttributes(java.lang.String configID,
                                  java.lang.String[] attributeNames,
                                  java.lang.Object[] attributeValues,
                                  java.lang.Boolean sync,
                                  java.lang.Long timeout)

Invokes the setAttributes operation.

Sets attributes on the given component collection. If synchronous execution is requested, returns the return values or exceptions of the individual requests to member of the collection. Returns null if asynchronous execution is requested.

Impact: ACTION

Parameters:

configID - The path to the component collection configuration (either storage or logical).

attributeNames - The names of the attributes.

attributeValues - The values of the attributes.

sync - If false, aynchronously invoke the operation on the collection and return null, otherwise build and return a collective result.

timeout - The time in milliseconds to wait for all responses to be received. The value should be greater than the request timeout value. The value is ignored if asynchronous execution is specified.

setLogFile

void setLogFile(java.lang.String value)

Sets the value of the LogFile attribute.

Parameters:

value - The directory pathname of the centralized log file. Defaults to {.log} in the container's working directory.

See Also:

getLogFile()

setLogFileRolloverSizeThreshold

void setLogFileRolloverSizeThreshold(java.lang.Long value)

Sets the value of the LogFileRolloverSizeThreshold attribute.

Parameters:

value - If the current centralized log file size equals or exceeds this threshold at midnight, then the Agent Manager will roll over the old contents to an archive file and create a new empty centralized log file.

See Also:

getLogFileRolloverSizeThreshold()

setLogFileSizeThreshold

void setLogFileSizeThreshold(java.lang.Long value)

Sets the value of the LogFileSizeThreshold attribute.

Parameters:

value - Once size of the the centralized log file reaches this threshold or for each time the size exceeds this threshold by a further 10%, the Agent Manager will send a warning notification.

See Also:

getLogFileSizeThreshold()

setMetricsCollectionInterval

void setMetricsCollectionInterval(java.lang.Integer value)

Sets the value of the MetricsCollectionInterval attribute.

Parameters:

value - Metrics collection interval (in minutes)

See Also:

getMetricsCollectionInterval()

setMetricsRefreshInterval

void setMetricsRefreshInterval(java.lang.Integer value)

Sets the value of the MetricsRefreshInterval attribute.

Parameters:

value - Metrics refresh interval (in seconds)

See Also:

getMetricsRefreshInterval()

setRepeatMetricAlerts

void setRepeatMetricAlerts(java.lang.Boolean value)

Sets the value of the RepeatMetricAlerts attribute.

Parameters:

value - Repeat metric alert notifications.

See Also:

getRepeatMetricAlerts()

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 - status polling
• 32 - container unreachable
• 64 - forwarded notifications
• 128 - fault detection

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()

suspendActiveRole

void suspendActiveRole(java.lang.Integer seconds)

Invokes the suspendActiveRole operation.

Relinquish the current active role to the the standby. For an active AM, this operation attempts to relinquish the active role to the current standby. The active AM will wait up to the given number of seconds for a standby to takeover the active role; if a standby does not takeover the active role in this period, the AM will continue its active role.

Impact: ACTION

Parameters:

seconds - The minimum time the active role will be suspended.