RpcPacket (Alfresco JLan 5.0.a API)

java.lang.Object
- org.alfresco.jlan.oncrpc.RpcPacket

```
public class RpcPacket
extends Object
```
ONC/RPC Request/Response Packet Class

Author:

gkspencer

Field Summary

Fields
Modifier and Type Field and Description

static int FragHeaderLen

static int ResponseAuthFailLen

static int ResponseMismatchLen

Fields
Modifier and Type	Field and Description
`static int`	`FragHeaderLen`
`static int`	`ResponseAuthFailLen`
`static int`	`ResponseMismatchLen`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`RpcPacket()` Default constructor
	`RpcPacket(byte[] buf)` Class constructor
	`RpcPacket(byte[] buf, int offset, int len)` Class constructor
	`RpcPacket(int len)` Class constructor
`protected`	`RpcPacket(int len, RpcPacketPool owner)` Class constructor

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`alignPosition()` Align the buffer position on a longword/32bit boundary
`void`	`buildAcceptErrorResponse(int stsCode)` Build an RPC accept error response
`void`	`buildAuthFailResponse(int stsCode)` Build an RPC authentication failure response
`void`	`buildErrorResponse(int stsCode)` Build an error response packet where the RPC has been accepted but returns a status code in the parameter area.
`void`	`buildProgramMismatchResponse(int verLow, int verHigh)` Build a program mismatch error response
`void`	`buildRequestHeader(int progId, int verId, int procId, int credType, byte[] cred, int verfType, byte[] verf)` Build an RPC request header, and set the buffer pointer ready to stream data into the parameter area of the request
`void`	`buildResponseHeader()` Build a response header for a valid RPC response and set the buffer pointer ready to stream data into the parameter area of the response.
`void`	`buildRpcMismatchResponse()` Build an RPC version mismatch response
`int`	`getAcceptStatus()` Return the accept status for the RPC response
`int`	`getAuthFailStatus()` Return the authentication failure status
`int`	`getAvailableLength()` Return the available buffer size
`byte[]`	`getBuffer()` Return the buffer
`InetAddress`	`getClientAddress()` Return the client network address
`String`	`getClientDetails()` Return the client details as a string
`int`	`getClientPort()` Return the client port
`int`	`getClientProtocol()` Return the client protocol
`int`	`getCredentialsLength()` Return the credentials length
`int`	`getCredentialsType()` Return the credentials type
`int`	`getLength()` Return the used buffer length
`int`	`getMessageType()` Return the message type
`int`	`getMismatchVersionHigh()` Return the version mismatch high version
`int`	`getMismatchVersionLow()` Return the version mismatch low version
`int`	`getOffset()` Return the start of data offset
`RpcPacketPool`	`getOwnerPacketPool()` Return the packet pool that owns this packet
`RpcPacketHandler`	`getPacketHandler()` Return the packet handler interface used to send/receive a packet
`int`	`getPosition()` Return the current buffer position
`int`	`getProcedureId()` Return the procedure id
`int`	`getProcedureParameterLength()` Return the procedure parameters length
`int`	`getProcedureParameterOffset()` Return the procedure specific parameters offset
`int`	`getProgramId()` Return the program id
`int`	`getProgramVersion()` Return the program version
`int`	`getRejectStatus()` Return the reject reply status
`int`	`getReplyState()` Return the reply state
`int`	`getRpcVersion()` Return the RPC version
`int`	`getTxLength()` Return the RPC + fragment header length
`int`	`getVerifierLength()` Return the verifier length
`int`	`getVerifierOffset()` Return the buffer offset to the verifier
`int`	`getVerifierType()` Return the verifier type
`int`	`getXID()` Return the XID
`boolean`	`hasClientAddress()` Determine if the client address has been set
`boolean`	`hasPacketHandler()` Determine if the packet handler is valid
`boolean`	`hasSuccessStatus()` Check if the response has a success status
`boolean`	`isAllocatedFromPool()` Detemrine if the packet is allocated from a packet pool
`void`	`packByte(int bval)` Pack a byte value
`void`	`packByteArray(byte[] buf)` Pack a byte array
`void`	`packByteArrayWithLength(byte[] buf)` Pack a byte array with a length
`void`	`packInt(int ival)` Pack an integer value
`void`	`packIntArrayWithLength(int[] iarray)` Pack an integer array
`void`	`packLong(long lval)` Pack a long value
`void`	`packNulls(int len)` Pack nulls
`void`	`packPortMapping(PortMapping portMap)` Pack a port mapping structure
`void`	`packString(String str)` Pack a string
`void`	`packUTF8String(String str)` Pack a UTF-8 string
`void`	`positionAtCredentialsData()` Position the read pointer at the credentials data
`void`	`positionAtParameters()` Position the read pointer at the procedure specific parameters
`void`	`positionAtVerifierData()` Position the read pointer at the verifier data
`void`	`setAuthFailStatus(int authSts)` Set the authentication failure status
`void`	`setBuffer(byte[] buf, int offset, int len)` Reset the buffer details
`void`	`setBuffer(int offset, int len)` Reset the buffer details
`void`	`setClientDetails(InetAddress addr, int port, int protocol)` Set the client details
`void`	`setCredentialsLength(int credlen)` Set the credentials length
`void`	`setCredentialsType(int credtype)` Set the credentials type
`void`	`setLength()` Set the used buffer length
`void`	`setLength(int len)` Set the used buffer length
`void`	`setMessageType(int msgType)` Set the message type
`protected void`	`setOwnerPacketPool(RpcPacketPool pool)` Set the owner packet pool, if the packet was allocated from a pool
`void`	`setPacketHandler(RpcPacketHandler pktHandler)` Set the associated packet handler interface for the packet
`void`	`setPosition(int pos)` Set the buffer position
`void`	`setProcedureId(int procId)` Set the procedure id
`void`	`setProgramId(int progId)` Set the program id
`void`	`setProgramVersion(int progVer)` Set the program version
`void`	`setRejectStatus(int rejSts)` Set the reject status
`void`	`setReplyState(int replySts)` Set the reply state
`void`	`setRpcMismatch(int rpcLow, int rpcHigh)` Set the RPC mismatch values
`void`	`setRpcVersion(int rpcVer)` Set the RPC version
`void`	`setVerifierLength(int verflen)` Set the verifier length
`void`	`setVerifierType(int verftype)` Set the verifier type
`void`	`setXID(int xid)` Set the XID
`void`	`skipBytes(int cnt)` Skip a number of bytes in the buffer, rounded to the next int boundary
`String`	`toString()` Return the RPC packet as a string
`void`	`unpackByteArray(byte[] buf)` Unpack a byte array, using the buffer length
`void`	`unpackByteArrayWithLength(byte[] buf)` Unpack a byte array with a length
`int`	`unpackInt()` Unpack an integer value
`void`	`unpackIntArray(int[] buf)` Unpack an integer array, using the buffer length
`long`	`unpackLong()` Unpack a long value
`String`	`unpackString()` Unpack a string
`String`	`unpackUTF8String()` Unpack a UTF-8 string

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FragHeaderLen
```
public static final int FragHeaderLen
```
    See Also:
    Constant Field Values
  - ResponseMismatchLen
