ariba.util.log
Class AuditLogger

java.lang.Object
  org.apache.log4j.Category
      org.apache.log4j.Logger
          ariba.util.log.Logger
              ariba.util.log.AuditLogger

All Implemented Interfaces:

org.apache.log4j.spi.AppenderAttachable

public class AuditLogger
extends Logger

AuditLogger is a special logger implemented to provide a framework for event auditing. One of the major design goals is to make it easy for developers to use. Towards this end, the API closely resembles ariba's logging API. After all, AuditLogger is actually a subclass of Logger.

Instead of doing something like Log.util.info(messageId, arg1, arg2,...), call Log.aribaAudit.auditInfo(messageId, Object, arg1, arg2, ...). Here, aribaAudit is a user defined 'audit logger'. The similarity between the 2 calls is evident.

The differences are:

• The string 'audit' is prepended to the info, error, warning methods: Instead of info, warning, error, the method names are auditInfo, auditWarning, auditError. Note that there is no support for debug level. This is intentional since this is auditing, not debugging.
• The various audit methods return a unique long int that serves as an Id that specifies this audit event, which is persisted to the database by the special ariba.app.server.AuditAppender appender.
• auditInfo and auditWarning take an additional Object parameter which specifies a context object (if any) that can be referenced by this audit event. The auditError method takes yet another additional parameter (Throwable) to spefify the stack trace where applicable.
• The usual debug, info, warning, error methods are not allowed. For example, calling Log.aribaAudit.info(...) results in an error. Use Log.aribaAudit.auditInfo instead.

The following are the quick and easy steps of using the auditing framework, assuming we want to audit events in the app.admin component.

• define the logger aribaAudit.admin by adding the following entry in ariba/util/log/PrivateLoggers.csv:

  aribaAudit.admin, ariba.app.audit.AuditLoggerFactory

  This will result in the aribaAudit.admin audit logger created with the above logger factory. It is important that the correct logger factory (and no typos please) be used.

• If the aribaAudit logger has not been added in the logging section in Parameters.table, add aribaAudit to the System.Logging.AribaAuditingAppender.Categories parameter. System.Logging.Categories should have aribaAudit:INFO, add this too if not already present. And of course, enable the appender by setting System.Logging.AribaAuditingAppender.Disable to false (default is true, we don't audit by default). The audit calls will have no effect this Disabled flag is true. One can also control the logging by turning on/off the aribaAudit (and its children) loggers, in exactly the same way other loggers work.
• Define this logger is the Log.java in the component in this case app.admin

           import ariba.base.audit.AuditLogger;
           public static final AuditLogger aribaAuditAdmin =
                       (AuditLogger)Logger.getLogger("aribaAudit.admin");
      

• Create Log.aribaAudit.admin.csv in the resource directory in the app.admin component as usual to specify any messages you want to audit. This csv file has exactly the same format as any other csv files used by the logging framework.

• audit an event, example:
           long id = Log.aribaAudit.admin.auditInfo(1234, contextObject, "auditing an event");
           if (id >= 0) {
              // audit logging is successful
              ....
           }
           else {
             // audit log is not successful, nothing persisted.
             // the value can be either a defined IgnoreNameLongValue (which basically says the audit logger is not
             // enabled, so nothing is done), or defined InvalidNameLongValue (which means some error happens, may
             // be the transaction commit fails, or some other errors).
             ...
           }
           The above persists an audit event specified by 'id' into a table named "AuditInfo".
           The detailed localized message is looked up from message code 1234 in Log.aribaAudit.admin.csv.
      

Field Summary

static java.lang.String	aribaAuditCommitNowName
static java.lang.String	aribaAuditName
static java.lang.String	FQCN The fully qualified name of this class.

Fields inherited from class ariba.util.log.Logger

CategoryDelimiter, LogDescTable, OptionLog, OptionLogWhere, SeverityDelimiter, stringTable, StringTableFormat, StringTablePrefix

Constructor Summary

AuditLogger(java.lang.String name, AuditLoggerMessageFactory factory)

Method Summary

long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, int a1) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, int a1, int a2) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, int a1, int a2, int a3) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, int a1, java.lang.Object a2) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.util.List args) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, int a2) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, int a2, int a3) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, int a3) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6) Audit an error message
long	auditError(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object[] more) Audit an error message
long	auditInfo(int messageID, java.lang.Object contextObject) Audit an info message
long	auditInfo(int messageID, java.lang.Object contextObject, int a1) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, int a1, int a2) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, int a1, int a2, int a3) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, int a1, java.lang.Object a2) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.util.List args) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, int a2) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, int a2, java.lang.Object a3) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, int a3) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6) Audit an warning message
long	auditInfo(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object[] more) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, int a1) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, int a1, int a2) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, int a1, int a2, int a3) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, int a1, java.lang.Object a2) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.util.List args) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, int a2) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, int a2, int a3) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, int a3) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object[] more) Audit an warning message
long	auditWarning(int messageID, java.lang.Object contextObject, java.lang.Throwable t, java.util.List args) Audit an warning message
static java.util.Iterator	getCategories()
static java.lang.String	getCategoryName(java.lang.String resource, java.util.Locale locale) Must return resource if the category is not found.
static java.lang.String	getCompletedMessage(java.util.List args, java.lang.String name, java.lang.String id, java.util.Locale locale) Given a locale, use the static resource name and arguments to materialize the final message.
void	setLevel(org.apache.log4j.Level level)

