Cloudant 資料庫 (cloudantDatabase)

Cloudant 資料庫的配置。

名稱	類型	預設值	說明
cloudantRef	最上層 cloudant 元素的參照（字串）。		指定當連接此資料庫時，將為「Cloudant 用戶端」建立的建置器。
create	boolean	true	指出如果資料庫不存在，「Cloudant 用戶端」應建立資料庫。
databaseName	string 必要		資料庫的名稱。
id	字串		唯一的配置 ID。
jndiName	string		JNDI 名稱。

名稱

類型

預設值

說明

cloudantRef

最上層 cloudant 元素的參照（字串）。

指定當連接此資料庫時，將為「Cloudant 用戶端」建立的建置器。

create

boolean

true

指出如果資料庫不存在，「Cloudant 用戶端」應建立資料庫。

databaseName

string
必要

資料庫的名稱。

字串

唯一的配置 ID。

jndiName

string

JNDI 名稱。

cloudant

指定當連接此資料庫時，將為「Cloudant 用戶端」建立的建置器。

名稱	類型	預設值	說明
account	string		用來連接 Cloudant 資料庫的帳戶名稱。
containerAuthDataRef	最上層 authData 元素的參照（字串）。		儲存器管理鑑別的預設鑑別資料，當連結沒有為 res-auth=CONTAINER 的資源參照指定鑑別別名時，就會套用它。
jndiName	string		JNDI 名稱。
libraryRef	最上層 library 元素的參照（字串）。		指定包含 Cloudant 用戶端程式庫及其相依關係的程式庫。
password	可逆的編碼密碼（字串）		您 Cloudant 使用者 ID 的對應密碼。
url	string		Cloudant 伺服器的 URL，包含主機和埠。
username	string		用來登入和存取您資料庫的 Cloudant 使用者 ID。
進階內容
connectTimeout	精準度是毫秒的時間量	5m	建立連線的逾時值。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。
disableSSLAuthentication	boolean	false	停用主機名稱驗證和憑證鏈驗證。
maxConnections	int 下限: 0	6	「Cloudant 用戶端」與主機之間所能建立的並行連線數目上限。
proxyPassword	可逆的編碼密碼（字串）		連接 Cloudant 伺服器時使用的 Proxy 伺服器使用者名稱所對應的密碼。
proxyUrl	string		連接至 Cloudant 伺服器時使用的 Proxy 伺服器 URL。
proxyUser	string		連接至 Cloudant 伺服器時使用的 Proxy 伺服器使用者名稱。
readTimeout	精準度是毫秒的時間量	5m	從已建立的用戶端連線等待回應的逾時值。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。
sslRef	最上層 ssl 元素的參照（字串）。		指定需要建立安全連線的 SSL 配置。

名稱

類型

預設值

說明

account

string

用來連接 Cloudant 資料庫的帳戶名稱。

containerAuthDataRef

最上層 authData 元素的參照（字串）。

儲存器管理鑑別的預設鑑別資料，當連結沒有為 res-auth=CONTAINER 的資源參照指定鑑別別名時，就會套用它。

jndiName

string

JNDI 名稱。

libraryRef

最上層 library 元素的參照（字串）。

指定包含 Cloudant 用戶端程式庫及其相依關係的程式庫。

password

可逆的編碼密碼（字串）

您 Cloudant 使用者 ID 的對應密碼。

url

string

Cloudant 伺服器的 URL，包含主機和埠。

username

string

用來登入和存取您資料庫的 Cloudant 使用者 ID。

進階內容

connectTimeout

精準度是毫秒的時間量

建立連線的逾時值。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。

disableSSLAuthentication

boolean

false

停用主機名稱驗證和憑證鏈驗證。

maxConnections

int
下限: 0

「Cloudant 用戶端」與主機之間所能建立的並行連線數目上限。

proxyPassword

可逆的編碼密碼（字串）

連接 Cloudant 伺服器時使用的 Proxy 伺服器使用者名稱所對應的密碼。

