Package jcifs.internal.smb1

Class ServerMessageBlock

java.lang.Object

jcifs.internal.smb1.ServerMessageBlock

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, RequestWithPath, Message, Request, Response

Direct Known Subclasses:

AndXServerMessageBlock, SmbComBlankResponse, SmbComClose, SmbComCreateDirectory, SmbComDelete, SmbComDeleteDirectory, SmbComFindClose2, SmbComNegotiate, SmbComNegotiateResponse, SmbComNtCancel, SmbComQueryInformation, SmbComQueryInformationResponse, SmbComRename, SmbComSeek, SmbComSeekResponse, SmbComSetInformation, SmbComSetInformationResponse, SmbComTransaction, SmbComTransactionResponse, SmbComTreeDisconnect, SmbComWrite, SmbComWriteResponse

public abstract class ServerMessageBlock
extends Object
implements CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, RequestWithPath

Field Summary

Fields

Modifier and Type	Field	Description
protected int	batchLevel
protected int	byteCount
protected SMB1SigningDigest	digest
protected int	errorCode
protected int	flags2
protected int	headerStart
protected int	length
protected int	mid
protected String	path
protected int	pid
static byte	SMB_COM_CHECK_DIRECTORY
static byte	SMB_COM_CLOSE
static byte	SMB_COM_CREATE_DIRECTORY
static byte	SMB_COM_DELETE
static byte	SMB_COM_DELETE_DIRECTORY
static byte	SMB_COM_ECHO
static byte	SMB_COM_FIND_CLOSE2
static byte	SMB_COM_LOCKING_ANDX
static byte	SMB_COM_LOGOFF_ANDX
static byte	SMB_COM_MOVE
static byte	SMB_COM_NEGOTIATE
static byte	SMB_COM_NT_CANCEL
static byte	SMB_COM_NT_CREATE_ANDX
static byte	SMB_COM_NT_TRANSACT
static byte	SMB_COM_NT_TRANSACT_SECONDARY
static byte	SMB_COM_OPEN_ANDX
static byte	SMB_COM_QUERY_INFORMATION
static byte	SMB_COM_READ_ANDX
static byte	SMB_COM_RENAME
static byte	SMB_COM_SEEK
static byte	SMB_COM_SESSION_SETUP_ANDX
static byte	SMB_COM_SET_INFORMATION
static byte	SMB_COM_TRANSACTION
static byte	SMB_COM_TRANSACTION_SECONDARY
static byte	SMB_COM_TRANSACTION2
static byte	SMB_COM_TREE_CONNECT_ANDX
static byte	SMB_COM_TREE_DISCONNECT
static byte	SMB_COM_WRITE
static byte	SMB_COM_WRITE_ANDX
protected int	tid
protected int	uid
protected int	wordCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServerMessageBlock(Configuration config)
protected	ServerMessageBlock(Configuration config, byte command)
protected	ServerMessageBlock(Configuration config, byte command, String path)

Method Summary

Modifier and Type	Method	Description
void	addFlags2(int fl)
boolean	allowChain(CommonServerMessageBlockRequest next)
void	clearReceived()	Unset received status
CommonServerMessageBlockRequest	createCancel()
int	decode(byte[] buffer, int bufferIndex)	Decode message data from the given byte array
int	encode(byte[] dst, int dstIndex)
boolean	equals(Object obj)
void	error()	Set error status
void	exception(Exception e)
int	getByteCount()
int	getCommand()
protected Configuration	getConfig()
int	getCreditCost()
SMB1SigningDigest	getDigest()
String	getDomain()
int	getErrorCode()
Exception	getException()
Long	getExpiration()
byte	getFlags()
int	getFlags2()
String	getFullUNCPath()
int	getGrantedCredits()
int	getLength()
long	getMid()
ServerMessageBlock	getNext()
CommonServerMessageBlockResponse	getNextResponse()
Integer	getOverrideTimeout()
String	getPath()
int	getPid()
byte[]	getRawPayload()
ServerMessageBlock	getResponse()
String	getServer()
int	getSignSeq()
int	getTid()
int	getUid()
int	hashCode()
CommonServerMessageBlock	ignoreDisconnect()
boolean	isAsync()
boolean	isCancel()
boolean	isError()
boolean	isExtendedSecurity()
boolean	isForceUnicode()
boolean	isReceived()
boolean	isResolveInDfs()
protected boolean	isResponse()
boolean	isResponseAsync()
boolean	isRetainPayload()
boolean	isUseUnicode()
boolean	isVerifyFailed()
void	prepare(CommonServerMessageBlockRequest next)
protected abstract int	readBytesWireFormat(byte[] buffer, int bufferIndex)
protected int	readHeaderWireFormat(byte[] buffer, int bufferIndex)
protected abstract int	readParameterWordsWireFormat(byte[] buffer, int bufferIndex)
String	readString(byte[] src, int srcIndex)
String	readString(byte[] src, int srcIndex, int maxLen, boolean unicode)
String	readString(byte[] src, int srcIndex, int srcEnd, int maxLen, boolean unicode)
protected int	readStringLength(byte[] src, int srcIndex, int max)
void	received()	Set received status
void	remFlags2(int fl)
void	reset()
void	retainPayload()	Indicate that this message should retain it's raw payload
void	setCommand(int command)
void	setDigest(SMBSigningDigest digest)
void	setErrorCode(int errorCode)
void	setExpiration(Long exp)
void	setExtendedSecurity(boolean extendedSecurity)
void	setFlags(byte flags)
void	setFlags2(int fl)
void	setFullUNCPath(String domain, String server, String fullPath)
void	setMid(long mid)
void	setOverrideTimeout(Integer overrideTimeout)
void	setPath(String path)
void	setPid(int pid)
void	setRawPayload(byte[] rawPayload)
void	setRequestCredits(int credits)
void	setResolveInDfs(boolean resolve)
void	setResponse(CommonServerMessageBlockResponse response)
void	setSessionId(long sessionId)
void	setSignSeq(int signSeq)
void	setTid(int tid)
void	setUid(int uid)
void	setUseUnicode(boolean useUnicode)
int	size()
CommonServerMessageBlockRequest	split()
int	stringWireLength(String str, int offset)
String	toString()
boolean	verifySignature(byte[] buffer, int i, int size)
protected abstract int	writeBytesWireFormat(byte[] dst, int dstIndex)
protected int	writeHeaderWireFormat(byte[] dst, int dstIndex)
protected abstract int	writeParameterWordsWireFormat(byte[] dst, int dstIndex)
protected int	writeString(String str, byte[] dst, int dstIndex)
protected int	writeString(String str, byte[] dst, int dstIndex, boolean unicode)

Methods inherited from class java.lang.Object

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

Field Detail

SMB_COM_CREATE_DIRECTORY

public static final byte SMB_COM_CREATE_DIRECTORY

See Also:

Constant Field Values

SMB_COM_DELETE_DIRECTORY

public static final byte SMB_COM_DELETE_DIRECTORY

See Also:

Constant Field Values

SMB_COM_CLOSE

public static final byte SMB_COM_CLOSE

See Also:

Constant Field Values

SMB_COM_DELETE

public static final byte SMB_COM_DELETE

See Also:

Constant Field Values

SMB_COM_RENAME

public static final byte SMB_COM_RENAME

See Also:

Constant Field Values

SMB_COM_QUERY_INFORMATION

public static final byte SMB_COM_QUERY_INFORMATION

See Also:

Constant Field Values

SMB_COM_SET_INFORMATION

public static final byte SMB_COM_SET_INFORMATION

See Also:

Constant Field Values

SMB_COM_WRITE

public static final byte SMB_COM_WRITE

