@ElementType(value=ENDPOINT) @SupportsOutputStreaming public abstract class FileSystemSender<F,FS extends IBasicFileSystem<F>> extends StreamingSenderBase implements HasPhysicalDestination
FileSystem
.FileSystemActor
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.parameterNamesMustBeUnique, paramList
log
Constructor and Description |
---|
FileSystemSender() |
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) |
canProvideOutputStream, sendMessage, supportsOutputStreamPassThrough
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList
createBean, getLogPrefix, getName, isSynchronous, setApplicationContext, setName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
consumesSessionVariable
isSynchronous, sendMessageOrThrow
getName, setName
getApplicationContext, getName
getConfigurationClassLoader
setApplicationContext
addParameter, getParameterList
public void configure() throws ConfigurationException
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.configure
in interface IConfigurable
configure
in interface ISender
configure
in class StreamingSenderBase
ConfigurationException
public void open() throws SenderException
ISender
sendMessage()
method.open
in interface ISender
open
in class SenderBase
SenderException
public void close() throws SenderException
ISender
close
in interface ISender
close
in class SenderBase
SenderException
public MessageOutputStream provideOutputStream(PipeLineSession session, IForwardTarget next) throws StreamingException
IOutputStreamingSupport
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 outputstreamprovideOutputStream
in interface IOutputStreamingSupport
StreamingException
public PipeRunResult sendMessage(Message message, PipeLineSession session, IForwardTarget next) throws SenderException, TimeoutException
sendMessage
in interface IStreamingSender
SenderException
TimeoutException
public String getPhysicalDestinationName()
getPhysicalDestinationName
in interface HasPhysicalDestination
public String getDomain()
getDomain
in interface HasPhysicalDestination
public void setFileSystem(FS fileSystem)
public FS getFileSystem()
protected void addActions(List<FileSystemActor.FileSystemAction> specificActions)
public void setAction(FileSystemActor.FileSystemAction action)
public FileSystemActor.FileSystemAction getAction()
public void setFilename(String filename)
public void setDestination(String destination)
public void setInputFolder(String inputFolder)
public void setCreateFolder(boolean createFolder)
public void setOverwrite(boolean overwrite)
public void setRotateDays(int rotateDays)
public void setRotateSize(int rotateSize)
public void setNumberOfBackups(int numberOfBackups)
@Deprecated public void setBase64(Base64Pipe.Direction base64)
@Deprecated @ConfigurationWarning(value="attribute \'wildCard\' has been renamed to \'wildcard\'") public void setWildCard(String wildcard)
public void setWildcard(String wildcard)
@Deprecated @ConfigurationWarning(value="attribute \'excludeWildCard\' has been renamed to \'excludeWildcard\'") public void setExcludeWildCard(String excludeWildcard)
public void setExcludeWildcard(String excludeWildcard)
public void setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)
public void setWriteLineSeparator(boolean writeLineSeparator)
public void setCharset(String charset)
public void setDeleteEmptyFolder(boolean deleteEmptyFolder)
public void setOutputFormat(DocumentFormat outputFormat)
Copyright © 2023 Frank!Framework. All rights reserved.