マイクロサービスの統合
Liferayセルフホスト Liferay SaaS Liferay PaaS
Liferay DXP 7.4
マイクロサービス クライアント拡張機能を定義して、Liferay インスタンス内のイベントに応じて独自のコードを実行できます。 どのようにコードを実装するかはあなた次第です。好みのパターンやテクノロジーを使ってください。 マイクロサービスのクライアント拡張はLiferayの外部でホストされ、Liferay自体からの合図でトリガーされます。
マイクロサービスのクライアント拡張には、リクエストを適切に処理し、保護されたLiferay APIを呼び出すために、事前に設定された認証プロファイルが必要です。 認証プロファイルは、同じプロジェクト内にクライアント拡張機能として含めることで追加できます (例: OAuth ユーザー エージェント クライアント拡張機能)。
マイクロサービス クライアント拡張機能は、Liferay Cloud 内にデプロイされると自動的にホストされます。 Liferayインスタンスをセルフホストする場合、これらのクライアント拡張が使用するマイクロサービスを個別にホストする必要があります。
オブジェクトアクションのクライアント拡張
オブジェクトアクションのクライアント拡張は、オブジェクト定義の アクションイベントにバインドする外部アクションハンドラーを定義します。 マイクロサービスのハンドラーコードは、オブジェクトのアクションが発生したときに実行されます。
client-extension.yamlファイルで type値を使用して、オブジェクトアクションのクライアント拡張を指定します。
type: objectAction
オブジェクト検証ルールクライアント拡張
オブジェクト検証ルールのクライアント拡張機能は、オブジェクト定義に追加できるカスタム 検証 を定義します。 これらは、オブジェクト エントリ送信イベントにバインドされ、ユーザーがエントリを作成または更新するときに実行される外部イベント ハンドラーを定義します。 これらのクライアント拡張機能を作成する場合、有効なフィールド入力を決定するための条件を任意の数使用できますが、各条件では validationCriteriaMet キーを true または falseのいずれかとして設定して返す必要があります。 基本的な例については、 ObjectValidationRule1RestController を参照してください。
このタイプのクライアント拡張機能を使用するには、 objectValidationRule タイプを client-extension.yaml ファイルに追加します。
type: objectValidationRule
デプロイされると、これらのクライアント拡張機能は、オブジェクト定義に検証を追加するときにオプションとして表示されます。 詳細については、 フィールド検証の追加 を参照してください。
- Liferay DXP 2024.Q3/Portal GA125 以降では、システム オブジェクトの検証ルールを追加できます。
- システム オブジェクトの検証メッセージは、ネイティブ UI に表示されない場合があります。 ただし、検証は期待どおりに実行されます。
allowedObjectDefinitionNames プロパティを使用して、検証ルールのスコープを特定のオブジェクト定義に設定できます。 クライアント拡張機能のプロパティの詳細については、 オブジェクト検証ルール YAML 構成リファレンス を参照してください。 Liferay からのオブジェクト エントリ POST リクエストを処理するときは、ヘッドレス API エクスプローラーで許可された各オブジェクト定義のエントリ スキーマを参照します。 関心のあるエンドポイントを見つけ、そのスキーマ ブラウザーを使用してエンティティの JSON を理解します。
ワークフローアクションのクライアント拡張
ワークフローアクションクライアント拡張機能は、 Liferayワークフローからのアクションイベントにバインドする外部ワークフローアクションハンドラーを定義します。 マイクロサービスのハンドラーコードは、ワークフローアクションが発生したときに実行されます。
client-extension.yamlファイルで type値を使用して、ワークフローアクションのクライアント拡張を指定します。
type: workflowAction
通知タイプのクライアント拡張
通知タイプのクライアント拡張機能は、Liferay の 通知イベント にバインドする外部通知ハンドラーを定義します。 マイクロサービスのハンドラーコードは、通知イベントが発生したときに実行されます。
client-extension.yamlファイルで type値を使用して、通知タイプのクライアント拡張を指定します。
type: notificationType
CAPTCHAクライアント拡張
CAPTCHA クライアント拡張機能を使用すると、任意の外部 CAPTCHA プロバイダーとの統合が可能になります。 これらには、ユーザーの応答を検証するためのアクセス可能なバックエンド アプリケーションと、CAPTCHA UI コンポーネントを実装するための別の カスタム要素クライアント拡張 が必要です。
CAPTCHA クライアント拡張機能を指定するには、 client-extension.yaml ファイル内の type 値を使用します。
type: captcha
詳細については、 CAPTCHA クライアント拡張機能の使用 を参照してください。