ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

オブジェクト検証ルール YAML 設定リファレンス

オブジェクト検証ルールのクライアント拡張機能を定義するには、 objectValidationRule タイプを client-extension.yaml ファイルに追加します。

使用法の詳細

この client-extension.yaml の例では、検証ルールと OAuth ユーザーエージェントを定義しています。

easy-object-validation-rule-1:
    name: Easy Object Validation Rule 1
    oAuth2ApplicationExternalReferenceCode: easy-oauth-application-user-agent
    resourcePath: /object/validation/rule/1
    type: objectValidationRule

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

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

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

サンプルワークスペースは、Spring Boot アプリケーションでオブジェクト検証ルールクライアント拡張機能を使用する方法を示しています。

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

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

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

easy-object-validation-rule-1:
    allowedObjectDefinitionNames:
        - C_EasyObject
        - User

この例では、 easy-object-validation-rule-1 は、 C_EasyObject オブジェクトと User オブジェクトの検証を定義する場合にのみオプションとして表示されます。

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

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

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

YAML プロパティ

これらのプロパティは、オブジェクト検証ルールのクライアント拡張に固有です。

名前	データ型	説明
`allowedObjectDefinitionNames`	リスト	クライアント拡張のスコープを指定されたオブジェクト定義に設定します（例： `C_EasyObject`、 `User`）
`dxp.lxc.liferay.com.virtualInstanceId`	文字列	ID を使用して、指定された仮想インスタンスにクライアント拡張機能のスコープを設定します (例: `easy-virtual-host-1.com`)。
`resourcePath`	文字列（URLの一部）	(必須) オブジェクト検証ルールハンドラーへのパス。この値は、OAauth2アプリケーションプロファイルの `homePageURL` の値と組み合わされて、完全なURLとなります。
`oAuth2ApplicationExternalReferenceCode`	文字列	(必須) リクエストを保護するために必要な、OAuth2アプリケーションプロファイルの外部参照コード。