com.etherios.connector.core.events

Class FirmwareEvent

java.lang.Object

com.etherios.connector.core.events.Event

com.etherios.connector.core.events.FirmwareEvent

Direct Known Subclasses:

FirmwareEvent.FirmwareBinaryBlockACKEvent, FirmwareEvent.FirmwareBinaryBlockEvent, FirmwareEvent.FirmwareCompleteAnswerEvent, FirmwareEvent.FirmwareCompleteEvent, FirmwareEvent.FirmwareErrorEvent, FirmwareEvent.FirmwareTargetInfoEvent, FirmwareEvent.FirmwareTargetResetEvent, FirmwareEvent.FirmwareUpdateAbortEvent, FirmwareEvent.FirmwareUpdateRequestAnswerEvent, FirmwareEvent.FirmwareUpdateRequestEvent

public abstract class FirmwareEvent
extends Event

Basic Firmware Event class containing common information and functionality for the different firmware event types.

See Also:

EventsListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirmwareEvent.FirmwareBinaryBlockACKEvent Specific implementation of the firmware event indicating a firmware binary block ACK.
static class	FirmwareEvent.FirmwareBinaryBlockEvent Specific implementation of the firmware event indicating a firmware binary block received.
static class	FirmwareEvent.FirmwareCompleteAnswerEvent Specific implementation of the firmware event indicating a firmware update completed answer event.
static class	FirmwareEvent.FirmwareCompleteEvent Specific implementation of the firmware event indicating a firmware update completed event.
static class	FirmwareEvent.FirmwareErrorEvent Specific implementation of the firmware event indicating a firmware error.
static class	FirmwareEvent.FirmwareTargetInfoEvent Specific implementation of the firmware event indicating a target information event.
static class	FirmwareEvent.FirmwareTargetResetEvent Specific implementation of the firmware event indicating a target reset event.
static class	FirmwareEvent.FirmwareUpdateAbortEvent Specific implementation of the firmware event indicating a firmware update abort.
static class	FirmwareEvent.FirmwareUpdateRequestAnswerEvent Specific implementation of the firmware event indicating a firmware update request answer.
static class	FirmwareEvent.FirmwareUpdateRequestEvent Specific implementation of the firmware event indicating a firmware update request.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORT_REASON_DOWNLOAD_ERROR Firmware update operation aborted because of download error.
static int	ABORT_REASON_HARDWARE_ERROR Firmware update operation aborted because of hardware error.
static int	ABORT_REASON_INVALID_OFFSET Firmware update operation aborted because of invalid offset.
static int	ABORT_REASON_SERVER_CLIENT Firmware update operation aborted by server or client.
static int	ABORT_REASON_UNEXPECTED_BINARY_BLOCK Firmware update operation aborted because of unexpected binary block.
static int	ERROR_INVALID_OPCODE Invalid firmware operation opcode.
static int	ERROR_INVALID_TARGET Invalid firmware target error.
static int	ERROR_MALFORMED_MESSAGE Firmware update message malformed.
static int	FIRMWARE_UPDATE_ABORT Firmware update abort event.
static int	FIRMWARE_UPDATE_BINARY_BLOCK Firmware update binary block event.
static int	FIRMWARE_UPDATE_BINARY_BLOCK_ANSWER Firmware update binary block answer event.
static int	FIRMWARE_UPDATE_COMPLETE Firmware update complete event.
static int	FIRMWARE_UPDATE_COMPLETE_ANSWER Firmware update complete answer event.
static int	FIRMWARE_UPDATE_ERROR Firmware update error event.
static int	FIRMWARE_UPDATE_REQUEST Firmware update request event.
static int	FIRMWARE_UPDATE_REQUEST_ANSWER Firmware update request answer event.
static int	FIRMWARE_UPDATE_TARGET_INFO Firmware update target information event.
static int	FIRMWARE_UPDATE_TARGET_RESET Firmware update target reset event.
static int	REQUEST_ANSWER_DENIED Firmware update operation denied.
static int	REQUEST_ANSWER_ERROR Firmware update operation error.
static int	REQUEST_ANSWER_FILE_TOO_LARGE Firmware update file too large.
static int	REQUEST_ANSWER_INVALID_VERSION Firmware update version invalid.
static int	REQUEST_ANSWER_NOT_ALLOWED Firmware update operation not allowed.
static int	REQUEST_ANSWER_NOT_AUTHENTICATED Firmware update error: not authenticated.
static int	REQUEST_ANSWER_OK Firmware update operation accepted.
static int	REQUEST_ANSWER_REJECT Firmware update operation rejected.
static int	UPDATE_COMPLETE_STATUS_CHECKSUM_ERROR Firmware update operation failed due to checksum error.
static int	UPDATE_COMPLETE_STATUS_ERROR Firmware update operation failed due to unknown error.
static int	UPDATE_COMPLETE_STATUS_OK Firmware update operation completed successfully.

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	getEventTypeTag() Retrieves the event type tag to be logged.
int	getFirmwareEventType() Retrieves the firmware event type.
static FirmwareEvent	newFirmwareAbortEvent(int target, int reason) Creates a new firmware abort event with the given reason for the given target.
static FirmwareEvent	newFirmwareBinaryBlockACKEvent(int target, int offset, int status) Creates a new firmware binary block ACK event with the given parameters.
static FirmwareEvent	newFirmwareBinaryBlockEvent(int target, int offset) Creates a new firmware binary block received event with the given parameters.
static FirmwareEvent	newFirmwareCompleteAnswerEvent(int target, java.lang.String version, byte[] checksum, int status) Creates a new firmware update completed answer event with the given parameters.
static FirmwareEvent	newFirmwareCompleteEvent(int target, int size, byte[] checksum) Creates a new firmware update completed event with the given parameters.
static FirmwareEvent	newFirmwareErrorEvent(int errorType) Creates a new firmware error event of the given type.
static FirmwareEvent	newFirmwareErrorEvent(int errorType, int target) Creates a new firmware error event of the given type for the given target.
static FirmwareEvent	newFirmwareTargetInfoEvent(int target) Creates a new firmware target information event for the given target.
static FirmwareEvent	newFirmwareTargetResetEvent(int target) Creates a new firmware target reset event for the given target.
static FirmwareEvent	newFirmwareUpdateRequestAnswerEvent(int target, int answer) Creates a new firmware update request answer event with the given parameters.
static FirmwareEvent	newFirmwareUpdateRequestEvent(int target, int size, java.lang.String fileName) Creates a new firmware update request event with the given parameters.
java.lang.String	toString()

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

getEventLogString, getEventSeverity, getEventType, setSeverity

Methods inherited from class java.lang.Object

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

Field Detail

ABORT_REASON_DOWNLOAD_ERROR

public static final int ABORT_REASON_DOWNLOAD_ERROR

Firmware update operation aborted because of download error.

See Also:

Constant Field Values

ABORT_REASON_HARDWARE_ERROR

public static final int ABORT_REASON_HARDWARE_ERROR

Firmware update operation aborted because of hardware error.

See Also:

Constant Field Values

ABORT_REASON_INVALID_OFFSET

public static final int ABORT_REASON_INVALID_OFFSET

Firmware update operation aborted because of invalid offset.

See Also:

Constant Field Values

ABORT_REASON_SERVER_CLIENT

public static final int ABORT_REASON_SERVER_CLIENT

Firmware update operation aborted by server or client.

See Also:

Constant Field Values

ABORT_REASON_UNEXPECTED_BINARY_BLOCK

public static final int ABORT_REASON_UNEXPECTED_BINARY_BLOCK

Firmware update operation aborted because of unexpected binary block.

See Also:

Constant Field Values

ERROR_INVALID_OPCODE

public static final int ERROR_INVALID_OPCODE

Invalid firmware operation opcode.

See Also:

Constant Field Values

ERROR_INVALID_TARGET

public static final int ERROR_INVALID_TARGET

Invalid firmware target error.

See Also:

Constant Field Values

ERROR_MALFORMED_MESSAGE

public static final int ERROR_MALFORMED_MESSAGE

