org.apache.knox.gateway.audit.api

Interface CorrelationContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

Log4jCorrelationContext

public interface CorrelationContext
extends Serializable

Method Summary

Modifier and Type	Method and Description
void	destroy() Would be used to indicate that the context can be cleaned and reused.
String	getParentRequestId() The parent request ID if this is a sub-request.
String	getRequestId() A unique value representing the current, active request.
String	getRootRequestId() The root request ID if this is a sub-request.
void	setParentRequestId(String parentRequestId) Sets the parent request ID if this is a sub-request.
void	setRequestId(String requestId) A unique value representing the current, active request.
void	setRootRequestId(String rootRequestId) Sets the root request ID if this is a sub-request.

Method Detail

getRequestId

String getRequestId()

A unique value representing the current, active request.

Returns:

A unique value representing the current, active request.

setRequestId

void setRequestId(String requestId)

A unique value representing the current, active request. If the current request id value is different from the current parent request id value then the current request id value is moved to the parent request id before it is replaced by the provided request id. If the root request id is not set it will be set with the first non-null value of either the parent request id or the passed request id.

Parameters:

requestId - A unique value representing the current, active request.

getParentRequestId

String getParentRequestId()

The parent request ID if this is a sub-request.

Returns:

The parent request ID.

setParentRequestId

void setParentRequestId(String parentRequestId)

Sets the parent request ID if this is a sub-request.

Parameters:

parentRequestId - The parent request ID.

getRootRequestId

String getRootRequestId()

The root request ID if this is a sub-request.

Returns:

The root request ID.

setRootRequestId

void setRootRequestId(String rootRequestId)

Sets the root request ID if this is a sub-request.

Parameters:

rootRequestId - The root request ID.

destroy

void destroy()

Would be used to indicate that the context can be cleaned and reused. This is only important if the service would like to maintain a pool of available "empty" context that can be reused to limit memory allocation and garbage collection.