com.sonicsw.mf.common.runtime
Interface IIdentity

All Superinterfaces:

java.lang.Comparable

All Known Subinterfaces:

IComponentIdentity, IContainerIdentity

public interface IIdentity
extends java.lang.Comparable

A base interface representing the runtime identity of runtime entities.

See Also:

IContainerIdentity, IComponentIdentity

Method Summary

int	compareTo(java.lang.Object object) Compares this object with the specified object for order.
boolean	equals(java.lang.Object object) Tests if the given object is equal to this identity.
java.lang.String	getCanonicalName() Gets the full composite name of the instance.
com.sonicsw.mf.common.config.IElementIdentity	getConfigIdentity() Gets the configuration identity of the entity (the configuration identity is the location in the Directory Service where this entities configuration is stored).
java.lang.String	getContainerName() Get the container name within the domain.
java.lang.String	getDomainName() Get the domain name to which the instance belongs.

Method Detail

compareTo

int compareTo(java.lang.Object object)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Comparison is made using the toString() value.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException - If the given object is not an instance of the same object.

equals

boolean equals(java.lang.Object object)

Tests if the given object is equal to this identity.

Overrides:

equals in class java.lang.Object

Returns:

Returns true if the canonical name and config identity of this identity equals that of the given object.

getCanonicalName

java.lang.String getCanonicalName()

Gets the full composite name of the instance. The canonical name will vary depending upon the instance implementation, for example:

• a containers cananocial name might be: "Sonic.Container"
• a components cananocial name might be: "Sonic.Container:ID=SonicMQ"

getConfigIdentity

com.sonicsw.mf.common.config.IElementIdentity getConfigIdentity()

Gets the configuration identity of the entity (the configuration identity is the location in the Directory Service where this entities configuration is stored).

getContainerName

java.lang.String getContainerName()

Get the container name within the domain.

getDomainName

java.lang.String getDomainName()

Get the domain name to which the instance belongs.