```
public static final int ResponseMismatchLen
```
    See Also:
    Constant Field Values
  - ResponseAuthFailLen
```
public static final int ResponseAuthFailLen
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RpcPacket
```
public RpcPacket()
```
    Default constructor
  - RpcPacket
```
public RpcPacket(int len)
```
    Class constructor
    
    Parameters:
    len - int
  - RpcPacket
```
protected RpcPacket(int len,
         RpcPacketPool owner)
```
    Class constructor
    
    Parameters:
    len - int
    owner - RpcPacketPool
  - RpcPacket
```
public RpcPacket(byte[] buf)
```
    Class constructor
    
    Parameters:
    buf - byte[]
  - RpcPacket
```
public RpcPacket(byte[] buf,
         int offset,
         int len)
```
    Class constructor
    
    Parameters:
    buf - byte[]
    offset - int
    len - int
- Method Detail
  - hasPacketHandler
```
public final boolean hasPacketHandler()
```
    Determine if the packet handler is valid
    
    Returns:
    boolean
  - getPacketHandler
```
public final RpcPacketHandler getPacketHandler()
```
    Return the packet handler interface used to send/receive a packet
    
    Returns:
    RpcPacketHandler
  - isAllocatedFromPool
```
public final boolean isAllocatedFromPool()
```
    Detemrine if the packet is allocated from a packet pool
    
    Returns:
    boolean
  - getOwnerPacketPool
```
public final RpcPacketPool getOwnerPacketPool()
```
    Return the packet pool that owns this packet
    
    Returns:
    RpcPacketPool
  - hasClientAddress
```
public final boolean hasClientAddress()
```
    Determine if the client address has been set
    
    Returns:
    boolean
  - getClientAddress
```
public final InetAddress getClientAddress()
```
    Return the client network address
    
    Returns:
    InetAddress
  - getClientPort
```
public final int getClientPort()
```
    Return the client port
    
    Returns:
    int
  - getClientProtocol
```
public final int getClientProtocol()
```
    Return the client protocol
    
    Returns:
    int
  - getClientDetails
```
public final String getClientDetails()
```
    Return the client details as a string
    
    Returns:
    String
  - getPosition
```
public final int getPosition()
```
    Return the current buffer position
    
    Returns:
    int
  - getBuffer
```
public final byte[] getBuffer()
```
    Return the buffer
    
    Returns:
    byte[]
  - getAvailableLength
```
public final int getAvailableLength()
```
    Return the available buffer size
    
    Returns:
    int
  - getLength
```
public final int getLength()
```
    Return the used buffer length
    
    Returns:
    int
  - getTxLength
```
public final int getTxLength()
```
    Return the RPC + fragment header length
    
    Returns:
    int
  - getOffset
```
public final int getOffset()
```
    Return the start of data offset
    
    Returns:
    int
  - getMessageType
```
public final int getMessageType()
```
    Return the message type
    
    Returns:
    int
  - getRpcVersion
```
public final int getRpcVersion()
```
    Return the RPC version
    
    Returns:
    int
  - getProgramId
```
public final int getProgramId()
```
    Return the program id
    
    Returns:
    int
  - getProgramVersion
```
public final int getProgramVersion()
```
    Return the program version
    
    Returns:
    int
  - getProcedureId
```
public final int getProcedureId()
```
    Return the procedure id
    
    Returns:
    int
  - getCredentialsType
```
public final int getCredentialsType()
```
    Return the credentials type
    
    Returns:
    int
  - getCredentialsLength
```
public final int getCredentialsLength()
```
    Return the credentials length
    
    Returns:
    int
  - getVerifierType
```
public final int getVerifierType()
```
    Return the verifier type
    
    Returns:
    int
  - getVerifierLength
```
public final int getVerifierLength()
```
    Return the verifier length
    
    Returns:
    int
  - getVerifierOffset
```
public final int getVerifierOffset()
```
    Return the buffer offset to the verifier
    
    Returns:
    int
  - getProcedureParameterOffset
```
public final int getProcedureParameterOffset()
```
    Return the procedure specific parameters offset
    
    Returns:
    int
  - getProcedureParameterLength
```
public final int getProcedureParameterLength()
```
    Return the procedure parameters length
    
    Returns:
    int
  - getXID
```
public final int getXID()
```
    Return the XID
    
    Returns:
    int
  - hasSuccessStatus
```
public final boolean hasSuccessStatus()
```
    Check if the response has a success status
    
    Returns:
    boolean
  - getReplyState
```
public final int getReplyState()
```
    Return the reply state
    
    Returns:
    int
  - getRejectStatus
```
public final int getRejectStatus()
```
    Return the reject reply status
    
    Returns:
    int
  - getMismatchVersionLow
```
public final int getMismatchVersionLow()
```
    Return the version mismatch low version
    
    Returns:
    int
  - getMismatchVersionHigh
```
public final int getMismatchVersionHigh()
```
    Return the version mismatch high version
    
    Returns:
    int
  - getAuthFailStatus
```
public final int getAuthFailStatus()
```
    Return the authentication failure status
    
    Returns:
    int
  - getAcceptStatus
```
public final int getAcceptStatus()
```
    Return the accept status for the RPC response
    
    Returns:
    int
  - alignPosition
```
protected final void alignPosition()
```
    Align the buffer position on a longword/32bit boundary
  - packByte
```
public final void packByte(int bval)
```
    Pack a byte value
    
    Parameters:
    bval - int
  - packNulls
```
public final void packNulls(int len)
```
    Pack nulls
    
    Parameters:
    len - int
  - packInt
```
public final void packInt(int ival)
```
    Pack an integer value
    
    Parameters:
    ival - int
  - packLong
```
public final void packLong(long lval)
```
    Pack a long value
    
    Parameters:
    lval - long
  - packByteArrayWithLength
```
public final void packByteArrayWithLength(byte[] buf)
```
    Pack a byte array with a length
    
    Parameters:
    buf - byte[]
  - packByteArray
```
public final void packByteArray(byte[] buf)
```
    Pack a byte array
    
    Parameters:
    buf - byte[]
  - packIntArrayWithLength
```
public final void packIntArrayWithLength(int[] iarray)
```
    Pack an integer array
    
    Parameters:
    iarray - int[]
  - packString
```
public final void packString(String str)
```
    Pack a string
    
    Parameters:
    str - String
  - packUTF8String
```
public final void packUTF8String(String str)
```
    Pack a UTF-8 string
    
    Parameters:
    str - String
  - packPortMapping
```
public final void packPortMapping(PortMapping portMap)
```
    Pack a port mapping structure
    
    Parameters:
    portMap - PortMapping
  - unpackInt
```
public final int unpackInt()
```
    Unpack an integer value
    
    Returns:
    int
  - unpackLong
```
public final long unpackLong()
```
    Unpack a long value
    
    Returns:
    long
  - unpackString
```
public final String unpackString()
```
    Unpack a string
    
    Returns:
    String
  - unpackUTF8String
```
public final String unpackUTF8String()
```
    Unpack a UTF-8 string
    
    Returns:
    String
  - unpackByteArrayWithLength
```
public final void unpackByteArrayWithLength(byte[] buf)
```
    Unpack a byte array with a length
    
    Parameters:
    buf - byte[]
  - unpackByteArray
```
public final void unpackByteArray(byte[] buf)
```
    Unpack a byte array, using the buffer length
    
    Parameters:
    buf - byte[]
  - unpackIntArray
```
public final void unpackIntArray(int[] buf)
```
    Unpack an integer array, using the buffer length
    
    Parameters:
    buf - int[]
  - positionAtCredentialsData
```
public final void positionAtCredentialsData()
```
    Position the read pointer at the credentials data
  - positionAtVerifierData
```
public final void positionAtVerifierData()
```
    Position the read pointer at the verifier data
  - positionAtParameters
```
public final void positionAtParameters()
```
    Position the read pointer at the procedure specific parameters
  - skipBytes
```
public final void skipBytes(int cnt)
```
    Skip a number of bytes in the buffer, rounded to the next int boundary
    
    Parameters:
    cnt - int
  - setClientDetails
```
public final void setClientDetails(InetAddress addr,
                    int port,
                    int protocol)
