public interface LoggingContextFacility
Entry point for Resource Adaptors to interact with logging MDC
| Modifier and Type | Field and Description |
|---|---|
static String |
CONFIG_PROPERTY_NAME |
| Modifier and Type | Method and Description |
|---|---|
void |
clearThreadContext()
Clears the current thread’s logging context.
|
Map<String,String> |
getImmutableActivityContext(ActivityHandle activityHandle)
Gets an immutable copy of the activity’s logging context.
|
Map<String,String> |
getImmutableThreadContext()
Gets an immutable copy of the current thread’s logging context.
|
void |
put(ActivityHandle activityHandle,
String key,
String value)
Add a key value pair to this activity’s logging context.
|
void |
put(String key,
String value)
Add a single key/value pair to the current thread’s logging context.
|
void |
putAll(ActivityHandle activityHandle,
Map<String,String> entries)
Put all context entries into the current logging context.
|
void |
putAll(Map<String,String> entries)
Add a map of key/value pairs to the current thread’s logging context.
|
void |
remove(ActivityHandle activityHandle,
String key)
Remove an entry from the logging context.
|
void |
remove(String key)
Remove a key from the current thread’s logging context.
|
static final String CONFIG_PROPERTY_NAME
Map<String,String> getImmutableActivityContext(ActivityHandle activityHandle) throws UnrecognizedActivityHandleException
Gets an immutable copy of the activity’s logging context.
Intended for use when calling up from the network, to fetch the existing state of an activity, once the activity is known.
activityHandle - Activity handle for the activity to get the Logging context for.UnrecognizedActivityHandleExceptionMap<String,String> getImmutableThreadContext()
Gets an immutable copy of the current thread’s logging context.
Intended for use by components with internal thread pools, to manage moving a logging context between an RA internal thread, and an activity plus rhino thread.
void clearThreadContext()
Clears the current thread’s logging context.
Provided for use by components with internal thread pools, to remove the logging context from an RA internal thread when the thread has completed work associated with an activity.
void put(String key, String value)
Add a single key/value pair to the current thread’s logging context. This does not modify the logging context of any activities directly. Provided for use by RAs before an activity has been started/located, for example in a network IO thread.
key - String context key to add to the thread’s logging contextvalue - String context value to add to the thread’s logging contextvoid putAll(Map<String,String> entries)
Add a map of key/value pairs to the current thread’s logging context. This does not modify the logging context of any activities directly. Provided for use by RAs before an activity has been started/located, for example in a network IO thread.
entries - Map of key, value pairs to add to the thread’s logging contextvoid remove(String key)
Remove a key from the current thread’s logging context. This does not modify the logging context of any activities directly. Provided for use by RAs before an activity has been started/located, for example in a network IO thread.
key - String key to remove from the thread’s logging contextvoid put(ActivityHandle activityHandle, String key, String value) throws UnrecognizedActivityHandleException
Add a key value pair to this activity’s logging context. It will be logged in all subsequent log statements for this activity.
Care must be taken to not overload the context with too many entries.
key - String key to add.value - String value to add.UnrecognizedActivityHandleException - if the handle is null, or does not point to a live activityvoid putAll(ActivityHandle activityHandle, Map<String,String> entries) throws UnrecognizedActivityHandleException
Put all context entries into the current logging context. It will be logged in all subsequent log statements for this activity.
Care must be taken to not overload the context with too many entries.
entries - String key and value pairs to addUnrecognizedActivityHandleException - if the handle is null, or does not point to a live activityvoid remove(ActivityHandle activityHandle, String key) throws UnrecognizedActivityHandleException
Remove an entry from the logging context. This entry will not be logged after this call.
key - String key to remove.UnrecognizedActivityHandleException - if the handle is null, or does not point to a live activity