com.netscape.certsrv.logging

Interface ILogEvent

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IBundleLogEvent

All Known Implementing Classes:

AuditEvent, SignedAuditEvent, SystemEvent

public interface ILogEvent
extends java.io.Serializable

An interface which all loggable events must implement. CMS comes with a limited set of ILogEvent types to implement: audit, system, and signed audit. This is the base class of all the subsequent implemented types. A log event represents a certain kind of log message designed for a specific purpose. For instance, an audit type event represents messages having to do with auditable CMS actions. The resulting message will ultimately appear into a specific log file.

Version:

$Revision$, $Date$

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventType() Retrieves log event type.
int	getLevel() Retrieves log level.
boolean	getMultiline() Retrieves multiline attribute.
int	getNTEventType() Retrieves NT specific log event type.
int	getSource() Retrieves log source.
long	getTimeStamp() Retrieves event time stamp.
void	setEventType(java.lang.String eventType) Sets log event type.
java.lang.String	toContent() Returns localized message string.
java.lang.String	toContent(java.util.Locale locale) Returns the string based on the given locale.

Method Detail

getTimeStamp

long getTimeStamp()

Retrieves event time stamp.

Returns:

Long integer of the time the event was created.

getSource

int getSource()

Retrieves log source. This is an id of the subsystem responsible for creating the log event.

Returns:

Integer source id.

getLevel

int getLevel()

Retrieves log level. The log level of an event represents its relative importance or severity within CMS.

Returns:

Integer log level value.

getNTEventType

int getNTEventType()

Retrieves NT specific log event type.

Returns:

Integer NTEventType value.

getMultiline

boolean getMultiline()

Retrieves multiline attribute. Does this message consiste of more than one line.

Returns:

Boolean of multiline status.

getEventType

java.lang.String getEventType()

Retrieves log event type. Each type of event has an associated String type value.

Returns:

String containing the type of event.

setEventType

void setEventType(java.lang.String eventType)

Sets log event type. Each type of event has an associated String type value.

Parameters:

eventType - String containing the type of event.

toContent

java.lang.String toContent()

Returns localized message string. This method should only be called if a localized string is necessary.

Returns:

Details message.

toContent

java.lang.String toContent(java.util.Locale locale)

Returns the string based on the given locale.

Parameters:

locale - locale

Returns:

Details message.