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

Interface ReadCommand<A extends FileAttributes>

public interface ReadCommand<A extends FileAttributes>

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,A>	read(FileConnectorConfig config, String filePath, boolean lock) Deprecated.
default org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A>	read(FileConnectorConfig config, String filePath, boolean lock, Long timeBetweenSizeCheck) Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, boolean)

Method Detail

read

@Deprecated
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A> read(FileConnectorConfig config,
                                                                                        String filePath,
                                                                                        boolean lock)

Deprecated.

Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, 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 exist

read

default org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A> read(FileConnectorConfig config,
                                                                                    String filePath,
                                                                                    boolean lock,
                                                                                    Long timeBetweenSizeCheck)

Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, 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

timeBetweenSizeCheck - wait time between size checks to determine if a file is ready to be read in milliseconds.

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 exist