Package weblogic.diagnostics.descriptor

Interface WLDFWatchBean

All Superinterfaces:

SettableBean, WLDFBean

public interface WLDFWatchBean
extends WLDFBean

Defines policies and actions.

Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.

Access limited to the following security roles:

Deployer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AUTO_RESET_ALARM_TYPE	Static constant for the automatic alarm type.
static java.lang.String	DOMAIN_LOG_RULE_TYPE	Static constant for the log rule type.
static java.lang.String	EL_LANGUAGE_TYPE	Static constant for using Java EL expressions for policy expressions.
static java.lang.String	EVENT_DATA_RULE_TYPE	Static constant for the event data rule type.
static java.lang.String	HARVESTER_RULE_TYPE	Static constant for the harvester rule type.
static java.lang.String	LOG_RULE_TYPE	Static constant for the log rule type.
static java.lang.String	MANUAL_RESET_ALARM_TYPE	Static constant for the manual alarm type.
static java.lang.String	NONE_ALARM_TYPE	Static constant for the alarm type none.
static java.lang.String	WLDF_LANGUAGE_TYPE	Static constant for the built-in WLDF expression language type (deprecated).

Method Summary

Modifier and Type	Method	Description
boolean	addNotification(WLDFNotificationBean notification)	Adds an action to this policy.
int	getAlarmResetPeriod()	For automatic alarms, the time period, in milliseconds, to wait after the policy evaluates to true before the alarm is automatically reset.
java.lang.String	getAlarmType()	The alarm type for the policy: manual or automatic.
java.lang.String	getExpressionLanguage()	Returns the expression language type used by the policy, either "EL" or "WLDF" (deprecated).
WLDFNotificationBean[]	getNotifications()	The actions enabled for this policy.
java.lang.String	getRuleExpression()	The expression used to evaluate the policy.
java.lang.String	getRuleType()	The expression type for the policy: HARVESTER_RULE_TYPE refers to harvested data, LOG_RULE_TYPE refers to server log entry data, DOMAIN_LOG_RULE_TYPE refers to domain log entry data, and EVENT_DATA_RULE_TYPE refers to instrumentation event data.
WLDFScheduleBean	getSchedule()	Defines the evaluation frequency for Harvester type rules, in seconds.
java.lang.String	getSeverity()	The severity level of the actions sent when this policy evaluates to true.
boolean	isEnabled()	Specifies whether this policy is enabled.
boolean	removeNotification(WLDFNotificationBean notification)	Removes an action from this policy.
void	setAlarmResetPeriod(int alarmResetPeriod)	Sets the value of the AlarmResetPeriod attribute.
void	setAlarmType(java.lang.String alarmType)	Sets the value of the AlarmType attribute.
void	setEnabled(boolean enabled)	Sets the value of the Enabled attribute.
void	setExpressionLanguage(java.lang.String languageType)	Sets the expression language type to use for the policy, either one of "EL" or "WLDF" (deprecated)
void	setNotifications(WLDFNotificationBean[] notifications)	Sets the value of the Notifications attribute.
void	setRuleExpression(java.lang.String ruleExpression)	Sets the value of the RuleExpression attribute.
void	setRuleType(java.lang.String ruleType)	Sets the value of the RuleType attribute.
void	setSeverity(java.lang.String severity)	Sets the value of the Severity attribute.

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean

getId, getName

Field Detail

WLDF_LANGUAGE_TYPE

static final java.lang.String WLDF_LANGUAGE_TYPE

Static constant for the built-in WLDF expression language type (deprecated).

See Also:

Constant Field Values

EL_LANGUAGE_TYPE

static final java.lang.String EL_LANGUAGE_TYPE

Static constant for using Java EL expressions for policy expressions.

See Also:

Constant Field Values

HARVESTER_RULE_TYPE

static final java.lang.String HARVESTER_RULE_TYPE

Static constant for the harvester rule type.

See Also:

Constant Field Values

DOMAIN_LOG_RULE_TYPE

static final java.lang.String DOMAIN_LOG_RULE_TYPE

Static constant for the log rule type.

See Also:

Constant Field Values

LOG_RULE_TYPE

static final java.lang.String LOG_RULE_TYPE

Static constant for the log rule type.

See Also:

Constant Field Values

EVENT_DATA_RULE_TYPE

static final java.lang.String EVENT_DATA_RULE_TYPE

Static constant for the event data rule type.

See Also:

Constant Field Values

MANUAL_RESET_ALARM_TYPE

static final java.lang.String MANUAL_RESET_ALARM_TYPE

