All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.rmi.activation.ActivationSystem

public interface ActivationSystem
extends Remote
The ActivationSystem provides a means for registering groups and "activatable" objects to be activated within those groups. The ActivationSystem works closely with the Activator, which activates objects registered via the ActivationSystem, and the ActivationMonitor, which obtains information about active and inactive objects, and inactive groups.

Since:
JDK1.2
See Also:
Activator, ActivationMonitor

Variable Index

o SYSTEM_PORT
The port to lookup the activation system

Method Index

o activeGroup(ActivationGroupID, ActivationInstantiator, long)
Callback to inform activation system that group is now active.
o registerGroup(ActivationGroupDesc)
Register the activation group.
o registerObject(ActivationDesc)
The registerObject method is used to register an activation descriptor, desc, and obtain a activation identifier for a activatable remote object.
o unregisterGroup(ActivationGroupID)
Remove the activation group.
o unregisterObject(ActivationID)
Remove the activation id and associated descriptor previously registered with the ActivationSystem; the object can no longer be activated via the object's activation id.

Variables

o SYSTEM_PORT 
public static final int SYSTEM_PORT
The port to lookup the activation system

Methods

o registerObject 
public abstract ActivationID registerObject(ActivationDesc desc) throws ActivationException, UnknownGroupException, RemoteException
The registerObject method is used to register an activation descriptor, desc, and obtain a activation identifier for a activatable remote object. The ActivationSystem creates a ActivationID (a activation identifier) for the object specified by the descriptor, desc, and records, in stable storage, the activation descriptor and its associated identifier for later use. When the Activator receives an activate request for a specific identifier, it looks up the activation descriptor (registered previously) for the specified identifier and uses that information to activate the object.

Parameters:
desc - the object's activation descriptor
Returns:
the activation id that can be used to activate the object
Throws: ActivationException
if registration fails (e.g., database update failure, etc).
Throws: UnknownGroupException
if group referred to in desc is not registered with this system
Throws: RemoteException
if remote call fails
o unregisterObject 
public abstract void unregisterObject(ActivationID id) throws ActivationException, UnknownObjectException, RemoteException
Remove the activation id and associated descriptor previously registered with the ActivationSystem; the object can no longer be activated via the object's activation id.

Parameters:
id - the object's activation id (from previous registration)
Throws: ActivationException
if unregister fails (e.g., database update failure, etc).
Throws: UnknownObjectException
if object is unknown (not registered)
Throws: RemoteException
if remote call fails
o registerGroup 
public abstract ActivationGroupID registerGroup(ActivationGroupDesc desc) throws ActivationException, RemoteException
Register the activation group. An activation group must be registered with the ActivationSystem before objects can be registered within that group.

Parameters:
desc - the group's descriptor
Returns:
an identifier for the group
Throws: ActivationException
if group registration fails
Throws: RemoteException
if remote call fails
o activeGroup 
public abstract ActivationMonitor activeGroup(ActivationGroupID id,
                                              ActivationInstantiator group,
                                              long incarnation) throws UnknownGroupException, ActivationException, RemoteException
Callback to inform activation system that group is now active. This call is made internally by the ActivationGroup.createGroup method to inform the ActivationSystem that the group is now active.

Parameters:
id - the activation group's identifier
group - the group's instantiator
incarnation - the group's incarnation number
Throws: UnknownGroupException
if group is not registered
Throws: ActivationException
if group is already active
Throws: RemoteException
if remote call fails
o unregisterGroup 
public abstract void unregisterGroup(ActivationGroupID id) throws ActivationException, UnknownGroupException, RemoteException
Remove the activation group. An activation group makes this call back to inform the activator that the group should be removed (destroyed). If this call completes successfully, objects can no longer be registered or activated within the group. All information of the group and its associated objects is removed from the system.

Parameters:
id - the activation group's identifier
Throws: ActivationException
if unregister fails (e.g., database update failure, etc).
Throws: UnknownGroupException
if group is not registered
Throws: RemoteException
if remote call fails
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature