com.emc.ecs.nfsclient.nfs

Class NfsResponseBase

java.lang.Object

com.emc.ecs.nfsclient.rpc.RpcResponse

com.emc.ecs.nfsclient.nfs.NfsResponseBase

Direct Known Subclasses:

NfsAccessResponse, NfsCommitResponse, NfsCreateResponse, NfsFsInfoResponse, NfsFsStatResponse, NfsGetAttrResponse, NfsLinkResponse, NfsLookupResponse, NfsMkdirResponse, NfsMknodResponse, NfsPathconfResponse, NfsReaddirplusResponse, NfsReaddirResponse, NfsReadlinkResponse, NfsReadResponse, NfsRemoveResponse, NfsRenameResponse, NfsRmdirResponse, NfsSetAttrResponse, NfsSymlinkResponse, NfsWriteResponse

public abstract class NfsResponseBase
extends RpcResponse

The base class for all NFS responses specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).

Field Summary

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

_xid

Constructor Summary

Constructors

Constructor and Description
NfsResponseBase() Create the base class object.

Method Summary

Modifier and Type	Method and Description
NfsGetAttributes	getAttributes()
byte[]	getFileHandle()
int	getState()
protected static NfsGetAttributes	makeNfsGetAttributes(Xdr xdr) Create the object if it is there, return null if it is not.
protected static NfsGetAttributes	makeNfsGetAttributes(Xdr xdr, boolean force) Create the object if it is there, or skip the existence check if force is true.
boolean	stateIsOk() Check the state returned in the response.
java.lang.String	toString()
void	unmarshalling(Xdr xdr) Load this structure from the response data, as specified by RFC 1831 (https://tools.ietf.org/html/rfc1831).
protected void	unmarshallingAttributes(Xdr xdr) Unmarshall the object if it is there.
protected void	unmarshallingAttributes(Xdr xdr, boolean force) Unmarshall the object if it is there, or skip the existence check if force is true.
protected void	unmarshallingFileHandle(Xdr xdr) Unmarshall the object if it is there.
protected void	unmarshallingFileHandle(Xdr xdr, boolean force) Unmarshall the object if it is there, or skip the existence check if force is true.

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

getAcceptStatus, getDirection, getRejectStatus, getReplyStatus, getXid

Methods inherited from class java.lang.Object

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

Constructor Detail

NfsResponseBase

public NfsResponseBase()

Create the base class object.

Method Detail

unmarshalling

public void unmarshalling(Xdr xdr)
                   throws RpcException

Description copied from class: RpcResponse

Load this structure from the response data, as specified by RFC 1831 (https://tools.ietf.org/html/rfc1831).

Overrides:

unmarshalling in class RpcResponse

Parameters:

xdr - The xdr response data.

Throws:

RpcException

getState

public int getState()

Returns:

The state returned in the response. For details, see RFC 1813 (https://tools.ietf.org/html/rfc1813).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAttributes

public final NfsGetAttributes getAttributes()

Returns:

File system object post-operation attributes. These are provided for many calls. For information on the object to which the attributes refer, or for other details, see RFC 1813 (https://tools.ietf.org/html/rfc1813).

getFileHandle

public final byte[] getFileHandle()

Returns:

The file handle for the system object that was created for a successful CREATE, MKDIR, MKNOD, or SYMLINK request, or looked up for a LOOKUP request. This is null for all other requests, and also for failed requests.

stateIsOk

public boolean stateIsOk()

Check the state returned in the response. For details, see RFC 1813 (https://tools.ietf.org/html/rfc1813).

Returns:

true if the state is NFS3_OK, false otherwise

unmarshallingAttributes

protected void unmarshallingAttributes(Xdr xdr)

Unmarshall the object if it is there. Convenience method for use in subclasses.

Parameters:

xdr -

unmarshallingAttributes

protected void unmarshallingAttributes(Xdr xdr,
                                       boolean force)

Unmarshall the object if it is there, or skip the existence check if force is true. Convenience method for use in subclasses.

Parameters:

xdr -

force - do not check whether it is there

unmarshallingFileHandle

protected void unmarshallingFileHandle(Xdr xdr)

Unmarshall the object if it is there. Convenience method for use in subclasses.

Parameters:

xdr -

unmarshallingFileHandle

protected void unmarshallingFileHandle(Xdr xdr,
                                       boolean force)

Unmarshall the object if it is there, or skip the existence check if force is true. Convenience method for use in subclasses.

Parameters:

xdr -

force -

makeNfsGetAttributes

protected static NfsGetAttributes makeNfsGetAttributes(Xdr xdr)

Create the object if it is there, return null if it is not. Convenience method for use in subclasses.

Parameters:

xdr -

Returns:

the created object or null

makeNfsGetAttributes

protected static NfsGetAttributes makeNfsGetAttributes(Xdr xdr,
                                                       boolean force)

Create the object if it is there, or skip the existence check if force is true. Convenience method for use in subclasses.

Parameters:

xdr -

force - do not check whether it is there

Returns:

the created object