org.qbroker.event

Class Event

java.lang.Object

org.qbroker.event.Event

All Implemented Interfaces:

Event

Direct Known Subclasses:

JMSEvent

public class Event
extends java.lang.Object
implements Event

Event is a JMS like message for carrying payload to communicate to a Centralized Repository. It has its own transport method, send(), which can be used to send event to the repository if the logger has been initialized.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Object>	attribute
protected java.lang.Object	body
protected int	deliveryMode
static java.lang.String	ESCAPED_AMPERSAND
static java.lang.String	ESCAPED_CARRIAGE_RETURN
static java.lang.String	ESCAPED_EQUAL
static java.lang.String	ESCAPED_ITEM_SEPARATOR
static java.lang.String	ESCAPED_QUOTE
protected int	eventID
protected long	expiration
protected int	groupID
static java.lang.String	ITEM_SEPARATOR
static int	LOG_CENTRAL
static int	LOG_COMPACT
static int	LOG_JMS
static int	LOG_LOCAL
static int	LOG_SYSLOG
protected int	logMode
protected long	timestamp

Fields inherited from interface org.qbroker.common.Event

ALERT, CRIT, DEBUG, EMERG, ERR, INFO, NONE, NOTICE, priorityNames, TRACE, WARNING

Constructor Summary

Constructors

Constructor and Description
Event(int priority)
Event(int priority, java.lang.String message)
Event(int priority, java.lang.String message, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
boolean	attributeExists(java.lang.String name) tests if the attribute exists on the key
void	clearAttributes() clears all attributes of the event
static java.lang.String	dateFormat(java.util.Date date)
protected void	finalize()
static void	flush(java.lang.Throwable e) It prints out error msg and rethrows it if it is an Error
java.lang.String	getAttribute(java.lang.String name) returns the attribute on the key
java.util.Set<java.lang.String>	getAttributeNames() returns the iterator for all the keys of attributes
java.lang.Object	getBody()
protected static java.lang.String	getDefaultName()
long	getExpiration() returns the expiration of the event
int	getGroupID()
static int	getHostID()
static java.lang.String	getHostName()
static java.lang.String	getIPAddress()
static int	getPID()
int	getPriority() returns the priority of the event
static int	getPriorityByName(java.lang.String name) returns priority in number or -1 on a bad priority name
static java.lang.String	getProgramName()
long	getTimestamp() returns the timestamp of the event
void	log() logs to the file according to programName
static java.util.Date	parseDate(java.lang.String date)
void	print(java.io.PrintStream stream)
java.lang.String	removeAttribute(java.lang.String name) removes the attribute on the key
void	send()
void	setAttribute(java.lang.String name, java.lang.String value) It sets an attribute of the Event
void	setBody(java.lang.Object obj) It sets the body of the Event with an Object which may not be transportable.
static void	setDefaultCategory(java.lang.String category)
static void	setDefaultName(java.lang.String name)
static void	setDefaultSite(java.lang.String site)
static void	setDefaultType(java.lang.String type)
void	setExpiration(long ts) sets the expiration of the event
void	setGroupID(int gid)
static void	setLogDir(java.lang.String dir) It sets the log dir and initializes the logger without date pattern.
static void	setLogDir(java.lang.String dir, java.lang.String datePattern) It sets the log dir for the events and initializes the logger with the given date pattern.
static void	setLogDir(java.lang.String dir, java.lang.String maxSize, int maxBackups) It sets the log dir for the events and initializes the logger with the given size limit and number of backups
void	setPriority(int p) sets the priority of the event
void	setTimestamp(long ts) sets the timestamp of the event
static java.lang.String	traceStack(java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_LOCAL

public static final int LOG_LOCAL

See Also:

Constant Field Values

LOG_CENTRAL

public static final int LOG_CENTRAL

See Also:

Constant Field Values

LOG_COMPACT

public static final int LOG_COMPACT

See Also:

Constant Field Values

LOG_JMS

public static final int LOG_JMS

See Also:

Constant Field Values

LOG_SYSLOG

public static final int LOG_SYSLOG

See Also:

Constant Field Values

eventID

protected int eventID

groupID

protected int groupID

logMode

protected int logMode

deliveryMode

protected int deliveryMode

timestamp

protected long timestamp

expiration

protected long expiration

attribute

protected final java.util.HashMap<java.lang.String,java.lang.Object> attribute

body

protected java.lang.Object body

ITEM_SEPARATOR

public static final java.lang.String ITEM_SEPARATOR

See Also:

Constant Field Values

ESCAPED_ITEM_SEPARATOR

public static final java.lang.String ESCAPED_ITEM_SEPARATOR

See Also:

Constant Field Values

ESCAPED_CARRIAGE_RETURN

public static final java.lang.String ESCAPED_CARRIAGE_RETURN

See Also:

Constant Field Values

ESCAPED_AMPERSAND

public static final java.lang.String ESCAPED_AMPERSAND

See Also:

Constant Field Values

ESCAPED_QUOTE

public static final java.lang.String ESCAPED_QUOTE

See Also:

Constant Field Values

ESCAPED_EQUAL

public static final java.lang.String ESCAPED_EQUAL

See Also:

Constant Field Values

Constructor Detail

Event

public Event(int priority)

Event

public Event(int priority,
             java.lang.String message)

Event

public Event(int priority,
             java.lang.String message,
             java.lang.String filename)

Method Detail

getPriorityByName

public static int getPriorityByName(java.lang.String name)

returns priority in number or -1 on a bad priority name

getPID

public static int getPID()

getHostID

public static int getHostID()

getIPAddress

public static java.lang.String getIPAddress()

getHostName

public static java.lang.String getHostName()

getProgramName

public static java.lang.String getProgramName()

getTimestamp

public long getTimestamp()

Description copied from interface: Event

returns the timestamp of the event

Specified by:

getTimestamp in interface Event

setTimestamp

public void setTimestamp(long ts)

Description copied from interface: Event

sets the timestamp of the event

Specified by:

setTimestamp in interface Event

getExpiration

public long getExpiration()

Description copied from interface: Event

returns the expiration of the event

Specified by:

getExpiration in interface Event

setExpiration

public void setExpiration(long ts)

Description copied from interface: Event

sets the expiration of the event

Specified by:

setExpiration in interface Event

getPriority

public int getPriority()

Description copied from interface: Event

returns the priority of the event

Specified by:

getPriority in interface Event

setPriority

public void setPriority(int p)

Description copied from interface: Event

sets the priority of the event

Specified by:

setPriority in interface Event

getGroupID

public int getGroupID()

setGroupID

public void setGroupID(int gid)

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Description copied from interface: Event

returns the attribute on the key

Specified by:

getAttribute in interface Event

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)

It sets an attribute of the Event

Specified by:

setAttribute in interface Event

Parameters:

name - the name of the attribute

value - the value of the attribute

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Description copied from interface: Event

returns the iterator for all the keys of attributes

Specified by:

getAttributeNames in interface Event

clearAttributes

public void clearAttributes()

Description copied from interface: Event

clears all attributes of the event

Specified by:

clearAttributes in interface Event

setBody

public void setBody(java.lang.Object obj)

It sets the body of the Event with an Object which may not be transportable.

getBody

public java.lang.Object getBody()

removeAttribute

public java.lang.String removeAttribute(java.lang.String name)

Description copied from interface: Event

removes the attribute on the key

Specified by:

removeAttribute in interface Event

attributeExists

public boolean attributeExists(java.lang.String name)

Description copied from interface: Event

tests if the attribute exists on the key

Specified by:

attributeExists in interface Event

setLogDir

public static void setLogDir(java.lang.String dir)

It sets the log dir and initializes the logger without date pattern.

setLogDir

public static void setLogDir(java.lang.String dir,
                             java.lang.String datePattern)

It sets the log dir for the events and initializes the logger with the given date pattern.

setLogDir

public static void setLogDir(java.lang.String dir,
                             java.lang.String maxSize,
                             int maxBackups)

It sets the log dir for the events and initializes the logger with the given size limit and number of backups

setDefaultName

public static void setDefaultName(java.lang.String name)

getDefaultName

protected static java.lang.String getDefaultName()

setDefaultSite

public static void setDefaultSite(java.lang.String site)

setDefaultCategory

public static void setDefaultCategory(java.lang.String category)

setDefaultType

public static void setDefaultType(java.lang.String type)

print

public void print(java.io.PrintStream stream)

send

public void send()

flush

public static void flush(java.lang.Throwable e)

It prints out error msg and rethrows it if it is an Error

traceStack

public static java.lang.String traceStack(java.lang.Throwable e)

dateFormat

public static java.lang.String dateFormat(java.util.Date date)

parseDate

public static java.util.Date parseDate(java.lang.String date)

log

public void log()

logs to the file according to programName

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object