Open topic with navigation

TIBCO ActiveSpaces® - Enterprise Edition 5.0.0

# ActiveSpaces Properties

The ActiveSpaces JDBC Driver makes invocations of the ActiveSpaces Java API. The ActiveSpaces Java API provides several API methods where properties can be specified which are needed to connect to the data grid or which affect the behavior of the data grid. However, in the JDBC driver you can only specify properties when you first connect to the data grid. Therefore, any properties that must be applied to Statements should also be specified in the set of properties used to connect to the data grid. When the JDBC API offers a method to set a value that can also be set using a property, the JDBC API's setting takes precedence.

The following partial list describes the most frequently used connection properties that can be specified. See the tables that follow to see other Connection, Session, and Statement properties that can be included in the set of properties specified when connecting to the data grid.

Property | Description | Default Value
--- | --- | ---
`com.tibco.tibdg.gridname` | Name of the data grid | `_default`
`com.tibco.tibdg.realmurl` | Realm Service URL. The Realm Service URLs use the pipe character (|) as a separator to provide a list of URLs. | `http://localhost:8080`
`com.tibco.tibdg.connectwaittime` | The amount of time to wait for a connection to be established. | `0.1 seconds`
`com.tibco.tibdg.timeout` | The amount of time to wait for responses from the data grid. | `5.0 seconds`

When specifying properties as part of the JDBC URL, the full property name or the property name without the `com.tibco.tibdg` prefix can be used. For example:

    jdbc:tibco:tibdg:_default;com.tibco.tibdg.realmurl=http://localhost:8080

Connection Property | Description | Default Value
--- | --- | ---
`com.tibco.tibdg.client.cert` | Specifies the client identity certificate. As an alternative to user/password, client applications can use a TLS certificate to authenticate with the grid. A TLS connection is required. Applications must also specify the private key along with the certificate. The value of this property must be a PEM file containing the certificate. The PEM file can also include intermediate certificates. Administrators must distribute client certificates to applications. Encode the client auth roles as a comma-separated list in the common name (CN) field of the client certificate. | None
`com.tibco.tibdg.client.private.key` | Specifies the private key of the client certificate. When you are using a TLS certificate to authenticate with the grid, also specify the corresponding private key and passphrase. The value of this property must be a PEM file containing the private key. | None
`com.tibco.tibdg.client.private.key.password` | Specifies the private key password of the client certificate, if it exists. When you are using a TLS certificate to authenticate with the grid, also specify the corresponding private key and passphrase. The value of this property must be a passphrase used to decrypt the private key. |
`com.tibco.tibdg.clientlabel` | Set the name used to refer to the client in monitoring and management components. | A string containing the grid name, client instance ID, and ActiveSpaces version.
`com.tibco.tibdg.connectbindstrategy` | Specifies how a client must establish a proxy connection. 0=choose a proxy at random 1=choose a proxy from the proxies listed in the `com.tibco.tibdg.connectproxynames` property 2=choose the proxy with the lowest load from the proxy responses received. This is the balanced bind strategy. | 0
`com.tibco.tibdg.connectnumresponses` | Specifies the number of responses to receive from proxies before the client stops looking for proxy responses. Only used when `com.tibco.tibdg.connectbindstrategy` has been set to 0 (random) or 2 (balanced) | 2147483647
`com.tibco.tibdg.connectproxynames` | A pipe '|' delimited list of proxy names for `com.tibco.tibdg.connectbindstrategy` | None
`com.tibco.tibdg.oauth2.client.id` | Specifies the OAuth 2.0 client. This client ID is required to get the OAuth 2.0 access token. When this parameter is specified along with `com.tibco.tibdg.oauth2.server.url` and `com.tibco.tibdg.oauth2.client.secret`, the application connects to the OAuth 2.0 server specified to get the OAuth 2.0 access token prior to connecting to the grid. | None
`com.tibco.tibdg.oauth2.client.secret` | Specifies the OAuth 2.0 client secret. This client secret is required to get the OAuth 2.0 access token. When this parameter is specified along with `com.tibco.tibdg.oauth2.server.url` and `com.tibco.tibdg.oauth2.client.id`, the application connects to the OAuth 2.0 server specified to get the OAuth 2.0 access token prior to connecting to the grid. | None
`com.tibco.tibdg.oauth2.server.trust.file` | Specifies the OAuth 2.0 server specific trust file. When the connection to the OAuth 2.0 server is secure (the URL starts with `https://`), specify this trust file, so the client knows whom to trust. If the trust file is available from the system trust store, you can omit it. | None
`com.tibco.tibdg.oauth2.server.url` | Specifies the OAuth 2.0 server URL. When this parameter is specified along with `com.tibco.tibdg.oauth2.client.secret` and `com.tibco.tibdg.oauth2.client.id`, the application connects to the OAuth 2.0 server specified to get the OAuth 2.0 access token before connecting to the grid. If this URL starts with `https://`, either the trust file for the OAuth 2.0 server must be available from the system trust store or specify `com.tibco.tibdg.oauth2.server.trust.file`. | None
`com.tibco.tibdg.realmconnectretries` | Specifies the number of times the underlying TIBCO FTL client library attempts to connect to the Realm. | 5
`com.tibco.tibdg.tporttype` | Specifies the type of TIBCO FTL transport that the client uses to connect to proxies. 0=DTCP 1=AUTO | Connection type is determined by the grid configuration.
`com.tibco.tibdg.trust.file` | Specifies the given file must be used to verify the realm server's certificate when `com.tibco.tibdg.trust.type` is set to `trust_file` | None
`com.tibco.tibdg.trust.type` | Specifies the type of "trust" to use when connecting to the realm server. `trust_file`=Use the trust file specified in the `com.tibco.tibdg.trust.file` property to verify the realm server's certificate. `trust_everyone`=The application trusts any realm server without verifying the trust in the realm server's certificate. Use for development only. | None
`com.tibco.tibdg.username` | Specifies the username to use when connecting to a secure realm server. | None
`com.tibco.tibdg.userpassword` | Specifies the password to use when connecting to a secure realm server. | None

Session Property | Description | Default
--- | --- | ---
`com.tibco.tibdg.checkpointname` | Use the specified checkpoint as the data source for this session's read operations. | None
`com.tibco.tibdg.immutablerows` | Specifies whether rows returned in ResultSets are immutable. true=rows cannot be modified false=rows can be modified | false

Statement Property | Description | Default
--- | --- | ---
`com.tibco.tibdg.statement.consistency` | When running queries, determines whether to wait for any previous transactions to be committed. Possible string values: global_snapshot, snapshot | global_snapshot - waits for writes to be committed
`com.tibco.tibdg.statement.prefetch` | Indicates the number of result rows to return to the client at a time for a query being run. Calling `Statement.setFetchSize()` overrides this property setting for the statement. | 256
`com.tibco.tibdg.statement.fetch.timeout` | Specifies how long (in seconds) the application waits for the next batch of query result rows before timing out. Calling `Statement.setQueryTimeout()` overrides this property and the `com.tibco.tibdg.statement.update.timeout` property for the statement. | If this property is not provided, the current timeout for the parent Connection is used.
`com.tibco.tibdg.statement.update.timeout` | Specifies how long (in seconds) the application waits for a reply to an ExecuteUpdate request, on a statement, before timing out. Calling `Statement.setQueryTimeout()` overrides this property and the `com.tibco.tibdg.statement.fetch.timeout` property for the statement. | If this property is not supplied the current timeout for the parent Connection is used.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO ActiveSpaces® - Enterprise Edition

Copyright © 2009-2025. Cloud Software Group, Inc. All Rights Reserved.