JavaTM 2 Platform
Standard Ed. 5.0

java.rmi.activation
クラス Activatable

java.lang.Object
  上位を拡張 java.rmi.server.RemoteObject
      上位を拡張 java.rmi.server.RemoteServer
          上位を拡張 java.rmi.activation.Activatable
すべての実装されたインタフェース:
Serializable, Remote

public abstract class Activatable
extends RemoteServer

永続的なアクセスを必要とし、システムから起動できるリモートオブジェクトをサポートします。

コンストラクタおよび static exportObject メソッドの場合、エクスポートするリモートオブジェクトのスタブは、UnicastRemoteObject で説明した方法で取得されます。

導入されたバージョン:
1.2
関連項目:
直列化された形式

フィールドの概要
 
クラス java.rmi.server.RemoteObject から継承されたフィールド
ref
 
コンストラクタの概要
protected Activatable(ActivationID id, int port)
          指定されたポート上でオブジェクトを起動またはエクスポートするために使うコンストラクタです。
protected Activatable(ActivationID id, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          指定されたポート上でオブジェクトを起動またはエクスポートするために使うコンストラクタです。
protected Activatable(String location, MarshalledObject data, boolean restart, int port)
          指定されたポートにオブジェクトを登録およびエクスポートするために使うコンストラクタです。
protected Activatable(String location, MarshalledObject data, boolean restart, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          指定されたポートにオブジェクトを登録およびエクスポートするために使うコンストラクタです。
 
メソッドの概要
static Remote exportObject(Remote obj, ActivationID id, int port)
          起動可能なリモートオブジェクトを RMI ランタイムにエクスポートすることにより、着信呼び出しの受け付けにオブジェクトを使用できるようにします。
static Remote exportObject(Remote obj, ActivationID id, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          起動可能なリモートオブジェクトを RMI ランタイムにエクスポートすることにより、着信呼び出しの受け付けにオブジェクトを使用できるようにします。
static ActivationID exportObject(Remote obj, String location, MarshalledObject data, boolean restart, int port)
          exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。
static ActivationID exportObject(Remote obj, String location, MarshalledObject data, boolean restart, int port, RMIClientSocketFactory csf, RMIServerSocketFactory ssf)
          exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。
protected  ActivationID getID()
          オブジェクトの起動識別子を返します。
static boolean inactive(ActivationID id)
          対応する起動 id のオブジェクトが現在停止していることを、システムに通知します。
static Remote register(ActivationDesc desc)
          起動可能なリモートオブジェクトのオブジェクト記述子を登録して、要求に応じてリモートオブジェクトを起動できるようにします。
static boolean unexportObject(Remote obj, boolean force)
          RMI ランタイムからリモートオブジェクト obj を削除します。
static void unregister(ActivationID id)
          id に関連した起動記述子の登録を取り消します。
 
クラス java.rmi.server.RemoteServer から継承されたメソッド
getClientHost, getLog, setLog
 
クラス java.rmi.server.RemoteObject から継承されたメソッド
equals, getRef, hashCode, toString, toStub
 
クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

Activatable

protected Activatable(String location,
                      MarshalledObject data,
                      boolean restart,
                      int port)
               throws ActivationException,
                      RemoteException
指定されたポートにオブジェクトを登録およびエクスポートするために使うコンストラクタです。port=0 の場合は匿名ポートが選択されます。 このクラスの具象サブクラスは、最初の構築時にオブジェクトを登録およびエクスポートするために、このコンストラクタを呼び出す必要があります。起動可能なオブジェクトを構築すると、リモートオブジェクトが起動システムに「登録」され、RMI ランタイムに「エクスポート」されます。port=0 の場合は匿名ポートが使用されます。これによって、リモートオブジェクトは、クライアントからの着信呼び出しの受け付けに使用できます。

パラメータ:
location - オブジェクトが使うクラスの位置
data - オブジェクトの初期化データ
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
restart - true の場合は、アクティベータが再起動したとき、または突然のクラッシュ後にオブジェクトの起動グループを再起動したときにオブジェクトも起動される。false の場合は、オブジェクトは要求に応じて起動される。restarttrue に指定しても、新規登録オブジェクトを最初にすぐ起動するわけではない。初期起動はすぐには行われない
例外:
ActivationException - オブジェクトの登録が失敗した場合
RemoteException - 次のどちらかが失敗した場合。a) 起動システムへのオブジェクトの登録。b) RMI ランタイムへのオブジェクトのエクスポート
導入されたバージョン:
1.2

Activatable

protected Activatable(String location,
                      MarshalledObject data,
                      boolean restart,
                      int port,
                      RMIClientSocketFactory csf,
                      RMIServerSocketFactory ssf)
               throws ActivationException,
                      RemoteException
指定されたポートにオブジェクトを登録およびエクスポートするために使うコンストラクタです。port=0 の場合は匿名ポートが選択されます。

このクラスの具象サブクラスは、最初の構築時にオブジェクトを登録およびエクスポートするために、このコンストラクタを呼び出す必要があります。起動可能なオブジェクトを構築すると、リモートオブジェクトが起動システムに「登録」され、RMI ランタイムに「エクスポート」されます。port=0 の場合は匿名ポートが使用されます。これによって、リモートオブジェクトは、クライアントからの着信呼び出しの受け付けに使用できます。

パラメータ:
location - オブジェクトが使うクラスの位置
data - オブジェクトの初期化データ
restart - true の場合は、アクティベータが再起動したとき、または突然のクラッシュ後にオブジェクトの起動グループを再起動したときにオブジェクトも起動される。false の場合は、オブジェクトは要求に応じて起動される。restarttrue に指定しても、新規登録オブジェクトを最初にすぐ起動するわけではない。初期起動はすぐには行われない
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
csf - リモートオブジェクトの呼び出しに使用する、クライアント側ソケットファクトリ
ssf - リモートオブジェクト呼び出しを受信する、サーバ側ソケットファクトリ
例外:
ActivationException - オブジェクトの登録が失敗した場合
RemoteException - 次のどちらかが失敗した場合。a) 起動システムへのオブジェクトの登録。b) RMI ランタイムへのオブジェクトのエクスポート
導入されたバージョン:
1.2

