SMBMailslotPacket (Alfresco JLan 6.2 API)

java.lang.Object
- org.alfresco.jlan.smb.mailslot.SMBMailslotPacket

public class SMBMailslotPacket
extends Object

SMB Mailslot Packet Class

Author:: gkspencer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANDXCOMMAND`
`static int`	`ANDXRESERVED`
`static int`	`COMMAND`
`static int`	`DEFAULT_BUFSIZE`
`static int`	`ERROR`
`static int`	`ERRORCLASS`
`static int`	`ERRORCODE`
`static int`	`FLAGS`
`static int`	`FLAGS2`
`static int`	`FLG_CANONICAL`
`static int`	`FLG_CASELESS`
`static int`	`FLG_NOTIFY`
`static int`	`FLG_OPLOCK`
`static int`	`FLG_RESPONSE`
`static int`	`FLG_SUBDIALECT`
`static int`	`FLG2_EXTENDEDATTRIB`
`static int`	`FLG2_LONGERRORCODE`
`static int`	`FLG2_LONGFILENAMES`
`static int`	`FLG2_READIFEXE`
`static int`	`FLG2_UNICODE`
`static int`	`MID`
`static int`	`MIN_RXLEN`
`static int`	`PARAMWORDS`
`static int`	`PID`
`static int`	`PIDHIGH`
`static int`	`SEQNO`
`static int`	`SID`
`static int`	`SIGNATURE`
`static int`	`TID`
`static int`	`TRANS_HEADERLEN`
`static int`	`Transaction`
`static int`	`Transaction2`
`static int`	`UID`
`static int`	`WORDCNT`

Constructor Summary

Constructors
Constructor and Description
`SMBMailslotPacket()` Default constructor
`SMBMailslotPacket(byte[] buf)` Class constructor
`SMBMailslotPacket(byte[] buf, int off)` Class constructor

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAndXCommand()` Get the secondary command code
`byte[]`	`getBuffer()` Return the byte array used for the SMB packet
`int`	`getBufferLength()` Return the total buffer size available to the SMB request
`int`	`getByteCount()` Get the data byte count for the SMB packet
`int`	`getByteOffset()` Get the data byte area offset within the SMB packet
`int`	`getCommand()` Get the SMB command
`int`	`getDataBlockOffset()` Return the offset to the data block within the SMB packet.
`int`	`getDataBlockOffset(int prmLen)` Return the offset to the data block within the SMB packet.
`int`	`getErrorClass()` Get the SMB error class
`int`	`getErrorCode()` Get the SMB error code
`int`	`getFlags()` Get the SMB flags value.
`int`	`getFlags2()` Get the SMB flags2 value.
`int`	`getLength()` Calculate the total used packet length.
`int`	`getLongErrorCode()` Get the long SMB error code
`int`	`getMailslotClass()` Return the mailslot class of service
`int`	`getMailslotDataOffset()` Return the mailslot data offset
`int`	`getMailslotOpcode()` Return the mailslot opcode
`int`	`getMailslotPriority()` Return the mailslot priority
`int`	`getMailslotSubOpcode()` Return the mailslot sub-opcode, the first byte from the mailslot data
`int`	`getMultiplexId()` Get the multiplex identifier.
`int`	`getParameter(int idx)` Get a parameter word from the SMB packet.
`int`	`getParameterBlockOffset()` Return the parameter block offset where the parameter bytes should be placed.
`int`	`getParameterCount()` Get the parameter count
`int`	`getProcessId()` Get the process indentifier (PID)
`int`	`getRxDataBlock()` Return the data block offset.
`int`	`getRxDataBlockLength()` Return the received transaction data block length.
`int`	`getRxParameter(int prmIdx)` Get the required transact parameter word (16 bit).
`int`	`getRxParameterBlock()` Return the position of the parameter block within the received packet.
`int`	`getRxParameterBlockLength()` Return the received transaction parameter block length.
`int`	`getRxParameterCount()` Return the received transaction setup parameter count.
`int`	`getRxParameterInt(int prmIdx)` Get the required transact parameter int value (32-bit).
`String`	`getRxParameterString(int pos)` Get the required transact parameter string.
`String`	`getRxParameterString(int pos, int len)` Get the required transact parameter string.
`String`	`getRxTransactName()` Return the received transaction name.
`int`	`getSetupParameter(int idx)` Return the specified transaction setup parameter.
`int`	`getTreeId()` Get the tree identifier (TID)
`int`	`getUserId()` Get the user identifier (UID)
`boolean`	`hasLongErrorCode()` Determine if normal or long error codes have been returned
`void`	`initializeMailslotSMB(String name, byte[] data, int dlen)` Initialize a mailslot SMB
`protected void`	`initializeTransact(String name, int pcnt, byte[] paramblk, int plen, byte[] datablk, int dlen)` Initialize the transact SMB packet
`void`	`resetPacket(byte[] buf, int offset)` Reset the mailslot packet to use the specified buffer and offset
`void`	`setAndXCommand(int cmd)` Set the secondary SMB command
`void`	`setByteCount(int cnt)` Set the data byte count for this SMB packet
`void`	`setBytes(byte[] byts)` Set the data byte area in the SMB packet
`void`	`setCommand(int cmd)` Set the SMB command
`void`	`setErrorClass(int cl)` Set the SMB error class.
`void`	`setErrorCode(int sts)` Set the SMB error code
`void`	`setFlags(int flg)` Set the SMB flags value.
`void`	`setFlags2(int flg)` Set the SMB flags2 value.
`void`	`setMultiplexId(int mid)` Set the multiplex identifier.
`void`	`setParameter(int idx, int val)` Set the specified parameter word.
`void`	`setParameterCount(int cnt)` Set the parameter count
`void`	`setProcessId(int pid)` Set the process identifier value (PID).
`void`	`setSeqNo(int seq)` Set the packet sequence number, for connectionless commands.
`void`	`setSetupParameter(int idx, int val)` Set the specifiec setup parameter within the SMB packet.
`void`	`setSID(int sid)` Set the session id.
`void`	`setTreeId(int tid)` Set the tree identifier (TID)
`void`	`setUserId(int uid)` Set the user identifier (UID)

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

- Field Detail
  - SIGNATURE
```
public static final int SIGNATURE
```
    See Also:
    Constant Field Values
  - COMMAND
```
public static final int COMMAND
```
    See Also:
    Constant Field Values
  - ERRORCODE
```
public static final int ERRORCODE
```
    See Also:
    Constant Field Values
  - ERRORCLASS
```
public static final int ERRORCLASS
```
    See Also:
    Constant Field Values
  - ERROR
```
public static final int ERROR
```
    See Also:
    Constant Field Values
  - FLAGS
```
public static final int FLAGS
```
    See Also:
    Constant Field Values
  - FLAGS2
```
public static final int FLAGS2
```
    See Also:
    Constant Field Values
  - PIDHIGH
```
public static final int PIDHIGH
```
    See Also:
    Constant Field Values
  - SID
```
public static final int SID
```
    See Also:
    Constant Field Values
  - SEQNO
```
public static final int SEQNO
```
    See Also:
    Constant Field Values
  - TID
```
public static final int TID
```
    See Also:
    Constant Field Values
  - PID
```
public static final int PID
```
    See Also:
    Constant Field Values
  - UID
```
public static final int UID
```
    See Also:
    Constant Field Values
  - MID
```
public static final int MID
```
    See Also:
    Constant Field Values
  - WORDCNT
```
public static final int WORDCNT
```
    See Also:
    Constant Field Values
  - ANDXCOMMAND
```
public static final int ANDXCOMMAND
```
    See Also:
    Constant Field Values
  - ANDXRESERVED
```
public static final int ANDXRESERVED
```
    See Also:
    Constant Field Values
  - PARAMWORDS
```
public static final int PARAMWORDS
```
    See Also:
    Constant Field Values
  - TRANS_HEADERLEN
```
public static final int TRANS_HEADERLEN
```
    See Also:
    Constant Field Values
  - MIN_RXLEN
```
public static final int MIN_RXLEN
```
    See Also:
    Constant Field Values
  - DEFAULT_BUFSIZE
```
public static final int DEFAULT_BUFSIZE
```
    See Also:
    Constant Field Values
  - FLG_SUBDIALECT
```
public static final int FLG_SUBDIALECT
```
    See Also:
    Constant Field Values
  - FLG_CASELESS
```
public static final int FLG_CASELESS
```
    See Also:
    Constant Field Values
  - FLG_CANONICAL
```
public static final int FLG_CANONICAL
```
    See Also:
    Constant Field Values
  - FLG_OPLOCK
