org.springframework.integration.file.remote

Interface RemoteFileOperations<F>

All Known Implementing Classes:

RemoteFileTemplate

public interface RemoteFileOperations<F>

Strategy for performing operations on remote files.

Since:

3.0

Author:

Gary Russell

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	execute(SessionCallback<F,T> callback) Execute the callback's doInSession method after obtaining a session.
boolean	get(Message<?> message, InputStreamCallback callback) Retrieve a remote file as an InputStream, based on information in a message.
boolean	get(String remotePath, InputStreamCallback callback) Retrieve a remote file as an InputStream.
boolean	remove(String path) Remove a remote file.
void	rename(String fromPath, String toPath) Rename a remote file, creating directories if needed.
String	send(Message<?> message) Send a file to a remote server, based on information in a message.
String	send(Message<?> message, String subDirectory) Send a file to a remote server, based on information in a message.

Method Detail

send

String send(Message<?> message)

Send a file to a remote server, based on information in a message.

Parameters:

message - The message.

Returns:

The remote path, or null if no local file was found.

send

String send(Message<?> message,
          String subDirectory)

Send a file to a remote server, based on information in a message. The subDirectory is appended to the remote directory evaluated from the message.

Parameters:

message - The message.

subDirectory - The sub directory.

Returns:

The remote path, or null if no local file was found.

get

boolean get(String remotePath,
          InputStreamCallback callback)

Retrieve a remote file as an InputStream.

Parameters:

remotePath - The remote path to the file.

callback - the callback.

Returns:

true if the operation was successful.

get

boolean get(Message<?> message,
          InputStreamCallback callback)

Retrieve a remote file as an InputStream, based on information in a message.

Parameters:

message - The message which will be evaluated to generate the remote path.

callback - the callback.

Returns:

true if the operation was successful.

remove

boolean remove(String path)

Remove a remote file.

Parameters:

path - The full path to the file.

Returns:

true when successful

rename

void rename(String fromPath,
          String toPath)

Rename a remote file, creating directories if needed.

Parameters:

fromPath - The current path.

toPath - The new path.

execute

<T> T execute(SessionCallback<F,T> callback)

Execute the callback's doInSession method after obtaining a session. Reliably closes the session when the method exits.

Type Parameters:

T - The type returned by SessionCallback.doInSession(org.springframework.integration.file.remote.session.Session).

Parameters:

callback - the SessionCallback.

Returns:

The result of the callback method.