weblogic.diagnostics.context

Interface CorrelationIntegrationManager

All Known Subinterfaces:

CorrelationIntegrationManagerForTest

All Known Implementing Classes:

CorrelationIntegrationManagerImpl

public interface CorrelationIntegrationManager

This is INTERNAL-USE-ONLY for supporting the DiagnosticIntegrationManager. The only code currently allowed to use these APIs are DMS and JMS Bridge, if you think you need to use this you MUST contact the WLDF team to discuss so we can understand and track usages of this (ie: this is an internal API which can change incompatibly from release to release, so we need to know exactly who is using it and why to ensure changes take it into consideration)

Excluded in public API Reference.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CorrelationIntegrationManager.Factory

Method Summary

Modifier and Type	Method and Description
void	activateCorrelation(Correlation correlation) This is used by DMS and the JMS Bridge This will unconditionally activate the specified non-null Correlation.
void	clearCorrelation() This is currently used by DMS Unconditionally clear a Correlation if one was previously active
Correlation	findCorrelation() This is currently used by DMS Finds and returns the existing Correlation if present.
Correlation	findOrCreateCorrelation() This is currently used by DMS Finds and returns the existing Correlation if present.
Correlation	newCorrelation() This is currently used by the JMS Bridge.
Correlation	newCorrelation(java.lang.String ecid, int[] ridComponents, int childCount, java.util.Map<java.lang.String,java.lang.String> values, long dyeVector, boolean inheritable) This is used by DMS.
void	setCorrelationEnabled(boolean enabled) This sets the Correlation enabled value at runtime.
void	setDMSCorrelationCallback(CorrelationCallback callback) This is to be called by DMS only! No other usages of this callback are allowed.

Method Detail

clearCorrelation

void clearCorrelation()

This is currently used by DMS Unconditionally clear a Correlation if one was previously active

findCorrelation

Correlation findCorrelation()

This is currently used by DMS Finds and returns the existing Correlation if present. A new Correlation will never be created as a side effect of calling this.

Returns:

Correlation

findOrCreateCorrelation

Correlation findOrCreateCorrelation()

This is currently used by DMS Finds and returns the existing Correlation if present. If not present, a new Correlation will always created and returned.

Returns:

Correlation

setCorrelationEnabled

void setCorrelationEnabled(boolean enabled)

This sets the Correlation enabled value at runtime. This does not affect the configuration and setting this to false will not disable any "implicitly" enabled Correlation cases (ie: JFR event correlation, etc...)

Parameters:

enabled - Whether Correlation is enabled/disabled.

setDMSCorrelationCallback

void setDMSCorrelationCallback(CorrelationCallback callback)

This is to be called by DMS only! No other usages of this callback are allowed. When DMS is present, it must register a CorrelationCallback so that it can be looped into certain Correlation related operations.

Parameters:

callback - CorrelationCallback instance

newCorrelation

Correlation newCorrelation()

This is currently used by the JMS Bridge. This will create a new in-active Correlation instance

newCorrelation

Correlation newCorrelation(java.lang.String ecid,
                           int[] ridComponents,
                           int childCount,
                           java.util.Map<java.lang.String,java.lang.String> values,
                           long dyeVector,
                           boolean inheritable)

This is used by DMS. Create a new inactive Correlation using the specified values.

Parameters:

ecid - Execution Context ID (ECID)

ridComponents - Component array used to form the Relationship ID (RID)

childCount - Initial child count for the RID being formed

values - Map of values

dyeVector - Dye vector

inheritable - Inheritable or not

Returns:

activateCorrelation

void activateCorrelation(Correlation correlation)

This is used by DMS and the JMS Bridge This will unconditionally activate the specified non-null Correlation. If there was a Correlation previously active it will be replaced with the specified Correlation. If the Correlation specified is null, nothing will be changed. Use clearCorrelation to clear the activate Correlation.

Parameters:

correlation - Correlation that is expected to be activated