Activatable

protected Activatable(ActivationID id,
                      int port)
               throws RemoteException
指定されたポート上でオブジェクトを起動またはエクスポートするために使うコンストラクタです。「起動可能な」リモートオブジェクトには、以下の 2 つの引数を持つコンストラクタが必要です。

このクラスの具象サブクラスは、前述したコンストラクタを通じて起動されるときに、このコンストラクタを呼び出す必要があります。起動可能なオブジェクトを構築すると、指定された port 上の RMI ランタイムにリモートオブジェクトがエクスポートされ、クライアントからの着信呼び出しの受け付けに使用できるようになります。

パラメータ:
id - オブジェクトの起動識別子
port - オブジェクトのエクスポート先のポート番号
例外:
RemoteException - RMI ランタイムへのオブジェクトのエクスポートが失敗した場合
導入されたバージョン:
1.2

Activatable

protected Activatable(ActivationID id,
                      int port,
                      RMIClientSocketFactory csf,
                      RMIServerSocketFactory ssf)
               throws RemoteException
指定されたポート上でオブジェクトを起動またはエクスポートするために使うコンストラクタです。「起動可能な」リモートオブジェクトには、以下の 2 つの引数を持つコンストラクタが必要です。

このクラスの具象サブクラスは、前述したコンストラクタを通じて起動されるときに、このコンストラクタを呼び出す必要があります。起動可能なオブジェクトを構築すると、指定された port 上の RMI ランタイムにリモートオブジェクトがエクスポートされ、クライアントからの着信呼び出しの受け付けに使用できるようになります。

パラメータ:
id - オブジェクトの起動識別子
port - オブジェクトのエクスポート先のポート番号
csf - リモートオブジェクトの呼び出しに使用する、クライアント側ソケットファクトリ
ssf - リモートオブジェクト呼び出しを受信する、サーバ側ソケットファクトリ
例外:
RemoteException - RMI ランタイムへのオブジェクトのエクスポートが失敗した場合
導入されたバージョン:
1.2
メソッドの詳細

getID

protected ActivationID getID()
オブジェクトの起動識別子を返します。このメソッドは、サブクラスだけがオブジェクトの識別子を取得できるように保護されています。

戻り値:
オブジェクトの起動識別子
導入されたバージョン:
1.2

register

public static Remote register(ActivationDesc desc)
                       throws UnknownGroupException,
                              ActivationException,
                              RemoteException
起動可能なリモートオブジェクトのオブジェクト記述子を登録して、要求に応じてリモートオブジェクトを起動できるようにします。

パラメータ:
desc - オブジェクトの記述子
戻り値:
起動可能なリモートオブジェクトが使うスタブ
例外:
UnknownGroupException - desc にあるグループ ID が起動システムに登録されていない場合
ActivationException - 起動システムが動作していない場合
RemoteException - リモート呼び出しが失敗した場合
導入されたバージョン:
1.2

inactive

public static boolean inactive(ActivationID id)
                        throws UnknownObjectException,
                               ActivationException,
                               RemoteException
対応する起動 id のオブジェクトが現在停止していることを、システムに通知します。オブジェクトが現在起動中である場合、そのオブジェクトは RMI ランタイムから「アンエクスポート」され (保留中、あるいは進行中の呼び出しがない場合のみ)、以後の着信呼び出しを受信できなくなります。この呼び出しは VM の ActivationGroup にオブジェクトが停止していることを通知し、ActivationGroup は、該当する ActivationMonitor に通知を行います。この呼び出しが正常に完了した場合、アクティベータへの後続の起動要求によってオブジェクトが再び起動されます。この操作は、オブジェクトが起動中であっても、アンエクスポート済みの場合は true を返します。

パラメータ:
id - オブジェクトの起動識別子
戻り値:
処理が成功した場合は true。オブジェクトが起動中であっても、アンエクスポート済みであるか、エクスポート中であり、保留中あるいは実行中の呼び出しがない場合、処理は成功する。オブジェクトに保留中あるいは実行中の呼び出しがあり、オブジェクトを終了できない場合は false
例外:
UnknownObjectException - オブジェクトが不明な場合。すでに停止している場合もある
ActivationException - グループが動作していない場合
RemoteException - 呼び出し通知モニターが失敗した場合
導入されたバージョン:
1.2

unregister

public static void unregister(ActivationID id)
                       throws UnknownObjectException,
                              ActivationException,
                              RemoteException
id に関連した起動記述子の登録を取り消します。その id を使ってオブジェクトを起動することはできなくなります。

パラメータ:
id - オブジェクトの起動識別子
例外:
UnknownObjectException - オブジェクト (id) が不明な場合
ActivationException - 起動システムが動作していない場合
RemoteException - 起動システムへのリモート呼び出しが失敗した場合
導入されたバージョン:
1.2

exportObject

public static ActivationID exportObject(Remote obj,
                                        String location,
                                        MarshalledObject data,
                                        boolean restart,
                                        int port)
                                 throws ActivationException,
                                        RemoteException
exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。この呼び出しで、a) 指定された location および data で構築された、オブジェクトの起動記述子を起動システムに登録することにより、オブジェクトを起動可能にしたり、b) リモートオブジェクト obj を、指定されたポートにエクスポートしたりします。port=0 の場合は、匿名ポートが選択されます。オブジェクトがいったんエクスポートされると、RMI 着信呼び出しを受け取ることができます。

objActivatable クラスを拡張する場合は、最初のコンストラクタがこのメソッドを呼び出すので、このメソッドの明示的な呼び出しは不要です。

パラメータ:
obj - エクスポート対象のオブジェクト
location - オブジェクトのコードの位置
data - オブジェクトのブートストラップデータ
restart - true の場合は、アクティベータが再起動したとき、または突然のクラッシュ後にオブジェクトの起動グループを再起動したときにオブジェクトも起動される。false の場合は、オブジェクトは要求に応じて起動される。restarttrue に指定しても、新規登録オブジェクトを最初にすぐ起動するわけではない。初期起動はすぐには行われない
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
戻り値:
起動システムが間違ったグループである場合に、記述子 desc を登録したときに取得した起動識別子
例外:
ActivationException - グループが停止している場合
RemoteException - オブジェクトの登録あるいはエクスポートが失敗した場合
導入されたバージョン:
1.2

exportObject

public static ActivationID exportObject(Remote obj,
                                        String location,
                                        MarshalledObject data,
                                        boolean restart,
                                        int port,
                                        RMIClientSocketFactory csf,
                                        RMIServerSocketFactory ssf)
                                 throws ActivationException,
                                        RemoteException
exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。この呼び出しで、a) 指定された location および data で構築された、オブジェクトの起動記述子を起動システムに登録することにより、オブジェクトを起動可能にしたり、b) リモートオブジェクト obj を、指定されたポートにエクスポートしたりします。port=0 の場合は、匿名ポートが選択されます。オブジェクトがいったんエクスポートされると、RMI 着信呼び出しを受け取ることができます。

objActivatable クラスを拡張する場合は、最初のコンストラクタがこのメソッドを呼び出すので、このメソッドの明示的な呼び出しは不要です。

パラメータ:
obj - エクスポート対象のオブジェクト
location - オブジェクトのコードの位置
data - オブジェクトのブートストラップデータ
restart - true の場合は、アクティベータが再起動したとき、または突然のクラッシュ後にオブジェクトの起動グループを再起動したときにオブジェクトも起動される。false の場合は、オブジェクトは要求に応じて起動される。restarttrue に指定しても、新規登録オブジェクトを最初にすぐ起動するわけではない。初期起動はすぐには行われない
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
csf - リモートオブジェクトの呼び出しに使用する、クライアント側ソケットファクトリ
ssf - リモートオブジェクト呼び出しを受信する、サーバ側ソケットファクトリ
戻り値:
起動システムが間違ったグループである場合に、記述子 desc を登録したときに取得した起動識別子
例外:
ActivationException - グループが停止している場合
RemoteException - オブジェクトの登録あるいはエクスポートが失敗した場合
導入されたバージョン:
1.2

exportObject

public static Remote exportObject(Remote obj,
                                  ActivationID id,
                                  int port)
                           throws RemoteException
起動可能なリモートオブジェクトを RMI ランタイムにエクスポートすることにより、着信呼び出しの受け付けにオブジェクトを使用できるようにします。port の値が 0 の場合、オブジェクトは匿名ポートにエクスポートされます。

起動時に、exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。Activatable を拡張するオブジェクトであれば、このメソッドを直接呼び出す必要はありません。このメソッドは、前述の 2 番目のコンストラクタに呼び出されます。また、サブクラスが、特別な起動コンストラクタからこのコンストラクタを呼び出すことがあります。

パラメータ:
obj - 実装されたリモートオブジェクト
id - オブジェクトの起動識別子
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
戻り値:
起動可能なリモートオブジェクトが使うスタブ
例外:
RemoteException - オブジェクトのエクスポートに失敗した場合
導入されたバージョン:
1.2

exportObject

public static Remote exportObject(Remote obj,
                                  ActivationID id,
                                  int port,
                                  RMIClientSocketFactory csf,
                                  RMIServerSocketFactory ssf)
                           throws RemoteException
起動可能なリモートオブジェクトを RMI ランタイムにエクスポートすることにより、着信呼び出しの受け付けにオブジェクトを使用できるようにします。port の値が 0 の場合、オブジェクトは匿名ポートにエクスポートされます。

起動時に、exportObject メソッドは、Activatable クラスを拡張しない「起動可能な」オブジェクトから明示的に呼び出されることがあります。Activatable を拡張するオブジェクトであれば、このメソッドを直接呼び出す必要はありません。このメソッドは、前述の 2 番目のコンストラクタに呼び出されます。また、サブクラスが、特別な起動コンストラクタからこのコンストラクタを呼び出すことがあります。

パラメータ:
obj - 実装されたリモートオブジェクト
id - オブジェクトの起動識別子
port - オブジェクトのエクスポート先のポート。port=0 の場合は匿名ポートが使用される
csf - リモートオブジェクトの呼び出しに使用する、クライアント側ソケットファクトリ
ssf - リモートオブジェクト呼び出しを受信する、サーバ側ソケットファクトリ
戻り値:
起動可能なリモートオブジェクトが使うスタブ
例外:
RemoteException - オブジェクトのエクスポートに失敗した場合
導入されたバージョン:
1.2

unexportObject

public static boolean unexportObject(Remote obj,
                                     boolean force)
                              throws NoSuchObjectException
RMI ランタイムからリモートオブジェクト obj を削除します。削除が成功すると、オブジェクトは RMI 入接続呼の受け付けのために使用できなくなります。パラメータ force が true に設定されていると、リモートオブジェクトへの保留状態の呼び出しがある場合や、進行中の呼び出しがある場合でも、オブジェクトは強制的にアンエクスポートされます。パラメータ force が false に設定されていると、オブジェクトへの保留中または進行中の呼び出しがない場合にのみ、オブジェクトがアンエクスポートされます。

パラメータ:
obj - エクスポートされリモートオブジェクト
force - true の場合は、保留中または進行中の呼び出しがあっても、オブジェクトのエクスポートを解除する。false の場合には、保留中または進行中の呼び出しがないときにだけ、オブジェクトはアンエクスポートされる
戻り値:
操作が成功した場合は true、そうでない場合は false
例外:
NoSuchObjectException - リモートオブジェクトが現在エクスポートされていない場合
導入されたバージョン:
1.2

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。