Package com.netscape.certsrv.logging
Class LogEvent
- java.lang.Object
-
- com.netscape.certsrv.logging.LogEvent
-
- All Implemented Interfaces:
ILogEvent
,java.io.Serializable
- Direct Known Subclasses:
AuditEvent
,SignedAuditEvent
public class LogEvent extends java.lang.Object implements ILogEvent
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LogEvent()
LogEvent(java.lang.Exception e)
Constructs a message from a base exception.LogEvent(java.lang.String msgFormat)
Constructs a message eventLogEvent(java.lang.String msgFormat, java.lang.Exception exception)
Constructs a message from an exception.LogEvent(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.LogEvent(java.lang.String msgFormat, java.lang.String param)
Constructs a message with a parameter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.LogSource
getSource()
Retrieves log source.long
getTimeStamp()
Retrieves event time stamp.void
setEventType(java.lang.String eventType)
Sets log event type.void
setLevel(int level)
Sets log level, NT log event type.void
setMessage(java.lang.String message)
void
setMultiline(boolean multiline)
Sets log multiline attribute.void
setParameters(java.lang.Object[] params)
Sets audit event's parameters.void
setSource(LogSource source)
Sets log source.java.lang.String
toString()
Return string representation of log message.
-
-
-
Constructor Detail
-
LogEvent
public LogEvent()
-
LogEvent
public LogEvent(java.lang.String msgFormat)
Constructs a message event- Parameters:
msgFormat
- the message string
-
LogEvent
public LogEvent(java.lang.String msgFormat, java.lang.String param)
Constructs a message with a parameter. For example,new AuditEvent("failed to load {0}", fileName);
- Parameters:
msgFormat
- details in message string formatparam
- message string parameter
-
LogEvent
public LogEvent(java.lang.String msgFormat, java.lang.Exception exception)
Constructs a message from an exception. It can be used to carry a system exception that may contain information about the context. For example,try { ... } catch (IOExeption e) { logHandler.log(new AuditEvent("Encountered System Error {0}", e); }
- Parameters:
msgFormat
- exception details in message string formatexception
- system exception
-
LogEvent
public LogEvent(java.lang.Exception e)
Constructs a message from a base exception. This will use the msgFormat from the exception itself.try { ... } catch (Exception e) { logHandler.log(new AuditEvent(e)); }
- Parameters:
e
- CMS exception
-
LogEvent
public LogEvent(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.- Parameters:
msgFormat
- message string formatparams
- list of message format parameters
-
-
Method Detail
-
getMessage
public java.lang.String getMessage()
Returns the current message format string.- Returns:
- details message
-
setMessage
public void setMessage(java.lang.String message)
-
getParameters
public java.lang.Object[] getParameters()
Returns a list of parameters.- Returns:
- list of message format parameters
-
setParameters
public void setParameters(java.lang.Object[] params)
Sets audit event's parameters.
-
getSource
public LogSource getSource()
Retrieves log source.
-
setSource
public void setSource(LogSource source)
Sets log source.- Parameters:
source
- the component source where this message event was triggered
-
getLevel
public int getLevel()
Retrieves log level. The log level of an event represents its relative importance or severity within CMS.
-
getNTEventType
public int getNTEventType()
Retrieves NT specific log event type.- Specified by:
getNTEventType
in interfaceILogEvent
- Returns:
- Integer NTEventType value.
-
setLevel
public void setLevel(int level)
Sets log level, NT log event type. For certain log levels the NT log event type gets set as well.- Parameters:
level
- Integer log level value.
-
getMultiline
public boolean getMultiline()
Retrieves log multiline attribute.- Specified by:
getMultiline
in interfaceILogEvent
- Returns:
- Boolean whether or not this event is multiline. A multiline message simply consists of more than one line.
-
setMultiline
public void setMultiline(boolean multiline)
Sets log multiline attribute. A multiline message consists of more than one line.- Parameters:
multiline
- Boolean multiline value.
-
getTimeStamp
public long getTimeStamp()
Retrieves event time stamp.- Specified by:
getTimeStamp
in interfaceILogEvent
- Returns:
- Long integer of the time the event was created.
-
getEventType
public java.lang.String getEventType()
Retrieves log event type. Each type of event has an associated String type value.- Specified by:
getEventType
in interfaceILogEvent
- Returns:
- String containing the type of event.
-
setEventType
public void setEventType(java.lang.String eventType)
Sets log event type. Each type of event has an associated String type value.- Specified by:
setEventType
in interfaceILogEvent
- Parameters:
eventType
- String containing the type of event.
-
toString
public java.lang.String toString()
Return string representation of log message.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String containing log message.
-
-