SMBSrvPacket (Alfresco JLan 5.0.a API)

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

Direct Known Subclasses:

NTTransPacket, SMBTransPacket
```
public class SMBSrvPacket
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_EXTENDEDSECURITY`
`static int`	`FLG2_LONGERRORCODE`
`static int`	`FLG2_LONGFILENAMES`
`static int`	`FLG2_READIFEXE`
`static int`	`FLG2_SECURITYSIGS`
`static int`	`FLG2_UNICODE`
`static int`	`HeaderLength`
`protected int`	`m_endpos`
`protected int`	`m_pos`
`static int`	`MID`
`static int`	`MIN_RXLEN`
`static int`	`NO_ANDX_CMD`
`static int`	`PARAMWORDS`
`static int`	`PID`
`static int`	`PIDHIGH`
`static int`	`PROTOCOL_NETBIOS`
`static int`	`PROTOCOL_TCPIP`
`static int`	`PROTOCOL_WIN32NETBIOS`
`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
`SMBSrvPacket()` Default constructor
`SMBSrvPacket(byte[] buf)` Construct an SMB packet using the specified packet buffer.
`SMBSrvPacket(int siz)` Construct an SMB packet of the specified size.
`SMBSrvPacket(SMBSrvPacket pkt)` Copy constructor.
`SMBSrvPacket(SMBSrvPacket pkt, int len)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`alignBytePointer()` Align the byte area pointer on an int (32bit) boundary
`static int`	`calculateHeaderLength(int numParams)` Calculate the header length for the specified number of parameters
`boolean`	`checkAndXPacketIsValid(int off, int reqWords, int reqBytes)` Check the SMB AndX command for the required minimum parameter count and byte count.
`boolean`	`checkPacketIsValid(int reqWords, int reqBytes)` Check the SMB packet for a valid SMB signature, and the required minimum parameter count and byte count.
`boolean`	`checkPacketSignature()` Check the SMB packet has a valid SMB signature.
`void`	`clearAssociatedPacket()` Clear the associated packet
`void`	`clearBytes()` Clear the data byte count
`void`	`clearHeader()` Clear the packet header
`void`	`clearLeaseTime()` Clear the lease time
`void`	`DumpPacket()` Dump the SMB packet to the debug stream
`void`	`DumpPacket(boolean dumpAll)` Dump the SMB packet to the debug stream
`int`	`getAndXByteCount(int off)` Get the data byte count for the SMB AndX command.
`int`	`getAndXByteOffset(int off)` Get the AndX data byte area offset within the SMB packet
`int`	`getAndXCommand()` Get the secondary command code
`int`	`getAndXParameter(int off, int idx)` Get an AndX parameter word from the SMB packet.
`int`	`getAndXParameterCount(int off)` Get the AndX command parameter count.
`int`	`getAndXParameterLong(int off, int idx)` Get an AndX parameter integer from the SMB packet.
`SMBSrvPacket`	`getAssociatedPacket()` Return the associated packet
`int`	`getAvailableLength()` Return the available buffer space for data bytes
`int`	`getAvailableLength(int len)` Return the available buffer space for data bytes for the specified buffer length
`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`	`getDeferredCount()` Return the deferred processing count for this 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`	`getHeaderFlags()` Return the NetBIOS header flags value.
`int`	`getHeaderLength()` Return the NetBIOS header data length value.
`int`	`getHeaderType()` Return the NetBIOS header message type.
`long`	`getLeaseTime()` Return the packet lease time
`int`	`getLength()` Calculate the total used packet length.
`int`	`getLongErrorCode()` Get the long SMB error code
`int`	`getMultiplexId()` Get the multiplex identifier.
`int`	`getPacketLength()` Calculate the total packet length, including header
`String`	`getPacketTypeString()` Dump the packet type
`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 identifier (PID)
`int`	`getProcessIdFull()` Return the 32bit process id value
`int`	`getProcessIdHigh()` Get the process identifier (PID) high bytes, or zero if not used
`int`	`getReceivedLength()` Get the actual received data length.
`int`	`getSID()` Get the session identifier (SID)
`int`	`getTreeId()` Get the tree identifier (TID)
`int`	`getUserId()` Get the user identifier (UID)
`boolean`	`hasAndXCommand()` Determine if there is a secondary command in this packet.
`boolean`	`hasAssociatedPacket()` Check if there is an associated packet
`boolean`	`hasLeaseTime()` Check if the packet has a lease
`boolean`	`hasMoreData()` Check if there is more data in the byte area
`void`	`incrementDeferredCount()` Increment the deferred processing count for this packet
`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`	`isQueuedForAsyncIO()` Determine if the packet is queued for sending via asynchronous I/O
`boolean`	`isRequestPacket()` Check if this is a request packet
`boolean`	`isResponse()` Determine if this packet is an SMB response, or command packet
`boolean`	`isSMB2()` Check if the packet is an SMB2 request/response
`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 an integer (32 bit) 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`	`packString(String str, boolean uni, boolean nul)` 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 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`	`SendResponseSMB(DataOutputStream out, int proto)` Send the SMB response packet.
`void`	`SendResponseSMB(DataOutputStream out, int proto, int len)` Send the SMB response packet.
`void`	`SendSuccessSMB(DataOutputStream out, int proto)` Send a success SMB response packet.
`void`	`setAndXByteCount(int off, int cnt)` Set the AndX data byte count for this SMB packet.
`void`	`setAndXBytes(int off, byte[] byts)` Set the AndX data byte area in the SMB packet
`void`	`setAndXCommand(int cmd)` Set the secondary SMB command
`void`	`setAndXCommand(int off, int cmd)` Set the AndX command for an AndX command block.
`void`	`setAndXParameter(int off, int idx, int val)` Set the specified AndX parameter word.
`void`	`setAndXParameterCount(int off, int cnt)` Set the AndX parameter count
`void`	`setAssociatedPacket(SMBSrvPacket smbPkt)` Set the associated packet
`void`	`setBuffer(byte[] buf)` Set the data buffer
`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`	`setError(boolean longError, int ntErr, int errCode, int errClass)` Set the error class/code.
`void`	`setError(int errCode, int errClass)` Set the error class and code.
`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`	`setHeaderFlags(int flg)` Set the NetBIOS packet header flags value.
`void`	`setHeaderLength(int len)` Set the NetBIOS packet data length in the packet header.
`void`	`setHeaderType(int typ)` Set the NetBIOS packet type in the packet header.
`void`	`setLeaseTime(long tmo)` Set the packet lease time
`void`	`setLongErrorCode(int err)` Set the long SMB error code
`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`	`setPosition(int pos)` Set the pack/unpack position
`void`	`setProcessId(int pid)` Set the process identifier value (PID).
`void`	`setQueuedForAsyncIO(boolean asyncIO)` Set/clear the asynchronous I/O flag
`void`	`setReceivedLength(int len)` Set the actual received data length.
`void`	`setRequestPacket(boolean reqPkt)` Set/clear the request packet flag
`void`	`setSeqNo(int seq)` Set the packet sequence number, for connectionless commands.
`void`	`setSID(int sid)` Set the session id.
`void`	`setSuccessStatus()` Set a success status code
`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
`String`	`toString()` Return the SMB packet details as a string
`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 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
`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, wait, wait, wait

- Field Detail
  - PROTOCOL_NETBIOS
```
public static final int PROTOCOL_NETBIOS
```
    See Also:
    Constant Field Values
  - PROTOCOL_TCPIP
```
public static final int PROTOCOL_TCPIP
```
    See Also:
    Constant Field Values
  - PROTOCOL_WIN32NETBIOS
```
public static final int PROTOCOL_WIN32NETBIOS
```
    See Also:
    Constant Field Values
  - 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
  - HeaderLength
```
public static final int HeaderLength
```
    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_EXTENDEDSECURITY
```
public static final int FLG2_EXTENDEDSECURITY
```
    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
  - NO_ANDX_CMD
```
public static final int NO_ANDX_CMD
```
    See Also:
    Constant Field Values
  - m_pos
```
protected int m_pos
```
  - m_endpos
```
protected int m_endpos
```
- Constructor Detail
  - SMBSrvPacket
```
public SMBSrvPacket()
```
    Default constructor
  - SMBSrvPacket
```
public SMBSrvPacket(byte[] buf)
```
    Construct an SMB packet using the specified packet buffer.
    
    Parameters:
    buf - SMB packet buffer.
  - SMBSrvPacket
```
public SMBSrvPacket(int siz)
```
    Construct an SMB packet of the specified size.
    
    Parameters:
    siz - Size of SMB packet buffer to allocate.
  - SMBSrvPacket
