org.mule.extension.file.common.api.command

Interface WriteCommand

public interface WriteCommand

Command design pattern for writing files

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	write(String filePath, Object content, FileWriteMode mode, org.mule.runtime.api.message.MuleEvent event, boolean lock, boolean createParentDirectory, String encoding) Writes a file under the considerations of FileSystem#write(FileConnectorConfig, String, Object, FileWriteMode, MuleEvent, boolean, boolean, String)

Method Detail

write

void write(String filePath,
           Object content,
           FileWriteMode mode,
           org.mule.runtime.api.message.MuleEvent event,
           boolean lock,
           boolean createParentDirectory,
           String encoding)

Writes a file under the considerations of FileSystem#write(FileConnectorConfig, String, Object, FileWriteMode, MuleEvent, boolean, boolean, String)

Parameters:

filePath - the path of the file to be written

content - the content to be written into the file

mode - a FileWriteMode

event - the MuleEvent which processing triggers this operation

lock - whether or not to lock the file

createParentDirectory - whether or not to attempt creating the parent directory if it doesn't exists.

encoding - when is a String, this attribute specifies the encoding to be used when writing. If not set, then it defaults to FileConnectorConfig.getDefaultWriteEncoding()

Throws:

IllegalArgumentException - if an illegal combination of arguments is supplied