Package com.adaptris.core.fs

Class TraversingFsConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.AdaptrisPollingConsumer

com.adaptris.core.fs.FsConsumerImpl

com.adaptris.core.fs.FsConsumer

com.adaptris.core.fs.TraversingFsConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent

@ComponentProfile(summary="Pickup messages from the filesystem; traversing sub-directories",
                  tag="consumer,fs,filesystem",
                  metadata={"originalname","fsFileSize","lastmodified","fsConsumeDir","_interlokMessageConsumedFrom","fsParentDir"},
                  recommended=NullConnection.class)
public class TraversingFsConsumer
extends FsConsumer

Extension of the standard FsConsumer that traverses all subdirectories for files that match the filter expression.

In the adapter configuration file this class is aliased as traversing-fs-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.AdaptrisPollingConsumer

AdaptrisPollingConsumer.LockOperator

Field Summary

Fields inherited from class com.adaptris.core.fs.FsConsumerImpl

fileFilter, fsWorker

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
TraversingFsConsumer()

Method Summary

Modifier and Type	Method	Description
protected int	processFile(java.io.File f)	Attempt to process this file which might be a directory.
protected int	processMessages()	If reacquire-lock-between-messages is set to true, this.reaquireLock is called after each message has been processed.

Methods inherited from class com.adaptris.core.fs.FsConsumer

getResetWipFiles, getWipSuffix, init, renameFile, resetWipFiles, setResetWipFiles, setWipSuffix

Methods inherited from class com.adaptris.core.fs.FsConsumerImpl

addStandardMetadata, baseDirUrl, checkModified, consumeLocationKey, createAdaptrisMessage, filterExpression, getBaseDirectoryUrl, getCreateDirs, getFileFilterImp, getFileSorter, getFilterExpression, getLogAllExceptions, getQuietInterval, isFileAccessible, logAllExceptions, prepareConsumer, setBaseDirectoryUrl, setCreateDirs, setFileFilterImp, setFileSorter, setFilterExpression, setLogAllExceptions, setQuietInterval, shouldCreateDirs, verifyDirectory, withBaseDirectoryUrl, withFilterExpression

Methods inherited from class com.adaptris.core.AdaptrisPollingConsumer

close, continueProcessingMessages, getMaxMessagesPerPoll, getPoller, getReacquireLockBetweenMessages, prepare, releaseLock, setMaxMessagesPerPoll, setPoller, setReacquireLockBetweenMessages, start, stop

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, newThreadName, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

TraversingFsConsumer

public TraversingFsConsumer()

Method Detail

processMessages

protected int processMessages()

Description copied from class: FsConsumerImpl

If reacquire-lock-between-messages is set to true, this.reaquireLock is called after each message has been processed. This gives other Threads (e.g. something stopping the adapter) the opportunity to obtain the lock without waiting for all messages to be processed.

Overrides:

processMessages in class FsConsumerImpl

See Also:

AdaptrisPollingConsumer.processMessages()

processFile

protected int processFile(java.io.File f)
                   throws CoreException

Description copied from class: FsConsumerImpl

Attempt to process this file which might be a directory.

Overrides:

processFile in class FsConsumer

Parameters:

f - the File

Returns:

the number of files processed.

Throws:

CoreException - wrapping any other Exception.