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 ILoggerProxy

public interface ILoggerProxy

Remote interface to a runtime instance of a Logger.

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:
Logger Notifications, Logger Metrics

Field Summary
static java.lang.String APPLICATION_ALERT_LOGGER_METRICS_LOGGEDPERMINUTE_NOTIFICATION_ID
          Notification type constant for the notification application.alert.logger.metrics.LoggedPerMinute.
static java.lang.String APPLICATION_ALERT_LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_NOTIFICATION_ID
          Notification type constant for the notification application.alert.logger.notifications.LoggedPerMinute.
static IMetricIdentity LOGGER_METRICS_LOGGEDPERMINUTE_METRIC_ID
          Metric identity constant for the metric logger.metrics.LoggedPerMinute.
static IMetricIdentity LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_METRIC_ID
          Metric identity constant for the metric logger.notifications.LoggedPerMinute.
static java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID
          Notification type constant for the notification system.state.Offline.
static java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID
          Notification type constant for the notification system.state.Online.
 
Method Summary
 void addComponentCollectionID(java.lang.String[] componentCollectionID)
          Invokes the addComponentCollectionID operation.
 void addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback)
          Adds a notification listener.
 void clearError()
          Invokes the clearError 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.
 AttributeList getAttributes(java.lang.String[] attributeNames)
          Gets the values of several attributes of a Logger 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.Integer getCollectionsMonitorPollInterval()
          Gets the value of the CollectionsMonitorPollInterval attribute.
 java.lang.String getCollectionsMonitorRuntimeID()
          Gets the value of the CollectionsMonitorRuntimeID attribute.
 java.lang.String[] getComponentCollections()
          Gets the value of the ComponentCollections attribute.
 java.lang.String getConfigID()
          Gets the value of the ConfigID attribute.
 java.lang.String getControlNumber()
          Gets the value of the ControlNumber attribute.
 IAlert[] getEnabledAlerts(IMetricIdentity[] ids)
          Invokes the getEnabledAlerts operation.
 IMetricIdentity[] getEnabledMetrics(IMetricIdentity[] ids)
          Invokes the getEnabledMetrics operation.
 java.lang.Boolean getEvaluationMode()
          Gets the value of the EvaluationMode 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 getLog4jConfigurationFilePath()
          Gets the value of the Log4jConfigurationFilePath attribute.
 java.lang.String getLogFormat()
          Gets the value of the LogFormat attribute.
 java.lang.String getLogTextDelimiter()
          Gets the value of the LogTextDelimiter attribute.
 java.lang.Integer getMaxLookbackPeriod()
          Gets the value of the MaxLookbackPeriod 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.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.
 void reload()
          Invokes the reload operation.
 java.lang.Boolean removeComponentCollectionID(java.lang.String[] componentCollectionID)
          Invokes the removeComponentCollectionID operation.
 void removeNotificationListener(NotificationListener listener)
          Removes a notification listener.
 void resetMetrics()
          Invokes the resetMetrics operation.
 AttributeList setAttributes(AttributeList attributes)
          Sets the values of several attributes of a Logger component.
 void setCollectionsMonitorPollInterval(java.lang.Integer value)
          Sets the value of the CollectionsMonitorPollInterval attribute.
 void setCollectionsMonitorRuntimeID(java.lang.String value)
          Sets the value of the CollectionsMonitorRuntimeID attribute.
 void setComponentCollections(java.lang.String[] value)
          Sets the value of the ComponentCollections attribute.
 void setControlNumber(java.lang.String value)
          Sets the value of the ControlNumber attribute.
 void setEvaluationMode(java.lang.Boolean value)
          Sets the value of the EvaluationMode attribute.
 void setLog4jConfigurationFilePath(java.lang.String value)
          Sets the value of the Log4jConfigurationFilePath attribute.
 void setLogFormat(java.lang.String value)
          Sets the value of the LogFormat attribute.
 void setLogTextDelimiter(java.lang.String value)
          Sets the value of the LogTextDelimiter attribute.
 void setMaxLookbackPeriod(java.lang.Integer value)
          Sets the value of the MaxLookbackPeriod 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.
 

Field Detail

APPLICATION_ALERT_LOGGER_METRICS_LOGGEDPERMINUTE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_LOGGER_METRICS_LOGGEDPERMINUTE_NOTIFICATION_ID
Notification type constant for the notification application.alert.logger.metrics.LoggedPerMinute.

Description: Alert for metric logger.metrics.LoggedPerMinute

