weblogic.diagnostics.context
Class DiagnosticContextHelper

java.lang.Object
  weblogic.diagnostics.context.DiagnosticContextHelper

All Implemented Interfaces:

DiagnosticContextConstants

public final class DiagnosticContextHelper
extends Object
implements DiagnosticContextConstants

Use this class to provide applications limited access to the diagnostic context. Applications can access, but not set, the immutable context ID attribute for a diagnostic context. Each context is assigned an immutable ID when created. The context also contains a dye vector (a bit vector). Each bit in the dye vector indicates the presence of a dye in the diagnostic context. Dye bits in the dye vector correspond to different properties of the request for which the diagnostic context is created. For example, dye USER1 indicates that the request was originated by a specific user. Applications can inspect dyes in the diagnostic context. They can also modify a subset of dye flags in the dye vector for their own use, identified by DYE_0 through DYE_7.

DiagnosticContextHelper

public DiagnosticContextHelper()

getContextId

public static String getContextId()

The immutable identifier for the current diagnostic context, which is unique within the domain.

Returns:

unique id of the current diagnostic context

setDye

public static void setDye(byte dye,
                          boolean enable)
                   throws InvalidDyeException

Sets an application-available dye flag (DYE_0 throughDYE_7) to be used to mark the diagnostic context.

Parameters:

dye - The dye whose value is to be set

enable - the value of the dye, true to dye, false to undye

Throws:

InvalidDyeException - if dye index is out of range

isDyedWith

public static boolean isDyedWith(byte dye)
                          throws InvalidDyeException

Tests whether the diagnostic context is marked with the given dye. All dye flags [0...63] can be inspected by application code.

Parameters:

dye - The dye to check

Returns:

true if context is dyed with given context; false otherwise.

Throws:

InvalidDyeException - if dye index is out of range.

getPayload

public static String getPayload()

The user payload inserted in the diagnostic context. A payload is an arbitrary string which you insert into the context for later retrieval.

Returns:

user payload in the diagnostic context. Returns null if none exists.

setPayload

public static void setPayload(String payload)

Sets the value of the Payload attribute.

Parameters:

payload - user payload

See Also:

DiagnosticContextHelper.getPayload()

parseDyeMask

public static long parseDyeMask(String mask)

Parses a comma-separated string of dye flag names, and returns the corresponding dye mask. For example: USER1,ADDR1.

parseDyeMask

public static long parseDyeMask(String[] maskNames)

Parses an array of dye flag names, and returns the corresponding dye mask. For example: ["USER1", "ADDR1"].

getDyeFlagNames

public static String[] getDyeFlagNames()

An array of valid dye flag names.

Returns:

Names of available dye flags.