java.rmi.activation
Interface ActivationSystem

All Superinterfaces:
Remote sample code for java.rmi.Remote definition code for java.rmi.Remote

public interface ActivationSystem
extends Remote sample code for java.rmi.Remote definition code for java.rmi.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:
1.2
See Also:
Activator sample code for java.rmi.activation.Activator definition code for java.rmi.activation.Activator , ActivationMonitor sample code for java.rmi.activation.ActivationMonitor definition code for java.rmi.activation.ActivationMonitor

Field Summary
static int SYSTEM_PORT sample code for java.rmi.activation.ActivationSystem.SYSTEM_PORT definition code for java.rmi.activation.ActivationSystem.SYSTEM_PORT
          The port to lookup the activation system.
 
Method Summary
 ActivationMonitor sample code for java.rmi.activation.ActivationMonitor definition code for java.rmi.activation.ActivationMonitor activeGroup sample code for java.rmi.activation.ActivationSystem.activeGroup(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationInstantiator, long) definition code for java.rmi.activation.ActivationSystem.activeGroup(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationInstantiator, long) (ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id, ActivationInstantiator sample code for java.rmi.activation.ActivationInstantiator definition code for java.rmi.activation.ActivationInstantiator  group, long incarnation)
          Callback to inform activation system that group is now active.
 ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc getActivationDesc sample code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID) definition code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID) (ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id)
          Returns the activation descriptor, for the object with the activation identifier, id.
 ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc getActivationGroupDesc sample code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID) definition code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID) (ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id)
          Returns the activation group descriptor, for the group with the activation group identifier, id.
 ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID registerGroup sample code for java.rmi.activation.ActivationSystem.registerGroup(java.rmi.activation.ActivationGroupDesc) definition code for java.rmi.activation.ActivationSystem.registerGroup(java.rmi.activation.ActivationGroupDesc) (ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  desc)
          Register the activation group.
 ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID registerObject sample code for java.rmi.activation.ActivationSystem.registerObject(java.rmi.activation.ActivationDesc) definition code for java.rmi.activation.ActivationSystem.registerObject(java.rmi.activation.ActivationDesc) (ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  desc)
          The registerObject method is used to register an activation descriptor, desc, and obtain an activation identifier for a activatable remote object.
 ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc setActivationDesc sample code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc) definition code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc) (ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id, ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  desc)
          Set the activation descriptor, desc for the object with the activation identifier, id.
 ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc setActivationGroupDesc sample code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc) definition code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc) (ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id, ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  desc)
          Set the activation group descriptor, desc for the object with the activation group identifier, id.
 void shutdown sample code for java.rmi.activation.ActivationSystem.shutdown() definition code for java.rmi.activation.ActivationSystem.shutdown() ()
          Shutdown the activation system.
 void unregisterGroup sample code for java.rmi.activation.ActivationSystem.unregisterGroup(java.rmi.activation.ActivationGroupID) definition code for java.rmi.activation.ActivationSystem.unregisterGroup(java.rmi.activation.ActivationGroupID) (ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id)
          Remove the activation group.
 void unregisterObject sample code for java.rmi.activation.ActivationSystem.unregisterObject(java.rmi.activation.ActivationID) definition code for java.rmi.activation.ActivationSystem.unregisterObject(java.rmi.activation.ActivationID) (ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id)
          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.
 

Field Detail

SYSTEM_PORT sample code for java.rmi.activation.ActivationSystem.SYSTEM_PORT

static final int SYSTEM_PORT
The port to lookup the activation system.

See Also:
Constant Field Values
Method Detail

registerObject sample code for java.rmi.activation.ActivationSystem.registerObject(java.rmi.activation.ActivationDesc) definition code for java.rmi.activation.ActivationSystem.registerObject(java.rmi.activation.ActivationDesc)

ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  registerObject(ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  desc)
                            throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                   UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                                   RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
The registerObject method is used to register an activation descriptor, desc, and obtain an activation identifier for a activatable remote object. The ActivationSystem creates an 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 sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - if registration fails (e.g., database update failure, etc).
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - if group referred to in desc is not registered with this system
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2

unregisterObject sample code for java.rmi.activation.ActivationSystem.unregisterObject(java.rmi.activation.ActivationID) definition code for java.rmi.activation.ActivationSystem.unregisterObject(java.rmi.activation.ActivationID)

void unregisterObject(ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id)
                      throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                             UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException ,
                             RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.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 sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - if unregister fails (e.g., database update failure, etc).
UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException - if object is unknown (not registered)
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2

registerGroup sample code for java.rmi.activation.ActivationSystem.registerGroup(java.rmi.activation.ActivationGroupDesc) definition code for java.rmi.activation.ActivationSystem.registerGroup(java.rmi.activation.ActivationGroupDesc)

ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  registerGroup(ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  desc)
                                throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                       RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.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 sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - if group registration fails
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2

activeGroup sample code for java.rmi.activation.ActivationSystem.activeGroup(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationInstantiator, long) definition code for java.rmi.activation.ActivationSystem.activeGroup(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationInstantiator, long)