Firmware update message malformed.

See Also:

Constant Field Values

FIRMWARE_UPDATE_ABORT

public static final int FIRMWARE_UPDATE_ABORT

Firmware update abort event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_BINARY_BLOCK

public static final int FIRMWARE_UPDATE_BINARY_BLOCK

Firmware update binary block event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_BINARY_BLOCK_ANSWER

public static final int FIRMWARE_UPDATE_BINARY_BLOCK_ANSWER

Firmware update binary block answer event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_COMPLETE

public static final int FIRMWARE_UPDATE_COMPLETE

Firmware update complete event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_COMPLETE_ANSWER

public static final int FIRMWARE_UPDATE_COMPLETE_ANSWER

Firmware update complete answer event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_ERROR

public static final int FIRMWARE_UPDATE_ERROR

Firmware update error event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_REQUEST

public static final int FIRMWARE_UPDATE_REQUEST

Firmware update request event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_REQUEST_ANSWER

public static final int FIRMWARE_UPDATE_REQUEST_ANSWER

Firmware update request answer event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_TARGET_INFO

public static final int FIRMWARE_UPDATE_TARGET_INFO

Firmware update target information event.

See Also:

Constant Field Values

FIRMWARE_UPDATE_TARGET_RESET

public static final int FIRMWARE_UPDATE_TARGET_RESET

Firmware update target reset event.

See Also:

Constant Field Values

REQUEST_ANSWER_DENIED

public static final int REQUEST_ANSWER_DENIED

Firmware update operation denied.

See Also:

Constant Field Values

REQUEST_ANSWER_ERROR

public static final int REQUEST_ANSWER_ERROR

Firmware update operation error.

See Also:

Constant Field Values

REQUEST_ANSWER_FILE_TOO_LARGE

public static final int REQUEST_ANSWER_FILE_TOO_LARGE

Firmware update file too large.

See Also:

Constant Field Values

REQUEST_ANSWER_INVALID_VERSION

public static final int REQUEST_ANSWER_INVALID_VERSION

Firmware update version invalid.

See Also:

Constant Field Values

REQUEST_ANSWER_NOT_ALLOWED

public static final int REQUEST_ANSWER_NOT_ALLOWED

Firmware update operation not allowed.

See Also:

Constant Field Values

REQUEST_ANSWER_NOT_AUTHENTICATED

public static final int REQUEST_ANSWER_NOT_AUTHENTICATED

Firmware update error: not authenticated.

See Also:

Constant Field Values

REQUEST_ANSWER_OK

public static final int REQUEST_ANSWER_OK

Firmware update operation accepted.

See Also:

Constant Field Values

REQUEST_ANSWER_REJECT

public static final int REQUEST_ANSWER_REJECT

Firmware update operation rejected.

See Also:

Constant Field Values

UPDATE_COMPLETE_STATUS_CHECKSUM_ERROR

public static final int UPDATE_COMPLETE_STATUS_CHECKSUM_ERROR

Firmware update operation failed due to checksum error.

See Also:

Constant Field Values

UPDATE_COMPLETE_STATUS_ERROR

public static final int UPDATE_COMPLETE_STATUS_ERROR

Firmware update operation failed due to unknown error.

See Also:

Constant Field Values

UPDATE_COMPLETE_STATUS_OK

public static final int UPDATE_COMPLETE_STATUS_OK

Firmware update operation completed successfully.

See Also:

Constant Field Values

Method Detail

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.

getFirmwareEventType

public int getFirmwareEventType()

Retrieves the firmware event type.

Returns:

Firmware event type.

See Also:

FIRMWARE_UPDATE_ABORT, FIRMWARE_UPDATE_BINARY_BLOCK, FIRMWARE_UPDATE_BINARY_BLOCK_ANSWER, FIRMWARE_UPDATE_COMPLETE, FIRMWARE_UPDATE_COMPLETE_ANSWER, FIRMWARE_UPDATE_ERROR, FIRMWARE_UPDATE_REQUEST, FIRMWARE_UPDATE_REQUEST_ANSWER, FIRMWARE_UPDATE_TARGET_INFO, FIRMWARE_UPDATE_TARGET_RESET

