CIFSContext (jCIFS NG 1.5.2 API)

All Known Implementing Classes:

AbstractCIFSContext, BaseContext, CIFSContextCredentialWrapper, CIFSContextWrapper, SingletonContext
```
public interface CIFSContext
```
Encapsulation of client context A context holds the client configuration, shared services as well as the active credentials. Usually you will want to create one context per client configuration and then multiple sub-contexts using different credentials (if neccessary). withDefaultCredentials(), withAnonymousCredentials(), withCredentials(SmbCredentials) allow to create such sub-contexts. Implementors of this interface should extend BaseContext or CIFSContextWrapper to get forward compatability.

Author:

mbechler

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()`
`BufferCache`	`getBufferCache()`
`Configuration`	`getConfig()`
`SmbCredentials`	`getCredentials()`
`Dfs`	`getDfs()`
`NameServiceClient`	`getNameServiceClient()`
`SidResolver`	`getSIDResolver()`
`SmbTransportPool`	`getTransportPool()`
`URLStreamHandler`	`getUrlHandler()`
`boolean`	`hasDefaultCredentials()`
`boolean`	`renewCredentials(String locationHint, Throwable error)`
`CIFSContext`	`withAnonymousCredentials()`
`CIFSContext`	`withCredentials(SmbCredentials creds)`
`CIFSContext`	`withDefaultCredentials()`
`CIFSContext`	`withGuestCrendentials()`

- Method Detail
  - close
```
void close()
    throws CIFSException
```
    Throws:
    
    CIFSException
  - getNameServiceClient
```
NameServiceClient getNameServiceClient()
```
    Returns:
    
    the name server client
  - getBufferCache
```
BufferCache getBufferCache()
```
    Returns:
    
    the buffer cache
  - getTransportPool
```
SmbTransportPool getTransportPool()
```
    Returns:
    
    the transport pool
  - getConfig
```
Configuration getConfig()
```
    Returns:
    
    the active configuration
  - getDfs
```
Dfs getDfs()
```
    Returns:
    
    the DFS instance for this context
  - getSIDResolver
```
SidResolver getSIDResolver()
```
    Returns:
    
    the SID resolver for this context
  - getCredentials
```
SmbCredentials getCredentials()
```
    Returns:
    
    the used credentials
  - getUrlHandler
```
URLStreamHandler getUrlHandler()
```
    Returns:
    
    an URL handler using this context
  - hasDefaultCredentials
```
boolean hasDefaultCredentials()
```
    Returns:
    
    whether default credentials are available
  - withDefaultCredentials
```
CIFSContext withDefaultCredentials()
```
    Returns:
    
    a child context using the configured default credentials
  - withAnonymousCredentials
```
CIFSContext withAnonymousCredentials()
```
    Returns:
    
    a child context using anonymous credentials
  - withGuestCrendentials
```
CIFSContext withGuestCrendentials()
```
    Returns:
    
    a child context using guest credentials
  - withCredentials
```
CIFSContext withCredentials(SmbCredentials creds)
```
    Parameters:
    
    creds -
    
    Returns:
    
    a child context using using the given credentials
  - renewCredentials
```
boolean renewCredentials(String locationHint,
                         Throwable error)
```
    Parameters:
    
    locationHint -
    
    error -
    
    Returns:
    
    whether new credentials are obtained

Interface CIFSContext

Method Summary

Method Detail

close

getNameServiceClient

getBufferCache

getTransportPool

getConfig

getDfs

getSIDResolver

getCredentials

getUrlHandler

hasDefaultCredentials

withDefaultCredentials

withAnonymousCredentials

withGuestCrendentials

withCredentials

renewCredentials