付録A ApiBuilder メソッド

user

文字列

Manager への接続に使用するユーザー。admin@internal のようにユーザー名とドメインの両方を指定する必要があります。このメソッドは、password メソッドと合わせて使用する必要があります。

password

文字列

Manager への接続に使用するユーザーのパスワード。

sessionID

文字列

Manager への接続に使用するセッションの ID。Manager の認証が済んでいて、セッションが利用できる場合には、ユーザー名とパスワードではなくこの引数を指定することができます。

requestTimeout

整数

要求に応答するまで待機するタイムアウトの値 (秒)。要求への応答時間がこの値よりも長い場合には、要求はキャンセルされ、例外が送出されます。この引数は任意です。

sessionTimeout

整数

Manager に要求が出されない場合にアクティブなセッションを破棄する

persistentAuth

ブール値

cookie を使用した永続的な認証を有効化または無効化します。デフォルトではこのオプションは有効となっているため、このオプションを無効にする場合のみこのメソッドが必要です。

noHostVerification

ブール値

Manager のホスト先のサーバーが公開する SSL 証明書のホスト名の検証を有効化または無効化します。デフォルトでは、ホスト名のアイデンティティーは検証され、ホスト名が正しくない場合には接続が拒否されます。そのため、このオプションを無効にする場合のみこのメソッドが必要です。

keyStorePath

文字列

Manager のホスト先のサーバーが公開する証明書の検証に使用する CA 証明書が含まれるファイルの場所を指定します。このメソッドは、keyStorePassword メソッドと合わせて使用する必要があります。

keyStorePassword

文字列

keyStorePath メソッドで指定するキーストアファイルにアクセスする際に使用するパスワード。

filter

ブール値

要求を行うユーザーのパーミッションをベースにしたオブジェクトのフィルタリングを有効化または無効化します。デフォルトでは、このオプションは無効になっており、この環境内のオブジェクトがすべてユーザーに表示されます。このメソッドは、要求を行うユーザーにだけ環境内のオブジェクトを表示するように制限する際にのみ必要です。

debug

ブール値

デバッグの出力を有効化または無効化します。デフォルトでは、このオプションは無効になっています。