```
public static final int FLG_OPLOCK
```
    See Also:
    Constant Field Values
  - FLG_NOTIFY
```
public static final int FLG_NOTIFY
```
    See Also:
    Constant Field Values
  - FLG_RESPONSE
```
public static final int FLG_RESPONSE
```
    See Also:
    Constant Field Values
  - FLG2_LONGFILENAMES
```
public static final int FLG2_LONGFILENAMES
```
    See Also:
    Constant Field Values
  - FLG2_EXTENDEDATTRIB
```
public static final int FLG2_EXTENDEDATTRIB
```
    See Also:
    Constant Field Values
  - FLG2_READIFEXE
```
public static final int FLG2_READIFEXE
```
    See Also:
    Constant Field Values
  - FLG2_LONGERRORCODE
```
public static final int FLG2_LONGERRORCODE
```
    See Also:
    Constant Field Values
  - FLG2_UNICODE
```
public static final int FLG2_UNICODE
```
    See Also:
    Constant Field Values
  - Transaction
```
public static final int Transaction
```
    See Also:
    Constant Field Values
  - Transaction2
```
public static final int Transaction2
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SMBMailslotPacket
```
public SMBMailslotPacket()
```
    Default constructor
  - SMBMailslotPacket
```
public SMBMailslotPacket(byte[] buf)
```
    Class constructor
    
    Parameters:
    buf - byte[]
  - SMBMailslotPacket
```
public SMBMailslotPacket(byte[] buf,
                 int off)
```
    Class constructor
    
    Parameters:
    buf - byte[]
    off - int
- Method Detail
  - resetPacket
```
public final void resetPacket(byte[] buf,
               int offset)
```
    Reset the mailslot packet to use the specified buffer and offset
    
    Parameters:
    buf - byte[]
    offset - int
  - getAndXCommand
```
public final int getAndXCommand()
```
    Get the secondary command code
    
    Returns:
    Secondary command code
  - getBuffer
```
public final byte[] getBuffer()
```
    Return the byte array used for the SMB packet
    
    Returns:
    Byte array used for the SMB packet.
  - getBufferLength
```
public final int getBufferLength()
```
    Return the total buffer size available to the SMB request
    
    Returns:
    Total SMB buffer length available.
  - getByteCount
```
public final int getByteCount()
```
    Get the data byte count for the SMB packet
    
    Returns:
    Data byte count
  - getByteOffset
```
public final int getByteOffset()
```
    Get the data byte area offset within the SMB packet
    
    Returns:
    Data byte offset within the SMB packet.
  - getCommand
```
public final int getCommand()
```
    Get the SMB command
    
    Returns:
    SMB command code.
  - hasLongErrorCode
```
public final boolean hasLongErrorCode()
```
    Determine if normal or long error codes have been returned
    
    Returns:
    boolean
  - getErrorClass
```
public final int getErrorClass()
```
    Get the SMB error class
    
    Returns:
    SMB error class.
  - getErrorCode
```
public final int getErrorCode()
```
    Get the SMB error code
    
    Returns:
    SMB error code.
  - getFlags
```
public final int getFlags()
```
    Get the SMB flags value.
    
    Returns:
    SMB flags value.
  - getFlags2
```
public final int getFlags2()
```
    Get the SMB flags2 value.
    
    Returns:
    SMB flags2 value.
  - getLength
```
public final int getLength()
```
    Calculate the total used packet length.
    
    Returns:
    Total used packet length.
  - getLongErrorCode
```
public final int getLongErrorCode()
```
    Get the long SMB error code
    
    Returns:
    Long SMB error code.
  - getMultiplexId
```
public final int getMultiplexId()
```
    Get the multiplex identifier.
    
    Returns:
    Multiplex identifier.
  - getParameter
```
public final int getParameter(int idx)
                       throws IndexOutOfBoundsException
