Module jcifs

Package org.codelibs.jcifs.smb.context

Class AbstractCIFSContext

java.lang.Object

java.lang.Thread

org.codelibs.jcifs.smb.context.AbstractCIFSContext

All Implemented Interfaces:

Runnable, CIFSContext

Direct Known Subclasses:

BaseContext

public abstract class AbstractCIFSContext
extends Thread
implements CIFSContext

Abstract base implementation of CIFSContext providing common functionality. This class serves as a foundation for concrete CIFS context implementations.

Author:

mbechler

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AbstractCIFSContext()	Default constructor that registers a shutdown hook for cleanup

Method Summary

Modifier and Type	Method	Description
boolean	close()	Close all connections and release resources associated with this context
Credentials	getCredentials()	Get the credentials associated with this context
protected abstract Credentials	getDefaultCredentials()	Gets the default credentials for this context.
boolean	hasDefaultCredentials()	Check if default credentials are configured
boolean	renewCredentials(String locationHint, Throwable error)	Attempt to renew credentials after authentication failure
void	run()
CIFSContext	withAnonymousCredentials()	Create a child context with anonymous credentials
CIFSContext	withCredentials(Credentials creds)	Create a child context with specified credentials
CIFSContext	withDefaultCredentials()	Create a child context with default credentials
CIFSContext	withGuestCredentials()	Create a child context with guest credentials

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codelibs.jcifs.smb.CIFSContext

get, getBufferCache, getConfig, getDfs, getNameServiceClient, getPipe, getSIDResolver, getTransportPool, getUrlHandler

Constructor Details

AbstractCIFSContext

public AbstractCIFSContext()

Default constructor that registers a shutdown hook for cleanup

Method Details

withCredentials

public CIFSContext withCredentials(Credentials creds)

Description copied from interface: CIFSContext

Create a child context with specified credentials

Specified by:

withCredentials in interface CIFSContext

Parameters:

creds - the credentials to use

Returns:

a wrapped context with the given credentials

withAnonymousCredentials

public CIFSContext withAnonymousCredentials()

Create a child context with anonymous credentials

Specified by:

withAnonymousCredentials in interface CIFSContext

Returns:

a child context using anonymous credentials

See Also:

• CIFSContext.withAnonymousCredentials()

withDefaultCredentials

public CIFSContext withDefaultCredentials()

Create a child context with default credentials

Specified by:

withDefaultCredentials in interface CIFSContext

Returns:

a child context using the configured default credentials

See Also:

• CIFSContext.withDefaultCredentials()

withGuestCredentials

public CIFSContext withGuestCredentials()

Create a child context with guest credentials

Specified by:

withGuestCredentials in interface CIFSContext

Returns:

a child context using guest credentials

See Also:

• CIFSContext.withGuestCredentials()

getCredentials

public Credentials getCredentials()

Get the credentials associated with this context

Specified by:

getCredentials in interface CIFSContext

Returns:

the used credentials

See Also:

• CIFSContext.getCredentials()

hasDefaultCredentials

public boolean hasDefaultCredentials()

Check if default credentials are configured

Specified by:

hasDefaultCredentials in interface CIFSContext

Returns:

whether default credentials are available

See Also:

• CIFSContext.hasDefaultCredentials()

getDefaultCredentials

protected abstract Credentials getDefaultCredentials()

Gets the default credentials for this context.

Returns:

the default credentials for this context

renewCredentials

public boolean renewCredentials(String locationHint,
 Throwable error)

Attempt to renew credentials after authentication failure

Specified by:

renewCredentials in interface CIFSContext

Parameters:

locationHint - URL or location hint for credential renewal

error - the error that triggered renewal

Returns:

whether new credentials are obtained

See Also:

• CIFSContext.renewCredentials(java.lang.String, java.lang.Throwable)

close

public boolean close()
              throws CIFSException

Close all connections and release resources associated with this context

Specified by:

close in interface CIFSContext

Returns:

whether any connection was still in use

Throws:

CIFSException - if an error occurs during cleanup

See Also:

• CIFSContext.close()

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

See Also:

• Thread.run()