See Also:

Constant Field Values

SMB_COM_CHECK_DIRECTORY

public static final byte SMB_COM_CHECK_DIRECTORY

See Also:

Constant Field Values

SMB_COM_SEEK

public static final byte SMB_COM_SEEK

See Also:

Constant Field Values

SMB_COM_LOCKING_ANDX

public static final byte SMB_COM_LOCKING_ANDX

See Also:

Constant Field Values

SMB_COM_TRANSACTION

public static final byte SMB_COM_TRANSACTION

See Also:

Constant Field Values

SMB_COM_TRANSACTION_SECONDARY

public static final byte SMB_COM_TRANSACTION_SECONDARY

See Also:

Constant Field Values

SMB_COM_MOVE

public static final byte SMB_COM_MOVE

See Also:

Constant Field Values

SMB_COM_ECHO

public static final byte SMB_COM_ECHO

See Also:

Constant Field Values

SMB_COM_OPEN_ANDX

public static final byte SMB_COM_OPEN_ANDX

See Also:

Constant Field Values

SMB_COM_READ_ANDX

public static final byte SMB_COM_READ_ANDX

See Also:

Constant Field Values

SMB_COM_WRITE_ANDX

public static final byte SMB_COM_WRITE_ANDX

See Also:

Constant Field Values

SMB_COM_TRANSACTION2

public static final byte SMB_COM_TRANSACTION2

See Also:

Constant Field Values

SMB_COM_FIND_CLOSE2

public static final byte SMB_COM_FIND_CLOSE2

See Also:

Constant Field Values

SMB_COM_TREE_DISCONNECT

public static final byte SMB_COM_TREE_DISCONNECT

See Also:

Constant Field Values

SMB_COM_NEGOTIATE

public static final byte SMB_COM_NEGOTIATE

See Also:

Constant Field Values

SMB_COM_SESSION_SETUP_ANDX

public static final byte SMB_COM_SESSION_SETUP_ANDX

See Also:

Constant Field Values

SMB_COM_LOGOFF_ANDX

public static final byte SMB_COM_LOGOFF_ANDX

See Also:

Constant Field Values

SMB_COM_TREE_CONNECT_ANDX

public static final byte SMB_COM_TREE_CONNECT_ANDX

See Also:

Constant Field Values

SMB_COM_NT_TRANSACT

public static final byte SMB_COM_NT_TRANSACT

See Also:

Constant Field Values

SMB_COM_NT_CANCEL

public static final byte SMB_COM_NT_CANCEL

See Also:

Constant Field Values

SMB_COM_NT_TRANSACT_SECONDARY

public static final byte SMB_COM_NT_TRANSACT_SECONDARY

See Also:

Constant Field Values

SMB_COM_NT_CREATE_ANDX

public static final byte SMB_COM_NT_CREATE_ANDX

See Also:

Constant Field Values

headerStart

protected int headerStart

length

protected int length

batchLevel

protected int batchLevel

errorCode

protected int errorCode

flags2

protected int flags2

pid

protected int pid

uid

protected int uid

mid

protected int mid

wordCount

protected int wordCount

byteCount

protected int byteCount

tid

protected int tid

path

protected String path

digest

protected SMB1SigningDigest digest

Constructor Detail

ServerMessageBlock

protected ServerMessageBlock(Configuration config)

ServerMessageBlock

protected ServerMessageBlock(Configuration config,
                             byte command)

ServerMessageBlock

protected ServerMessageBlock(Configuration config,
                             byte command,
                             String path)

Method Detail

size

public int size()

Specified by:

size in interface CommonServerMessageBlockRequest

Returns:

the size of this message

See Also:

CommonServerMessageBlockRequest.size()

isAsync

public boolean isAsync()

Specified by:

isAsync in interface CommonServerMessageBlockResponse

Returns:

is an async response

See Also:

CommonServerMessageBlockResponse.isAsync()