newFirmwareAbortEvent

public static FirmwareEvent newFirmwareAbortEvent(int target,
                                                  int reason)

Creates a new firmware abort event with the given reason for the given target.

Parameters:

target - Target for which the firmware event is generated.

reason - Reason to abort the firmware update.

Returns:

The update firmware abort event.

See Also:

ABORT_REASON_SERVER_CLIENT, ABORT_REASON_DOWNLOAD_ERROR, ABORT_REASON_INVALID_OFFSET, ABORT_REASON_UNEXPECTED_BINARY_BLOCK, ABORT_REASON_HARDWARE_ERROR

newFirmwareBinaryBlockACKEvent

public static FirmwareEvent newFirmwareBinaryBlockACKEvent(int target,
                                                           int offset,
                                                           int status)

Creates a new firmware binary block ACK event with the given parameters.

Parameters:

target - Target for which the binary block ACK event is sent.

offset - Offset of the binary block.

status - Status of handling the binary block.

Returns:

The binary block ACK event.

newFirmwareBinaryBlockEvent

public static FirmwareEvent newFirmwareBinaryBlockEvent(int target,
                                                        int offset)

Creates a new firmware binary block received event with the given parameters.

Parameters:

target - Target for which the binary block event is received.

offset - Offset of the received binary block.

Returns:

The binary block event.

newFirmwareCompleteAnswerEvent

public static FirmwareEvent newFirmwareCompleteAnswerEvent(int target,
                                                           java.lang.String version,
                                                           byte[] checksum,
                                                           int status)

Creates a new firmware update completed answer event with the given parameters.

Parameters:

target - Target for which firmware update complete answer event is sent.

version - New firmware version number.

checksum - Device calculated checksum of the firmware image.

status - Firmware update complete status.

Returns:

The firmware update complete answer event.

newFirmwareCompleteEvent

public static FirmwareEvent newFirmwareCompleteEvent(int target,
                                                     int size,
                                                     byte[] checksum)

Creates a new firmware update completed event with the given parameters.

Parameters:

target - Target for which firmware update complete event is sent.

size - Firmware image size.

checksum - Server calculated checksum of the firmware image.

Returns:

The firmware update complete event.

newFirmwareErrorEvent

public static FirmwareEvent newFirmwareErrorEvent(int errorType)

Creates a new firmware error event of the given type.

Parameters:

errorType - Firmware event error type.

Returns:

The firmware error event.

newFirmwareErrorEvent

public static FirmwareEvent newFirmwareErrorEvent(int errorType,
                                                  int target)

Creates a new firmware error event of the given type for the given target.

Parameters:

errorType - Firmware event error type.

target - Target for which the firmware event is generated.

Returns:

The firmware error event.

newFirmwareTargetInfoEvent

public static FirmwareEvent newFirmwareTargetInfoEvent(int target)

Creates a new firmware target information event for the given target.

Parameters:

target - Target for which target information event is sent.

Returns:

The firmware target information event.

newFirmwareTargetResetEvent

public static FirmwareEvent newFirmwareTargetResetEvent(int target)

Creates a new firmware target reset event for the given target.

Parameters:

target - Target for which target reset event is sent.

Returns:

The firmware target reset event.

newFirmwareUpdateRequestAnswerEvent

public static FirmwareEvent newFirmwareUpdateRequestAnswerEvent(int target,
                                                                int answer)

Creates a new firmware update request answer event with the given parameters.

Parameters:

target - Target for which the update firmware request answer is sent.

answer - Firmware update request answer code.

Returns:

The update firmware request answer event.

newFirmwareUpdateRequestEvent

public static FirmwareEvent newFirmwareUpdateRequestEvent(int target,
                                                          int size,
                                                          java.lang.String fileName)

Creates a new firmware update request event with the given parameters.

Parameters:

target - Target for which the update firmware request is sent.

size - Size of the new firmware image.

fileName - The update firmware file name.

Returns:

The update firmware request event.

toString

public java.lang.String toString()

Overrides:

toString in class Event