ActivationMonitor sample code for java.rmi.activation.ActivationMonitor definition code for java.rmi.activation.ActivationMonitor  activeGroup(ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id,
                              ActivationInstantiator sample code for java.rmi.activation.ActivationInstantiator definition code for java.rmi.activation.ActivationInstantiator  group,
                              long incarnation)
                              throws UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                                     ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                     RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.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
Returns:
monitor for activation group
Throws:
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - if group is not registered
ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - if a group for the specified id is already active and that group is not equal to the specified group or that group has a different incarnation than the specified group
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2

unregisterGroup sample code for java.rmi.activation.ActivationSystem.unregisterGroup(java.rmi.activation.ActivationGroupID) definition code for java.rmi.activation.ActivationSystem.unregisterGroup(java.rmi.activation.ActivationGroupID)

void unregisterGroup(ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id)
                     throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                            UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                            RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.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 sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - if unregister fails (e.g., database update failure, etc).
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - if group is not registered
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2

shutdown sample code for java.rmi.activation.ActivationSystem.shutdown() definition code for java.rmi.activation.ActivationSystem.shutdown()

void shutdown()
              throws RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
Shutdown the activation system. Destroys all groups spawned by the activation daemon and exits the activation daemon.

Throws:
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if failed to contact/shutdown the activation daemon
Since:
1.2

setActivationDesc sample code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc) definition code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc)

ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  setActivationDesc(ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id,
                                 ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  desc)
                                 throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                        UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException ,
                                        UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                                        RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
Set the activation descriptor, desc for the object with the activation identifier, id. The change will take effect upon subsequent activation of the object.

Parameters:
id - the activation identifier for the activatable object
desc - the activation descriptor for the activatable object
Returns:
the previous value of the activation descriptor
Throws:
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - the group associated with desc is not a registered group
UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException - the activation id is not registered
ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - for general failure (e.g., unable to update log)
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2
See Also:
getActivationDesc(java.rmi.activation.ActivationID) sample code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID) definition code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID)

setActivationGroupDesc sample code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc) definition code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc)

ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  setActivationGroupDesc(ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id,
                                           ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  desc)
                                           throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                                  UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                                                  RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
Set the activation group descriptor, desc for the object with the activation group identifier, id. The change will take effect upon subsequent activation of the group.

Parameters:
id - the activation group identifier for the activation group
desc - the activation group descriptor for the activation group
Returns:
the previous value of the activation group descriptor
Throws:
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - the group associated with id is not a registered group
ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - for general failure (e.g., unable to update log)
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2
See Also:
getActivationGroupDesc(java.rmi.activation.ActivationGroupID) sample code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID) definition code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID)

getActivationDesc sample code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID) definition code for java.rmi.activation.ActivationSystem.getActivationDesc(java.rmi.activation.ActivationID)

ActivationDesc sample code for java.rmi.activation.ActivationDesc definition code for java.rmi.activation.ActivationDesc  getActivationDesc(ActivationID sample code for java.rmi.activation.ActivationID definition code for java.rmi.activation.ActivationID  id)
                                 throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                        UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException ,
                                        RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
Returns the activation descriptor, for the object with the activation identifier, id.

Parameters:
id - the activation identifier for the activatable object
Returns:
the activation descriptor
Throws:
UnknownObjectException sample code for java.rmi.activation.UnknownObjectException definition code for java.rmi.activation.UnknownObjectException - if id is not registered
ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - for general failure
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2
See Also:
setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc) sample code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc) definition code for java.rmi.activation.ActivationSystem.setActivationDesc(java.rmi.activation.ActivationID, java.rmi.activation.ActivationDesc)

getActivationGroupDesc sample code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID) definition code for java.rmi.activation.ActivationSystem.getActivationGroupDesc(java.rmi.activation.ActivationGroupID)

ActivationGroupDesc sample code for java.rmi.activation.ActivationGroupDesc definition code for java.rmi.activation.ActivationGroupDesc  getActivationGroupDesc(ActivationGroupID sample code for java.rmi.activation.ActivationGroupID definition code for java.rmi.activation.ActivationGroupID  id)
                                           throws ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException ,
                                                  UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException ,
                                                  RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException 
Returns the activation group descriptor, for the group with the activation group identifier, id.

Parameters:
id - the activation group identifier for the group
Returns:
the activation group descriptor
Throws:
UnknownGroupException sample code for java.rmi.activation.UnknownGroupException definition code for java.rmi.activation.UnknownGroupException - if id is not registered
ActivationException sample code for java.rmi.activation.ActivationException definition code for java.rmi.activation.ActivationException - for general failure
RemoteException sample code for java.rmi.RemoteException definition code for java.rmi.RemoteException - if remote call fails
Since:
1.2
See Also:
setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc) sample code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc) definition code for java.rmi.activation.ActivationSystem.setActivationGroupDesc(java.rmi.activation.ActivationGroupID, java.rmi.activation.ActivationGroupDesc)