com.jscape.inet.sftp.packets
Class SshFxpRead

java.lang.Object
  com.jscape.inet.sftp.SftpPacket
      com.jscape.inet.sftp.packets.SshFxpRead

All Implemented Interfaces:

Dispatchable

public class SshFxpRead
extends SftpPacket
implements Dispatchable

The SSH_FXP_READ packet.

Version:

1.0

Author:

Alex Usun

Field Summary

static int

TYPE The SFTP packet type

Constructor Summary

SshFxpRead(byte[] handle, long offset, int len)
Creates a new packet instance.

SshFxpRead(long id, byte[] handle, long offset, int len)
Creates a new packet instance.

Method Summary

SftpPacket	accept(PacketDispatcher dispatcher) The "backwards dispatching" support.
byte[]	getHandle() Obtains the file handle.
int	getLen() Obtains the length to read.
long	getOffset() Obtains the file offset.
static SftpPacket	readFrom(java.io.InputStream in, java.lang.String charset) Reads the packet from the stream.
java.lang.String	toString() Provides the human-readable packet representation.
void	writeTo(java.io.OutputStream out, java.lang.String charset) Writes the current packet to the specified stream.

Methods inherited from class com.jscape.inet.sftp.SftpPacket

getId, getType, readFrom, readFrom, setId, writeTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final int TYPE

The SFTP packet type

See Also:

Constant Field Values

Constructor Detail

SshFxpRead

public SshFxpRead(long id,
                  byte[] handle,
                  long offset,
                  int len)

Creates a new packet instance.

Parameters:

id - the packet #

handle - the file handle

offset - the reading offset

len - the number of bytes to read

SshFxpRead

public SshFxpRead(byte[] handle,
                  long offset,
                  int len)

Creates a new packet instance.

Parameters:

handle - the file handle

offset - the reading offset

len - the number of bytes to read

Method Detail

readFrom

public static SftpPacket readFrom(java.io.InputStream in,
                                  java.lang.String charset)
                           throws java.io.IOException

Reads the packet from the stream.

Parameters:

in - the source input stream

Returns:

the readed packet

Throws:

java.io.IOException - if an I/O error occurs

getHandle

public byte[] getHandle()

Obtains the file handle.

Returns:

the file handle

getOffset

public long getOffset()

Obtains the file offset.

Returns:

the file offset

getLen

public int getLen()

Obtains the length to read.

Returns:

the length to read.

writeTo

public void writeTo(java.io.OutputStream out,
                    java.lang.String charset)
             throws java.io.IOException

Writes the current packet to the specified stream.

Overrides:

writeTo in class SftpPacket

Parameters:

out - the output stream

Throws:

java.io.IOException - if I/O error occured

accept

public SftpPacket accept(PacketDispatcher dispatcher)
                  throws java.io.IOException

The "backwards dispatching" support.

Specified by:

accept in interface Dispatchable

Parameters:

dispatcher - the packet dispatcher

Returns:

the response

Throws:

java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()

Provides the human-readable packet representation.

Overrides:

toString in class java.lang.Object

Returns:

the human-readable packet representation.