org.apache.camel.component.file

Class FileConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.impl.ScheduledPollConsumer

org.apache.camel.impl.ScheduledBatchPollingConsumer

org.apache.camel.component.file.GenericFileConsumer<File>

org.apache.camel.component.file.FileConsumer

All Implemented Interfaces:

Runnable, BatchConsumer, Consumer, EndpointAware, PollingConsumerPollingStrategy, RouteAware, Service, ShutdownableService, ShutdownAware, ShutdownPrepared, StatefulService, Suspendable, SuspendableService

public class FileConsumer
extends GenericFileConsumer<File>

File consumer.

Field Summary

Fields inherited from class org.apache.camel.component.file.GenericFileConsumer

customProcessor, eagerLimitMaxMessagesPerPoll, endpoint, fileExpressionResult, log, operations, pendingExchanges, prepareOnStartup, processStrategy, shutdownRunningTask

Fields inherited from class org.apache.camel.impl.ScheduledBatchPollingConsumer

maxMessagesPerPoll

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

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

Constructor Summary

Constructors

Constructor and Description
FileConsumer(FileEndpoint endpoint, Processor processor, GenericFileOperations<File> operations, GenericFileProcessStrategy<File> processStrategy)

Method Summary

Modifier and Type	Method and Description
static GenericFile<File>	asGenericFile(String endpointPath, File file, String charset) Deprecated. use asGenericFile(String, File, String, boolean)
static GenericFile<File>	asGenericFile(String endpointPath, File file, String charset, boolean probeContentType) Creates a new GenericFile based on the given file.
FileEndpoint	getEndpoint() Gets the endpoint associated with an object.
protected boolean	isMatched(GenericFile<File> file, String doneFileName, List<File> files) Strategy to perform file matching based on endpoint configuration in terms of done file name.
protected boolean	pollDirectory(String fileName, List<GenericFile<File>> fileList, int depth) Polls the given directory for files to process
protected void	updateFileHeaders(GenericFile<File> file, Message message) Updates the information on Message after we have acquired read-lock and can begin process the file.

Methods inherited from class org.apache.camel.component.file.GenericFileConsumer

afterPoll, beforePoll, canPollMoreFiles, customProcessExchange, doStart, doStop, evaluateFileExpression, getCustomProcessor, ignoreCannotRetrieveFile, isEagerLimitMaxMessagesPerPoll, isInProgress, isMatched, isRetrieveFile, isValidFile, onInit, poll, postPollCheck, prePollCheck, processBatch, processExchange, removeExcessiveInProgressFiles, removeExcessiveInProgressFiles, setCustomProcessor, setEagerLimitMaxMessagesPerPoll, setOperations

Methods inherited from class org.apache.camel.impl.ScheduledBatchPollingConsumer

deferShutdown, getMaxMessagesPerPoll, getPendingExchangesSize, isBatchAllowed, prepareShutdown, processEmptyMessage, setMaxMessagesPerPoll

Methods inherited from class org.apache.camel.impl.ScheduledPollConsumer

doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler

Methods inherited from class org.apache.camel.impl.DefaultConsumer

createUoW, doneUoW, getAsyncProcessor, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

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

doResume, 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, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

FileConsumer

public FileConsumer(FileEndpoint endpoint,
                    Processor processor,
                    GenericFileOperations<File> operations,
                    GenericFileProcessStrategy<File> processStrategy)

Method Detail

pollDirectory

protected boolean pollDirectory(String fileName,
                                List<GenericFile<File>> fileList,
                                int depth)

Description copied from class: GenericFileConsumer

Polls the given directory for files to process

Specified by:

pollDirectory in class GenericFileConsumer<File>

Parameters:

fileName - current directory or file

fileList - current list of files gathered

depth - the current depth of the directory (will start from 0)

Returns:

whether or not to continue polling, false means the maxMessagesPerPoll limit has been hit

isMatched

protected boolean isMatched(GenericFile<File> file,
                            String doneFileName,
                            List<File> files)

Description copied from class: GenericFileConsumer

Strategy to perform file matching based on endpoint configuration in terms of done file name.

Specified by:

isMatched in class GenericFileConsumer<File>

Parameters:

file - the file

doneFileName - the done file name (without any paths)

files - files in the directory

Returns:

true if the file is matched, false if not

asGenericFile

@Deprecated
public static GenericFile<File> asGenericFile(String endpointPath,
                                                          File file,
                                                          String charset)

Deprecated. use asGenericFile(String, File, String, boolean)

Creates a new GenericFile based on the given file.

Parameters:

endpointPath - the starting directory the endpoint was configured with

file - the source file

Returns:

wrapped as a GenericFile

asGenericFile

public static GenericFile<File> asGenericFile(String endpointPath,
                                              File file,
                                              String charset,
                                              boolean probeContentType)

Creates a new GenericFile based on the given file.

Parameters:

endpointPath - the starting directory the endpoint was configured with

file - the source file

probeContentType - whether to probe the content type of the file or not

Returns:

wrapped as a GenericFile

updateFileHeaders

protected void updateFileHeaders(GenericFile<File> file,
                                 Message message)

Description copied from class: GenericFileConsumer

Updates the information on Message after we have acquired read-lock and can begin process the file.

Specified by:

updateFileHeaders in class GenericFileConsumer<File>

Parameters:

file - the file

message - the Camel message to update its headers

getEndpoint

public FileEndpoint getEndpoint()

Description copied from interface: EndpointAware

Gets the endpoint associated with an object. It's the endpoint for sending to for components like Producer or for consuming from for components like Consumer or Route

Specified by:

getEndpoint in interface EndpointAware

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint