SPI 実装の作成

この章では、SPI 実装の作成について説明します。節の内容は以下のとおりです。

VCR SPI 実装の対話

VCR は、アプリケーションリポジトリのコンフィグレーションのセットから特定のリポジトリにアクセスする必要がある時、VCR SPI リポジトリインタフェースを実装するコンフィグレーションした SPI 実装のクラスのインスタンスをロードし、作成します。VCR は、他の VCR SPI インタフェースを実装する [Ticket] などのオブジェクトを取得するためにリポジトリ実装のメソッドを呼び出します。

VCR は、SPI 実装の機能についてクエリを送信するために [Repository] および [Ticket] 実装のメソッドを呼び出します。(機能とは、実装がサポートする操作のことです。) VCR はメソッドを呼び出して、SPI をエクスポーズする NodeOpsV1 などの操作インタフェースを取得します。最後に、VCR は操作インタフェースのメソッドを呼び出します。

基本的な SPI 実装用の主クラス

Repository クラスは VCR で直接にインスタンス化されます。このクラスは匿名リポジトリアクセスを提供します。たとえば、SPI 実装は、そのバージョンおよび基本的な情報を報告できます。もっとも重要なのは、これは Ticket を取得するために SPI 実装認可のエントリポイントです。認可済みのユーザのみが Ticket を取得できます。Ticket を使用して重要なリポジトリ操作にアクセスできます。

Ticket は認可されたリポジトリアクセスを提供し、NodeOpsV1 などの認可されている操作のインタフェースにアクセスすることもできます。認可済みのユーザのみが Ticket を取得することができ、Ticket を使用して重要なリポジトリ操作にアクセスにできます。このクラスは Repository.connect(…) によってインスタンス化されます。

Repository は、getAllInterfaces() および getInterface() を実装して NodeOpsV1、SearchOpsV1 などの追加の認可された Ticket 操作インタフェースを必要に応じてエクスポーズできます。

SPI 実装を作成する場合のリポジトリガイドライン

SPI 実装を作成する場合、以下のデザインのガイドラインを使用してください。

スタンドアロン – SPI 実装はスタンドアロン実装である必要があります。VCR インタフェースでは SPI 実装を呼び出す。VCR 連合インタフェースでは SPI 実装は VCR データオブジェクトを使用できますが、呼び出すことはできません。
ステートレス – 一般的に、SPI 実装はステートレスである必要があります。変更はすぐに外部システムに伝播される必要があります。

上記に対する複数の理由は以下の通りです。第一に、クラスタシナリオまたは複数のエンタープライズアプリケーションが同一サーバ上に存在するため、変更はすぐに外部システムに伝播される必要があります。データをどのサーバおよびエンタープライズアプリケーションからアクセスするかにかかわらず、データが「本稼動」として表示されます。

オブジェクトキャッシング – SPI 実装が返されるデータオブジェクトインスタンスをキャッシュしてはいけません (Nodes、Properties、Values、ObjectClasses、PropertyDefinitions および PropertyChoices)。VCR およびクライアントコードはこれらのオブジェクトを所有しており、変更することができます。たとえば、VCR は、ノードをクライアントへ戻る前に、ノードパスを変更する場合があります。

安全な方法は、オブジェクトをキャッシュして、SPI 実装が参照しないこれらのオブジェクトのクローンを返すことです。

データオブジェクトタイプは、SPI 実装、VCR およびクライアントコード間共有されるので、これらのデータオブジェクトのすべての方法は各タイプのコーラーのために適切ではありません。(詳細については、「WebLogic Portal Javadoc」を参照してください。)たとえば、「Node」を作成する場合、VCR から SPI 実装へ「Properties」などの新しいオブジェクトデータを渡しますが、「PropertyID」の UUID はありません。これは、UUID が SPI 実装により割り当てられ、新しいオブジェクトがSPI 実装によりまだ持続していないことにより起こります。UUID は SPI によって取り出されるか返されるデータオブジェクトのために存在します。

VCR リポジトリインタフェース - SPI 実装は VCR リポジトリインタフェースを実装する必要があります。VCR はリポジトリを動的にロードし、パブリックデフォルトコンストラクターを必要とします。VCR は SPI 実装をロードする際、「connect()」メソッドを呼び出す前に「Repository.setName()」および「Repository.setProperties()」メソッドを呼び出します。

各リポジトリインスタンスは、単一のエンタープライズアプリケーションおよび単一のユーザが使用できるように単一のリポジトリコンフィグレーションに対応します。実行時に、VCR は、現在の多数 WebLogic Portal ユーザが使用できるようにリポジトリの多くのインスタンスを作成できます。何百ものオブジェクトが存在する場合があるので、比較的に軽量なオブジェクトである必要があります。

エンタープライズアプリケーションでは、特定の SPI 実装用の複数アクティブリポジトリコンフィグレーションがある場合があります。たとえば、VCR が管理するアプリケーションに対して 3 つのリポジトリコンフィグレーションが存在する場合があり、各リポジトリには独自のコンフィグレーションデータおよび実行的に作成される独自のリポジトリインスタンスがあります。

例外 – SPI 実装は操作を実行できなくなると、RepositoryException を送出する必要があります。RepositoryException の複数のサブクラスを定義し、一致する場合、使用する必要があります。たとえば、SPI 実装が操作をサポートしない場合、UnsupportedRepositoryOperationException を送出する必要があります。
Ticket の再利用 – VCR は、Ticket オブジェクトをキャッシュと再利用します。通常、それは同時上の理由で、ステートレスである必要があります。VCR は Ticket と HTTPSession のユーザを関連します。同じリポジトリに対して HTTPSession に複数のリクエストを受信した場合、同じ Ticket オブジェクト上で複数の操作が同時に実行される可能性があります。ステートレスの設計によって、このような状態での問題が回避されます。
SPI 実装の複数リポジトリインスタンスのサポート - SPI 実装の複数のリポジトリが同時に使用される時、適切に操作を実行するには、データが特定リポジトリの名前またはインスタンスに結合されていることを確認して静的なキャッシュの扱いに注意する必要があります。1 つ目のオプションとして、データのキャッシュ時に、データキーにリポジトリ名を組み込む方法があります。2 つ目のオプションとして、名前付きシングルトンを使用してキャッシュされたデータにアクセスする方法があります。リポジトリ名でデータを分類することによって、SPI 実装はこの状況で適切に実行されます。
パフォーマンス - SPI キャッシングは重要です。通常、SPI はデータをキャッシュする必要があるため、頻繁に外部システムを参照する必要はありません。SPI は、以下のような複数設定の遅延ローディングを行うことにより、パフォーマンスを向上できます。

ノードプロパティ – ノードが null Property[] を使用して作成した場合、プロパティが遅延ローディングされる。
ノード objectClass – ノードが null ObjectClass を使用して作成したが、ObjectClassId は setObjectClassId を通じて割り当てて、ObjectClass が遅延ローディングされました。

バイナリプロパティ値 - ノードのプロパティ (および価値) をロードする場合、パフォーマンスを向上させるために、バイナリプロパティ inputstream を null として返すことができます。

基本的な SPI 実装

com.bea.content.spi.flexspi.Repository インタフェースを実装する Java クラスを作成します。

このクラスは、実装する必要なインタフェースです。これは WebLogic Portal に組み込まれています。

パブリックデフォルトコンストラクタを作成します。
VCR によって渡されたリポジトリコンフィグレーションプロパティを保存するために、setProperties() を実装します。ローカル変数に保存します。
VCR が渡されたリポジトリコンフィグレーションプロパティを保存するには、setName() を実装します。ローカル変数に保存します。
ローカル変数を読み込むために、getProperties() および getName() を実装します。
リポジトリ説明データを報告するために、getDescription() を実装します。

これは、SPIDescriptionKeys にある定義したキーを持つ Properties バケットです。これには、ベンダ、バージョンなどがあります。

SPI 実装がどのカスタム機能をサポートするかを報告するために、getRepositoryDefinedCapabilities() を実装します。

基本的な SPI 実装のために、Collections.emptySet() を返します。

すべてのリポジトリ (ticket を除いて) 操作のインタフェースを返すには、getAllInterfaces() を実装します。

これは、リポジトリが実装できる RepositoryConfigOpsV1 などのオプションインタフェースです。

ベアボーン SPI 実装の場合、空の HashMap を返します。

getAllInterfaces()と一致できるように、getInterface( String interfaceName ) を実装します。

ベアボーン SPI 実装の場合、null を返します。

SPI 実装がどの機能をサポートするかを報告するために、getCapabilitySupport( Set<ICapabilityDefinition> ) を実装します。

オプションリポジトリ操作インタフェース全体でリポジトリがサポートするメソッド機能も報告します。

コーラーが ticket を取得できるように、connect( Credentials ) および Connect( String username, String password ) を実装します。

ユーザ名とパスワードが使用可能な場合、connect( username, password ) を呼び出します (通常、リポジトリコンフィグレーションデータから)。

ユーザ名とパスワードが使用可能でない場合、connect( credentials ) を呼び出します。資格にコーラーの暗黙の ID を含みます。

基本的な SPI 実装の場合、新しい Ticket インスタンスを作成して返します。より高度な実装は資格を認証する場合があり、成功すると Ticket インスタンスのみが返されます。

RepositoryConfigOpsV1 などの省略可能な Repository 操作インタフェースを実装します。

Repository.getAllInterfaces() が返されたリポジトリ操作インタフェースの場合、

インタフェースを実装します。

実装されていないメソッドの場合、UnsupportedRepositoryOperationException が送出され、getCapabilitySupport() メソッドは、このメソッドはサポートされていることを報告する必要はありません。

インタフェース実装が戻されるように Repository.getAllInterfaces() および getInterface() を変更します。
リポジトリ操作インタフェースの各メソッドの状態 (サポートされているサポートされていない) を報告するように、Repository.getCapabilitySupport() を変更します。

com.bea.content.spi.flexspi.Ticket インタフェース (WebLogic Portal と共に提供される) を実装する Java クラスを作成します。

すべての Ticket 操作のインタフェースを返されるように getAllInterfaces() を実装します。これらは、Ticket が実装できる NodeOpsV1 などのオプションインタフェースです。基本的な SPI 実装の場合、空の HashMap を戻ります。
getAllInterfaces() と一致するよに getInterface( String interfaceName ) を実装します。基本的な SPI 実装の場合、null のみを返します。
この Ticket がオプション Ticket 操作インタフェース全体のどのメソッド機能をサポートするかを報告するために、getCapabilitySupport( Set<ICapabilityDefinition> ) を実装します。

NodeOpsV1 などのオプション Ticket 操作インスタンスを実装します。

Ticket.getAllInterfaces() が返される Ticket 操作インスタンスの場合、

インタフェースを実装します。

実装されいないメソッドの場合、UnsupportedRepositoryOperationException が送出され、getCapabilitySupport() メソッドは、このメソッドはサポートされていることを報告する必要はありません。

インタフェース実装が返されるように Ticket.getAllInterfaces() および getInterface() を変更します。
リポジトリ操作インタフェースの各メソッドの状態 (サポートされているサポートされていない) を報告するように、Ticket.getCapabilitySupport() を変更します。

基本的な SPI リポジトリ実装のコード例

コードリスト 4-1 は、以下の制限があるリポジトリの簡単な SPI リポジトリコードの例を示します。

認証は行いません。
機能はサポートされていません。
RepositoryConfigOpsV1 などのオプションリポジトリ操作インタフェースはサポートされていないので、メソッドの機能はサポートされていません。
リポジトリ定義機能は提供されていませｎ。

コードリスト 4-1 基本的な SPI 実装

