com.etherios.connector.core.events

Class DataPushEvent

java.lang.Object

com.etherios.connector.core.events.Event

com.etherios.connector.core.events.DataPushEvent

public class DataPushEvent
extends Event

Basic Data Push Event class containing common information and functionality for the data push events.

See Also:

EventsListener

Field Summary

Fields

Modifier and Type	Field and Description
static byte	STATUS_BAD_REQUEST Data push request is invalid.
static byte	STATUS_SERVER_ERROR Server error while processing data push request.
static byte	STATUS_SUCCESS Data push status success.
static byte	STATUS_UNAVAILABLE Server unavailable while sending data push request.

Fields inherited from class com.etherios.connector.core.events.Event

SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, TAG_DEBUG, TAG_ERROR, TAG_INFO, TYPE_CONNECTION, TYPE_DATA_POINT, TYPE_DATA_PUSH, TYPE_DEVICE_REQUEST, TYPE_FILE_SYSTEM, TYPE_FIRMWARE, TYPE_RCI

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventLogString() Retrieves the event string to be logged.
java.lang.String	getEventTypeTag() Retrieves the event type tag to be logged.
java.lang.String	getMessage() Retrieves the event additional message in case it exists.
java.lang.String	getPath() Retrieves the path of the file for which this event has been fired.
int	getStatus() Retrieves the data upload status from the event.
java.lang.String	getStatusMessage() Retrieves the status message of the data push event.
static DataPushEvent	newDataPushEvent(java.lang.String path, int status, java.lang.String message) Creates a new data push event for the given file path.
java.lang.String	toString()

Methods inherited from class com.etherios.connector.core.events.Event

getEventSeverity, getEventType, setSeverity

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_BAD_REQUEST

public static final byte STATUS_BAD_REQUEST

Data push request is invalid.

See Also:

Constant Field Values

STATUS_SERVER_ERROR

public static final byte STATUS_SERVER_ERROR

Server error while processing data push request.

See Also:

Constant Field Values

STATUS_SUCCESS

public static final byte STATUS_SUCCESS

Data push status success.

See Also:

Constant Field Values

STATUS_UNAVAILABLE

public static final byte STATUS_UNAVAILABLE

Server unavailable while sending data push request.

See Also:

Constant Field Values

Method Detail

getEventLogString

public java.lang.String getEventLogString()

Description copied from class: Event

Retrieves the event string to be logged.

Specified by:

getEventLogString in class Event

Returns:

The event string to be logged.

getEventTypeTag

public java.lang.String getEventTypeTag()

Description copied from class: Event

Retrieves the event type tag to be logged.

Specified by:

getEventTypeTag in class Event

Returns:

The event type tag to be logged.

getMessage

public java.lang.String getMessage()

Retrieves the event additional message in case it exists.

Returns:

The event additional message, null if none.

getPath

public java.lang.String getPath()

Retrieves the path of the file for which this event has been fired.

Returns:

Path of the uploaded file.

getStatus

public int getStatus()

Retrieves the data upload status from the event.

Returns:

Data upload status form the event.

See Also:

STATUS_BAD_REQUEST, STATUS_SERVER_ERROR, STATUS_SUCCESS, STATUS_UNAVAILABLE

getStatusMessage

public java.lang.String getStatusMessage()

Retrieves the status message of the data push event.

Returns:

The status message of the data push event.

newDataPushEvent

public static DataPushEvent newDataPushEvent(java.lang.String path,
                                             int status,
                                             java.lang.String message)

Creates a new data push event for the given file path.

Parameters:

path - Path of the file that will be pushed.

status - Push status.

message - Additional event message.

Returns:

The data push event.

toString

public java.lang.String toString()

Overrides:

toString in class Event