Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.diagnostics.descriptor
Interface WLDFWatchNotificationBean

All Superinterfaces:
WLDFBean

public interface WLDFWatchNotificationBean
extends WLDFBean

Configures and controls the WebLogic Diagnostic Framework (WLDF) Watch Notification component; creates and deletes watch definitions; and defines the rules that apply to specific watches.

Access limited to the following security roles:
Deployer

Method Summary
 WLDFImageNotificationBean createImageNotification(String name)
          Creates an Image notification configuration with the specified name.
 WLDFJMSNotificationBean createJMSNotification(String name)
          Creates an JMS notification configuration with the specified name.
 WLDFJMXNotificationBean createJMXNotification(String name)
          Creates an JMX notification configuration with the specified name.
 WLDFSMTPNotificationBean createSMTPNotification(String name)
          Creates an SMTP notification configuration with the specified name.
 WLDFSNMPNotificationBean createSNMPNotification(String name)
          Creates an SNMP notification configuration with the specified name.
 WLDFWatchBean createWatch(String name)
          Creates a watch configuration with the given name.
 void destroyImageNotification(WLDFImageNotificationBean notification)
          Deletes the specified Image notification configuration defined in this deployment.
 void destroyJMSNotification(WLDFJMSNotificationBean notification)
          Deletes the specified JMS notification configuration defined in this deployment.
 void destroyJMXNotification(WLDFJMXNotificationBean notification)
          Deletes the specified JMX notification configuration defined in this deployment.
 void destroySMTPNotification(WLDFSMTPNotificationBean notification)
          Deletes the specified SMTP notification configuration defined in this deployment.
 void destroySNMPNotification(WLDFSNMPNotificationBean notification)
          Deletes the specified SNMP notification configuration defined in this deployment.
 void destroyWatch(WLDFWatchBean watch)
          Deletes the specified watch configuration defined in this deployment.
 WLDFImageNotificationBean[] getImageNotifications()
          The Image notifications defined in this deployment.
 WLDFJMSNotificationBean[] getJMSNotifications()
          The JMS notifications defined in this deployment.
 WLDFJMXNotificationBean[] getJMXNotifications()
          The JMX notifications defined in this deployment.
 String getLogWatchSeverity()
          The threshold severity level of log messages evaluated by log watch rules.
 WLDFNotificationBean[] getNotifications()
          The notifications defined in this deployment.
 String getSeverity()
          The default notification severity level for all watches.
 WLDFSMTPNotificationBean[] getSMTPNotifications()
          The SMTP notifications defined in this deployment.
 WLDFSNMPNotificationBean[] getSNMPNotifications()
          The SNMP notifications defined in this deployment.
 WLDFWatchBean[] getWatches()
          The watches defined in this deployment.
 boolean isEnabled()
          Specifies whether the Watch Notification component is enabled.
 WLDFImageNotificationBean lookupImageNotification(String name)
          Looks up the Image notification configuration with the specified name.
 WLDFJMSNotificationBean lookupJMSNotification(String name)
          Looks up the JMS notification configuration with the given name.
 WLDFJMXNotificationBean lookupJMXNotification(String name)
          Looks up the JMX notification configuration with the specified name.
 WLDFNotificationBean lookupNotification(String name)
          Looks up a notification with the given name.
 WLDFSMTPNotificationBean lookupSMTPNotification(String name)
          Looks up the SMTP notification configuration with the specified name.
 WLDFSNMPNotificationBean lookupSNMPNotification(String name)
          Looks up the SNMP notification configuration with the given name.
 WLDFWatchBean lookupWatch(String name)
          Looks up the SNMP notification configuration with the given name.
 void setEnabled(boolean enabled)
          Sets the value of the Enabled attribute.
 void setLogWatchSeverity(String severity)
          Sets the value of the LogWatchSeverity attribute.
 void setSeverity(String severity)
          Sets the value of the Severity attribute.
 
Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean
getId, getName
 

Method Detail

isEnabled

boolean isEnabled()

Specifies whether the Watch Notification component is enabled.

If true (the default), all configured watches are activated, incoming data or events are evaluated against the rules, and notifications are sent when rule conditions are met. If false, all watches are rendered inactive.

Default Value:
true

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:
enabled - The enabled state of the WatchNotification component.
See Also:
WLDFWatchNotificationBean.isEnabled()

getSeverity

String getSeverity()

The default notification severity level for all watches. When a watch triggers, the severity level is delivered with the notification.

The severity levels are the same levels used by the logging framework and the Severities class. If no level is specified, the default value is Notice.

Returns:
the default severity for notifications sent 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 default severity of the notifications fired when this watch evaluates to true
See Also:
WLDFWatchNotificationBean.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

getLogWatchSeverity

String getLogWatchSeverity()

The threshold severity level of log messages evaluated by log watch rules. Messages with a lower severity than this value will be ignored and not evaluated against the watch rules.

Do not confuse LogWatchSeverity with Severity. LogWatchSeverity filters which log messages will be evaluated; Severity sets the default severity level for a notification.

Returns:
the threshold severity level of log messages evaluated by log watch rules

setLogWatchSeverity

void setLogWatchSeverity(String severity)

Sets the value of the LogWatchSeverity attribute.

Parameters:
severity - the threshold severity level of log messages evaluated by log watch rules
See Also:
WLDFWatchNotificationBean.getLogWatchSeverity()
Default Value:
weblogic.logging.Severities.WARNING_TEXT
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

