com.etherios.connector.core.events

Class FileSystemEvent

java.lang.Object

com.etherios.connector.core.events.Event

com.etherios.connector.core.events.FileSystemEvent

Direct Known Subclasses:

FileSystemEvent.FileDownloadEvent, FileSystemEvent.FileListEvent, FileSystemEvent.FileRemoveEvent, FileSystemEvent.FileSystemErrorEvent, FileSystemEvent.FileUploadEvent

public abstract class FileSystemEvent
extends Event

Basic File System Event class containing common information and functionality for the different file system event types.

See Also:

EventsListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemEvent.FileDownloadEvent Specific implementation of the File system event indicating a file download request.
static class	FileSystemEvent.FileListEvent Specific implementation of the File system event indicating a file list request.
static class	FileSystemEvent.FileRemoveEvent Specific implementation of the File system event indicating a file remove request.
static class	FileSystemEvent.FileSystemErrorEvent Specific implementation of the File system event indicating a file remove request.
static class	FileSystemEvent.FileUploadEvent Specific implementation of the File system event indicating a file upload request.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_FATAL Fatal error while performing a file system operation.
static int	ERROR_INSUFFICENT_STORAGE Insufficient storage to perform the file system operation.
static int	ERROR_INVALID_PARAMETER Invalid parameter in the file system request.
static int	ERROR_OUT_OF_MEMORY Out of memory error while performing the file system operation.
static int	ERROR_PATH_NOT_FOUND Path not found for the file system operation.
static int	ERROR_PERMISSION_DENIED Permission denied while performing the file system operation.
static int	ERROR_REQUEST_FORMAT_ERROR File system request error.
static int	FILE_DOWNLOAD File download event.
static int	FILE_ERROR File system operation error event.
static int	FILE_LIST File list event.
static int	FILE_REMOVE File remove event.
static int	FILE_UPLOAD File upload event.

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	getFileSystemEventType() Retrieves the file system event action.
java.lang.String	getPath() Retrieves the file system event path.
static FileSystemEvent	newFileDownloadEvent(java.lang.String path) Creates a new file download file system event for the given path.
static FileSystemEvent	newFileListEvent(java.lang.String path) Creates a new file list file system event for the given path.
static FileSystemEvent	newFileSystemErrorEvent(int errorType) Creates a new file system error event with the given parameters.
static FileSystemEvent	newFileSystemErrorEvent(int action, java.lang.String path, int errorType) Creates a new file system error event with the given parameters.
static FileSystemEvent	newFileSystemErrorEvent(int action, java.lang.String path, int errorType, java.lang.String hint) Creates a new file system error event with the given parameters.
static FileSystemEvent	newFileUploadEvent(java.lang.String path) Creates a new file upload file system event for the given path.
static FileSystemEvent	newRemoveFileEvent(java.lang.String path) Creates a new file remove file system event for the given path.
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

ERROR_FATAL

public static final int ERROR_FATAL

Fatal error while performing a file system operation.

See Also:

Constant Field Values

ERROR_INSUFFICENT_STORAGE

public static final int ERROR_INSUFFICENT_STORAGE

Insufficient storage to perform the file system operation.

See Also:

Constant Field Values

ERROR_INVALID_PARAMETER

public static final int ERROR_INVALID_PARAMETER

Invalid parameter in the file system request.

See Also:

Constant Field Values

ERROR_OUT_OF_MEMORY

public static final int ERROR_OUT_OF_MEMORY

Out of memory error while performing the file system operation.

See Also:

Constant Field Values

ERROR_PATH_NOT_FOUND

public static final int ERROR_PATH_NOT_FOUND

Path not found for the file system operation.

See Also:

Constant Field Values

ERROR_PERMISSION_DENIED

public static final int ERROR_PERMISSION_DENIED

Permission denied while performing the file system operation.

See Also:

Constant Field Values

ERROR_REQUEST_FORMAT_ERROR

public static final int ERROR_REQUEST_FORMAT_ERROR

File system request error.

See Also:

Constant Field Values

FILE_DOWNLOAD

public static final int FILE_DOWNLOAD

File download event.

See Also:

Constant Field Values

FILE_ERROR

public static final int FILE_ERROR

File system operation error event.

See Also:

Constant Field Values

FILE_LIST

public static final int FILE_LIST

File list event.

See Also:

Constant Field Values

FILE_REMOVE

public static final int FILE_REMOVE

File remove event.

See Also:

Constant Field Values

FILE_UPLOAD

public static final int FILE_UPLOAD

File upload event.

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.

getFileSystemEventType

public int getFileSystemEventType()

Retrieves the file system event action.

Returns:

File system event action.

See Also:

FILE_DOWNLOAD, FILE_ERROR, FILE_LIST, FILE_REMOVE, FILE_UPLOAD

getPath

public java.lang.String getPath()

Retrieves the file system event path.

Returns:

File system event path.

newFileDownloadEvent

public static FileSystemEvent newFileDownloadEvent(java.lang.String path)

Creates a new file download file system event for the given path.

Parameters:

path - Path for which the file download event is fired.

Returns:

The file system event.

newFileListEvent

public static FileSystemEvent newFileListEvent(java.lang.String path)

Creates a new file list file system event for the given path.

Parameters:

path - Path for which the file list event is fired.

Returns:

The file system event.

newFileSystemErrorEvent

public static FileSystemEvent newFileSystemErrorEvent(int errorType)

Creates a new file system error event with the given parameters.

Parameters:

errorType - Type of error.

Returns:

The file system event.

newFileSystemErrorEvent

public static FileSystemEvent newFileSystemErrorEvent(int action,
                                                      java.lang.String path,
                                                      int errorType)

Creates a new file system error event with the given parameters.

Parameters:

action - Action that was being performed when error occurred.

path - Path of the file for which action was being performed.

errorType - Type of error.

Returns:

The file system event.

newFileSystemErrorEvent

public static FileSystemEvent newFileSystemErrorEvent(int action,
                                                      java.lang.String path,
                                                      int errorType,
                                                      java.lang.String hint)

Creates a new file system error event with the given parameters.

Parameters:

action - Action that was being performed when error occurred.

path - Path of the file for which action was being performed.

errorType - Type of error.

hint - The error hint.

Returns:

The file system event.

newFileUploadEvent

public static FileSystemEvent newFileUploadEvent(java.lang.String path)

Creates a new file upload file system event for the given path.

Parameters:

path - Path for which the file upload event is fired.

Returns:

The file system event.

newRemoveFileEvent

public static FileSystemEvent newRemoveFileEvent(java.lang.String path)

Creates a new file remove file system event for the given path.

Parameters:

path - Path for which the file remove event is fired.

Returns:

The file system event.

toString

public java.lang.String toString()

Overrides:

toString in class Event