java.rmi.activation

インタフェース ActivationSystem

すべてのスーパーインタフェース:

Remote

public interface ActivationSystem
extends Remote

ActivationSystem は、グループ、およびその中にある「起動可能な」オブジェクトのうちで起動しておくものを登録する方法を提供します。ActivationSystem は、ActivationSystem を使って登録されたオブジェクトを起動する Activator、および起動中あるいは停止中のオブジェクトと停止中のグループに関する情報を取得する ActivationMonitor と密接に連携しながら動作します。

導入されたバージョン:

1.2

関連項目:

Activator, ActivationMonitor

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static int	SYSTEM_PORT 起動システムを探すポートです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
ActivationMonitor	activeGroup(ActivationGroupID id, ActivationInstantiator group, long incarnation) グループが起動中であることを起動システムに通知するコールバックです。
ActivationDesc	getActivationDesc(ActivationID id) 起動識別子が id であるオブジェクトの起動記述子を返します。
ActivationGroupDesc	getActivationGroupDesc(ActivationGroupID id) 起動グループ識別子が id であるグループの起動グループ記述子を返します。
ActivationGroupID	registerGroup(ActivationGroupDesc desc) 起動グループを登録します。
ActivationID	registerObject(ActivationDesc desc) registerObject メソッドは、起動記述子 desc の登録、および起動可能なリモートオブジェクトの起動識別子の取得に使います。
ActivationDesc	setActivationDesc(ActivationID id, ActivationDesc desc) 起動識別子が id であるオブジェクトの起動記述子 desc を設定します。
ActivationGroupDesc	setActivationGroupDesc(ActivationGroupID id, ActivationGroupDesc desc) 起動グループ識別子が id であるオブジェクトの起動グループ記述子 desc を設定します。
void	shutdown() 起動システムを停止します。
void	unregisterGroup(ActivationGroupID id) 起動グループを削除します。
void	unregisterObject(ActivationID id) ActivationSystem で登録された起動 ID、および関連した記述子を削除します。オブジェクトは、その起動 ID で起動できなくなります。

フィールドの詳細

SYSTEM_PORT

static final int SYSTEM_PORT

起動システムを探すポートです。

関連項目:

定数フィールド値

メソッドの詳細

registerObject

ActivationID registerObject(ActivationDesc desc)
                            throws ActivationException,
                                   UnknownGroupException,
                                   RemoteException

registerObject メソッドは、起動記述子 desc の登録、および起動可能なリモートオブジェクトの起動識別子の取得に使います。ActivationSystem は、記述子 desc に指定されたオブジェクトの ActivationID (起動識別子) を作成し、安定記憶領域に、あとで使用するための起動記述子およびそれに関連した識別子を記録します。Activator は、特定の識別子を対象とした activate 要求を受け取ると、指定された識別子に対応する起動記述子 (前に登録したもの) を探し、その情報を使用してオブジェクトを起動します。

パラメータ:

desc - オブジェクトの起動記述子

戻り値:

オブジェクトの起動に使用する起動 ID

例外:

ActivationException - 登録が失敗した場合 (たとえば、データベース更新の失敗)。

UnknownGroupException - desc に示されたグループがこのシステムに登録されていない場合

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

unregisterObject

void unregisterObject(ActivationID id)
                      throws ActivationException,
                             UnknownObjectException,
                             RemoteException

ActivationSystem で登録された起動 ID、および関連した記述子を削除します。オブジェクトは、その起動 ID で起動できなくなります。

パラメータ:

id - オブジェクトの起動 ID (以前に登録されたもの)

例外:

ActivationException - 登録解除が失敗した場合 (たとえば、データベース更新の失敗など)

UnknownObjectException - オブジェクトが不明な (登録されていない) 場合

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

registerGroup

ActivationGroupID registerGroup(ActivationGroupDesc desc)
                                throws ActivationException,
                                       RemoteException

起動グループを登録します。オブジェクトを起動グループに登録する前に、その起動グループを ActivationSystem に登録しておく必要があります。

パラメータ:

desc - グループの記述子

戻り値:

グループの識別子

例外:

ActivationException - グループの登録が失敗した場合

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

activeGroup

ActivationMonitor activeGroup(ActivationGroupID id,
                            ActivationInstantiator group,
                            long incarnation)
                              throws UnknownGroupException,
                                     ActivationException,
                                     RemoteException

グループが起動中であることを起動システムに通知するコールバックです。この呼び出しが ActivationGroup.createGroup メソッドの内部で実行されることにより、グループが起動中であることを ActivationSystem に通知します。

パラメータ:

id - 起動グループの識別子

group - グループのインスタンシエータ

incarnation - グループの生成番号

戻り値:

起動グループのモニター

例外:

UnknownGroupException - グループが登録されていない場合

ActivationException - 指定された id に対するグループがすでに起動されており、かつそのグループが指定された group と等しくないか、あるいはそのグループが指定された group とは異なる incarnation を持つ場合

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

unregisterGroup

void unregisterGroup(ActivationGroupID id)
                     throws ActivationException,
                            UnknownGroupException,
                            RemoteException

起動グループを削除します。起動グループはこのコールバックを返すことにより、グループを削除 (破棄) するようアクティベータに通知します。この呼び出しが成功した場合は、そのグループにオブジェクトを登録したり、そのグループ内でオブジェクトを起動したりすることはできなくなります。そのグループに関する情報と、そのグループに関連付けられたオブジェクトはすべてシステムから削除されます。

パラメータ:

id - 起動グループの識別子

例外:

ActivationException - 登録解除が失敗した場合 (たとえば、データベース更新の失敗など)

UnknownGroupException - グループが登録されていない場合

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

shutdown

void shutdown()
              throws RemoteException

起動システムを停止します。起動デーモンによって生成されたグループをすべて破棄して、起動デーモンを終了します。

例外:

RemoteException - 起動デーモンの接続/シャットダウンが失敗した場合

導入されたバージョン:

1.2

setActivationDesc

ActivationDesc setActivationDesc(ActivationID id,
                               ActivationDesc desc)
                                 throws ActivationException,
                                        UnknownObjectException,
                                        UnknownGroupException,
                                        RemoteException

起動識別子が id であるオブジェクトの起動記述子 desc を設定します。この変更は、次回オブジェクトを起動したときに有効になります。

パラメータ:

id - 起動可能なオブジェクトの起動識別子

desc - 起動可能なオブジェクトの起動記述子

戻り値:

起動記述子の以前の値

例外:

UnknownGroupException - desc に関連したグループが登録されていない場合

UnknownObjectException - 起動 id が登録されていない場合

ActivationException - 一般的なエラー (たとえば、ログを更新できない場合)

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

関連項目:

getActivationDesc(java.rmi.activation.ActivationID)

setActivationGroupDesc

ActivationGroupDesc setActivationGroupDesc(ActivationGroupID id,
                                         ActivationGroupDesc desc)
                                           throws ActivationException,
                                                  UnknownGroupException,
                                                  RemoteException

起動グループ識別子が id であるオブジェクトの起動グループ記述子 desc を設定します。この変更は、次回グループを起動したときに有効になります。

パラメータ:

id - 起動グループの起動グループ識別子

desc - 起動グループの起動グループ記述子

戻り値:

起動グループ記述子の以前の値

例外:

UnknownGroupException - id に関連したグループが登録されていない場合

ActivationException - 一般的なエラー (たとえば、ログを更新できない場合)

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

関連項目:

getActivationGroupDesc(java.rmi.activation.ActivationGroupID)

getActivationDesc

ActivationDesc getActivationDesc(ActivationID id)
                                 throws ActivationException,
                                        UnknownObjectException,
                                        RemoteException

起動識別子が id であるオブジェクトの起動記述子を返します。

パラメータ:

id - 起動可能なオブジェクトの起動識別子

戻り値:

起動記述子

例外:

UnknownObjectException - id が登録されていない場合

ActivationException - 一般的なエラー

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

関連項目:

setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc)

getActivationGroupDesc

ActivationGroupDesc getActivationGroupDesc(ActivationGroupID id)
                                           throws ActivationException,
                                                  UnknownGroupException,
                                                  RemoteException

起動グループ識別子が id であるグループの起動グループ記述子を返します。

パラメータ:

id - グループの起動グループ識別子

戻り値:

起動グループ記述子

例外:

UnknownGroupException - id が登録されていない場合

ActivationException - 一般的なエラー

RemoteException - リモート呼び出しが失敗した場合

導入されたバージョン:

1.2

関連項目:

setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc)