JsonConfigBasedBoxClientService

文档中心 › 组件索引 › JsonConfigBasedBoxClientService

JsonConfigBasedBoxClientService Controller Service

类型全限定名:cn.org.acal.lynxus.box.controllerservices.JsonConfigBasedBoxClientService

所属 Bundle:cn.org.acal.lynxus:lynxus-box-services-nar:2.11.8

描述

提供 Box 客户端对象,通过这些对象可以使用 Box API 调用。

标签

boxclientprovider

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
App Actorimpersonated-user
  • Service Account — 使用与该应用关联的服务账户进行 Box API 调用
  • Impersonated User — 使用 as-user 头代表指定的 Box 用户进行 Box API 调用
指定将代表谁进行 Box API 调用。
Account ID应用程序将代表的 Box 帐户的 ID。
支持表达式语言:是(仅使用环境/系统变量求值)
应用配置文件应用配置 JSON 文件的完整路径。有关详细信息,请参阅其他详细信息。
支持表达式语言:是(仅使用环境/系统变量求值)
App Config JSON包含应用程序配置的原始 JSON。 有关详细信息,请参阅其他详细信息。
敏感属性:是
支持表达式语言:是(仅使用环境/系统变量求值)
Connect Timeout10 secs初始套接字连接期间失败之前等待的最长时间。
Read Timeout30 secs读取套接字响应时失败之前等待的最长时间。
Proxy Configuration Service控制器服务 API:
ProxyConfigurationService
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
指定代理配置 Controller Service 来代理网络请求。

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

提供的 Service API

  • BoxClientService (cn.org.acal.lynxus-lynxus-box-services-api-nar-2.11.8)

详细说明

JsonConfigBasedBoxClientService

配置 Box 应用

该 Processor 需要在拥有被访问资源的账号下预先配置好一个 App(https://app.box.com/developers/console)。

该 App 应具备以下配置:

  • 如果创建新 App,选择 'Server Authentication (with JWT)' 认证方式。如果想使用已有的 App,选择认证方式为 'OAuth 2.0 with JSON Web Tokens (Server Authentication)' 的 App。
  • 应有一个 'Client ID' 和 'Client Secret'。
  • 'App Access Level' 应为 'App + Enterprise Access'。
  • 'Application Scopes' 应启用 'Write all files and folders in Box'。
  • 如果 'App Actor' 是 'Impersonated User','Advanced Features' 应启用 'Generate user access tokens' 和 'Make API calls using the as-user header'。
  • 在 'Add and Manage Public Keys' 下生成一对公钥/私钥,并下载 配置 JSON 文件(在 App Settings 下)。该文件的完整路径应设置 在 'Box Config File' 属性中。 注意,包含密钥对详情的配置 JSON 只能在生成密钥对时下载一次。 这也是 Box 唯一一次向你展示私钥的机会。 如果你以后想下载配置 JSON 文件(在 'App Settings' 下)—— 或者想使用自己的密钥对——下载后需要手动编辑文件并添加密钥对详情。
  • 所有设置完成后,需要在管理员页面重新授权该 App。 (https://app.box.com/master/custom-apps 的 'Reauthorize App'。) 如果该应用是首次配置,需要先添加('Add App')才能授权。