Home » openjdk-7 » java » rmi » activation » [javadoc | source]
java.rmi.activation
public final class: ActivationDesc [javadoc | source]
java.lang.Object
   java.rmi.activation.ActivationDesc

All Implemented Interfaces:
    java$io$Serializable

An activation descriptor contains the information necessary to activate an object:

A descriptor registered with the activation system can be used to recreate/activate the object specified by the descriptor. The MarshalledObject in the object's descriptor is passed as the second argument to the remote object's constructor for object to use during reinitialization/activation.

Constructor:
 public ActivationDesc(String className,
    String location,
    MarshalledObject<?> data) throws ActivationException 
    Constructs an object descriptor for an object whose class name is className, that can be loaded from the code location and whose initialization information is data. If this form of the constructor is used, the groupID defaults to the current id for ActivationGroup for this VM. All objects with the same ActivationGroupID are activated in the same VM.

    Note that objects specified by a descriptor created with this constructor will only be activated on demand (by default, the restart mode is false). If an activatable object requires restart services, use one of the ActivationDesc constructors that takes a boolean parameter, restart.

    This constructor will throw ActivationException if there is no current activation group for this VM. To create an ActivationGroup use the ActivationGroup.createGroup method.

    Parameters:
    className - the object's fully package qualified class name
    location - the object's code location (from where the class is loaded)
    data - the object's initialization (activation) data contained in marshalled form.
    Throws:
    ActivationException - if the current group is nonexistent
    exception: ActivationException - if the current group is nonexistent
    since: 1.2 -
 public ActivationDesc(String className,
    String location,
    MarshalledObject<?> data,
    boolean restart) throws ActivationException 
    Constructs an object descriptor for an object whose class name is className, that can be loaded from the code location and whose initialization information is data. If this form of the constructor is used, the groupID defaults to the current id for ActivationGroup for this VM. All objects with the same ActivationGroupID are activated in the same VM.

    This constructor will throw ActivationException if there is no current activation group for this VM. To create an ActivationGroup use the ActivationGroup.createGroup method.

    Parameters:
    className - the object's fully package qualified class name
    location - the object's code location (from where the class is loaded)
    data - the object's initialization (activation) data contained in marshalled form.
    restart - if true, the object is restarted (reactivated) when either the activator is restarted or the object's activation group is restarted after an unexpected crash; if false, the object is only activated on demand. Specifying restart to be true does not force an initial immediate activation of a newly registered object; initial activation is lazy.
    Throws:
    ActivationException - if the current group is nonexistent
    exception: ActivationException - if the current group is nonexistent
    since: 1.2 -
 public ActivationDesc(ActivationGroupID groupID,
    String className,
    String location,
    MarshalledObject<?> data) 
    Constructs an object descriptor for an object whose class name is className that can be loaded from the code location and whose initialization information is data. All objects with the same groupID are activated in the same Java VM.

    Note that objects specified by a descriptor created with this constructor will only be activated on demand (by default, the restart mode is false). If an activatable object requires restart services, use one of the ActivationDesc constructors that takes a boolean parameter, restart.

    Parameters:
    groupID - the group's identifier (obtained from registering ActivationSystem.registerGroup method). The group indicates the VM in which the object should be activated.
    className - the object's fully package-qualified class name
    location - the object's code location (from where the class is loaded)
    data - the object's initialization (activation) data contained in marshalled form.
    Throws:
    IllegalArgumentException - if groupID is null
    exception: IllegalArgumentException - if groupID is null
    since: 1.2 -
 public ActivationDesc(ActivationGroupID groupID,
    String className,
    String location,
    MarshalledObject<?> data,
    boolean restart) 
    Constructs an object descriptor for an object whose class name is className that can be loaded from the code location and whose initialization information is data. All objects with the same groupID are activated in the same Java VM.
    Parameters:
    groupID - the group's identifier (obtained from registering ActivationSystem.registerGroup method). The group indicates the VM in which the object should be activated.
    className - the object's fully package-qualified class name
    location - the object's code location (from where the class is loaded)
    data - the object's initialization (activation) data contained in marshalled form.
    restart - if true, the object is restarted (reactivated) when either the activator is restarted or the object's activation group is restarted after an unexpected crash; if false, the object is only activated on demand. Specifying restart to be true does not force an initial immediate activation of a newly registered object; initial activation is lazy.
    Throws:
    IllegalArgumentException - if groupID is null
    exception: IllegalArgumentException - if groupID is null
    since: 1.2 -
Method from java.rmi.activation.ActivationDesc Summary:
equals,   getClassName,   getData,   getGroupID,   getLocation,   getRestartMode,   hashCode
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.rmi.activation.ActivationDesc Detail:
 public boolean equals(Object obj) 
    Compares two activation descriptors for content equality.
 public String getClassName() 
    Returns the class name for the object specified by this descriptor.
 public MarshalledObject<?> getData() 
    Returns a "marshalled object" containing intialization/activation data for the object specified by this descriptor.
 public ActivationGroupID getGroupID() 
    Returns the group identifier for the object specified by this descriptor. A group provides a way to aggregate objects into a single Java virtual machine. RMI creates/activates objects with the same groupID in the same virtual machine.
 public String getLocation() 
    Returns the code location for the object specified by this descriptor.
 public boolean getRestartMode() 
    Returns the "restart" mode of the object associated with this activation descriptor.
 public int hashCode() 
    Return the same hashCode for similar ActivationDescs.