Sling アダプターの使用

Sling は、Adaptable インターフェイスを実装するオブジェクトを簡単に変換するための Adapter パターンを提供します。このインターフェイスは、汎用の adaptTo() メソッドを提供しており、このメソッドによってオブジェクトは引数として渡されるクラス型に変換されます。

例えば、次のように実行するだけで、Resource オブジェクトを対応する Node オブジェクトに変換できます。

Node node = resource.adaptTo(Node.class);

ユースケース

次のようなユースケースがあります。

  • 実装用のオブジェクトの取得

    例えば、汎用の Resource インターフェイスの JCR ベース実装では、基盤の JCR Node にアクセスできます。

  • 内部的なコンテキストオブジェクトを渡す必要があるオブジェクトのショートカット作成。

    例えば、JCR ベースの ResourceResolver では、要求の JCR Session への参照を保持しています。この JCR セッションは、その要求セッションに基づいて動作する多くのオブジェクト(PageManagerUserManager など)を取得するために必要になります。

  • サービスへのショートカット。

    稀なケース - sling.getService() も簡単に使用できます。

戻り値 Null

adaptTo() は null を返す場合があります。

これには様々な理由がありますが、その一部は次のとおりです。

  • 実装がターゲットタイプをサポートしていない
  • このケースを処理するアダプターファクトリがアクティブでない(サービスの参照が見つからないなどの理由で)
  • 内部的な条件が合わなかった
  • サービスを利用できない

null のケースを問題なく処理することが重要です。JSP レンダリングでは、JSP の問題によってコンテンツの一部が空になる場合に、その問題が受容されることもあります。

キャッシュ

パフォーマンスを改善する目的で、各実装では obj.adaptTo() 呼び出しから返されたオブジェクトを自由にキャッシュできます。obj が同じであれば、返されるオブジェクトも同じです。

このキャッシュ処理は、すべての AdapterFactory ベースのケースで実行されます。

ただし、汎用的なルールは存在せず、オブジェクトが新しいインスタンスである場合も既存のインスタンスである場合もあります。したがって、いずれの動作にも依存することはできません。重要なのは、特に AdapterFactory 内部において、このシナリオでオブジェクトが再利用可能であるということです。

仕組み

Adaptable.adaptTo() の実装には、様々な方法があります。

  • オブジェクト自体による実装(このメソッド自体を実装して特定のオブジェクトにマッピングします)。

  • By an AdapterFactory`, which can map arbitrary objects.

    オブジェクトは、引き続き Adaptable インターフェイスを実装し、SlingAdaptable を拡張する必要があります(これは、Central Adapter Manager の adaptTo 呼び出しを渡します)。

    これにより、Resource などの既存クラスの adaptTo メカニズムにフックを組み込むことができます。

  • これら 2 つの組み合わせ。

最初の例では、javadocs に何の adaptTo-targets が可能かが示されます。ただし、JCR ベースのリソースなどの特定のサブクラスでは、多くの場合、これは不可能です。後者の場合、AdapterFactory の実装は通常、バンドルのプライベートクラスの一部なので、クライアント API で公開されず、Javadoc にも表示されません。理論的には、OSGi サービスランタイムからすべての AdapterFactory 実装にアクセスし、「アダプタブル」(ソースとターゲット)の設定を調べることは可能ですが、相互にマッピングすることはできません。最終的には、これは内部ロジックに依存し、ドキュメントに記載する必要があります。従って、参照はこちらです。

リファレンス

Sling

Resource は次の項目に適応します。

Node このリソースが JCR ノードベースのリソースまたはノードを参照する JCR プロパティの場合。
Property このリソースが JCR プロパティベースのリソースである場合。
Item このリソースが JCR ベースのリソース(ノードまたはプロパティ)の場合。
Map このリソースが JCR ノードベースのリソース(または値マップをサポートするその他のリソース)の場合、プロパティのマップを返します。
ValueMap このリソースが JCR ノードベースのリソース(または値マップをサポートするその他のリソース)の場合、プロパティの使用しやすいマップを返します。また、
ResourceUtil.getValueMap(Resource) を使用(null ケースを処理するなど)して達成することもできます。
InheritanceValueMap ValueMap の拡張。プロパティを探すときにリソースの階層を考慮することができます。
PersistableValueMap このリソースが JCR ノードベースのリソースであり、ユーザーがそのノードのプロパティを変更する権限を持っている場合。
注意:複数の永続化可能マップでは値は共有されません。
InputStream 「ファイル」のバイナリコンテンツを返すnt:resource
AuthorizableResourceProviderorg.apache.sling.jackrabbit.usermanager/system/userManager
cq:Pagecq:PseudoPage
cq:Component
cq:Page
cq:Template
cq:Page
cq:Tag
cq:Preferences
cq:ContentSyncConfig
cq:ContentSyncConfig

ResourceResolver は次の項目に適応します。

Session このリソースリゾルバーが JCR ベースのリソースリゾルバー(デフォルト)である場合の、要求の JCR セッション。
PageManager
ComponentManager
デザイナー
AssetManager このリソースリゾルバーが JCR ベースのリソースリゾルバーである場合の、JCR セッションに基づいたもの。
TagManager このリソースリゾルバーが JCR ベースのリソースリゾルバーである場合の、JCR セッションに基づいたもの。
UserManager このリソースリゾルバーが JCR ベースのリソースリゾルバーであり、ユーザーが UserManager へのアクセス権限を持っている場合の、JCR セッションに基づいたもの。
Authorizable 現在のユーザー。
User
現在のユーザー。
PrivilegeManager
環境設定 現在のユーザーの環境設定(このリソースリゾルバーが JCR ベースのリソースリゾルバーである場合、JCR セッションに基づいたもの)。
PreferencesService
PinManager
QueryBuilder
Externalizer 要求オブジェクトがない場合でも、絶対 URL を外部化するためのもの。

SlingHttpServletRequest は次の項目に適応します。

現時点ではターゲットはありませんが、Adaptable を実装し、カスタムの AdapterFactory 内でソースとして使用することは可能です。

SlingHttpServletResponse は次の項目に適応します。

ContentHandler
(XML)
この応答が Sling リライター応答である場合。

WCM

Page は次の項目に適応します。

Resource
ページのリソース。
LabeledResource ラベル付きリソース(== this)。
Node ページのノード。
... ページのリソースが適応可能なすべての項目。

Component は次の項目に適応します。

Resource コンポーネントのリソース。
LabeledResource ラベル付きリソース(== this)。
Node コンポーネントのノード。
コンポーネントのリソースが適応可能なすべての項目。

Template は次の項目に適応します。

Resource
テンプレートのリソース。
LabeledResource ラベル付きリソース(== this)。
Node このテンプレートのノード。
... テンプレートのリソースが適応可能なすべての項目。

セキュリティ

AuthorizableUser および Group は次の項目に適応します。

Node ユーザーまたはグループのホームノードを返します。
ReplicationStatus ユーザーまたはホームノードのレプリケーションステータスを返します。

DAM

Asset は次の項目に適応します。

Resource アセットのリソース。
Node アセットのノード。
アセットのリソースが適応可能なすべての項目。

タグ付け

Tag は次の項目に適応します。

Resource タグのリソース。
Node タグのノード。
タグのリソースが適応可能なすべての項目。

その他

さらに、Sling、JCR、OCM では、カスタム OCM( [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory)Object Content Mapping)オブジェクト用の も提供しています。

このページ