SMBPacket (Alfresco JLan 5.2 API)

java.lang.Object
- org.alfresco.jlan.smb.server.SMBPacket

```
public class SMBPacket
extends Object
```
SMB packet type 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_DFSRESOLVE`
`static int`	`FLG2_EXTENDEDATTRIB`
`static int`	`FLG2_EXTENDNEGOTIATE`
`static int`	`FLG2_LONGERRORCODE`
`static int`	`FLG2_LONGFILENAMES`
`static int`	`FLG2_LONGNAMESUSED`
`static int`	`FLG2_READIFEXE`
`static int`	`FLG2_SECURITYSIGS`
`static int`	`FLG2_UNICODE`
`protected int`	`m_endpos`
`protected int`	`m_pos`
`static int`	`MID`
`static int`	`MIN_RXLEN`
`static int`	`PARAMWORDS`
`static int`	`PID`
`static int`	`PIDHIGH`
`static int`	`RAW_READ`
`static int`	`RAW_WRITE`
`static int`	`SEC_ENCRYPT`
`static int`	`SEC_USER`
`static int`	`SEQNO`
`static int`	`SID`
`static int`	`SIGNATURE`
`static int`	`TID`
`static int`	`TRANS_HEADERLEN`
`static int`	`UID`
`static int`	`WORDCNT`

Constructor Summary

Constructors
Constructor and Description
`SMBPacket()` Default constructor
`SMBPacket(byte[] buf)` Construct an SMB packet using the specified packet buffer.
`SMBPacket(int siz)` Construct an SMB packet of the specified size.
`SMBPacket(SMBPacket pkt)` Copy constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`alignBytePointer()` Align the byte area pointer on an int (32bit) boundary
`void`	`clearBytes()` Clear the data byte count
`void`	`DumpPacket()` Dump the SMB packet to the debug stream
`boolean`	`equalsError(int errClass, int errCode)` Check if the error class/code match the specified error/class
`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`	`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`	`getMultiplexId()` Get the multiplex identifier.
`int`	`getParameter(int idx)` Get a parameter word from the SMB packet.
`int`	`getParameterCount()` Get the parameter count
`int`	`getParameterLong(int idx)` Get the specified parameter words, as an int value.
`int`	`getPosition()` Return the current byte area buffer position
`int`	`getProcessId()` Get the process indentifier (PID)
`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
`boolean`	`hasMoreData()` Check if there is more data in the byte area
`boolean`	`isCaseless()` Check if the packet is using caseless filenames
`boolean`	`isLongErrorCode()` Check if long error codes are being used
`boolean`	`isLongFileNames()` Check if long file names are being used
`boolean`	`isResponse()` Determine if this packet is an SMB response, or command packet
`boolean`	`isUnicode()` Check if the packet contains ASCII or Unicode strings
`boolean`	`isValidResponse()` Check if the response packet is valid, ie.
`void`	`packByte(byte val)` Pack a byte (8 bit) value into the byte area
`void`	`packByte(int val)` Pack a byte (8 bit) value into the byte area
`void`	`packBytes(byte[] byts, int len)` Pack the specified bytes into the byte area
`void`	`packInt(int val)` Pack a 32 bit integer value into the byte area
`void`	`packLong(long val)` Pack a long integer (64 bit) value into the byte area
`void`	`packString(String str, boolean uni)` Pack a string using either ASCII or Unicode into the byte area
`void`	`packWord(int val)` Pack a word (16 bit) value into the byte area
`void`	`resetBytePointer()` Reset the byte/parameter pointer area for packing/unpacking data items from the packet
`void`	`resetBytePointerAlign()` Reset the byte/parameter pointer area for packing/unpacking data items from the packet, and align the buffer on an int (32bit) boundary
`void`	`resetParameterPointer()` Reset the byte/parameter pointer area for packing/unpacking paramaters from the packet
`void`	`setAndXCommand(int cmd)` Set the secondary SMB command
`void`	`setByteCount()` Set the data byte count for this SMB packet
`void`	`setByteCount(int cnt)` Set the data byte count for this SMB packet
`void`	`setBytePointer(int off, int len)` Set the unpack pointer to the specified offset, for AndX processing
`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`	`setParameterLong(int idx, int val)` Set the specified parameter words.
`void`	`setProcessId(int pid)` Set the process identifier value (PID).
`void`	`setSeqNo(int seq)` Set the packet sequence number, for connectionless commands.
`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)
`void`	`skipBytes(int cnt)` Skip a number of bytes in the parameter/byte area
`int`	`unpackByte()` Unpack a byte value from the byte area
`byte[]`	`unpackBytes(int len)` Unpack a block of bytes from the byte area
`int`	`unpackInt()` Unpack an integer (32 bit) value from the byte/parameter area
`long`	`unpackLong()` Unpack a long integer (64 bit) value from the byte area
`String`	`unpackString(boolean uni)` Unpack a string from the byte area
`String`	`unpackString(int len, boolean uni)` Unpack a string from the byte area
`int`	`unpackWord()` Unpack a word (16 bit) value from the byte area

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_SECURITYSIGS
```
public static final int FLG2_SECURITYSIGS
```
    See Also:
    Constant Field Values
  - FLG2_LONGNAMESUSED
```
public static final int FLG2_LONGNAMESUSED
```
    See Also:
    Constant Field Values
  - FLG2_EXTENDNEGOTIATE
```
public static final int FLG2_EXTENDNEGOTIATE
```
    See Also:
    Constant Field Values
  - FLG2_DFSRESOLVE
```
public static final int FLG2_DFSRESOLVE
```
    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
  - SEC_USER
```
public static final int SEC_USER
```
    See Also:
    Constant Field Values
  - SEC_ENCRYPT
```
public static final int SEC_ENCRYPT
```
    See Also:
    Constant Field Values
  - RAW_READ
```
public static final int RAW_READ
```
    See Also:
    Constant Field Values
  - RAW_WRITE
```
public static final int RAW_WRITE
```
    See Also:
    Constant Field Values
  - m_pos
```
protected int m_pos
```
  - m_endpos
```
protected int m_endpos
```
- Constructor Detail
  - SMBPacket
```
public SMBPacket()
```
    Default constructor
  - SMBPacket
```
public SMBPacket(byte[] buf)
```
    Construct an SMB packet using the specified packet buffer.
    
    Parameters:
    buf - SMB packet buffer.
  - SMBPacket
```
public SMBPacket(int siz)
```
    Construct an SMB packet of the specified size.
    
    Parameters:
    siz - Size of SMB packet buffer to allocate.
  - SMBPacket
```
public SMBPacket(SMBPacket pkt)
```
    Copy constructor
    
    Parameters:
    pkt - SMBPacket
- Method Detail
  - clearBytes
```
public final void clearBytes()
```
    Clear the data byte count
  - DumpPacket
```
public final void DumpPacket()
```
    Dump the SMB packet to the debug stream
  - equalsError
```
public final boolean equalsError(int errClass,
                  int errCode)
```
    Check if the error class/code match the specified error/class
    
    Parameters:
    errClass - int
    errCode - int
    
    Returns:
    boolean
  - 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
  - isUnicode
```
public final boolean isUnicode()
```
    Check if the packet contains ASCII or Unicode strings
    
    Returns:
    boolean
  - isCaseless
```
public final boolean isCaseless()
```
    Check if the packet is using caseless filenames
    
    Returns:
    boolean
  - isLongFileNames
```
public final boolean isLongFileNames()
```
    Check if long file names are being used
    
    Returns:
    boolean
  - isLongErrorCode
```
public final boolean isLongErrorCode()
```
    Check if long error codes are being used
    
    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.
  - getParameterLong
```
public final int getParameterLong(int idx)
```
    Get the specified parameter words, as an int value.
    
    Parameters:
    idx - Parameter index (zero based).
    
    Returns:
    int
  - 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)
  - isResponse
```
public final boolean isResponse()
```
    Determine if this packet is an SMB response, or command packet
    
    Returns:
    true if this SMB packet is a response, else false
  - isValidResponse
```
public final boolean isValidResponse()
```
    Check if the response packet is valid, ie. type and flags
    
    Returns:
    true if the SMB packet is a response packet and the response is valid, else false.
  - packByte
```
public final void packByte(byte val)
```
    Pack a byte (8 bit) value into the byte area
    
    Parameters:
    val - byte
  - packByte
```
public final void packByte(int val)
```
    Pack a byte (8 bit) value into the byte area
    
    Parameters:
    val - int
  - packBytes
```
public final void packBytes(byte[] byts,
             int len)