Static constant for the manual alarm type.

See Also:

Constant Field Values

AUTO_RESET_ALARM_TYPE

static final java.lang.String AUTO_RESET_ALARM_TYPE

Static constant for the automatic alarm type.

See Also:

Constant Field Values

NONE_ALARM_TYPE

static final java.lang.String NONE_ALARM_TYPE

Static constant for the alarm type none.

See Also:

Constant Field Values

Method Detail

isEnabled

boolean isEnabled()

Specifies whether this policy is enabled.

Returns:

true if the policy is enabled, false otherwise

Default Value:

true

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:

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

See Also:

isEnabled()

getRuleType

java.lang.String getRuleType()

The expression type for the policy: HARVESTER_RULE_TYPE refers to harvested data, LOG_RULE_TYPE refers to server log entry data, DOMAIN_LOG_RULE_TYPE refers to domain log entry data, and EVENT_DATA_RULE_TYPE refers to instrumentation event data. The default type is HARVESTER_RULE_TYPE.

For information on policy expressions, see "Using the Diagnostics Framework for Oracle WebLogic Server" at http://docs.oracle.com/middleware/home/index.html.

Returns:

the type of expression for the policy: Harvester, Log, or EventData

Default Value:

WLDFWatchBean.HARVESTER_RULE_TYPE

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Valid Values:

WLDFWatchBean.HARVESTER_RULE_TYPE, WLDFWatchBean.LOG_RULE_TYPE, WLDFWatchBean.DOMAIN_LOG_RULE_TYPE, WLDFWatchBean.EVENT_DATA_RULE_TYPE

setRuleType

void setRuleType(java.lang.String ruleType)

Sets the value of the RuleType attribute.

Parameters:

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

See Also:

getRuleType()

getRuleExpression

java.lang.String getRuleExpression()

The expression used to evaluate the policy.

Returns:

the expression used to evaluate the policy

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setRuleExpression

void setRuleExpression(java.lang.String ruleExpression)

Sets the value of the RuleExpression attribute.

Parameters:

ruleExpression - the expression used to evaluate the policy

See Also:

getRuleExpression()

getExpressionLanguage

java.lang.String getExpressionLanguage()

Returns the expression language type used by the policy, either "EL" or "WLDF" (deprecated).

Returns:

The expression language used by the policy

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setExpressionLanguage

void setExpressionLanguage(java.lang.String languageType)

Sets the expression language type to use for the policy, either one of "EL" or "WLDF" (deprecated)

Parameters:

lang - The expression language to use for the policy

See Also:

getExpressionLanguage()

getSeverity

java.lang.String getSeverity()

The severity level of the actions sent when this policy 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 actions fired when this policy evaluates to true

Default Value:

weblogic.logging.Severities.NOTICE_TEXT

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setSeverity

void setSeverity(java.lang.String severity)

Sets the value of the Severity attribute.

Parameters:

severity - the severity of the actions sent when this policy evaluates to true

See Also:

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

java.lang.String getAlarmType()

The alarm type for the policy: 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 policy, either manual or automatic

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setAlarmType

void setAlarmType(java.lang.String alarmType)

Sets the value of the AlarmType attribute.

Parameters:

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

See Also:

getAlarmType()

Default Value:

WLDFWatchBean.NONE_ALARM_TYPE

Valid Values:

WLDFWatchBean.NONE_ALARM_TYPE, WLDFWatchBean.MANUAL_RESET_ALARM_TYPE, WLDFWatchBean.AUTO_RESET_ALARM_TYPE

getSchedule

WLDFScheduleBean getSchedule()

Defines the evaluation frequency for Harvester type rules, in seconds.

The default frequency is 5 minutes (300 seconds), minimum is 5 seconds.

Returns:

The frequency for Harvester type rule evaluation.

See Also:

WLDFScheduleBean

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getAlarmResetPeriod

int getAlarmResetPeriod()

For automatic alarms, the time period, in milliseconds, to wait after the policy 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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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:

getAlarmResetPeriod()

Default Value:

60000

Minimum Value:

1000

getNotifications

WLDFNotificationBean[] getNotifications()

The actions enabled for this policy.

Returns:

the actions enabled for this policy

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setNotifications

void setNotifications(WLDFNotificationBean[] notifications)

Sets the value of the Notifications attribute.

See Also:

getNotifications()

addNotification

boolean addNotification(WLDFNotificationBean notification)

Adds an action to this policy.

Parameters:

action -

removeNotification

boolean removeNotification(WLDFNotificationBean notification)

Removes an action from this policy.

Parameters:

action -