Package org.frankframework.filesystem

Class AbstractFileSystemSender<F,S extends IBasicFileSystem<F>>

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.filesystem.AbstractFileSystemSender<F,S>

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

AmazonS3Sender, ExchangeFileSystemSender, FileSystemSenderWithAttachments, FtpFileSystemSender, ImapSender, LocalFileSystemSender, Samba1Sender, Samba2Sender, SftpFileSystemSender

@DestinationType(FILE_SYSTEM)
@EnterpriseIntegrationPattern(ENDPOINT)
@Forward(name="fileNotFound",description="if the input file was expected to exist, but was not found") @Forward(name="folderNotFound",description="if the folder does not exist") @Forward(name="fileAlreadyExists",description="if a file that should have been created as new already exists, or if a file already exists when it should have been created as folder") @Forward(name="folderAlreadyExists",description="if a folder is to be created that already exists")
public abstract class AbstractFileSystemSender<F,S extends IBasicFileSystem<F>>
extends AbstractSenderWithParameters
implements HasPhysicalDestination

Base class for Senders that use a FileSystem.

Author:

Gerrit van Brakel

See Also:

• FileSystemActor

Specific parameters

action Overrides attribute action., filename Overrides attribute filename. If not present, the input message is used., destination Destination for action rename and move. Overrides attribute destination., contents Content for action write and append., inputFolder Folder for actions list, mkdir and rmdir. This is a sub folder of baseFolder. Overrides attribute inputFolder. If not present, the input message is used., typeFilter Filter for action list. Specify FILES_ONLY, FOLDERS_ONLY or FILES_AND_FOLDERS. By default, only files are listed.

Field Summary

Fields inherited from class org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
AbstractFileSystemSender()

Method Summary

Modifier and Type	Method	Description
protected void	addActions(List<FileSystemActor.FileSystemAction> specificActions)
void	configure()	Configure this component.
FileSystemActor.FileSystemAction	getAction()
S	getFileSystem()
String	getPhysicalDestinationName()
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setAction(FileSystemActor.FileSystemAction action)
void	setCharset(String charset)
void	setCreateFolder(boolean createFolder)
void	setDeleteEmptyFolder(boolean deleteEmptyFolder)
void	setDestination(String destination)
void	setExcludeWildcard(String excludeWildcard)
void	setFilename(String filename)
void	setFileSystem(S fileSystem)
void	setInputFolder(String inputFolder)
void	setNumberOfBackups(int numberOfBackups)
void	setOutputFormat(DocumentFormat outputFormat)
void	setOverwrite(boolean overwrite)
void	setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)
void	setRotateDays(int rotateDays)
void	setRotateSize(int rotateSize)
void	setTypeFilter(TypeFilter typeFilter)
void	setWildcard(String wildcard)
void	setWriteLineSeparator(boolean writeLineSeparator)
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.NameAware

setName

Constructor Details

AbstractFileSystemSender

public AbstractFileSystemSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractSenderWithParameters

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractSender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractSender

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 PipeLineSession session)
                         throws SenderException,
TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setFileSystem

public void setFileSystem(S fileSystem)

getFileSystem

public S getFileSystem()

addActions

protected void addActions(List<FileSystemActor.FileSystemAction> specificActions)

setAction

@ReferTo(FileSystemActor.class)
public void setAction(FileSystemActor.FileSystemAction action)

getAction

public FileSystemActor.FileSystemAction getAction()

setFilename

@ReferTo(FileSystemActor.class)
public void setFilename(String filename)

setDestination

@ReferTo(FileSystemActor.class)
public void setDestination(String destination)

setInputFolder

@ReferTo(FileSystemActor.class)
public void setInputFolder(String inputFolder)

setCreateFolder

@ReferTo(FileSystemActor.class)
public void setCreateFolder(boolean createFolder)

setOverwrite

@ReferTo(FileSystemActor.class)
public void setOverwrite(boolean overwrite)

setRotateDays

@ReferTo(FileSystemActor.class)
public void setRotateDays(int rotateDays)

setRotateSize

@ReferTo(FileSystemActor.class)
public void setRotateSize(int rotateSize)

setNumberOfBackups

@ReferTo(FileSystemActor.class)
public void setNumberOfBackups(int numberOfBackups)

setWildcard

@ReferTo(FileSystemActor.class)
public void setWildcard(String wildcard)

setExcludeWildcard

@ReferTo(FileSystemActor.class)
public void setExcludeWildcard(String excludeWildcard)

setRemoveNonEmptyFolder

@ReferTo(FileSystemActor.class)
public void setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)

setWriteLineSeparator

@ReferTo(FileSystemActor.class)
public void setWriteLineSeparator(boolean writeLineSeparator)

setCharset

@ReferTo(FileSystemActor.class)
public void setCharset(String charset)

setDeleteEmptyFolder

@ReferTo(FileSystemActor.class)
public void setDeleteEmptyFolder(boolean deleteEmptyFolder)

setOutputFormat

@ReferTo(FileSystemActor.class)
public void setOutputFormat(DocumentFormat outputFormat)

setTypeFilter

@ReferTo(FileSystemActor.class)
public void setTypeFilter(TypeFilter typeFilter)