Methods inherited from class ariba.util.log.Logger

addAppender, addAppenderFromFlags, addAppenderToLoggers, addCommonAppendersToEmptyLoggers, callAppenders, checkRegistration, convertEarlyChecks, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, description, description, error, error, error, error, error, error, error, error, error, getAllAppenders, getInstance, getLogger, info, info, info, info, info, info, info, info, info, isPrivate, isSuspendCheckingOn, localizeMessage, makeSuppressable, printWhere, processArguments, removeAppenderFromFlags, removeAppenderFromLoggers, setLevelsFromFlags, setLocaleToUse, setSuspendChecking, setupArguments, warning, warning, warning, warning, warning, warning, warning, warning, warning

Methods inherited from class org.apache.log4j.Logger

getLogger, getLogger, getRootLogger, isTraceEnabled, trace, trace

Methods inherited from class org.apache.log4j.Category

assertLog, callAppenders, debug, error, error, exists, fatal, fatal, getAdditivity, getAppender, getChainedPriority, getCurrentCategories, getDefaultHierarchy, getEffectiveLevel, getHierarchy, getInstance, getLevel, getLoggerRepository, getName, getParent, getPriority, getResourceBundle, getRoot, info, info, isAttached, isDebugEnabled, isEnabledFor, isInfoEnabled, l7dlog, l7dlog, log, log, log, removeAllAppenders, removeAppender, removeAppender, setAdditivity, setPriority, setResourceBundle, shutdown, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

FQCN

public static java.lang.String FQCN

The fully qualified name of this class.

aribaAuditName

public static final java.lang.String aribaAuditName

See Also:

Constant Field Values

aribaAuditCommitNowName

public static final java.lang.String aribaAuditCommitNowName

See Also:

Constant Field Values

Constructor Detail

AuditLogger

public AuditLogger(java.lang.String name,
                   AuditLoggerMessageFactory factory)

Method Detail

getCompletedMessage

public static java.lang.String getCompletedMessage(java.util.List args,
                                                   java.lang.String name,
                                                   java.lang.String id,
                                                   java.util.Locale locale)

Given a locale, use the static resource name and arguments to materialize the final message.

Parameters:

args - the values to substitute in the message template.

name - the string table name (though it may lack the StringTablePrefix).

id - the key into the string table to get the template.

locale - the locale to use for the parameters and resource.

Returns:

the localized, completed message

getCategoryName

public static java.lang.String getCategoryName(java.lang.String resource,
                                               java.util.Locale locale)

Must return resource if the category is not found.

getCategories

public static java.util.Iterator getCategories()

setLevel

public void setLevel(org.apache.log4j.Level level)

Overrides:

setLevel in class Logger

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject)