proxyUrl

string

連接至 Cloudant 伺服器時使用的 Proxy 伺服器 URL。

proxyUser

string

連接至 Cloudant 伺服器時使用的 Proxy 伺服器使用者名稱。

readTimeout

精準度是毫秒的時間量

從已建立的用戶端連線等待回應的逾時值。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。

sslRef

最上層 ssl 元素的參照（字串）。

指定需要建立安全連線的 SSL 配置。

cloudant > containerAuthData

儲存器管理鑑別的預設鑑別資料，當連結沒有為 res-auth=CONTAINER 的資源參照指定鑑別別名時，就會套用它。

名稱	類型	說明
krb5Principal	string	要使用的 Kerberos principal 名稱或 Kerberos 服務名稱。
krb5TicketCache	檔案的路徑	將在其中儲存 Kerberos 主體名稱或服務名稱的 Kerberos 認證的檔案位置。又稱為 Kerberos 認證快取 (ccache)
password	可逆的編碼密碼（字串）	連接至 EIS 時要使用的使用者密碼。其值可以用明碼或編碼形式儲存。建議您將密碼編碼。如果要這麼做，請搭配使用 securityUtility 工具與編碼選項。
user	string	連接至 EIS 時要使用的使用者名稱。

名稱

類型

預設值

說明

krb5Principal

string

要使用的 Kerberos principal 名稱或 Kerberos 服務名稱。

krb5TicketCache

檔案的路徑

將在其中儲存 Kerberos 主體名稱或服務名稱的 Kerberos 認證的檔案位置。又稱為 Kerberos 認證快取 (ccache)

password

可逆的編碼密碼（字串）

連接至 EIS 時要使用的使用者密碼。其值可以用明碼或編碼形式儲存。建議您將密碼編碼。如果要這麼做，請搭配使用 securityUtility 工具與編碼選項。

user

string

連接至 EIS 時要使用的使用者名稱。

cloudant > library

指定包含 Cloudant 用戶端程式庫及其相依關係的程式庫。

名稱	類型	預設值	說明
apiTypeVisibility	string	spec,ibm-api,api,stable	這個類別載入器支援這種 API 套件的類型。值是下列 API 套件之任何組合的逗點區隔清單：spec、ibm-api、api、stable、third-party。
description	string		管理者的共用程式庫說明
filesetRef	最上層 fileset 元素的參照清單（逗點區隔的字串）。		指定要包含在此函式庫類別路徑中的 JAR 或 ZIP 檔案集
name	string		管理者的共用程式庫名稱

名稱

類型

預設值

說明

apiTypeVisibility

string

spec,ibm-api,api,stable

這個類別載入器支援這種 API 套件的類型。值是下列 API 套件之任何組合的逗點區隔清單：spec、ibm-api、api、stable、third-party。

description

string

管理者的共用程式庫說明

filesetRef

最上層 fileset 元素的參照清單（逗點區隔的字串）。

指定要包含在此函式庫類別路徑中的 JAR 或 ZIP 檔案集

name

string

管理者的共用程式庫名稱

cloudant > library > file

新增 JAR 或 ZIP 檔案，以包含在此函式庫的類別路徑中。指定的 JAR 或 ZIP 中包含的類別和資源可供此函式庫載入。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
name	檔案的路徑必要		檔案的路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

name

檔案的路徑
必要

檔案的路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。

cloudant > library > fileset

指定要包含在此函式庫類別路徑中的 JAR 或 ZIP 檔案集

名稱	類型	預設值	說明
caseSensitive	boolean	true	指出搜尋是否應該區分大小寫的布林值（預設值：true）。
dir	目錄的路徑	${server.config.dir}	搜尋檔案的基本目錄。
excludes	string		要從搜尋結果中且以逗點或空格區隔的檔名型樣清單，預設為不排除任何檔案。
id	字串		唯一的配置 ID。
includes	string	*	要併入搜尋結果中且以逗點或空格區隔的檔名型樣清單（預設值：*）。
scanInterval	精準度是毫秒的時間量	0	掃描間隔，用來判定是否從檔案集新增或移除檔案。不會掃描個別檔案。時間間隔的字尾是 h-小時、m-分鐘、s-秒及ms-毫秒，例如 2ms 或 5s。依預設會停用掃描間隔，並透過將掃描間隔 scanInterval 設為 0 來手動停用。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。

