com.emc.ecs.nfsclient.nfs

Class NfsReadRequest

java.lang.Object

com.emc.ecs.nfsclient.rpc.RpcRequest

com.emc.ecs.nfsclient.nfs.NfsRequestBase

com.emc.ecs.nfsclient.nfs.NfsReadRequest

All Implemented Interfaces:

NfsRequest

Direct Known Subclasses:

Nfs3ReadRequest

public class NfsReadRequest
extends NfsRequestBase

The request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).

Procedure READ reads data from a file.

Field Summary

Fields inherited from class com.emc.ecs.nfsclient.rpc.RpcRequest

CHARSET

Constructor Summary

Constructors

Constructor and Description
NfsReadRequest(byte[] fileHandle, long offset, int size, Credential credential, int nfsVersion) Creates the request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).

Method Summary

Modifier and Type	Method and Description
void	marshalling(Xdr xdr) Transfer data to an Xdr object for RPC use.
java.lang.String	toString()

Methods inherited from class com.emc.ecs.nfsclient.nfs.NfsRequestBase

getErrorMessage, getFileHandle, getIpKey, startToString

Methods inherited from class com.emc.ecs.nfsclient.rpc.RpcRequest

cloneFileHandle, isUsePrivilegedPort, setUsePrivilegedPort, trimFileName

Methods inherited from class java.lang.Object

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

Constructor Detail

NfsReadRequest

public NfsReadRequest(byte[] fileHandle,
                      long offset,
                      int size,
                      Credential credential,
                      int nfsVersion)
               throws java.io.FileNotFoundException

Creates the request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).

Procedure READ reads data from a file.

Parameters:

fileHandle - The file handle of the file from which data is to be read. This must identify a file system object of type, NF3REG.

offset - The position within the file at which the read is to begin. An offset of 0 means to read data starting at the beginning of the file. If offset is greater than or equal to the size of the file, the status, NFS3_OK, is returned with size set to 0 and eof set to true, subject to access permissions checking.

size - The number of bytes of data that are to be read. If size is 0, the READ will succeed and return 0 bytes of data, subject to access permissions checking. size must be less than or equal to the value of the rtmax field in the FSINFO reply structure for the file system that contains file. If greater, the server may return only rtmax bytes, resulting in a short read.

credential - The credential used for RPC authentication.

nfsVersion - The NFS version number

Throws:

java.io.FileNotFoundException

Method Detail

marshalling

public void marshalling(Xdr xdr)

Description copied from interface: NfsRequest

Transfer data to an Xdr object for RPC use. The format is specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).

Specified by:

marshalling in interface NfsRequest

Overrides:

marshalling in class NfsRequestBase

Parameters:

xdr - the Xdr to be sent.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object