ServerMessageBlock2 (jCIFS NG 2.1.7 API)

java.lang.Object
- jcifs.internal.smb2.ServerMessageBlock2

All Implemented Interfaces:

CommonServerMessageBlock, Message

Direct Known Subclasses:

ServerMessageBlock2Request, ServerMessageBlock2Response, Smb2CancelRequest
```
public abstract class ServerMessageBlock2
extends Object
implements CommonServerMessageBlock
```
Author:

mbechler

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SMB2_FLAGS_ASYNC_COMMAND`
`static int`	`SMB2_FLAGS_DFS_OPERATIONS`
`static int`	`SMB2_FLAGS_PRIORITY_MASK`
`static int`	`SMB2_FLAGS_RELATED_OPERATIONS`
`static int`	`SMB2_FLAGS_REPLAY_OPERATION`
`static int`	`SMB2_FLAGS_SERVER_TO_REDIR`
`static int`	`SMB2_FLAGS_SIGNED`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFlags(int flag)`
`boolean`	`chain(ServerMessageBlock2 n)`
`void`	`clearFlags(int flag)`
`int`	`decode(byte[] buffer, int bufferIndex)` Decode message data from the given byte array
`int`	`decode(byte[] buffer, int bufferIndex, boolean compound)`
`int`	`encode(byte[] dst, int dstIndex)`
`boolean`	`equals(Object obj)`
`long`	`getAsyncId()`
`int`	`getCommand()`
`int`	`getCredit()`
`int`	`getCreditCharge()`
`Smb2SigningDigest`	`getDigest()`
`byte`	`getErrorContextCount()`
`byte[]`	`getErrorData()`
`int`	`getFlags()`
`int`	`getHeaderStart()`
`int`	`getLength()`
`long`	`getMid()`
`int`	`getNextCommandOffset()`
`byte[]`	`getRawPayload()`
`ServerMessageBlock2Response`	`getResponse()`
`long`	`getSessionId()`
`int`	`getStatus()`
`int`	`getTreeId()`
`int`	`hashCode()`
`boolean`	`isAsync()`
`boolean`	`isRetainPayload()`
`void`	`reset()`
`void`	`retainPayload()` Indicate that this message should retain it's raw payload
`void`	`setAsyncId(long asyncId)`
`void`	`setCommand(int command)`
`void`	`setCredit(int credit)`
`void`	`setDigest(SMBSigningDigest digest)`
`void`	`setExtendedSecurity(boolean extendedSecurity)`
`void`	`setMid(long mid)`
`void`	`setRawPayload(byte[] rawPayload)`
`void`	`setReadSize(int readSize)`
`void`	`setResponse(CommonServerMessageBlockResponse msg)`
`void`	`setSessionId(long sessionId)`
`void`	`setTreeId(int treeId)`
`void`	`setUid(int uid)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SMB2_FLAGS_SERVER_TO_REDIR
```
public static final int SMB2_FLAGS_SERVER_TO_REDIR
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_ASYNC_COMMAND
```
public static final int SMB2_FLAGS_ASYNC_COMMAND
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_RELATED_OPERATIONS
```
public static final int SMB2_FLAGS_RELATED_OPERATIONS
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_SIGNED
```
public static final int SMB2_FLAGS_SIGNED
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_PRIORITY_MASK
```
public static final int SMB2_FLAGS_PRIORITY_MASK
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_DFS_OPERATIONS
```
public static final int SMB2_FLAGS_DFS_OPERATIONS
```
    See Also:
    
    Constant Field Values
  - SMB2_FLAGS_REPLAY_OPERATION
