Module jcifs

Package org.codelibs.jcifs.smb.internal.smb1.com

Class SmbComTreeConnectAndXResponse

java.lang.Object

org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

org.codelibs.jcifs.smb.internal.smb1.AndXServerMessageBlock

org.codelibs.jcifs.smb.internal.smb1.com.SmbComTreeConnectAndXResponse

All Implemented Interfaces:

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

public class SmbComTreeConnectAndXResponse
extends AndXServerMessageBlock
implements TreeConnectResponse

SMB1 Tree Connect AndX response implementation. Handles server responses to tree connect requests in SMB1 protocol, providing information about the connected share including service type and DFS capabilities.

Author:

mbechler

Field Summary

Fields inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

batchLevel, byteCount, digest, errorCode, flags2, headerStart, length, mid, path, pid, SMB_COM_CHECK_DIRECTORY, SMB_COM_CLOSE, SMB_COM_CREATE_DIRECTORY, SMB_COM_DELETE, SMB_COM_DELETE_DIRECTORY, SMB_COM_ECHO, SMB_COM_FIND_CLOSE2, SMB_COM_LOCKING_ANDX, SMB_COM_LOGOFF_ANDX, SMB_COM_MOVE, SMB_COM_NEGOTIATE, SMB_COM_NT_CANCEL, SMB_COM_NT_CREATE_ANDX, SMB_COM_NT_TRANSACT, SMB_COM_NT_TRANSACT_SECONDARY, SMB_COM_OPEN_ANDX, SMB_COM_QUERY_INFORMATION, SMB_COM_READ_ANDX, SMB_COM_RENAME, SMB_COM_SEEK, SMB_COM_SESSION_SETUP_ANDX, SMB_COM_SET_INFORMATION, SMB_COM_TRANSACTION, SMB_COM_TRANSACTION_SECONDARY, SMB_COM_TRANSACTION2, SMB_COM_TREE_CONNECT_ANDX, SMB_COM_TREE_DISCONNECT, SMB_COM_WRITE, SMB_COM_WRITE_ANDX, tid, uid, wordCount

Constructor Summary

Constructors

Constructor	Description
SmbComTreeConnectAndXResponse(Configuration config, ServerMessageBlock andx)	Constructs a tree connect AndX response.

Method Summary

Modifier and Type	Method	Description
final String	getNativeFileSystem()	Returns the native file system type of the connected share.
final String	getService()	Returns the service type of the connected share (e.g., A: for disk, LPT1: for printer, IPC for named pipe).
final boolean	isShareDfs()	Indicates whether the connected share is part of a Distributed File System (DFS) namespace.
final boolean	isSupportSearchBits()	Indicates whether the share supports search operations with search bits.
boolean	isValidTid()	Indicates whether the tree connection has been successfully established and has a valid tree ID.
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the data bytes portion of the SMB message from the wire format.
protected int	readParameterWordsWireFormat(byte[] buffer, int bufferIndex)	Reads the parameter words portion of the SMB message from the wire format.
String	toString()
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the data bytes portion of the SMB message to the wire format.
protected int	writeParameterWordsWireFormat(byte[] dst, int dstIndex)	Writes the parameter words portion of the SMB message to the wire format.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb1.AndXServerMessageBlock

decode, encode, getAndx, getBatchLimit, getNext, getNextResponse, readAndXWireFormat, writeAndXWireFormat

Methods inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

addFlags2, allowChain, clearReceived, createCancel, equals, error, exception, getByteCount, getCommand, getConfig, getCreditCost, getDigest, getDomain, getErrorCode, getException, getExpiration, getFlags, getFlags2, getFullUNCPath, getGrantedCredits, getLength, getMid, getOverrideTimeout, getPath, getPid, getRawPayload, getResponse, getServer, getSignSeq, getTid, getUid, hashCode, ignoreDisconnect, isAsync, isCancel, isError, isExtendedSecurity, isForceUnicode, isReceived, isResolveInDfs, isResponse, isResponseAsync, isRetainPayload, isUseUnicode, isVerifyFailed, prepare, readHeaderWireFormat, readString, readString, readString, readStringLength, received, remFlags2, reset, retainPayload, setCommand, setDigest, setErrorCode, setExpiration, setExtendedSecurity, setFlags, setFlags2, setFullUNCPath, setMid, setOverrideTimeout, setPath, setPid, setRawPayload, setRequestCredits, setResolveInDfs, setResponse, setSessionId, setSignSeq, setTid, setUid, setUseUnicode, size, split, stringWireLength, verifySignature, writeHeaderWireFormat, writeString, writeString

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, reset, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

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

getNextResponse, isAsync, prepare

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

clearReceived, error, exception, getErrorCode, getException, getExpiration, getGrantedCredits, getMid, isError, isReceived, isVerifyFailed, received, reset, setExpiration, setMid, verifySignature

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

getTid

Constructor Details

SmbComTreeConnectAndXResponse

public SmbComTreeConnectAndXResponse(Configuration config,
 ServerMessageBlock andx)

Constructs a tree connect AndX response.

Parameters:

config - the configuration to use

andx - the next command in the AndX chain, or null

Method Details

getService

public final String getService()

Description copied from interface: TreeConnectResponse

Returns the service type of the connected share (e.g., A: for disk, LPT1: for printer, IPC for named pipe).

Specified by:

getService in interface TreeConnectResponse

Returns:

the service

getNativeFileSystem

public final String getNativeFileSystem()

Returns the native file system type of the connected share.

Returns:

the nativeFileSystem

isSupportSearchBits

public final boolean isSupportSearchBits()

Indicates whether the share supports search operations with search bits.

Returns:

the supportSearchBits

isShareDfs

public final boolean isShareDfs()

Description copied from interface: TreeConnectResponse

Indicates whether the connected share is part of a Distributed File System (DFS) namespace.

Specified by:

isShareDfs in interface TreeConnectResponse

Returns:

the shareIsInDfs

isValidTid

public boolean isValidTid()

Indicates whether the tree connection has been successfully established and has a valid tree ID.

Specified by:

isValidTid in interface TreeConnectResponse

Returns:

whether the tree id is a valid one

See Also:

• TreeConnectResponse.isValidTid()

writeParameterWordsWireFormat

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

Description copied from class: ServerMessageBlock

Writes the parameter words portion of the SMB message to the wire format.

Specified by:

writeParameterWordsWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

writeBytesWireFormat

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

Description copied from class: ServerMessageBlock

Writes the data bytes portion of the SMB message to the wire format.

Specified by:

writeBytesWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

readParameterWordsWireFormat

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

Description copied from class: ServerMessageBlock

Reads the parameter words portion of the SMB message from the wire format.

Specified by:

readParameterWordsWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

readBytesWireFormat

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

Description copied from class: ServerMessageBlock

Reads the data bytes portion of the SMB message from the wire format.

Specified by:

readBytesWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

toString

public String toString()

Overrides:

toString in class AndXServerMessageBlock