```
    Get a parameter word from the SMB packet.
    
    Parameters:
    idx - Parameter index (zero based).
    
    Returns:
    Parameter word value.
    
    Throws:
    
    IndexOutOfBoundsException - If the parameter index is out of range.
  - getParameterCount
```
public final int getParameterCount()
```
    Get the parameter count
    
    Returns:
    Parameter word count.
  - getProcessId
```
public final int getProcessId()
```
    Get the process indentifier (PID)
    
    Returns:
    Process identifier value.
  - getTreeId
```
public final int getTreeId()
```
    Get the tree identifier (TID)
    
    Returns:
    Tree identifier (TID)
  - getUserId
```
public final int getUserId()
```
    Get the user identifier (UID)
    
    Returns:
    User identifier (UID)
  - getDataBlockOffset
```
public final int getDataBlockOffset()
```
    Return the offset to the data block within the SMB packet. The data block is word aligned within the byte buffer area of the SMB packet. This method must be called after the parameter count and parameter block length have been set.
    
    Returns:
    int Offset to the data block area.
  - getDataBlockOffset
```
public final int getDataBlockOffset(int prmLen)
```
    Return the offset to the data block within the SMB packet. The data block is word aligned within the byte buffer area of the SMB packet. This method must be called after the parameter count has been set.
    
    Parameters:
    prmLen - Parameter block length, in bytes.
    
    Returns:
    int Offset to the data block area.
  - getParameterBlockOffset
```
public final int getParameterBlockOffset()
```
    Return the parameter block offset where the parameter bytes should be placed. This method must be called after the paramter count has been set. The parameter offset is word aligned.
    
    Returns:
    int Offset to the parameter block area.
  - getRxDataBlock
```
public final int getRxDataBlock()
```
    Return the data block offset.
    
    Returns:
    int Offset to data block within packet.
  - getRxDataBlockLength
```
public final int getRxDataBlockLength()
```
    Return the received transaction data block length.
    
    Returns:
    int
  - getRxParameter
```
public final int getRxParameter(int prmIdx)
```
    Get the required transact parameter word (16 bit).
    
    Parameters:
    prmIdx - int
    
    Returns:
    int
  - getRxParameterBlock
```
public final int getRxParameterBlock()
```
    Return the position of the parameter block within the received packet.
    
    Returns:
    int
  - getRxParameterBlockLength
```
public final int getRxParameterBlockLength()
```
    Return the received transaction parameter block length.
    
    Returns:
    int
  - getRxParameterCount
```
public final int getRxParameterCount()
```
    Return the received transaction setup parameter count.
    
    Returns:
    int
  - getRxParameterInt
```
public final int getRxParameterInt(int prmIdx)
```
    Get the required transact parameter int value (32-bit).
    
    Parameters:
    prmIdx - int
    
    Returns:
    int
  - getRxParameterString
```
public final String getRxParameterString(int pos)
```
    Get the required transact parameter string.
    
    Parameters:
    pos - Offset to the string within the parameter block.
    
    Returns:
    int
  - getRxParameterString
```
public final String getRxParameterString(int pos,
                          int len)
```
    Get the required transact parameter string.
    
    Parameters:
    pos - Offset to the string within the parameter block.
    len - Length of the string.
    
    Returns:
    int
  - getRxTransactName
```
public final String getRxTransactName()
```
    Return the received transaction name.
    
    Returns:
    java.lang.String
  - getSetupParameter
```
public final int getSetupParameter(int idx)
                            throws ArrayIndexOutOfBoundsException
```
    Return the specified transaction setup parameter.
    
    Parameters:
    idx - Setup parameter index.
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - getMailslotOpcode
```
public final int getMailslotOpcode()
```
    Return the mailslot opcode
    
    Returns:
    int
  - getMailslotPriority
```
public final int getMailslotPriority()
```
    Return the mailslot priority
    
    Returns:
    int
  - getMailslotClass
```
public final int getMailslotClass()
```
    Return the mailslot class of service
    
    Returns:
    int
  - getMailslotSubOpcode
```
public final int getMailslotSubOpcode()
```
    Return the mailslot sub-opcode, the first byte from the mailslot data
    
    Returns:
    int
  - getMailslotDataOffset
```
public final int getMailslotDataOffset()
```
    Return the mailslot data offset
    
    Returns:
    int
  - initializeMailslotSMB
```
public final void initializeMailslotSMB(String name,
                         byte[] data,
                         int dlen)
```
    Initialize a mailslot SMB
    
    Parameters:
    name - Mailslot name
    data - Request data bytes
    dlen - Data length
  - initializeTransact
```
protected final void initializeTransact(String name,
                      int pcnt,
                      byte[] paramblk,
                      int plen,
                      byte[] datablk,
                      int dlen)
