jp.go.aist.dmrc.platform.datacooperation.interfaces

インタフェース PFDataCooperation

public interface PFDataCooperation

コンポーネントバス向けのI/F.

バージョン:

0.00

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	clear() 再初期化を行う.
void	componentCooperationAsyncRequest(java.lang.String platformName, java.lang.String brokerName, int componentID, java.lang.String componentPublicName, java.lang.String methodName, java.lang.Object[] argments, java.lang.Class[] types, boolean isLight, int[] srcComponentID) 非同期コンポーネント連携の要求を受け付ける.
void	componentCooperationAsyncRequest(java.lang.String platformName, java.lang.String brokerName, java.lang.String componentName, int componentID, java.lang.String componentKey, java.lang.String componentPublicName, java.lang.String methodName, java.lang.Object[] argments, java.lang.Class[] types, boolean isLight, int[] srcComponentID) 非同期コンポーネント連携の要求を受け付ける.
PFComponentCooperationResult	componentCooperationRequest(java.lang.String platformName, java.lang.String brokerName, int componentID, java.lang.String componentPublicName, java.lang.String methodName, java.lang.Object[] argments, java.lang.Class[] types, boolean isLight, int[] srcComponentID) 同期コンポーネント連携の要求を受け付ける.
PFComponentCooperationResult	componentCooperationRequest(java.lang.String platformName, java.lang.String brokerName, java.lang.String componentName, int componentID, java.lang.String componentKey, java.lang.String componentPublicName, java.lang.String methodName, java.lang.Object[] argments, java.lang.Class[] types, boolean isLight, int[] srcComponentID) 同期コンポーネント連携の要求を受け付ける.
void	finalizeDataCooperation() 連携コンポーネントの終了処理を行う.
java.lang.String	getBrokerName() ブローカ名を取得する.
java.lang.String	getPlatformName() プラットフォーム名を取得する.
void	initDataCooperation() 連携コンポーネントを初期化する.
java.lang.String[]	listAllBrokersInComponentInfos() レジストリサーバにコンポーネント情報が登録されているブローカの一覧を取得する.
PFPlatformFQName[]	listAllPlatformsInComponentInfos() レジストリサーバにコンポーネント情報が登録されている全ての プラットフォームを取得する.
PFPlatformFQName[]	listAllPlatformsInComponentInfos(java.lang.String brokerName) レジストリサーバにコンポーネント情報が登録されているプラットフォームのうち、 指定されたブローカに属するものの一覧を取得する.
PFComponentInfo[]	registryListAllComponentInfos() コンポーネント情報の一覧取得要求を受け付ける.
PFComponentInfo[]	registrySearchComponentInfo(PFPlatformFQName platformName, PFComponentFQName componentName, java.lang.String methodName, java.lang.String[] argTypes) コンポーネント情報の検索要求を受け付ける.

メソッドの詳細

initDataCooperation

void initDataCooperation()
                  throws PFDataCooperationException

連携コンポーネントを初期化する.

例外:

PFDataCooperationException - エラーが発生した場合

finalizeDataCooperation

void finalizeDataCooperation()
                      throws PFDataCooperationException

連携コンポーネントの終了処理を行う.

例外:

PFDataCooperationException - エラーが発生した場合

componentCooperationRequest

PFComponentCooperationResult componentCooperationRequest(java.lang.String platformName,
                                                         java.lang.String brokerName,
                                                         java.lang.String componentName,
                                                         int componentID,
                                                         java.lang.String componentKey,
                                                         java.lang.String componentPublicName,
                                                         java.lang.String methodName,
                                                         java.lang.Object[] argments,
                                                         java.lang.Class[] types,
                                                         boolean isLight,
                                                         int[] srcComponentID)
                                                  throws PFDataCooperationException

同期コンポーネント連携の要求を受け付ける.

パラメータ:

platformName - 連携を行うプラットフォーム名

brokerName - プラットフォームが所属するブローカ名

componentName - 連携を行うコンポーネント名

componentID - コンポーネントのID

componentKey - コンポーネントのキー

methodName - メソッド名

argments - 引数の値の配列

types - 引数の型の配列

srcComponentID - 要求の送信元のコンポーネントID

戻り値:

連携結果(PFComponentCooperationResultクラスのオブジェクト)

例外:

PFDataCooperationException - エラーが発生した場合

componentCooperationRequest

PFComponentCooperationResult componentCooperationRequest(java.lang.String platformName,
                                                         java.lang.String brokerName,
                                                         int componentID,
                                                         java.lang.String componentPublicName,
                                                         java.lang.String methodName,
                                                         java.lang.Object[] argments,
                                                         java.lang.Class[] types,
                                                         boolean isLight,
                                                         int[] srcComponentID)
                                                  throws PFDataCooperationException

同期コンポーネント連携の要求を受け付ける.

パラメータ:

platformName - 連携を行うプラットフォーム名

brokerName - プラットフォームが所属するブローカ名

componentID - コンポーネントのID

methodName - メソッド名

argments - 引数の値の配列

types - 引数の型の配列

srcComponentID - 要求の送信元のコンポーネントID

戻り値:

連携結果(PFComponentCooperationResultクラスのオブジェクト)

例外:

PFDataCooperationException - エラーが発生した場合

componentCooperationAsyncRequest

void componentCooperationAsyncRequest(java.lang.String platformName,
                                      java.lang.String brokerName,
                                      java.lang.String componentName,
                                      int componentID,
                                      java.lang.String componentKey,
                                      java.lang.String componentPublicName,
                                      java.lang.String methodName,
                                      java.lang.Object[] argments,
                                      java.lang.Class[] types,
                                      boolean isLight,
                                      int[] srcComponentID)
                               throws PFDataCooperationException

非同期コンポーネント連携の要求を受け付ける.

パラメータ:

platformName - 連携を行うプラットフォーム名

brokerName - プラットフォームが所属するブローカ名

componentName - 連携を行うコンポーネント名

componentID - コンポーネントのID

componentKey - コンポーネントのキー

methodName - メソッド名

argments - 引数の値の配列

types - 引数の型の配列

srcComponentID - 要求の送信元のコンポーネントID

例外:

PFDataCooperationException - エラーが発生した場合

componentCooperationAsyncRequest

void componentCooperationAsyncRequest(java.lang.String platformName,
                                      java.lang.String brokerName,
                                      int componentID,
                                      java.lang.String componentPublicName,
                                      java.lang.String methodName,
                                      java.lang.Object[] argments,
                                      java.lang.Class[] types,
                                      boolean isLight,
                                      int[] srcComponentID)
                               throws PFDataCooperationException

非同期コンポーネント連携の要求を受け付ける.

パラメータ:

platformName - 連携を行うプラットフォーム名

brokerName - プラットフォームが所属するブローカ名

componentID - コンポーネントのID

methodName - メソッド名

argments - 引数の値の配列

types - 引数の型の配列

srcComponentID - 要求の送信元のコンポーネントID

例外:

PFDataCooperationException - エラーが発生した場合

registrySearchComponentInfo

PFComponentInfo[] registrySearchComponentInfo(PFPlatformFQName platformName,
                                              PFComponentFQName componentName,
                                              java.lang.String methodName,
                                              java.lang.String[] argTypes)
                                       throws PFDataCooperationException

コンポーネント情報の検索要求を受け付ける.

パラメータ:

platformName - プラットフォームの完全修飾名

componentName - コンポーネントの完全修飾名

methodName - メソッド名

argTypes - 引数の型名の配列

戻り値:

検索結果(PFComponentInfoオブジェクトの配列)

例外:

PFDataCooperationException - エラーが発生した場合

registryListAllComponentInfos

PFComponentInfo[] registryListAllComponentInfos()
                                         throws PFDataCooperationException

コンポーネント情報の一覧取得要求を受け付ける.

戻り値:

コンポーネント情報の一覧(PFComponentInfoの配列)

例外:

PFDataCooperationException - エラーが発生した場合

listAllBrokersInComponentInfos

java.lang.String[] listAllBrokersInComponentInfos()
                                           throws PFDataCooperationException

レジストリサーバにコンポーネント情報が登録されているブローカの一覧を取得する.

戻り値:

ブローカ名の配列

例外:

PFDataCooperationException - エラーが発生した場合

listAllPlatformsInComponentInfos

PFPlatformFQName[] listAllPlatformsInComponentInfos()
                                             throws PFDataCooperationException

レジストリサーバにコンポーネント情報が登録されている全ての プラットフォームを取得する.

戻り値:

プラットフォーム完全修飾名の配列

例外:

PFDataCooperationException - エラー発生時

listAllPlatformsInComponentInfos

PFPlatformFQName[] listAllPlatformsInComponentInfos(java.lang.String brokerName)
                                             throws PFDataCooperationException

レジストリサーバにコンポーネント情報が登録されているプラットフォームのうち、 指定されたブローカに属するものの一覧を取得する. ブローカ名にnullが指定 されたときは、レジストリに登録された全てのプラットフォームが取得される.

パラメータ:

brokerName - ブローカ名. 全てのプラットフォームを取得するときはnullを指定する.

戻り値:

プラットフォーム完全修飾名の配列

例外:

PFDataCooperationException - エラーが発生した場合

clear

void clear()

再初期化を行う.

getPlatformName

java.lang.String getPlatformName()

プラットフォーム名を取得する.

戻り値:

プラットフォーム名

getBrokerName

java.lang.String getBrokerName()

ブローカ名を取得する.

戻り値:

ブローカ名