Module jcifs
Package org.codelibs.jcifs.smb

Interface Configuration

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

    Modifier and Type
    Method
    Description
    long
    getAttributeCacheTimeout()
    Property org.codelibs.jcifs.smb.impl.client.attrExpirationPeriod (int, 5000)
    int
    getBatchLimit(String cmd)
    Gets the batch limit for a specific SMB command
    InetAddress
    getBroadcastAddress()
    Property org.codelibs.jcifs.smb.netbios.baddr (string, default 255.255.255.255)
    int
    getBufferCacheSize()
    Property org.codelibs.jcifs.smb.impl.maxBuffers (int, default 16)
    int
    getCapabilities()
    Property org.codelibs.jcifs.smb.impl.client.capabilities (int)
    int
    getConnTimeout()
    Property org.codelibs.jcifs.smb.impl.client.connTimeout (int, default 35000)
    String
    getDefaultDomain()
    Property org.codelibs.jcifs.smb.impl.client.domain
    String
    getDefaultPassword()
    Property org.codelibs.jcifs.smb.impl.client.password
    String
    getDefaultUsername()
    Property org.codelibs.jcifs.smb.impl.client.username
    long
    getDfsTtl()
    Property org.codelibs.jcifs.smb.impl.client.dfs.ttl (int, default 300)
    int
    getFlags2()
    Property org.codelibs.jcifs.smb.impl.client.flags2 (int)
    String
    getGuestPassword()
    Property org.codelibs.jcifs.smb.impl.client.guestPassword, defaults to empty string
    String
    getGuestUsername()
    Property org.codelibs.jcifs.smb.impl.client.guestUsername, defaults to GUEST
    int
    getLanManCompatibility()
    Lanman compatibility level Microsoft TechNet Documentation LM Compatibility Levels 0 or 1 LM and NTLM 2 NTLM only 3-5 NTLMv2 only Property org.codelibs.jcifs.smb.impl.lmCompatibility (int, default 3)
    int
    getListCount()
    Property org.codelibs.jcifs.smb.impl.client.listCount (int, default 200)
    int
    getListSize()
    Property org.codelibs.jcifs.smb.impl.client.listSize (int, default 65435)
    String
    getLmHostsFileName()
    Property org.codelibs.jcifs.smb.netbios.lmhosts (string)
    InetAddress
    getLocalAddr()
    Property org.codelibs.jcifs.smb.impl.client.laddr (string)
    int
    getLocalPort()
    Property org.codelibs.jcifs.smb.impl.client.lport (int)
    TimeZone
    getLocalTimezone()
    Gets the local timezone for time-related operations
    String
    getLogonShare()
    Property org.codelibs.jcifs.smb.impl.client.logonShare
    byte[]
    getMachineId()
    Machine identifier ClientGuid, ... are derived from this value.
    int
    getMaximumBufferSize()
    Gets the maximum buffer size for IO operations
    DialectVersion
    getMaximumVersion()
    Maximum protocol version Property org.codelibs.jcifs.smb.impl.client.maxVersion (string, default SMB210)
    int
    getMaxMpxCount()
    Property org.codelibs.jcifs.smb.impl.client.maxMpxCount (int, default 10)
    int
    getMaxRequestRetries()
    Property org.codelibs.jcifs.smb.impl.client.maxRequestRetries (int, default 2)
    DialectVersion
    getMinimumVersion()
    Minimum protocol version Property org.codelibs.jcifs.smb.impl.client.minVersion (string, default SMB1)
    String
    getNativeLanman()
    Property org.codelibs.jcifs.smb.impl.client.nativeLanMan (string, default jCIFS)
    String
    getNativeOs()
    Property org.codelibs.jcifs.smb.impl.client.nativeOs (string, default os.name)
    int
    getNetbiosCachePolicy()
    Property org.codelibs.jcifs.smb.netbios.cachePolicy in minutes (int, default 600)
    String
    getNetbiosHostname()
    Property org.codelibs.jcifs.smb.netbios.hostname (string)
    InetAddress
    getNetbiosLocalAddress()
    Property org.codelibs.jcifs.smb.netbios.laddr (string)
    int
    getNetbiosLocalPort()
    Property org.codelibs.jcifs.smb.netbios.lport (int)
    int
    getNetbiosRcvBufSize()
    Property org.codelibs.jcifs.smb.netbios.rcv_buf_size (int, default 576)
    int
    getNetbiosRetryCount()
    Property org.codelibs.jcifs.smb.netbios.retryCount (int, default 2)
    int
    getNetbiosRetryTimeout()
    Property org.codelibs.jcifs.smb.netbios.retryTimeout (int, default 3000)
    String
    getNetbiosScope()
    Property org.codelibs.jcifs.smb.netbios.scope (string)
    int
    getNetbiosSndBufSize()
    Property org.codelibs.jcifs.smb.netbios.snd_buf_size (int, default 576)
    int
    getNetbiosSoTimeout()
    Property org.codelibs.jcifs.smb.netbios.soTimeout (int, default 5000)
    int
    getNotifyBufferSize()
    Property org.codelibs.jcifs.smb.impl.client.notify_buf_size (int, default 1024)
    String
    getOemEncoding()
    Property org.codelibs.jcifs.smb.encoding (string, default Cp850)
    int
    getPid()
    Gets the process ID to use in SMB messages
    SecureRandom
    getRandom()
    Gets the secure random number generator for cryptographic operations
    int
    getReceiveBufferSize()
    Property org.codelibs.jcifs.smb.impl.client.rcv_buf_size (int, default 65535)
    int
    getRecieveBufferSize()
    Deprecated.
    use getReceiveBufferSize instead
    List<ResolverType>
    getResolveOrder()
    Property org.codelibs.jcifs.smb.resolveOrder (string, default LMHOSTS,DNS,WINS,BCAST)
    int
    getResponseTimeout()
    Property org.codelibs.jcifs.smb.impl.client.responseTimeout (int, default 30000)
    int
    getSendBufferSize()
    Property org.codelibs.jcifs.smb.impl.client.snd_buf_size (int, default 65535)
    int
    getSessionLimit()
    Property org.codelibs.jcifs.smb.impl.client.ssnLimit (int, 250)
    int
    getSessionTimeout()
    Property org.codelibs.jcifs.smb.impl.client.sessionTimeout (int, default 35000)
    int
    getSoTimeout()
    Property org.codelibs.jcifs.smb.impl.client.soTimeout (int, default 35000)
    int
    getTransactionBufferSize()
    Property org.codelibs.jcifs.smb.impl.client.transaction_buf_size (int, default 65535)
    int
    getVcNumber()
    Gets the virtual circuit number for SMB connections
    InetAddress[]
    getWinsServers()
    Property org.codelibs.jcifs.smb.netbios.wins (string, comma separated)
    boolean
    isAllowCompound(String command)
    Checks if compound requests are allowed for the specified command
    boolean
    isAllowGuestFallback()
    Property org.codelibs.jcifs.smb.impl.client.allowGuestFallback, defaults to false
    boolean
    isAllowNTLMFallback()
    Property org.codelibs.jcifs.smb.impl.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 org.codelibs.jcifs.smb.impl.client.dfs.disabled (boolean, default false)
    boolean
    isDfsStrictView()
    Property org.codelibs.jcifs.smb.impl.client.dfs.strictView (boolean, default false)
    boolean
    isDisablePlainTextPasswords()
    Property org.codelibs.jcifs.smb.impl.client.disablePlainTextPasswords (boolean, default true)
    boolean
    isDisableSpnegoIntegrity()
    Property org.codelibs.jcifs.smb.impl.client.disableSpnegoIntegrity (boolean, false)
    boolean
    isEncryptionEnabled()
    Property org.codelibs.jcifs.smb.impl.client.encryptionEnabled (boolean, default false) This is an experimental option allowing to indicate support during protocol negotiation, SMB encryption is not implemented yet.
    boolean
    isEnforceSpnegoIntegrity()
    Property org.codelibs.jcifs.smb.impl.client.enforceSpnegoIntegrity (boolean, false)
    boolean
    isForceExtendedSecurity()
    Property org.codelibs.jcifs.smb.impl.client.forceExtendedSecurity (boolean, default false)
    boolean
    isForceUnicode()
    Property org.codelibs.jcifs.smb.impl.client.forceUnicode (boolean, default false)
    boolean
    isIgnoreCopyToException()
    Property org.codelibs.jcifs.smb.impl.client.ignoreCopyToException (boolean, false)
    boolean
    isIpcSigningEnforced()
    Property org.codelibs.jcifs.smb.impl.client.ipcSigningEnforced (boolean, default true)
    boolean
    isPort139FailoverEnabled()
    Enable port 139 failover Property org.codelibs.jcifs.smb.impl.client.port139.enabled (boolean, default false)
    boolean
    isPreserveShareCase()
    Whether to preserve share name case When true, preserve the original case of share names instead of converting to uppercase.
    boolean
    isRequireSecureNegotiate()
    Enforce secure negotiation Property org.codelibs.jcifs.smb.impl.client.requireSecureNegotiate (boolean, default true) This does not provide any actual downgrade protection if SMB1 is allowed.
    boolean
    isSendNTLMTargetName()
    Property org.codelibs.jcifs.smb.impl.client.SendNTLMTargetName (boolean, true)
    boolean
    isSigningEnabled()
    Property org.codelibs.jcifs.smb.impl.client.signingPreferred (boolean, default false)
    boolean
    isSigningEnforced()
    Property org.codelibs.jcifs.smb.impl.client.signingEnforced (boolean, default false)
    boolean
    isStrictResourceLifecycle()
    Property org.codelibs.jcifs.smb.impl.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 org.codelibs.jcifs.smb.impl.client.useBatching (boolean, default false)
    boolean
    isUseRawNTLM()
    Property org.codelibs.jcifs.smb.impl.useRawNTLM (boolean, default false)
    boolean
    isUseSMB2OnlyNegotiation()
    Use SMB2 non-backward compatible negotiation style Property org.codelibs.jcifs.smb.impl.client.useSMB2Negotiation (boolean, default false)
    boolean
    isUseUnicode()
    Property org.codelibs.jcifs.smb.impl.client.useUnicode (boolean, default true)

  • Method Details

    • getRandom

      SecureRandom getRandom()
      Gets the secure random number generator for cryptographic operations
      Returns:
      random source to use

    • getDfsTtl

      long getDfsTtl()
      Property org.codelibs.jcifs.smb.impl.client.dfs.ttl (int, default 300)
      Returns:
      title to live, in seconds, for DFS cache entries

    • isDfsStrictView

      boolean isDfsStrictView()
      Property org.codelibs.jcifs.smb.impl.client.dfs.strictView (boolean, default false)
      Returns:
      whether a authentication failure during DFS resolving will throw an exception

    • isDfsDisabled

      boolean isDfsDisabled()
      Property org.codelibs.jcifs.smb.impl.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 org.codelibs.jcifs.smb.impl.client.dfs.convertToFQDN (boolean, default false)
      Returns:
      whether to convert NetBIOS names returned by DFS to FQDNs

    • isPreserveShareCase

      boolean isPreserveShareCase()
      Whether to preserve share name case When true, preserve the original case of share names instead of converting to uppercase. This is required for DFS namespaces with case-sensitive link names. Property jcifs.smb.client.preserveShareCase (boolean, default false)
      Returns:
      whether to preserve share name case

    • getMinimumVersion

      DialectVersion getMinimumVersion()
      Minimum protocol version Property org.codelibs.jcifs.smb.impl.client.minVersion (string, default SMB1)
      Returns:
      minimum protocol version to use/allow
      Since:
      2.1
      See Also:

    • getMaximumVersion

      DialectVersion getMaximumVersion()
      Maximum protocol version Property org.codelibs.jcifs.smb.impl.client.maxVersion (string, default SMB210)
      Returns:
      maximum protocol version to use/allow
      Since:
      2.1
      See Also:

    • isUseSMB2OnlyNegotiation

      boolean isUseSMB2OnlyNegotiation()
      Use SMB2 non-backward compatible negotiation style Property org.codelibs.jcifs.smb.impl.client.useSMB2Negotiation (boolean, default false)
      Returns:
      whether to use non-backward compatible protocol negotiation

    • isRequireSecureNegotiate

      boolean isRequireSecureNegotiate()
      Enforce secure negotiation Property org.codelibs.jcifs.smb.impl.client.requireSecureNegotiate (boolean, default true) This does not provide any actual downgrade protection if SMB1 is allowed. It will also break connections with SMB2 servers that do not properly sign error responses.
      Returns:
      whether to enforce the use of secure negotiation.

    • isPort139FailoverEnabled

      boolean isPort139FailoverEnabled()
      Enable port 139 failover Property org.codelibs.jcifs.smb.impl.client.port139.enabled (boolean, default false)
      Returns:
      whether to failover to legacy transport on port 139

    • isUseUnicode

      boolean isUseUnicode()
      Property org.codelibs.jcifs.smb.impl.client.useUnicode (boolean, default true)
      Returns:
      whether to announce support for unicode

    • isForceUnicode

      boolean isForceUnicode()
      Property org.codelibs.jcifs.smb.impl.client.forceUnicode (boolean, default false)
      Returns:
      whether to use unicode, even if the server does not announce it

    • isUseBatching

      boolean isUseBatching()
      Property org.codelibs.jcifs.smb.impl.client.useBatching (boolean, default false)
      Returns:
      whether to enable support for SMB1 AndX command batching

    • getNativeOs

      String getNativeOs()
      Property org.codelibs.jcifs.smb.impl.client.nativeOs (string, default os.name)
      Returns:
      OS string to report

    • getNativeLanman

      String getNativeLanman()
      Property org.codelibs.jcifs.smb.impl.client.nativeLanMan (string, default jCIFS)
      Returns:
      Lanman string to report

    • getRecieveBufferSize

      @Deprecated int getRecieveBufferSize()
      Deprecated.
      use getReceiveBufferSize instead
      Property org.codelibs.jcifs.smb.impl.client.rcv_buf_size (int, default 65535)
      Returns:
      receive buffer size, in bytes

    • getReceiveBufferSize

      int getReceiveBufferSize()
      Property org.codelibs.jcifs.smb.impl.client.rcv_buf_size (int, default 65535)
      Returns:
      receive buffer size, in bytes

    • getSendBufferSize

      int getSendBufferSize()
      Property org.codelibs.jcifs.smb.impl.client.snd_buf_size (int, default 65535)
      Returns:
      send buffer size, in bytes

    • getSoTimeout

      int getSoTimeout()
      Property org.codelibs.jcifs.smb.impl.client.soTimeout (int, default 35000)
      Returns:
      socket timeout, in milliseconds

    • getConnTimeout

      int getConnTimeout()
      Property org.codelibs.jcifs.smb.impl.client.connTimeout (int, default 35000)
      Returns:
      timeout for establishing a socket connection, in milliseconds

    • getSessionTimeout

      int getSessionTimeout()
      Property org.codelibs.jcifs.smb.impl.client.sessionTimeout (int, default 35000)
      Returns:
      timeout for SMB sessions, in milliseconds

    • getResponseTimeout

      int getResponseTimeout()
      Property org.codelibs.jcifs.smb.impl.client.responseTimeout (int, default 30000)
      Returns:
      timeout for SMB responses, in milliseconds

    • getLocalPort

      int getLocalPort()
      Property org.codelibs.jcifs.smb.impl.client.lport (int)
      Returns:
      local port to use for outgoing connections

    • getLocalAddr

      InetAddress getLocalAddr()
      Property org.codelibs.jcifs.smb.impl.client.laddr (string)
      Returns:
      local address to use for outgoing connections

    • getNetbiosHostname

      String getNetbiosHostname()
      Property org.codelibs.jcifs.smb.netbios.hostname (string)
      Returns:
      local NETBIOS/short name to announce

    • getLogonShare

      String getLogonShare()
      Property org.codelibs.jcifs.smb.impl.client.logonShare
      Returns:
      share to connect to during authentication, if unset connect to IPC$

    • getDefaultDomain

      String getDefaultDomain()
      Property org.codelibs.jcifs.smb.impl.client.domain
      Returns:
      default credentials, domain name

    • getDefaultUsername

      String getDefaultUsername()
      Property org.codelibs.jcifs.smb.impl.client.username
      Returns:
      default credentials, user name

    • getDefaultPassword

      String getDefaultPassword()
      Property org.codelibs.jcifs.smb.impl.client.password
      Returns:
      default credentials, password

    • getLanManCompatibility

      int getLanManCompatibility()
      Lanman compatibility level Microsoft TechNet Documentation
      LM Compatibility Levels
      0 or 1 LM and NTLM
      2 NTLM only
      3-5 NTLMv2 only
      Property org.codelibs.jcifs.smb.impl.lmCompatibility (int, default 3)
      Returns:
      lanman compatibility level, defaults to 3 i.e. NTLMv2 only

    • isAllowNTLMFallback

      boolean isAllowNTLMFallback()
      Property org.codelibs.jcifs.smb.impl.allowNTLMFallback (boolean, default true)
      Returns:
      whether to allow fallback from kerberos to NTLM

    • isUseRawNTLM

      boolean isUseRawNTLM()
      Property org.codelibs.jcifs.smb.impl.useRawNTLM (boolean, default false)
      Returns:
      whether to use raw NTLMSSP tokens instead of SPNEGO wrapped ones
      Since:
      2.1

    • isDisablePlainTextPasswords

      boolean isDisablePlainTextPasswords()
      Property org.codelibs.jcifs.smb.impl.client.disablePlainTextPasswords (boolean, default true)
      Returns:
      whether the usage of plaintext passwords is prohibited, defaults to false

    • getResolveOrder

      List<ResolverType> getResolveOrder()
      Property org.codelibs.jcifs.smb.resolveOrder (string, default LMHOSTS,DNS,WINS,BCAST)
      Returns:
      order and selection of resolver modules, see ResolverType

    • getBroadcastAddress

      InetAddress getBroadcastAddress()
      Property org.codelibs.jcifs.smb.netbios.baddr (string, default 255.255.255.255)
      Returns:
      broadcast address to use

    • getWinsServers

      InetAddress[] getWinsServers()
      Property org.codelibs.jcifs.smb.netbios.wins (string, comma separated)
      Returns:
      WINS server to use

    • getNetbiosLocalPort

      int getNetbiosLocalPort()
      Property org.codelibs.jcifs.smb.netbios.lport (int)
      Returns:
      local bind port for nebios connections

    • getNetbiosLocalAddress

      InetAddress getNetbiosLocalAddress()
      Property org.codelibs.jcifs.smb.netbios.laddr (string)
      Returns:
      local bind address for netbios connections

    • getNetbiosSoTimeout

      int getNetbiosSoTimeout()
      Property org.codelibs.jcifs.smb.netbios.soTimeout (int, default 5000)
      Returns:
      socket timeout for netbios connections, in milliseconds

    • getVcNumber

      int getVcNumber()
      Gets the virtual circuit number for SMB connections
      Returns:
      virtual circuit number to use

    • getCapabilities

      int getCapabilities()
      Property org.codelibs.jcifs.smb.impl.client.capabilities (int)
      Returns:
      custom capabilities

    • getFlags2

      int getFlags2()
      Property org.codelibs.jcifs.smb.impl.client.flags2 (int)
      Returns:
      custom flags2

    • getSessionLimit

      int getSessionLimit()
      Property org.codelibs.jcifs.smb.impl.client.ssnLimit (int, 250)
      Returns:
      maximum number of sessions on a single connection

    • getOemEncoding

      String getOemEncoding()
      Property org.codelibs.jcifs.smb.encoding (string, default Cp850)
      Returns:
      OEM encoding to use

    • getLocalTimezone

      TimeZone getLocalTimezone()
      Gets the local timezone for time-related operations
      Returns:
      local timezone

    • getPid

      int getPid()
      Gets the process ID to use in SMB messages
      Returns:
      Process id to send, randomized if unset

    • getMaxMpxCount

      int getMaxMpxCount()
      Property org.codelibs.jcifs.smb.impl.client.maxMpxCount (int, default 10)
      Returns:
      maximum count of concurrent commands to announce

    • isSigningEnabled

      boolean isSigningEnabled()
      Property org.codelibs.jcifs.smb.impl.client.signingPreferred (boolean, default false)
      Returns:
      whether to enable SMB signing (for everything), if available

    • isIpcSigningEnforced

      boolean isIpcSigningEnforced()
      Property org.codelibs.jcifs.smb.impl.client.ipcSigningEnforced (boolean, default true)
      Returns:
      whether to enforce SMB signing for IPC connections

    • isSigningEnforced

      boolean isSigningEnforced()
      Property org.codelibs.jcifs.smb.impl.client.signingEnforced (boolean, default false)
      Returns:
      whether to enforce SMB signing (for everything)

    • isEncryptionEnabled

      boolean isEncryptionEnabled()
      Property org.codelibs.jcifs.smb.impl.client.encryptionEnabled (boolean, default false) This is an experimental option allowing to indicate support during protocol negotiation, SMB encryption is not implemented yet.
      Returns:
      whether SMB encryption is enabled
      Since:
      2.1

    • isForceExtendedSecurity

      boolean isForceExtendedSecurity()
      Property org.codelibs.jcifs.smb.impl.client.forceExtendedSecurity (boolean, default false)
      Returns:
      whether to force extended security usage

    • getLmHostsFileName

      String getLmHostsFileName()
      Property org.codelibs.jcifs.smb.netbios.lmhosts (string)
      Returns:
      lmhosts file to use

    • getNetbiosScope

      String getNetbiosScope()
      Property org.codelibs.jcifs.smb.netbios.scope (string)
      Returns:
      default netbios scope to set in requests

    • getNetbiosSndBufSize

      int getNetbiosSndBufSize()
      Property org.codelibs.jcifs.smb.netbios.snd_buf_size (int, default 576)
      Returns:
      netbios send buffer size

    • getNetbiosRcvBufSize

      int getNetbiosRcvBufSize()
      Property org.codelibs.jcifs.smb.netbios.rcv_buf_size (int, default 576)
      Returns:
      netbios recieve buffer size

    • getNetbiosRetryTimeout

      int getNetbiosRetryTimeout()
      Property org.codelibs.jcifs.smb.netbios.retryTimeout (int, default 3000)
      Returns:
      timeout of retry requests, in milliseconds

    • getNetbiosRetryCount

      int getNetbiosRetryCount()
      Property org.codelibs.jcifs.smb.netbios.retryCount (int, default 2)
      Returns:
      maximum number of retries for netbios requests

    • getNetbiosCachePolicy

      int getNetbiosCachePolicy()
      Property org.codelibs.jcifs.smb.netbios.cachePolicy in minutes (int, default 600)
      Returns:
      netbios cache timeout, in seconds, 0 - disable caching, -1 - cache forever

    • getMaximumBufferSize

      int getMaximumBufferSize()
      Gets the maximum buffer size for IO operations
      Returns:
      the maximum size of IO buffers, limits the maximum message size

    • getTransactionBufferSize

      int getTransactionBufferSize()
      Property org.codelibs.jcifs.smb.impl.client.transaction_buf_size (int, default 65535)
      Returns:
      maximum data size for SMB transactions

    • getBufferCacheSize

      int getBufferCacheSize()
      Property org.codelibs.jcifs.smb.impl.maxBuffers (int, default 16)
      Returns:
      number of buffers to keep in cache

    • getListCount

      int getListCount()
      Property org.codelibs.jcifs.smb.impl.client.listCount (int, default 200)
      Returns:
      maxmimum number of elements to request in a list request

    • getListSize

      int getListSize()
      Property org.codelibs.jcifs.smb.impl.client.listSize (int, default 65435)
      Returns:
      maximum data size for list/info requests (known overhead is subtracted)

    • getAttributeCacheTimeout

      long getAttributeCacheTimeout()
      Property org.codelibs.jcifs.smb.impl.client.attrExpirationPeriod (int, 5000)
      Returns:
      timeout of file attribute cache

    • isIgnoreCopyToException

      boolean isIgnoreCopyToException()
      Property org.codelibs.jcifs.smb.impl.client.ignoreCopyToException (boolean, false)
      Returns:
      whether to ignore exceptions that occur during file copy

    • getBatchLimit

      int getBatchLimit(String cmd)
      Gets the batch limit for a specific SMB command
      Parameters:
      cmd - the SMB command name
      Returns:
      the batch limit for the given command

    • getNotifyBufferSize

      int getNotifyBufferSize()
      Property org.codelibs.jcifs.smb.impl.client.notify_buf_size (int, default 1024)
      Returns:
      the size of the requested server notify buffer

    • getMaxRequestRetries

      int getMaxRequestRetries()
      Property org.codelibs.jcifs.smb.impl.client.maxRequestRetries (int, default 2)
      Returns:
      retry SMB requests on failure up to n times

    • isStrictResourceLifecycle

      boolean isStrictResourceLifecycle()
      Property org.codelibs.jcifs.smb.impl.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)
      Checks if compound requests are allowed for the specified command
      Parameters:
      command - the SMB command to check
      Returns:
      whether to allow creating compound requests with that command

    • getMachineId

      byte[] getMachineId()
      Machine identifier ClientGuid, ... are derived from this value. Normally this should be randomly assigned for each client instance/configuration.
      Returns:
      machine identifier (32 byte)

    • isDisableSpnegoIntegrity

      boolean isDisableSpnegoIntegrity()
      Property org.codelibs.jcifs.smb.impl.client.disableSpnegoIntegrity (boolean, false)
      Returns:
      whether to disable sending/verifying SPNEGO mechanismListMIC

    • isEnforceSpnegoIntegrity

      boolean isEnforceSpnegoIntegrity()
      Property org.codelibs.jcifs.smb.impl.client.enforceSpnegoIntegrity (boolean, false)
      Returns:
      whether to enforce verifying SPNEGO mechanismListMIC

    • isSendNTLMTargetName

      boolean isSendNTLMTargetName()
      Property org.codelibs.jcifs.smb.impl.client.SendNTLMTargetName (boolean, true)
      Returns:
      whether to send an AvTargetName with the NTLM exchange

    • getGuestPassword

      String getGuestPassword()
      Property org.codelibs.jcifs.smb.impl.client.guestPassword, defaults to empty string
      Returns:
      password used when guest authentication is requested

    • getGuestUsername

      String getGuestUsername()
      Property org.codelibs.jcifs.smb.impl.client.guestUsername, defaults to GUEST
      Returns:
      username used when guest authentication is requested

    • isAllowGuestFallback

      boolean isAllowGuestFallback()
      Property org.codelibs.jcifs.smb.impl.client.allowGuestFallback, defaults to false
      Returns:
      whether to permit guest logins when user authentication is requested