org.apache.camel.component.file.strategy

Class FileIdempotentRepositoryReadLockStrategy

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.component.file.strategy.FileIdempotentRepositoryReadLockStrategy

All Implemented Interfaces:

CamelContextAware, GenericFileExclusiveReadLockStrategy<File>, Service, ShutdownableService, StatefulService, SuspendableService

public class FileIdempotentRepositoryReadLockStrategy
extends ServiceSupport
implements GenericFileExclusiveReadLockStrategy<File>, CamelContextAware

A file read lock that uses an IdempotentRepository as the lock strategy. This allows to plugin and use existing idempotent repositories that for example supports clustering. The other read lock strategies that are using marker files or file locks, are not guaranteed to work in clustered setup with various platform and file systems.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
FileIdempotentRepositoryReadLockStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acquireExclusiveReadLock(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Acquires exclusive read lock to the file.
protected String	asKey(GenericFile<File> file)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
IdempotentRepository<String>	getIdempotentRepository() The idempotent repository to use as the store for the read locks.
boolean	isRemoveOnCommit() Whether to remove the file from the idempotent repository when doing a commit.
boolean	isRemoveOnRollback() Whether to remove the file from the idempotent repository when doing a rollback.
void	prepareOnStartup(GenericFileOperations<File> operations, GenericFileEndpoint<File> endpoint) Allows custom logic to be run on startup preparing the strategy, such as removing old lock files etc.
void	releaseExclusiveReadLockOnAbort(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Releases the exclusive read lock granted by the acquireExclusiveReadLock method due an abort operation (acquireExclusiveReadLock returned false).
void	releaseExclusiveReadLockOnCommit(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Releases the exclusive read lock granted by the acquireExclusiveReadLock method due a commit operation (Exchange processing succeeded)
void	releaseExclusiveReadLockOnRollback(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Releases the exclusive read lock granted by the acquireExclusiveReadLock method due a rollback operation (Exchange processing failed)
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setCheckInterval(long checkInterval) Sets the check interval period.
void	setDeleteOrphanLockFiles(boolean deleteOrphanLockFiles) Sets whether orphan marker files should be deleted upon startup
void	setIdempotentRepository(IdempotentRepository<String> idempotentRepository) The idempotent repository to use as the store for the read locks.
void	setMarkerFiler(boolean markerFile) Sets whether marker file should be used or not.
void	setReadLockLoggingLevel(LoggingLevel readLockLoggingLevel) Sets logging level used when a read lock could not be acquired.
void	setRemoveOnCommit(boolean removeOnCommit) Whether to remove the file from the idempotent repository when doing a commit.
void	setRemoveOnRollback(boolean removeOnRollback) Whether to remove the file from the idempotent repository when doing a rollback.
void	setTimeout(long timeout) Sets an optional timeout period.

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

FileIdempotentRepositoryReadLockStrategy

public FileIdempotentRepositoryReadLockStrategy()

Method Detail

prepareOnStartup

public void prepareOnStartup(GenericFileOperations<File> operations,
                    GenericFileEndpoint<File> endpoint)
                      throws Exception

Description copied from interface: GenericFileExclusiveReadLockStrategy

Allows custom logic to be run on startup preparing the strategy, such as removing old lock files etc.

Specified by:

prepareOnStartup in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

endpoint - the endpoint

Throws:

Exception - can be thrown in case of errors

acquireExclusiveReadLock

public boolean acquireExclusiveReadLock(GenericFileOperations<File> operations,
                               GenericFile<File> file,
                               Exchange exchange)
                                 throws Exception

Description copied from interface: GenericFileExclusiveReadLockStrategy

Acquires exclusive read lock to the file.

Specified by:

acquireExclusiveReadLock in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

file - the file

exchange - the exchange

Returns:

true if read lock was acquired. If false Camel will skip the file and try it on the next poll

Throws:

Exception - can be thrown in case of errors

releaseExclusiveReadLockOnAbort

public void releaseExclusiveReadLockOnAbort(GenericFileOperations<File> operations,
                                   GenericFile<File> file,
                                   Exchange exchange)
                                     throws Exception

Description copied from interface: GenericFileExclusiveReadLockStrategy

Releases the exclusive read lock granted by the acquireExclusiveReadLock method due an abort operation (acquireExclusiveReadLock returned false).

Specified by:

releaseExclusiveReadLockOnAbort in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

file - the file

exchange - the exchange

Throws:

Exception - can be thrown in case of errors

releaseExclusiveReadLockOnRollback

public void releaseExclusiveReadLockOnRollback(GenericFileOperations<File> operations,
                                      GenericFile<File> file,
                                      Exchange exchange)
                                        throws Exception

Description copied from interface: GenericFileExclusiveReadLockStrategy

Releases the exclusive read lock granted by the acquireExclusiveReadLock method due a rollback operation (Exchange processing failed)

Specified by:

releaseExclusiveReadLockOnRollback in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

file - the file

exchange - the exchange

Throws:

Exception - can be thrown in case of errors

releaseExclusiveReadLockOnCommit

public void releaseExclusiveReadLockOnCommit(GenericFileOperations<File> operations,
                                    GenericFile<File> file,
                                    Exchange exchange)
                                      throws Exception

Description copied from interface: GenericFileExclusiveReadLockStrategy

Releases the exclusive read lock granted by the acquireExclusiveReadLock method due a commit operation (Exchange processing succeeded)

Specified by:

releaseExclusiveReadLockOnCommit in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

file - the file

exchange - the exchange

Throws:

Exception - can be thrown in case of errors

setTimeout

public void setTimeout(long timeout)

Description copied from interface: GenericFileExclusiveReadLockStrategy

Sets an optional timeout period.

If the readlock could not be granted within the time period then the wait is stopped and the acquireExclusiveReadLock method returns false.

Specified by:

setTimeout in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

timeout - period in millis

setCheckInterval

public void setCheckInterval(long checkInterval)

Description copied from interface: GenericFileExclusiveReadLockStrategy

Sets the check interval period.

The check interval is used for sleeping between attempts to acquire read lock. Setting a high value allows to cater for slow writes in case the producer of the file is slow.

The default period is 1000 millis.

Specified by:

setCheckInterval in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

checkInterval - interval in millis

setReadLockLoggingLevel

public void setReadLockLoggingLevel(LoggingLevel readLockLoggingLevel)

Description copied from interface: GenericFileExclusiveReadLockStrategy

Sets logging level used when a read lock could not be acquired.

Logging level used when a read lock could not be acquired.

The default logging level is WARN

Specified by:

setReadLockLoggingLevel in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

readLockLoggingLevel - LoggingLevel

setMarkerFiler

public void setMarkerFiler(boolean markerFile)

Description copied from interface: GenericFileExclusiveReadLockStrategy

Sets whether marker file should be used or not.

Specified by:

setMarkerFiler in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

markerFile - true to use marker files.

setDeleteOrphanLockFiles

public void setDeleteOrphanLockFiles(boolean deleteOrphanLockFiles)

Description copied from interface: GenericFileExclusiveReadLockStrategy

Sets whether orphan marker files should be deleted upon startup

Specified by:

setDeleteOrphanLockFiles in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

deleteOrphanLockFiles - true to delete files, false to skip this check

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getIdempotentRepository

public IdempotentRepository<String> getIdempotentRepository()

The idempotent repository to use as the store for the read locks.

setIdempotentRepository

public void setIdempotentRepository(IdempotentRepository<String> idempotentRepository)

The idempotent repository to use as the store for the read locks.

isRemoveOnRollback

public boolean isRemoveOnRollback()

Whether to remove the file from the idempotent repository when doing a rollback.

By default this is true.

setRemoveOnRollback

public void setRemoveOnRollback(boolean removeOnRollback)

Whether to remove the file from the idempotent repository when doing a rollback.

By default this is true.

isRemoveOnCommit

public boolean isRemoveOnCommit()

Whether to remove the file from the idempotent repository when doing a commit.

By default this is false.

setRemoveOnCommit

public void setRemoveOnCommit(boolean removeOnCommit)

Whether to remove the file from the idempotent repository when doing a commit.

By default this is false.

asKey

protected String asKey(GenericFile<File> file)

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()