com.etherios.connector.core.events

Class Event

java.lang.Object

com.etherios.connector.core.events.Event

Direct Known Subclasses:

ConnectionEvent, DataPointEvent, DataPushEvent, DeviceRequestEvent, FileSystemEvent, FirmwareEvent, RCIEvent

public abstract class Event
extends java.lang.Object

This class represents a Cloud Connector Event. Different event types may extend from this class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEVERITY_DEBUG Event severity is of type 'debug'.
static int	SEVERITY_ERROR Event severity is of type 'error'.
static int	SEVERITY_INFO Event severity is of type 'information'.
static java.lang.String	TAG_DEBUG Log tag for 'debug' severity events.
static java.lang.String	TAG_ERROR Log tag for 'error' severity events.
static java.lang.String	TAG_INFO Log tag for 'information' severity events.
static int	TYPE_CONNECTION Event is of type 'connection'.
static int	TYPE_DATA_POINT Event is of type 'data point'.
static int	TYPE_DATA_PUSH Event is of type 'data push'.
static int	TYPE_DEVICE_REQUEST Event is of type 'device request'.
static int	TYPE_FILE_SYSTEM Event is of type 'file system'.
static int	TYPE_FIRMWARE Event is of type 'firmware update'.
static int	TYPE_RCI Event is of type 'RCI'.

Constructor Summary

Constructors

Constructor and Description
Event(int type) Class constructor.
Event(int type, int severity) Class constructor.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getEventLogString() Retrieves the event string to be logged.
int	getEventSeverity() Retrieves the event severity.
int	getEventType() Retrieves the event type.
abstract java.lang.String	getEventTypeTag() Retrieves the event type tag to be logged.
void	setSeverity(int severity) Sets the event severity.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SEVERITY_DEBUG

public static final int SEVERITY_DEBUG

Event severity is of type 'debug'.

See Also:

Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR

Event severity is of type 'error'.

See Also:

Constant Field Values

SEVERITY_INFO

public static final int SEVERITY_INFO

Event severity is of type 'information'.

See Also:

Constant Field Values

TAG_DEBUG

public static final java.lang.String TAG_DEBUG

Log tag for 'debug' severity events.

See Also:

Constant Field Values

TAG_ERROR

public static final java.lang.String TAG_ERROR

Log tag for 'error' severity events.

See Also:

Constant Field Values

TAG_INFO

public static final java.lang.String TAG_INFO

Log tag for 'information' severity events.

See Also:

Constant Field Values

TYPE_CONNECTION

public static final int TYPE_CONNECTION

Event is of type 'connection'.

See Also:

Constant Field Values

TYPE_DATA_POINT

public static final int TYPE_DATA_POINT

Event is of type 'data point'.

See Also:

Constant Field Values

TYPE_DATA_PUSH

public static final int TYPE_DATA_PUSH

Event is of type 'data push'.

See Also:

Constant Field Values

TYPE_DEVICE_REQUEST

public static final int TYPE_DEVICE_REQUEST

Event is of type 'device request'.

See Also:

Constant Field Values

TYPE_FILE_SYSTEM

public static final int TYPE_FILE_SYSTEM

Event is of type 'file system'.

See Also:

Constant Field Values

TYPE_FIRMWARE

public static final int TYPE_FIRMWARE

Event is of type 'firmware update'.

See Also:

Constant Field Values

TYPE_RCI

public static final int TYPE_RCI

Event is of type 'RCI'.

See Also:

Constant Field Values

Constructor Detail

Event

public Event(int type)

Class constructor. Instances a new object of type Event with the given parameters.

Parameters:

type - Event type.

Event

public Event(int type,
             int severity)

Class constructor. Instances a new object of type Event with the given parameters.

Parameters:

type - Event type.

severity - Event severity.

Method Detail

getEventLogString

public abstract java.lang.String getEventLogString()

Retrieves the event string to be logged.

Returns:

The event string to be logged.

getEventSeverity

public int getEventSeverity()

Retrieves the event severity.

Returns:

Event severity.

See Also:

SEVERITY_INFO, SEVERITY_ERROR, SEVERITY_DEBUG

getEventType

public int getEventType()

Retrieves the event type.

Returns:

The event type.

See Also:

TYPE_CONNECTION, TYPE_DATA_POINT, TYPE_DATA_PUSH, TYPE_FILE_SYSTEM, TYPE_FIRMWARE, TYPE_RCI

getEventTypeTag

public abstract java.lang.String getEventTypeTag()

Retrieves the event type tag to be logged.

Returns:

The event type tag to be logged.

setSeverity

public void setSeverity(int severity)

Sets the event severity.

Parameters:

severity - Event severity.

See Also:

SEVERITY_INFO, SEVERITY_ERROR, SEVERITY_DEBUG

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object