import com.bea.content.spi.flexspi.Repository;
import com.bea.content.spi.flexspi.Ticket;
import com.bea.content.spi.flexspi.common.capability.ICapabilityDefinition;
import com.bea.content.spi.flexspi.common.capability.CapabilityLevel;
import com.bea.content.spi.flexspi.common.capability.FeatureCapabilityDefinition;
import com.bea.content.spi.flexspi.common.ISPIMarker;
import com.bea.content.spi.flexspi.common.SPIRepositoryInterfaces;
import com.bea.content.spi.flexspi.common.SPIDescriptionKeys;
import com.bea.content.capability.NodeFeatureCapability;
import com.bea.content.*;
import java.util.*;
public class FlexRepositoryImpl implements Repository
{
   // VCRは connect()を呼ぶ前にこれをコンフィグレーションする
   private String repositoryName;
   private Properties props;
 
   // キー・値の詳細
   private Map<String, String> descMap = new HashMap<String, String>();
   public FlexRepositoryImpl()
   {
      // SPI 実装にはデフォルトのパブリック コンストラクタを持つ必要がある。
      //標準キー        
      descMap.put(SPIDescriptionKeys.VENDOR_KEY, 
         "Some third party vendor");
      descMap.put(SPIDescriptionKeys. VERSION_KEY, "0.1.1");    
      descMap.put(SPIDescriptionKeys. DESCRIPTION_KEY, "Simple SPI");

      //カスタムキーを追加することができます
      descMap.put("InternalVersion", "Build 31141");
   }
   public Ticket connect(Credentials credentials) 
      throws AuthenticationException, RepositoryException 
   {
       // この SPI は認証を実行しません
       return new FlexTicketImpl(this);
   }
   public Ticket connect(String username, String password) 
      throws AuthenticationException, RepositoryException 
   {
      // この SPI は認証を実行しません
       return new FlexTicketImpl(this);
   }
   public String getName() {
      return repositoryName;
   }
   public void setName(String name) {
      repositoryName = name;
   }
   public Properties getProperties() {
      return props;
   }
   public void setProperties(Properties properties)  {
      props = properties;
   }
   public Set<ICapabilityDefinition> getRepositoryDefinedCapabilities() {
      return Collections.emptySet();
   }
   public Map<String, String> getDescription() {
       return descMap;
   }
   public Map<String, ISPIMarker> getAllInterfaces() {
       // リポジトリ操作インタフェースはありません
      return new HashMap<String,ISPIMarker>();   
   }
   public ISPIMarker getInterface(String interfaceName) {
       // リポジトリ操作インタフェースはありません
      return null;    
   }
   public Map<ICapabilityDefinition, CapabilityLevel>
      getCapabilitySupport(Set<ICapabilityDefinition> capabilities)
   {
      HashMap<ICapabilityDefinition, CapabilityLevel> capMap 
          =new HashMap<ICapabilityDefinition, CapabilityLevel>();
      // サポートされていないすべての項目から開始し、
       // サポートされる個々の機能をマークします。
      for (ICapabilityDefinition capDef : capabilities) {
         capMap.put(capDef, CapabilityLevel.NotSupported);
   }
      // 以前サポートされていない機能はサポートする場合、
      // サポートされなかった値がオーバーライドされます
 
      // すべてはサポートされていません
      return capMap;   
   }
}

基本的な SPI Ticket 実装のコード例

コードリスト 4-2 は、Ticket はNodeOpsV1 および SearchOpsV1 などのオプション Ticket 操作インタフェースをサポートしないので、1 つのメソッド機能はサポートしない SPI Ticket コードの例を示します。

省略可能な SPI インタフェース実装

VCR にノードとタイプをエクスポーズするために、省略可能な SPI インタフェースを使用します。一般的に、クライアントコードはコードに対して実行されるリポジトリの機能について特定な仮定があります (たとえば、ノードへの読み取り専用アクセス)。VCR はノードとタイプをリポジトリに委託するので、クライアントコードは特定の VCR メソッドが適切に動作することを前提とします。

省略可能な SPI インタフェースのエクスポーズ

NodeOpsV1 などの省略可能な SPI インタフェースをエクスポーズするには、

SPI インタフェースを実装するには、クラスを作成します。

たとえば、MyNodeOps は NodeOpsV1 を実装します。一般に、多数のオブジェクトが作成される場合があるので、軽量のクラスを作成する必要があります。

SPI インタフェースメソッドの実装を記述します。

注意 : 実装されていないのメソッドの場合、UnsupportedRepositoryOperationException が送出されます。また、Ticket.getCapabilitySupport() メソッドは、このメソッドはサポートされていることを報告する必要があります。

インタフェース実装が返されるように Ticket.getAllInterfaces() および getInterface() を変更します。

オブジェクトの作成を減らすには、Ticket の作成時にインタフェースを作成して保持し、getAllInterfaces() および getInterface() に返します。次に例を示します。

private Map<String,ISPIMarker> ifaces;
public FlexTicketImpl( Repository repository ) { 
   this.repository= repository;
//init インタフェース 
   ifaces= new HashMap<String,ISPIMarker>();
   ifaces.put(SPITicketInterfaces.NODE_OPS_V1,
      new MyNodeOps(…);
   . . .
}

public Map<String, ISPIMarker> getAllInterfaces() {
   return ifaces;
}

public ISPIMarker getInterface( String ifaceName ) {
   return ifaces.get( ifaceName );
}

すべての Ticket 操作インタフェースの各メソッドの状態 (サポートされているサポートされていない) を報告するように、Ticket.getCapabilitySupport() を変更します。次に例を示します。

public Map<ICapabilityDefinition, CapabilityLevel>
   getCapabilitySupport(Set<ICapabilityDefinition> capabilities)
{
   Map<ICapabilityDefinition, CapabilityLevel> capMap 
      =new HashMap<ICapabilityDefinition, CapabilityLevel>();

   // サポートされていないすべての項目から開始し、
   // サポートされる個々の機能をマークします。
   for (ICapabilityDefinition capDef : capabilities) {
      capMap.put(capDef, CapabilityLevel.NotSupported);
   }

   // 必要に応じてサポートされていない値をオーバーライドします
   final String[] supportedNodeOpsMethodNames = new String[] {
      NodeOpsV1.MethodName.getNodeChildren.toString(),
      NodeOpsV1.MethodName.getNodeChildrenAsNodeIds.toString(),
      NodeOpsV1.MethodName.getNodesWithIds.toString(),
      NodeOpsV1.MethodName.getNodeWithId.toString(),
      NodeOpsV1.MethodName.getNodeWithPath.toString(),
   };

   for (String methodName : supportedNodeOpsMethodNames) {
      ICapabilityDefinition capDef 
         = new MethodCapabilityDefinition(
            SPITicketInterfaces.NODE_OPS, methodName
            );
         if (capabilities.contains(capDef)) {
            capMap.put(capDef, CapabilityLevel.FullySupported);
      }
   }

   return capMap;
}

SPI インタフェース結果の集合、ソーティングおよびフィルタリング

オプションで、SPI 実装では結果をソートおよびフィルタするの機能を含むことができます。SPI が返された項目の集合を QueryResult オブジェクト (結果の順序付きリストを含む) および返された集合のソートとフィルタの方法を (処理を行う場合) 記述する QueryCriteria オブジェクトに返します。たとえば、QueryResult<Node> には、ソートおよびフィルタしたノードの集合を含む場合があります。

SPI を使用して結果のフィルタおよびソート処理

結果の集合を返す多数のメソッドは QueryCriteria パラメータを使用します。このパラメタでコーラーは結果のソートまたはフィルタ方法 (可能であれは両方も) を設定できます。たとえば、コーラーは結果が名前によってソートされるよう要求する場合があります。現在、コーラーは 1 つのソート条件および 1 つのフィルタ条件のみを指定できます。

SortCriteriaには、名前昇順 などのプロパティ (条件) および昇順または降順フラグがあります。

FilterCriteria には、プロパティ (条件) とフィルターなし、等しい、等しくない、含む、含まない、で始まる、で終わる、より大きい、より小さいおよび値などの FilterMethod オペランドがあります。たとえば、name contains 'foo'

プロパティのソートおよびフィルタ条件のセットは使用しているデータオブジェクトの JavaBean プロパティに関連付けられます。たとえば、Node には getName() メソッドがあるので name および getCreatedDate() メソッドがあるので createdDate のために JavaBean プロパティを含みます。

ネイティブのソート、フィルタ処理はうまく機能します。また、SPI 実装がソートまたはフィルタの要求を処理できない場合、VCR はメモリ内にソーティングとフィルタリングを行うためにメカニズムをサポートします。クライアントコード (と VCR) は、SPI がネイティブにソートおよびフィルタできるプロパティを確認できます。

SPI 実装は NodeOpsV1.getNativeSortableProperties() および NodeOpsV1.getNativeFilterableProperties() などのメソッドを実装して、インタフェースのオブジェクトのために VCR にそのソーティングおよびフィルタリング機能 (ソートおよびフィルタできるプロパティ) を報告します。たとえば、SPI はノードが name および createDate プロパティでソートできることを報告します。

ソーティングおよびフィルタリング機能の報告は実際にインタフェース精度で行っています。つまり、NodeOpsV1 などの特定のインタフェースには主なデータオブジェクトがあります。主なデータオブジェクト、たとえば、Node は、インタフェースでの結果の集合メソッド全体でソート、フィルタ処理の機能を報告します。

SPI 実装は、サポートするソーティングとフィルタリング機能よりも高度な機能を要求する QueryCriteria パラメタを受信する場合があります。この場合に、SPI 実装は例外を送出しないことを確認します。代わりに、SPI 実装は結果をソートおよびフィルタする現在の方法を報告する必要があります。たとえば、SPI 実装は、未ソートと未フィルタ QueryResult を作成して、ソートとフィルタできなかった項目を表します。SPI 実装が 1 つの要求を実行できる場合、要求を実行して適切に結果を報告する必要があります。たとえば、ソートすることができる場合、SPI 実装は結果を [ソート済みが未フィルタ] として報告する必要があります。

必要に応じて、VCR はクライアントの要求によってソートまたはフィルタ処理を行っているかを確認するために、メモリ内でクエリ結果をソートまたはフィルタする場合があります。

ソートおよびフィルタの対象である共通の SPI インタフェースオブジェクト

ソートおよびフィルタ処理を行うために以下のオブジェクトを使用します。

QueryCriteria – 一部のメソッドは、結果のソートおよびフィルタ処理を要求するためにコーラーが使用する QueryCriteria オブジェクトを渡します。これらのメソッドは SortCriteria および FilterCriteria オブジェクトを含みます。現在、1 つの SortCriteria または FilterCriteria のみを指定できます。マルチ条件ソーティングとフィルタリングはサポートされていません。
SortCriteria – 特定のプロパティ (条件)で昇順または降順ソートできる機能を提供します。sortResults フラグは結果がソートされているかを示します。SortCriteria はデータオブジェクトの JavaBean プロパティの 1 つである property も含みます。
FilterCriteria – 特定のプロパティ (条件)でフィルタできる機能を提供します。filterResults フラグは結果がフィルタされているかを示します。FilterCriteria は、データオブジェクトの JavaBean プロパティの 1 つである property を含み、等しい、より大きい、未フィルターなどのフィルタ操作を示す filterMethod を含みます。
QueryResult – SPI 実装が返された結果のセットを表します。QueryResult には、結果のソートおよびフィルタ方法 (または両方もない) を記述する QueryCriteria オブジェクトとデータオブジェクトの順序リストを含みます。

コンテンツ管理 SPI 開発ガイド