weblogic.diagnostics.descriptor
Interface WLDFWatchBean

All Superinterfaces:

WLDFBean

public interface WLDFWatchBean
extends WLDFBean

Defines watches and notifications.

Access limited to the following security roles:

Deployer

HARVESTER_RULE_TYPE

static final String HARVESTER_RULE_TYPE

Static constant for the harvester rule type.

See Also:

Constant Field Values

LOG_RULE_TYPE

static final String LOG_RULE_TYPE

Static constant for the log rule type.

See Also:

Constant Field Values

EVENT_DATA_RULE_TYPE

static final String EVENT_DATA_RULE_TYPE

Static constant for the event data rule type.

See Also:

Constant Field Values

MANUAL_RESET_ALARM_TYPE

static final String MANUAL_RESET_ALARM_TYPE

Static constant for the manual alarm type.

See Also:

Constant Field Values

AUTO_RESET_ALARM_TYPE

static final String AUTO_RESET_ALARM_TYPE

Static constant for the automatic alarm type.

See Also:

Constant Field Values

NONE_ALARM_TYPE

static final String NONE_ALARM_TYPE

Static constant for the alarm type none.

See Also:

Constant Field Values

isEnabled

boolean isEnabled()

Specifies whether this watch is enabled.

Returns:

true if the watch is enabled, false otherwise

Default Value:

true

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:

enabled - true to enable the watch, false to disable it

See Also:

WLDFWatchBean.isEnabled()

getRuleType

String getRuleType()

The rule-expression type for the watch: HARVESTER_RULE_TYPE refers to harvested data, LOG_RULE_TYPE refers to log entry data, and EVENT_DATA_RULE_TYPE refers to instrumentation event data. The default type is HARVESTER_RULE_TYPE.

For information on rule expressions, see "Using the Diagnostics Framework for Oracle WebLogic Server" on http://www.oracle.com/technetwork/index.html.

Returns:

the type of rule expression for the watch: Harvester, Log, or EventData

Default Value:

WLDFWatchBean.HARVESTER_RULE_TYPE

Valid Values:

WLDFWatchBean.HARVESTER_RULE_TYPE, WLDFWatchBean.LOG_RULE_TYPE, WLDFWatchBean.EVENT_DATA_RULE_TYPE

setRuleType

void setRuleType(String ruleType)

Sets the value of the RuleType attribute.

Parameters:

ruleType - the type of rule expression for the watch: Harvester, Log or EventData

See Also:

WLDFWatchBean.getRuleType()

getRuleExpression

String getRuleExpression()

The rule expression used to evaluate the watch.

Returns:

the rule expression used to evaluate the watch

setRuleExpression

void setRuleExpression(String ruleExpression)

Sets the value of the RuleExpression attribute.

Parameters:

ruleExpression - the rule expression used to evaluate the watch

See Also:

WLDFWatchBean.getRuleExpression()

This method can NOT set a null value.

This method can NOT set a value of zero length.

getSeverity

String getSeverity()

The severity level of the notifications sent when this watch evaluates to true. When set, this level overrides the default value provided in the parent MBean. However, if no severity level is set (null), the value provided in the parent MBean is returned.

The severity levels are the same levels used by the logging framework and the Severities class.

Returns:

the severity of the notifications fired when this watch evaluates to true

Default Value:

weblogic.logging.Severities.NOTICE_TEXT

setSeverity

void setSeverity(String severity)

Sets the value of the Severity attribute.

Parameters:

severity - the severity of the notifications sent when this watch evaluates to true

See Also:

WLDFWatchBean.getSeverity()

Valid Values:

weblogic.logging.Severities.INFO_TEXT, weblogic.logging.Severities.WARNING_TEXT, weblogic.logging.Severities.ERROR_TEXT, weblogic.logging.Severities.NOTICE_TEXT, weblogic.logging.Severities.CRITICAL_TEXT, weblogic.logging.Severities.ALERT_TEXT, weblogic.logging.Severities.EMERGENCY_TEXT

getAlarmType

String getAlarmType()

The alarm type for the watch: manual or automatic. The default alarm type is manual.

Once a manually set alarm has triggered, it must be reset through the WebLogic Server Administration Console or programmatically before it can trigger again. An automatic reset alarm will reset after the specified time period has elapsed.

Returns:

the type of alarm for the watch, either manual or automatic

setAlarmType

void setAlarmType(String alarmType)

Sets the value of the AlarmType attribute.

Parameters:

alarmType - the reset type of this watch, either manual or automatic

See Also:

WLDFWatchBean.getAlarmType()

Default Value:

WLDFWatchBean.NONE_ALARM_TYPE

Valid Values:

WLDFWatchBean.NONE_ALARM_TYPE, WLDFWatchBean.MANUAL_RESET_ALARM_TYPE, WLDFWatchBean.AUTO_RESET_ALARM_TYPE

getAlarmResetPeriod

int getAlarmResetPeriod()

For automatic alarms, the time period, in milliseconds, to wait after the watch evaluates to true before the alarm is automatically reset.

The default reset period is 60000 milliseconds, which is equivalent to 60 seconds.

Returns:

the number of milliseconds to wait before the alarm is automatically reset

setAlarmResetPeriod

void setAlarmResetPeriod(int alarmResetPeriod)

Sets the value of the AlarmResetPeriod attribute.

Parameters:

alarmResetPeriod - the number of milliseconds to wait before the alarm is automatically reset

See Also:

WLDFWatchBean.getAlarmResetPeriod()

Default Value:

60000

Minimum Value:

1000

getNotifications

WLDFNotificationBean[] getNotifications()

The notifications enabled for this watch.

Returns:

the notifications enabled for this watch

setNotifications

void setNotifications(WLDFNotificationBean[] notifications)

Sets the value of the Notifications attribute.

See Also:

WLDFWatchBean.getNotifications()

addNotification

boolean addNotification(WLDFNotificationBean notification)

Adds a notification to this watch.

removeNotification

boolean removeNotification(WLDFNotificationBean notification)

Removes a notification from this watch.