Package org.apache.sshd.sftp.client.impl

Class SftpOutputStreamAsync

java.lang.Object

java.io.OutputStream

org.apache.sshd.common.util.io.output.OutputStreamWithChannel

org.apache.sshd.sftp.client.impl.SftpOutputStreamAsync

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Channel, SftpClientHolder

public class SftpOutputStreamAsync
extends org.apache.sshd.common.util.io.output.OutputStreamWithChannel
implements SftpClientHolder

Implements an output stream for a given remote file

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	bb
protected org.apache.sshd.common.util.buffer.Buffer	buffer
protected int	bufferSize
protected SftpClient.CloseableHandle	handle
protected org.slf4j.Logger	log
protected long	offset
protected Deque<SftpAckData>	pendingWrites

Constructor Summary

Constructors

Constructor	Description
SftpOutputStreamAsync(AbstractSftpClient client, int bufferSize, String path, Collection<SftpClient.OpenMode> mode)
SftpOutputStreamAsync(AbstractSftpClient client, int bufferSize, String path, SftpClient.CloseableHandle handle)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
AbstractSftpClient	getClient()
String	getPath()	The remotely accessed file path
boolean	isOpen()
void	setOffset(long offset)
String	toString()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

bb

protected final byte[] bb

bufferSize

protected final int bufferSize

buffer

protected org.apache.sshd.common.util.buffer.Buffer buffer

handle

protected SftpClient.CloseableHandle handle

offset

protected long offset

pendingWrites

protected final Deque<SftpAckData> pendingWrites

Constructor Detail

SftpOutputStreamAsync

public SftpOutputStreamAsync(AbstractSftpClient client,
                             int bufferSize,
                             String path,
                             Collection<SftpClient.OpenMode> mode)
                      throws IOException

Throws:

IOException

SftpOutputStreamAsync

public SftpOutputStreamAsync(AbstractSftpClient client,
                             int bufferSize,
                             String path,
                             SftpClient.CloseableHandle handle)
                      throws IOException

Throws:

IOException

Method Detail

getClient

public final AbstractSftpClient getClient()

Specified by:

getClient in interface SftpClientHolder

setOffset

public void setOffset(long offset)

getPath

public final String getPath()

The remotely accessed file path

Returns:

Remote file path

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object