|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAgentProxy
Remote interface to a runtime instance of an Agent.
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 |
ID
The well known component identity for this component. |
static java.lang.String |
SYSTEM_ALERT_SYSTEM_MEMORY_CURRENTUSAGE_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.memory.CurrentUsage. |
static java.lang.String |
SYSTEM_ALERT_SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.notifications.AwaitingDispatch. |
static java.lang.String |
SYSTEM_ALERT_SYSTEM_THREADS_CURRENTPOOLSIZE_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.threads.CurrentPoolSize. |
static java.lang.String |
SYSTEM_ALERT_SYSTEM_THREADS_CURRENTTOTAL_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.threads.CurrentTotal. |
static java.lang.String |
SYSTEM_ALERT_SYSTEM_THREADS_POOLWAITS_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.threads.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_LOGMESSAGE_NOTIFICATION_ID
Notification type constant for the notification system.log.LogMessage. |
static java.lang.String |
SYSTEM_LOG_THRESHOLD_NOTIFICATION_ID
Notification type constant for the notification system.log.Threshold. |
static IMetricIdentity |
SYSTEM_MEMORY_CURRENTUSAGE_METRIC_ID
Metric identity constant for the metric system.memory.CurrentUsage. |
static IMetricIdentity |
SYSTEM_MEMORY_MAXUSAGE_METRIC_ID
Metric identity constant for the metric system.memory.MaxUsage. |
static IMetricIdentity |
SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_METRIC_ID
Metric identity constant for the metric system.notifications.AwaitingDispatch. |
static IMetricIdentity |
SYSTEM_NOTIFICATIONS_DROPPED_METRIC_ID
Metric identity constant for the metric system.notifications.Dropped. |
static IMetricIdentity |
SYSTEM_NOTIFICATIONS_MAXAWAITINGDISPATCH_METRIC_ID
Metric identity constant for the metric system.notifications.MaxAwaitingDispatch. |
static java.lang.String |
SYSTEM_SECURITY_MANAGEPERMISSIONDENIED_NOTIFICATION_ID
Notification type constant for the notification system.security.ManagePermissionDenied. |
static java.lang.String |
SYSTEM_STATE_CONTAINERSTATE_NOTIFICATION_ID
Notification type constant for the notification system.state.ContainerState. |
static java.lang.String |
SYSTEM_STATE_FAILOVER_NOTIFICATION_ID
Notification type constant for the notification system.state.Failover. |
static java.lang.String |
SYSTEM_STATE_LOAD_NOTIFICATION_ID
Notification type constant for the notification system.state.Load. |
static java.lang.String |
SYSTEM_STATE_ONLINE_NOTIFICATION_ID
Notification type constant for the notification system.state.Online. |
static java.lang.String |
SYSTEM_STATE_SHUTDOWN_NOTIFICATION_ID
Notification type constant for the notification system.state.Shutdown. |
static java.lang.String |
SYSTEM_STATE_UNLOAD_NOTIFICATION_ID
Notification type constant for the notification system.state.Unload. |
static IMetricIdentity |
SYSTEM_THREADS_CURRENTPOOLSIZE_METRIC_ID
Metric identity constant for the metric system.threads.CurrentPoolSize. |
static IMetricIdentity |
SYSTEM_THREADS_CURRENTTOTAL_METRIC_ID
Metric identity constant for the metric system.threads.CurrentTotal. |
static IMetricIdentity |
SYSTEM_THREADS_MAXPOOLSIZE_METRIC_ID
Metric identity constant for the metric system.threads.MaxPoolSize. |
static IMetricIdentity |
SYSTEM_THREADS_POOLWAITS_METRIC_ID
Metric identity constant for the metric system.threads.PoolWaits. |
Method Summary | |
---|---|
void |
addNotificationListener(NotificationListener listener,
NotificationFilter filter,
java.lang.Object handback)
Adds a notification listener. |
void |
cleanRestart()
Invokes the cleanRestart operation. |
void |
clearError()
Invokes the clearError operation. |
void |
clearLogFile()
Invokes the clearLogFile operation. |
java.lang.String |
diagnose(java.lang.String instructions)
Invokes the diagnose operation. |
void |
disableAlerts(IAlert[] alerts)
Invokes the disableAlerts operation. |
void |
disableMetrics(IMetricIdentity[] ids)
Invokes the disableMetrics operation. |
void |
downloadArchives()
Invokes the downloadArchives operation. |
void |
downloadArchives(java.lang.String archivesRootDSpath,
java.lang.String archivesVersion)
Invokes the downloadArchives operation. |
void |
downloadFile(java.lang.String dsFilePath)
Invokes the downloadFile 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 Agent component. |
java.lang.String |
getClassname()
Gets the value of the Classname attribute. |
java.lang.String |
getClasspath()
Gets the value of the Classpath attribute. |
java.lang.Boolean |
getCommandLine()
Gets the value of the CommandLine attribute. |
java.lang.String |
getConfigID()
Gets the value of the ConfigID attribute. |
IContainerState |
getContainerState()
Invokes the getContainerState operation. |
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 |
getHostname()
Gets the value of the Hostname attribute. |
java.util.Properties |
getJVMProperties()
Invokes the getJVMProperties operation. |
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.Boolean |
getLogToConsole()
Gets the value of the LogToConsole attribute. |
java.lang.Boolean |
getLogToFile()
Gets the value of the LogToFile attribute. |
java.lang.Integer |
getMaxThreads()
Gets the value of the MaxThreads 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 |
getMinThreads()
Gets the value of the MinThreads 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.String |
ping(java.lang.String pingMessage)
Invokes the ping operation. |
void |
reloadComponent(java.lang.String id)
Invokes the reloadComponent operation. |
void |
removeNotificationListener(NotificationListener listener)
Removes a notification listener. |
void |
resetMetrics()
Invokes the resetMetrics operation. |
void |
restart()
Invokes the restart operation. |
void |
saveLogFile(java.lang.String filename)
Invokes the saveLogFile operation. |
void |
setAllowFailover(java.lang.Boolean value)
Sets the value of the AllowFailover attribute. |
AttributeList |
setAttributes(AttributeList attributes)
Sets the values of several attributes of an Agent component. |
void |
setCommandLine(java.lang.Boolean value)
Sets the value of the CommandLine attribute. |
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 |
setLogToConsole(java.lang.Boolean value)
Sets the value of the LogToConsole attribute. |
void |
setLogToFile(java.lang.Boolean value)
Sets the value of the LogToFile 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 |
shutdown()
Invokes the shutdown operation. |
void |
suspendActiveRole(java.lang.Integer seconds)
Invokes the suspendActiveRole operation. |
Field Detail |
---|
static final java.lang.String ID
static final java.lang.String SYSTEM_ALERT_SYSTEM_MEMORY_CURRENTUSAGE_NOTIFICATION_ID
Description: Alert for metric system.memory.CurrentUsage
system.alert.system.memory.CurrentUsage
static final java.lang.String SYSTEM_ALERT_SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_NOTIFICATION_ID
Description: Alert for metric system.notifications.AwaitingDispatch
static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_CURRENTPOOLSIZE_NOTIFICATION_ID
Description: Alert for metric system.threads.CurrentPoolSize
static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_CURRENTTOTAL_NOTIFICATION_ID
Description: Alert for metric system.threads.CurrentTotal
system.alert.system.threads.CurrentTotal
static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_POOLWAITS_NOTIFICATION_ID
Description: Alert for metric system.threads.PoolWaits
system.alert.system.threads.PoolWaits
static final java.lang.String SYSTEM_LOG_FAILURE_NOTIFICATION_ID
Description: Failure to write to the container log file.
system.log.Failure
static final java.lang.String SYSTEM_LOG_LOGMESSAGE_NOTIFICATION_ID
Description: Message has been logged to the container log. Note: The following will not generate this notification: initial container startup messages, final container shutdown messages, trace messages.
system.log.LogMessage
static final java.lang.String SYSTEM_LOG_THRESHOLD_NOTIFICATION_ID
Description: The size of the current container log has reached or exceeded (by a 10% increment) the configured threshold.
system.log.Threshold
static final IMetricIdentity SYSTEM_MEMORY_CURRENTUSAGE_METRIC_ID
Description: Heap space used by the container and its hosted components.
system.memory.CurrentUsage
static final IMetricIdentity SYSTEM_MEMORY_MAXUSAGE_METRIC_ID
Description: Maximum heap space used by the container and its hosted components since last metrics reset.
system.memory.MaxUsage
static final IMetricIdentity SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_METRIC_ID
Description: The number of management notifications awaiting dispatch.
system.notifications.AwaitingDispatch
static final IMetricIdentity SYSTEM_NOTIFICATIONS_DROPPED_METRIC_ID
Description: Number of times a management notification was dropped before dispatch to listeners. Evaluated over the last 30 minutes.
system.notifications.Dropped
static final IMetricIdentity SYSTEM_NOTIFICATIONS_MAXAWAITINGDISPATCH_METRIC_ID
Description: The maximum number of management notifications awaiting dispatch since last metrics reset.
system.notifications.MaxAwaitingDispatch
static final java.lang.String SYSTEM_SECURITY_MANAGEPERMISSIONDENIED_NOTIFICATION_ID
Description: User has been denied permission to perform a management task.
system.security.ManagePermissionDenied
static final java.lang.String SYSTEM_STATE_CONTAINERSTATE_NOTIFICATION_ID
Description: Update of container state
system.state.ContainerState
static final java.lang.String SYSTEM_STATE_FAILOVER_NOTIFICATION_ID
Description: Standby container has failed over to become the active container.
system.state.Failover
static final java.lang.String SYSTEM_STATE_LOAD_NOTIFICATION_ID
Description: Component load completed.
system.state.Load
static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID
Description: Component start complete.
system.state.Online
static final java.lang.String SYSTEM_STATE_SHUTDOWN_NOTIFICATION_ID
Description: Agent/Container shutdown initiated.
system.state.Shutdown
static final java.lang.String SYSTEM_STATE_UNLOAD_NOTIFICATION_ID
Description: Component unload completed.
system.state.Unload
static final IMetricIdentity SYSTEM_THREADS_CURRENTPOOLSIZE_METRIC_ID
Description: Size of thread pool used to service transient management tasks.
system.threads.CurrentPoolSize
static final IMetricIdentity SYSTEM_THREADS_CURRENTTOTAL_METRIC_ID
Description: Total number of threads used by the container and its hosted components.
system.threads.CurrentTotal
static final IMetricIdentity SYSTEM_THREADS_MAXPOOLSIZE_METRIC_ID
Description: Maximum size of thread pool used to service transient management tasks since last metrics reset.
system.threads.MaxPoolSize
static final IMetricIdentity SYSTEM_THREADS_POOLWAITS_METRIC_ID
Description: Number of times transient management tasks had to wait because a pooled thread was not immediately available to service such tasks. Evaluated over the last 30 minutes.
system.threads.PoolWaits
Method Detail |
---|
void addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback)
An Agent component publishes the following notifications:
system.alert.system.memory.CurrentUsage
system.alert.system.notifications.AwaitingDispatch
system.alert.system.threads.CurrentPoolSize
system.alert.system.threads.CurrentTotal
system.alert.system.threads.PoolWaits
system.log.Failure
system.log.LogMessage
system.log.Threshold
system.security.ManagePermissionDenied
system.state.ContainerState
system.state.Failover
system.state.Load
system.state.Online
system.state.Shutdown
system.state.Unload
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 cleanRestart()
Restart the Agent/Container after deleting all the files in the working directory of the container (other than scripts, container.ini and the log) (requires support from parent shell/process).
Impact: ACTION
void clearError()
Clear existing error condition.
Impact: ACTION
getLastErrorLevel()
void clearLogFile()
Clear the log file.
Impact: ACTION
java.lang.String diagnose(java.lang.String instructions)
Execute diagnostics instructions
Impact: INFO
instructions
- One or more diagnostic instructions - an instruction per linevoid disableAlerts(IAlert[] alerts)
Disable threshold alerts on a metric.
Impact: ACTION
Metrics that allow alert thresholds to be specified are:
alerts
- A list of alerts to disable.enableAlerts(com.sonicsw.mf.common.metrics.IAlert[])
,
getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])
void disableMetrics(IMetricIdentity[] ids)
Disable the given set of dynamic metrics.
Impact: ACTION
Dynamic metrics are:
system.memory.CurrentUsage
system.memory.MaxUsage
system.notifications.AwaitingDispatch
system.notifications.Dropped
system.notifications.MaxAwaitingDispatch
system.threads.CurrentPoolSize
system.threads.CurrentTotal
system.threads.MaxPoolSize
system.threads.PoolWaits
ids
- A list of metrics identity patterns.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()
void downloadArchives()
Makes sure all the latest versions of archives used by components of this container are cached in the container's cache.
Impact: ACTION
void downloadArchives(java.lang.String archivesRootDSpath, java.lang.String archivesVersion)
Makes sure all the latest versions of archives used by components of this container are cached in the container's cache.
Impact: ACTION
archivesRootDSpath
- The Directory Service path of the root of the archives - the "sonicfs://" prefix can be omitted. Example: "/Archives".archivesVersion
- The version of the archive(s). Example: "8.0".void downloadFile(java.lang.String dsFilePath)
Makes sure the latest version of the specified Directory Service file is cached in the container's cache.
Impact: ACTION
dsFilePath
- The Directory Service path of the file.void enableAlerts(IAlert[] alerts)
Enable threshold alerts on a metric.
Impact: ACTION
Metrics that allow alert thresholds to be specified are:
alerts
- A list of alerts to enable.disableAlerts(com.sonicsw.mf.common.metrics.IAlert[])
,
getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])
void enableMetrics(IMetricIdentity[] ids)
Enable the given set of dynamic metrics.
Impact: ACTION
Dynamic metrics are:
system.memory.CurrentUsage
system.memory.MaxUsage
system.notifications.AwaitingDispatch
system.notifications.Dropped
system.notifications.MaxAwaitingDispatch
system.threads.CurrentPoolSize
system.threads.CurrentTotal
system.threads.MaxPoolSize
system.threads.PoolWaits
ids
- A list of metrics identity patterns.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()
IMetricIdentity[] getActiveMetrics(IMetricIdentity[] ids)
Gets the the list of metrics currently active in this component.
Impact: INFO
ids
- A list of metrics identity patterns.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()
java.lang.Boolean getAllowFailover()
setAllowFailover(java.lang.Boolean)
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 Agent are:
AllowFailover
(java.lang.Boolean)
Classname
(java.lang.String)
Classpath
(java.lang.String)
CommandLine
(java.lang.Boolean)
ConfigID
(java.lang.String)
FaultToleranceRole
(java.lang.String)
FaultTolerantState
(java.lang.Short)
FaultTolerantStateString
(java.lang.String)
Hostname
(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)
LogToConsole
(java.lang.Boolean)
LogToFile
(java.lang.Boolean)
MaxThreads
(java.lang.Integer)
MetricsCollectionInterval
(java.lang.Integer)
MetricsRefreshInterval
(java.lang.Integer)
MinThreads
(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)
attributeNames
- A list of the attribute names of attributes to be retrieved.
setAttributes(javax.management.AttributeList)
java.lang.String getClassname()
java.lang.String getClasspath()
java.lang.Boolean getCommandLine()
setCommandLine(java.lang.Boolean)
java.lang.String getConfigID()
IContainerState getContainerState()
Gets the execution state of the container and its hosted components.
Impact: INFO
IAlert[] getEnabledAlerts(IMetricIdentity[] ids)
Get all metric threshold alerts enabled by this component.
Impact: INFO
ids
- A list of metrics identities for which to get the enabled alerts.disableAlerts(com.sonicsw.mf.common.metrics.IAlert[])
,
enableAlerts(com.sonicsw.mf.common.metrics.IAlert[])
IMetricIdentity[] getEnabledMetrics(IMetricIdentity[] ids)
Get the list of metric patterns that have been enabled for this component.
Impact: INFO
ids
- A list of metrics identities for which to get the enabled alerts.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()
java.lang.String getFaultToleranceRole()
java.lang.Short getFaultTolerantState()
java.lang.String getFaultTolerantStateString()
java.lang.String getHostname()
java.util.Properties getJVMProperties()
Returns the JVM's system properties.
Impact: INFO
java.lang.String getLastError()
java.lang.Integer getLastErrorLevel()
java.lang.String getLastErrorLevelString()
java.lang.String getLogExtract(java.lang.Long fromPosition, java.lang.Long readLength)
Reads the requested bytes from the log file and returns them as a String.
Impact: INFO
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.javax.management.openmbean.CompositeData getLogExtractAndLogFileSize(java.lang.Long fromPosition, java.lang.Long readLength)
Reads the requested bytes from the 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
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.java.lang.String getLogFile()
setLogFile(java.lang.String)
java.lang.Long getLogFileRolloverSizeThreshold()
setLogFileRolloverSizeThreshold(java.lang.Long)
java.lang.Long getLogFileSize()
java.lang.Long getLogFileSizeThreshold()
setLogFileSizeThreshold(java.lang.Long)
java.lang.Boolean getLogToConsole()
setLogToConsole(java.lang.Boolean)
java.lang.Boolean getLogToFile()
setLogToFile(java.lang.Boolean)
java.lang.Integer getMaxThreads()
java.lang.Integer getMetricsCollectionInterval()
setMetricsCollectionInterval(java.lang.Integer)
IMetricsData getMetricsData(IMetricIdentity[] ids, java.lang.Boolean returnTriggeredAlerts)
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
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.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()
IMetricInfo[] getMetricsInfo()
Gets the meta-data for all metrics supported by this component.
Impact: INFO
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()
java.lang.Integer getMetricsRefreshInterval()
setMetricsRefreshInterval(java.lang.Integer)
java.lang.Integer getMinThreads()
java.lang.String getReleaseVersion()
java.lang.Boolean getRepeatMetricAlerts()
setRepeatMetricAlerts(java.lang.Boolean)
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()
java.lang.String ping(java.lang.String pingMessage)
Checks the container for accessibility. Returns the given string.
Impact: INFO
pingMessage
- Any string.void reloadComponent(java.lang.String id)
Asynchronously reload the given component ID.
Impact: ACTION
id
- The runtime identity of the component within the container to be reloaded.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)
void resetMetrics()
Reset all metrics to their initial state.
Impact: ACTION
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()
void restart()
Restart the Agent/Container (requires support from parent shell/process).
Impact: ACTION
void saveLogFile(java.lang.String filename)
Saves the contents of the log file to the given file name.
Impact: ACTION
filename
- A valid filename (including path) to save the log file to.void setAllowFailover(java.lang.Boolean value)
value
- When this container is in a standby state and this attribute is set to 'false', fault tolerant failover to active will not occur.getAllowFailover()
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 Agent are:
AllowFailover
(java.lang.Boolean)
CommandLine
(java.lang.Boolean)
LogFile
(java.lang.String)
LogFileRolloverSizeThreshold
(java.lang.Long)
LogFileSizeThreshold
(java.lang.Long)
LogToConsole
(java.lang.Boolean)
LogToFile
(java.lang.Boolean)
MetricsCollectionInterval
(java.lang.Integer)
MetricsRefreshInterval
(java.lang.Integer)
RepeatMetricAlerts
(java.lang.Boolean)
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(java.lang.String[])
void setCommandLine(java.lang.Boolean value)
value
- Flag indicating if a local command line interface is enabled.getCommandLine()
void setLogFile(java.lang.String value)
value
- The directory pathname of the container log file. Defaults to {getLogFile()
void setLogFileRolloverSizeThreshold(java.lang.Long value)
value
- If the current log file size equals or exceeds this threshold at midnight, then the container will roll over the old contents to an archive file and create a new empty container log file.getLogFileRolloverSizeThreshold()
void setLogFileSizeThreshold(java.lang.Long value)
value
- Once the size of the container log file reaches this threshold or for each time the size exceeds this threshold by a further 10%, the Agent will send a warning notification.getLogFileSizeThreshold()
void setLogToConsole(java.lang.Boolean value)
value
- Flag indicating if messages logged via the framework should be sent to the container console.getLogToConsole()
void setLogToFile(java.lang.Boolean value)
value
- Flag indicating if messages logged via the framework should be sent to the log file.getLogToFile()
void setMetricsCollectionInterval(java.lang.Integer value)
value
- Metrics collection interval (in minutes)getMetricsCollectionInterval()
void setMetricsRefreshInterval(java.lang.Integer value)
value
- Metrics refresh interval (in seconds)getMetricsRefreshInterval()
void setRepeatMetricAlerts(java.lang.Boolean value)
value
- Repeat metric alert notifications.getRepeatMetricAlerts()
void setTraceMask(java.lang.Integer value)
value
- Debug bit mask.getTraceMask()
,
getTraceMaskValues()
void shutdown()
Shutdown the Agent/Container.
Impact: ACTION
void suspendActiveRole(java.lang.Integer seconds)
Relinquish the current active role to the the standby. For an active container, this operation attempts to relinquish the active role to the current standby. The active container 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 container will continue its active role.
Impact: ACTION
seconds
- The minimum time the active role will be suspended.
|
Sonic Management API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |