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

Class GenericFileRenameProcessStrategy<T>

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.component.file.strategy.GenericFileProcessStrategySupport<T>

org.apache.camel.component.file.strategy.GenericFileRenameProcessStrategy<T>

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, GenericFileProcessStrategy<T>, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class GenericFileRenameProcessStrategy<T>
extends GenericFileProcessStrategySupport<T>

Field Summary

Fields inherited from class org.apache.camel.component.file.strategy.GenericFileProcessStrategySupport

camelContext, exclusiveReadLockStrategy

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
GenericFileRenameProcessStrategy()

Method Summary

Modifier and Type	Method	Description
boolean	begin(GenericFileOperations<T> operations, GenericFileEndpoint<T> endpoint, org.apache.camel.Exchange exchange, GenericFile<T> file)	Called when work is about to begin on this file.
void	commit(GenericFileOperations<T> operations, GenericFileEndpoint<T> endpoint, org.apache.camel.Exchange exchange, GenericFile<T> file)	Releases any file locks and possibly deletes or moves the file after successful processing
GenericFileRenamer<T>	getBeginRenamer()
GenericFileRenamer<T>	getCommitRenamer()
GenericFileRenamer<T>	getFailureRenamer()
void	rollback(GenericFileOperations<T> operations, GenericFileEndpoint<T> endpoint, org.apache.camel.Exchange exchange, GenericFile<T> file)	Releases any file locks and possibly deletes or moves the file after unsuccessful processing
void	setBeginRenamer(GenericFileRenamer<T> beginRenamer)
void	setCommitRenamer(GenericFileRenamer<T> commitRenamer)
void	setFailureRenamer(GenericFileRenamer<T> failureRenamer)

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

abort, deleteLocalWorkFile, doShutdown, doStart, doStop, getCamelContext, getExclusiveReadLockStrategy, prepareOnStartup, renameFile, setCamelContext, setExclusiveReadLockStrategy

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Detail

GenericFileRenameProcessStrategy

public GenericFileRenameProcessStrategy()

Method Detail

begin

public boolean begin(GenericFileOperations<T> operations,
                     GenericFileEndpoint<T> endpoint,
                     org.apache.camel.Exchange exchange,
                     GenericFile<T> file)
              throws Exception

Description copied from interface: GenericFileProcessStrategy

Called when work is about to begin on this file. This method may attempt to acquire some file lock before returning true; returning false if the file lock could not be obtained so that the file should be ignored.

Specified by:

begin in interface GenericFileProcessStrategy<T>

Overrides:

begin in class GenericFileProcessStrategySupport<T>

Parameters:

operations - file operations

endpoint - the endpoint

exchange - the exchange

file - the file

Returns:

true if the file can be processed (such as if a file lock could be obtained)

Throws:

Exception - can be thrown in case of errors

rollback

public void rollback(GenericFileOperations<T> operations,
                     GenericFileEndpoint<T> endpoint,
                     org.apache.camel.Exchange exchange,
                     GenericFile<T> file)
              throws Exception

Description copied from interface: GenericFileProcessStrategy

Releases any file locks and possibly deletes or moves the file after unsuccessful processing

Specified by:

rollback in interface GenericFileProcessStrategy<T>

Overrides:

rollback in class GenericFileProcessStrategySupport<T>

Parameters:

operations - file operations

endpoint - the endpoint

exchange - the exchange

file - the file

Throws:

Exception - can be thrown in case of errors

commit

public void commit(GenericFileOperations<T> operations,
                   GenericFileEndpoint<T> endpoint,
                   org.apache.camel.Exchange exchange,
                   GenericFile<T> file)
            throws Exception

Description copied from interface: GenericFileProcessStrategy

Releases any file locks and possibly deletes or moves the file after successful processing

Specified by:

commit in interface GenericFileProcessStrategy<T>

Overrides:

commit in class GenericFileProcessStrategySupport<T>

Parameters:

operations - file operations

endpoint - the endpoint

exchange - the exchange

file - the file

Throws:

Exception - can be thrown in case of errors

getBeginRenamer

public GenericFileRenamer<T> getBeginRenamer()

setBeginRenamer

public void setBeginRenamer(GenericFileRenamer<T> beginRenamer)

getCommitRenamer

public GenericFileRenamer<T> getCommitRenamer()

setCommitRenamer

public void setCommitRenamer(GenericFileRenamer<T> commitRenamer)

getFailureRenamer

public GenericFileRenamer<T> getFailureRenamer()

setFailureRenamer

public void setFailureRenamer(GenericFileRenamer<T> failureRenamer)