io.jenkins.plugins.audit

Class RequestContext

java.lang.Object

io.jenkins.plugins.audit.RequestContext

public final class RequestContext
extends Object

Defines all the variables that an application needs to be available in the ThreadContext for audit logging and general application usage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IP_ADDRESS
static String	NODE_NAME
static String	REQUEST_ID
static String	REQUEST_URI
static String	TIMESTAMP
static String	USER_ID

Constructor Summary

Constructors

Constructor and Description
RequestContext()

Method Summary

Modifier and Type	Method and Description
static void	clear() The methods in this class are not required by framework components that use the RequestContext properties.
static String	getIpAddress()
static String	getNodeName()
static String	getRequestId()
static String	getRequestUri()
static String	getTimeStamp()
static String	getUserId()
static void	setIpAddress(String address)
static void	setNodeName(String nodeName)
static void	setRequestUri(String requestUri)
static void	setTimeStamp(String timestamp)
static void	setUserId(String userId)

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_ID

public static final String REQUEST_ID

See Also:

Constant Field Values

REQUEST_URI

public static final String REQUEST_URI

See Also:

Constant Field Values

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

TIMESTAMP

public static final String TIMESTAMP

See Also:

Constant Field Values

USER_ID

public static final String USER_ID

See Also:

Constant Field Values

IP_ADDRESS

public static final String IP_ADDRESS

See Also:

Constant Field Values

Constructor Detail

RequestContext

public RequestContext()

Method Detail

clear

public static void clear()

The methods in this class are not required by framework components that use the RequestContext properties. They are provided as a convenience for applications. If they are not provided the properties can be accessed directly through the Log4j ThreadContext Map using the keys above.

getRequestId

public static String getRequestId()

setIpAddress

public static void setIpAddress(String address)

getIpAddress

public static String getIpAddress()

setUserId

public static void setUserId(@Nonnull
                             String userId)

getUserId

public static String getUserId()

setRequestUri

public static void setRequestUri(String requestUri)

getRequestUri

public static String getRequestUri()

setNodeName

public static void setNodeName(@Nonnull
                               String nodeName)

getNodeName

public static String getNodeName()

setTimeStamp

public static void setTimeStamp(@Nonnull
                                String timestamp)

getTimeStamp

public static String getTimeStamp()