weblogic.diagnostics.descriptor
Interface WLDFInstrumentationMonitorBean

All Superinterfaces:

WLDFBean

public interface WLDFInstrumentationMonitorBean
extends WLDFBean

This interface defines a diagnostic monitor, which is applied at the specified locations within the included classes in an instrumentation scope.

Access limited to the following security roles:

Deployer

getDescription

String getDescription()

Optional description of this monitor.

setDescription

void setDescription(String description)

Sets the value of the Description attribute.

See Also:

WLDFInstrumentationMonitorBean.getDescription()

isEnabled

boolean isEnabled()

Specifies whether the monitor and its associated diagnostics actions are enabled.

Returns:

True if monitor is enabled

Default Value:

true

setEnabled

void setEnabled(boolean value)

Sets the value of the Enabled attribute.

Parameters:

value - A boolean value that indicates whether this monitor and its associated diagnostics actions are enabled.

See Also:

WLDFInstrumentationMonitorBean.isEnabled()

getDyeMask

String getDyeMask()

The dye mask for all diagnostic actions associated with this monitor.

setDyeMask

void setDyeMask(String dyeMask)

Set the value of the DyeMask attribute.

Parameters:

dyeMask - The dye mask to be applied to all diagnostic action within the scope

See Also:

WLDFInstrumentationMonitorBean.getDyeMask()

isDyeFilteringEnabled

boolean isDyeFilteringEnabled()

Specifies whether dye filtering is enabled for the diagnostic actions associated with this monitor.

Returns:

True, if dye filtering is enabled for the monitor

setDyeFilteringEnabled

void setDyeFilteringEnabled(boolean enable)

Sets the value of the DyeFilteringEnabled attribute.

Parameters:

enable - If true, enable dye filtering; disable otherwise.

See Also:

WLDFInstrumentationMonitorBean.isDyeFilteringEnabled()

getProperties

String getProperties()

Properties for this monitor. Properties are name=value pairs, one pair per line. For example, USER1=foo\nADDR1=127.0.0.1.

Returns:

properties associated with this monitor

setProperties

void setProperties(String properties)

Sets the value of the Properties attribute.

Parameters:

properties - New properties of the monitor

See Also:

WLDFInstrumentationMonitorBean.getProperties()

getActions

String[] getActions()

The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: TraceAction, DisplayArgumentsAction, MethodInvocationStatisticsAction, MethodMemoryAllocationStatisticsAction, StackDumpAction, ThreadDumpAction, TraceElapsedTimeAction, and TraceMemoryAllocationAction.

Returns:

Diagnostic actions attached to the delegating or custom monitor

setActions

void setActions(String[] actions)

Sets the value of the Actions attribute.

Parameters:

actions - Array of action names to be attached to the delegating/custom monitor

See Also:

WLDFInstrumentationMonitorBean.getActions()

getLocationType

String getLocationType()

Attached actions are applied at selected locations: before, after, or around pointcuts. This is relevant only for custom monitors. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)

Once a location type is set, it cannot be changed.

Returns:

location type

Default Value:

"before"

setLocationType

void setLocationType(String locationType)

Sets the value of the LocationType attribute.

Parameters:

locationType - The location type for the actions attached to this monitor.

See Also:

WLDFInstrumentationMonitorBean.getLocationType()

Valid Values:

"before", "after", "around"

getPointcut

String getPointcut()

The pointcut expression for this monitor. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)

Setting a pointcut expression is relevant only for custom monitors; for standard and delegating monitors, this definition is implicitly defined by WLDF.

Once a pointcut expression is set, it cannot be changed.

Returns:

Pointcut expression for the custom monitor.

setPointcut

void setPointcut(String pointcut)

Sets the value of the Pointcut attribute.

Parameters:

pointcut - Pointcut expression for the monitor

See Also:

WLDFInstrumentationMonitorBean.getPointcut()

getIncludes

String[] getIncludes()

Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.

A pattern can end with an asterisk (*), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, weblogic.rmi.* will match with all classes in weblogic.rmi and its subpackages.

Returns:

The patterns containing the names of included classes

See Also:

WLDFInstrumentationMonitorBean.getExcludes()

setIncludes

void setIncludes(String[] expr)

Sets the value of the Includes attribute.

Parameters:

expr - String array of expressions specifying the classes to be included in the instrumentation

See Also:

WLDFInstrumentationMonitorBean.getIncludes()

getExcludes

String[] getExcludes()

Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.

Returns:

The patterns containing the names of excluded classes; for example, com.foo.bar.*

See Also:

WLDFInstrumentationMonitorBean.getIncludes()

setExcludes

void setExcludes(String[] expr)

Sets the value of the Excludes attribute.

Parameters:

expr - String array containing the pattern expressions for the excluded classes

See Also:

WLDFInstrumentationMonitorBean.getExcludes()