```
    Pack the specified bytes into the byte area
    
    Parameters:
    byts - byte[]
    len - int
  - packString
```
public final void packString(String str,
              boolean uni)
```
    Pack a string using either ASCII or Unicode into the byte area
    
    Parameters:
    str - String
    uni - boolean
  - packWord
```
public final void packWord(int val)
```
    Pack a word (16 bit) value into the byte area
    
    Parameters:
    val - int
  - packInt
```
public final void packInt(int val)
```
    Pack a 32 bit integer value into the byte area
    
    Parameters:
    val - int
  - packLong
```
public final void packLong(long val)
```
    Pack a long integer (64 bit) value into the byte area
    
    Parameters:
    val - long
  - getPosition
```
public final int getPosition()
```
    Return the current byte area buffer position
    
    Returns:
    int
  - unpackByte
```
public final int unpackByte()
```
    Unpack a byte value from the byte area
    
    Returns:
    int
  - unpackBytes
```
public final byte[] unpackBytes(int len)
```
    Unpack a block of bytes from the byte area
    
    Parameters:
    len - int
    
    Returns:
    byte[]
  - unpackWord
```
public final int unpackWord()
```
    Unpack a word (16 bit) value from the byte area
    
    Returns:
    int
  - unpackInt
```
public final int unpackInt()
```
    Unpack an integer (32 bit) value from the byte/parameter area
    
    Returns:
    int
  - unpackLong
```
public final long unpackLong()
```
    Unpack a long integer (64 bit) value from the byte area
    
    Returns:
    long
  - unpackString
```
public final String unpackString(boolean uni)
```
    Unpack a string from the byte area
    
    Parameters:
    uni - boolean
    
    Returns:
    String
  - unpackString
```
public final String unpackString(int len,
                  boolean uni)
```
    Unpack a string from the byte area
    
    Parameters:
    len - int
    uni - boolean
    
    Returns:
    String
  - hasMoreData
```
public final boolean hasMoreData()
```
    Check if there is more data in the byte area
    
    Returns:
    boolean
  - 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.
  - setByteCount
```
public final void setByteCount()
```
    Set the data byte count for this SMB packet
  - 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.
  - setParameterLong
```
public final void setParameterLong(int idx,
                    int val)
```
    Set the specified parameter words.
    
    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.
  - alignBytePointer
```
public final void alignBytePointer()
```
    Align the byte area pointer on an int (32bit) boundary
  - resetBytePointer
```
public final void resetBytePointer()
```
    Reset the byte/parameter pointer area for packing/unpacking data items from the packet
  - resetBytePointerAlign
```
public final void resetBytePointerAlign()
```
    Reset the byte/parameter pointer area for packing/unpacking data items from the packet, and align the buffer on an int (32bit) boundary
  - resetParameterPointer
```
public final void resetParameterPointer()
```
    Reset the byte/parameter pointer area for packing/unpacking paramaters from the packet
  - setBytePointer
```
public final void setBytePointer(int off,
                  int len)
```
    Set the unpack pointer to the specified offset, for AndX processing
    
    Parameters:
    off - int
    len - int
  - skipBytes
```
public final void skipBytes(int cnt)
```
    Skip a number of bytes in the parameter/byte area
    
    Parameters:
    cnt - int

Class SMBPacket

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_SECURITYSIGS

FLG2_LONGNAMESUSED

FLG2_EXTENDNEGOTIATE

FLG2_DFSRESOLVE

FLG2_READIFEXE

FLG2_LONGERRORCODE

FLG2_UNICODE

SEC_USER

SEC_ENCRYPT

RAW_READ

RAW_WRITE

m_pos

m_endpos

Constructor Detail

SMBPacket

SMBPacket

SMBPacket

SMBPacket

Method Detail

clearBytes

DumpPacket

equalsError

getAndXCommand

getBuffer

getBufferLength

getByteCount

getByteOffset

getCommand

hasLongErrorCode

isUnicode

isCaseless

isLongFileNames

isLongErrorCode

getErrorClass

getErrorCode

getFlags

getFlags2

getLength

getLongErrorCode

getMultiplexId

getParameter

getParameterLong

getParameterCount

getProcessId

getTreeId