Package org.apache.camel.component.file.strategy

Class FileLockExclusiveReadLockStrategy

java.lang.Object

org.apache.camel.component.file.strategy.MarkerFileExclusiveReadLockStrategy

org.apache.camel.component.file.strategy.FileLockExclusiveReadLockStrategy

All Implemented Interfaces:

GenericFileExclusiveReadLockStrategy<File>

public class FileLockExclusiveReadLockStrategy
extends MarkerFileExclusiveReadLockStrategy

Acquires exclusive read lock to the given file. Will wait until the lock is granted. After granting the read lock it is released, we just want to make sure that when we start consuming the file its not currently in progress of being written by third party.

Constructor Summary

Constructors

Constructor	Description
FileLockExclusiveReadLockStrategy()

Method Summary

Modifier and Type	Method	Description
boolean	acquireExclusiveReadLock(GenericFileOperations<File> operations, GenericFile<File> file, org.apache.camel.Exchange exchange)	Acquires exclusive read lock to the file.
protected void	doReleaseExclusiveReadLock(GenericFile<File> file, org.apache.camel.Exchange exchange)	Perform the releases of the exclusive read lock granted by the acquireExclusiveReadLock method due a commit operation.
long	getTimeout()
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	setCheckInterval(long checkInterval)	Sets the check interval period.
void	setReadLockLoggingLevel(org.apache.camel.LoggingLevel readLockLoggingLevel)	Sets logging level used when a read lock could not be acquired.
void	setTimeout(long timeout)	Sets an optional timeout period.

Methods inherited from class org.apache.camel.component.file.strategy.MarkerFileExclusiveReadLockStrategy

releaseExclusiveReadLockOnAbort, releaseExclusiveReadLockOnCommit, releaseExclusiveReadLockOnRollback, setDeleteOrphanLockFiles, setMarkerFiler

Methods inherited from class java.lang.Object

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

Constructor Details

FileLockExclusiveReadLockStrategy

public FileLockExclusiveReadLockStrategy()

Method Details

prepareOnStartup

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

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>

Overrides:

prepareOnStartup in class MarkerFileExclusiveReadLockStrategy

Parameters:

operations - generic file operations

endpoint - the endpoint

acquireExclusiveReadLock

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

Description copied from interface: GenericFileExclusiveReadLockStrategy

Acquires exclusive read lock to the file.

Specified by:

acquireExclusiveReadLock in interface GenericFileExclusiveReadLockStrategy<File>

Overrides:

acquireExclusiveReadLock in class MarkerFileExclusiveReadLockStrategy

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

doReleaseExclusiveReadLock

protected void doReleaseExclusiveReadLock(GenericFile<File> file,
 org.apache.camel.Exchange exchange)
                                   throws Exception

Description copied from class: MarkerFileExclusiveReadLockStrategy

Perform the releases of the exclusive read lock granted by the acquireExclusiveReadLock method due a commit operation.

Overrides:

doReleaseExclusiveReadLock in class MarkerFileExclusiveReadLockStrategy

Parameters:

file - the file

exchange - the exchange

Throws:

Exception - can be thrown in case of errors

See Also:

• MarkerFileExclusiveReadLockStrategy.releaseExclusiveReadLockOnCommit(GenericFileOperations, GenericFile, Exchange)
• MarkerFileExclusiveReadLockStrategy.releaseExclusiveReadLockOnRollback(GenericFileOperations, GenericFile, Exchange)
• MarkerFileExclusiveReadLockStrategy.releaseExclusiveReadLockOnAbort(GenericFileOperations, GenericFile, Exchange)

getTimeout

public long getTimeout()

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>

Overrides:

setTimeout in class MarkerFileExclusiveReadLockStrategy

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>

Overrides:

setCheckInterval in class MarkerFileExclusiveReadLockStrategy

Parameters:

checkInterval - interval in millis

setReadLockLoggingLevel

public void setReadLockLoggingLevel(org.apache.camel.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>

Overrides:

setReadLockLoggingLevel in class MarkerFileExclusiveReadLockStrategy

Parameters:

readLockLoggingLevel - LoggingLevel