jp.go.aist.dmrc.platform.beans.datamanagement

クラス PFAccessControlComponent

java.lang.Object

jp.go.aist.dmrc.platform.beans.datamanagement.PFAccessControlComponent

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource

public class PFAccessControlComponent
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFXMLSerializable

アクセス制御機能を利用するためのコンポーネント.

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PFAccessControlComponent() コンストラクタ.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addPFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
int	getComponentID() コンポーネントIDを取得する.
java.lang.String	getComponentKey() コンポーネントキーを取得する.
java.lang.String	getComponentName() コンポーネント名称を取得する.
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する.
java.util.Iterator	getPFDataCreateListenerList() イベントリスナ配列を取得する。
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール更新への対応を行う.
void	readAccessControlInfo(java.lang.String filename) 指定されたファイルからアクセス制御の設定情報を読み込み、 アクセス制御情報クラスの配列を返す.
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	removePFDataCreateListener(PFDataCreateListener lis) 引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。
void	restartAccessControl() アクセス制御の設定を再度実行する.
void	saveAccessControlInfo(PFAccessControlInfo[] infos, java.lang.String filename) アクセス制御情報クラスの配列を、所定の書式の文字列に変換した上で 指定されたファイルに出力する.
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する.
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する.
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PFAccessControlComponent

public PFAccessControlComponent()

コンストラクタ.

メソッドの詳細

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する.

定義:

getComponentName インタフェース内 PFComponent

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する.

定義:

getComponentKey インタフェース内 PFComponent

戻り値:

コンポーネントキー文字列

関連項目:

setComponentKey(java.lang.String)

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する.

定義:

setComponentKey インタフェース内 PFComponent

パラメータ:

key - コンポーネントキー文字列

関連項目:

getComponentKey()

getComponentID

public int getComponentID()

コンポーネントIDを取得する.

定義:

getComponentID インタフェース内 PFComponent

戻り値:

コンポーネントID

関連項目:

setComponentID(int)

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する.
コンポーネントIDはプラットフォームPFComponentBusから設定される. 各コンポーネント内では操作しないこと.

定義:

setComponentID インタフェース内 PFComponent

パラメータ:

id - 設定するコンポーネントID

関連項目:

getComponentID()

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する.
形式："Component Name" [ ID : "ID" ]

定義:

getComponentString インタフェース内 PFComponent

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

getComponentPublicName インタフェース内 PFComponent

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

setComponentPublicName インタフェース内 PFComponent

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

isAllowRemoteInvocation インタフェース内 PFComponent

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

setAllowRemoteInvocation インタフェース内 PFComponent

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPullTransfer インタフェース内 PFComponent

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPullTransfer インタフェース内 PFComponent

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

isAllowPushTransfer インタフェース内 PFComponent

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

setAllowPushTransfer インタフェース内 PFComponent

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()

ロケール更新への対応を行う.

定義:

localeUpdated インタフェース内 PFComponent

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

readXML インタフェース内 PFXMLSerializable

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

writeXML インタフェース内 PFXMLSerializable

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()

インタフェースからコピーされた説明: PFDataCreateEventSource

イベントリスナ配列を取得する。

定義:

getPFDataCreateListenerList インタフェース内 PFDataCreateEventSource

戻り値:

イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)

インタフェースからコピーされた説明: PFDataCreateEventSource

引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:

addPFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)

インタフェースからコピーされた説明: PFDataCreateEventSource

引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:

removePFDataCreateListener インタフェース内 PFDataCreateEventSource

パラメータ:

lis - 削除対象イベントリスナ

restartAccessControl

public void restartAccessControl()
                          throws PFDataManagementException

アクセス制御の設定を再度実行する.

例外:

PFDataManagementException - エラー発生時

readAccessControlInfo

public void readAccessControlInfo(java.lang.String filename)
                           throws PFDataManagementException,
                                  PFMethodException,
                                  PFRuntimeException

指定されたファイルからアクセス制御の設定情報を読み込み、 アクセス制御情報クラスの配列を返す.

パラメータ:

filename - ファイル名

例外:

PFDataManagementException - エラー発生時

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

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

saveAccessControlInfo

public void saveAccessControlInfo(PFAccessControlInfo[] infos,
                                  java.lang.String filename)
                           throws PFDataManagementException

アクセス制御情報クラスの配列を、所定の書式の文字列に変換した上で 指定されたファイルに出力する.

パラメータ:

infos - 出力するアクセス制御情報クラスの配列

filename - ファイル名

例外:

PFDataManagementException - エラー発生時