com.emc.ecs.nfsclient.rpc

Class RpcRequest

java.lang.Object

com.emc.ecs.nfsclient.rpc.RpcRequest

Direct Known Subclasses:

GetPortRequest, MountRequest, NfsRequestBase, UnmountRequest

public abstract class RpcRequest
extends java.lang.Object

An RPC request, as specified by RFC 1831 (https://tools.ietf.org/html/rfc1831).

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CHARSET The default Internet charset.

Constructor Summary

Constructors

Constructor and Description
RpcRequest(int serviceProgram, int serviceVersion, int serviceProcedure, Credential credential) Create the request, as specified by RFC 1831 (https://tools.ietf.org/html/rfc1831).

Method Summary

Modifier and Type	Method and Description
protected static byte[]	cloneFileHandle(byte[] fileHandle) Utility function for cloning file handles.
abstract java.lang.String	getErrorMessage()
boolean	isUsePrivilegedPort()
void	marshalling(Xdr xdr)
void	setUsePrivilegedPort(boolean usePrivilegedPort) Set the flag.
protected java.lang.StringBuilder	startToString(java.lang.String requestLabel) Start a StringBuilder for use in toString() (for logging).
protected static java.lang.String	trimFileName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final java.nio.charset.Charset CHARSET

The default Internet charset.

Constructor Detail

RpcRequest

public RpcRequest(int serviceProgram,
                  int serviceVersion,
                  int serviceProcedure,
                  Credential credential)

Create the request, as specified by RFC 1831 (https://tools.ietf.org/html/rfc1831).

Parameters:

serviceProgram - The program number of the service.

serviceVersion - The version number of the service.

serviceProcedure - The service procedure number to be called.

credential - The authentication credential to be used for the call.

Method Detail

marshalling

public void marshalling(Xdr xdr)

isUsePrivilegedPort

public boolean isUsePrivilegedPort()

Returns:

• true if the client should use a privileged local port (below 1024).
• false if the client should use any available local port.

setUsePrivilegedPort

public void setUsePrivilegedPort(boolean usePrivilegedPort)

Set the flag.

Parameters:

usePrivilegedPort -

• true if the client should use a privileged local port (below 1024).
• false if the client should use any available local port.

startToString

protected java.lang.StringBuilder startToString(java.lang.String requestLabel)

Start a StringBuilder for use in toString() (for logging).

Parameters:

requestLabel -

Returns:

the builder

getErrorMessage

public abstract java.lang.String getErrorMessage()

Returns:

an appropriate error message

cloneFileHandle

protected static final byte[] cloneFileHandle(byte[] fileHandle)
                                       throws java.io.FileNotFoundException

Utility function for cloning file handles. These can never be null.

Parameters:

fileHandle - The file handle to clone.

Returns:

A clone if fileHandle is not null.

Throws:

java.io.FileNotFoundException - If the file handle is null.

trimFileName

protected static final java.lang.String trimFileName(java.lang.String name)
                                              throws java.lang.IllegalArgumentException

Parameters:

name - The file name to trim.

Returns:

The trimmed file name.

Throws:

java.lang.IllegalArgumentException - If the file name is blank.