```
public static final int SMB2_FLAGS_REPLAY_OPERATION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface CommonServerMessageBlock
  - getCommand
```
public final int getCommand()
```
    Specified by:
    
    getCommand in interface CommonServerMessageBlock
    
    Returns:
    
    the command
  - getNextCommandOffset
```
public final int getNextCommandOffset()
```
    Returns:
    
    offset to next compound command
  - setReadSize
```
public void setReadSize(int readSize)
```
    Parameters:
    
    readSize - the readSize to set
  - isAsync
```
public boolean isAsync()
```
    Returns:
    
    the async
  - setCommand
```
public final void setCommand(int command)
```
    Specified by:
    
    setCommand in interface CommonServerMessageBlock
    
    Parameters:
    
    command - the command to set
  - getTreeId
```
public final int getTreeId()
```
    Returns:
    
    the treeId
  - setTreeId
```
public final void setTreeId(int treeId)
```
    Parameters:
    
    treeId - the treeId to set
  - getAsyncId
```
public final long getAsyncId()
```
    Returns:
    
    the asyncId
  - setAsyncId
```
public final void setAsyncId(long asyncId)
```
    Parameters:
    
    asyncId - the asyncId to set
  - getCredit
```
public final int getCredit()
```
    Returns:
    
    the credit
  - setCredit
```
public final void setCredit(int credit)
```
    Parameters:
    
    credit - the credit to set
  - getCreditCharge
```
public final int getCreditCharge()
```
    Returns:
    
    the creditCharge
  - retainPayload
```
public void retainPayload()
```
    Description copied from interface: Message
    
    Indicate that this message should retain it's raw payload
    
    Specified by:
    
    retainPayload in interface Message
  - isRetainPayload
```
public boolean isRetainPayload()
```
    Specified by:
    
    isRetainPayload in interface Message
    
    Returns:
    
    whether to retain the message payload
  - getRawPayload
```
public byte[] getRawPayload()
```
    Specified by:
    
    getRawPayload in interface Message
    
    Returns:
    
    the raw response message
  - setRawPayload
```
public void setRawPayload(byte[] rawPayload)
```
    Specified by:
    
    setRawPayload in interface Message
  - getDigest
```
public Smb2SigningDigest getDigest()
```
    Specified by:
    
    getDigest in interface CommonServerMessageBlock
    
    Returns:
    
    the signing digest
    
    See Also:
    
    CommonServerMessageBlock.getDigest()
  - setDigest
```
public void setDigest(SMBSigningDigest digest)
```
    Specified by:
    
    setDigest in interface CommonServerMessageBlock
    
    See Also:
    
    CommonServerMessageBlock.setDigest(jcifs.internal.SMBSigningDigest)
  - getStatus
```
public final int getStatus()
```
    Returns:
    
    the status
  - getSessionId
```
public long getSessionId()
```
    Returns:
    
    the sessionId
  - setSessionId
```
public final void setSessionId(long sessionId)
```
    Specified by:
    
    setSessionId in interface CommonServerMessageBlock
    
    Parameters:
    
    sessionId - the sessionId to set
  - setExtendedSecurity
```
public void setExtendedSecurity(boolean extendedSecurity)
```
    Specified by:
    
    setExtendedSecurity in interface CommonServerMessageBlock
    
    See Also:
    
    CommonServerMessageBlock.setExtendedSecurity(boolean)
  - setUid
```
public void setUid(int uid)
```
    Specified by:
    
    setUid in interface CommonServerMessageBlock
    
    See Also:
    
    CommonServerMessageBlock.setUid(int)
  - getFlags
```
public final int getFlags()
```
    Returns:
    
    the flags
  - addFlags
```
public final void addFlags(int flag)
```
    Parameters:
    
    flag -
  - clearFlags
```
public final void clearFlags(int flag)
```
    Parameters:
    
    flag -
  - getMid
```
public final long getMid()
```
    Specified by:
    
    getMid in interface CommonServerMessageBlock
    
    Returns:
    
    the mid
  - setMid
```
public final void setMid(long mid)
```
    Specified by:
    
    setMid in interface CommonServerMessageBlock
    
    Parameters:
    
    mid - the mid to set
  - chain
```
public boolean chain(ServerMessageBlock2 n)
```
    Parameters:
    
    n -
    
    Returns:
    
    whether chaining was successful
  - getResponse
```
public ServerMessageBlock2Response getResponse()
```
    Specified by:
    
    getResponse in interface CommonServerMessageBlock
    
    Returns:
    
    the response
  - setResponse
```
public void setResponse(CommonServerMessageBlockResponse msg)
```
    Specified by:
    
    setResponse in interface CommonServerMessageBlock
    
    See Also:
    
    CommonServerMessageBlock.setResponse(jcifs.internal.CommonServerMessageBlockResponse)
  - getErrorData
```
public final byte[] getErrorData()
```
    Returns:
    
    the errorData
  - getErrorContextCount
```
public final byte getErrorContextCount()
```
    Returns:
    
    the errorContextCount
  - getHeaderStart
```
public final int getHeaderStart()
```
    Returns:
    
    the headerStart
  - getLength
```
public final int getLength()
```
    Returns:
    
    the length
  - encode
```
public int encode(byte[] dst,
                  int dstIndex)
```
    Specified by:
    
    encode in interface CommonServerMessageBlock
    
    Returns:
    
    message length
  - decode
```
public int decode(byte[] buffer,
                  int bufferIndex)
           throws SMBProtocolDecodingException
```
    Description copied from interface: CommonServerMessageBlock
    
    Decode message data from the given byte array
    
    Specified by:
    
    decode in interface CommonServerMessageBlock
    
    Returns:
    
    message length
    
    Throws:
    
    SMBProtocolDecodingException
  - decode
```
public int decode(byte[] buffer,
                  int bufferIndex,
                  boolean compound)
           throws SMBProtocolDecodingException
```
    Parameters:
    
    buffer -
    
    bufferIndex -
    
    compound -
    
    Returns:
    
    decoded length
    
    Throws:
    
    SMBProtocolDecodingException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ServerMessageBlock2

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SMB2_FLAGS_SERVER_TO_REDIR

SMB2_FLAGS_ASYNC_COMMAND

SMB2_FLAGS_RELATED_OPERATIONS

SMB2_FLAGS_SIGNED

SMB2_FLAGS_PRIORITY_MASK

SMB2_FLAGS_DFS_OPERATIONS

SMB2_FLAGS_REPLAY_OPERATION

Method Detail

reset

getCommand

getNextCommandOffset

setReadSize

isAsync

setCommand

getTreeId

setTreeId

getAsyncId

setAsyncId

getCredit

setCredit

getCreditCharge

retainPayload

isRetainPayload

getRawPayload

setRawPayload

getDigest

setDigest

getStatus

getSessionId

setSessionId

setExtendedSecurity

setUid

getFlags

addFlags

clearFlags

getMid

setMid

chain

getResponse

setResponse

getErrorData

getErrorContextCount

getHeaderStart

getLength

encode

decode

decode

hashCode

equals

toString