Package org.codice.ddf.security.util

Class ThreadContextProperties

java.lang.Object

org.codice.ddf.security.util.ThreadContextProperties

public final class ThreadContextProperties
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_INFO_KEY
static final String	SERVLET_CONTEXT_PATH
static final String	SERVLET_REMOTE_ADDR
static final String	SERVLET_REMOTE_HOST
static final String	SERVLET_REMOTE_PORT
static final String	SERVLET_SCHEME
static final String	TRACE_CONTEXT_KEY
static final String	TRACE_ID

Method Summary

Modifier and Type	Method	Description
static void	addClientInfo(String clientIP, String clientHost, String clientPort, URI requestUri)
static void	addClientInfo(javax.servlet.ServletRequest request)	Adds the client info map to ThreadContext.
static String	addTraceId()	Adds the trace context and unique trace id to the ThreadContext.
static String	getContextPath()
static String	getRemoteAddress()
static String	getRemoteHost()
static String	getRemotePort()
static String	getScheme()
static String	getTraceId()
static void	removeClientInfo()	removes the client info map from the Thread Context
static void	removeTraceId()	removes the trace context map from the ThreadContext

Methods inherited from class java.lang.Object

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

Field Details

TRACE_CONTEXT_KEY

public static final String TRACE_CONTEXT_KEY

See Also:

• Constant Field Values

TRACE_ID

public static final String TRACE_ID

See Also:

• Constant Field Values

CLIENT_INFO_KEY

public static final String CLIENT_INFO_KEY

See Also:

• Constant Field Values

SERVLET_REMOTE_ADDR

public static final String SERVLET_REMOTE_ADDR

See Also:

• Constant Field Values

SERVLET_REMOTE_HOST

public static final String SERVLET_REMOTE_HOST

See Also:

• Constant Field Values

SERVLET_REMOTE_PORT

public static final String SERVLET_REMOTE_PORT

See Also:

• Constant Field Values

SERVLET_SCHEME

public static final String SERVLET_SCHEME

See Also:

• Constant Field Values

SERVLET_CONTEXT_PATH

public static final String SERVLET_CONTEXT_PATH

See Also:

• Constant Field Values

Method Details

addTraceId

public static String addTraceId()

Adds the trace context and unique trace id to the ThreadContext.

Returns:

traceId in ThreadContext

getTraceId

public static String getTraceId()

Returns:

trace-id from ThreadContext if it exists otherwise returns null

removeTraceId

public static void removeTraceId()

removes the trace context map from the ThreadContext

addClientInfo

public static void addClientInfo(javax.servlet.ServletRequest request)

Adds the client info map to ThreadContext. The Client Info can include the client's IP address, client host, client port, and the request context path.

Parameters:

request - the servlet request containing the client address info

addClientInfo

public static void addClientInfo(String clientIP,
 @Nullable
 String clientHost,
 @Nullable
 String clientPort,
 @Nullable
 URI requestUri)

Parameters:

clientIP -

clientHost -

clientPort -

requestUri -

getRemoteAddress

public static String getRemoteAddress()

Returns:

the client IP address or null if not present

getRemotePort

public static String getRemotePort()

Returns:

the client Port address or null if not present

getRemoteHost

public static String getRemoteHost()

Returns:

the client host name or null if it not present

getContextPath

public static String getContextPath()

Returns:

the context path of the request if available or null if not present

getScheme

public static String getScheme()

Returns:

the scheme of the request if available or null if not present

removeClientInfo

public static void removeClientInfo()

removes the client info map from the Thread Context