名稱

類型

預設值

說明

caseSensitive

boolean

true

指出搜尋是否應該區分大小寫的布林值（預設值：true）。

dir

目錄的路徑

${server.config.dir}

搜尋檔案的基本目錄。

excludes

string

要從搜尋結果中且以逗點或空格區隔的檔名型樣清單，預設為不排除任何檔案。

字串

唯一的配置 ID。

includes

string

要併入搜尋結果中且以逗點或空格區隔的檔名型樣清單（預設值：*）。

scanInterval

精準度是毫秒的時間量

掃描間隔，用來判定是否從檔案集新增或移除檔案。不會掃描個別檔案。時間間隔的字尾是 h-小時、m-分鐘、s-秒及ms-毫秒，例如 2ms 或 5s。依預設會停用掃描間隔，並透過將掃描間隔 scanInterval 設為 0 來手動停用。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。

cloudant > library > folder

新增資料夾，以包含在此函式庫的類別路徑中。指定資料夾及其子資料夾中所包含的類別和資源可供此函式庫載入。指定資料夾中包含的 JAR 和 ZIP 檔案不會新增至此函式庫的類別路徑。

名稱	類型	預設值	說明
dir	目錄的路徑必要		資料夾的路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。
id	字串		唯一的配置 ID。

名稱

類型

預設值

說明

dir

目錄的路徑
必要

資料夾的路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。

字串

唯一的配置 ID。

cloudant > library > path

新增 JAR 檔案、ZIP 檔案或資料夾，以包含在此函式庫的類別路徑中。如果指定的路徑是 JAR 或 ZIP 檔案，則指定的 JAR 或 ZIP 檔案中所包含的類和資源可供此函式庫載入。如果指定的路徑是資料夾，則指定資料夾及其子資料夾中包含的類別和資源可供此函式庫載入。指定資料夾中包含的 JAR 和 ZIP 檔案不會新增至此函式庫的類別路徑。

名稱	類型	預設值	說明
id	字串		唯一的配置 ID。
name	檔案、目錄或 URL。必要		路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

name

檔案、目錄或 URL。
必要

路徑可以是完全限定路徑或相對路徑。相對路徑是相對於 $ {server.config.dir} 屬性的值。

cloudant > ssl

指定需要建立安全連線的 SSL 配置。

