Module jcifs

Package org.codelibs.jcifs.smb.context

Class BaseContext

java.lang.Object

java.lang.Thread

org.codelibs.jcifs.smb.context.AbstractCIFSContext

org.codelibs.jcifs.smb.context.BaseContext

All Implemented Interfaces:

Runnable, CIFSContext

Direct Known Subclasses:

SingletonContext

public class BaseContext
extends AbstractCIFSContext

Base implementation of CIFS context providing core functionality for SMB operations. This class serves as the foundation for context implementations in the jCIFS library.

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
BaseContext(Configuration config)	Construct a context

Method Summary

Modifier and Type	Method	Description
boolean	close()	Close all connections and release resources associated with this context
SmbResource	get(String url)	Get a resource
BufferCache	getBufferCache()	Get the buffer cache for efficient memory management
Configuration	getConfig()	Get the configuration object for this context
protected Credentials	getDefaultCredentials()	Gets the default credentials for this context.
DfsResolver	getDfs()	Get the DFS resolver for handling distributed file system paths
NameServiceClient	getNameServiceClient()	Get the name service client for NetBIOS name resolution
SmbPipeResource	getPipe(String url, int pipeType)	Get a pipe resource
SidResolver	getSIDResolver()	Get the SID resolver for resolving security identifiers
SmbTransportPool	getTransportPool()	Get the transport pool for managing SMB connections
URLStreamHandler	getUrlHandler()	Get a URL stream handler for SMB URLs

Methods inherited from class org.codelibs.jcifs.smb.context.AbstractCIFSContext

getCredentials, hasDefaultCredentials, renewCredentials, run, withAnonymousCredentials, withCredentials, withDefaultCredentials, withGuestCredentials

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

Constructor Details

BaseContext

public BaseContext(Configuration config)

Construct a context

Parameters:

config - configuration for the context

Method Details

get

public SmbResource get(String url)
                throws CIFSException

Get a resource

Parameters:

url - the URL of the SMB resource

Returns:

the SMB resource at the specified location

Throws:

CIFSException - if the URL is malformed or there is an error creating the SMB resource

See Also:

• CIFSContext.get(java.lang.String)

getPipe

public SmbPipeResource getPipe(String url,
 int pipeType)
                        throws CIFSException

Get a pipe resource

Parameters:

url - the URL of the SMB pipe resource

pipeType - the type of the pipe

Returns:

the SMB pipe resource at the specified location

Throws:

CIFSException - if the pipe resource cannot be accessed

See Also:

• CIFSContext.getPipe(java.lang.String, int)

getTransportPool

public SmbTransportPool getTransportPool()

Description copied from interface: CIFSContext

Get the transport pool for managing SMB connections

Returns:

the transport pool

getConfig

public Configuration getConfig()

Get the configuration object for this context

Returns:

the active configuration

See Also:

• CIFSContext.getConfig()

getDfs

public DfsResolver getDfs()

Get the DFS resolver for handling distributed file system paths

Returns:

the DFS instance for this context

See Also:

• CIFSContext.getDfs()

getNameServiceClient

public NameServiceClient getNameServiceClient()

Get the name service client for NetBIOS name resolution

Returns:

the name server client

See Also:

• CIFSContext.getNameServiceClient()

getBufferCache

public BufferCache getBufferCache()

Get the buffer cache for efficient memory management

Returns:

the buffer cache

See Also:

• CIFSContext.getBufferCache()

getUrlHandler

public URLStreamHandler getUrlHandler()

Get a URL stream handler for SMB URLs

Returns:

an URL handler using this context

See Also:

• CIFSContext.getUrlHandler()

getSIDResolver

public SidResolver getSIDResolver()

Get the SID resolver for resolving security identifiers

Returns:

the SID resolver for this context

See Also:

• CIFSContext.getSIDResolver()

getDefaultCredentials

protected Credentials getDefaultCredentials()

Gets the default credentials for this context.

Specified by:

getDefaultCredentials in class AbstractCIFSContext

Returns:

the default credentials for this context

See Also:

• AbstractCIFSContext.getDefaultCredentials()

close

public boolean close()
              throws CIFSException

Close all connections and release resources associated with this context

Specified by:

close in interface CIFSContext

Overrides:

close in class AbstractCIFSContext

Returns:

whether any connection was still in use

Throws:

CIFSException - if an error occurs during cleanup

See Also:

• CIFSContext.close()