Module jcifs

Package org.codelibs.jcifs.smb.internal

Interface RequestWithPath

All Superinterfaces:

CommonServerMessageBlock, Message

All Known Implementing Classes:

AndXServerMessageBlock, NetServerEnum2, NetServerEnum2Response, NetShareEnum, NetShareEnumResponse, NtTransNotifyChange, NtTransNotifyChangeResponse, NtTransQuerySecurityDesc, NtTransQuerySecurityDescResponse, ServerMessageBlock, Smb2CreateRequest, SmbComBlankResponse, SmbComClose, SmbComCreateDirectory, SmbComDelete, SmbComDeleteDirectory, SmbComFindClose2, SmbComLockingAndX, SmbComLogoffAndX, SmbComNegotiate, SmbComNegotiateResponse, SmbComNtCancel, SmbComNTCreateAndX, SmbComNTCreateAndXResponse, SmbComNtTransaction, SmbComNtTransactionResponse, SmbComOpenAndX, SmbComOpenAndXResponse, SmbComQueryInformation, SmbComQueryInformationResponse, SmbComReadAndX, SmbComReadAndXResponse, SmbComRename, SmbComSeek, SmbComSeekResponse, SmbComSessionSetupAndX, SmbComSessionSetupAndXResponse, SmbComSetInformation, SmbComSetInformationResponse, SmbComTransaction, SmbComTransactionResponse, SmbComTreeConnectAndX, SmbComTreeConnectAndXResponse, SmbComTreeDisconnect, SmbComWrite, SmbComWriteAndX, SmbComWriteAndXResponse, SmbComWriteResponse, Trans2FindFirst2, Trans2FindFirst2Response, Trans2FindNext2, Trans2GetDfsReferral, Trans2GetDfsReferralResponse, Trans2QueryFSInformation, Trans2QueryFSInformationResponse, Trans2QueryPathInformation, Trans2QueryPathInformationResponse, Trans2SetFileInformation, Trans2SetFileInformationResponse, TransCallNamedPipe, TransCallNamedPipeResponse, TransPeekNamedPipe, TransPeekNamedPipeResponse, TransTransactNamedPipe, TransTransactNamedPipeResponse, TransWaitNamedPipe, TransWaitNamedPipeResponse

public interface RequestWithPath
extends CommonServerMessageBlock

Interface for SMB requests that include file system path information. Provides path handling capabilities including UNC path resolution and DFS support for SMB operations that target specific files or directories on remote shares.

Author:

mbechler

Method Summary

Modifier and Type	Method	Description
String	getDomain()	Gets the domain name.
String	getFullUNCPath()	Gets the full UNC path.
String	getPath()	Gets the path to the resource.
String	getServer()	Gets the server name.
boolean	isResolveInDfs()	Checks if this request should be resolved in DFS.
void	setFullUNCPath(String domain, String server, String fullPath)	Sets the full UNC path components.
void	setPath(String path)	Sets the path to the resource.
void	setResolveInDfs(boolean resolve)	Sets whether to resolve this request path in DFS.

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.util.transport.Message

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Method Details

getPath

String getPath()

Gets the path to the resource.

Returns:

the path to the resource (below share)

getServer

String getServer()

Gets the server name.

Returns:

the server name

getDomain

String getDomain()

Gets the domain name.

Returns:

the domain name

getFullUNCPath

String getFullUNCPath()

Gets the full UNC path.

Returns:

the full UNC path

setPath

void setPath(String path)

Sets the path to the resource.

Parameters:

path - the path to set

setFullUNCPath

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

Sets the full UNC path components.

Parameters:

domain - the domain name

server - the server name

fullPath - the full UNC path

setResolveInDfs

void setResolveInDfs(boolean resolve)

Sets whether to resolve this request path in DFS.

Parameters:

resolve - true to enable DFS resolution

isResolveInDfs

boolean isResolveInDfs()

Checks if this request should be resolved in DFS.

Returns:

whether to resolve the request path in DFS