TLSConfiguration

java.lang.Object
- com.zoiper.zdk.Configurations.TLSConfiguration

```
public class TLSConfiguration
extends java.lang.Object
```
TLS specific account configuration The configuration is applied/initialized with startContext! Any changes after startContext has been invoked will not take effect until a restart happens - stopContext followed by startContext. TLS transport configuration along with the User Agent Server part (incoming TLS connections need a domain and cert to work properly).

Constructor Summary

Constructors
Constructor and Description

TLSConfiguration(long handle)
Constructor storing the pointer/address to the underlying native object

Constructors
Constructor and Description
`TLSConfiguration(long handle)` Constructor storing the pointer/address to the underlying native object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`domain()` Gets the configured local domain name A default TLS transport is always initialized.
`void`	`domain(java.lang.String value)` Configures the local domain name A default TLS transport is always initialized.
`java.lang.String`	`domainCert()` Gets the configured domain certificate to be load If not set (or set to NULL) AND domain is also not set (or set to NULL) only the default TLS transport will be initialized.
`void`	`domainCert(java.lang.String value)` Configures the domain certificate to be load If not set (or set to NULL) AND domain is also not set (or set to NULL) only the default TLS transport will be initialized.
`java.lang.String`	`domainCertPassphrase()` Gets the configured domain certificate passphrase Can optionally contain the plaintext passphrase protecting the key set with domainCert.
`void`	`domainCertPassphrase(java.lang.String value)` Configures the domain certificate passphrase Can optionally contain the plaintext passphrase protecting the key set with domainCert.
`protected void`	`finalize()` Ensures the underlying native object destruction
`long`	`handle()` Gets the pointer/address to the underlying native object
`TLSSecureSuiteType`	`secureSuite()` Gets the configured TLS secure suite type to be used By default it is set to TLSv1.2 (support TLSv1.2 and better/newer - TLSv1.3, etc are alsosupported!)
`void`	`secureSuite(TLSSecureSuiteType value)` Configures the TLS secure suite type to be used By default it is set to TLSv1.2 (support TLSv1.2 and better/newer - TLSv1.3, etc are alsosupported!)
`boolean`	`tlsInitialized()` Gets whether the TLS configuration is initialized/applied Indicates whether the configuration is applied/initialized with startContext! Any changes to the configuration can take place only if it is not initialized.
`void`	`tlsInitialized(boolean value)` Sets whether the TLS configuration is initialized/applied Indicates whether the configuration is applied/initialized with startContext! Any changes to the configuration can take place only if it is not initialized.
`boolean`	`useOnlyStrongCyphers()` Gets whether to to limit the use to only of strong cypher If enabled, will limit the ciphers to 3DES and AES (RC4 or DES will not be allowed)
`void`	`useOnlyStrongCyphers(boolean value)` Configures whether to to limit the use to only of strong cypher If enabled, will limit the ciphers to 3DES and AES (RC4 or DES will not be allowed)

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

- Constructor Detail
  - TLSConfiguration
```
public TLSConfiguration(long handle)
```
    Constructor storing the pointer/address to the underlying native object
    
    Parameters:
    
    handle - Pointer/address to the underlying native object
- Method Detail
  - handle
```
public long handle()
```
    Gets the pointer/address to the underlying native object
    
    Returns:
    
    Pointer/address to the underlying native object
  - finalize
```
protected void finalize()
```
    Ensures the underlying native object destruction
    
    Overrides:
    
    finalize in class java.lang.Object
  - tlsInitialized
```
public boolean tlsInitialized()
```
    Gets whether the TLS configuration is initialized/applied Indicates whether the configuration is applied/initialized with startContext! Any changes to the configuration can take place only if it is not initialized. If startContext has been invoked any changes will not take effect until a restart happens - stopContext followed by startContext.
    Returns:
    0 - not initialized (can be modified)
    1 - initialized (modifications will take effect after restart)
  - tlsInitialized
```
public void tlsInitialized(boolean value)
```
    Sets whether the TLS configuration is initialized/applied Indicates whether the configuration is applied/initialized with startContext! Any changes to the configuration can take place only if it is not initialized. If startContext has been invoked any changes will not take effect until a restart happens - stopContext followed by startContext.
    Parameters:
    value -
    
    0 - not initialized (can be modified)
    1 - initialized (modifications will take effect after restart)
  - useOnlyStrongCyphers
```
public boolean useOnlyStrongCyphers()
```
    Gets whether to to limit the use to only of strong cypher If enabled, will limit the ciphers to 3DES and AES (RC4 or DES will not be allowed)
    Returns:
    0 - disabled (use all)
    1 - enabled (use only strong cyphers - 3DES and AES)
  - useOnlyStrongCyphers
```
public void useOnlyStrongCyphers(boolean value)
```
    Configures whether to to limit the use to only of strong cypher If enabled, will limit the ciphers to 3DES and AES (RC4 or DES will not be allowed)
    Parameters:
    value -
    
    0 - disabled (use all)
    1 - enabled (use only strong cyphers - 3DES and AES)
  - domain
```
public java.lang.String domain()
```
    Gets the configured local domain name A default TLS transport is always initialized. Incoming TLS connections will not work with it unless a user certificate is later configured. If not set (or set to NULL) only the default transport will be initialized. If set to empty string ("") the ZDK will try to guess the local hostname and will generate a self-signed certificate for a TLS transport that will listen for incoming TLS connections. Has a low chance of succeeding. Falls back to "localhost". Does not matter what is the value of domainCert. This will not stop the default TLS transport creation nor will force any users to use it for their outgoing TLS connections. Using self-signed domain TLS certificate is rarely supported by TLS peers and in most cases will not work. It is recommended not to use it. If set, it will use this domain, no matter what is the value of the domain name found in the certificate set with domainCert.
    
    Returns:
    
    The TLS domain name
    
    See Also:
    
    domainCert
  - domain
```
public void domain(java.lang.String value)
```
    Configures the local domain name A default TLS transport is always initialized. Incoming TLS connections will not work with it unless a user certificate is later configured. If not set (or set to NULL) only the default transport will be initialized. If set to empty string ("") the ZDK will try to guess the local hostname and will generate a self-signed certificate for a TLS transport that will listen for incoming TLS connections. Has a low chance of succeeding. Falls back to "localhost". Does not matter what is the value of domainCert. This will not stop the default TLS transport creation nor will force any users to use it for their outgoing TLS connections. Using self-signed domain TLS certificate is rarely supported by TLS peers and in most cases will not work. It is recommended not to use it. If set, it will use this domain, no matter what is the value of the domain name found in the certificate set with domainCert.
    
    Parameters:
    
    value - The TLS domain name
    
    See Also:
    
    domainCert
  - domainCert
```
public java.lang.String domainCert()
```
    Gets the configured domain certificate to be load If not set (or set to NULL) AND domain is also not set (or set to NULL) only the default TLS transport will be initialized. Incoming TLS connections will not work unless a user certificate is later configured. If not set (or set to NULL) AND domain is set a self-signed certificate will be created to be used for the incoming connections. Not recommended because self-signed domain TLS certificate are rarely supported by TLS peers and in most cases will not work. If set the ZDK will try loading a Certificate and Key pair from the file with this name. The file can be in PEM format (the order in which the certificate and key are pasted in it does not matter) or in PKCS#12 format (.PFX, the way the pair is exported in Windows). If it is in the PKCS#12 format any additional certificates will be added to the trusted certificate list. !!! NOTE !!! If domain is set (not NULL) the domain name found in the certificate will be ignored!
    
    Returns:
    
    The TLS domain certificate name
    
    See Also:
    
    domain
  - domainCert
```
public void domainCert(java.lang.String value)
```
    Configures the domain certificate to be load If not set (or set to NULL) AND domain is also not set (or set to NULL) only the default TLS transport will be initialized. Incoming TLS connections will not work unless a user certificate is later configured. If not set (or set to NULL) AND domain is set a self-signed certificate will be created to be used for the incoming connections. Not recommended because self-signed domain TLS certificate are rarely supported by TLS peers and in most cases will not work. If set the ZDK will try loading a Certificate and Key pair from the file with this name. The file can be in PEM format (the order in which the certificate and key are pasted in it does not matter) or in PKCS#12 format (.PFX, the way the pair is exported in Windows). If it is in the PKCS#12 format any additional certificates will be added to the trusted certificate list. !!! NOTE !!! If domain is set (not NULL) the domain name found in the certificate will be ignored!
    
    Parameters:
    
    value - The TLS domain certificate name
    
    See Also:
    
    domain
  - domainCertPassphrase
```
public java.lang.String domainCertPassphrase()
```
    Gets the configured domain certificate passphrase Can optionally contain the plaintext passphrase protecting the key set with domainCert. Can be left not set (or set to NULL pointer) if the key is not protected.
    
    Returns:
    
    The TLS domain certificate passphrase
    
    See Also:
    
    domainCert
  - domainCertPassphrase
```
public void domainCertPassphrase(java.lang.String value)
```
    Configures the domain certificate passphrase Can optionally contain the plaintext passphrase protecting the key set with domainCert. Can be left not set (or set to NULL pointer) if the key is not protected.
    
    Parameters:
    
    value - The TLS domain certificate passphrase
    
    See Also:
    
    domainCert
  - secureSuite
```
public TLSSecureSuiteType secureSuite()
```
    Gets the configured TLS secure suite type to be used By default it is set to TLSv1.2 (support TLSv1.2 and better/newer - TLSv1.3, etc are alsosupported!)
    
    Returns:
    
    The TLS secure suite type
    
    See Also:
    
    TLSSecureSuiteType
  - secureSuite
```
public void secureSuite(TLSSecureSuiteType value)
```
    Configures the TLS secure suite type to be used By default it is set to TLSv1.2 (support TLSv1.2 and better/newer - TLSv1.3, etc are alsosupported!)
    
    Parameters:
    
    value - The TLS secure suite type
    
    See Also:
    
    TLSSecureSuiteType

Class TLSConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TLSConfiguration

Method Detail

handle

finalize

tlsInitialized

tlsInitialized

useOnlyStrongCyphers

useOnlyStrongCyphers

domain

domain

domainCert

domainCert

domainCertPassphrase

domainCertPassphrase

secureSuite

secureSuite