Overview  Package   Class  Tree  Index  Help 
Sonic Management API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sonicsw.mf.mgmtapi.runtime
Interface IAgentProxy

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.

See Also:
Agent Notifications, Agent Metrics

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

ID

static final java.lang.String ID
The well known component identity for this component.

See Also:
Constant Field Values

SYSTEM_ALERT_SYSTEM_MEMORY_CURRENTUSAGE_NOTIFICATION_ID

static final java.lang.String SYSTEM_ALERT_SYSTEM_MEMORY_CURRENTUSAGE_NOTIFICATION_ID
Notification type constant for the notification system.alert.system.memory.CurrentUsage.

Description: Alert for metric system.memory.CurrentUsage

See Also:
  • system.alert.system.memory.CurrentUsage

    • See Also:
    Constant Field Values

    SYSTEM_ALERT_SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_NOTIFICATION_ID

    static final java.lang.String SYSTEM_ALERT_SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_NOTIFICATION_ID
    Notification type constant for the notification system.alert.system.notifications.AwaitingDispatch.

    Description: Alert for metric system.notifications.AwaitingDispatch

    See Also:
  • system.alert.system.notifications.AwaitingDispatch

    • See Also:
    Constant Field Values

    SYSTEM_ALERT_SYSTEM_THREADS_CURRENTPOOLSIZE_NOTIFICATION_ID

    static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_CURRENTPOOLSIZE_NOTIFICATION_ID
    Notification type constant for the notification system.alert.system.threads.CurrentPoolSize.

    Description: Alert for metric system.threads.CurrentPoolSize

    See Also:
  • system.alert.system.threads.CurrentPoolSize

    • See Also:
    Constant Field Values

    SYSTEM_ALERT_SYSTEM_THREADS_CURRENTTOTAL_NOTIFICATION_ID

    static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_CURRENTTOTAL_NOTIFICATION_ID
    Notification type constant for the notification system.alert.system.threads.CurrentTotal.

    Description: Alert for metric system.threads.CurrentTotal

    See Also:
  • system.alert.system.threads.CurrentTotal

    • See Also:
    Constant Field Values

    SYSTEM_ALERT_SYSTEM_THREADS_POOLWAITS_NOTIFICATION_ID

    static final java.lang.String SYSTEM_ALERT_SYSTEM_THREADS_POOLWAITS_NOTIFICATION_ID
    Notification type constant for the notification system.alert.system.threads.PoolWaits.

    Description: Alert for metric system.threads.PoolWaits

    See Also:
  • system.alert.system.threads.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 container log file.

    See Also:
  • system.log.Failure

    • See Also:
    Constant Field Values

    SYSTEM_LOG_LOGMESSAGE_NOTIFICATION_ID

    static final java.lang.String SYSTEM_LOG_LOGMESSAGE_NOTIFICATION_ID
    Notification type constant for the notification system.log.LogMessage.

    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.

    See Also:
  • system.log.LogMessage

    • 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 container log has reached or exceeded (by a 10% increment) the configured threshold.

    See Also:
  • system.log.Threshold

    • See Also:
    Constant Field Values

    SYSTEM_MEMORY_CURRENTUSAGE_METRIC_ID

    static final IMetricIdentity SYSTEM_MEMORY_CURRENTUSAGE_METRIC_ID
    Metric identity constant for the metric system.memory.CurrentUsage.

    Description: Heap space used by the container and its hosted components.

    See Also:
  • system.memory.CurrentUsage

    • SYSTEM_MEMORY_MAXUSAGE_METRIC_ID

    static final IMetricIdentity SYSTEM_MEMORY_MAXUSAGE_METRIC_ID
    Metric identity constant for the metric system.memory.MaxUsage.

    Description: Maximum heap space used by the container and its hosted components since last metrics reset.

    See Also:
  • system.memory.MaxUsage

    • SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_METRIC_ID

    static final IMetricIdentity SYSTEM_NOTIFICATIONS_AWAITINGDISPATCH_METRIC_ID
    Metric identity constant for the metric system.notifications.AwaitingDispatch.

    Description: The number of management notifications awaiting dispatch.

    See Also:
  • system.notifications.AwaitingDispatch

    • SYSTEM_NOTIFICATIONS_DROPPED_METRIC_ID

    static final IMetricIdentity SYSTEM_NOTIFICATIONS_DROPPED_METRIC_ID
    Metric identity constant for the metric system.notifications.Dropped.

    Description: Number of times a management notification was dropped before dispatch to listeners. Evaluated over the last 30 minutes.

    See Also:
  • system.notifications.Dropped

    • SYSTEM_NOTIFICATIONS_MAXAWAITINGDISPATCH_METRIC_ID

    static final IMetricIdentity SYSTEM_NOTIFICATIONS_MAXAWAITINGDISPATCH_METRIC_ID
    Metric identity constant for the metric system.notifications.MaxAwaitingDispatch.

    Description: The maximum number of management notifications awaiting dispatch since last metrics reset.

    See Also:
  • system.notifications.MaxAwaitingDispatch

    • SYSTEM_SECURITY_MANAGEPERMISSIONDENIED_NOTIFICATION_ID

    static final java.lang.String SYSTEM_SECURITY_MANAGEPERMISSIONDENIED_NOTIFICATION_ID
    Notification type constant for the notification system.security.ManagePermissionDenied.

    Description: User has been denied permission to perform a management task.

    See Also:
  • system.security.ManagePermissionDenied

    • See Also:
    Constant Field Values

    SYSTEM_STATE_CONTAINERSTATE_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_CONTAINERSTATE_NOTIFICATION_ID
    Notification type constant for the notification system.state.ContainerState.

    Description: Update of container state

    See Also:
  • system.state.ContainerState

    • See Also:
    Constant Field Values

    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 container has failed over to become the active container.

    See Also:
  • system.state.Failover

    • See Also:
    Constant Field Values

    SYSTEM_STATE_LOAD_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_LOAD_NOTIFICATION_ID
    Notification type constant for the notification system.state.Load.

    Description: Component load completed.

    See Also:
  • system.state.Load

    • 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_SHUTDOWN_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_SHUTDOWN_NOTIFICATION_ID
    Notification type constant for the notification system.state.Shutdown.

    Description: Agent/Container shutdown initiated.

    See Also:
  • system.state.Shutdown

    • See Also:
    Constant Field Values

    SYSTEM_STATE_UNLOAD_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_UNLOAD_NOTIFICATION_ID
    Notification type constant for the notification system.state.Unload.

    Description: Component unload completed.

    See Also:
  • system.state.Unload

    • See Also:
    Constant Field Values

    SYSTEM_THREADS_CURRENTPOOLSIZE_METRIC_ID

    static final IMetricIdentity SYSTEM_THREADS_CURRENTPOOLSIZE_METRIC_ID
    Metric identity constant for the metric system.threads.CurrentPoolSize.

    Description: Size of thread pool used to service transient management tasks.

    See Also:
  • system.threads.CurrentPoolSize

    • SYSTEM_THREADS_CURRENTTOTAL_METRIC_ID

    static final IMetricIdentity SYSTEM_THREADS_CURRENTTOTAL_METRIC_ID
    Metric identity constant for the metric system.threads.CurrentTotal.

    Description: Total number of threads used by the container and its hosted components.

    See Also:
  • system.threads.CurrentTotal

    • SYSTEM_THREADS_MAXPOOLSIZE_METRIC_ID

    static final IMetricIdentity SYSTEM_THREADS_MAXPOOLSIZE_METRIC_ID
    Metric identity constant for the metric system.threads.MaxPoolSize.

    Description: Maximum size of thread pool used to service transient management tasks since last metrics reset.

    See Also:
  • system.threads.MaxPoolSize

    • SYSTEM_THREADS_POOLWAITS_METRIC_ID

    static final IMetricIdentity SYSTEM_THREADS_POOLWAITS_METRIC_ID
    Metric identity constant for the metric system.threads.PoolWaits.

    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.

    See Also:
  • system.threads.PoolWaits

    • Method Detail

    addNotificationListener

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

    An Agent component publishes the following notifications:

    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)

    cleanRestart

    void cleanRestart()
    Invokes the cleanRestart operation.

    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

    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 log file.

    Impact: ACTION

    diagnose

    java.lang.String diagnose(java.lang.String instructions)
    Invokes the diagnose operation.

    Execute diagnostics instructions

    Impact: INFO

    Parameters:
    instructions - One or more diagnostic instructions - an instruction per line

    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:

    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:

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

    downloadArchives

    void downloadArchives()
    Invokes the downloadArchives operation.

    Makes sure all the latest versions of archives used by components of this container are cached in the container's cache.

    Impact: ACTION

    downloadArchives

    void downloadArchives(java.lang.String archivesRootDSpath,
                      java.lang.String archivesVersion)
    Invokes the downloadArchives operation.

    Makes sure all the latest versions of archives used by components of this container are cached in the container's cache.

    Impact: ACTION

    Parameters:
    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".

    downloadFile

    void downloadFile(java.lang.String dsFilePath)
    Invokes the downloadFile operation.

    Makes sure the latest version of the specified Directory Service file is cached in the container's cache.

    Impact: ACTION

    Parameters:
    dsFilePath - The Directory Service path of the file.

    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:

    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:

    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 container 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 Agent component.

    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:

    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.

    getCommandLine

    java.lang.Boolean getCommandLine()
    Gets the value of the CommandLine attribute.

    Returns:
    Flag indicating if a local command line interface is enabled.
    See Also:
    setCommandLine(java.lang.Boolean)

    getConfigID

    java.lang.String getConfigID()
    Gets the value of the ConfigID attribute.

    Returns:
    Configuration identity.

    getContainerState

    IContainerState getContainerState()
    Invokes the getContainerState operation.

    Gets the execution state of the container and its hosted components.

    Impact: INFO

    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 container (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 container.

    getFaultTolerantStateString

    java.lang.String getFaultTolerantStateString()
    Gets the value of the FaultTolerantStateString attribute.

    Returns:
    The description of the current fault tolerant state of this container.

    getHostname

    java.lang.String getHostname()
    Gets the value of the Hostname attribute.

    Returns:
    The hostname for the container host machine.

    getJVMProperties

    java.util.Properties getJVMProperties()
    Invokes the getJVMProperties operation.

    Returns the JVM's system properties.

    Impact: INFO

    Returns:
    the JVM's system properties.

    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 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 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 container 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 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.
    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 container 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 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.
    See Also:
    setLogFileSizeThreshold(java.lang.Long)

    getLogToConsole

    java.lang.Boolean getLogToConsole()
    Gets the value of the LogToConsole attribute.

    Returns:
    Flag indicating if messages logged via the framework should be sent to the container console.
    See Also:
    setLogToConsole(java.lang.Boolean)

    getLogToFile

    java.lang.Boolean getLogToFile()
    Gets the value of the LogToFile attribute.

    Returns:
    Flag indicating if messages logged via the framework should be sent to the log file.
    See Also:
    setLogToFile(java.lang.Boolean)

    getMaxThreads

    java.lang.Integer getMaxThreads()
    Gets the value of the MaxThreads attribute.

    Returns:
    The maximum number of threads that the container can create to service transient management tasks.

    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)

    getMinThreads

    java.lang.Integer getMinThreads()
    Gets the value of the MinThreads attribute.

    Returns:
    The minimum number of threads that the container will cache for reuse to service transient management tasks.

    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:

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

    ping

    java.lang.String ping(java.lang.String pingMessage)
    Invokes the ping operation.

    Checks the container for accessibility. Returns the given string.

    Impact: INFO

    Parameters:
    pingMessage - Any string.

    reloadComponent

    void reloadComponent(java.lang.String id)
    Invokes the reloadComponent operation.

    Asynchronously reload the given component ID.

    Impact: ACTION

    Parameters:
    id - The runtime identity of the component within the container to be reloaded.

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

    restart

    void restart()
    Invokes the restart operation.

    Restart the Agent/Container (requires support from parent shell/process).

    Impact: ACTION

    saveLogFile

    void saveLogFile(java.lang.String filename)
    Invokes the saveLogFile operation.

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

    Impact: ACTION

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

    setAllowFailover

    void setAllowFailover(java.lang.Boolean value)
    Sets the value of the AllowFailover attribute.

    Parameters:
    value - When this container is in a standby state and this attribute is set to 'false', fault tolerant failover to active will not occur.
    See Also:
    getAllowFailover()

    setAttributes

    AttributeList setAttributes(AttributeList attributes)
    Sets the values of several attributes of an Agent component.

    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:

    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[])

    setCommandLine

    void setCommandLine(java.lang.Boolean value)
    Sets the value of the CommandLine attribute.

    Parameters:
    value - Flag indicating if a local command line interface is enabled.
    See Also:
    getCommandLine()

    setLogFile

    void setLogFile(java.lang.String value)
    Sets the value of the LogFile attribute.

    Parameters:
    value - The directory pathname of the container 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 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.
    See Also:
    getLogFileRolloverSizeThreshold()

    setLogFileSizeThreshold

    void setLogFileSizeThreshold(java.lang.Long value)
    Sets the value of the LogFileSizeThreshold attribute.

    Parameters:
    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.
    See Also:
    getLogFileSizeThreshold()

    setLogToConsole

    void setLogToConsole(java.lang.Boolean value)
    Sets the value of the LogToConsole attribute.

    Parameters:
    value - Flag indicating if messages logged via the framework should be sent to the container console.
    See Also:
    getLogToConsole()

    setLogToFile

    void setLogToFile(java.lang.Boolean value)
    Sets the value of the LogToFile attribute.

    Parameters:
    value - Flag indicating if messages logged via the framework should be sent to the log file.
    See Also:
    getLogToFile()

    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:

    Parameters:
    value - Debug bit mask.
    See Also:
    getTraceMask(), getTraceMaskValues()

    shutdown

    void shutdown()
    Invokes the shutdown operation.

    Shutdown the Agent/Container.

    Impact: ACTION

    suspendActiveRole

    void suspendActiveRole(java.lang.Integer seconds)
    Invokes the suspendActiveRole operation.

    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

    Parameters:
    seconds - The minimum time the active role will be suspended.
    Overview  Package   Class  Tree  Index  Help 
    		Sonic Management API
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
    HTML formatted on 13-Mar-2012.