Configuration (jCIFS NG 2.0.6 API)

All Known Implementing Classes:

BaseConfiguration, DelegatingConfiguration, PropertyConfiguration
```
public interface Configuration
```
Implementors of this interface should extend BaseConfiguration or DelegatingConfiguration to get forward compatibility.

Author:

mbechler

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getAttributeCacheTimeout()` Property `jcifs.smb.client.attrExpirationPeriod` (int, 5000)
`int`	`getBatchLimit(String cmd)`
`InetAddress`	`getBroadcastAddress()` Property `jcifs.netbios.baddr` (string, default `255.255.255.255`)
`int`	`getBufferCacheSize()` Property `jcifs.smb.maxBuffers` (int, default 16)
`int`	`getCapabilities()` Property `jcifs.smb.client.capabilities` (int)
`int`	`getConnTimeout()` Property `jcifs.smb.client.connTimeout` (int, default 35000)
`String`	`getDefaultDomain()` Property `jcifs.smb.client.domain`
`String`	`getDefaultPassword()` Property `jcifs.smb.client.password`
`String`	`getDefaultUsername()` Property `jcifs.smb.client.username`
`long`	`getDfsTtl()` Property `jcifs.smb.client.dfs.ttl` (int, default 300)
`int`	`getFlags2()` Property `jcifs.smb.client.flags2` (int)
`int`	`getLanManCompatibility()` Lanman compatibility level 0 or 1 LM and NTLM 2 NTLM only 3-5 NTLMv2 only Property `jcifs.smb.lmCompatibility` (int, default 3)
`int`	`getListCount()` Property `jcifs.smb.client.listCount` (int, default 200)
`int`	`getListSize()` Property `jcifs.smb.client.listSize` (int, default 65535)
`String`	`getLmHostsFileName()` Property `jcifs.netbios.lmhosts` (string)
`InetAddress`	`getLocalAddr()` Property `jcifs.smb.client.laddr` (string)
`int`	`getLocalPort()` Property `jcifs.smb.client.lport` (int)
`TimeZone`	`getLocalTimezone()`
`String`	`getLogonShare()` Property `jcifs.smb.client.logonShare`
`int`	`getMaximumBufferSize()`
`int`	`getMaxMpxCount()` Property `jcifs.smb.client.maxMpxCount` (int, default 10)
`int`	`getMaxRequestRetries()` Property `jcifs.smb.client.maxRequestRetries` (int, default 2)
`String`	`getNativeLanman()` Property `jcifs.smb.client.nativeLanMan` (string, default `jCIFS`)
`String`	`getNativeOs()` Property `jcifs.smb.client.nativeOs` (string, default `os.name`)
`int`	`getNetbiosCachePolicy()` Property `jcifs.netbios.cachePolicy` in minutes (int, default 600)
`String`	`getNetbiosHostname()` Property `jcifs.netbios.hostname` (string)
`InetAddress`	`getNetbiosLocalAddress()` Property `jcifs.netbios.laddr` (string)
`int`	`getNetbiosLocalPort()` Property `jcifs.netbios.lport` (int)
`int`	`getNetbiosRcvBufSize()` Property `jcifs.netbios.rcv_buf_size` (int, default 576)
`int`	`getNetbiosRetryCount()` Property `jcifs.netbios.retryCount` (int, default 2)
`int`	`getNetbiosRetryTimeout()` Property `jcifs.netbios.retryTimeout` (int, default 3000)
`String`	`getNetbiosScope()` Property `jcifs.netbios.scope` (string)
`int`	`getNetbiosSndBufSize()` Property `jcifs.netbios.snd_buf_size` (int, default 576)
`int`	`getNetbiosSoTimeout()` Property `jcifs.netbios.soTimeout` (int, default 5000)
`int`	`getNotifyBufferSize()` Property `jcifs.smb.client.notify_buf_size` (int, default 1024)
`String`	`getOemEncoding()` Property `jcifs.encoding` (string, default `Cp850`)
`int`	`getPid()`
`SecureRandom`	`getRandom()`
`int`	`getRecieveBufferSize()` Property `jcifs.smb.client.rcv_buf_size` (int, default 65535)
`List<ResolverType>`	`getResolveOrder()` Property `jcifs.resolveOrder` (string, default `LMHOSTS,DNS,WINS,BCAST`)
`int`	`getResponseTimeout()` Property `jcifs.smb.client.responseTimeout` (int, default 30000)
`int`	`getSendBufferSize()` Property `jcifs.smb.client.snd_buf_size` (int, default 65535)
`int`	`getSessionLimit()` Property `jcifs.smb.client.ssnLimit` (int, 250)
`int`	`getSessionTimeout()` Property `jcifs.smb.client.sessionTimeout` (int, default 35000)
`int`	`getSoTimeout()` Property `jcifs.smb.client.soTimeout` (int, default 35000)
`String[]`	`getSupportedDialects()`
`int`	`getTransactionBufferSize()` Property `jcifs.smb.client.transaction_buf_size` (int, default 65535)
`int`	`getVcNumber()`
`InetAddress[]`	`getWinsServers()` Property `jcifs.netbios.wins` (string, comma separated)
`boolean`	`isAllowCompound(String command)`
`boolean`	`isAllowNTLMFallback()` Property `jcifs.smb.allowNTLMFallback` (boolean, default true)
`boolean`	`isDfsConvertToFQDN()` Enable hack to make kerberos auth work with DFS sending short names This works by appending the domain name to the netbios short name and will fail horribly if this mapping is not correct for your domain.
`boolean`	`isDfsDisabled()` Property `jcifs.smb.client.dfs.disabled` (boolean, default false)
`boolean`	`isDfsStrictView()` Property `jcifs.smb.client.dfs.strictView` (boolean, default false)
`boolean`	`isDisablePlainTextPasswords()` Property `jcifs.smb.client.disablePlainTextPasswords` (boolean, default true)
`boolean`	`isDisableSMB1()` Disables SMB1 support Property `jcifs.smb.client.disableSMB1` (boolean, default false) Rejects connections if the server chooses SMB1.
`boolean`	`isEnableSMB2()` Enable experimental SMB2 support Property `jcifs.smb.client.enableSMB2` (boolean, default false) This enables announcement of SMB2 support.
`boolean`	`isForceExtendedSecurity()` Property `jcifs.smb.client.forceExtendedSecurity` (boolean, default false)
`boolean`	`isForceUnicode()` Property `jcifs.smb.client.forceUnicode` (boolean, default false)
`boolean`	`isIgnoreCopyToException()` Property `jcifs.smb.client.ignoreCopyToException` (boolean, true)
`boolean`	`isIpcSigningEnforced()` Property `jcifs.smb.client.ipcSigningEnforced` (boolean, default true)
`boolean`	`isPort139FailoverEnabled()` Enable port 139 failover Property `jcifs.smb.client.port139.enabled` (boolean, default false)
`boolean`	`isSigningEnabled()` Property `jcifs.smb.client.signingPreferred` (boolean, default false)
`boolean`	`isSigningEnforced()` Property `jcifs.smb.client.signingEnforced` (boolean, default false)
`boolean`	`isStrictResourceLifecycle()` Property `jcifs.smb.client.strictResourceLifecycle` (bool, default false) If enabled, SmbFile instances starting with their first use will hold a reference to their tree.
`boolean`	`isTraceResourceUsage()` This is solely intended for debugging
`boolean`	`isUseBatching()` Property `jcifs.smb.client.useBatching` (boolean, default true)
`boolean`	`isUseSMB2OnlyNegotiation()` Use SMB2 non-backward compatible negotiation style Property `jcifs.smb.client.useSMB2Negotiation` (boolean, default false)
`boolean`	`isUseUnicode()` Property `jcifs.smb.client.useUnicode` (boolean, default true)

- Method Detail
  - getRandom
```
SecureRandom getRandom()
```
    Returns:
    
    random source to use
  - getDfsTtl
```
long getDfsTtl()
```
    Property jcifs.smb.client.dfs.ttl (int, default 300)
    
    Returns:
    
    title to live, in seconds, for DFS cache entries
  - isDfsStrictView
```
boolean isDfsStrictView()
```
    Property jcifs.smb.client.dfs.strictView (boolean, default false)
    
    Returns:
    
    whether a authentication failure during DFS resolving will throw an exception
  - isDfsDisabled
```
boolean isDfsDisabled()
```
    Property jcifs.smb.client.dfs.disabled (boolean, default false)
    
    Returns:
    
    whether DFS lookup is disabled
  - isDfsConvertToFQDN
```
boolean isDfsConvertToFQDN()
```
    Enable hack to make kerberos auth work with DFS sending short names This works by appending the domain name to the netbios short name and will fail horribly if this mapping is not correct for your domain. Property jcifs.smb.client.dfs.convertToFQDN (boolean, default false)
    
    Returns:
    
    whether to convert NetBIOS names returned by DFS to FQDNs
  - isEnableSMB2
```
boolean isEnableSMB2()
```
    Enable experimental SMB2 support Property jcifs.smb.client.enableSMB2 (boolean, default false) This enables announcement of SMB2 support. SMB2 might still be chosen if the server rejects SMB1 and answers with a SMB2 negotiation response.
    
    Returns:
    
    whether to enable experimental SMB2+ support
  - isDisableSMB1
```
boolean isDisableSMB1()
```
    Disables SMB1 support Property jcifs.smb.client.disableSMB1 (boolean, default false) Rejects connections if the server chooses SMB1.
    
    Returns:
    
    whether to disable SMB1 support
  - isUseSMB2OnlyNegotiation
```
boolean isUseSMB2OnlyNegotiation()
```
    Use SMB2 non-backward compatible negotiation style Property jcifs.smb.client.useSMB2Negotiation (boolean, default false)
    
    Returns:
    
    whether to use non-backward compatible protocol negotiation
  - isPort139FailoverEnabled
```
boolean isPort139FailoverEnabled()
```
    Enable port 139 failover Property jcifs.smb.client.port139.enabled (boolean, default false)
    
    Returns:
    
    whether to failover to legacy transport on port 139
  - isUseUnicode
```
boolean isUseUnicode()
```
    Property jcifs.smb.client.useUnicode (boolean, default true)
    
    Returns:
    
    whether to announce support for unicode
  - isForceUnicode
```
boolean isForceUnicode()
```
    Property jcifs.smb.client.forceUnicode (boolean, default false)
    
    Returns:
    
    whether to use unicode, even if the server does not announce it
  - isUseBatching
```
boolean isUseBatching()
```
    Property jcifs.smb.client.useBatching (boolean, default true)
    
    Returns:
    
    whether to enable support for SMB1 AndX command batching
  - getNativeOs
```
String getNativeOs()
```
    Property jcifs.smb.client.nativeOs (string, default os.name)
    
    Returns:
    
    OS string to report
  - getNativeLanman
```
String getNativeLanman()
```
    Property jcifs.smb.client.nativeLanMan (string, default jCIFS)
    
    Returns:
    
    Lanman string to report
  - getRecieveBufferSize
```
int getRecieveBufferSize()
```
    Property jcifs.smb.client.rcv_buf_size (int, default 65535)
    
    Returns:
    
    recieve buffer size, in bytes
  - getSendBufferSize
```
int getSendBufferSize()
```
    Property jcifs.smb.client.snd_buf_size (int, default 65535)
    
    Returns:
    
    send buffer size, in bytes
  - getSoTimeout
```
int getSoTimeout()
```
    Property jcifs.smb.client.soTimeout (int, default 35000)
    
    Returns:
    
    socket timeout, in milliseconds
  - getConnTimeout
```
int getConnTimeout()
```
    Property jcifs.smb.client.connTimeout (int, default 35000)
    
    Returns:
    
    timeout for establishing a socket connection, in milliseconds
  - getSessionTimeout
```
int getSessionTimeout()
```
    Property jcifs.smb.client.sessionTimeout (int, default 35000)
    
    Returns:
    
    timeout for SMB sessions, in milliseconds
  - getResponseTimeout
```
int getResponseTimeout()
```
    Property jcifs.smb.client.responseTimeout (int, default 30000)
    
    Returns:
    
    timeout for SMB responses, in milliseconds
  - getLocalPort
```
int getLocalPort()
```
    Property jcifs.smb.client.lport (int)
    
    Returns:
    
    local port to use for outgoing connections
  - getLocalAddr
```
InetAddress getLocalAddr()
```
    Property jcifs.smb.client.laddr (string)
    
    Returns:
    
    local address to use for outgoing connections
  - getNetbiosHostname
```
String getNetbiosHostname()
```
    Property jcifs.netbios.hostname (string)
    
    Returns:
    
    local NETBIOS/short name to announce
  - getLogonShare
```
String getLogonShare()
```
    Property jcifs.smb.client.logonShare
    
    Returns:
    
    share to connect to during authentication, if unset connect to IPC$
  - getDefaultDomain
```
String getDefaultDomain()
```
    Property jcifs.smb.client.domain
    
    Returns:
    
    default credentials, domain name
  - getDefaultUsername
```
String getDefaultUsername()
```
    Property jcifs.smb.client.username
    
    Returns:
    
    default credentials, user name
  - getDefaultPassword
```
String getDefaultPassword()
```
    Property jcifs.smb.client.password
    
    Returns:
    
    default credentials, password
  - getLanManCompatibility
```
int getLanManCompatibility()
```
    Lanman compatibility level
    
    0 or 1 LM and NTLM
    
    2 NTLM only
    
    3-5 NTLMv2 only
    
    Property jcifs.smb.lmCompatibility (int, default 3)
    
    Returns:
    
    lanman compatibility level, defaults to 3 i.e. NTLMv2 only
  - isAllowNTLMFallback
```
boolean isAllowNTLMFallback()
```
    Property jcifs.smb.allowNTLMFallback (boolean, default true)
    
    Returns:
    
    whether to allow fallback from kerberos to NTLM
  - isDisablePlainTextPasswords
```
boolean isDisablePlainTextPasswords()
```
    Property jcifs.smb.client.disablePlainTextPasswords (boolean, default true)
    
    Returns:
    
    whether the usage of plaintext passwords is prohibited, defaults to false
  - getResolveOrder
```
List<ResolverType> getResolveOrder()
```
    Property jcifs.resolveOrder (string, default LMHOSTS,DNS,WINS,BCAST)
    
    Returns:
    
    order and selection of resolver modules, see ResolverType
  - getBroadcastAddress
```
InetAddress getBroadcastAddress()
```
    Property jcifs.netbios.baddr (string, default 255.255.255.255)
    
    Returns:
    
    broadcast address to use
  - getWinsServers
```
InetAddress[] getWinsServers()
```
    Property jcifs.netbios.wins (string, comma separated)
    
    Returns:
    
    WINS server to use
  - getNetbiosLocalPort
```
int getNetbiosLocalPort()
```
    Property jcifs.netbios.lport (int)
    
    Returns:
    
    local bind port for nebios connections
  - getNetbiosLocalAddress
```
InetAddress getNetbiosLocalAddress()
```
    Property jcifs.netbios.laddr (string)
    
    Returns:
    
    local bind address for netbios connections
  - getNetbiosSoTimeout
```
int getNetbiosSoTimeout()
```
    Property jcifs.netbios.soTimeout (int, default 5000)
    
    Returns:
    
    socket timeout for netbios connections, in milliseconds
  - getVcNumber
```
int getVcNumber()
```
    Returns:
    
    virtual circuit number to use
  - getCapabilities
```
int getCapabilities()
```
    Property jcifs.smb.client.capabilities (int)
    
    Returns:
    
    custom capabilities
  - getFlags2
```
int getFlags2()
```
    Property jcifs.smb.client.flags2 (int)
    
    Returns:
    
    custom flags2
  - getSessionLimit
```
int getSessionLimit()
```
    Property jcifs.smb.client.ssnLimit (int, 250)
    
    Returns:
    
    maximum number of sessions on a single connection
  - getOemEncoding
```
String getOemEncoding()
```
    Property jcifs.encoding (string, default Cp850)
    
    Returns:
    
    OEM encoding to use
  - getLocalTimezone
```
TimeZone getLocalTimezone()
```
    Returns:
    
    local timezone
  - getPid
```
int getPid()
```
    Returns:
    
    Process id to send, randomized if unset
  - getMaxMpxCount
```
int getMaxMpxCount()
```
    Property jcifs.smb.client.maxMpxCount (int, default 10)
    
    Returns:
    
    maximum count of concurrent commands to announce
  - isSigningEnabled
```
boolean isSigningEnabled()
```
    Property jcifs.smb.client.signingPreferred (boolean, default false)
    
    Returns:
    
    whether to enable SMB signing (for everything), if available
  - isIpcSigningEnforced
```
boolean isIpcSigningEnforced()
```
    Property jcifs.smb.client.ipcSigningEnforced (boolean, default true)
    
    Returns:
    
    whether to enforce SMB signing for IPC connections
  - isSigningEnforced
```
boolean isSigningEnforced()
```
    Property jcifs.smb.client.signingEnforced (boolean, default false)
    
    Returns:
    
    whether to enforce SMB signing (for everything)
  - isForceExtendedSecurity
```
boolean isForceExtendedSecurity()
```
    Property jcifs.smb.client.forceExtendedSecurity (boolean, default false)
    
    Returns:
    
    whether to force extended security usage
  - getLmHostsFileName
```
String getLmHostsFileName()
```
    Property jcifs.netbios.lmhosts (string)
    
    Returns:
    
    lmhosts file to use
  - getNetbiosScope
```
String getNetbiosScope()
```
    Property jcifs.netbios.scope (string)
    
    Returns:
    
    default netbios scope to set in requests
  - getNetbiosSndBufSize
```
int getNetbiosSndBufSize()
```
    Property jcifs.netbios.snd_buf_size (int, default 576)
    
    Returns:
    
    netbios send buffer size
  - getNetbiosRcvBufSize
```
int getNetbiosRcvBufSize()
```
    Property jcifs.netbios.rcv_buf_size (int, default 576)
    
    Returns:
    
    netbios recieve buffer size
  - getNetbiosRetryTimeout
```
int getNetbiosRetryTimeout()
```
    Property jcifs.netbios.retryTimeout (int, default 3000)
    
    Returns:
    
    timeout of retry requests, in milliseconds
  - getNetbiosRetryCount
```
int getNetbiosRetryCount()
```
    Property jcifs.netbios.retryCount (int, default 2)
    
    Returns:
    
    maximum number of retries for netbios requests
  - getNetbiosCachePolicy
```
int getNetbiosCachePolicy()
```
    Property jcifs.netbios.cachePolicy in minutes (int, default 600)
    
    Returns:
    
    netbios cache timeout, in seconds, 0 - disable caching, -1 - cache forever
  - getMaximumBufferSize
```
int getMaximumBufferSize()
```
    Returns:
    
    the maximum size of IO buffers, limits the maximum message size
  - getTransactionBufferSize
```
int getTransactionBufferSize()
```
    Property jcifs.smb.client.transaction_buf_size (int, default 65535)
    
    Returns:
    
    maximum data size for SMB transactions
  - getBufferCacheSize
```
int getBufferCacheSize()
```
    Property jcifs.smb.maxBuffers (int, default 16)
    
    Returns:
    
    number of buffers to keep in cache
  - getListCount
```
int getListCount()
```
    Property jcifs.smb.client.listCount (int, default 200)
    
    Returns:
    
    maxmimum number of elements to request in a list request
  - getListSize
```
int getListSize()
```
    Property jcifs.smb.client.listSize (int, default 65535)
    
    Returns:
    
    maximum data size for list requests
  - getAttributeCacheTimeout
```
long getAttributeCacheTimeout()
```
    Property jcifs.smb.client.attrExpirationPeriod (int, 5000)
    
    Returns:
    
    timeout of file attribute cache
  - isIgnoreCopyToException
```
boolean isIgnoreCopyToException()
```
    Property jcifs.smb.client.ignoreCopyToException (boolean, true)
    
    Returns:
    
    whether to ignore exceptions
  - getBatchLimit
```
int getBatchLimit(String cmd)
```
    Parameters:
    
    cmd -
    
    Returns:
    
    the batch limit for the given command
  - getSupportedDialects
```
String[] getSupportedDialects()
```
    Returns:
    
    the supported dialects
  - getNotifyBufferSize
```
int getNotifyBufferSize()
```
    Property jcifs.smb.client.notify_buf_size (int, default 1024)
    
    Returns:
    
    the size of the requested server notify buffer
  - getMaxRequestRetries
```
int getMaxRequestRetries()
```
    Property jcifs.smb.client.maxRequestRetries (int, default 2)
    
    Returns:
    
    retry SMB requests on failure up to n times
  - isStrictResourceLifecycle
```
boolean isStrictResourceLifecycle()
```
    Property jcifs.smb.client.strictResourceLifecycle (bool, default false) If enabled, SmbFile instances starting with their first use will hold a reference to their tree. This means that trees/sessions/connections won't be idle-disconnected even if there are no other active references (currently executing code, file descriptors). Depending on the usage scenario, this may have some benefit as there won't be any delays for restablishing these resources, however comes at the cost of having to properly release all SmbFile instances you no longer need.
    
    Returns:
    
    whether to use strict resource lifecycle
  - isTraceResourceUsage
```
boolean isTraceResourceUsage()
```
    This is solely intended for debugging
    
    Returns:
    
    whether to track the locations from which resources were created
  - isAllowCompound
```
boolean isAllowCompound(String command)
```
    Parameters:
    
    command -
    
    Returns:
    
    whether to allow creating compound requests with that command

Interface Configuration

Method Summary

Method Detail

getRandom

getDfsTtl

isDfsStrictView

isDfsDisabled

isDfsConvertToFQDN

isEnableSMB2

isDisableSMB1

isUseSMB2OnlyNegotiation

isPort139FailoverEnabled

isUseUnicode

isForceUnicode

isUseBatching

getNativeOs

getNativeLanman

getRecieveBufferSize

getSendBufferSize

getSoTimeout

getConnTimeout

getSessionTimeout

getResponseTimeout

getLocalPort

getLocalAddr

getNetbiosHostname

getLogonShare

getDefaultDomain

getDefaultUsername

getDefaultPassword

getLanManCompatibility

isAllowNTLMFallback

isDisablePlainTextPasswords

getResolveOrder

getBroadcastAddress

getWinsServers

getNetbiosLocalPort

getNetbiosLocalAddress

getNetbiosSoTimeout

getVcNumber

getCapabilities

getFlags2

getSessionLimit

getOemEncoding

getLocalTimezone

getPid

getMaxMpxCount

isSigningEnabled

isIpcSigningEnforced

isSigningEnforced

isForceExtendedSecurity

getLmHostsFileName

getNetbiosScope

getNetbiosSndBufSize

getNetbiosRcvBufSize

getNetbiosRetryTimeout

getNetbiosRetryCount

getNetbiosCachePolicy

getMaximumBufferSize

getTransactionBufferSize

getBufferCacheSize

getListCount

getListSize

getAttributeCacheTimeout

isIgnoreCopyToException

getBatchLimit

getSupportedDialects

getNotifyBufferSize

getMaxRequestRetries

isStrictResourceLifecycle

isTraceResourceUsage

isAllowCompound