net.eduvax.util

Class Event

java.lang.Object

net.eduvax.util.Event

public class Event
extends java.lang.Object

Timed event. The message template table associated to this event class must be registered as an application singleton. This table is a Hashtable<String,String>. The key use to identify the table singleton in App service is this class' Class instance : // register message table Hashtable<String,String> table= .... ; App.get().setSingleton(Event.class,table); Do the same for each Event class' subclasse.

See Also:

singleton management service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.ELevel Event severity classification

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Vector<java.lang.Object>	_args Event's arguments.
private java.lang.String	_id Event type identification
private Event.ELevel	_level level / severity
private long	_timestamp event timestamp.
static java.lang.String	I_CMDDONE command succeed ident suffix.
static java.lang.String	I_CMDFAILED command failed ident suffix.
static java.lang.String	I_CMDREFUSED command rejected ident suffix.
static java.lang.String	I_CMDSTART command start ident suffix.
static java.lang.String	I_CMDSTEPKO command step failed ident suffix.
static java.lang.String	I_CMDSTEPOK command step OK ident suffix.

Constructor Summary

Constructors

Constructor and Description
Event(long ts, java.lang.String id, Event.ELevel level) Create anti-dated timestamp.
Event(java.lang.String id, Event.ELevel level) Create new event.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArg(java.lang.Object arg) Add argument to this event.
boolean	checkId(java.lang.String id) type event name comparison.
java.lang.Object	getArg(int index) Retrieve an argument.
int	getArgCount()
java.lang.String	getId()
protected java.lang.String	getIdPrefix() Get event class identification.
Event.ELevel	getLevel()
java.lang.String	getMessage() Get text message for the event.
long	getTimeStamp() Get event timestamp.
static Event.ELevel	parseLevel(java.lang.String l) String to level Enum utility
java.lang.String	toString() Get message full text description.

Methods inherited from class java.lang.Object

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

Field Detail

_timestamp

private long _timestamp

event timestamp. Default is system date in milliseconds

_args

private java.util.Vector<java.lang.Object> _args

Event's arguments.

_level

private Event.ELevel _level

level / severity

_id

private java.lang.String _id

Event type identification

I_CMDSTART

public static final java.lang.String I_CMDSTART

command start ident suffix.

See Also:

Constant Field Values

I_CMDSTEPOK

public static final java.lang.String I_CMDSTEPOK

command step OK ident suffix.

See Also:

Constant Field Values

I_CMDSTEPKO

public static final java.lang.String I_CMDSTEPKO

command step failed ident suffix.

See Also:

Constant Field Values

I_CMDDONE

public static final java.lang.String I_CMDDONE

command succeed ident suffix.

See Also:

Constant Field Values

I_CMDFAILED

public static final java.lang.String I_CMDFAILED

command failed ident suffix.

See Also:

Constant Field Values

I_CMDREFUSED

public static final java.lang.String I_CMDREFUSED

command rejected ident suffix.

See Also:

Constant Field Values

Constructor Detail

Event

public Event(java.lang.String id,
     Event.ELevel level)

Create new event.

Parameters:

id - event identification.

level - event severity.

Event

public Event(long ts,
     java.lang.String id,
     Event.ELevel level)

Create anti-dated timestamp.

Parameters:

ts - timestamp (must be consistant with auto-dated event that use system date in milliseconds to allow correct sort if required).

id - event type identification

level - event severity.

Method Detail

getTimeStamp

public long getTimeStamp()

Get event timestamp.

Returns:

the timestamp.

getMessage

public java.lang.String getMessage()

Get text message for the event.

Returns:

textual description of the event. In case of no template in message table, default string is event id followed by event arguments separated by tab char.

addArg

public void addArg(java.lang.Object arg)

Add argument to this event.

Parameters:

arg - argument to add.

getArg

public java.lang.Object getArg(int index)

Retrieve an argument.

Arguments expeceted regarding the event ID (non limitative, default use in this package, each package should subclass with its own Event class to avoid any conflict in customization) :

- I_CMDSTART, I_CMDDONE, I_CMDFAILED, I_CMDREFUSED : command identification - I_CMDSTEPOK, I_CMDSTEPKO : - command identification. - progression indicator (double value from 0 to 1)

Parameters:

index - argument index (first is 0).

Returns:

the requested argument or null if index overflow.

getArgCount

public int getArgCount()

Returns:

arguments count.

getIdPrefix

protected java.lang.String getIdPrefix()

Get event class identification. Subclasses should overrid to return their own class identification.

Returns:

"GE." (e.g. generic event)

toString

public java.lang.String toString()

Get message full text description. String containing fields separated by tab char. List fo fields : - timestamp - level/severity - id - message as returned by getMessage() (may include sub fields also separated by tab char).

Overrides:

toString in class java.lang.Object

Returns:

string representation of this event.

getLevel

public Event.ELevel getLevel()

Returns:

event level / severity

parseLevel

public static Event.ELevel parseLevel(java.lang.String l)

String to level Enum utility. - err, error : ELevel.ERROR - warn, warning : ELevel.WARNING - info : ELevel.INFO - info+, info1, infodet : ELevel.INFO1 - info++, info2 : ELevel.INFO2 - any other : ELevel.DEBUG

Parameters:

l - string to convert, not case sensitive.

Returns:

level Enum.

getId

public java.lang.String getId()

Returns:

event type name.

checkId

public boolean checkId(java.lang.String id)

type event name comparison.

Parameters:

id - candidate ident.

Returns:

- true : candidate ident is equals to this event's id (including prefix) - otherwise false.