附录 A. ApiBuilder 的方法
下表列出了 Java 软件开发套件 V3 版本中
ApiBuilder
类可以使用的关键方法(method)。
方法 | 参数类型 | 描述 |
---|---|---|
user | String | 连接到 Manager 的用户的名称。您需要知道用户名和域(如 admin@internal )。这个方法需要和 password 方法一起使用。 |
password | String | 连接到 Manager 的用户的密码。 |
sessionID | String | 连接到 Manager 的会话 ID。如果已和 Manager 进行了验证并有可用的会话,则可以指定这个参数来替代用户名和密码。 |
requestTimeout | Integer | 等待请求响应的超时时间(以秒为单位)。如果请求在这个设置的时间内没有获得响应,则这个请求会被取消,并产生一个异常(exception)。这个参数是可选的。 |
sessionTimeout | Integer | 会话超时时间(以分钟为单位)。当经过这个指定的时间后还没有对 Manager 的请求,则活跃的会话会被删除。这个参数是可选的。 |
persistentAuth | Boolean | 指定是否使用 cookies 实现持久性验证。这个选项在默认情况下被启用,您只需要在禁用这个选项时才需要使用它。 |
noHostVerification | Boolean | 指定是否验证运行 Manager 的服务器上的 SSL 证书中的主机名。在默认情况下,主机名会被验证,如果主机名不正确,连接会被拒绝。只有在需要禁用这个选项时才使用这个方法。 |
keyStorePath | String | 指定包括一个 CA 证书的文件位置。这个证书被用来验证运行 Manager 的服务器上的证书。这个方法需要和 keyStorePassword 方法一起使用。 |
keyStorePassword | String | 访问在 keyStorePath 方法中指定的 keystore 文件时使用的密码。 |
filter | Boolean | 启用或禁用基于发出请求的用户的权限对项进行过滤的功能。它的默认设置是禁用,这会允许任何用户查看环境中的所有项。如果需要限制环境中的项只对有权限的用户可见,可以使用这个方法。 |
debug | Boolean | 启用或禁用 debug 输出。在默认情况下,这个选项被禁用。 |