org.apache.camel.component.file
Class FileConsumer

java.lang.Object
  org.apache.camel.impl.ServiceSupport
      org.apache.camel.impl.DefaultConsumer
          org.apache.camel.impl.ScheduledPollConsumer
              org.apache.camel.component.file.GenericFileConsumer<File>
                  org.apache.camel.component.file.FileConsumer

All Implemented Interfaces:

Runnable, BatchConsumer, Consumer, Service, ShutdownableService, ShutdownAware, SuspendableService

public class FileConsumer
extends GenericFileConsumer<File>

File consumer.

Field Summary

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

endpoint, fileExpressionResult, log, loggedIn, maxMessagesPerPoll, operations, pendingExchanges, shutdownRunningTask

Constructor Summary

FileConsumer(GenericFileEndpoint<File> endpoint, Processor processor, GenericFileOperations<File> operations)

Method Summary

static GenericFile<File>	asGenericFile(String endpointPath, File file) Creates a new GenericFile based on the given file.
FileEndpoint	getEndpoint() Gets the endpoint this Consumer consumes from.
protected boolean	pollDirectory(String fileName, List<GenericFile<File>> fileList) Polls the given directory for files to process

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

canPollMoreFiles, deferShutdown, doStart, getPendingExchangesSize, isBatchAllowed, isInProgress, isMatched, isValidFile, poll, postPollCheck, prepareShutdown, prePollCheck, processBatch, processExchange, setMaxMessagesPerPoll, setOperations

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

doStop, doSuspend, getDelay, getInitialDelay, getPollStrategy, getTimeUnit, isPollAllowed, isUseFixedDelay, run, setDelay, setInitialDelay, setPollStrategy, setTimeUnit, setUseFixedDelay

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

getAsyncProcessor, getExceptionHandler, getProcessor, handleException, setExceptionHandler, toString

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

addChildService, doResume, doShutdown, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, 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

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Detail

FileConsumer

public FileConsumer(GenericFileEndpoint<File> endpoint,
                    Processor processor,
                    GenericFileOperations<File> operations)

Method Detail

pollDirectory

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

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

Returns:

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

asGenericFile

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

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

getEndpoint

public FileEndpoint getEndpoint()

Description copied from interface: Consumer

Gets the endpoint this Consumer consumes from.

Specified by:

getEndpoint in interface Consumer

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint