Module jcifs

Package org.codelibs.jcifs.smb.internal.dfs

Class DfsReferralDataImpl

java.lang.Object

org.codelibs.jcifs.smb.internal.dfs.DfsReferralDataImpl

All Implemented Interfaces:

DfsReferralData, DfsReferralDataInternal

public class DfsReferralDataImpl
extends Object
implements DfsReferralDataInternal

Implementation of DFS referral data for internal use. Provides concrete implementation of DFS referral information including server details, share paths, expiration handling, and referral management for DFS path resolution.

Author:

mbechler

Constructor Summary

Constructors

Constructor	Description
DfsReferralDataImpl()	Constructs a new DfsReferralDataImpl instance

Method Summary

Modifier and Type	Method	Description
void	append(DfsReferralDataInternal dr)	Append another referral to this referral chain
DfsReferralDataInternal	combine(DfsReferralData n)	Combine this referral with another to form a chain
boolean	equals(Object obj)
void	fixupDomain(String dom)	Possibly appends the given domain name to the host name if it is currently unqualified
void	fixupHost(String fqdn)	Replaces the host with the given FQDN if it is currently unqualified
static DfsReferralDataImpl	fromReferral(Referral ref, String reqPath, long expire, int consumed)	Set the referral data from a referral response
String	getDomain()	Get the domain this referral is for
long	getExpiration()	Get the expiration time of this referral entry
int	getFlags()	Get the referral flags
String	getKey()	Get the cache key for this referral
String	getLink()	Get the complete UNC path link for this referral
String	getPath()	Get the replacement path for this referral
int	getPathConsumed()	Get the number of characters from the UNC path that were consumed by this referral
String	getServer()	Get the server this referral points to
String	getShare()	Get the share this referral points to
long	getTtl()	Get the time to live for this referral
int	hashCode()
void	intermediate()	Mark this referral as intermediate (requires further resolution)
boolean	isIntermediate()	Check if this referral needs to be resolved further
boolean	isResolveHashes()	Not exactly sure what that is all about, certainly legacy stuff
DfsReferralDataImpl	next()	Get the next referral in the chain
void	replaceCache()	Replaces the entry with key in the cache map with this referral
void	setCacheMap(Map<String,DfsReferralDataInternal> map)	Set the cache map for this referral
void	setDomain(String domain)	Set the domain for this referral
void	setKey(String key)	Set the cache key for this referral
void	setLink(String link)	Set the UNC path link for this referral
void	stripPathConsumed(int i)	Reduces path consumed by the given value
String	toString()
<T extends DfsReferralData> T	unwrap(Class<T> type)	Unwrap the referral data to a specific implementation type

Methods inherited from class java.lang.Object

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

Constructor Details

DfsReferralDataImpl

public DfsReferralDataImpl()

Constructs a new DfsReferralDataImpl instance

Method Details

unwrap

public <T extends DfsReferralData> T unwrap(Class<T> type)

Unwrap the referral data to a specific implementation type

Specified by:

unwrap in interface DfsReferralData

Type Parameters:

T - the target type to unwrap to

Parameters:

type - the class of the target type

Returns:

the referral adapted to type

See Also:

• DfsReferralData.unwrap(java.lang.Class)

getExpiration

public long getExpiration()

Description copied from interface: DfsReferralData

Get the expiration time of this referral entry

Specified by:

getExpiration in interface DfsReferralData

Returns:

the expiration time of this entry

getPathConsumed

public int getPathConsumed()

Description copied from interface: DfsReferralData

Get the number of characters from the UNC path that were consumed by this referral

Specified by:

getPathConsumed in interface DfsReferralData

Returns:

the number of characters from the unc path that were consumed by this referral

getDomain

public String getDomain()

Get the domain this referral is for

Specified by:

getDomain in interface DfsReferralData

Returns:

the domain this referral is for

See Also:

• DfsReferralData.getDomain()

setDomain

public void setDomain(String domain)

Set the domain for this referral

Parameters:

domain - the domain to set

getLink

public String getLink()

Description copied from interface: DfsReferralData

Get the complete UNC path link for this referral

Specified by:

getLink in interface DfsReferralData

Returns:

the link

setLink

public void setLink(String link)

Description copied from interface: DfsReferralDataInternal

Set the UNC path link for this referral

Specified by:

setLink in interface DfsReferralDataInternal

Parameters:

link - the UNC path link to set

getKey

public String getKey()

Description copied from interface: DfsReferralDataInternal

Get the cache key for this referral

Specified by:

getKey in interface DfsReferralDataInternal

Returns:

the key

setKey

public void setKey(String key)

Description copied from interface: DfsReferralDataInternal

Set the cache key for this referral

Specified by:

setKey in interface DfsReferralDataInternal

Parameters:

key - the key to set

getServer

public String getServer()

Description copied from interface: DfsReferralData

Get the server this referral points to

Specified by:

getServer in interface DfsReferralData

Returns:

the server this referral points to

getShare

public String getShare()

Description copied from interface: DfsReferralData

Get the share this referral points to

Specified by:

getShare in interface DfsReferralData

Returns:

the share this referral points to

getPath

public String getPath()

Description copied from interface: DfsReferralData

Get the replacement path for this referral

Specified by:

getPath in interface DfsReferralData

Returns:

the replacement path for this referal

getFlags

public int getFlags()

Get the referral flags

Returns:

the rflags

setCacheMap

public void setCacheMap(Map<String,DfsReferralDataInternal> map)

Set the cache map for this referral

Specified by:

setCacheMap in interface DfsReferralDataInternal

Parameters:

map - the cache map to associate with this referral

See Also:

• DfsReferralDataInternal.setCacheMap(java.util.Map)

replaceCache

public void replaceCache()

Replaces the entry with key in the cache map with this referral

Specified by:

replaceCache in interface DfsReferralDataInternal

See Also:

• DfsReferralDataInternal.replaceCache()

next

public DfsReferralDataImpl next()

Description copied from interface: DfsReferralData

Get the next referral in the chain

Specified by:

next in interface DfsReferralData

Specified by:

next in interface DfsReferralDataInternal

Returns:

pointer to next referral, points to self if there is no further referral

append

public void append(DfsReferralDataInternal dr)

Append another referral to this referral chain

Specified by:

append in interface DfsReferralDataInternal

Parameters:

dr - the referral to append

stripPathConsumed

public void stripPathConsumed(int i)

Reduces path consumed by the given value

Specified by:

stripPathConsumed in interface DfsReferralDataInternal

Parameters:

i - the number of characters to strip from path consumed

See Also:

• DfsReferralDataInternal.stripPathConsumed(int)

fixupDomain

public void fixupDomain(String dom)

Description copied from interface: DfsReferralDataInternal

Possibly appends the given domain name to the host name if it is currently unqualified

Specified by:

fixupDomain in interface DfsReferralDataInternal

Parameters:

dom - the domain name to append

fixupHost

public void fixupHost(String fqdn)

Description copied from interface: DfsReferralDataInternal

Replaces the host with the given FQDN if it is currently unqualified

Specified by:

fixupHost in interface DfsReferralDataInternal

Parameters:

fqdn - the fully qualified domain name to use

isResolveHashes

public boolean isResolveHashes()

Description copied from interface: DfsReferralDataInternal

Not exactly sure what that is all about, certainly legacy stuff

Specified by:

isResolveHashes in interface DfsReferralDataInternal

Returns:

the resolveHashes

intermediate

public void intermediate()

Mark this referral as intermediate (requires further resolution)

isIntermediate

public boolean isIntermediate()

Description copied from interface: DfsReferralDataInternal

Check if this referral needs to be resolved further

Specified by:

isIntermediate in interface DfsReferralDataInternal

Returns:

the intermediate

toString

public String toString()

Overrides:

toString in class Object

getTtl

public long getTtl()

Get the time to live for this referral

Returns:

the ttl

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

fromReferral

public static DfsReferralDataImpl fromReferral(Referral ref,
 String reqPath,
 long expire,
 int consumed)

Set the referral data from a referral response

Parameters:

ref - the referral response

reqPath - the requested path

expire - the expiration time

consumed - the number of characters consumed from the path

Returns:

referral data

combine

public DfsReferralDataInternal combine(DfsReferralData n)

Combine this referral with another to form a chain

Specified by:

combine in interface DfsReferralDataInternal

Parameters:

n - the referral to combine with

Returns:

new referral, combining a chain of referrals

See Also:

• DfsReferralDataInternal.combine(org.codelibs.jcifs.smb.DfsReferralData)