cd.connect.context

Class ConnectContext

java.lang.Object

cd.connect.context.ConnectContext

public class ConnectContext
extends Object

We use the underlying MDC of the logging library to store these as essentially they are used for logging, so much be compatible. Objects always get stored as JSON mapped strings, and the key is changed to "json."

Author:

Richard Vowles - https://plus.google.com/+RichardVowles

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PREFIX
static NamedConnectContext	requestId
static NamedConnectContext	scenarioId

Constructor Summary

Constructors

Constructor and Description
ConnectContext()

Method Summary

Modifier and Type	Method and Description
static void	clear() Clear the logging context (usually this thread)
static String	get(String key) Gets a key and returns the string representation of it.
static <T> T	get(String key, Class<T> clazz) Takes the given key, finds the json: prefix version of it.
static Map<String,String>	getContext() The complete context.
static void	remove(String key) Remove the specific key.
static void	set(String key, Object value) logging contexts can generally only deal with strings
static void	setContext(Map<String,String> pushContext) used when transferring context between threads

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

requestId

public static NamedConnectContext requestId

scenarioId

public static NamedConnectContext scenarioId

JSON_PREFIX

public static final String JSON_PREFIX

See Also:

Constant Field Values

Constructor Detail

ConnectContext

public ConnectContext()

Method Detail

clear

public static void clear()

Clear the logging context (usually this thread)

remove

public static void remove(String key)

Remove the specific key. Use clear to remove them all, always wrap this in a try/finally.

Parameters:

key - - key to remove from context

set

public static void set(String key,
                       Object value)

logging contexts can generally only deal with strings

Parameters:

key - - the key to use, will be replaced with json.KEY if value is object. If the value is a JSON object that needs to be preserved as a JSON object, use the JSON_PREFIX in your key.

value - - java.lang variants are stored as strings, other objects are converted to JSON

get

public static String get(String key)

Gets a key and returns the string representation of it.

Parameters:

key - - key and will try and find the json version of it if missing.*

Returns:

- always returns a string

get

public static <T> T get(String key,
                        Class<T> clazz)

Takes the given key, finds the json: prefix version of it.

Type Parameters:

T - - the type

Parameters:

key - - the key to get (minus the json prefix)

clazz - - the class to serialize into

Returns:

- null (if not found) or new instance of object

getContext

public static Map<String,String> getContext()

The complete context.

Returns:

setContext

public static void setContext(Map<String,String> pushContext)

used when transferring context between threads

Parameters:

pushContext -