See Also:
  • application.alert.logger.metrics.LoggedPerMinute

    • See Also:
    Constant Field Values

    APPLICATION_ALERT_LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_NOTIFICATION_ID

    static final java.lang.String APPLICATION_ALERT_LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_NOTIFICATION_ID
    Notification type constant for the notification application.alert.logger.notifications.LoggedPerMinute.

    Description: Alert for metric logger.notifications.LoggedPerMinute

    See Also:
  • application.alert.logger.notifications.LoggedPerMinute

    • See Also:
    Constant Field Values

    LOGGER_METRICS_LOGGEDPERMINUTE_METRIC_ID

    static final IMetricIdentity LOGGER_METRICS_LOGGEDPERMINUTE_METRIC_ID
    Metric identity constant for the metric logger.metrics.LoggedPerMinute.

    Description: Rate at which metrics have been logged.

    See Also:
  • logger.metrics.LoggedPerMinute

    • LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_METRIC_ID

    static final IMetricIdentity LOGGER_NOTIFICATIONS_LOGGEDPERMINUTE_METRIC_ID
    Metric identity constant for the metric logger.notifications.LoggedPerMinute.

    Description: Rate at which notifications have been logged.

    See Also:
  • logger.notifications.LoggedPerMinute

    • SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID
    Notification type constant for the notification system.state.Offline.

    Description: Component stop complete.

    See Also:
  • system.state.Offline

    • See Also:
    Constant Field Values

    SYSTEM_STATE_ONLINE_NOTIFICATION_ID

    static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID
    Notification type constant for the notification system.state.Online.

    Description: Component start complete.

    See Also:
  • system.state.Online

    • See Also:
    Constant Field Values
    Method Detail

    addComponentCollectionID

    void addComponentCollectionID(java.lang.String[] componentCollectionID)
    Invokes the addComponentCollectionID operation.

    Adds a Component Collection ID to the list of Component Collections in which the LoggerComponent is currently interested.

    Impact: ACTION

    Parameters:
    componentCollectionID - The ID of a Component Collection to be added to the list of Component Collections in which the LoggerComponent is currently interested.

    addNotificationListener

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

    A Logger 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)

    clearError

    void clearError()
    Invokes the clearError operation.

    Clear existing error condition.

    Impact: ACTION

    See Also:
    getLastErrorLevel()

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

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

    getAttributes

    AttributeList getAttributes(java.lang.String[] attributeNames)
    Gets the values of several attributes of a Logger component.

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

    Readable attributes (and their datatypes) exposed by a Logger 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.

    getCollectionsMonitorPollInterval

    java.lang.Integer getCollectionsMonitorPollInterval()
    Gets the value of the CollectionsMonitorPollInterval attribute.

    Returns:
    The amount of time that the LoggerComponent instance will wait between attempts to poll its associated CollectionMonitor for metrics and notifications data.
    See Also:
    setCollectionsMonitorPollInterval(java.lang.Integer)

    getCollectionsMonitorRuntimeID

    java.lang.String getCollectionsMonitorRuntimeID()
    Gets the value of the CollectionsMonitorRuntimeID attribute.

    Returns:
    The runtime ID of the CollectionsMonitor with which this LoggerComponent instance is associated.
    See Also:
    setCollectionsMonitorRuntimeID(java.lang.String)

    getComponentCollections

    java.lang.String[] getComponentCollections()
    Gets the value of the ComponentCollections attribute.

    Returns:
    IDs of Component Collections in which this LoggerComponent is interested.
    See Also:
    setComponentCollections(java.lang.String[])

    getConfigID

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

    Returns:
    Configuration identity.

    getControlNumber

    java.lang.String getControlNumber()
    Gets the value of the ControlNumber attribute.

    Returns:
    The LoggerComponent License Control Number [required in order to access Logger functionality].
    See Also:
    setControlNumber(java.lang.String)

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

    getEvaluationMode

    java.lang.Boolean getEvaluationMode()
    Gets the value of the EvaluationMode attribute.

    Returns:
    Flag that indicates if LoggerComponent is running in evaluation-only mode [limited time use].
    See Also:
    setEvaluationMode(java.lang.Boolean)

    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.

    getLog4jConfigurationFilePath

    java.lang.String getLog4jConfigurationFilePath()
    Gets the value of the Log4jConfigurationFilePath attribute.

    Returns:
    Path to log4j configuration file.
    See Also:
    setLog4jConfigurationFilePath(java.lang.String)

    getLogFormat

    java.lang.String getLogFormat()
    Gets the value of the LogFormat attribute.

    Returns:
    Format used to log data [Delimited Text, XML, or Java Object format].
    See Also:
    setLogFormat(java.lang.String)

    getLogTextDelimiter

    java.lang.String getLogTextDelimiter()
    Gets the value of the LogTextDelimiter attribute.

    Returns:
    Character [or text] used to delimit log entries [applicable only when using the Delimited Text log format].
    See Also:
    setLogTextDelimiter(java.lang.String)

    getMaxLookbackPeriod

    java.lang.Integer getMaxLookbackPeriod()
    Gets the value of the MaxLookbackPeriod attribute.

    Returns:
    The maximum number of threads that the Agent Manager can create to poll containers for their state.
    See Also:
    setMaxLookbackPeriod(java.lang.Integer)

    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)

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

    reload

    void reload()
    Invokes the reload operation.

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

    Impact: ACTION

    removeComponentCollectionID

    java.lang.Boolean removeComponentCollectionID(java.lang.String[] componentCollectionID)
    Invokes the removeComponentCollectionID operation.

    Removes a Component Collection ID from the list of Component Collections in which the LoggerComponent is currently interested. A return value of "false" indicates that the attempt was unsuccessful [A LoggerComponent must always be configured with at least one Component Collection ID, and an attempt to remove the only remaining ID will fail].

    Impact: ACTION

    Parameters:
    componentCollectionID - The ID of a Component Collection to be removed from the list of Component Collections in which the LoggerComponent is currently interested.

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

    setAttributes

    AttributeList setAttributes(AttributeList attributes)
    Sets the values of several attributes of a Logger component.

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

    Settable attributes (and their datatypes) exposed by a Logger 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[])

    setCollectionsMonitorPollInterval

    void setCollectionsMonitorPollInterval(java.lang.Integer value)
    Sets the value of the CollectionsMonitorPollInterval attribute.

    Parameters:
    value - The amount of time that the LoggerComponent instance will wait between attempts to poll its associated CollectionMonitor for metrics and notifications data.
    See Also:
    getCollectionsMonitorPollInterval()

    setCollectionsMonitorRuntimeID

    void setCollectionsMonitorRuntimeID(java.lang.String value)
    Sets the value of the CollectionsMonitorRuntimeID attribute.

    Parameters:
    value - The runtime ID of the CollectionsMonitor with which this LoggerComponent instance is associated.
    See Also:
    getCollectionsMonitorRuntimeID()

    setComponentCollections

    void setComponentCollections(java.lang.String[] value)
    Sets the value of the ComponentCollections attribute.

    Parameters:
    value - IDs of Component Collections in which this LoggerComponent is interested.
    See Also:
    getComponentCollections()

    setControlNumber

    void setControlNumber(java.lang.String value)
    Sets the value of the ControlNumber attribute.

    Parameters:
    value - The LoggerComponent License Control Number [required in order to access Logger functionality].
    See Also:
    getControlNumber()

    setEvaluationMode

    void setEvaluationMode(java.lang.Boolean value)
    Sets the value of the EvaluationMode attribute.

    Parameters:
    value - Flag that indicates if LoggerComponent is running in evaluation-only mode [limited time use].
    See Also:
    getEvaluationMode()

    setLog4jConfigurationFilePath

    void setLog4jConfigurationFilePath(java.lang.String value)
    Sets the value of the Log4jConfigurationFilePath attribute.

    Parameters:
    value - Path to log4j configuration file.
    See Also:
    getLog4jConfigurationFilePath()

    setLogFormat

    void setLogFormat(java.lang.String value)
    Sets the value of the LogFormat attribute.

    Parameters:
    value - Format used to log data [Delimited Text, XML, or Java Object format].
    See Also:
    getLogFormat()

    setLogTextDelimiter

    void setLogTextDelimiter(java.lang.String value)
    Sets the value of the LogTextDelimiter attribute.

    Parameters:
    value - Character [or text] used to delimit log entries [applicable only when using the Delimited Text log format].
    See Also:
    getLogTextDelimiter()

    setMaxLookbackPeriod

    void setMaxLookbackPeriod(java.lang.Integer value)
    Sets the value of the MaxLookbackPeriod attribute.

    Parameters:
    value - The maximum number of threads that the Agent Manager can create to poll containers for their state.
    See Also:
    getMaxLookbackPeriod()

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

    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()
    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-2011 Progress Software Corporation. All Rights Reserved.
    HTML formatted on 12-Aug-2011.