isResponseAsync

public boolean isResponseAsync()

Specified by:

isResponseAsync in interface CommonServerMessageBlockRequest

Returns:

request was handled asynchronously

See Also:

CommonServerMessageBlockRequest.isResponseAsync()

getOverrideTimeout

public final Integer getOverrideTimeout()

Specified by:

getOverrideTimeout in interface CommonServerMessageBlockRequest

Returns:

custom response timeout for this request

See Also:

CommonServerMessageBlockRequest.getOverrideTimeout()

setOverrideTimeout

public final void setOverrideTimeout(Integer overrideTimeout)

Parameters:

overrideTimeout - the overrideTimeout to set

getNext

public ServerMessageBlock getNext()

Specified by:

getNext in interface CommonServerMessageBlockRequest

Specified by:

getNext in interface Request

Returns:

next chained message

See Also:

CommonServerMessageBlockRequest.getNext()

allowChain

public boolean allowChain(CommonServerMessageBlockRequest next)

Specified by:

allowChain in interface CommonServerMessageBlockRequest

Returns:

whether to allow chaining

See Also:

CommonServerMessageBlockRequest.allowChain(jcifs.internal.CommonServerMessageBlockRequest)

split

public CommonServerMessageBlockRequest split()

Specified by:

split in interface CommonServerMessageBlockRequest

Returns:

the following message

See Also:

CommonServerMessageBlockRequest.split()

createCancel

public CommonServerMessageBlockRequest createCancel()

Specified by:

createCancel in interface CommonServerMessageBlockRequest

Returns:

create cancel request

See Also:

CommonServerMessageBlockRequest.createCancel()

getNextResponse

public CommonServerMessageBlockResponse getNextResponse()

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)

Specified by:

prepare in interface CommonServerMessageBlockResponse

See Also:

CommonServerMessageBlockResponse.prepare(jcifs.internal.CommonServerMessageBlockRequest)

getCreditCost

public int getCreditCost()

Specified by:

getCreditCost in interface Request

Returns:

number of credits this request requires

See Also:

Request.getCreditCost()

getGrantedCredits

public int getGrantedCredits()

Specified by:

getGrantedCredits in interface Response

Returns:

number of credits granted by the server

See Also:

Response.getGrantedCredits()

setRequestCredits

public void setRequestCredits(int credits)

Specified by:

setRequestCredits in interface Request

See Also:

Request.setRequestCredits(int)

getCommand

public final int getCommand()

Specified by:

getCommand in interface CommonServerMessageBlock

Returns:

the command

setCommand

public final void setCommand(int command)

Specified by:

setCommand in interface CommonServerMessageBlock

Parameters:

command - the command to set

getByteCount

public final int getByteCount()

Returns:

the byteCount

getLength

public final int getLength()

Returns:

the length

isForceUnicode

public boolean isForceUnicode()

Returns:

the forceUnicode

getFlags

public final byte getFlags()

Returns:

the flags

setFlags

public final void setFlags(byte flags)

Parameters:

flags - the flags to set

getFlags2

public final int getFlags2()

Returns:

the flags2

setFlags2

public final void setFlags2(int fl)

Parameters:

fl - the flags2 to set

addFlags2

public final void addFlags2(int fl)

Parameters:

fl -

remFlags2

public final void remFlags2(int fl)

Parameters:

fl -

setResolveInDfs

public void setResolveInDfs(boolean resolve)

Specified by:

setResolveInDfs in interface RequestWithPath

See Also:

RequestWithPath.setResolveInDfs(boolean)

isResolveInDfs

public boolean isResolveInDfs()

Specified by:

isResolveInDfs in interface RequestWithPath

Returns:

whether to resolve the request path in DFS

See Also:

RequestWithPath.isResolveInDfs()

getErrorCode

public final int getErrorCode()

Specified by:

getErrorCode in interface Response

Returns:

the errorCode

