cloudantDatabase - Cloudant Database (cloudantDatabase)

Configuration for a Cloudant Database.

NameTypeDefaultDescription
idstringA unique configuration ID.
cloudantRefA reference to top level cloudant element (string).Specifies the builder for the Cloudant Client that will be used when connecting to this database.
createbooleantrueIndicates that the Cloudant Client should create the database if it does not already exist.
databaseNamestringName of the database.
jndiNamestringJNDI name.

cloudant

Specifies the builder for the Cloudant Client that will be used when connecting to this database.

NameTypeDefaultDescription
libraryRefA reference to top level library element (string).Specifies a library that contains the Cloudant Client library and its dependencies.
disableSSLAuthenticationbooleanfalseDisables host name verification and certificate chain validation.
jndiNamestringJNDI name.
urlstringURL for the Cloudant server, which includes the host and port.
accountstringAccount name used to connect to a Cloudant database.
containerAuthDataRefA reference to top level authData element (string).Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
usernamestringThe Cloudant user ID used to log in and access your databases.
passwordReversably encoded password (string)Password corresponding to your Cloudant user ID.
connectTimeoutA period of time with millisecond precision5mThe timeout to establish a connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
maxConnectionsint
Min: 0
6The maximum number of concurrent connections that a Cloudant Client can make to the host.
proxyUrlstringThe URL of a proxy server to use when connecting to a Cloudant server.
proxyUserstringUser name for a proxy server to use when connecting to a Cloudant server.
proxyPasswordReversably encoded password (string)Password corresponding to the user name for a proxy server to use when connecting to a Cloudant server.
readTimeoutA period of time with millisecond precision5mTimeout value to wait for a response from an established client connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
sslRefA reference to top level ssl element (string).Specifies the SSL configuration that is needed to establish a secure connection.

cloudant > library

Specifies a library that contains the Cloudant Client library and its dependencies.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,apiThe types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.

cloudant > library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

cloudant > library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

cloudant > library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

cloudant > containerAuthData

Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

cloudant > ssl

Specifies the SSL configuration that is needed to establish a secure connection.

NameTypeDefaultDescription
keyStoreRefA reference to top level keyStore element (string).A keystore containing key entries for the SSL repertoire. This attribute is required.
trustStoreRefA reference to top level keyStore element (string).${keyStoreRef}A keystore containing trusted certificate entries used by the SSL repertoire for signing verification. This attribute is optional. If unspecified, the same keystore is used for both key and trusted certificate entries.
sslProtocolstringThe SSL handshake protocol. Protocol values can be found in the documentation for the underlying JRE's Java Secure Socket Extension (JSSE) provider. When using the IBM JRE the default value is SSL_TLS and when using the Oracle JRE the default value is SSL.
clientAuthenticationbooleanfalseSpecifies whether client authentication is enabled. If set to true then client authentication is required and the client must provide a certificate for the server trusts.
clientAuthenticationSupportedbooleanfalseSpecifies whether a client authentication is supported. If set to true then the client authentication support means the server will check trust from a client if the client presents a certificate.
securityLevel
  • MEDIUM
  • CUSTOM
  • HIGH
  • LOW
HIGHSpecifies the cipher suite group used by the SSL handshake. HIGH are 3DES and 128 bit and higher ciphers, MEDIUM are DES and 40 bit ciphers, LOW are ciphers without encryption. If the enabledCiphers attribute is used the securityLevel list is ignored.
MEDIUM
%repertoire.MEDIUM
CUSTOM
%repertoire.CUSTOM
HIGH
Cipher suites 3DES and 128 bit and higher
LOW
%repertoire.LOW
clientKeyAliasstringSpecifies the alias of the certificate in the keystore that is used as the key to send to a server that has client authentication enabled. This attribute is only needed if the keystore has more than one key entry.
serverKeyAliasstringSpecifies the alias of the certificate in the keystore used as the server's key. This attribute is only needed if the keystore has more then one key entry.
enabledCiphersstringSpecifies a custom list of ciphers. Separate each cipher in the list with a space. The supported cipher will depend on the underlying JRE used. Please check the JRE for valid ciphers.