```
    Set the client details
    
    Parameters:
    addr - InetAddress
    port - int
    protocol - int
  - setBuffer
```
public final void setBuffer(byte[] buf,
             int offset,
             int len)
```
    Reset the buffer details
    
    Parameters:
    buf - byte[]
    offset - int
    len - int
  - setBuffer
```
public final void setBuffer(int offset,
             int len)
```
    Reset the buffer details
    
    Parameters:
    offset - int
    len - int
  - setLength
```
public final void setLength(int len)
```
    Set the used buffer length
    
    Parameters:
    len - int
  - setLength
```
public final void setLength()
```
    Set the used buffer length
  - setPosition
```
public final void setPosition(int pos)
```
    Set the buffer position
    
    Parameters:
    pos - int
  - setMessageType
```
public final void setMessageType(int msgType)
```
    Set the message type
    
    Parameters:
    msgType - int
  - setRpcVersion
```
public final void setRpcVersion(int rpcVer)
```
    Set the RPC version
    
    Parameters:
    rpcVer - int
  - setProgramId
```
public final void setProgramId(int progId)
```
    Set the program id
    
    Parameters:
    progId - int
  - setProgramVersion
```
public final void setProgramVersion(int progVer)
```
    Set the program version
    
    Parameters:
    progVer - int
  - setProcedureId
```
public final void setProcedureId(int procId)
```
    Set the procedure id
    
    Parameters:
    procId - int
  - setCredentialsType
```
public final void setCredentialsType(int credtype)
```
    Set the credentials type
    
    Parameters:
    credtype - int
  - setCredentialsLength
```
public final void setCredentialsLength(int credlen)
```
    Set the credentials length
    
    Parameters:
    credlen - int
  - setReplyState
```
public final void setReplyState(int replySts)
```
    Set the reply state
    
    Parameters:
    replySts - int
  - setRejectStatus
```
public final void setRejectStatus(int rejSts)
```
    Set the reject status
    
    Parameters:
    rejSts - int
  - setRpcMismatch
```
public final void setRpcMismatch(int rpcLow,
                  int rpcHigh)
