java.lang.Object
- com.hierynomus.smbj.SmbConfig

public final class SmbConfig
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SmbConfig.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`private static boolean`	`ANDROID`
`private java.util.List<Factory.Named<Authenticator>>`	`authenticators`
`private GSSContextConfig`	`clientGSSContextConfig`
`private java.util.UUID`	`clientGuid`
`private static int`	`DEFAULT_BUFFER_SIZE`
`private static int`	`DEFAULT_SO_TIMEOUT`
`private static java.util.concurrent.TimeUnit`	`DEFAULT_SO_TIMEOUT_UNIT`
`private static int`	`DEFAULT_TIMEOUT`
`private static java.util.concurrent.TimeUnit`	`DEFAULT_TIMEOUT_UNIT`
`private static TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>>`	`DEFAULT_TRANSPORT_LAYER_FACTORY`
`private boolean`	`dfsEnabled`
`private java.util.Set<SMB2Dialect>`	`dialects`
`private boolean`	`encryptData`
`private NtlmConfig`	`ntlmConfig`
`private java.util.Random`	`random`
`private int`	`readBufferSize`
`private long`	`readTimeout`
`private SecurityProvider`	`securityProvider`
`private boolean`	`signingEnabled`
`private boolean`	`signingRequired`
`private javax.net.SocketFactory`	`socketFactory`
`private int`	`soTimeout`
`private int`	`transactBufferSize`
`private long`	`transactTimeout`
`private TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>>`	`transportLayerFactory`
`private boolean`	`useMultiProtocolNegotiate`
`private int`	`writeBufferSize`
`private long`	`writeTimeout`

Constructor Summary

Constructors
Modifier Constructor Description

private SmbConfig()

private SmbConfig(SmbConfig other)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static SmbConfig.Builder`	`builder()`
`static SmbConfig.Builder`	`builder(SmbConfig baseConfig)`
`static SmbConfig`	`createDefaultConfig()`
`java.util.Set<SMB2GlobalCapability>`	`getClientCapabilities()`
`GSSContextConfig`	`getClientGSSContextConfig()`
`java.util.UUID`	`getClientGuid()`
`private static java.util.List<Factory.Named<Authenticator>>`	`getDefaultAuthenticators()`
`private static SecurityProvider`	`getDefaultSecurityProvider()`
`NtlmConfig`	`getNtlmConfig()`
`java.util.Random`	`getRandomProvider()`
`int`	`getReadBufferSize()`
`long`	`getReadTimeout()`
`SecurityProvider`	`getSecurityProvider()`
`javax.net.SocketFactory`	`getSocketFactory()`
`int`	`getSoTimeout()`
`java.util.List<Factory.Named<Authenticator>>`	`getSupportedAuthenticators()`
`java.util.Set<SMB2Dialect>`	`getSupportedDialects()`
`int`	`getTransactBufferSize()`
`long`	`getTransactTimeout()`
`TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>>`	`getTransportLayerFactory()`
`java.lang.String`	`getWorkStationName()`	Deprecated. Moved into getNtlmConfig().getWorkStationName()
`int`	`getWriteBufferSize()`
`long`	`getWriteTimeout()`
`boolean`	`isDfsEnabled()`	Whether the client should use the DFS protocol.
`boolean`	`isEncryptData()`
`boolean`	`isSigningEnabled()`	Whether the client should sign messages to the server.
`boolean`	`isSigningRequired()`	Whether the client requires that messages from the server are signed.
`boolean`	`isUseMultiProtocolNegotiate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BUFFER_SIZE
```
private static final int DEFAULT_BUFFER_SIZE
```
See Also:

Constant Field Values

DEFAULT_SO_TIMEOUT
```
private static final int DEFAULT_SO_TIMEOUT
```
See Also:

Constant Field Values

DEFAULT_SO_TIMEOUT_UNIT

private static final java.util.concurrent.TimeUnit DEFAULT_SO_TIMEOUT_UNIT

DEFAULT_TIMEOUT
```
private static final int DEFAULT_TIMEOUT
```
See Also:

Constant Field Values

DEFAULT_TIMEOUT_UNIT

private static final java.util.concurrent.TimeUnit DEFAULT_TIMEOUT_UNIT

DEFAULT_TRANSPORT_LAYER_FACTORY

private static final TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>> DEFAULT_TRANSPORT_LAYER_FACTORY

ANDROID
```
private static final boolean ANDROID
```

dialects

private java.util.Set<SMB2Dialect> dialects

authenticators

private java.util.List<Factory.Named<Authenticator>> authenticators

socketFactory

private javax.net.SocketFactory socketFactory

random
```
private java.util.Random random
```

clientGuid
```
private java.util.UUID clientGuid
```

signingRequired
```
private boolean signingRequired
```

signingEnabled
```
private boolean signingEnabled
```

dfsEnabled
```
private boolean dfsEnabled
```

useMultiProtocolNegotiate

private boolean useMultiProtocolNegotiate

securityProvider

private SecurityProvider securityProvider

readBufferSize
```
private int readBufferSize
```

readTimeout
```
private long readTimeout
```

writeBufferSize
```
private int writeBufferSize
```

writeTimeout
```
private long writeTimeout
```

transactBufferSize
```
private int transactBufferSize
```

transportLayerFactory

private TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>> transportLayerFactory

transactTimeout
```
private long transactTimeout
```

clientGSSContextConfig

private GSSContextConfig clientGSSContextConfig

encryptData
```
private boolean encryptData
```

ntlmConfig
```
private NtlmConfig ntlmConfig
```

soTimeout
```
private int soTimeout
```

Constructor Detail

SmbConfig
```
private SmbConfig()
```

SmbConfig
```
private SmbConfig(SmbConfig other)
```

Method Detail

createDefaultConfig

public static SmbConfig createDefaultConfig()

builder

public static SmbConfig.Builder builder()

builder

public static SmbConfig.Builder builder(SmbConfig baseConfig)

getDefaultSecurityProvider

private static SecurityProvider getDefaultSecurityProvider()

getDefaultAuthenticators

private static java.util.List<Factory.Named<Authenticator>> getDefaultAuthenticators()

getRandomProvider

public java.util.Random getRandomProvider()

getSecurityProvider

public SecurityProvider getSecurityProvider()

getSupportedDialects

public java.util.Set<SMB2Dialect> getSupportedDialects()

getClientGuid
```
public java.util.UUID getClientGuid()
```

getSupportedAuthenticators

public java.util.List<Factory.Named<Authenticator>> getSupportedAuthenticators()

isSigningRequired
```
public boolean isSigningRequired()
```
Whether the client requires that messages from the server are signed. When message signing is enforced a received message that is not signed properly will result in an exception.

isSigningEnabled
```
public boolean isSigningEnabled()
```
Whether the client should sign messages to the server. When message signing is enabled the client will sign messages to the server.

isDfsEnabled
```
public boolean isDfsEnabled()
```
Whether the client should use the DFS protocol.

isUseMultiProtocolNegotiate

public boolean isUseMultiProtocolNegotiate()

getReadBufferSize
```
public int getReadBufferSize()
```

getReadTimeout
```
public long getReadTimeout()
```

getWriteBufferSize
```
public int getWriteBufferSize()
```

getWriteTimeout
```
public long getWriteTimeout()
```

getTransactBufferSize
```
public int getTransactBufferSize()
```

getTransactTimeout
```
public long getTransactTimeout()
```

getTransportLayerFactory

public TransportLayerFactory<SMBPacketData<?>,SMBPacket<?,?>> getTransportLayerFactory()

getSoTimeout
```
public int getSoTimeout()
```

getSocketFactory

public javax.net.SocketFactory getSocketFactory()

getClientGSSContextConfig

public GSSContextConfig getClientGSSContextConfig()

isEncryptData
```
public boolean isEncryptData()
```

getWorkStationName
```
public java.lang.String getWorkStationName()
```
Deprecated.
Moved into getNtlmConfig().getWorkStationName()

Get the work station name to be used in the NTLM authentication.

getNtlmConfig
```
public NtlmConfig getNtlmConfig()
```

getClientCapabilities

public java.util.Set<SMB2GlobalCapability> getClientCapabilities()

Constructors
Modifier	Constructor	Description
`private`	`SmbConfig()`
`private`	`SmbConfig(SmbConfig other)`

Class SmbConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

DEFAULT_SO_TIMEOUT

DEFAULT_SO_TIMEOUT_UNIT

DEFAULT_TIMEOUT

DEFAULT_TIMEOUT_UNIT

DEFAULT_TRANSPORT_LAYER_FACTORY

ANDROID

dialects

authenticators

socketFactory

random

clientGuid

signingRequired

signingEnabled

dfsEnabled

useMultiProtocolNegotiate

securityProvider

readBufferSize

readTimeout

writeBufferSize

writeTimeout

transactBufferSize

transportLayerFactory

transactTimeout

clientGSSContextConfig

encryptData

ntlmConfig

soTimeout

Constructor Detail

SmbConfig

SmbConfig

Method Detail

createDefaultConfig

builder

builder

getDefaultSecurityProvider

getDefaultAuthenticators

getRandomProvider

getSecurityProvider

getSupportedDialects

getClientGuid

getSupportedAuthenticators

isSigningRequired

isSigningEnabled

isDfsEnabled

isUseMultiProtocolNegotiate

getReadBufferSize

getReadTimeout

getWriteBufferSize

getWriteTimeout

getTransactBufferSize

getTransactTimeout

getTransportLayerFactory

getSoTimeout

getSocketFactory

getClientGSSContextConfig

isEncryptData

getWorkStationName

getNtlmConfig

getClientCapabilities