getWatches

WLDFWatchBean[] getWatches()

The watches defined in this deployment.

Returns:
the watches defined in this deployment

createWatch

WLDFWatchBean createWatch(String name)

Creates a watch configuration with the given name.

Parameters:
name - the name of the watch configuration
Returns:
A watch configuration with the given name

destroyWatch

void destroyWatch(WLDFWatchBean watch)

Deletes the specified watch configuration defined in this deployment.

Parameters:
watch - the watch configuration defined in this deployment

getNotifications

WLDFNotificationBean[] getNotifications()

The notifications defined in this deployment.

Returns:
the notifications defined in this deployment

lookupNotification

WLDFNotificationBean lookupNotification(String name)

Looks up a notification with the given name.

Parameters:
name -
Returns:
A notification with the given name

getImageNotifications

WLDFImageNotificationBean[] getImageNotifications()

The Image notifications defined in this deployment.

Returns:
the Image notifications defined in this deployment

createImageNotification

WLDFImageNotificationBean createImageNotification(String name)

Creates an Image notification configuration with the specified name.

Parameters:
name - the name of the Image notification being created
Returns:
the Image notification created for this deployment

destroyImageNotification

void destroyImageNotification(WLDFImageNotificationBean notification)

Deletes the specified Image notification configuration defined in this deployment.

Parameters:
notification - the Image notification configuration defined in this deployment

lookupImageNotification

WLDFImageNotificationBean lookupImageNotification(String name)

Looks up the Image notification configuration with the specified name.

Parameters:
name - the name of the Image notification being requested
Returns:
the Image notification located for this name

getJMSNotifications

WLDFJMSNotificationBean[] getJMSNotifications()

The JMS notifications defined in this deployment.

Returns:
the JMS notifications defined in this deployment

createJMSNotification

WLDFJMSNotificationBean createJMSNotification(String name)

Creates an JMS notification configuration with the specified name.

Parameters:
name - the name of the JMS notification being created
Returns:
the JMS notification created for this deployment

destroyJMSNotification

void destroyJMSNotification(WLDFJMSNotificationBean notification)

Deletes the specified JMS notification configuration defined in this deployment.

Parameters:
notification - the JMS notification configuration defined in this deployment

lookupJMSNotification

WLDFJMSNotificationBean lookupJMSNotification(String name)

Looks up the JMS notification configuration with the given name.

Parameters:
name - the name of the JMS notification being requested
Returns:
the JMS notification located for this name

getJMXNotifications

WLDFJMXNotificationBean[] getJMXNotifications()

The JMX notifications defined in this deployment.

Returns:
the JMX notifications defined in this deployment

createJMXNotification

WLDFJMXNotificationBean createJMXNotification(String name)

Creates an JMX notification configuration with the specified name.

Parameters:
name - the name of the JMX notification being created
Returns:
the JMX notification created for this deployment

destroyJMXNotification

void destroyJMXNotification(WLDFJMXNotificationBean notification)

Deletes the specified JMX notification configuration defined in this deployment.

Parameters:
notification - the JMX notification configuration defined in this deployment

lookupJMXNotification

WLDFJMXNotificationBean lookupJMXNotification(String name)

Looks up the JMX notification configuration with the specified name.

Parameters:
name - the name of the JMX notification being requested
Returns:
the JMX notification located for this name

getSMTPNotifications

WLDFSMTPNotificationBean[] getSMTPNotifications()

The SMTP notifications defined in this deployment.

Returns:
the SMTP notifications defined in this deployment

createSMTPNotification

WLDFSMTPNotificationBean createSMTPNotification(String name)

Creates an SMTP notification configuration with the specified name.

Parameters:
name - the name of the SMTP notification being created
Returns:
the SMTP notification created for this deployment

destroySMTPNotification

void destroySMTPNotification(WLDFSMTPNotificationBean notification)

Deletes the specified SMTP notification configuration defined in this deployment.

Parameters:
notification - the SMTP notification configuration defined in this deployment

lookupSMTPNotification

WLDFSMTPNotificationBean lookupSMTPNotification(String name)

Looks up the SMTP notification configuration with the specified name.

Parameters:
name - the name of the SMTP notification being requested
Returns:
the SMTP notification located for this name

getSNMPNotifications

WLDFSNMPNotificationBean[] getSNMPNotifications()

The SNMP notifications defined in this deployment.

Returns:
the SNMP notifications defined in this deployment

createSNMPNotification

WLDFSNMPNotificationBean createSNMPNotification(String name)

Creates an SNMP notification configuration with the specified name.

Parameters:
name - the name of the SNMP notification being created
Returns:
the SNMP notification created for this deployment

destroySNMPNotification

void destroySNMPNotification(WLDFSNMPNotificationBean notification)

Deletes the specified SNMP notification configuration defined in this deployment.

Parameters:
notification - the SNMP notification configuration defined in this deployment

lookupSNMPNotification

WLDFSNMPNotificationBean lookupSNMPNotification(String name)

Looks up the SNMP notification configuration with the given name.

Parameters:
name - the name of the SNMP notification being requested
Returns:
the SNMP notification located for this name

lookupWatch

WLDFWatchBean lookupWatch(String name)

Looks up the SNMP notification configuration with the given name.

Parameters:
name - the name of the SNMP notification being requested
Returns:
the SNMP notification located for this name

Copyright 1996, 2014, 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.3)

Part Number E41849-02