```
    Set the RPC mismatch values
    
    Parameters:
    rpcLow - int
    rpcHigh - int
  - setAuthFailStatus
```
public final void setAuthFailStatus(int authSts)
```
    Set the authentication failure status
    
    Parameters:
    authSts - int
  - setVerifierType
```
public final void setVerifierType(int verftype)
```
    Set the verifier type
    
    Parameters:
    verftype - int
  - setVerifierLength
```
public final void setVerifierLength(int verflen)
```
    Set the verifier length
    
    Parameters:
    verflen - int
  - setPacketHandler
```
public final void setPacketHandler(RpcPacketHandler pktHandler)
```
    Set the associated packet handler interface for the packet
    
    Parameters:
    pktHandler - RpcPacketHandler
  - setXID
```
public final void setXID(int xid)
```
    Set the XID
    
    Parameters:
    xid - int
  - setOwnerPacketPool
```
protected final void setOwnerPacketPool(RpcPacketPool pool)
```
    Set the owner packet pool, if the packet was allocated from a pool
    
    Parameters:
    pool - RpcPacketPool
  - buildRequestHeader
```
public final void buildRequestHeader(int progId,
                      int verId,
                      int procId,
                      int credType,
                      byte[] cred,
                      int verfType,
                      byte[] verf)