Audit an info message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      java.lang.Object a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      java.lang.Object a3,
                      java.lang.Object a4)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      java.lang.Object a3,
                      java.lang.Object a4,
                      java.lang.Object a5)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      java.lang.Object a3,
                      java.lang.Object a4,
                      java.lang.Object a5,
                      java.lang.Object a6)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

a6 - the sixth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      java.lang.Object a3,
                      java.lang.Object a4,
                      java.lang.Object a5,
                      java.lang.Object a6,
                      java.lang.Object[] more)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

a6 - the sixth argument to the format string of messageID Can be null

more - addtional arguments

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.util.List args)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

args - the argument list

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      int a1)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      int a1,
                      int a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      int a1,
                      java.lang.Object a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      int a1,
                      int a2,
                      int a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      int a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      int a2,
                      java.lang.Object a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditInfo

public long auditInfo(int messageID,
                      java.lang.Object contextObject,
                      java.lang.Object a1,
                      java.lang.Object a2,
                      int a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         java.lang.Object a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         java.lang.Object a3,
                         java.lang.Object a4)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         java.lang.Object a3,
                         java.lang.Object a4,
                         java.lang.Object a5)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         java.lang.Object a3,
                         java.lang.Object a4,
                         java.lang.Object a5,
                         java.lang.Object a6)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

a6 - the sixth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         java.lang.Object a3,
                         java.lang.Object a4,
                         java.lang.Object a5,
                         java.lang.Object a6,
                         java.lang.Object[] more)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

a6 - the sixth argument to the format string of messageID Can be null

more - addtional arguments

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Throwable t,
                         java.util.List args)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - an associated throwable

args - the argument list

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.util.List args)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

args - the argument list

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         int a1)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         int a1,
                         int a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         int a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         int a1,
                         java.lang.Object a2)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         int a1,
                         int a2,
                         int a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         java.lang.Object a2,
                         int a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditWarning

public long auditWarning(int messageID,
                         java.lang.Object contextObject,
                         java.lang.Object a1,
                         int a2,
                         int a3)

Audit an warning message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       java.lang.Object a3)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       java.lang.Object a3,
                       java.lang.Object a4)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       java.lang.Object a3,
                       java.lang.Object a4,
                       java.lang.Object a5)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       java.lang.Object a3,
                       java.lang.Object a4,
                       java.lang.Object a5,
                       java.lang.Object a6)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID Can be null

a4 - the fourth argument to the format string of messageID Can be null

a5 - the fifth argument to the format string of messageID

a6 - the sixth argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       int a1)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       int a2)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       int a2,
                       int a3)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       int a1,
                       java.lang.Object a2)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID Can be null

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       int a1,
                       int a2)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       int a1,
                       int a2,
                       int a3)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID

a2 - the second argument to the format string of messageID

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       int a3)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID Can be null

a2 - the second argument to the format string of messageID Can be null

a3 - the third argument to the format string of messageID

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.lang.Object a1,
                       java.lang.Object a2,
                       java.lang.Object a3,
                       java.lang.Object a4,
                       java.lang.Object a5,
                       java.lang.Object a6,
                       java.lang.Object[] more)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

a1 - the first argument to the format string of messageID. Can be null.

a2 - the second argument to the format string of messageID Can be null.

a3 - the third argument to the format string of messageID Can be null.

a4 - the fourth argument to the format string of messageID Can be null.

a5 - the fifth argument to the format string of messageID Can be null.

a6 - the sixth argument to the format string of messageID Can be null.

more - additional arguments to the format string of messageID Can be null.

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.

auditError

public long auditError(int messageID,
                       java.lang.Object contextObject,
                       java.lang.Throwable t,
                       java.util.List args)

Audit an error message

Parameters:

messageID - id of the message used to localize the message.

contextObject - the context object, a cluster root (can be null) that provides the context related to this auditing event.

t - the throwable, if any. Can be null

args - a list of arguments to provide the details of the message.

Returns:

a unique long integer which if non-negative specifies a unique audit log event being successfully audited. Returns #IgnoreNameLongValue if the audit log mechanism is not enabled. Returns #InvalidNameLongValue if the audit logging event failed.