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

Part Number E27170-01

weblogic.diagnostics.descriptor
Interface WLDFInstrumentationBean

All Superinterfaces:
WLDFBean

public interface WLDFInstrumentationBean
extends WLDFBean

Use this interface to configure server-scope and application-scope instrumentation for diagnostic monitors that will execute diagnostic code at selected locations in server or application code.

Access limited to the following security roles:
Deployer

Method Summary
 WLDFInstrumentationMonitorBean createWLDFInstrumentationMonitor(String name)
          Adds the specified diagnostic monitor to this instrumentation scope, which could be server or application scope.
 void destroyWLDFInstrumentationMonitor(WLDFInstrumentationMonitorBean monitor)
          Removes the specified diagnostic monitor from this instrumentation scope.
 String[] getExcludes()
          Pattern expressions for classes that will be excluded from this instrumentation scope.
 String[] getIncludes()
          Pattern expressions for classes that are included in this instrumentation scope.
 WLDFInstrumentationMonitorBean[] getWLDFInstrumentationMonitors()
          The diagnostic monitors defined in this instrumentation scope.
 boolean isEnabled()
          The state of the instrumentation behavior for the server or application.
 void setEnabled(boolean value)
          Sets the value of the Enabled attribute.
 void setExcludes(String[] expr)
          Sets the value of the Excludes attribute.
 void setIncludes(String[] expr)
          Sets the value of the Includes attribute.
 
Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean
getId, getName
 

Method Detail

isEnabled

boolean isEnabled()

The state of the instrumentation behavior for the server or application. If false, there will no weaving (inserting of diagnostic code) in the application or server code during class loading. In addition, if woven classes are already loaded, disabling instrumentation will disable all the monitors in this scope.


setEnabled

void setEnabled(boolean value)

Sets the value of the Enabled attribute.

See Also:
WLDFInstrumentationBean.isEnabled()

getIncludes

String[] getIncludes()

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

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:
WLDFInstrumentationBean.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:
WLDFInstrumentationBean.getIncludes()

getExcludes

String[] getExcludes()

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

Returns:
The patterns containing the names of excluded classes; for example, com.foo.bar.*
See Also:
WLDFInstrumentationBean.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:
WLDFInstrumentationBean.getExcludes()

getWLDFInstrumentationMonitors

WLDFInstrumentationMonitorBean[] getWLDFInstrumentationMonitors()

The diagnostic monitors defined in this instrumentation scope.


createWLDFInstrumentationMonitor

WLDFInstrumentationMonitorBean createWLDFInstrumentationMonitor(String name)

Adds the specified diagnostic monitor to this instrumentation scope, which could be server or application scope.

Parameters:
name - A unique name to identify the monitor in this scope.
See Also:
WLDFInstrumentationBean.getWLDFInstrumentationMonitors()

destroyWLDFInstrumentationMonitor

void destroyWLDFInstrumentationMonitor(WLDFInstrumentationMonitorBean monitor)

Removes the specified diagnostic monitor from this instrumentation scope.

Parameters:
monitor - The name of the monitor to remove
Throws:
MonitorNotFoundException - The named monitor does not exist in the scope of this instrumentation manager.

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-01