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

java.lang.Object
  org.apache.camel.component.file.strategy.FileLockExclusiveReadLockStrategy

All Implemented Interfaces:

GenericFileExclusiveReadLockStrategy<File>

public class FileLockExclusiveReadLockStrategy
extends Object
implements GenericFileExclusiveReadLockStrategy<File>

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

FileLockExclusiveReadLockStrategy()

Method Summary

boolean	acquireExclusiveReadLock(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Acquires exclusive read lock to the file.
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	releaseExclusiveReadLock(GenericFileOperations<File> operations, GenericFile<File> file, Exchange exchange) Releases the exclusive read lock granted by the acquireExclusiveReadLock method.
void	setTimeout(long timeout) Sets an optional timeout period.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLockExclusiveReadLockStrategy

public FileLockExclusiveReadLockStrategy()

Method Detail

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>

Parameters:

operations - generic file operations

endpoint - the endpoint

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

releaseExclusiveReadLock

public void releaseExclusiveReadLock(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.

Specified by:

releaseExclusiveReadLock in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

operations - generic file operations

file - the file

exchange - the exchange

Throws:

Exception - can be thrown in case of errors

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

Sets an optional timeout period.

If the readlock could not be granted within the timeperiod then the wait is stopped and the acquireReadLock returns false.

Specified by:

setTimeout in interface GenericFileExclusiveReadLockStrategy<File>

Parameters:

timeout - period in millis