com.adaptris.core.ftp

Class FtpConsumerImpl

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.AdaptrisPollingConsumer

com.adaptris.core.ftp.FtpConsumerImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

FtpConsumer, RelaxedFtpConsumer

public abstract class FtpConsumerImpl
extends AdaptrisPollingConsumer

Abstract FTP Implementation of the AdaptrisMessageConsumer implementation.

Nested Class Summary

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

AdaptrisPollingConsumer.LockOperator

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_FILE_FILTER_IMPL
protected static TimeInterval	DEFAULT_OLDER_THAN
protected java.io.FileFilter	fileFilter
protected FileTransferClient	ftpClient

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
FtpConsumerImpl()

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(java.lang.String path)
protected boolean	additionalDebug()
protected AdaptrisMessage	addStandardMetadata(AdaptrisMessage msg, java.lang.String filename, java.lang.String dir)
protected java.lang.String	configureWorkDir(java.lang.String path)
java.lang.String	consumeLocationKey() Provides the metadata key '"fsConsumeDir"' that contains the directory (if not null) where the file was read from.
protected abstract boolean	fetchAndProcess(java.lang.String fullPath)
protected java.lang.String	fileFilterImp()
java.lang.String	getFileFilterImp()
TimeInterval	getQuietInterval()
void	init() Initialises the component.
protected boolean	oldEnough(java.lang.String fullPath)
protected long	olderThanMs()
protected void	prepareConsumer()
protected int	processMessages() Implemented by protocol-specific sub-classes.
void	setFileFilterImp(java.lang.String s) Set the filename filter implementation that will be used for filtering files.
void	setQuietInterval(TimeInterval interval) Specify the time in which a file has been untouched before it is deemed safe to be processed.

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, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestination

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

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.AdaptrisMessageWorker

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Field Detail

DEFAULT_OLDER_THAN

protected static final TimeInterval DEFAULT_OLDER_THAN

DEFAULT_FILE_FILTER_IMPL

protected static final java.lang.String DEFAULT_FILE_FILTER_IMPL

See Also:

Constant Field Values

fileFilter

protected transient java.io.FileFilter fileFilter

ftpClient

protected transient FileTransferClient ftpClient

Constructor Detail

FtpConsumerImpl

public FtpConsumerImpl()

Method Detail

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

Overrides:

init in class AdaptrisPollingConsumer

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.init()

additionalDebug

protected boolean additionalDebug()

oldEnough

protected boolean oldEnough(java.lang.String fullPath)
                     throws FileTransferException,
                            java.io.IOException

Throws:

FileTransferException

java.io.IOException

addStandardMetadata

protected AdaptrisMessage addStandardMetadata(AdaptrisMessage msg,
                                              java.lang.String filename,
                                              java.lang.String dir)

processMessages

protected int processMessages()

Description copied from class: AdaptrisPollingConsumer

Implemented by protocol-specific sub-classes.

Specified by:

processMessages in class AdaptrisPollingConsumer

fetchAndProcess

protected abstract boolean fetchAndProcess(java.lang.String fullPath)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

configureWorkDir

protected java.lang.String configureWorkDir(java.lang.String path)

accept

protected boolean accept(java.lang.String path)
                  throws java.lang.Exception

Throws:

java.lang.Exception

prepareConsumer

protected void prepareConsumer()
                        throws CoreException

Specified by:

prepareConsumer in class AdaptrisPollingConsumer

Throws:

CoreException

fileFilterImp

protected java.lang.String fileFilterImp()

getFileFilterImp

public java.lang.String getFileFilterImp()

Returns:

Returns the fileFilterImp.

setFileFilterImp

public void setFileFilterImp(java.lang.String s)

Set the filename filter implementation that will be used for filtering files.

The String expression that is used to filter messages is obtained from ConsumeDestination.

Note that because we working against a remote server, support for additional file attributes such as size (e.g. via SizeGreaterThan) or last modified may not be supported. We encourage you to stick with filtering by filename only.

Parameters:

s - The fileFilterImp to set, if not specified, then the default is org.apache.commons.io.filefilter.RegexFileFilter which uses the java.util regular expressions to perform filtering

See Also:

ConsumeDestination.getFilterExpression()

olderThanMs

protected long olderThanMs()

getQuietInterval

public TimeInterval getQuietInterval()

setQuietInterval

public void setQuietInterval(TimeInterval interval)

Specify the time in which a file has been untouched before it is deemed safe to be processed.

The purpose of this is to delay processing of files that may be currently being written to by another process. On certain platforms (e.g. most Unix) it is still possible to obtain an exclusive lock on the file even though it is being written to by another process.

Note: your mileage may vary when using this setting. The FTP Server and the FTP Client will almost certainly have to time-synchronized. Depending on the FTP Server implementation in question, you may need to additionally specify the server's timezone in order to get accurate information.Additionally, the remote FTP server needs to support support the MDTM command.

Parameters:

interval - the quietPeriod to set (default to 0)

See Also:

FtpConnectionImp.setServerTimezone(String), CompositeFileFilter, setFileFilterImp(String)

consumeLocationKey

public java.lang.String consumeLocationKey()

Provides the metadata key '"fsConsumeDir"' that contains the directory (if not null) where the file was read from.

Returns:

the metadata key;

Since:

3.9.0