```
    Initialize the transact SMB packet
    
    Parameters:
    name - Transaction name
    pcnt - Total parameter count for this transaction
    paramblk - Parameter block data bytes
    plen - Parameter block data length
    datablk - Data block data bytes
    dlen - Data block data length
  - setAndXCommand
```
public final void setAndXCommand(int cmd)
```
    Set the secondary SMB command
    
    Parameters:
    cmd - Secondary SMB command code.
  - setByteCount
```
public final void setByteCount(int cnt)
```
    Set the data byte count for this SMB packet
    
    Parameters:
    cnt - Data byte count.
  - setBytes
```
public final void setBytes(byte[] byts)
```
    Set the data byte area in the SMB packet
    
    Parameters:
    byts - Byte array containing the data to be copied to the SMB packet.
  - setCommand
```
public final void setCommand(int cmd)
```
    Set the SMB command
    
    Parameters:
    cmd - SMB command code
  - setErrorClass
```
public final void setErrorClass(int cl)
```
    Set the SMB error class.
    
    Parameters:
    cl - SMB error class.
  - setErrorCode
```
public final void setErrorCode(int sts)
```
    Set the SMB error code
    
    Parameters:
    sts - SMB error code.
  - setFlags
```
public final void setFlags(int flg)
```
    Set the SMB flags value.
    
    Parameters:
    flg - SMB flags value.
  - setFlags2
```
public final void setFlags2(int flg)
```
    Set the SMB flags2 value.
    
    Parameters:
    flg - SMB flags2 value.
  - setMultiplexId
```
public final void setMultiplexId(int mid)
```
    Set the multiplex identifier.
    
    Parameters:
    mid - Multiplex identifier
  - setParameter
```
public final void setParameter(int idx,
                int val)
```
    Set the specified parameter word.
    
    Parameters:
    idx - Parameter index (zero based).
    val - Parameter value.
  - setParameterCount
```
public final void setParameterCount(int cnt)
```
    Set the parameter count
    
    Parameters:
    cnt - Parameter word count.
  - setProcessId
```
public final void setProcessId(int pid)
```
    Set the process identifier value (PID).
    
    Parameters:
    pid - Process identifier value.
  - setSeqNo
```
public final void setSeqNo(int seq)
```
    Set the packet sequence number, for connectionless commands.
    
    Parameters:
    seq - Sequence number.
  - setSID
```
public final void setSID(int sid)
```
    Set the session id.
    
    Parameters:
    sid - Session id.
  - setTreeId
```
public final void setTreeId(int tid)
```
    Set the tree identifier (TID)
    
    Parameters:
    tid - Tree identifier value.
  - setUserId
```
public final void setUserId(int uid)
```
    Set the user identifier (UID)
    
    Parameters:
    uid - User identifier value.
  - setSetupParameter
```
public final void setSetupParameter(int idx,
                     int val)
```
    Set the specifiec setup parameter within the SMB packet.
    
    Parameters:
    idx - Setup parameter index.
    val - Setup parameter value.

Class SMBMailslotPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIGNATURE

COMMAND

ERRORCODE

ERRORCLASS

ERROR

FLAGS

FLAGS2

PIDHIGH

SID

SEQNO

TID

PID

UID

MID

WORDCNT

ANDXCOMMAND

ANDXRESERVED

PARAMWORDS

TRANS_HEADERLEN

MIN_RXLEN

DEFAULT_BUFSIZE

FLG_SUBDIALECT

FLG_CASELESS

FLG_CANONICAL

FLG_OPLOCK

FLG_NOTIFY

FLG_RESPONSE

FLG2_LONGFILENAMES

FLG2_EXTENDEDATTRIB

FLG2_READIFEXE

FLG2_LONGERRORCODE

FLG2_UNICODE

Transaction

Transaction2

Constructor Detail

SMBMailslotPacket

SMBMailslotPacket

SMBMailslotPacket

Method Detail

resetPacket

getAndXCommand

getBuffer

getBufferLength

getByteCount

getByteOffset

getCommand

hasLongErrorCode

getErrorClass

getErrorCode

getFlags

getFlags2

getLength

getLongErrorCode

getMultiplexId

getParameter

getParameterCount

getProcessId

getTreeId

getUserId

getDataBlockOffset

getDataBlockOffset

getParameterBlockOffset

getRxDataBlock

getRxDataBlockLength

getRxParameter

getRxParameterBlock

getRxParameterBlockLength

getRxParameterCount

getRxParameterInt

getRxParameterString

getRxParameterString

getRxTransactName

getSetupParameter

getMailslotOpcode