de.aristaflow.adept2.core.eventmanager.fileevents

Class LockFileEventImpl

java.lang.Object

de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

de.aristaflow.adept2.core.eventmanager.fileevents.FileEventImpl

de.aristaflow.adept2.core.eventmanager.fileevents.LockFileEventImpl

All Implemented Interfaces:

Event, FileEvent, LockFileEvent

public class LockFileEventImpl
extends FileEventImpl
implements LockFileEvent

An event for files and their lock files, that is, an event is produced and sent as soon as a file (or a directory) is created or stored in a specific folder.
This event source terminates as soon as an event has been handled. However, since it polls, one has to ensure that a handled file is deleted or moved to another folder. Otherwise the source will create another event for the file.

Author:

Ulrich Kreher, Marco Waimer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.attribute.BasicFileAttributes	lockAttributes The file attributes of the path of the lock file.
protected java.io.File	lockFile Deprecated.
protected java.net.URL	lockFileURL Deprecated.
protected java.nio.file.Path	lockPath The path of the lock file for which the event has been created.

Fields inherited from class de.aristaflow.adept2.core.eventmanager.fileevents.FileEventImpl

attributes, file, path, url

Fields inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

creationTime, eventType, id, ID_COUNT, managerURI, sourceID, sourceType

Constructor Summary

Constructors

Constructor and Description
LockFileEventImpl(java.net.URI[] managerURI, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID, java.io.File file, java.io.File lockFile) Deprecated. Use LockFileEventImpl(URI[], String, String, String, Path, Path) instead.
LockFileEventImpl(java.net.URI[] managerURI, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID, java.nio.file.Path path, java.nio.file.Path lockPath) Creates a new event for the designated file.

Method Summary

Modifier and Type	Method and Description
java.io.File	getLockFile() Gets the file that caused this event.
java.net.URL	getLockFileAsURL() Gets the URL of the file that caused this event.
java.nio.file.attribute.BasicFileAttributes	getLockFileAttributes() Gets the basic file attributes of the lock file of this event.
java.nio.file.Path	getLockPath() Gets the path of the lock file of this event.

Methods inherited from class de.aristaflow.adept2.core.eventmanager.fileevents.FileEventImpl

getAsURI, getAsURL, getFile, getFileAttributes, getLastModified, getName, getPath

Methods inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

getCreationTime, getEventManager, getEventType, getID, getSourceID, getSourceType

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.model.events.FileEvent

getAsURI, getAsURL, getFile, getFileAttributes, getLastModified, getName, getPath

Methods inherited from interface de.aristaflow.adept2.model.events.Event

getCreationTime, getEventManager, getEventType, getID, getSourceID, getSourceType

Field Detail

lockPath

protected final java.nio.file.Path lockPath

The path of the lock file for which the event has been created.

lockAttributes

protected final java.nio.file.attribute.BasicFileAttributes lockAttributes

The file attributes of the path of the lock file.

lockFile

@Deprecated
protected final java.io.File lockFile

Deprecated.

The file for which the event has been created.

lockFileURL

@Deprecated
protected final java.net.URL lockFileURL

Deprecated.

The URL of the file for which the event has been created.

Constructor Detail

LockFileEventImpl

@Deprecated
public LockFileEventImpl(java.net.URI[] managerURI,
                                     java.lang.String eventType,
                                     java.lang.String sourceType,
                                     java.lang.String sourceID,
                                     java.io.File file,
                                     java.io.File lockFile)
                              throws java.io.IOException

Deprecated. Use LockFileEventImpl(URI[], String, String, String, Path, Path) instead.

Creates a new event for the designated file.

Parameters:

managerURI - The URIs of the service (event manager) creating the event.

eventType - The type of the event.

sourceType - The type of the source of this event.

sourceID - The ID of the source of this event.

file - The file of the event.

lockFile - The lock file of the event.

Throws:

java.io.IOException - Retrieving the URL of the file may throw an IOException.

LockFileEventImpl

public LockFileEventImpl(java.net.URI[] managerURI,
                         java.lang.String eventType,
                         java.lang.String sourceType,
                         java.lang.String sourceID,
                         java.nio.file.Path path,
                         java.nio.file.Path lockPath)
                  throws java.io.IOException

Creates a new event for the designated file.

Parameters:

managerURI - The URIs of the service (event manager) creating the event.

eventType - The type of the event.

sourceType - The type of the source of this event.

sourceID - The ID of the source of this event.

path - The path for which the event has been created.

lockPath - The path of the lock file for which the event has been created.

Throws:

java.io.IOException - If retrieving the basic file attributes of the designated path fails, an IOException will be thrown.

Method Detail

getLockPath

public java.nio.file.Path getLockPath()

Description copied from interface: LockFileEvent

Gets the path of the lock file of this event.

Specified by:

getLockPath in interface LockFileEvent

Returns:

The path of the lock file of this event.

getLockFileAttributes

public java.nio.file.attribute.BasicFileAttributes getLockFileAttributes()

Description copied from interface: LockFileEvent

Gets the basic file attributes of the lock file of this event.

Specified by:

getLockFileAttributes in interface LockFileEvent

Returns:

The basic file attributes of the path of the lock file of this event.

getLockFileAsURL

public java.net.URL getLockFileAsURL()

Description copied from interface: LockFileEvent

Gets the URL of the file that caused this event.

Specified by:

getLockFileAsURL in interface LockFileEvent

Returns:

The URL of the file that caused this event.

getLockFile

public java.io.File getLockFile()

Description copied from interface: LockFileEvent

Gets the file that caused this event.
Important: Only change this file if you consume this event!

Specified by:

getLockFile in interface LockFileEvent

Returns:

The file that caused this event.