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 OutputStreamWithChannel
implements SftpClientHolder

Implements an output stream for a given remote file

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	SftpOutputStreamAsync.ByteInput
private static class	SftpOutputStreamAsync.ChannelReader

Field Summary

Fields

Modifier and Type	Field	Description
protected final byte[]	bb
protected Buffer	buffer
private final Buffer[]	bufferPool
protected final int	bufferSize
private final AbstractSftpClient	clientInstance
protected SftpClient.CloseableHandle	handle
private final byte[]	handleId
private SftpMessage	lastMsg
protected final org.slf4j.Logger	log
private int	nextBuffer
protected long	offset
private final boolean	ownsHandle
private final int	packetSize
private final String	path
protected final Deque<SftpAckData>	pendingAcks
private final int	sftpPreamble
private final boolean	usePacket

Constructor Summary

Constructors

Constructor	Description
SftpOutputStreamAsync(AbstractSftpClient client, int bufferSize, String path, Collection<SftpClient.OpenMode> mode)	Creates a new stream to write data to a remote file.
SftpOutputStreamAsync(AbstractSftpClient client, int bufferSize, String path, SftpClient.CloseableHandle handle)	Creates a new stream to write data to a remote file.
SftpOutputStreamAsync(AbstractSftpClient client, int bufferSize, String path, SftpClient.CloseableHandle handle, boolean closeHandle)	Creates a new stream to write data to a remote file.

Method Summary

Modifier and Type	Method	Description
private void	checkStatus(AbstractSftpClient client, Buffer buf)
void	close()
void	flush()
private Buffer	getBuffer(Session session)
final AbstractSftpClient	getClient()
final String	getPath()	The remotely accessed file path
private void	internalFlush()
private long	internalTransfer(SftpOutputStreamAsync.ByteInput stream, boolean forceFlush)
boolean	isOpen()
void	setOffset(long offset)
String	toString()
long	transferFrom(InputStream stream)
long	transferFrom(ReadableByteChannel stream, long count)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class OutputStream

write

Methods inherited from class Object

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

Field Details

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

pendingAcks

protected final Deque<SftpAckData> pendingAcks

clientInstance

private final AbstractSftpClient clientInstance

path

private final String path

handleId

private final byte[] handleId

ownsHandle

private final boolean ownsHandle

bufferPool

private final Buffer[] bufferPool

packetSize

private final int packetSize

sftpPreamble

private final int sftpPreamble

usePacket

private final boolean usePacket

nextBuffer

private int nextBuffer

lastMsg

private SftpMessage lastMsg

Constructor Details

SftpOutputStreamAsync

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

Creates a new stream to write data to a remote file.

Parameters:

client - AbstractSftpClient to use for writing data

bufferSize - SFTP packet length to use. Most servers have a limit of 256kB. If zero, the stream picks a size such that each SFTP packet fits into a single SSH packet, i.e., roughly 32kB.

path - remote path to write to

mode - SftpClient.OpenModes for opening the file.

Throws:

IOException - if the remote file cannot be opened

SftpOutputStreamAsync

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

Creates a new stream to write data to a remote file.

Parameters:

client - AbstractSftpClient to use for writing data

bufferSize - SFTP packet length to use. Most servers have a limit of 256kB. If zero, the stream picks a size such that each SFTP packet fits into a single SSH packet, i.e., roughly 32kB.

handle - SftpClient.CloseableHandle of the remote file to write to; will be closed when this output stream is closed

SftpOutputStreamAsync

public SftpOutputStreamAsync(AbstractSftpClient client,
 int bufferSize,
 String path,
 SftpClient.CloseableHandle handle,
 boolean closeHandle)

Creates a new stream to write data to a remote file.

Parameters:

client - AbstractSftpClient to use for writing data

bufferSize - SFTP packet length to use. Most servers have a limit of 256kB. If zero, the stream picks a size such that each SFTP packet fits into a single SSH packet, i.e., roughly 32kB.

handle - SftpClient.CloseableHandle of the remote file to write to

closeHandle - whether to close the handle when this output stream is closed

Method Details

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

transferFrom

public long transferFrom(InputStream stream)
                  throws IOException

Throws:

IOException

transferFrom

public long transferFrom(ReadableByteChannel stream,
 long count)
                  throws IOException

Throws:

IOException

getBuffer

private Buffer getBuffer(Session session)

internalTransfer

private long internalTransfer(SftpOutputStreamAsync.ByteInput stream,
 boolean forceFlush)
                       throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

internalFlush

private void internalFlush()
                    throws IOException

Throws:

IOException

checkStatus

private void checkStatus(AbstractSftpClient client,
 Buffer buf)
                  throws IOException

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