名稱	類型	預設值	說明
clientAuthentication	boolean	false	指定是否啟用用戶端鑑別。如果設為 true，則需要用戶端鑑別，且用戶端必須提供伺服器信任的憑證。
clientAuthenticationSupported	boolean	false	指定是否支援用戶端鑑別。如果設為 true，則用戶端鑑別支援表示一旦用戶端出示憑證，伺服器會檢查是否信任該用戶端。
clientKeyAlias	string		指定金鑰儲存庫中的憑證別名，該憑證將作為金鑰，並傳送給已啟用用戶端鑑別的伺服器。只有在金鑰儲存庫有多個金鑰項目時，才需要這個屬性。
enabledCiphers	string		指定自訂的密碼清單。在清單中，各密碼之間請空一格。支援的密碼取決於所使用的基礎 JRE。請檢查 JRE，取得有效的密碼。
enforceCipherOrder	boolean	false	指定是否在伺服器 Socket 上施行密碼順序。如果設為 true，則會啟用伺服器 Socket 以施行密碼順序。依預設，此屬性會設為 false。
keyStoreRef	最上層 keyStore 元素的參照（字串）。		包含 SSL 儲存庫之金鑰項目的金鑰儲存庫。這個屬性是必要的。
securityLevel	CUSTOM HIGH LOW MEDIUM	HIGH	指定 SSL 信號交換所用的密碼組合群組。「高」是 3DES 和 128 位元（及以上）密碼，「中」是 DES 和 40 位元密碼，「低」是沒有加密的密碼。如果使用 enabledCiphers 屬性，則會忽略 securityLevel 清單。 CUSTOM 自訂的密碼組合清單 HIGH 密碼組合 3DES 和 128 位元（及以上） LOW 沒有加密的密碼組合 MEDIUM 密碼組合 DES 和 40 位元
serverKeyAlias	string		指定金鑰儲存庫中要作為伺服器金鑰之憑證的別名。只有在金鑰儲存庫有多個金鑰項目時，才需要這個屬性。
skipHostnameVerificationForHosts	string		指定主機名稱，允許使用特定 SSL 設定的出站連線跳過主機名稱驗證。
sslProtocol	string		SSL 信號交換通訊協定。通訊協定可以設為在基礎 JRE 的 Java Secure Socket Extension (JSSE) 提供者說明文件中找到的單一值。當使用 IBM JRE 時，預設值是 SSL_TLSv2；當使用 Oracle JRE 時，預設值是 SSL。通訊協定也可以是下列任何值的逗點區隔清單：TLSv1、TLSv1.1、TLSv1.2 或 TLSv1.3。
trustDefaultCerts	boolean	false	指定信任管理程式是否可以使用預設憑證來建立信任。如果設為 true，則除了所配置的信任儲存庫檔案，還會使用預設憑證來建立信任。依預設，會將屬性設為 false。
trustStoreRef	最上層 keyStore 元素的參照（字串）。		包含 SSL 儲存庫用於簽署確認之信任憑證項目的金鑰儲存庫。這個屬性是選用的。如果未指定，則會對金鑰及信任的憑證項目都使用相同的金鑰儲存庫。
verifyHostname	boolean	true	指定是否啟用主機名稱驗證，以使用特定的 SSL 配置來驗證出埠連線。如果設為 true，只要出埠 SSL 連線使用指定的 SSL 配置，系統就會驗證目標伺服器的主機名稱是否符合該伺服器的憑證。

名稱

類型

預設值

說明

clientAuthentication

boolean

false

指定是否啟用用戶端鑑別。如果設為 true，則需要用戶端鑑別，且用戶端必須提供伺服器信任的憑證。

clientAuthenticationSupported

boolean

false

指定是否支援用戶端鑑別。如果設為 true，則用戶端鑑別支援表示一旦用戶端出示憑證，伺服器會檢查是否信任該用戶端。

clientKeyAlias

string

指定金鑰儲存庫中的憑證別名，該憑證將作為金鑰，並傳送給已啟用用戶端鑑別的伺服器。只有在金鑰儲存庫有多個金鑰項目時，才需要這個屬性。

enabledCiphers

string

指定自訂的密碼清單。在清單中，各密碼之間請空一格。支援的密碼取決於所使用的基礎 JRE。請檢查 JRE，取得有效的密碼。

enforceCipherOrder

boolean

false

指定是否在伺服器 Socket 上施行密碼順序。如果設為 true，則會啟用伺服器 Socket 以施行密碼順序。依預設，此屬性會設為 false。

keyStoreRef

最上層 keyStore 元素的參照（字串）。

包含 SSL 儲存庫之金鑰項目的金鑰儲存庫。這個屬性是必要的。

securityLevel

CUSTOM
HIGH
LOW
MEDIUM

HIGH

指定 SSL 信號交換所用的密碼組合群組。「高」是 3DES 和 128 位元（及以上）密碼，「中」是 DES 和 40 位元密碼，「低」是沒有加密的密碼。如果使用 enabledCiphers 屬性，則會忽略 securityLevel 清單。
CUSTOM
自訂的密碼組合清單
HIGH
密碼組合 3DES 和 128 位元（及以上）
LOW
沒有加密的密碼組合
MEDIUM
密碼組合 DES 和 40 位元

