org.apache.knox.gateway.audit.log4j.correlation

Class Log4jCorrelationContext

java.lang.Object

org.apache.knox.gateway.audit.log4j.correlation.Log4jCorrelationContext

All Implemented Interfaces:

Externalizable, Serializable, CorrelationContext

public class Log4jCorrelationContext
extends Object
implements Externalizable, CorrelationContext

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Log4jCorrelationContext()
Log4jCorrelationContext(String requestId, String parentRequestId, String rootRequestId)

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	readExternal(ObjectInput in)
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.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4jCorrelationContext

public Log4jCorrelationContext()

Log4jCorrelationContext

public Log4jCorrelationContext(String requestId,
                               String parentRequestId,
                               String rootRequestId)

Method Detail

getRequestId

public String getRequestId()

Description copied from interface: CorrelationContext

A unique value representing the current, active request.

Specified by:

getRequestId in interface CorrelationContext

Returns:

A unique value representing the current, active request.

setRequestId

public void setRequestId(String requestId)

Description copied from interface: CorrelationContext

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.

Specified by:

setRequestId in interface CorrelationContext

Parameters:

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

getParentRequestId

public String getParentRequestId()

Description copied from interface: CorrelationContext

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

Specified by:

getParentRequestId in interface CorrelationContext

Returns:

The parent request ID.

setParentRequestId

public void setParentRequestId(String parentRequestId)

Description copied from interface: CorrelationContext

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

Specified by:

setParentRequestId in interface CorrelationContext

Parameters:

parentRequestId - The parent request ID.

getRootRequestId

public String getRootRequestId()

Description copied from interface: CorrelationContext

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

Specified by:

getRootRequestId in interface CorrelationContext

Returns:

The root request ID.

setRootRequestId

public void setRootRequestId(String rootRequestId)

Description copied from interface: CorrelationContext

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

Specified by:

setRootRequestId in interface CorrelationContext

Parameters:

rootRequestId - The root request ID.

toString

public String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

destroy

public void destroy()

Description copied from interface: CorrelationContext

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.

Specified by:

destroy in interface CorrelationContext