setErrorCode

public final void setErrorCode(int errorCode)

Parameters:

errorCode - the errorCode to set

getPath

public final String getPath()

Specified by:

getPath in interface RequestWithPath

Returns:

the path

getFullUNCPath

public String getFullUNCPath()

Specified by:

getFullUNCPath in interface RequestWithPath

Returns:

the full UNC path

See Also:

RequestWithPath.getFullUNCPath()

getDomain

public String getDomain()

Specified by:

getDomain in interface RequestWithPath

Returns:

the domain name

See Also:

RequestWithPath.getDomain()

getServer

public String getServer()

Specified by:

getServer in interface RequestWithPath

Returns:

the server name

See Also:

RequestWithPath.getServer()

setFullUNCPath

public void setFullUNCPath(String domain,
                           String server,
                           String fullPath)

Specified by:

setFullUNCPath in interface RequestWithPath

See Also:

RequestWithPath.setFullUNCPath(java.lang.String, java.lang.String, java.lang.String)

setPath

public final void setPath(String path)

Specified by:

setPath in interface RequestWithPath

Parameters:

path - the path to set

getDigest

public final SMB1SigningDigest getDigest()

Specified by:

getDigest in interface CommonServerMessageBlock

Returns:

the digest

setDigest

public final void setDigest(SMBSigningDigest digest)

Specified by:

setDigest in interface CommonServerMessageBlock

Parameters:

digest - the digest to set

isExtendedSecurity

public boolean isExtendedSecurity()

Returns:

the extendedSecurity

setSessionId

public final void setSessionId(long sessionId)

Specified by:

setSessionId in interface CommonServerMessageBlock

setExtendedSecurity

public void setExtendedSecurity(boolean extendedSecurity)

Specified by:

setExtendedSecurity in interface CommonServerMessageBlock

Parameters:

extendedSecurity - the extendedSecurity to set

isUseUnicode

public final boolean isUseUnicode()

Returns:

the useUnicode

setUseUnicode

public final void setUseUnicode(boolean useUnicode)

Parameters:

useUnicode - the useUnicode to set

isReceived

public final boolean isReceived()

Specified by:

isReceived in interface Response

Returns:

the received

clearReceived

public final void clearReceived()

Description copied from interface: Response

Unset received status

Specified by:

clearReceived in interface Response

received

public void received()

Set received status

Specified by:

received in interface Response

See Also:

Response.received()

exception

public void exception(Exception e)

Specified by:

exception in interface Response

See Also:

Response.exception(java.lang.Exception)

error

public void error()

Set error status

Specified by:

error in interface Response

See Also:

Response.error()

getResponse

public ServerMessageBlock getResponse()

Specified by:

getResponse in interface CommonServerMessageBlock

Specified by:

getResponse in interface Request

Returns:

the response

ignoreDisconnect

public CommonServerMessageBlock ignoreDisconnect()

Returns:

null

setResponse

public final void setResponse(CommonServerMessageBlockResponse response)

Specified by:

setResponse in interface CommonServerMessageBlock

Parameters:

response - the response to set

isCancel

public boolean isCancel()

Specified by:

isCancel in interface Request

Returns:

whether this is a cancel request

See Also:

Request.isCancel()

getMid

public final long getMid()

Specified by:

getMid in interface CommonServerMessageBlock

Specified by:

getMid in interface Response

Returns:

the mid

setMid

public final void setMid(long mid)

Specified by:

setMid in interface CommonServerMessageBlock

Specified by:

setMid in interface Response

Parameters:

mid - the mid to set

getTid

public final int getTid()

Returns:

the tid

setTid

public final void setTid(int tid)

Specified by:

setTid in interface CommonServerMessageBlockRequest

Parameters:

tid - the tid to set

getPid

public final int getPid()

Returns:

the pid

setPid

public final void setPid(int pid)

Parameters:

pid - the pid to set

getUid