serverKeyAlias

string

指定金鑰儲存庫中要作為伺服器金鑰之憑證的別名。只有在金鑰儲存庫有多個金鑰項目時，才需要這個屬性。

skipHostnameVerificationForHosts

string

指定主機名稱，允許使用特定 SSL 設定的出站連線跳過主機名稱驗證。

sslProtocol

string

SSL 信號交換通訊協定。通訊協定可以設為在基礎 JRE 的 Java Secure Socket Extension (JSSE) 提供者說明文件中找到的單一值。當使用 IBM JRE 時，預設值是 SSL_TLSv2；當使用 Oracle JRE 時，預設值是 SSL。通訊協定也可以是下列任何值的逗點區隔清單：TLSv1、TLSv1.1、TLSv1.2 或 TLSv1.3。

trustDefaultCerts

boolean

false

指定信任管理程式是否可以使用預設憑證來建立信任。如果設為 true，則除了所配置的信任儲存庫檔案，還會使用預設憑證來建立信任。依預設，會將屬性設為 false。

trustStoreRef

最上層 keyStore 元素的參照（字串）。

包含 SSL 儲存庫用於簽署確認之信任憑證項目的金鑰儲存庫。這個屬性是選用的。如果未指定，則會對金鑰及信任的憑證項目都使用相同的金鑰儲存庫。

verifyHostname

boolean

true

指定是否啟用主機名稱驗證，以使用特定的 SSL 配置來驗證出埠連線。如果設為 true，只要出埠 SSL 連線使用指定的 SSL 配置，系統就會驗證目標伺服器的主機名稱是否符合該伺服器的憑證。

cloudant > ssl > keyStore

包含 SSL 儲存庫之金鑰項目的金鑰儲存庫。這個屬性是必要的。

名稱	類型	預設值	說明
fileBased	boolean	true	如果金鑰儲存庫是檔案型，請指定 true；如果金鑰儲存庫是 SAF 金鑰環或硬體金鑰儲存庫類型，請指定 false。
id	string	defaultKeyStore	唯一的配置 ID。
location	檔案、目錄或 URL。	${server.output.dir}/resources/security/key.p12	金鑰儲存庫檔的絕對路徑或相對路徑。如果提供相對路徑，伺服器將會嘗試在 ${server.output.dir}/resources/security 目錄中找出此檔案。對檔案型金鑰儲存庫使用金鑰儲存庫檔；對 SAF 金鑰環使用金鑰環名稱，或是對硬體加密裝置使用裝置配置檔。在 SSL 最小配置中，假設檔案的位置為 ${server.output.dir}/resources/security/key.p12。
password	可逆的編碼密碼（字串）		用來載入金鑰儲存庫檔的密碼。其值可以用明碼或編碼形式儲存。請使用 securityUtility 工具來將密碼編碼。
pollingRate	精準度是毫秒的時間量	500ms	伺服器檢查金鑰儲存庫檔更新項目的頻率。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。
readOnly	boolean	false	如果伺服器只為了讀取而使用金鑰儲存庫，請指定 true；如果伺服器會對金鑰儲存庫執行寫入作業，請指定 false。
type	string	PKCS12	目標 SDK 支援的金鑰儲存庫類型。
updateTrigger	disabled mbean polled	mbean	金鑰儲存庫檔案更新方法或觸發程式。 disabled 停用所有更新監視。當伺服器正在執行時，不會套用金鑰儲存庫檔案的變更。 mbean 只在 FileNotificationMbean 提示時，伺服器才更新金鑰儲存庫。外部程式（例如：整合開發環境或管理應用程式）通常會呼叫 FileNotificationMBean。 polled 伺服器會依輪詢間隔來掃描金鑰儲存庫檔案的變更，如果可偵測到金鑰儲存庫檔案的變更，就會進行更新。輪詢的金鑰儲存庫不適用於非檔案型金鑰儲存庫，例如 SAF 金鑰環。

