org.apache.sshd.client.subsystem.sftp.impl

Class SftpOutputStreamAsync

java.lang.Object

java.io.OutputStream

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

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

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.nio.channels.Channel

public class SftpOutputStreamAsync
extends OutputStreamWithChannel

Implements an output stream for a given remote file

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	bb
protected Buffer	buffer
protected int	bufferSize
private AbstractSftpClient	clientInstance
protected SftpClient.CloseableHandle	handle
protected org.slf4j.Logger	log
protected long	offset
private java.lang.String	path
protected java.util.Deque<SftpAckData>	pendingWrites

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.io.OutputStream

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 Buffer buffer

handle

protected SftpClient.CloseableHandle handle

offset

protected long offset

pendingWrites

protected final java.util.Deque<SftpAckData> pendingWrites

clientInstance

private final AbstractSftpClient clientInstance

path

private final java.lang.String path

Constructor Detail

SftpOutputStreamAsync

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

Throws:

java.io.IOException

SftpOutputStreamAsync

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

Throws:

java.io.IOException

Method Detail

getClient

public final AbstractSftpClient getClient()

The client instance

Returns:

SftpClient instance used to access the remote file

setOffset

public void setOffset(long offset)

getPath

public final java.lang.String getPath()

The remotely accessed file path

Returns:

Remote file path

isOpen

public boolean isOpen()

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object