クライアント拡張
liferay DXP 7.4 (self-hosted) Liferay Experience Cloud (SaaS) Liferay Cloud:セルフマネージド
クライアント拡張はOSGiモジュールを使わずにLiferayを拡張します。 クライアント拡張機能は、Liferay環境であれば、自社ホストでもLiferayクラウド上でもデプロイできます。 また、 Liferay objects のようなビルトインコンフィギュレーションとともに、Liferay CloudでLiferayをカスタマイズする主な方法でもあります。
OSGiモジュール や テーマ のような他のLiferayエクステンションがLiferayそのものを変更したり機能を追加したりするのに対して、クライアントエクステンションはLiferayのAPIだけをインターフェイスにします。 この疎結合により、クライアント拡張はより柔軟になり、バージョン間でほとんど変更されないAPIにのみ依存するため、アップグレード後の環境に適用しやすくなります。 また、クライアント拡張はLiferayの外部で実行され、オブジェクトと統合されるため、接続に余分なコードは必要ありません。
クライアント・エクステンションを使用すると、次のことが可能になります。
- カスタムJavaScriptまたはCSS を適用し、Liferayのコードに依存しないようにする。
- Liferay ページ上の カスタム要素にリモートでホストされているアプリケーションを埋め込む
- 同じコンフィギュレーションやオブジェクトを、 クライアント拡張に変換することで、複数の環境に適用
- カスタムサービスや 関数を呼び出す Liferayの外部(例:RESTエンドポイント)で、お好みのプログラミング言語やテクノロジーを使って実行する。
クライアント拡張機能の種類
Liferay Workspaceを使用して、クライアント拡張機能を開発・配備します。 クライアント拡張は ヘッドレス API を介して Liferay と通信します。
これらはクライアント・エクステンションの分類である:
バッチクライアント拡張機能
バッチクライアント拡張は、 オブジェクト定義 や ワークフロー定義 のようなデータエンティティを Liferay インスタンスに提供します。 バッチエンジンフレームワーク を介してデータをエクスポートすることで、バッチクライアントの拡張機能を作成します。
このタイプの詳細については バッチクライアント拡張機能 を参照のこと。
クライアント拡張の設定
コンフィギュレーションクライアントエクステンションは、Liferayインスタンス内の機能を変更するための特定のコンフィギュレーションを提供します。
これらは、 マイクロサービスクライアント拡張 のような他のクライアント拡張と一緒に使用することができます。 たとえば、OAuth ユーザーエージェントクライアント拡張機能を使用して、ユーザートリガーのアクションイベントで動作するクライアント拡張機能を認証することができます。
特定のタイプの詳細については、 クライアント拡張の設定 を参照のこと。
フロントエンドのクライアント拡張
フロントエンドクライアントエクステンションは、特定のページに表示するリソースを提供します。 テーマリソースまたはカスタム HTML 要素をクライアント拡張機能で提供できるようになりました。 ほとんどのフロントエンドクライアント拡張は、Liferayインスタンスに 静的リソース を提供します。
特定のタイプの詳細については、 フロントエンドのクライアント拡張 を参照のこと。
マイクロサービスのクライアント拡張
マイクロサービスクライアント拡張は、Liferay内でトリガーするAPIエンドポイントを提供します(オブジェクトやワークフローのアクションなど)。 これらのアクションイベントがAPIを呼び出したら、Liferayの外で別の マイクロサービス として好きな機能を実行できます。
特定のタイプの詳細については、 マイクロサービスのクライアント拡張 を参照してください。