Menu
Simba Technologies
Simba Technologies

SimbaEngine X SDK 10.1.15
SimbaClient/Server Developer Guide

SimbaClient for JDBC Configuration Properties

All configuration properties are configured either programmatically or on the connection string.The following table summarize the configuration properties. Detailed descriptions are provided in subsequent tables.

Property Description

UID

User ID.

PWD

User password.

Timeout properties

LoginTimeout

The time to wait for a response during login.

ConnectionTimeout

The time to wait for a response from the server.

Logging configuration properties

LogLevel

Controls the granularity of the messages and events that are logged.

LogPath

Specifies the directory where the log files are created.

Integrated security (single sign-on) properties

UseIntegratedSecurity

Indicates whether integrated security (Kerberos) should be used.

ServicePrincipalName

The service principal name for the server with integrated security.

Secure socket layer (SSL) properties

UseSsl

Enable SSL encryption for the connection between SimbaClient and SimbaServer.

TrustedStorePath

The location of the Java keystore.

TrustedStorePassword

The password used to access the trusted key store.

SSLAllowHostMismatch

Specifies whether the client will accept a hostname from the server that differs from the one in the server's SSL certificate.

SSLAllowExpiredCert

Specifies whether the client will accept an expired SSL certificate from the server.

SSLCACertFile

Location of the SSL certificate authority certification file.

General configuration properties

UID

The username to use when accessing the driver.

Required

Yes, if the server requires it.

Allowed values

Any valid string.

Default value

None

Example

UID=jdoe

Comment

The sample Quickstart implementation does not require a username or password in order to establish a connection between the JDB client and the SimbaServer. You can modify the server to require a username and password.

PWD

The password to use when accessing the driver.

Required

Yes if the driver requires it.

Allowed values

Any valid string.

Default value

None

Example

PWD=123Hello

Timeout Properties

For more information on timeout behavior, see How does timeout work?

LoginTimeout

The time, in seconds, to wait for a response from the server after a login request is made by the client.

Required

No

Range

0 – UINT_MAX seconds

Default value

60

Example

LoginTimeout=10

Comment

A value of 0 means no timeout.

The value of this property is used to set the value of SQL_ATTR_LOGIN_TIMEOUT.

Note:

  • A log in timeout may occur earlier than the time specified by this value. For example, if a DNS lookup failure occurs, the log in attempt times out immediately.
  • If additional servers are specified in ServerList, the client attempts to log in to the other servers before timing out.

ConnectionTimeout

The timeout, in seconds, to wait for a response from the server after sending a command.

Required

No

Range

0 – UINT_MAX seconds

Default value

0 (no timeout)

Example

ConnectionTimeout=10

Comment

A value of 0 means no timeout.

Logging configuration properties

LogLevel

Controls the granularity of the messages and events that are logged.

Note:

Log files are not created if this value is set to OFF.

Required

No

Allowed
values

See Comment.

Default value

OFF

Example

LogLevel=ERROR

Comment

With this keyword, you can control the amount of log output by controlling the kinds of events that are logged.

Possible values (case sensitive):

  • OFF: no logging occurs
  • FATAL: only log fatal errors
  • ERROR: log all errors
  • WARNING: log all errors and warnings
  • INFO: log all errors, warnings, and informational messages
  • DEBUG: log method entry and exit points and parameter values for debugging
  • TRACE: log all method entry points

You can also use integers 0 - 6 instead of String, but String is more descriptive.

LogPath

Specifies where the log file is created.

Required

No

Allowed values

Valid directory path, or unspecified.

Default value

Unspecified

Example

LogPath=C:\Simba Technologies\Temp

Comment

If this value is not set, the log files are written to the current working directory of the SimbaClient.

Integrated security (single sign-on) properties

For more information on configuring Kerberos, see Overview.

ServicePrincipalName

The service principal name for the server with integrated security.

Required

Yes if UseIntegratedSecurity is True.

Allowed
values

Any valid service principal name.

Default
value

no default

Example

ServicePrincipalName=<SPN of the server>

UseIntegratedSecurity

Indicates whether integrated security (single sign-on), should be used when the client establishes a connection to the server. Kerberos authentication is used for integrated security.

Note:

You must configure UseIntegratedSecurity on both the SimbaServer and the SimbaClient in order to use integrated security.

Required

No

Allowed values

Disabled, Enabled, Required

Default value

Disabled

Example

UseIntegratedSecurity=Required

Comment

If enabled on the client and the server, integrated security will be used during connection.

For a summary of the connection types that will be established based on the different client and server settings, see Configuration Properties for Integrated Security.

Secure socket layer (SSL) properties

For more information on configuring SSL, see Overview.

TrustedStorePath

The location of the Java keystore.

Required

No

Allowed values

Valid absolute or relative directory path to the SSL trusted store.

Default value

no default

Example

TrustedStorePath="C:\JDBCKeyStore"

Comment

Use one of the following options to enable SSL:

  • TrustedStorePath and
    TrustedStorePassword
  • Or, SSLCACertFile

TrustedStorePassword

The password used to access the trusted key store.

Required

No

Allowed values

Any valid string.

Default value

none

Example

TrustedStorePassword=SimbaServer1543

Comment

Use one of the following options to enable SSL:

  • TrustedStorePath and
    TrustedStorePassword
  • Or, SSLCACertFile

SSLAllowExpiredCert

Specifies whether the client will accept an expired SSL certificate from the server.

Required

No

Range

Yes or No (also accepts 1 or 0)

Default value

No

Example

SSLAllowExpiredCert=Yes

Comment

When enabled, the client will accept an expired SSL certificate from the server.

SSLAllowHostMismatch

Specifies whether the client will accept a hostname from the server that differs from the one in the server's SSL certificate.

Required

No

Allowed values

Yes or No(also accepts 1 or 0).

Default value

No

Example

SSLAllowHostMismatch=Yes

Comment

When enabled, the client will accept a different hostname from the server than the one specified in the server’s SSL certificate.

SSLCACertfile

Location of the SSL certificate authority certification file for SimbaClient to use when encrypting SSL communication with SimbaServer.

Required

Yes if UseSsl is enabled.

Allowed
values

Disabled, Enabled, Required

Default
value

Disabled

Example

SSLCACertFile=C:\Simba Technologies\SimbaEngineSDK\10.1
\Documentation\SSLCertificates\
SampleCACertificate.pem

UseSsl

This setting allows the connection between the SimbaClients and SimbaServer to use Secure Sockets Layer (SSL) encryption.

Note:

You must configure SSL on both the SimbaServer and the SimbaClient in order to establish a secure connection. See Configuration Properties for SSL.

Required

Yes, if UseSsl is enabled on the Server.

Allowed values

Disabled, Enabled, Required

Default value

Disabled

Example

UseSsl=Enabled