public final int getUid()

Returns:

the uid

setUid

public final void setUid(int uid)

Specified by:

setUid in interface CommonServerMessageBlock

Parameters:

uid - the uid to set

getSignSeq

public int getSignSeq()

Returns:

the signSeq

setSignSeq

public final void setSignSeq(int signSeq)

Parameters:

signSeq - the signSeq to set

isVerifyFailed

public boolean isVerifyFailed()

Specified by:

isVerifyFailed in interface Response

Returns:

the verifyFailed

getException

public Exception getException()

Specified by:

getException in interface Response

Returns:

an exception linked to an error

See Also:

Response.getException()

isError

public boolean isError()

Specified by:

isError in interface Response

Returns:

whether the response is an error

See Also:

Response.isError()

getRawPayload

public byte[] getRawPayload()

Specified by:

getRawPayload in interface Message

Returns:

the raw response message

See Also:

Message.getRawPayload()

setRawPayload

public void setRawPayload(byte[] rawPayload)

Specified by:

setRawPayload in interface Message

See Also:

Message.setRawPayload(byte[])

isRetainPayload

public boolean isRetainPayload()

Specified by:

isRetainPayload in interface Message

Returns:

whether to retain the message payload

See Also:

Message.isRetainPayload()

retainPayload

public void retainPayload()

Indicate that this message should retain it's raw payload

Specified by:

retainPayload in interface Message

See Also:

Message.retainPayload()

getExpiration

public Long getExpiration()

Specified by:

getExpiration in interface Response

Returns:

the message timeout

See Also:

Response.getExpiration()

setExpiration

public void setExpiration(Long exp)

Specified by:

setExpiration in interface Response

Parameters:

exp - message timeout

See Also:

Response.setExpiration(java.lang.Long)

getConfig

protected final Configuration getConfig()

Returns:

the config

reset

public void reset()

Specified by:

reset in interface CommonServerMessageBlock

Specified by:

reset in interface Response

verifySignature

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

Specified by:

verifySignature in interface Response

Returns:

whether signature verification is successful

See Also:

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

writeString

protected int writeString(String str,
                          byte[] dst,
                          int dstIndex)

writeString

protected int writeString(String str,
                          byte[] dst,
                          int dstIndex,
                          boolean unicode)

readString

public String readString(byte[] src,
                         int srcIndex)

Parameters:

src -

srcIndex -

Returns:

read string

readString

public String readString(byte[] src,
                         int srcIndex,
                         int maxLen,
                         boolean unicode)

Parameters:

src -

srcIndex -

maxLen -

unicode -

Returns:

read string

readString

public String readString(byte[] src,
                         int srcIndex,
                         int srcEnd,
                         int maxLen,
                         boolean unicode)

Parameters:

src -

srcIndex -

srcEnd -

maxLen -

unicode -

Returns:

read string

stringWireLength

public int stringWireLength(String str,
                            int offset)

Parameters:

str -

offset -

Returns:

string length

readStringLength

protected int readStringLength(byte[] src,
                               int srcIndex,
                               int max)

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

writeHeaderWireFormat

protected int writeHeaderWireFormat(byte[] dst,
                                    int dstIndex)

readHeaderWireFormat

protected int readHeaderWireFormat(byte[] buffer,
                                   int bufferIndex)

isResponse

protected boolean isResponse()

writeParameterWordsWireFormat

protected abstract int writeParameterWordsWireFormat(byte[] dst,
                                                     int dstIndex)

writeBytesWireFormat

protected abstract int writeBytesWireFormat(byte[] dst,
                                            int dstIndex)

readParameterWordsWireFormat

protected abstract int readParameterWordsWireFormat(byte[] buffer,
                                                    int bufferIndex)

readBytesWireFormat

protected abstract int readBytesWireFormat(byte[] buffer,
                                           int bufferIndex)
                                    throws SMBProtocolDecodingException

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