net.scharlie.lj4l.core.io.remote.sftp

Class SftpOutputStream

java.lang.Object

java.io.OutputStream

net.scharlie.lj4l.core.io.remote.sftp.SftpOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ConnectedTestable

public final class SftpOutputStream
extends OutputStream
implements ConnectedTestable

This class implements a SFTP output stream.

Instances of this class are not safe for use by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SftpOutputStream.WriteMode File transfer mode.

Constructor Summary

Constructors

Constructor and Description
SftpOutputStream(SftpChannel channel, String path) Create a new SFTP output stream in OVERWRITE mode.
SftpOutputStream(SftpChannel channel, String path, SftpOutputStream.WriteMode mode) Create a new SFTP output stream.
SftpOutputStream(SftpChannel channel, String path, SftpOutputStream.WriteMode mode, long offset) Create a new SFTP output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
boolean	isConnected() Answer whether this object is currently connected.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SftpOutputStream

public SftpOutputStream(SftpChannel channel,
                        String path)
                 throws NotConnectedException

Create a new SFTP output stream in OVERWRITE mode.

Parameters:

channel - The SFTP channel

path - The file path

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - in case of being not connected

SftpOutputStream

public SftpOutputStream(SftpChannel channel,
                        String path,
                        SftpOutputStream.WriteMode mode)
                 throws NotConnectedException

Create a new SFTP output stream.

Parameters:

channel - The SFTP channel

path - The file path

mode - The write mode (OVERWRITE, RESUME or APPEND)

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - in case of being not connected

SftpOutputStream

public SftpOutputStream(SftpChannel channel,
                        String path,
                        SftpOutputStream.WriteMode mode,
                        long offset)
                 throws NotConnectedException

Create a new SFTP output stream.

Parameters:

channel - The SFTP channel

path - The file path

mode - The write mode (OVERWRITE, RESUME or APPEND)

offset - The data will be added at offset

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - in case of being not connected

Method Detail

isConnected

public boolean isConnected()

Description copied from interface: ConnectedTestable

Answer whether this object is currently connected.

Specified by:

isConnected in interface ConnectedTestable

Returns:

answer

write

public final void write(int b)

Specified by:

write in class OutputStream

write

public final void write(byte[] b)

Overrides:

write in class OutputStream

write

public final void write(byte[] b,
                        int off,
                        int len)

Overrides:

write in class OutputStream

flush

public final void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream