com.adaptris.core.ftp

Class FtpConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.AdaptrisPollingConsumer

com.adaptris.core.ftp.FtpConsumerImpl

com.adaptris.core.ftp.FtpConsumer

All Implemented Interfaces:

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

@ComponentProfile(summary="Pickup messages from an FTP or SFTP server",
                  tag="consumer,ftp,ftps,sftp",
                  metadata={"originalname","fsFileSize"},
                  recommended=FileTransferConnection.class)
public class FtpConsumer
extends FtpConsumerImpl

FTP implementation of the AdaptrisMessageConsumer interface.

The connection type for this consumer should always be a concrete implementation of FileTransferConnection.

The destination returned by the ConsumeDestination implementation should be in the form in the URL form dictated by the FileTransferConnection flavour or simply the IP Address / DNS name of the target Server. If the URL form is used, then it is possible to override the username, password, and port settings of the server, in all other cases the configuration specified in the FileTransferConnection object will be used.

In the event the proc-directory is not configured, then after processing the file, it is deleted. If proc-directory is configured, then the remote file will be renamed to this directory

The configuration of this consumer closely mirrors that of the FsConsumer though it does not, at the moment, share any common hierarchy with a key difference; although multiple file-filters can be configured only filters that work with the filepath will work. Other filter implementations (such as those based on size /last modified) may not work.

See Also:

FtpConnection, SftpConnection, FileTransferConnection, ConsumeDestination

In the adapter configuration file this class is aliased as ftp-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.ftp.FtpConsumerImpl

DEFAULT_FILE_FILTER_IMPL, DEFAULT_OLDER_THAN, fileFilter, 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
FtpConsumer()

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(java.lang.String path)
protected java.lang.String	configureWorkDir(java.lang.String path)
protected boolean	fetchAndProcess(java.lang.String fullPath)
java.lang.String	getProcDirectory() Get the "proc" directory.
java.lang.String	getWipSuffix()
java.lang.String	getWorkDirectory() Get the work directory.
void	init() Initialises the component.
void	setProcDirectory(java.lang.String s) Set the directory where files are placed after processing.
void	setWipSuffix(java.lang.String s) Set the suffix of the file to indicate it is being processed.
void	setWorkDirectory(java.lang.String s) Set the work directory.

Methods inherited from class com.adaptris.core.ftp.FtpConsumerImpl

additionalDebug, addStandardMetadata, fileFilterImp, getFileFilterImp, getQuietInterval, oldEnough, olderThanMs, prepareConsumer, processMessages, setFileFilterImp, setQuietInterval

Methods inherited from class com.adaptris.core.AdaptrisPollingConsumer

close, continueProcessingMessages, 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, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, 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, isConfirmation, isTrackingEndpoint

Constructor Detail

FtpConsumer

public FtpConsumer()

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 FtpConsumerImpl

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.init()

configureWorkDir

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

Overrides:

configureWorkDir in class FtpConsumerImpl

accept

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

Overrides:

accept in class FtpConsumerImpl

Throws:

java.lang.Exception

fetchAndProcess

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

Specified by:

fetchAndProcess in class FtpConsumerImpl

Throws:

java.lang.Exception

getProcDirectory

public java.lang.String getProcDirectory()

Get the "proc" directory.

Returns:

the configured directory.

getWorkDirectory

public java.lang.String getWorkDirectory()

Get the work directory.

Returns:

the work directory.

setProcDirectory

public void setProcDirectory(java.lang.String s)

Set the directory where files are placed after processing.

If set, then after downloading the file, it is renamed to this directory, otherwise it is deleted.

If the ConsumeDestination specifies a URL, then it is assumed be a sub-directory of the path specified by the URL. If the ConsumeDestination does not specify a URL, then it is an absolute path.

Parameters:

s - the directory

setWorkDirectory

public void setWorkDirectory(java.lang.String s)

Set the work directory.

If the ConsumeDestination specifies a URL, then it is assumed be a sub-directory of the path specified by the URL. If the ConsumeDestination does not specify a URL, then it is an absolute path.

Parameters:

s - the directory.

See Also:

ConsumeDestination

getWipSuffix

public java.lang.String getWipSuffix()

Returns:

Returns the wipSuffix.

setWipSuffix

public void setWipSuffix(java.lang.String s)

Set the suffix of the file to indicate it is being processed.

The first action performed by the consumer is to attempt to rename any file that it is attempting to process to mark it as being processed. This will allow multiple consumers to poll the same directory, and also isolate the consumer from anything that attempts to write to the file concurrently.

Parameters:

s - The wipSuffix to set, default is "_wip" if not specified.