Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.impl.SftpOutputStreamAsync

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

Modifier and Type	Field and 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 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

Access	Constructor and Description
public	SftpOutputStreamAsync(AbstractSftpClient `AbstractSftpClient` to use for writing data client, int 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. bufferSize, String remote path to write to path, Collection<SftpClient.OpenMode> `OpenMode`s for opening the file. mode) Creates a new stream to write data to a remote file.
public	SftpOutputStreamAsync(AbstractSftpClient `AbstractSftpClient` to use for writing data client, int 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. bufferSize, String path, SftpClient.CloseableHandle `CloseableHandle` of the remote file to write to; will be closed when this output stream is closed handle) Creates a new stream to write data to a remote file.
public	SftpOutputStreamAsync(AbstractSftpClient `AbstractSftpClient` to use for writing data client, int 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. bufferSize, String path, SftpClient.CloseableHandle `CloseableHandle` of the remote file to write to handle, boolean whether to close the `handle` when this output stream is closed closeHandle) Creates a new stream to write data to a remote file.

Method Summary

Modifier and Type	Method and Description
private void	checkStatus(AbstractSftpClient client, Buffer buf)
public void	close() Overrides java.io.OutputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Closes this channel.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
private Buffer	getBuffer(Session session)
public final AbstractSftpClient	getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.
public final String	Returns: Remote file path getPath() The remotely accessed file path
private void	internalFlush()
private long	internalTransfer(SftpOutputStreamAsync.ByteInput stream, boolean forceFlush)
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public void	setOffset(long offset)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public long	transferFrom(InputStream stream)
public long	transferFrom(ReadableByteChannel stream, long count)
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Field Detail

bb	back to summary
protected final byte[] bb

buffer	back to summary
protected Buffer buffer

bufferPool	back to summary
private final Buffer[] bufferPool

bufferSize	back to summary
protected final int bufferSize

clientInstance	back to summary
private final AbstractSftpClient clientInstance

handle	back to summary
protected SftpClient.CloseableHandle handle

handleId	back to summary
private final byte[] handleId

lastMsg	back to summary
private SftpMessage lastMsg

log	back to summary
protected final Logger log

nextBuffer	back to summary
private int nextBuffer

offset	back to summary
protected long offset

ownsHandle	back to summary
private final boolean ownsHandle

packetSize	back to summary
private final int packetSize

path	back to summary
private final String path

pendingAcks	back to summary
protected final Deque<SftpAckData> pendingAcks

sftpPreamble	back to summary
private final int sftpPreamble

usePacket	back to summary
private final boolean usePacket

Constructor Detail

SftpOutputStreamAsync back to summary

SftpOutputStreamAsync	back to summary
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 `AbstractSftpClient` to use for writing data bufferSize:int 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:String remote path to write to mode:Collection<SftpClient.OpenMode> `OpenMode`s for opening the file. Exceptions IOException: if the remote file cannot be opened

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: AbstractSftpClient to use for writing data
bufferSize:int: 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:String: remote path to write to
mode:Collection<SftpClient.OpenMode>: OpenModes for opening the file.

Exceptions

IOException:: if the remote file cannot be opened

SftpOutputStreamAsync back to summary

SftpOutputStreamAsync	back to summary
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 `AbstractSftpClient` to use for writing data bufferSize:int 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 `CloseableHandle` of the remote file to write to; will be closed when this output stream is closed

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: AbstractSftpClient to use for writing data
bufferSize:int: 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: CloseableHandle of the remote file to write to; will be closed when this output stream is closed

SftpOutputStreamAsync back to summary

SftpOutputStreamAsync	back to summary
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 `AbstractSftpClient` to use for writing data bufferSize:int 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 `CloseableHandle` of the remote file to write to closeHandle:boolean whether to close the `handle` when this output stream is closed

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: AbstractSftpClient to use for writing data
bufferSize:int: 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: CloseableHandle of the remote file to write to
closeHandle:boolean: whether to close the handle when this output stream is closed

Method Detail

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

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.nio.channels.Channel.close, java.io.Closeable.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.nio.channels.Channel.close, java.io.Closeable.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getBuffer	back to summary
private Buffer getBuffer(Session session)

getClient	back to summary
public final AbstractSftpClient getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient. Annotations @Override

getClient

back to summary

public final AbstractSftpClient getClient()

Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.

Annotations

@Override

getPath	back to summary
public final String getPath() The remotely accessed file path Returns:String Remote file path

getPath

back to summary

public final String getPath()

The remotely accessed file path

Returns:String: Remote file path

internalFlush	back to summary
private void internalFlush() throws IOException

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

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

setOffset	back to summary
public void setOffset(long offset)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

transferFrom	back to summary
public long transferFrom(InputStream stream) throws IOException

transferFrom	back to summary
public long transferFrom(ReadableByteChannel stream, long count) throws IOException

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

public Class SftpOutputStreamAsync

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface SftpOutputStreamAsync.ByteInput

Method Summary

Method Detail

private Class SftpOutputStreamAsync.ChannelReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail