ariba.util.log
Interface AuditLoggerMessage

public interface AuditLoggerMessage

ToDo: javadoc

Field Summary

static long	IgnoreNameLongValue The various WithId methods in ariba.base.audit.AuditLogger return this if the underlying logger is not enabled, essentially this means a logical no-op has been performed.
static long	InvalidNameLongValue The various WithId methods in ariba.base.audit.AuditLogger return this if the logging operation failed.

Method Summary

java.util.List	getArgs()
java.lang.Object	getContextObject()
java.lang.String	getDescription()
java.lang.Object	getEffectiveUserId()
long	getId()
java.lang.String	getIPAddress()
int	getLevel() The (log4j) level of the message.
int	getMessageId()
java.lang.String	getNodeName()
int	getNumArgs()
int	getRealmId()
java.lang.Object	getRealUserId()
java.lang.String	getResourceName()
java.lang.String	getStringFromArg(java.lang.Object arg) Convenient method to obtain a string from the specified object.
java.lang.Throwable	getThrowable()
void	setArgs(java.util.List args)
void	setContextObject(java.lang.Object contextObject)
void	setId(long value) set the Id field.
void	setLevelAndThrowable(int level, java.lang.Throwable t)
void	setMessageId(int messageId)
void	setResourceName(java.lang.String name)

Field Detail

InvalidNameLongValue

static final long InvalidNameLongValue

The various WithId methods in ariba.base.audit.AuditLogger return this if the logging operation failed.

See Also:

Constant Field Values

IgnoreNameLongValue

static final long IgnoreNameLongValue

The various WithId methods in ariba.base.audit.AuditLogger return this if the underlying logger is not enabled, essentially this means a logical no-op has been performed.

See Also:

Constant Field Values

Method Detail

getStringFromArg

java.lang.String getStringFromArg(java.lang.Object arg)

Convenient method to obtain a string from the specified object.

Parameters:

arg - the specified object

Returns:

the string representing the object.

setId

void setId(long value)

set the Id field. This setter method is provided because the Id which is unique may not be known at the time of instantiation of this class. The inteneded use is that this method be called once in one thread (where the instance is created). Because of this, this is not synchronized

Parameters:

value - the value to set

getId

long getId()

getRealUserId

java.lang.Object getRealUserId()

getEffectiveUserId

java.lang.Object getEffectiveUserId()

getNodeName

java.lang.String getNodeName()

getIPAddress

java.lang.String getIPAddress()

getRealmId

int getRealmId()

setContextObject

void setContextObject(java.lang.Object contextObject)

getContextObject

java.lang.Object getContextObject()

getLevel

int getLevel()

The (log4j) level of the message.

setMessageId

void setMessageId(int messageId)

getMessageId

int getMessageId()

setResourceName

void setResourceName(java.lang.String name)

getResourceName

java.lang.String getResourceName()

setArgs

void setArgs(java.util.List args)

getArgs

java.util.List getArgs()

getNumArgs

int getNumArgs()

setLevelAndThrowable

void setLevelAndThrowable(int level,
                          java.lang.Throwable t)

getThrowable

java.lang.Throwable getThrowable()

getDescription

java.lang.String getDescription()