org.springframework.integration.file.remote.session

Interface Session<T>

All Known Implementing Classes:

CachingSessionFactory.CachedSession, FtpSession

public interface Session<T>

Common abstraction for a Session with a remote File system.

Since:

2.0

Author:

Josh Long, Mario Gray, Mark Fisher, Oleg Zhurakousky, Gary Russell

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	exists(java.lang.String path)
boolean	finalizeRaw() Invoke after closing the InputStream from readRaw(String).
boolean	isOpen()
T[]	list(java.lang.String path)
java.lang.String[]	listNames(java.lang.String path)
boolean	mkdir(java.lang.String directory)
void	read(java.lang.String source, java.io.OutputStream outputStream)
java.io.InputStream	readRaw(java.lang.String source) Retrieve a remote file as a raw InputStream.
boolean	remove(java.lang.String path)
void	rename(java.lang.String pathFrom, java.lang.String pathTo)
void	write(java.io.InputStream inputStream, java.lang.String destination)

Method Detail

remove

boolean remove(java.lang.String path)
               throws java.io.IOException

Throws:

java.io.IOException

list

T[] list(java.lang.String path)
         throws java.io.IOException

Throws:

java.io.IOException

read

void read(java.lang.String source,
        java.io.OutputStream outputStream)
          throws java.io.IOException

Throws:

java.io.IOException

write

void write(java.io.InputStream inputStream,
         java.lang.String destination)
           throws java.io.IOException

Throws:

java.io.IOException

mkdir

boolean mkdir(java.lang.String directory)
              throws java.io.IOException

Throws:

java.io.IOException

rename

void rename(java.lang.String pathFrom,
          java.lang.String pathTo)
            throws java.io.IOException

Throws:

java.io.IOException

close

void close()

isOpen

boolean isOpen()

exists

boolean exists(java.lang.String path)
               throws java.io.IOException

Throws:

java.io.IOException

listNames

java.lang.String[] listNames(java.lang.String path)
                             throws java.io.IOException

Throws:

java.io.IOException

readRaw

java.io.InputStream readRaw(java.lang.String source)
                            throws java.io.IOException

Retrieve a remote file as a raw InputStream.

Parameters:

source - The path of the remote file

Returns:

The raw inputStream.

Throws:

java.io.IOException

finalizeRaw

boolean finalizeRaw()
                    throws java.io.IOException

Invoke after closing the InputStream from readRaw(String). Required by some session providers.

Returns:

true if successful.

Throws:

java.io.IOException