Module jcifs

Package org.codelibs.jcifs.smb.internal.smb2

Class ServerMessageBlock2Response

java.lang.Object

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Response

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockResponse, Message, Response

Direct Known Subclasses:

Smb2ChangeNotifyResponse, Smb2CloseResponse, Smb2CreateResponse, Smb2EchoResponse, Smb2FlushResponse, Smb2IoctlResponse, Smb2LockResponse, Smb2LogoffResponse, Smb2NegotiateResponse, Smb2OplockBreakNotification, Smb2QueryDirectoryResponse, Smb2QueryInfoResponse, Smb2ReadResponse, Smb2SessionSetupResponse, Smb2SetInfoResponse, Smb2TreeConnectResponse, Smb2TreeDisconnectResponse, Smb2WriteResponse

public abstract class ServerMessageBlock2Response
extends ServerMessageBlock2
implements CommonServerMessageBlockResponse

Base class for SMB2/SMB3 response messages. This abstract class provides common functionality for handling response messages in the SMB2/SMB3 protocol.

Author:

mbechler

Field Summary

Fields inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

SMB2_CANCEL, SMB2_CHANGE_NOTIFY, SMB2_CLOSE, SMB2_CREATE, SMB2_ECHO, SMB2_FLAGS_ASYNC_COMMAND, SMB2_FLAGS_DFS_OPERATIONS, SMB2_FLAGS_PRIORITY_MASK, SMB2_FLAGS_RELATED_OPERATIONS, SMB2_FLAGS_REPLAY_OPERATION, SMB2_FLAGS_SERVER_TO_REDIR, SMB2_FLAGS_SIGNED, SMB2_FLUSH, SMB2_IOCTL, SMB2_LOCK, SMB2_LOGOFF, SMB2_NEGOTIATE, SMB2_OPLOCK_BREAK, SMB2_QUERY_DIRECTORY, SMB2_QUERY_INFO, SMB2_READ, SMB2_SESSION_SETUP, SMB2_SET_INFO, SMB2_TREE_CONNECT, SMB2_TREE_DISCONNECT, SMB2_WRITE

Constructor Summary

Constructors

Constructor	Description
ServerMessageBlock2Response(Configuration config)	Constructor for SMB2 response with configuration.
ServerMessageBlock2Response(Configuration config, int command)	Constructor for SMB2 response with configuration and command.

Method Summary

Modifier and Type	Method	Description
final void	clearReceived()	Unset received status
final void	error()	Set error status
final void	exception(Exception e)	Sets an exception for this response.
final int	getErrorCode()	Gets the error status code.
Exception	getException()	Gets the exception associated with this response.
Long	getExpiration()	Gets the expiration time for this response.
int	getGrantedCredits()	Gets the number of credits granted by the server.
CommonServerMessageBlockResponse	getNextResponse()	Gets the next response in the chain.
protected void	haveResponse(byte[] buffer, int start, int len)	Called when a response has been received and decoded.
boolean	isAsyncHandled()	Checks whether the asynchronous interim response has been handled.
final boolean	isError()	Checks if the response indicates an error.
final boolean	isReceived()	Checks if the response has been received.
boolean	isSigned()	Checks whether this SMB2 response packet has been signed.
final boolean	isVerifyFailed()	Checks if signature verification failed.
void	prepare(CommonServerMessageBlockRequest next)	Prepares this response for the next request.
final void	received()	Set received status
void	reset()	Resets this message to its initial state.
void	setAsyncHandled(boolean asyncHandled)	Sets whether the asynchronous interim response has been handled.
void	setExpiration(Long exp)	Sets the expiration time for this response.
boolean	verifySignature(byte[] buffer, int i, int size)	Verifies the signature of this response.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

addFlags, chain, clearFlags, decode, decode, encode, equals, getAsyncId, getCommand, getConfig, getCredit, getCreditCharge, getDigest, getErrorContextCount, getErrorData, getFlags, getHeaderStart, getLength, getMid, getNext, getNextCommandOffset, getRawPayload, getResponse, getSessionId, getStatus, getTreeId, hashCode, isAsync, isErrorResponseStatus, isRetainPayload, pad8, readBytesWireFormat, readErrorResponse, readHeaderWireFormat, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, setResponse, setSessionId, setTreeId, setUid, size8, size8, toString, writeBytesWireFormat, writeHeaderWireFormat

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlock

decode, encode, getCommand, getDigest, getMid, getResponse, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlockResponse

isAsync

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Message

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Response

getMid, setMid

Constructor Details

ServerMessageBlock2Response

