Class NfsAccessRequest

java.lang.Object

com.emc.ecs.nfsclient.rpc.RpcRequest

com.emc.ecs.nfsclient.nfs.NfsRequestBase

com.emc.ecs.nfsclient.nfs.NfsAccessRequest

All Implemented Interfaces:

NfsRequest

Direct Known Subclasses:

Nfs3AccessRequest

public class NfsAccessRequest
extends NfsRequestBase

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

Procedure ACCESS determines the access rights that a user, as identified by the credentials in the request, has with respect to a file system object. The client encodes the set of permissions that are to be checked in a bit mask. The server checks the permissions encoded in the bit mask. A status of NFS3_OK is returned along with a bit mask encoded with the permissions that the client is allowed.

The results of this procedure are necessarily advisory in nature. That is, a return status of NFS3_OK and the appropriate bit set in the bit mask does not imply that such access will be allowed to the file system object in the future, as access rights can be revoked by the server at any time.

Field Summary

Fields inherited from class RpcRequest

CHARSET

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	marshalling(Xdr xdr)	Writes the RPC call header and authentication credentials to the XDR buffer.
String	toString()

Methods inherited from class NfsRequestBase

getErrorMessage, getFileHandle, getIpKey, startToString

Methods inherited from class RpcRequest

cloneFileHandle, isUsePrivilegedPort, setUsePrivilegedPort, trimFileName

Methods inherited from class Object

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

Constructor Details

NfsAccessRequest

public NfsAccessRequest(byte[] fileHandle,
 long accessToCheck,
 Credential credential,
 int nfsVersion)
                 throws FileNotFoundException

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

Procedure ACCESS determines the access rights that a user, as identified by the credentials in the request, has with respect to a file system object. The client encodes the set of permissions that are to be checked in a bit mask. The server checks the permissions encoded in the bit mask. A status of NFS3_OK is returned along with a bit mask encoded with the permissions that the client is allowed.

The results of this procedure are necessarily advisory in nature. That is, a return status of NFS3_OK and the appropriate bit set in the bit mask does not imply that such access will be allowed to the file system object in the future, as access rights can be revoked by the server at any time.

Parameters:

fileHandle - The file handle for the file system object to which access is to be checked.

accessToCheck - A bit mask of access permissions to check, as specified below.

ACCESS3_READ    = 0x0001 - Read data from file or read a directory.
ACCESS3_LOOKUP  = 0x0002 - Look up a name in a directory (no meaning for non-directory objects).
ACCESS3_MODIFY  = 0x0004 - Rewrite existing file data or modify existing directory entries.
ACCESS3_EXTEND  = 0x0008 - Write new data or add directory entries.
ACCESS3_DELETE  = 0x0010 - Delete an existing directory entry.
ACCESS3_EXECUTE = 0x0020 - Execute file (no meaning for a directory).
           

credential - The credential used for RPC authentication.

nfsVersion - The NFS version number

Throws:

FileNotFoundException

Method Details

marshalling

public void marshalling(Xdr xdr)

Writes the RPC call header and authentication credentials to the XDR buffer.

Specified by:

marshalling in interface NfsRequest

Overrides:

marshalling in class NfsRequestBase

Parameters:

xdr - the Xdr to be sent.

toString

public String toString()

Overrides:

toString in class Object