名稱

類型

預設值

說明

fileBased

boolean

true

如果金鑰儲存庫是檔案型，請指定 true；如果金鑰儲存庫是 SAF 金鑰環或硬體金鑰儲存庫類型，請指定 false。

string

defaultKeyStore

唯一的配置 ID。

location

檔案、目錄或 URL。

${server.output.dir}/resources/security/key.p12

金鑰儲存庫檔的絕對路徑或相對路徑。如果提供相對路徑，伺服器將會嘗試在 ${server.output.dir}/resources/security 目錄中找出此檔案。對檔案型金鑰儲存庫使用金鑰儲存庫檔；對 SAF 金鑰環使用金鑰環名稱，或是對硬體加密裝置使用裝置配置檔。在 SSL 最小配置中，假設檔案的位置為 ${server.output.dir}/resources/security/key.p12。

password

可逆的編碼密碼（字串）

用來載入金鑰儲存庫檔的密碼。其值可以用明碼或編碼形式儲存。請使用 securityUtility 工具來將密碼編碼。

pollingRate

精準度是毫秒的時間量

500ms

伺服器檢查金鑰儲存庫檔更新項目的頻率。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。

readOnly

boolean

false

如果伺服器只為了讀取而使用金鑰儲存庫，請指定 true；如果伺服器會對金鑰儲存庫執行寫入作業，請指定 false。

type

string

PKCS12

目標 SDK 支援的金鑰儲存庫類型。

updateTrigger

disabled
mbean
polled

mbean

金鑰儲存庫檔案更新方法或觸發程式。
disabled
停用所有更新監視。當伺服器正在執行時，不會套用金鑰儲存庫檔案的變更。
mbean
只在 FileNotificationMbean 提示時，伺服器才更新金鑰儲存庫。外部程式（例如：整合開發環境或管理應用程式）通常會呼叫 FileNotificationMBean。
polled
伺服器會依輪詢間隔來掃描金鑰儲存庫檔案的變更，如果可偵測到金鑰儲存庫檔案的變更，就會進行更新。輪詢的金鑰儲存庫不適用於非檔案型金鑰儲存庫，例如 SAF 金鑰環。

cloudant > ssl > keyStore > keyEntry

唯一的配置 ID。

名稱	類型	說明
id	字串	唯一的配置 ID。
keyPassword	可逆的編碼密碼（字串）必要	金鑰儲存庫中之私密金鑰項目的密碼。
name	string 必要	金鑰儲存庫中之私密金鑰項目的名稱。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

keyPassword

可逆的編碼密碼（字串）
必要

金鑰儲存庫中之私密金鑰項目的密碼。

name

string
必要

金鑰儲存庫中之私密金鑰項目的名稱。

cloudant > ssl > outboundConnection

唯一的配置 ID。

名稱	類型	說明
clientCertificate	string	如果您建立連線來連接支援或需要用戶端鑑別的伺服器，用戶端會使用這個憑證別名。
host	string 必要	伺服器在存取指定的主機名稱時，會使用這項 SSL 配置。
id	字串	唯一的配置 ID。
port	int	伺服器在存取位於指定埠的遠端主機名稱時，會使用這項 SSL 配置。

名稱

類型

預設值

說明

clientCertificate

string

如果您建立連線來連接支援或需要用戶端鑑別的伺服器，用戶端會使用這個憑證別名。

host

string
必要

伺服器在存取指定的主機名稱時，會使用這項 SSL 配置。

字串

唯一的配置 ID。

port

int

伺服器在存取位於指定埠的遠端主機名稱時，會使用這項 SSL 配置。

cloudant > ssl > trustStore

包含 SSL 儲存庫用於簽署確認之信任憑證項目的金鑰儲存庫。這個屬性是選用的。如果未指定，則會對金鑰及信任的憑證項目都使用相同的金鑰儲存庫。

