Package weblogic.diagnostics.descriptor

Interface WLDFWatchNotificationBean

All Superinterfaces:

SettableBean, WLDFBean

public interface WLDFWatchNotificationBean
extends WLDFBean

Configures and controls the WebLogic Diagnostic Framework (WLDF) policy and action component; creates and deletes policy definitions; and defines the rules that apply to specific policies.

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

Method Summary

Modifier and Type	Method	Description
WLDFActionBean	createAction(java.lang.String name, java.lang.String type)	Creates an action bean with the specified name.
WLDFHeapDumpActionBean	createHeapDumpAction(java.lang.String name)	Creates an Heap Dump action configuration with the specified name.
WLDFImageNotificationBean	createImageNotification(java.lang.String name)	Creates an Image action configuration with the specified name.
WLDFJMSNotificationBean	createJMSNotification(java.lang.String name)	Creates an JMS action configuration with the specified name.
WLDFJMXNotificationBean	createJMXNotification(java.lang.String name)	Creates an JMX notification configuration with the specified name.
WLDFLogActionBean	createLogAction(java.lang.String name)	Creates an Log action configuration with the specified name.
WLDFRESTNotificationBean	createRESTNotification(java.lang.String name)	Creates an REST action configuration with the specified name.
WLDFScaleDownActionBean	createScaleDownAction(java.lang.String name)	Creates a scale-down action configuration with the specified name.
WLDFScaleUpActionBean	createScaleUpAction(java.lang.String name)	Creates a scale-up action configuration with the specified name.
WLDFScriptActionBean	createScriptAction(java.lang.String name)	Creates an Script action configuration with the specified name.
WLDFSMTPNotificationBean	createSMTPNotification(java.lang.String name)	Creates an SMTP action configuration with the specified name.
WLDFSNMPNotificationBean	createSNMPNotification(java.lang.String name)	Creates an SNMP action configuration with the specified name.
WLDFThreadDumpActionBean	createThreadDumpAction(java.lang.String name)	Creates an Thread Dump action configuration with the specified name.
WLDFWatchBean	createWatch(java.lang.String name)	Creates a policy configuration with the given name.
void	destroyAction(WLDFActionBean action)	Deletes the specified action configuration defined in this deployment.
void	destroyHeapDumpAction(WLDFHeapDumpActionBean action)	Deletes the specified Heap Dump action configuration defined in this deployment.
void	destroyImageNotification(WLDFImageNotificationBean notification)	Deletes the specified Image action configuration defined in this deployment.
void	destroyJMSNotification(WLDFJMSNotificationBean notification)	Deletes the specified JMS action configuration defined in this deployment.
void	destroyJMXNotification(WLDFJMXNotificationBean notification)	Deletes the specified JMX notification configuration defined in this deployment.
void	destroyLogAction(WLDFLogActionBean action)	Deletes the specified Log action configuration defined in this deployment.
void	destroyRESTNotification(WLDFRESTNotificationBean notification)	Deletes the specified REST action configuration defined in this deployment.
void	destroyScaleDownAction(WLDFScaleDownActionBean notification)	Deletes the specified Scale-down action configuration defined in this deployment.
void	destroyScaleUpAction(WLDFScaleUpActionBean notification)	Deletes the specified Scale-up action configuration defined in this deployment.
void	destroyScriptAction(WLDFScriptActionBean notification)	Deletes the specified Script action configuration defined in this deployment.
void	destroySMTPNotification(WLDFSMTPNotificationBean notification)	Deletes the specified SMTP action configuration defined in this deployment.
void	destroySNMPNotification(WLDFSNMPNotificationBean notification)	Deletes the specified SNMP action configuration defined in this deployment.
void	destroyThreadDumpAction(WLDFThreadDumpActionBean action)	Deletes the specified Thread Dump action configuration defined in this deployment.
void	destroyWatch(WLDFWatchBean watch)	Deletes the specified policy configuration defined in this deployment.
WLDFActionBean[]	getActions()	The actions defined in this deployment.
WLDFHeapDumpActionBean[]	getHeapDumpActions()	Get the Heap Dump actions defined in this deployment.
WLDFImageNotificationBean[]	getImageNotifications()	The Image actions defined in this deployment.
WLDFJMSNotificationBean[]	getJMSNotifications()	The JMS actions defined in this deployment.
WLDFJMXNotificationBean[]	getJMXNotifications()	The JMX notification actions defined in this deployment.
WLDFLogActionBean[]	getLogActions()	The Log actions defined in this deployment.
java.lang.String	getLogWatchSeverity()	The threshold severity level of log messages evaluated by log policies.
WLDFNotificationBean[]	getNotifications()	The actions defined in this deployment.
WLDFRESTNotificationBean[]	getRESTNotifications()	The REST actions defined in this deployment.
WLDFScaleDownActionBean[]	getScaleDownActions()	The Scale-down actions defined in this deployment.
WLDFScaleUpActionBean[]	getScaleUpActions()	The Scale-Up actions defined in this deployment.
WLDFScriptActionBean[]	getScriptActions()	The Script actions defined in this deployment.
java.lang.String	getSeverity()	The default action severity level for all policies.
WLDFSMTPNotificationBean[]	getSMTPNotifications()	The SMTP actions defined in this deployment.
WLDFSNMPNotificationBean[]	getSNMPNotifications()	The SNMP actions defined in this deployment.
WLDFThreadDumpActionBean[]	getThreadDumpActions()	Get the Thread Dump actions defined in this deployment.
WLDFWatchBean[]	getWatches()	The policies defined in this deployment.
boolean	isEnabled()	Specifies whether the policy and action component is enabled.
WLDFActionBean	lookupAction(java.lang.String name)	Looks up an action with the given name.
WLDFActionBean[]	lookupActions(java.lang.String typeName)
WLDFHeapDumpActionBean	lookupHeapDumpAction(java.lang.String name)	Looks up the Heap Dump action configuration with the given name.
WLDFImageNotificationBean	lookupImageNotification(java.lang.String name)	Looks up the Image action configuration with the specified name.
WLDFJMSNotificationBean	lookupJMSNotification(java.lang.String name)	Looks up the JMS action configuration with the given name.
WLDFJMXNotificationBean	lookupJMXNotification(java.lang.String name)	Looks up the JMX notification action configuration with the specified name.
WLDFLogActionBean	lookupLogAction(java.lang.String name)	Looks up the Log action configuration with the given name.
WLDFNotificationBean	lookupNotification(java.lang.String name)	Looks up an action with the given name.
WLDFRESTNotificationBean	lookupRESTNotification(java.lang.String name)	Looks up the REST action configuration with the given name.
WLDFScaleDownActionBean	lookupScaleDownAction(java.lang.String name)	Looks up the Scale-down action configuration with the given name.
WLDFScaleUpActionBean	lookupScaleUpAction(java.lang.String name)	Looks up the Scale-up action configuration with the given name.
WLDFScriptActionBean	lookupScriptAction(java.lang.String name)	Looks up the Script action configuration with the given name.
WLDFSMTPNotificationBean	lookupSMTPNotification(java.lang.String name)	Looks up the SMTP action configuration with the specified name.
WLDFSNMPNotificationBean	lookupSNMPNotification(java.lang.String name)	Looks up the SNMP action configuration with the given name.
WLDFThreadDumpActionBean	lookupThreadDumpAction(java.lang.String name)	Looks up the Thread Dump action configuration with the given name.
WLDFWatchBean	lookupWatch(java.lang.String name)	Looks up a policy configuration with the given name.
void	setEnabled(boolean enabled)	Sets the value of the Enabled attribute.
void	setLogWatchSeverity(java.lang.String severity)	Sets the value of the LogWatchSeverity attribute.
void	setSeverity(java.lang.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 policy and action component is enabled.

If true (the default), all configured policies are activated, incoming data or events are evaluated against the policies, and actions are generated when policy conditions are met. If false, all policies are rendered inactive.

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 - The enabled state of the WatchNotification component.

See Also:

isEnabled()

getSeverity

java.lang.String getSeverity()

The default action severity level for all policies. When a policy triggers, the severity level is delivered with the action.

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

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 default severity of the notifications fired when this watch 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

getLogWatchSeverity

java.lang.String getLogWatchSeverity()

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

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

Returns:

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

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

setLogWatchSeverity

void setLogWatchSeverity(java.lang.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:

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 policies defined in this deployment.

Returns:

the watches defined in this deployment

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

createWatch

WLDFWatchBean createWatch(java.lang.String name)

Creates a policy 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 policy configuration defined in this deployment.

Parameters:

watch - the watch configuration defined in this deployment

getNotifications

WLDFNotificationBean[] getNotifications()

The actions defined in this deployment.

Returns:

the notifications defined in this deployment

lookupNotification

WLDFNotificationBean lookupNotification(java.lang.String name)

Looks up an action with the given name.

Parameters:

name -

Returns:

A notification with the given name

createAction

WLDFActionBean createAction(java.lang.String name,
                            java.lang.String type)

Creates an action bean with the specified name.

Parameters:

name - The instance name for the action being created

type - The action type

Returns:

the action created for this deployment

destroyAction

void destroyAction(WLDFActionBean action)

Deletes the specified action configuration defined in this deployment.

Parameters:

notification - the action configuration defined in this deployment

getActions

WLDFActionBean[] getActions()

The actions defined in this deployment.

Returns:

the notifications defined in this deployment

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

lookupAction

WLDFActionBean lookupAction(java.lang.String name)

Looks up an action with the given name.

Parameters:

name -

Returns:

A notification with the given name

lookupActions

WLDFActionBean[] lookupActions(java.lang.String typeName)

Parameters:

typeName -

Returns:

getImageNotifications

WLDFImageNotificationBean[] getImageNotifications()

The Image actions defined in this deployment.

Returns:

the Image notifications defined in this deployment

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

createImageNotification

WLDFImageNotificationBean createImageNotification(java.lang.String name)

Creates an Image action 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 action configuration defined in this deployment.

Parameters:

notification - the Image notification configuration defined in this deployment

lookupImageNotification

WLDFImageNotificationBean lookupImageNotification(java.lang.String name)

Looks up the Image action 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 actions defined in this deployment.

Returns:

the JMS notifications defined in this deployment

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

createJMSNotification

WLDFJMSNotificationBean createJMSNotification(java.lang.String name)

Creates an JMS action 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 action configuration defined in this deployment.

Parameters:

notification - the JMS notification configuration defined in this deployment

lookupJMSNotification

WLDFJMSNotificationBean lookupJMSNotification(java.lang.String name)

Looks up the JMS action configuration with the given name.

Parameters:

name - the name of the JMS notification being requested

Returns:

the JMS notification located for this name

getLogActions

WLDFLogActionBean[] getLogActions()

The Log actions defined in this deployment.

Returns:

the Log notifications defined in this deployment

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

createLogAction

WLDFLogActionBean createLogAction(java.lang.String name)

Creates an Log action configuration with the specified name.

Parameters:

name - the name of the Log action being created

Returns:

the Log action created for this deployment

destroyLogAction

void destroyLogAction(WLDFLogActionBean action)

Deletes the specified Log action configuration defined in this deployment.

Parameters:

notification - the Log action configuration defined in this deployment

lookupLogAction

WLDFLogActionBean lookupLogAction(java.lang.String name)

Looks up the Log action configuration with the given name.

Parameters:

name - the name of the Log action being requested

Returns:

the Log action located for this name

getJMXNotifications

WLDFJMXNotificationBean[] getJMXNotifications()

The JMX notification actions defined in this deployment.

Returns:

the JMX notifications defined in this deployment

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

createJMXNotification

WLDFJMXNotificationBean createJMXNotification(java.lang.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(java.lang.String name)

Looks up the JMX notification action 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 actions defined in this deployment.

Returns:

the SMTP notifications defined in this deployment

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

createSMTPNotification

WLDFSMTPNotificationBean createSMTPNotification(java.lang.String name)

Creates an SMTP action 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 action configuration defined in this deployment.

Parameters:

notification - the SMTP notification configuration defined in this deployment

lookupSMTPNotification

WLDFSMTPNotificationBean lookupSMTPNotification(java.lang.String name)

Looks up the SMTP action 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 actions defined in this deployment.

Returns:

the SNMP notifications defined in this deployment

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

createSNMPNotification

WLDFSNMPNotificationBean createSNMPNotification(java.lang.String name)

Creates an SNMP action 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 action configuration defined in this deployment.

Parameters:

notification - the SNMP notification configuration defined in this deployment

lookupSNMPNotification

WLDFSNMPNotificationBean lookupSNMPNotification(java.lang.String name)

Looks up the SNMP action configuration with the given name.

Parameters:

name - the name of the SNMP notification being requested

Returns:

the SNMP notification located for this name

getRESTNotifications

WLDFRESTNotificationBean[] getRESTNotifications()

The REST actions defined in this deployment.

Returns:

the REST notifications defined in this deployment

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

createRESTNotification

WLDFRESTNotificationBean createRESTNotification(java.lang.String name)

Creates an REST action configuration with the specified name.

Parameters:

name - the name of the REST notification being created

Returns:

the REST notification created for this deployment

destroyRESTNotification

void destroyRESTNotification(WLDFRESTNotificationBean notification)

Deletes the specified REST action configuration defined in this deployment.

Parameters:

notification - the REST notification configuration defined in this deployment

lookupRESTNotification

WLDFRESTNotificationBean lookupRESTNotification(java.lang.String name)

Looks up the REST action configuration with the given name.

Parameters:

name - the name of the REST notification being requested

Returns:

the REST notification located for this name

getScaleUpActions

WLDFScaleUpActionBean[] getScaleUpActions()

The Scale-Up actions defined in this deployment.

Returns:

the Scale-up actions defined in this deployment

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

createScaleUpAction

WLDFScaleUpActionBean createScaleUpAction(java.lang.String name)

Creates a scale-up action configuration with the specified name.

Parameters:

name - the name of the Scale-up action being created

Returns:

the Scale-up action created for this deployment

destroyScaleUpAction

void destroyScaleUpAction(WLDFScaleUpActionBean notification)

Deletes the specified Scale-up action configuration defined in this deployment.

Parameters:

notification - the Scale-up action configuration defined in this deployment

lookupScaleDownAction

WLDFScaleDownActionBean lookupScaleDownAction(java.lang.String name)

Looks up the Scale-down action configuration with the given name.

Parameters:

name - the name of the Scale-down action being requested

Returns:

the Scale-down action located for this name

getScaleDownActions

WLDFScaleDownActionBean[] getScaleDownActions()

The Scale-down actions defined in this deployment.

Returns:

the Scale-down actions defined in this deployment

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

createScaleDownAction

WLDFScaleDownActionBean createScaleDownAction(java.lang.String name)

Creates a scale-down action configuration with the specified name.

Parameters:

name - the name of the Scale-down action being created

Returns:

the Scale-down action created for this deployment

destroyScaleDownAction

void destroyScaleDownAction(WLDFScaleDownActionBean notification)

Deletes the specified Scale-down action configuration defined in this deployment.

Parameters:

notification - the Scale-down action configuration defined in this deployment

lookupScaleUpAction

WLDFScaleUpActionBean lookupScaleUpAction(java.lang.String name)

Looks up the Scale-up action configuration with the given name.

Parameters:

name - the name of the Scaling action being requested

Returns:

the Scaling action located for this name

getScriptActions

WLDFScriptActionBean[] getScriptActions()

The Script actions defined in this deployment.

Returns:

the Script actions defined in this deployment

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

createScriptAction

WLDFScriptActionBean createScriptAction(java.lang.String name)

Creates an Script action configuration with the specified name.

Parameters:

name - the name of the Script action being created

Returns:

the Script action created for this deployment

destroyScriptAction

void destroyScriptAction(WLDFScriptActionBean notification)

Deletes the specified Script action configuration defined in this deployment.

Parameters:

notification - the Script action configuration defined in this deployment

lookupScriptAction

WLDFScriptActionBean lookupScriptAction(java.lang.String name)

Looks up the Script action configuration with the given name.

Parameters:

name - the name of the Script action being requested

Returns:

the Script action located for this name

getHeapDumpActions

WLDFHeapDumpActionBean[] getHeapDumpActions()

Get the Heap Dump actions defined in this deployment.

Returns:

the heap dump actions defined in this deployment

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

createHeapDumpAction

WLDFHeapDumpActionBean createHeapDumpAction(java.lang.String name)

Creates an Heap Dump action configuration with the specified name.

Parameters:

name - the name of the Heap Dump action being created

Returns:

the Heap Dump action created for this deployment

destroyHeapDumpAction

void destroyHeapDumpAction(WLDFHeapDumpActionBean action)

Deletes the specified Heap Dump action configuration defined in this deployment.

Parameters:

notification - the Heap Dump action configuration defined in this deployment

lookupHeapDumpAction

WLDFHeapDumpActionBean lookupHeapDumpAction(java.lang.String name)

Looks up the Heap Dump action configuration with the given name.

Parameters:

name - the name of the Heap Dump action being requested

Returns:

the Heap Dump action located for this name

getThreadDumpActions

WLDFThreadDumpActionBean[] getThreadDumpActions()

Get the Thread Dump actions defined in this deployment.

Returns:

the Thread dump actions defined in this deployment

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

createThreadDumpAction

WLDFThreadDumpActionBean createThreadDumpAction(java.lang.String name)

Creates an Thread Dump action configuration with the specified name.

Parameters:

name - the name of the Thread Dump action being created

Returns:

the Heap Dump action created for this deployment

destroyThreadDumpAction

void destroyThreadDumpAction(WLDFThreadDumpActionBean action)

Deletes the specified Thread Dump action configuration defined in this deployment.

Parameters:

notification - the Thread Dump action configuration defined in this deployment

lookupThreadDumpAction

WLDFThreadDumpActionBean lookupThreadDumpAction(java.lang.String name)

Looks up the Thread Dump action configuration with the given name.

Parameters:

name - the name of the Thread Dump action being requested

Returns:

the Thread Dump action located for this name

lookupWatch

WLDFWatchBean lookupWatch(java.lang.String name)

Looks up a policy configuration with the given name.

Parameters:

name - the name of the policy being requested

Returns:

the policy configuration located for this name