net.shibboleth.idp.log

Class BaseEvent

java.lang.Object

net.shibboleth.idp.log.BaseEvent

Direct Known Subclasses:

PerformanceEvent

public abstract class BaseEvent
extends Object

An event to be logged. An event message is logged by calling the Object.toString() method on the Event. It is expected that most events will result in a character separated list of name/value pairs fit for subsequent processing by scripts or analysis software. This is NOT requirement, just a general observation.

Field Summary

Fields

Modifier and Type	Field and Description
private String	message A human readable message associated with the event.

Constructor Summary

Constructors

Constructor and Description
BaseEvent()

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessage() Gets the message associated with the event.
abstract String	getType() Gets the type of event.
void	setMessage(String msg) Sets the message associated with the event.

Methods inherited from class java.lang.Object

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

Field Detail

message

private String message

A human readable message associated with the event. This message should always come last in the event string.

Constructor Detail

BaseEvent

public BaseEvent()

Method Detail

getType

public abstract String getType()

Gets the type of event.

Returns:

the type of the event, used to help determine which log will receive the event.

getMessage

public String getMessage()

Gets the message associated with the event.

Returns:

message associated with the event

setMessage

public void setMessage(String msg)

Sets the message associated with the event.

Parameters:

msg - message associated with the event