オブジェクトアクションYAML設定リファレンス

client-extension.yaml ファイルでオブジェクトアクションクライアント拡張を定義することができます。

使用法の詳細

この client-extension.yaml は、オブジェクトアクションと OAuth ユーザーエージェントを定義しています：

easy-object-action-1:
    name: Easy Object Action 1
    oAuth2ApplicationExternalReferenceCode: easy-oauth-application-user-agent
    resourcePath: /easy-object/action/1
    type: objectAction

easy-oauth-application-user-agent:
    type: oAuthApplicationUserAgent

必須の resourcePath プロパティは、オブジェクトアクションハンドラーの場所を定義します。 外部アプリケーション（Java Spring Bootアプリケーションなど）としてアクセス可能なオブジェクトアクションハンドラーの実装を指します。 この値は、関連する OAuth2 アプリケーションプロファイルの homePageURL 値と組み合わされて、完全な URL を形成します。

オブジェクトアクションクライアント拡張は、Liferayのオブジェクトアクションによって引き起こされるリクエストを保護するためにOAuth2アプリケーションプロファイルを必要とします。 client-extension.yaml は、このプロファイルの追加の OAuth ユーザー エージェント クライアント拡張 を定義し、 oAuth2ApplicationExternalReferenceCode プロパティは、そのクライアント拡張の キー 値を参照します。

サンプルワークスペース は、オブジェクトアクションクライアント拡張機能の追加を示しています。

クライアント拡張スコープの制限

デフォルトでは、オブジェクトアクションクライアント拡張は、すべての Liferay インスタンス内のすべてのオブジェクト定義で使用できます。

オブジェクト定義によってアクセスを制限するには、アクションを使用できるオブジェクトのリストとともに、 allowedObjectDefinitionNames プロパティを追加します。

easy-object-action-1:
    allowedObjectDefinitionNames:
        - C_EasyObject
        - User

この例では、 easy-object-action-1 は、 C_EasyObject オブジェクトと User オブジェクトの アクションの定義 時にのみオプションとして表示されます。

インスタンスによるアクセスを制限するには、目的の仮想インスタンスの ID を持つ dxp.lxc.liferay.com.virtualInstanceId プロパティを追加します。

easy-object-action-1:
    allowedObjectDefinitionNames:
        - C_EasyObject
        - User
    dxp.lxc.liferay.com.virtualInstanceId: easy-virtual-host-1.com

この例では、 easy-object-action-1 は、 easy-virtual-host-1.com インスタンス内の C_EasyObject および User オブジェクトのオプションとしてのみ表示されます。

YAML プロパティ

これらのプロパティは、オブジェクトアクションクライアントエクステンションに固有のものです。

関連トピック

• マイクロサービスのクライアント拡張
• クライアント拡張との連携
• ワークフローアクションYAML設定リファレンス