|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WLDFWatchBean
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.
Field Summary | |
---|---|
static String |
AUTO_RESET_ALARM_TYPE Static constant for the automatic alarm type. |
static String |
DOMAIN_LOG_RULE_TYPE Static constant for the log rule type. |
static String |
EL_LANGUAGE_TYPE Static constant for using Java EL expressions for policy expressions. |
static String |
EVENT_DATA_RULE_TYPE Static constant for the event data rule type. |
static String |
HARVESTER_RULE_TYPE Static constant for the harvester rule type. |
static String |
LOG_RULE_TYPE Static constant for the log rule type. |
static String |
MANUAL_RESET_ALARM_TYPE Static constant for the manual alarm type. |
static String |
NONE_ALARM_TYPE Static constant for the alarm type none. |
static String |
WLDF_LANGUAGE_TYPE Static constant for the built-in WLDF expression language type (deprecated). |
Method Summary | |
---|---|
abstract boolean |
addNotification(WLDFNotificationBean notification) Adds an action to this policy. |
abstract int |
getAlarmResetPeriod() For automatic alarms, the time period, in milliseconds, to wait after the policy evaluates to true before the alarm is automatically reset. |
abstract String |
getAlarmType() The alarm type for the policy: manual or automatic. |
abstract String |
getExpressionLanguage() Returns the expression language type used by the policy, either "EL" or "WLDF" (deprecated). |
abstract WLDFNotificationBean[] |
getNotifications() The actions enabled for this policy. |
abstract String |
getRuleExpression() The expression used to evaluate the policy. |
abstract 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. |
abstract WLDFScheduleBean |
getSchedule() Defines the evaluation frequency for Harvester type rules, in seconds. |
abstract String |
getSeverity() The severity level of the actions sent when this policy evaluates to true . |
abstract boolean |
isEnabled() Specifies whether this policy is enabled. |
abstract boolean |
removeNotification(WLDFNotificationBean notification) Removes an action from this policy. |
abstract void |
setAlarmResetPeriod(int alarmResetPeriod) Sets the value of the AlarmResetPeriod attribute. |
abstract void |
setAlarmType(String alarmType) Sets the value of the AlarmType attribute. |
abstract void |
setEnabled(boolean enabled) Sets the value of the Enabled attribute. |
abstract void |
setExpressionLanguage(String languageType) Sets the expression language type to use for the policy, either one of "EL" or "WLDF" (deprecated) |
abstract void |
setNotifications(WLDFNotificationBean[] notifications) Sets the value of the Notifications attribute. |
abstract void |
setRuleExpression(String ruleExpression) Sets the value of the RuleExpression attribute. |
abstract void |
setRuleType(String ruleType) Sets the value of the RuleType attribute. |
abstract void |
setSeverity(String severity) Sets the value of the Severity attribute. |
Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean |
---|
getId, getName |
Field Detail |
---|
static final String WLDF_LANGUAGE_TYPE
Static constant for the built-in WLDF expression language type (deprecated).
static final String EL_LANGUAGE_TYPE
Static constant for using Java EL expressions for policy expressions.
static final String HARVESTER_RULE_TYPE
Static constant for the harvester rule type.
static final String DOMAIN_LOG_RULE_TYPE
Static constant for the log rule type.
static final String LOG_RULE_TYPE
Static constant for the log rule type.
static final String EVENT_DATA_RULE_TYPE
Static constant for the event data rule type.
static final String MANUAL_RESET_ALARM_TYPE
Static constant for the manual alarm type.
static final String AUTO_RESET_ALARM_TYPE
Static constant for the automatic alarm type.
static final String NONE_ALARM_TYPE
Static constant for the alarm type none.
Method Detail |
---|
boolean isEnabled()
Specifies whether this policy is enabled.
true
if the policy is enabled, false
otherwisevoid setEnabled(boolean enabled)
Sets the value of the Enabled attribute.
enabled
- true
to enable the policy, false
to disable itWLDFWatchBean.isEnabled()
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.
void setRuleType(String ruleType)
Sets the value of the RuleType attribute.
ruleType
- the type of expression for the policy: Harvester, Log or EventDataWLDFWatchBean.getRuleType()
String getRuleExpression()
The expression used to evaluate the policy.
void setRuleExpression(String ruleExpression)
Sets the value of the RuleExpression attribute.
ruleExpression
- the expression used to evaluate the policyWLDFWatchBean.getRuleExpression()
String getExpressionLanguage()
void setExpressionLanguage(String languageType)
lang
- The expression language to use for the policyWLDFWatchBean.getExpressionLanguage()
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.
void setSeverity(String severity)
Sets the value of the Severity attribute.
severity
- the severity of the actions sent when this policy evaluates to trueWLDFWatchBean.getSeverity()
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.
void setAlarmType(String alarmType)
Sets the value of the AlarmType attribute.
alarmType
- the reset type of this policy, either manual or automaticWLDFWatchBean.getAlarmType()
WLDFScheduleBean getSchedule()
Defines the evaluation frequency for Harvester type rules, in seconds.
The default frequency is 5 minutes (300 seconds), minimum is 5 seconds.
WLDFScheduleBean
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.
void setAlarmResetPeriod(int alarmResetPeriod)
Sets the value of the AlarmResetPeriod attribute.
alarmResetPeriod
- the number of milliseconds to wait before the alarm is automatically resetWLDFWatchBean.getAlarmResetPeriod()
WLDFNotificationBean[] getNotifications()
The actions enabled for this policy.
void setNotifications(WLDFNotificationBean[] notifications)
Sets the value of the Notifications attribute.
WLDFWatchBean.getNotifications()
boolean addNotification(WLDFNotificationBean notification)
Adds an action to this policy.
action
-boolean removeNotification(WLDFNotificationBean notification)
Removes an action from this policy.
action
-
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |