Package org.nuxeo.runtime.trackers.files

Class FileEventTracker

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.runtime.trackers.files.FileEventTracker

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService

public class FileEventTracker
extends DefaultComponent

Files event tracker which delete files once the runtime leave the threads or at least once the associated marker object is garbaged. Note: for being backward compatible you may disable the thread events tracking by black-listing the default configuration component "org.nuxeo.runtime.trackers.files.threadstracking.config" in the runtime. This could be achieved by editing the "blacklist" file in your 'config' directory or using the @{link BlacklistComponent} annotation on your test class.

Since:

6.0

Author:

Stephane Lacoin at Nuxeo (aka matic)

See Also:

ThreadEventHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FileEventTracker.BaseFileEventHandler
static class	FileEventTracker.EnableThreadsTracking
protected static class	FileEventTracker.GCDelegate
protected class	FileEventTracker.ThreadDelegate

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.nuxeo.runtime.trackers.files.FileEventTracker.SafeFileDeleteStrategy	deleteStrategy
protected FileEventListener	filesListener
protected static org.nuxeo.runtime.trackers.files.FileEventTracker.ForceSafeFileDeleteStrategy	forceDeleteStrategy
protected FileEventTracker.GCDelegate	gc
protected static Log	log
protected ThreadLocal<FileEventTracker.ThreadDelegate>	threads
protected ThreadEventListener	threadsListener

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
FileEventTracker()

Method Summary

Modifier and Type	Method	Description
void	activate(ComponentContext context)	Activates the component.
void	deactivate(ComponentContext context)	Deactivates the component.
int	getApplicationStartedOrder()	The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).
static org.nuxeo.runtime.trackers.files.FileEventTracker.SafeFileDeleteStrategy	getDeleteStrategy()	For test purpose.
static org.nuxeo.runtime.trackers.files.FileEventTracker.ForceSafeFileDeleteStrategy	getForceDeleteStrategy()	For test purpose.
protected FileEventHandler	onContext()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
static void	registerProtectedPath(String path)	Registers a protected path under which files should not be deleted
protected void	resetThreadDelegate()
protected void	setThreadDelegate(boolean isLongRunning)
void	start(ComponentContext context)	Start the component.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

addRuntimeMessage, addRuntimeMessage, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted

Field Detail

log

protected static final Log log

deleteStrategy

protected static org.nuxeo.runtime.trackers.files.FileEventTracker.SafeFileDeleteStrategy deleteStrategy

forceDeleteStrategy

protected static org.nuxeo.runtime.trackers.files.FileEventTracker.ForceSafeFileDeleteStrategy forceDeleteStrategy

gc

protected final FileEventTracker.GCDelegate gc

threads

protected final ThreadLocal<FileEventTracker.ThreadDelegate> threads

threadsListener

protected final ThreadEventListener threadsListener

filesListener

protected final FileEventListener filesListener

Constructor Detail

FileEventTracker

public FileEventTracker()

Method Detail

registerProtectedPath

public static void registerProtectedPath(String path)

Registers a protected path under which files should not be deleted

Since:

7.2

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Returns:

the order, 1000 by default

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

onContext

protected FileEventHandler onContext()

setThreadDelegate

protected void setThreadDelegate(boolean isLongRunning)

resetThreadDelegate

protected void resetThreadDelegate()
                            throws IllegalStateException

Throws:

IllegalStateException

getDeleteStrategy

public static org.nuxeo.runtime.trackers.files.FileEventTracker.SafeFileDeleteStrategy getDeleteStrategy()

For test purpose.

Since:

2023.5

getForceDeleteStrategy

public static org.nuxeo.runtime.trackers.files.FileEventTracker.ForceSafeFileDeleteStrategy getForceDeleteStrategy()

For test purpose.

Since:

2023.5