public ServerMessageBlock2Response(Configuration config,
 int command)

Constructor for SMB2 response with configuration and command.

Parameters:

config - the configuration object

command - the SMB2 command code

ServerMessageBlock2Response

public ServerMessageBlock2Response(Configuration config)

Constructor for SMB2 response with configuration.

Parameters:

config - the configuration object

Method Details

getNextResponse

public CommonServerMessageBlockResponse getNextResponse()

Gets the next response in the chain.

Specified by:

getNextResponse in interface CommonServerMessageBlockResponse

Specified by:

getNextResponse in interface Response

Returns:

the next response

See Also:

• CommonServerMessageBlockResponse.getNextResponse()

prepare

public void prepare(CommonServerMessageBlockRequest next)

Prepares this response for the next request.

Specified by:

prepare in interface CommonServerMessageBlockResponse

Parameters:

next - the next request to prepare for

See Also:

• CommonServerMessageBlockResponse.prepare(org.codelibs.jcifs.smb.internal.CommonServerMessageBlockRequest)

reset

public void reset()

Resets this message to its initial state.

Specified by:

reset in interface CommonServerMessageBlock

Specified by:

reset in interface Response

Overrides:

reset in class ServerMessageBlock2

See Also:

• ServerMessageBlock2.reset()

received

public final void received()

Set received status

Specified by:

received in interface Response

See Also:

• Response.received()

exception

public final void exception(Exception e)

Sets an exception for this response.

Specified by:

exception in interface Response

Parameters:

e - the exception to set

See Also:

• Response.exception(java.lang.Exception)

error

public final void error()

Set error status

Specified by:

error in interface Response

See Also:

• Response.error()

clearReceived

public final void clearReceived()

Unset received status

Specified by:

clearReceived in interface Response

See Also:

• Response.clearReceived()

isReceived

public final boolean isReceived()

Checks if the response has been received.

Specified by:

isReceived in interface Response

Returns:

whether the response is received

See Also:

• Response.isReceived()

isError

public final boolean isError()

Checks if the response indicates an error.

Specified by:

isError in interface Response

Returns:

whether the response is an error

See Also:

• Response.isError()

isSigned

public boolean isSigned()

Checks whether this SMB2 response packet has been signed.

Returns:

whether the packet has been signed.

getExpiration

public Long getExpiration()

Gets the expiration time for this response.

Specified by:

getExpiration in interface Response

Returns:

the message timeout

See Also:

• Response.getExpiration()

setExpiration

public void setExpiration(Long exp)

Sets the expiration time for this response.

Specified by:

setExpiration in interface Response

Parameters:

exp - the message timeout to set

See Also:

• Response.setExpiration(java.lang.Long)

isAsyncHandled

public boolean isAsyncHandled()

Checks whether the asynchronous interim response has been handled.

Returns:

whether the interim response has been handled

setAsyncHandled

public void setAsyncHandled(boolean asyncHandled)

Sets whether the asynchronous interim response has been handled.

Parameters:

asyncHandled - the asyncHandled to set

getException

public Exception getException()

Gets the exception associated with this response.

Specified by:

getException in interface Response

Returns:

an exception linked to an error

See Also:

• Response.getException()

getErrorCode

public final int getErrorCode()

Description copied from interface: Response

Gets the error status code.

Specified by:

getErrorCode in interface Response

Returns:

error status code

isVerifyFailed

public final boolean isVerifyFailed()

Description copied from interface: Response

Checks if signature verification failed.

Specified by:

isVerifyFailed in interface Response

Returns:

whether signature verification failed

getGrantedCredits

public int getGrantedCredits()

Gets the number of credits granted by the server.

Specified by:

getGrantedCredits in interface Response

Returns:

number of credits granted by the server

See Also:

• Response.getGrantedCredits()

haveResponse

protected void haveResponse(byte[] buffer,
 int start,
 int len)
                     throws SMBProtocolDecodingException

Called when a response has been received and decoded.

Overrides:

haveResponse in class ServerMessageBlock2

Parameters:

buffer - the buffer containing the response

start - the starting position in the buffer

len - the length of the response

Throws:

SMBProtocolDecodingException - if there is an error decoding the response

See Also:

• ServerMessageBlock2.haveResponse(byte[], int, int)

verifySignature

public boolean verifySignature(byte[] buffer,
 int i,
 int size)

Verifies the signature of this response.

Specified by:

verifySignature in interface Response

Parameters:

buffer - the buffer containing the signature data

i - the starting index in the buffer

size - the size of the signature data

Returns:

whether signature verification is successful

See Also:

• Response.verifySignature(byte[], int, int)