|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.netscape.certsrv.logging.AuditEvent
public class AuditEvent
The log event object that carries message detail of a log event that goes into the Transaction log. Note that the name of this class "AuditEvent" is legacy and has nothing to do with the signed audit log events, whcih are represented by SignedAuditEvent.
MessageFormat
,
LogResources
,
Serialized FormField Summary | |
---|---|
protected java.lang.Object[] |
mParams
|
Constructor Summary | |
---|---|
AuditEvent(java.lang.Exception e)
Constructs a message from a base exception. |
|
AuditEvent(java.lang.String msgFormat)
Constructs a message event |
|
AuditEvent(java.lang.String msgFormat,
java.lang.Exception exception)
Constructs a message from an exception. |
|
AuditEvent(java.lang.String msgFormat,
java.lang.Object[] params)
Constructs a message event with a list of parameters that will be substituted into the message format. |
|
AuditEvent(java.lang.String msgFormat,
java.lang.String param)
Constructs a message with a parameter. |
Method Summary | |
---|---|
protected java.lang.String |
getBundleName()
Retrieves bundle name. |
java.lang.String |
getEventType()
Retrieves log event type. |
int |
getLevel()
Retrieves log level. |
java.lang.String |
getMessage()
Returns the current message format string. |
boolean |
getMultiline()
Retrieves log multiline attribute. |
int |
getNTEventType()
Retrieves NT specific log event type. |
java.lang.Object[] |
getParameters()
Returns a list of parameters. |
int |
getSource()
Retrieves log source. |
long |
getTimeStamp()
Retrieves event time stamp. |
void |
setBundleName(java.lang.String bundle)
Gets the resource bundle name for this class instance. |
void |
setEventType(java.lang.String eventType)
Sets log event type. |
void |
setLevel(int level)
Sets log level, NT log event type. |
void |
setMultiline(boolean multiline)
Sets log multiline attribute. |
void |
setSource(int source)
Sets log source. |
java.lang.String |
toContent()
Returns localized message string. |
java.lang.String |
toContent(java.util.Locale locale)
Returns the string based on the given locale. |
java.lang.String |
toString()
Return string representation of log message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.Object[] mParams
Constructor Detail |
---|
public AuditEvent(java.lang.String msgFormat)
msgFormat
- the message stringpublic AuditEvent(java.lang.String msgFormat, java.lang.String param)
new AuditEvent("failed to load {0}", fileName);
msgFormat
- details in message string formatparam
- message string parameterpublic AuditEvent(java.lang.String msgFormat, java.lang.Exception exception)
try { ... } catch (IOExeption e) { logHandler.log(new AuditEvent("Encountered System Error {0}", e); }
msgFormat
- exception details in message string formatexception
- system exceptionpublic AuditEvent(java.lang.Exception e)
try { ... } catch (Exception e) { logHandler.log(new AuditEvent(e)); }
e
- CMS exceptionpublic AuditEvent(java.lang.String msgFormat, java.lang.Object[] params)
msgFormat
- message string formatparams
- list of message format parametersMethod Detail |
---|
public java.lang.String getMessage()
public java.lang.Object[] getParameters()
public java.lang.String toContent()
toContent
in interface ILogEvent
public java.lang.String toContent(java.util.Locale locale)
toContent
in interface ILogEvent
locale
- locale
public void setBundleName(java.lang.String bundle)
setBundleName
in interface IBundleLogEvent
bundle
- String that represents the resource bundle name to be setprotected java.lang.String getBundleName()
public int getSource()
getSource
in interface ILogEvent
public void setSource(int source)
source
- an integer that represents the component source
where this message event was triggeredpublic int getLevel()
getLevel
in interface ILogEvent
public int getNTEventType()
getNTEventType
in interface ILogEvent
public void setLevel(int level)
level
- Integer log level value.public boolean getMultiline()
getMultiline
in interface ILogEvent
public void setMultiline(boolean multiline)
multiline
- Boolean multiline value.public long getTimeStamp()
getTimeStamp
in interface ILogEvent
public java.lang.String getEventType()
getEventType
in interface ILogEvent
public void setEventType(java.lang.String eventType)
setEventType
in interface ILogEvent
eventType
- String containing the type of event.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |