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

オブジェクトアクション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 プロパティは、そのクライアント拡張の キー 値を参照する。

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

YAML プロパティ

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

名前 データ型 説明
resourcePath 文字列(URLの一部) (必須) オブジェクトアクションハンドラーへのパスです。 この値は、OAauth2アプリケーションプロファイルの homePageURL の値と組み合わされて、完全なURLとなります。
oAuth2ApplicationExternalReferenceCode 文字列 (必須) リクエストを保護するために必要な、OAuth2アプリケーションプロファイルの外部参照コードです。

追加情報