nl.nn.adapterframework.filesystem

Class FileSystemSender<F,FS extends IBasicFileSystem<F>>

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.stream.StreamingSenderBase

nl.nn.adapterframework.filesystem.FileSystemSender<F,FS>

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IOutputStreamingSupport, IStreamingSender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

AmazonS3Sender, ExchangeFolderSender, FileSystemSenderWithAttachments, FtpFileSystemSender, ImapSender, LocalFileSystemSender, Samba1Sender, Samba2Sender

@ElementType(value=ENDPOINT)
 @SupportsOutputStreaming
public abstract class FileSystemSender<F,FS extends IBasicFileSystem<F>>
extends StreamingSenderBase
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 contents 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.

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
FileSystemSender()

Method Summary

Modifier and Type	Method and Description
protected void	addActions(List<FileSystemActor.FileSystemAction> specificActions)
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
FileSystemActor.FileSystemAction	getAction()
String	getDomain()
FS	getFileSystem()
String	getPhysicalDestinationName()
void	open() This method will be called to start the sender.
MessageOutputStream	provideOutputStream(PipeLineSession session, IForwardTarget next) return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way.
PipeRunResult	sendMessage(Message message, PipeLineSession session, IForwardTarget next)
void	setAction(FileSystemActor.FileSystemAction action)
void	setBase64(Base64Pipe.Direction base64) Deprecated.
void	setCharset(String charset)
void	setCreateFolder(boolean createFolder)
void	setDeleteEmptyFolder(boolean deleteEmptyFolder)
void	setDestination(String destination)
void	setExcludeWildcard(String excludeWildcard)
void	setExcludeWildCard(String excludeWildcard) Deprecated.
void	setFilename(String filename)
void	setFileSystem(FS 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	setWildcard(String wildcard)
void	setWildCard(String wildcard) Deprecated.
void	setWriteLineSeparator(boolean writeLineSeparator)

Methods inherited from class nl.nn.adapterframework.stream.StreamingSenderBase

canProvideOutputStream, sendMessage, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

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

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

createBean, getLogPrefix, getName, isSynchronous, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IWithParameters

addParameter, getParameterList

Constructor Detail

FileSystemSender

public FileSystemSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

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

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class StreamingSenderBase

Throws:

ConfigurationException

open

public void open()
          throws SenderException

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:

open in interface ISender

Overrides:

open in class SenderBase

Throws:

SenderException

close

public void close()
           throws SenderException

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderBase

Throws:

SenderException

provideOutputStream

public MessageOutputStream provideOutputStream(PipeLineSession session,
                                               IForwardTarget next)
                                        throws StreamingException

Description copied from interface: IOutputStreamingSupport

return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way. If a target MessageOutputStream is required to stream output to, this can be obtained from next, if specified. If the implementor of this method is a pipe, and it is the last one in the chain of streaming pipes, it must provide the appropriate forward in the provide MessageOutputStream. If the class cannot provide an outputstream, it must return null. If the provider of an outputstream is a pipe itself, it must provide a proper pipeforward in the provided outputstream

Specified by:

provideOutputStream in interface IOutputStreamingSupport

Throws:

StreamingException

sendMessage

public PipeRunResult sendMessage(Message message,
                                 PipeLineSession session,
                                 IForwardTarget next)
                          throws SenderException,
                                 TimeoutException

Specified by:

sendMessage in interface IStreamingSender

Throws:

SenderException

TimeoutException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

getDomain

public String getDomain()

Specified by:

getDomain in interface HasPhysicalDestination

setFileSystem

public void setFileSystem(FS fileSystem)

getFileSystem

public FS getFileSystem()

addActions

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

setAction

public void setAction(FileSystemActor.FileSystemAction action)

getAction

public FileSystemActor.FileSystemAction getAction()

setFilename

public void setFilename(String filename)

setDestination

public void setDestination(String destination)

setInputFolder

public void setInputFolder(String inputFolder)

setCreateFolder

public void setCreateFolder(boolean createFolder)

setOverwrite

public void setOverwrite(boolean overwrite)

setRotateDays

public void setRotateDays(int rotateDays)

setRotateSize

public void setRotateSize(int rotateSize)

setNumberOfBackups

public void setNumberOfBackups(int numberOfBackups)

setBase64

@Deprecated
public void setBase64(Base64Pipe.Direction base64)

Deprecated.

setWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'wildCard\' has been renamed to \'wildcard\'")
public void setWildCard(String wildcard)

Deprecated.

setWildcard

public void setWildcard(String wildcard)

setExcludeWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'excludeWildCard\' has been renamed to \'excludeWildcard\'")
public void setExcludeWildCard(String excludeWildcard)

Deprecated.

setExcludeWildcard

public void setExcludeWildcard(String excludeWildcard)

setRemoveNonEmptyFolder

public void setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)

setWriteLineSeparator

public void setWriteLineSeparator(boolean writeLineSeparator)

setCharset

public void setCharset(String charset)

setDeleteEmptyFolder

public void setDeleteEmptyFolder(boolean deleteEmptyFolder)

setOutputFormat

public void setOutputFormat(DocumentFormat outputFormat)