```
public SMBSrvPacket(SMBSrvPacket pkt)
```
    Copy constructor.
    
    Parameters:
    pkt - SMB packet buffer.
  - SMBSrvPacket
```
public SMBSrvPacket(SMBSrvPacket pkt,
            int len)
```
    Copy constructor.
    
    Parameters:
    pkt - SMB packet buffer.
    len - Length of packet to be copied
- Method Detail
  - checkAndXPacketIsValid
```
public final boolean checkAndXPacketIsValid(int off,
                             int reqWords,
                             int reqBytes)
```
    Check the SMB AndX command for the required minimum parameter count and byte count.
    
    Parameters:
    off - Offset to the AndX command within the SMB packet.
    reqWords - Minimum number of parameter words expected.
    reqBytes - Minimum number of bytes expected.
    
    Returns:
    boolean True if the packet passes the checks, else false.
  - checkPacketIsValid
```
public final boolean checkPacketIsValid(int reqWords,
                         int reqBytes)
```
    Check the SMB packet for a valid SMB signature, and the required minimum parameter count and byte count.
    
    Parameters:
    reqWords - Minimum number of parameter words expected.
    reqBytes - Minimum number of bytes expected.
    
    Returns:
    boolean True if the packet passes the checks, else false.
  - checkPacketSignature
```
public final boolean checkPacketSignature()
```
    Check the SMB packet has a valid SMB signature.
    
    Returns:
    boolean True if the SMB signature is valid, else false.
  - isSMB2
```
public final boolean isSMB2()
```
    Check if the packet is an SMB2 request/response
    
    Returns:
    boolean
  - clearBytes
```
public final void clearBytes()
```
    Clear the data byte count
  - DumpPacket
```
public final void DumpPacket()
```
    Dump the SMB packet to the debug stream
  - DumpPacket
```
public final void DumpPacket(boolean dumpAll)
```
    Dump the SMB packet to the debug stream
    
    Parameters:
    dumpAll - boolean
  - getAndXByteCount
```
public final int getAndXByteCount(int off)
```
    Get the data byte count for the SMB AndX command.
    
    Parameters:
    off - Offset to the AndX command.
    
    Returns:
    Data byte count
  - getAndXByteOffset
```
public final int getAndXByteOffset(int off)
```
    Get the AndX data byte area offset within the SMB packet
    
    Parameters:
    off - Offset to the AndX command.
    
    Returns:
    Data byte offset within the SMB packet.
  - getAndXCommand
```
public final int getAndXCommand()
```
    Get the secondary command code
    
    Returns:
    Secondary command code
  - getAndXParameter
```
public final int getAndXParameter(int off,
                   int idx)
                           throws IndexOutOfBoundsException
```
    Get an AndX parameter word from the SMB packet.
    
    Parameters:
    off - Offset to the AndX command.
    idx - Parameter index (zero based).
    
    Returns:
    Parameter word value.
    
    Throws:
    
    IndexOutOfBoundsException - If the parameter index is out of range.
  - getAndXParameterLong
```
public final int getAndXParameterLong(int off,
                       int idx)
                               throws IndexOutOfBoundsException
```
    Get an AndX parameter integer from the SMB packet.
    
    Parameters:
    off - Offset to the AndX command.
    idx - Parameter index (zero based).
    
    Returns:
    Parameter integer value.
    
    Throws:
    
    IndexOutOfBoundsException - If the parameter index is out of range.
  - getAndXParameterCount
```
public final int getAndXParameterCount(int off)
```
    Get the AndX command parameter count.
    
    Parameters:
    off - Offset to the AndX command.
    
    Returns:
    Parameter word count.
  - 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.
  - 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.
  - getHeaderFlags
```
public final int getHeaderFlags()
```
    Return the NetBIOS header flags value.
    
    Returns:
    int
  - getHeaderLength
```
public final int getHeaderLength()
```
    Return the NetBIOS header data length value.
    
    Returns:
    int
  - getHeaderType
```
public final int getHeaderType()
```
    Return the NetBIOS header message type.
    
    Returns:
    int
  - getLength
```
public final int getLength()
```
    Calculate the total used packet length.
    
    Returns:
    Total used packet length.
  - getPacketLength
```
public final int getPacketLength()
```
    Calculate the total packet length, including header
    
    Returns:
    Total packet length.
  - getAvailableLength
```
public final int getAvailableLength()
```
    Return the available buffer space for data bytes
    
    Returns:
    int
  - getAvailableLength
```
public final int getAvailableLength(int len)
```
    Return the available buffer space for data bytes for the specified buffer length
    
    Parameters:
    len - int
    
    Returns:
    int
  - 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.
  - getPacketTypeString
```
public final String getPacketTypeString()
```
    Dump the packet type
    
    Returns:
    String
  - 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.
  - getParameterLong
```
public final int getParameterLong(int idx)
```
    Get the specified parameter words, as an int value.
    
    Parameters:
    idx - Parameter index (zero based).
    
    Returns:
    int
  - getProcessId
```
public final int getProcessId()
```
    Get the process identifier (PID)
    
    Returns:
    Process identifier value.
  - getProcessIdHigh
```
public final int getProcessIdHigh()
```
    Get the process identifier (PID) high bytes, or zero if not used
    
    Returns:
    Process identifier value.
  - getProcessIdFull
```
public final int getProcessIdFull()
```
    Return the 32bit process id value
    
    Returns:
    int
  - getReceivedLength
```
public final int getReceivedLength()
```
    Get the actual received data length.
    
    Returns:
    int
  - getSID
```
public final int getSID()
```
    Get the session identifier (SID)
    
    Returns:
    Session identifier (SID)
  - 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)
  - hasAndXCommand
```
public final boolean hasAndXCommand()
```
    Determine if there is a secondary command in this packet.
    
    Returns:
    Secondary command code
  - 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.
  - 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
  - isRequestPacket
```
public final boolean isRequestPacket()
```
    Check if this is a request packet
    
    Returns:
    boolean
  - 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
  - packString
```
public final void packString(String str,
              boolean uni,
              boolean nul)
```
    Pack a string using either ASCII or Unicode into the byte area
    
    Parameters:
    str - String
    uni - boolean
    nul - 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 an integer (32 bit) 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 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
  - hasMoreData
```
public final boolean hasMoreData()
```
    Check if there is more data in the byte area
    
    Returns:
    boolean
  - SendResponseSMB
```
public final void SendResponseSMB(DataOutputStream out,
                   int proto)
                           throws IOException
```
    Send the SMB response packet.
    
    Parameters:
    out - Output stream associated with the session socket.
    proto - Protocol type, either PROTOCOL_NETBIOS or PROTOCOL_TCPIP
    
    Throws:
    
    IOException - If an I/O error occurs.
  - SendResponseSMB
```
public final void SendResponseSMB(DataOutputStream out,
                   int proto,
                   int len)
                           throws IOException
```
    Send the SMB response packet.
    
    Parameters:
    out - Output stream associated with the session socket.
    proto - Protocol type, either PROTOCOL_NETBIOS or PROTOCOL_TCPIP
    len - Packet length
    
    Throws:
    
    IOException - If an I/O error occurs.
  - SendSuccessSMB
```
public final void SendSuccessSMB(DataOutputStream out,
                  int proto)
                          throws IOException
```
    Send a success SMB response packet.
    
    Parameters:
    out - Output stream associated with the session socket.
    proto - Protocol type, either PROTOCOL_NETBIOS or PROTOCOL_TCPIP
    
    Throws:
    
    IOException - If an I/O error occurs.
  - setAndXByteCount
```
public final void setAndXByteCount(int off,
                    int cnt)
```
    Set the AndX data byte count for this SMB packet.
    
    Parameters:
    off - AndX command offset.
    cnt - Data byte count.
  - setAndXBytes
```
public final void setAndXBytes(int off,
                byte[] byts)
```
    Set the AndX data byte area in the SMB packet
    
    Parameters:
    off - Offset to the AndX command.
    byts - Byte array containing the data to be copied to the SMB packet.
  - setAndXCommand
```
public final void setAndXCommand(int cmd)
```
    Set the secondary SMB command
    
    Parameters:
    cmd - Secondary SMB command code.
  - setAndXCommand
```
public final void setAndXCommand(int off,
                  int cmd)
```
    Set the AndX command for an AndX command block.
    
    Parameters:
    off - Offset to the current AndX command.
    cmd - Secondary SMB command code.
  - setAndXParameter
```
public final void setAndXParameter(int off,
                    int idx,
                    int val)
```
    Set the specified AndX parameter word.
    
    Parameters:
    off - Offset to the AndX command.
    idx - Parameter index (zero based).
    val - Parameter value.
  - setAndXParameterCount
```
public final void setAndXParameterCount(int off,
                         int cnt)
```
    Set the AndX parameter count
    
    Parameters:
    off - Offset to the AndX command.
    cnt - Parameter word count.
  - 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
  - setError
```
public final void setError(int errCode,
            int errClass)
```
    Set the error class and code.
    
    Parameters:
    errCode - int
    errClass - int
  - setError
```
public final void setError(boolean longError,
            int ntErr,
            int errCode,
            int errClass)
```
    Set the error class/code.
    
    Parameters:
    longError - boolean
    ntErr - int
    errCode - int
    errClass - int
  - 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.
  - setLongErrorCode
```
public final void setLongErrorCode(int err)
```
    Set the long SMB error code
    
    Parameters:
    err - Long SMB error code.
  - setSuccessStatus
```
public final void setSuccessStatus()
```
    Set a success status 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.
  - setHeaderFlags
```
public final void setHeaderFlags(int flg)
```
    Set the NetBIOS packet header flags value.
    
    Parameters:
    flg - int
  - setHeaderLength
```
public final void setHeaderLength(int len)
```
    Set the NetBIOS packet data length in the packet header.
    
    Parameters:
    len - int
  - setHeaderType
```
public final void setHeaderType(int typ)
```
    Set the NetBIOS packet type in the packet header.
    
    Parameters:
    typ - int
  - 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.
  - setParameterLong
```
public final void setParameterLong(int idx,
                    int val)
```
    Set the specified parameter words.
    
    Parameters:
    idx - Parameter index (zero based).
    val - Parameter value.
  - setPosition
```
public final void setPosition(int pos)
```
    Set the pack/unpack position
    
    Parameters:
    pos - int
  - setProcessId
```
public final void setProcessId(int pid)
```
    Set the process identifier value (PID).
    
    Parameters:
    pid - Process identifier value.
  - setReceivedLength
```
public final void setReceivedLength(int len)
```
    Set the actual received data length.
    
    Parameters:
    len - int
  - 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.
  - resetBytePointer
```
public final void resetBytePointer()
```
    Reset the byte pointer area for packing/unpacking data items 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
  - alignBytePointer
```
public final void alignBytePointer()
```
    Align the byte area pointer on an int (32bit) boundary
  - 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
  - skipBytes
```
public final void skipBytes(int cnt)
```
    Skip a number of bytes in the parameter/byte area
    
    Parameters:
    cnt - int
  - setBuffer
```
public final void setBuffer(byte[] buf)
```
    Set the data buffer
    
    Parameters:
    buf - byte[]
  - hasAssociatedPacket
```
public final boolean hasAssociatedPacket()
```
    Check if there is an associated packet
    
    Returns:
    boolean
  - getAssociatedPacket
```
public final SMBSrvPacket getAssociatedPacket()
```
    Return the associated packet
    
    Returns:
    SMBSrvPacket
  - setAssociatedPacket
```
public final void setAssociatedPacket(SMBSrvPacket smbPkt)
```
    Set the associated packet
    
    Parameters:
    smbPkt - SMBSrvPacket
  - clearAssociatedPacket
```
public final void clearAssociatedPacket()
```
    Clear the associated packet
  - calculateHeaderLength
```
public static final int calculateHeaderLength(int numParams)
```
    Calculate the header length for the specified number of parameters
    
    Parameters:
    numParams - int
    
    Returns:
    int
  - isQueuedForAsyncIO
```
public final boolean isQueuedForAsyncIO()
```
    Determine if the packet is queued for sending via asynchronous I/O
    
    Returns:
    boolean
  - setQueuedForAsyncIO
```
public final void setQueuedForAsyncIO(boolean asyncIO)
```
    Set/clear the asynchronous I/O flag
    
    Parameters:
    asyncIO - boolean
  - clearHeader
```
public final void clearHeader()
```
    Clear the packet header
  - getDeferredCount
```
public final int getDeferredCount()
```
    Return the deferred processing count for this packet
    
    Returns:
    int
  - incrementDeferredCount
```
public final void incrementDeferredCount()
```
    Increment the deferred processing count for this packet
  - setRequestPacket
```
public final void setRequestPacket(boolean reqPkt)
```
    Set/clear the request packet flag
    
    Parameters:
    reqPkt - boolean
  - hasLeaseTime
```
public final boolean hasLeaseTime()
```
    Check if the packet has a lease
    
    Returns:
    boolean
  - getLeaseTime
```
public final long getLeaseTime()
```
    Return the packet lease time
    
    Returns:
    long
  - clearLeaseTime
```
public final void clearLeaseTime()
```
    Clear the lease time
  - setLeaseTime
```
public final void setLeaseTime(long tmo)
```
    Set the packet lease time
    
    Parameters:
    tmo - long
  - toString
```
public String toString()
```
    Return the SMB packet details as a string
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String

Class SMBSrvPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_NETBIOS

PROTOCOL_TCPIP

PROTOCOL_WIN32NETBIOS

SIGNATURE

COMMAND

ERRORCODE

ERRORCLASS

ERROR

FLAGS

FLAGS2

PIDHIGH

SID

SEQNO

TID

PID

UID

MID

WORDCNT

ANDXCOMMAND

ANDXRESERVED

PARAMWORDS

HeaderLength

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_EXTENDEDSECURITY

FLG2_DFSRESOLVE

FLG2_READIFEXE

FLG2_LONGERRORCODE

FLG2_UNICODE

SEC_USER

SEC_ENCRYPT

RAW_READ

RAW_WRITE

NO_ANDX_CMD

m_pos

m_endpos

Constructor Detail

SMBSrvPacket

SMBSrvPacket

SMBSrvPacket

SMBSrvPacket

SMBSrvPacket

Method Detail

checkAndXPacketIsValid

checkPacketIsValid

checkPacketSignature

isSMB2

clearBytes

DumpPacket

DumpPacket

getAndXByteCount

getAndXByteOffset

getAndXCommand

getAndXParameter

getAndXParameterLong

getAndXParameterCount

getBuffer

getBufferLength

getByteCount

getByteOffset

getCommand

getErrorClass

getErrorCode

getFlags