Package org.nuxeo.runtime.trackers.files

Class FileEvent

java.lang.Object

org.nuxeo.runtime.services.event.Event

org.nuxeo.runtime.trackers.files.FileEvent

Direct Known Subclasses:

DirectoryEvent

public class FileEvent
extends Event

Runtime events about transient files which should be deleted once the runtime leave the thread ( FileEventTracker).

Producers should use the static onFile(Object, File, Object) factory method and fire events by invoking the event's send() method:

 FileEvent.onFile(source, aFile, aMarker).send();
 

Consumers should implements the FileEventHandler interface and register in the EventService using the FileEventListener wrapper:

 FileEventListener filesListener = new FileEventListener(new FileEventHandler() {
     @Override
     public void onFile(File file, Object marker) {
         ...
     }
 });
 ...
 filesListener.install();
 ...
 filesListener.uninstall();
 

Since:

6.0

Author:

Stephane Lacoin at Nuxeo (aka matic)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileEvent(Object source, File aFile, Object aMarker)

Method Summary

Modifier and Type	Method	Description
protected File	getFile()
protected Object	getMarker()
void	handle(FileEventHandler handler)
static void	ignore(FileEventListener aListener)
static void	listen(FileEventListener aListener)
static DirectoryEvent	onDirectory(Object source, File aFile, Object aMarker)
static FileEvent	onFile(Object source, File aFile, Object aMarker)
void	send()

Methods inherited from class org.nuxeo.runtime.services.event.Event

getData, getId, getSource, getTopic, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileEvent

protected FileEvent(Object source,
                    File aFile,
                    Object aMarker)

Method Detail

listen

public static void listen(FileEventListener aListener)

ignore

public static void ignore(FileEventListener aListener)

send

public void send()

handle

public void handle(FileEventHandler handler)

getFile

protected File getFile()

getMarker

protected Object getMarker()

onFile

public static FileEvent onFile(Object source,
                               File aFile,
                               Object aMarker)

onDirectory

public static DirectoryEvent onDirectory(Object source,
                                         File aFile,
                                         Object aMarker)

Since:

2023.5