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

Interface ReadCommand

public interface ReadCommand

Command design pattern for reading files

Since:

1.0

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes>	read(FileConnectorConfig config, String filePath, org.mule.runtime.api.metadata.MediaType mediaType, boolean lock) Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, MediaType, boolean)

Method Detail

read

org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes> read(FileConnectorConfig config,
                                                                                         String filePath,
                                                                                         org.mule.runtime.api.metadata.MediaType mediaType,
                                                                                         boolean lock)

Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, MediaType, boolean)

Parameters:

config - the config that is parameterizing this operation

filePath - the path of the file you want to read

lock - whether or not to lock the file

Returns:

An Result with an InputStream with the file's content as payload and a FileAttributes object as Message.getAttributes()

Throws:

IllegalArgumentException - if the file at the given path doesn't exists