```
    Build an RPC request header, and set the buffer pointer ready to stream data into the parameter area of the request
    
    Parameters:
    progId - int
    verId - int
    procId - int
    credType - int
    cred - byte[]
    verfType - int
    verf - byte[]
  - buildResponseHeader
```
public final void buildResponseHeader()
```
    Build a response header for a valid RPC response and set the buffer pointer ready to stream data into the parameter area of the response.
  - buildErrorResponse
```
public final void buildErrorResponse(int stsCode)
```
    Build an error response packet where the RPC has been accepted but returns a status code in the parameter area.
    
    Parameters:
    stsCode - int
  - buildRpcMismatchResponse
```
public final void buildRpcMismatchResponse()
```
    Build an RPC version mismatch response
  - buildAuthFailResponse
```
public final void buildAuthFailResponse(int stsCode)
```
    Build an RPC authentication failure response
    
    Parameters:
    stsCode - int
  - buildAcceptErrorResponse
```
public final void buildAcceptErrorResponse(int stsCode)
```
    Build an RPC accept error response
    
    Parameters:
    stsCode - int
  - buildProgramMismatchResponse
```
public final void buildProgramMismatchResponse(int verLow,
                                int verHigh)
```
    Build a program mismatch error response
    
    Parameters:
    verLow - int
    verHigh - int
  - toString
```
public String toString()
```
    Return the RPC packet as a string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class RpcPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FragHeaderLen

ResponseMismatchLen

ResponseAuthFailLen

Constructor Detail

RpcPacket

RpcPacket

RpcPacket

RpcPacket

RpcPacket

Method Detail

hasPacketHandler

getPacketHandler

isAllocatedFromPool

getOwnerPacketPool

hasClientAddress

getClientAddress

getClientPort

getClientProtocol

getClientDetails

getPosition

getBuffer

getAvailableLength

getLength

getTxLength

getOffset

getMessageType

getRpcVersion

getProgramId

getProgramVersion

getProcedureId

getCredentialsType

getCredentialsLength

getVerifierType

getVerifierLength

getVerifierOffset

getProcedureParameterOffset

getProcedureParameterLength

getXID

hasSuccessStatus

getReplyState

getRejectStatus

getMismatchVersionLow

getMismatchVersionHigh

getAuthFailStatus

getAcceptStatus

alignPosition

packByte

packNulls

packInt

packLong

packByteArrayWithLength

packByteArray

packIntArrayWithLength

packString

packUTF8String

packPortMapping

unpackInt

unpackLong

unpackString

unpackUTF8String

unpackByteArrayWithLength

unpackByteArray

unpackIntArray

positionAtCredentialsData

positionAtVerifierData

positionAtParameters

skipBytes

setClientDetails

setBuffer

setBuffer

setLength

setLength

setPosition

setMessageType