名稱	類型	預設值	說明
fileBased	boolean	true	如果金鑰儲存庫是檔案型，請指定 true；如果金鑰儲存庫是 SAF 金鑰環或硬體金鑰儲存庫類型，請指定 false。
id	string	defaultKeyStore	唯一的配置 ID。
location	檔案、目錄或 URL。	${server.output.dir}/resources/security/key.p12	金鑰儲存庫檔的絕對路徑或相對路徑。如果提供相對路徑，伺服器將會嘗試在 ${server.output.dir}/resources/security 目錄中找出此檔案。對檔案型金鑰儲存庫使用金鑰儲存庫檔；對 SAF 金鑰環使用金鑰環名稱，或是對硬體加密裝置使用裝置配置檔。在 SSL 最小配置中，假設檔案的位置為 ${server.output.dir}/resources/security/key.p12。
password	可逆的編碼密碼（字串）		用來載入金鑰儲存庫檔的密碼。其值可以用明碼或編碼形式儲存。請使用 securityUtility 工具來將密碼編碼。
pollingRate	精準度是毫秒的時間量	500ms	伺服器檢查金鑰儲存庫檔更新項目的頻率。. 指定正整數加上時間單位，時間單位可以是小時 (h)、分鐘 (m)、秒 (s) 或毫秒 (ms)。例如，指定 500 毫秒為 500ms。您可以在單一項目中包括多個值。例如，1s500ms 相等於 1.5 秒。
readOnly	boolean	false	如果伺服器只為了讀取而使用金鑰儲存庫，請指定 true；如果伺服器會對金鑰儲存庫執行寫入作業，請指定 false。
type	string	PKCS12	目標 SDK 支援的金鑰儲存庫類型。
updateTrigger	disabled mbean polled	mbean	金鑰儲存庫檔案更新方法或觸發程式。 disabled 停用所有更新監視。當伺服器正在執行時，不會套用金鑰儲存庫檔案的變更。 mbean 只在 FileNotificationMbean 提示時，伺服器才更新金鑰儲存庫。外部程式（例如：整合開發環境或管理應用程式）通常會呼叫 FileNotificationMBean。 polled 伺服器會依輪詢間隔來掃描金鑰儲存庫檔案的變更，如果可偵測到金鑰儲存庫檔案的變更，就會進行更新。輪詢的金鑰儲存庫不適用於非檔案型金鑰儲存庫，例如 SAF 金鑰環。

名稱

類型

預設值

說明

fileBased

boolean

true

如果金鑰儲存庫是檔案型，請指定 true；如果金鑰儲存庫是 SAF 金鑰環或硬體金鑰儲存庫類型，請指定 false。

string

defaultKeyStore

唯一的配置 ID。

location

檔案、目錄或 URL。

${server.output.dir}/resources/security/key.p12

password

可逆的編碼密碼（字串）

用來載入金鑰儲存庫檔的密碼。其值可以用明碼或編碼形式儲存。請使用 securityUtility 工具來將密碼編碼。

pollingRate

精準度是毫秒的時間量

500ms

readOnly

boolean

false

如果伺服器只為了讀取而使用金鑰儲存庫，請指定 true；如果伺服器會對金鑰儲存庫執行寫入作業，請指定 false。

type

string

PKCS12

目標 SDK 支援的金鑰儲存庫類型。

updateTrigger

disabled
mbean
polled

mbean

cloudant > ssl > trustStore > keyEntry

唯一的配置 ID。

名稱	類型	說明
id	字串	唯一的配置 ID。
keyPassword	可逆的編碼密碼（字串）必要	金鑰儲存庫中之私密金鑰項目的密碼。
name	string 必要	金鑰儲存庫中之私密金鑰項目的名稱。

名稱

類型

預設值

說明

字串

唯一的配置 ID。

keyPassword

可逆的編碼密碼（字串）
必要

金鑰儲存庫中之私密金鑰項目的密碼。

name

string
必要

金鑰儲存庫中之私密金鑰項目的名稱。