|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WLDFWatchBean
Defines watches and notifications.
Field Summary | |
---|---|
static String |
AUTO_RESET_ALARM_TYPE
Static constant for the automatic alarm type. |
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. |
Method Summary | |
---|---|
boolean |
addNotification(WLDFNotificationBean notification)
Adds a notification to this watch. |
int |
getAlarmResetPeriod()
For automatic alarms, the time period, in milliseconds, to wait after the watch evaluates to true before the
alarm is automatically reset. |
String |
getAlarmType()
The alarm type for the watch: manual or automatic. |
WLDFNotificationBean[] |
getNotifications()
The notifications enabled for this watch. |
String |
getRuleExpression()
The rule expression used to evaluate the watch. |
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. |
String |
getSeverity()
The severity level of the notifications sent when this watch evaluates to true . |
boolean |
isEnabled()
Specifies whether this watch is enabled. |
boolean |
removeNotification(WLDFNotificationBean notification)
Removes a notification from this watch. |
void |
setAlarmResetPeriod(int alarmResetPeriod)
Sets the value of the AlarmResetPeriod attribute. |
void |
setAlarmType(String alarmType)
Sets the value of the AlarmType attribute. |
void |
setEnabled(boolean enabled)
Sets the value of the Enabled attribute. |
void |
setNotifications(WLDFNotificationBean[] notifications)
Sets the value of the Notifications attribute. |
void |
setRuleExpression(String ruleExpression)
Sets the value of the RuleExpression attribute. |
void |
setRuleType(String ruleType)
Sets the value of the RuleType attribute. |
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 HARVESTER_RULE_TYPE
Static constant for the harvester 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 watch is enabled.
true
if the watch is enabled, false
otherwisevoid setEnabled(boolean enabled)
Sets the value of the Enabled attribute.
enabled
- true
to enable the watch, false
to disable itWLDFWatchBean.isEnabled()
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.
void setRuleType(String ruleType)
Sets the value of the RuleType attribute.
ruleType
- the type of rule expression for the watch: Harvester, Log or EventDataWLDFWatchBean.getRuleType()
String getRuleExpression()
The rule expression used to evaluate the watch.
void setRuleExpression(String ruleExpression)
Sets the value of the RuleExpression attribute.
ruleExpression
- the rule expression used to evaluate the watchWLDFWatchBean.getRuleExpression()
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.
void setSeverity(String severity)
Sets the value of the Severity attribute.
severity
- the severity of the notifications sent when this watch evaluates to trueWLDFWatchBean.getSeverity()
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.
void setAlarmType(String alarmType)
Sets the value of the AlarmType attribute.
alarmType
- the reset type of this watch, either manual or automaticWLDFWatchBean.getAlarmType()
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.
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 notifications enabled for this watch.
void setNotifications(WLDFNotificationBean[] notifications)
Sets the value of the Notifications attribute.
WLDFWatchBean.getNotifications()
boolean addNotification(WLDFNotificationBean notification)
Adds a notification to this watch.
boolean removeNotification(WLDFNotificationBean notification)
Removes a notification from this watch.
|
Copyright 1996, 2013, 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.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |