javax.slee.management

Class DeployableUnitDescriptor

java.lang.Object

javax.slee.management.DeployableUnitDescriptor

All Implemented Interfaces:

Serializable, VendorExtensions

public class DeployableUnitDescriptor
extends Object
implements VendorExtensions, Serializable

This class provides access to deployment-specific attributes that describe an installed deployable unit.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeployableUnitDescriptor(DeployableUnitID id, Date deploymentDate, ComponentID[] components)

Method Summary

Methods

Modifier and Type	Method and Description
static void	disableVendorDataDeserialization() Disable the deserialization of vendor-specific data for objects of this class.
static void	disableVendorDataSerialization() Disable the serialization of vendor-specific data for objects of this class.
static void	enableVendorDataDeserialization() Enable the deserialization of vendor-specific data for objects of this class.
static void	enableVendorDataSerialization() Enable the serialization of vendor-specific data for objects of this class.
boolean	equals(Object obj) Compare this deployable unit identifier for equality with another object.
ComponentID[]	getComponents() Get the component identifiers of the components installed with this deployable unit.
Date	getDeploymentDate() Get the date that the deployable unit was installed.
DeployableUnitID	getID() Get the deployable unit identifier for this descriptor.
String	getURL() Get the URL that the deployable unit was installed from.
Object	getVendorData() Get the vendor-specific data.
int	hashCode() Get a hash code value for this deployable unit descriptor.
void	setVendorData(Object vendorData) Set the vendor-specific data.
String	toString() Get a string representation for this deployable unit descriptor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeployableUnitDescriptor

public DeployableUnitDescriptor(DeployableUnitID id,
                        Date deploymentDate,
                        ComponentID[] components)

Method Detail

getID

public DeployableUnitID getID()

Get the deployable unit identifier for this descriptor.

Returns:

the deployable unit identifier for this descriptor.

getURL

public String getURL()

Get the URL that the deployable unit was installed from.

Returns:

the URL that the deployable unit was installed from.

getDeploymentDate

public Date getDeploymentDate()

Get the date that the deployable unit was installed.

Returns:

the date that the deployable unit was installed.

getComponents

public ComponentID[] getComponents()

Get the component identifiers of the components installed with this deployable unit.

Returns:

the component identifiers of the components installed with this deployable unit.

enableVendorDataSerialization

public static void enableVendorDataSerialization()

Enable the serialization of vendor-specific data for objects of this class. This method is typically used by a SLEE implementation that wants to export vendor-specific data with objects of this class to management clients.

By default, any vendor-specific data included in an object of this class will not be included in the serialization stream when the object is serialized. Invoking this method changes this behavior so that vendor-specific data is included in the serialization stream when an object of this class is serialized.

This method should only be invoked if the vendor-specific data is serializable via standard Java serialization means.

Since:

SLEE 1.1

See Also:

disableVendorDataSerialization(), setVendorData(java.lang.Object)

disableVendorDataSerialization

public static void disableVendorDataSerialization()

Disable the serialization of vendor-specific data for objects of this class.

If the serialization of vendor-specific data for objects of this class has been enabled via the enableVendorDataSerialization() method, this method disables that behavior again.

Since:

SLEE 1.1

enableVendorDataDeserialization

public static void enableVendorDataDeserialization()

Enable the deserialization of vendor-specific data for objects of this class. This method is typically used by a management client that wants to obtain any vendor-specific data included in the serialization stream of objects of this class.

By default, any vendor-specific data included in the serialization stream of objects of this class is discarded upon deserialization. Invoking this method changes that behavior so that the vendor-specific data is also deserialized when an object of this class is deserialized. A management client that enables the deserialization of vendor-specific data must ensure that any necessary classes required to deserialize that data is available in the relevant classloader.

Since:

SLEE 1.1

See Also:

disableVendorDataDeserialization(), getVendorData()

disableVendorDataDeserialization

public static void disableVendorDataDeserialization()

Disable the deserialization of vendor-specific data for objects of this class.

If the deserialization of vendor-specific data for objects of this class has been enabled via the enableVendorDataDeserialization() method, this method disables that behavior again.

Since:

SLEE 1.1

setVendorData

public void setVendorData(Object vendorData)

Set the vendor-specific data.

Specified by:

setVendorData in interface VendorExtensions

Parameters:

vendorData - the vendor-specific data.

Since:

SLEE 1.1

getVendorData

public Object getVendorData()

Get the vendor-specific data.

Specified by:

getVendorData in interface VendorExtensions

Returns:

the vendor-specific data.

Since:

SLEE 1.1

equals

public boolean equals(Object obj)

Compare this deployable unit identifier for equality with another object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this with.

Returns:

true if obj is a deployable unit descriptor containing the same deployable unit identifier as this, false otherwise.

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Get a hash code value for this deployable unit descriptor.

Overrides:

hashCode in class Object

Returns:

a hash code value for this descriptor.

See Also:

Object.hashCode()

toString

public String toString()

Get a string representation for this deployable unit descriptor.

Overrides:

toString in class Object

Returns:

a string representation for this descriptor.

See Also:

Object.toString()