Solstice Enterprise Manager 4.1 Java API Reference Doc Set ContentsPreviousIndex


Chapter 4

Java Topology API

This chapter descibes the classes that make up the Java Topology Application Programming Interface.

This chapter comprises the following topics:

4.1 Overview

For information on how to use the Java Topology API, refer to the Developing Java Applications book.

4.2 EMAgent Class

public abstract class EMAgent

extends EMObject

4.2.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMAgent

4.2.2 Constructors

EMAgent

public EMAgent()

4.2.3 Methods

getOperationalState

public abstract EMAgentOperationalState 
getOperationalState()

Returns the EMAgentAttribute.OPERATIONAL_STATE attribute.

See Also: OPERATIONAL_STATE

getAdministrativeState

Returns the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public abstract EMAgentAdministrativeState
getAdministrativeState()

See Also: ADMINISTRATIVE_STATE

setAdministrativeState

Sets the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public abstract void setAdministrativeState
(EMAgentAdministrativeState administrativeState)

administrativeState is the administrative state.

See Also: ADMINISTRATIVE_STATE

4.3 EMAgentAdministrativeState Class

public class EMAgentAdministrativeState

extends Object implements Serializable

The com.sun.em.api.topology.EMAgentAdministrativeState class represents the possible administrative states of a proxy agent. It is the same as the administrativeState attribute defined in [ISO10165-2].

4.3.1 Variables

LOCKED

The LOCKED state means that the proxy must not perform, or suspend performing, proxy activities on behalf of the Internet agent.

public static final EMAgentAdministrativeState LOCKED

UNLOCKED

The UNLOCKED state means that proxy must continue to perform, or resume performing, proxy activities on behalf of the Internet agent.

public static final EMAgentAdministrativeState UNLOCKED

SHUTTING_DOWN

public static final EMAgentAdministrativeState SHUTTING_DOWN

4.3.2 Methods

equals

Compares this EMAgentAdministrativeState against the specified object.
The result is true if, and only if, the argument is not null and is a EMAgentAdministrativeState object with the same value as this EMAgentAdministrativeState.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object

toString

Returns a string representation of the EMAgentAdministrativeState

public String toString()

Returns the string representation.

Overrides toString in class Object

4.4 EMAgentAttribute Class

public class EMAgentAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMAgentAttribute class represents a single attribute of the EMAgent persistent object class (POC).

4.4.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMAgentAttribute

4.4.2 Variables

OPERATIONAL_STATE

The OPERATIONAL_STATE attribute indicates the perceived state of the agent. It is the same as the operationalState attribute defined in ISO10165-2.

 public static final EMAgentAttribute OPERATIONAL_STATE

ADMINISTRATIVE_STATE

The ADMINISTRATIVE_STATE attribute is used to suspend and resume the proxy activity relative to the agent. It is the same as the administrativeState attribute defined in ISO10165-2.

public static final EMAgentAttribute 
ADMINISTRATIVE_STATE

4.4.3 Methods

toString

Returns a String representation of the EMAgentAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute.

4.5 EMAgentOperationalState Class

public class EMAgentOperationalState

extends Object implements Serializable

The com.sun.em.api.topology.EMAgentOperationalStat e class represents the possible operational states of a proxy agent. It is the same as the operationalState attribute defined in ISO10165-2.

4.5.1 Variables

DISABLED

The DISABLED state means that the agent is not operational, as perceived by the proxy, that is, it cannot be reached.

public static final EMAgentOperationalState DISABLED

ENABLED

The ENABLED state means that the Internet agent is operational as perceived by the proxy, that is, it can be reached.

public static final EMAgentOperationalState ENABLED

4.5.2 Methods

equals

Compares this EMAgentOperationalState against the specified object. The result is true if and only if the argument is not null and is a EMAgentOperationalState object, with the same value as this EMAgentOperationalState.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

toString

Returns a String representation of the EMAgentOperationalState.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.6 EMAttributeDecodeException Class

public class EMAttributeDecodeException

extends RuntimeException

The com.sun.em.api.topology.EMAttributeDecodeExcep tion class is the exception returned when an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

4.6.1 Inheritance

 
java.lang.Object
   |
   +--java.lang.Throwable
           |
           +--java.lang.Exception
                   |
                   +--java.lang.RuntimeException
                           |
                           
+-com.sun.em.api.topology.EMAttributeDecodeException

4.6.2 Constructors

EMAttributeDecodeException

Constructs a new EMAttributeDecodeException with the specified detail message.

public EMAttributeDecodeException(String message)

message is the detail message.

EMAttributeDecodeException

Constructs a new EMAttributeDecodeException with no detail message.

public EMAttributeDecodeException()

4.7 EMAttributeEncodeException Class

public class EMAttributeEncodeException

extends RuntimeException

The com.sun.em.api.topology.EMAttributeEncodeExcep tion class is used for exceptions returned when an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

4.7.1 Inheritance

 
java.lang.Object
   |
   +--java.lang.Throwable
           |
           +--java.lang.Exception
                   |
                   +--java.lang.RuntimeException
                           |
                           
+-com.sun.em.api.topology.EMAttributeEncodeException

4.7.2 Constructs

EMAttributeEncodeException

Constructs a new EMAttributeEncodeException with the specified detail message.

public EMAttributeEncodeException(String message)

message is the detail message.

EMAttributeEncodeException

Constructs a new EMAttributeEncodeException with no detail message.

public EMAttributeEncodeException

4.8 EMAttributeNotCreatableException Class

public class EMAttributeNotCreatableException

extends RuntimeException

The com.sun.em.api.topology.EMAttributeNotCreatabl eException class is thrown if the method createWithSomeAttributes() of a persistent object class (POC) attempts to set the initial value of an attribute, which is not allowed to be set at creation time. This exception is a RuntimeException since it is caused by a programming error.

4.8.1 Inheritance

java.lang.Object
   |
   +--java.lang.Throwable
           |
           +--java.lang.Exception
                   |
                   +--java.lang.RuntimeException
	 	 	 	 	 	 	 
	 	 |
                           
+-com.sun.em.api.topology.EMAttributeNotCreatableException

4.8.2 Constructs

EMAttributeNotCreatableException

Constructs a new EMAttributeNotCreatableException with the specified detail message.

 public EMAttributeNotCreatableException(String message)

message is the detail message.

EMAttributeNotCreatableException

Constructs a new EMAttributeNotCreatableException with no detail message.

public EMAttributeNotCreatableException()

4.9 EMAttributeNotSetException Class

public class EMAttributeNotSetException

extends RuntimeException

The com.sun.em.api.topology.EMAttributeNotSetExcep tion class is used for exceptions returned when an attribute of a persistent object class (POC) instance is being accessed but has not been set yet in the cache, or when create or store is invoked without certain mandatory attribute(s) being set.

4.9.1 Inheritance

 
java.lang.Object
   |
   +--java.lang.Throwable
           |
           +--java.lang.Exception
                   |
                   +--java.lang.RuntimeException
                           |
                           
+-com.sun.em.api.topology.EMAttributeNotSetException

4.9.2 Constructs

EMAttributeNotSetException

Constructs a new EMAttributeNotSetException with the specified detail message.

 public EMAttributeNotSetException(String message)

message is the detail message.

EMAttributeNotSetException

Constructs a new EMAttributeNotSetException with no detail message.

 public EMAttributeNotSetException()

4.10 EMAttributeNotStoreableException Class

public class EMAttributeNotStoreableException

extends RuntimeException

The com.sun.em.api.topology.EMAttributeNotStoreabl eException class is thrown if the method storeWithSomeAttributes(), of a Persistent Object Class (POC), attempts to store a read-only attribute. This exception is a RuntimeException since it is caused by a programming error.

4.10.1 Inheritance

java.lang.Object
   |
   +--java.lang.Throwable
           |
           +--java.lang.Exception
                   |
                   +--java.lang.RuntimeException
                           |
                           
+-com.sun.em.api.topology.EMAttributeNotStoreableException

4.10.2 Constructs

EMAttributeNotStoreableException

Constructs a new EMAttributeNotStoreableException with the specified detail message.

 public EMAttributeNotStoreableException(String message)

message is the detail message.

EMAttributeNotStoreableException

Constructs a new EMAttributeNotStoreableException with no detail message.

 public EMAttributeNotStoreableException()

4.11 EMCmipAgent Class

public class EMCmipAgent

extends EMObject implements Cloneable

An instance of the com.sun.em.api.topology.EMCmipAgent class represents the MIS object which contains configuration information for a CMIP agent. The configuration information includes the CMIP MPA hostname and port number, a list of managed objects DNs, a network SAP, a transport selector, a presentation selector, a session selector, and an application entity title (AET).


Note – This class does not provide an interface to the agent's managed objects, but only to Solstice EM's configuration information for the agent.

4.11.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMCmipAgent

4.11.2 Constructors

EMCmipAgent

Constructs an instance of EMCmipAgent representing a particular CMIPagent configuration object.

public EMCmipAgent(EMTopoPlatform platform, 
EMCmipAgentDn dn)

platform is the Topology API platform.

dn is the unique identifier of the CMIPagent configuration object.

4.11.3 Methods

getCmipAgentFromManagedObject

Returns the unique identifier of the CMIP agent configuration object whose management domain includes the specified managed object.

public static EMCmipAgentDn 
getCmipAgentFromManagedObject
(EMTopoPlatform platform,String managedObjectDnSlashForm)
throws EMTopoServiceException

platform is the Topology API platform.

managedObjectDnSlashForm is the fully distinguished name (fdn) of the managed object.

Returns the CMIP agent configuration object unique identifier; null if the managed object is not managed by a CMIP agent.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMCmipAgent.DN attribute which associates the EMCmipAgent instance with a particular CMIP agent object in the MIS. This method is useful when you want to reuse the EMCmipAgent instance to access a different CMIP agent object and don't want the previous values to remain in effect.

 public void clearAllAttributes()

Overrides clearAllAttributes in class EMObject.

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMCmipAgent.DN attribute which associates the EMCmipAgent instance with a particular CMIP agent object in the MIS. This method is useful when you want to reuse a EMCmipAgent instance to access a different proxy agent object and do not want the previous values to remain in effect.

public void clearSomeAttributes(EMAttributeSet attributes)

attributes is the object attributes to have their cached values cleared.

Overrides clearSomeAttributes in class EMObject.

clone

Return a clone of this EMCmipAgent object.

public Object clone()

Returns a clone of this EMCmipAgent.

Overrides clone in class Object.

createWithAllAttributes

Creates a new CMIP agent object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set:

EMTopoAttribute.DN

EMAgentAttribute.ADMINISTRATIVE_STATE

EMCmipAgentAttribute.MPA_ADDRESS_INFO

EMCmipAgentAttribute.AGENT_ADDRESS_INFO

EMCmipAgentAttribute.MANAGED_OBJECTS

EMCmipAgentAttribute.APPLICATION_ENTITY_TITLE

EMCmipAgentAttribute.PRESENTATION_SELECTOR

EMCmipAgentAttribute.SESSION_SELECTOR

EMCmipAgentAttribute.TRANSPORT_SELECTOR

EMCmipAgentAttribute.NETWORK_SAP

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMAgentAttribute.OPERATIONAL_STATE

These attributes are ignored even if they have cached values.

public void createWithAllAttributes()
throws EMTopoServiceException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the any of the mandatory attributes are not set.

Overrides createWithAllAttributes in class EMObject.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and then only if the attribute is active (that is, it has been given a value). All other attributes will be given a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set and must be members of the EMAttributeSet attributes:

EMTopoAttribute.DN

EMAgentAttribute.ADMINISTRATIVE_STATE

EMCmipAgentAttribute.MPA_ADDRESS_INFO

EMCmipAgentAttribute.AGENT_ADDRESS_INFO

EMCmipAgentAttribute.MANAGED_OBJECTS

EMCmipAgentAttribute.APPLICATION_ENTITY_TITLE

EMCmipAgentAttribute.PRESENTATION_SELECTOR

EMCmipAgentAttribute.SESSION_SELECTOR

EMCmipAgentAttribute.TRANSPORT_SELECTOR

EMCmipAgentAttribute.NETWORK_SAP

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMAgentAttribute.OPERATIONAL_STATE

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotCreatableException will be thrown.

public void createWithSomeAttributes(EMAttributeSet 
attributes
throws EMTopoServiceException

attributes is subset of the EMCmipAgent's attributes to store in the new object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if any of the mandatory attributes are not set.

EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

Overrides createWithAllAttributes in class EMObject.

destroy

Deletes the object identified by EMCmipAgent.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public void destroy() throws EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMCmipAgent.DN does not exist.

Overrides destroy in class EMObject.

differences

Compares this EMCmipAgent against the specified EMCmipAgent and returns either the set of attributes for which the EMCmipAgent objects have different values or null if the EMCmipAgent objects are equal. If the argument obj is null or not an instance of EMCmipAgent, then all active attributes of this EMCmipAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMCmipAgent but not the other, or if the attribute is active for both EMCmipAgent objects but the values of the attribute are not equal.

 public EMAttributeSet differences(EMObject obj)

obj is the object to compare against.

Returns the set of attributes for which the EMCmipAgent objects have different values or null if the EMCmipAgent objects are equal.

Overrides differences in class EMObject.

differencesSubset

Compares this EMCmipAgent only for those attributes specified by the second input parameter, and returns the set of attributes for which the EMCmipAgents have different values or null if the EMCmipAgents are equal. If the argument obj is null or not an instance of EMCmipAgent, then all active attributes of this EMCmipAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMCmipAgent but not the other, or if the attribute is active for both EMCmipAgents but the values of the attribute are not equal.

public EMAttributeSet differencesSubset
(EMObject obj,EMAttributeSet attributes)

obj is the object to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the EMCmipAgent objects have different values or null if the EMCmipAgent objects are equal.

Overrides differencesSubset in class EMObject.

equals

Compares this EMCmipAgent against the specified object. If the argument obj is null or not an instance of EMCmipAgent, then the two objects are not equal. Otherwise, if the two EMCmipAgent objects have the same set of active attributes, and the same value for each active attribute, then the EMCmipAgent objects are equal.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

equalsSubset

Compares this EMCmipAgent against the specified object only for those attributes specified by the second parameter, restricting the equality check to the specified attributes. If the argument obj is null or not an instance of EMCmipAgent, then the two objects are not equal. Otherwise, if the two EMCmipAgents have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the EMCmipAgents are equal

public boolean equalsSubset(EMObject obj,EMAttributeSet 
attributes)

.

obj is the object to compare against.

attributes is the subset of attributes.

Returns true if the objects are equal, otherwise returns false.

Overrides equalsSubset in class EMObject.

exists

Checks to see if the object identified by EMCmipAgent.DN exists.

public boolean exists() throws EMTopoServiceException

Returns true if the object exists.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides exists in class EMObject.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public EMAttributeSet getActiveAttributes()

Returns the set of active attributes.

Overrides getActiveAttributes in class EMObject.

loadAllAttributes

Loads all attributes of the object identified by EMCmipAgent.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadAllAttributes()throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMCmipAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadAllAttributes in class EMObject.

loadSomeAttributes

Loads the specified attributes of the object identified by EMCmipAgent.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate get methods.

public void loadSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMCmipAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadSomeAttributes in class EMObject.

newInstance

Returns a new instance of the EMCmipAgent class without any attributes set.

public EMObject newInstance()

Returns the new object.

Overrides newInstance in class EMObject.

storeAllAttributes

Stores all attributes into the object identified by EMCmipAgent.DN. For attributes which have not been given a value by calling load or setter methods, a default value, (usually null or empty string or 0) will be stored.

The EMAgentAttribute.OPERATIONAL_STATE attribute is read-only and therefore cannot be stored in the MIS. This attribute is ignored even if they have cached values.

public void storeAllAttributes() throws 
EMTopoServiceException,EMUnknownObjectException 

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMCmipAgent.DN does not exist.

EMAttributeEncodeException if an error ocurred in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeAllAttributes in class EMObject.

storeSomeAttributes

Stores the specified attributes into the object identified by EMCmipAgent.DN. For attributes which have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored.

The EMAgentAttribute.OPERATIONAL_STATE attribute is read-only and therefore cannot be stored in the MIS. If this attribute is a member of the EMAttributeSet attributes, then an EMAttributeNotStoreableException will be thrown.

public void storeSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to store in the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMCmipAgent.DN does not exist.

EMAttributeNotStoreableException if attributes contains any attributes which cannot be set at creation time.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeSomeAttributes in class EMObject.

getAdministrativeState

Returns the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public EMAgentAdministrativeState 
getAdministrativeState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ADMINISTRATIVE_STATE

getAgentAddressInfo

Returns the EMCmipAgentAttribute.AGENT_ADDRESS_INFO attribute.

public String getAgentAddressInfo()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: AGENT_ADDRESS_INFO

getAgentAddressTag

Returns the EMCmipAgentAttribute.AGENT_ADDRESS_TAG attribute.

public Integer getAgentAddressTag()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: AGENT_ADDRESS_TAG

getApplicationEntityTitle

Returns the EMCmipAgentAttribute.APPLICATION_ENTITY_TITLE< /font> attribute.

public String getApplicationEntityTitle()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: APPLICATION_ENTITY_TITLE

getDn

Returns the EMTopoAttribute.DN attribute.

public EMObjectDn getDn()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getDn in class EMObject.

See Also: DN

getMpaAddressInfo

Returns the EMCmipAgentAttribute.MPA_ADDRESS_INFO attribute.

public EMCmipAgentMpaAddressInfo getMpaAddressInfo()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MPA_ADDRESS_INFO

getManagedObjects

Returns the EMCmipAgentAttribute.MANAGED_OBJECTS attribute.

public String[] getManagedObjects()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MANAGED_OBJECTS

getNetworkSAP

Returns the EMCmipAgentAttribute.NETWORK_SAP attribute.

public String getNetworkSAP()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: NETWORK_SAP

getOperationalState

Returns the EMAgentAttribute.OPERATIONAL_STATE attribute.

public EMAgentOperationalState getOperationalState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: OPERATIONAL_STATE

getPresentationSelector

Returns the EMCmipAgentAttribute.PRESENTATION_SELECTOR attribute.

public String getPresentationSelector()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: PRESENTATION_SELECTOR

getSessionSelector

Returns the EMCmipAgentAttribute.SESSION_SELECTOR attribute.

public String getSessionSelector()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SESSION_SELECTOR

getTransportSelector

Returns the EMCmipAgentAttribute.TRANSPORT_SELECTOR attribute.

public String getTransportSelector()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: TRANSPORT_SELECTOR

setAdministrativeState

Sets the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public void setAdministrativeState
(EMAgentAdministrativeState administrativeState)

administrativeState is the attribute value.

Throws NullPointerException if administrativeState is null.

See Also: ADMINISTRATIVE_STATE

setAgentAddressInfo

Sets the EMCmipAgentAttribute.AGENT_ADDRESS_INFO attribute.

public void setAgentAddressInfo(String agentAddressInfo)

agentAddressInfo is the attribute value.

Throws NullPointerException if agentAddressInfo is null.

See Also: AGENT_ADDRESS_INFO

setAgentAddressTag

Sets the EMCmipAgentAttribute.AGENT_ADDRESS_TAG attribute.

public void setAgentAddressTag(Integer agentAddressTag)

agentAddressTag is the attribute value.

Throws NullPointerException if agentAddressTag is null.

See Also: AGENT_ADDRESS_TAG

setApplicationEntityTitle

Sets the EMCmipAgentAttribute.APPLICATION_ENTITY_TITLE< /font> attribute.

public void setApplicationEntityTitle(String applicationEntityTitle
)

applicationEntityTitle is the attribute value.

Throws NullPointerException if applicationEntityTitle is null.

See Also: APPLICATION_ENTITY_TITLE

setDn

Sets the EMTopoAttribute.DN attribute.

public void setDn(EMObjectDn dn)

dn is the attribute value.

Throws:

NullPointerException if dn is null.

ClassCastException if dn is not an instance of EMCmipAgentDn.

Overrides setDn in class EMObject.

See Also: DN

setMpaAddressInfo

Sets the EMCmipAgentAttribute.MPA_ADDRESS_I NFO attribute.

public void setMpaAddressInfo
(EMCmipAgentMpaAddressInfo mpaAddressInfo)

mpaAddressInfo is the attribute value.

Throws NullPointerException if mpaAddressInfo is null.

See Also: MPA_ADDRESS_INFO

setManagedObjects

Sets the EMCmipAgentAttribute.MANAGED_OBJEC TS attribute.

public void setManagedObjects(String managedObjects[])

managedObjects is the attribute value.

Throws NullPointerException if managedObjects is null.

See Also: MANAGED_OBJECTS

addManagedObject

Adds the specified managedObject to the EMCmipAgentAttribute.MANAGED_OBJECTS attribute.

public void addManagedObject(String managedObject)

managedObject is the attribute value.

See Also: MANAGED_OBJECTS

removeManagedObject

Removes the specified managedObject from the EMCmipAgentAttribute.MANAGED_OBJECTS attribute.

public void removeManagedObject(String managedObject)

managedObject is the attribute value.

See Also: MANAGED_OBJECTS

setNetworkSAP

Sets the EMCmipAgentAttribute.NETWORK_SAP attribute.

public void setNetworkSAP(String networkSAP)

networkSAP is the attribute value.

Throws NullPointerException if networkSAP is null.

See Also: NETWORK_SAP

setPresentationSelector

Sets the EMCmipAgentAttribute.PRESENTATION_SELECTOR attribute.

public void setPresentationSelector(String presentationSelector)

presentationSelector is the attribute value.

Throws NullPointerException if presentationSelector is null.

See Also: PRESENTATION_SELECTOR

setSessionSelector

Sets the EMCmipAgentAttribute.SESSION_SELECTOR attribute.

public void setSessionSelector(String sessionSelector)

sessionSelector is the attribute value.

Throws NullPointerException if sessionSelector is null.

See Also: SESSION_SELECTOR

setTransportSelector

Sets the EMCmipAgentAttribute.TRANSPORT_SELECTOR attribute.

public void setTransportSelector(String transportSelector)

transportSelector is the attribute value.

Throws NullPointerException if transportSelector is null.

See Also: TRANSPORT_SELECTOR

toString

Returns a String representation of the EMCmipAgent.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.12 EMCmipAgentAttribute Class

public class EMCmipAgentAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMCmipAgentAttribute class represents a single attribute of the EMCmipAgent persistent object class POC.

4.12.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMCmipAgentAttribute

4.12.2 Variables

MPA_ADDRESS_INFO_ID

public static final int MPA_ADDRESS_INFO_ID

MPA_ADDRESS_INFO

This variable is the MPA hostname and port number.

public static final EMCmipAgentAttribute 
MPA_ADDRESS_INFO

AGENT_ADDRESS_INFO_ID

public static final int AGENT_ADDRESS_INFO_ID

AGENT_ADDRESS_INFO

This variable is the agent address information in the format defined by AGENT_ADDRESS_TAG.

public static final EMCmipAgentAttribute 
AGENT_ADDRESS_INFO

AGENT_ADDRESS_TAG_ID

public static final int AGENT_ADDRESS_TAG_ID

AGENT_ADDRESS_TAG

This variable defines format of AGENT_ADDRESS_INFO.

public static final EMCmipAgentAttribute 
AGENT_ADDRESS_TAG

MANAGED_OBJECTS_ID

public static final int MANAGED_OBJECTS_ID

MANAGED_OBJECTS

This variable is the list of DNs in slash format of managed objects located on agent. Note that the multiple CMIP agent configurations can be created for the same CMIP MPA but with a different set of managed objects for each configuration.

public static final EMCmipAgentAttribute MANAGED_OBJECTS

APPLICATION_ENTITY_TITLE_ID

public static final int APPLICATION_ENTITY_TITLE_ID

APPLICATION_ENTITY_TITLE

This variable is the Application Entity Title (AET).

public static final EMCmipAgentAttribute
APPLICATION_ENTITY_TITLE

PRESENTATION_SELECTOR_ID

public static final int PRESENTATION_SELECTOR_ID

PRESENTATION_SELECTOR

This variable is the OSI presentation selector.

public static final EMCmipAgentAttribute 
PRESENTATION_SELECTOR

SESSION_SELECTOR_ID

public static final int SESSION_SELECTOR_ID

SESSION_SELECTOR

This variable is the OSI session selector.

public static final EMCmipAgentAttribute 
SESSION_SELECTOR

TRANSPORT_SELECTOR_ID

public static final int TRANSPORT_SELECTOR_ID

TRANSPORT_SELECTOR

This variable is the OSI transport selector.

public static final EMCmipAgentAttribute 
TRANSPORT_SELECTOR

NETWORK_SAP_ID

public static final int NETWORK_SAP_ID

NETWORK_SAP

This variable is the OSI network SAP.

public static final EMCmipAgentAttribute NETWORK_SAP

4.12.3 Methods

toString

Returns a String representation of the EMCmipAgentAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute.

4.13 EMCmipAgentAttributeSet Class

public class EMCmipAgentAttributeSet

extends EMAttributeSet implements Cloneable, Serializable

The com.sun.em.api.topology.EMCmipAgentAttributeSe t class implements an abstract class which forms the basis for the attributes set classes of each EMCmipAgent. EMCmipAgentAttributeSet is used in the Topology API to communicate which attributes of a EMCmipAgent an API method should operate on.

4.13.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMAttributeSet
           |
           
+----com.sun.em.api.topology.EMCmipAgentAttributeSet

4.13.2 Constructors

EMCmipAgentAttributeSet

Creates an EMCmipAgentAttributeSet which contains no attributes.

public EMCmipAgentAttributeSet()

4.13.3 Methods

clone

Returns a clone of this EMCmipAgentAttributeSet object.

public Object clone()

Returns a clone of this EMCmipAgentAttributeSet.

Overrides clone in class EMAttributeSet.

elements

Returns an enumeration of the attributes in this set.

public Enumeration elements()

Returns an enumeration of the attributes in this set.

Overrides elements in class EMAttributeSet.

4.14 EMCmipAgentDn Class

public final class EMCmipAgentDn

extends EMObjectDn and implements Serializable, Comparable.

An instance of the com.sun.em.api.topology.EMCmipAgentDn class uniquely identifies a CMIP agent.

4.14.1 Inheritance

java.lang.Object
   |
   +----com.sun.em.api.topology.EMObjectDn
           |
           +----com.sun.em.api.topology.EMCmipAgentDn

4.14.2 Constructors

EMCmipAgentDn

Creates an EMCmipAgentDn with the specified system name and agent name.

public EMCmipAgentDn(String systemName, String 
uniqueName)

systemName is the name of the MIS where the CMIP agent is stored.

uniqueName is the unique name of the CMIP agent within the MIS.

4.14.3 Methods

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMCmipAgentDn object which identifies the same CMIP agent as this object.

public boolean equals(Object 
obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object

compareTo

Compares this EMCmipAgentDn with another object that implements Comparable interface. Order is determined by first lexicographically comparing the system name, and then the unique name if necessary.

public int compareTo(Comparable comparable)

Returns: 0 if the objects are identical. Less than 0 if this object is 'less than' the specified object. Greater than 0 if this object is 'greater than' the specified object.

Throws ClassCastException if the object parameter is not of class EMCmipAgentDn.

getSystemName

Returns the name of the MIS where the CMIP agent is stored.

public String getSystemName()

Returns the MIS name.

Overrides getSystemName in class EMObjectDn.

getUniqueName

Returns the name of the CMIP agent. This name is unique within the MIS.

public String getUniqueName()

Returns the unique name of the CMIP agent.

Overrides getUniqueName in class EMObjectDn.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

4.15 EMCmipAgentMpaAddressInfo Class

public final class EMCmipAgentMpaAddressInfo

extends Object and implements Cloneable, Serializable.

The com.sun.em.api.topology.EMCmipAgentMpaAddressI nfo class is a holder class for the value of EMCmipAgent's MPA_ADDRESS_INFO attribute consisting of MPA hostname and port number. Because this is simply a holder class, the data members are public.

See Also: MPA_ADDRESS_INFO, getMpaAddressInfo, setMpaAddressInfo

4.15.1 Variables

hostname

The hostname where the MPA is located.

public String hostname

port

The port number on the host used by the MPA.

public int port

4.15.2 Constructors

EMCmipAgentMpaAddressInfo

Creates an instance of EMCmipAgentMpaAddressInfo with the specified MPA hostname and port number.

public EMCmipAgentMpaAddressInfo(String hostname,int port)

hostname is the host where the MPA is located.

port is the port number on the host used by the MPA.

4.15.3 Methods

clone

Returns a clone of this EMCmipAgentMpaAddressInfo object.

public Object clone()

Returns a clone of this EMCmipAgentMpaAddressInfo.

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMCmipAgentMpaAddressInfo object that has the same values for hostname and port.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

Overrides hashCode in class Object.

toString

Returns a String representation of the EMCmipAgentMpaAddressInfo.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.16 EMIndividualNodeListener Interface

public interface EMIndividualNodeListener

extends EventListener

The com.sun.em.api.topology.EMIndividualNodeListener is the listener interface for receiving events of a particular topology node.

See Also: EMIndividualNodeEvent, addEMIndividualNodeListener, removeEMIndividualNodeListener.

4.16.1 Methods

theNodeDeleted

Invoked when the topology node is deleted from the MIS.

 public void theNodeDeleted(EMTopoNodeEvent event)

event is the event information.

theNodeChanged

Invoked when one or more attributes of the topology node were changed in the MIS.

public void theNodeChanged(EMTopoNodeEvent event)

event is the event information.

4.17 EMInvalidArgException Class

public class EMInvalidArgException

extends EMTopoException

The com.sun.em.api.topology.EMInvalidArgException is the exception returned when an argument (input parameter) is invalid.

4.17.1 Inheritance

 
java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   
+----com.sun.em.api.topology.EMTopoException
                           |
                           
+----com.sun.em.api.topology.EMInvalidArgException

4.17.2 Constructors

EMInvalidArgException

Constructs a new EMInvalidArgException with the specified detail message.

public EMInvalidArgException(String message)

message is the detail message.

EMInvalidArgException

Constructs a new EMInvalidArgException with no detail message.

public EMInvalidArgException()

4.18 EMObject Class

public abstract class EMObject

extends Object

The com.sun.em.api.topology.EMObject class is an abstract base class that specifies the interface supported by all the persistent object classes (POC): EMTopoNode, EMTopoType, EMCmipAgent, EMRpcAgent, and EMSnmpAgent. Each unit of persistent state is called an attribute and an object is made up of a set of these attributes.

To create a new object in the MIS, first the mandatory attributes required for creation must be set either by loading values from another object or setting the values explicitly using the POC's setter methods. Then, createWithAllAttributes() or createWithSomeAttributes() is called to create the object in the MIS. Note that createWithAllAttributes() only uses attributes that have been given a value. If the create method succeeds, then the POC.DN attribute will be set with the unique identifier of the new object. To destroy an object, first the POC.DN identifier must be set, and then the destroy() method may be called to delete the object from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

In order to get the attribute values of a particular object, first the POC.DN identifier must be set, then either loadAllAttributes() or loadSomeAttributes() should be called. Once the attribute values are loaded, they stay cached within the POC and remain constant even if the values change in the MIS. In order to set the attribute values persistently in the MIS, first the POC.DN attribute must be set, then either storeAllAttributes() or storeSomeAttributes() may be called. Note that storeAllAttributes() only stores those attributes that have been given a value.

4.18.1 Constructors

EMObject

public EMObject()

4.18.2 Methods

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the POC.DN attribute that associates the POC with a particular object in the MIS. This method is useful when you want to reuse a POC instance to access a different object and do not want the previous values to remain in effect.

public abstract void clearAllAttributes()

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the POC.DN attribute which associates the POC with a particular object in the MIS. This method is useful when you want to reuse a POC instance to access a different object and do not want the previous values to remain in effect.

public abstract void clearSomeAttributes(EMAttributeSet 
attributes)

attributes is the object attributes to have their cached values cleared.

createWithAllAttributes

Creates a new object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on the default value defined by the GDMO for the POC. Note that some attributes may be prohibited from being set at creation time; these attributes are ignored regardless of whether they have a cached value. In order for the create to succeed, the mandatory attributes required by the particular POC must be set. Please refer to the POC class documentation for the list of mandatory attributes required for creation.

public abstract void createWithAllAttributes() 
throws EMTopoServiceException

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and then only if the attribute is active, that is, has been given a value. All other attributes will be given a default value defined by the GDMO for the POC. In order for the create to succeed, the mandatory attributes required by the particular POC must be set. Please refer to the POC class documentation for the list of mandatory attributes required for creation.

public abstract void createWithSomeAttributes
(EMAttributeSet attributes)
throws EMTopoServiceException

attributes is subset of the POC's attributes to store in the new object.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

Throws EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

destroy

Deletes the object identified by POC.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public abstract void destroy()throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object POC.DN does not exist.

differences

Compares this POC against the specified POC, and returns the set of attributes for which the POCs have different values or null if the POCs are equal. If the argument obj is null or not an instance of this POC, then all active attributes of this POC are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one POC but not the other, or if the attribute is active for both POCs but the values of the attribute are not equal.

public abstract EMAttributeSet differences(EMObject 
obj)

obj is the POC to compare against.

Returns the set of attributes for which the POCs have different values or null if the POCs are equal.

differencesSubset

Compares this POC against the specified POC only for those attributes specified by the second parameter, and returns the set of attributes for which the POCs have different values or null if the POCs are equal. If the argument obj is null or not an instance of this POC, then all active attributes of this POC are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one POC but not for the other, or if the attribute is active for both POCs but the values of the attribute are not equal.

public abstract EMAttributeSet 
differencesSubset(EMObject obj,EMAttributeSet attributes
)

obj is the POC to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the POCs have different values or null if the POCs are equal.

equalsSubset

Compares this POC against the specified object only for those attributes specified by the second parameter, and returns the set of attributes for which the POCs have different values or null if the POCs are equal. If the argument obj is null or not an instance of POC, then the two objects are not equal. Otherwise, if the two POCs have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the POCs are equal.

public abstract boolean equalsSubset
(EMObject obj,EMAttributeSetattributes
)

obj is the object to compare against.

attributes is the subset of attributes

Returns true if the objects are equal, otherwise returns false.

exists

Checks to see if the object identified by POC.DN exists.

public abstract boolean exists() throws 
EMTopoServiceException

Returns true if the object exists.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public abstract EMAttributeSet getActiveAttributes()

getDn

Gets the unique identifier from the cache.

public abstract EMObjectDn getDn()

Returns the unique identifier.

loadAllAttributes

Loads all attributes of the object identified by POC.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public abstract void loadAllAttributes() 
throws
EMTopoServiceException,EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object POC.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

EMAttributeNotSetException if the POC.DN attribute is not set.

loadSomeAttributes

Loads the specified attributes of the object identified by POC.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public abstract void loadSomeAttributes
(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object POC.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

EMAttributeNotSetException if the POC.DN attribute is not set.

newInstance

Returns a new instance of the POC class without any attributes set.

public abstract EMObject newInstance()

Returns the new object.

setDn

Sets the unique identifier in the cache.

public abstract void setDn(EMObjectDn dn)

dn is the dn.

storeAllAttributes

Stores all attributes into the object identified by POC.DN. For attributes which have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored.

public abstract void storeAllAttributes()
throws EMTopoServiceException, EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object POC.DN does not exist.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

EMAttributeNotSetException if the POC.DN attribute is not set.

storeSomeAttributes

Stores the specified attributes into the object identified by POC.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that some attributes are read-only or can only be set at creation time; these attributes are excluded regardless of whether they have a cached value.

public abstract void storeSomeAttributes(EMAttributeSet 
attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to store in the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object POC.DN does not exist.

EMAttributeNotStoreableException if attributes contains any attributes which cannot be set at creation time.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

EMAttributeNotSetException if the POC.DN attribute is not set.

4.19 EMObjectDn Class

public abstract class EMObjectDn

extends Object

The com.sun.em.api.topology.EMObjectDn class is the abstract base class for unique identifiers of POC objects.

4.19.1 Constructors

EMObjectDn

public EMObjectDn()

4.19.2 Methods

getSystemName

Returns the name of the MIS where the POC's managed object is stored.

public abstract String getSystemName()

Returns the MIS name.

getUniqueName

Returns the name of the POC's managed object. This name is unique within the MIS.

public abstract String getUniqueName()

4.20 EMPlatformConfigEvent Class

public class EMPlatformConfigEvent

extends EventObject

The com.sun.em.api.topology.EMPlatformConfigEvent< /font> class contains information on MIS connection established and removed events.

4.20.1 Inheritance

 
java.lang.Object
   |
   +----java.util.EventObject
           |
           
+----com.sun.em.api.topology.EMPlatformConfigEvent

4.20.2 Variables

MIS_ADDED

MIS connection established.

public static final int MIS_ADDED

MIS_REMOVED

MIS connection removed.

public static final int MIS_REMOVED

4.20.3 Constructors

EMPlatformConfigEvent

Creates an instance of EMPlatformConfigEvent.

public EMPlatformConfigEvent 
(Object source, int eventType,String systemName)

eventType is the type of event.

systemName is the name of the MIS machine.

4.20.4 Methods

getEventType

Returns event type.

public int getEventType()

getSystemName

Returns MIS name.

public String getSystemName()

4.21 EMPlatformConfigListener Interface

public interface EMPlatformConfigListener

extends EventListener

The com.sun.em.api.topology.EMPlatformConfigListen er interface is the listener interface for MIS connection established, removed events.

See Also: EMPlatformConfigEvent

4.21.1 Methods

misAdded

Invoked when MIS connection is established.

public void misAdded(EMPlatformConfigEvent event)

misRemoved

Invoked when MIS connection is removed.

public void misRemoved(EMPlatformConfigEvent event)

4.22 EMRpcAgent Class

public class EMRpcAgent

extends EMAgent implements Cloneable

An instance of the com.sun.em.api.topology.EMRpcAgent class represents the MIS object that contains configuration information for an RPC agent. The configuration information includes the read and write community strings, and supported infos.


Note – This class does not provide an interface to the agent's managed objects, but only to Solstice EM's configuration information for the agent.

4.22.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMAgent
                   |
                   
+----com.sun.em.api.topology.EMRpcAgent

4.22.2 Constructors

EMRpcAgent

Constructs an instance of EMRpcAgent representing a particular RPC agent configuration object.

public EMRpcAgent(EMTopoPlatform platform, EMRpcAgentDn 
dn)

platform is the Topology API platform.

dn is the unique identifier of the RPC agent configuration object.

4.22.3 Methods

getRpcAgentFromManagedObject

Returns the unique identifier of the RPC agent configuration object whose management domain includes the specified managed object.

public static EMRpcAgentDn 
getRpcAgentFromManagedObject(EMTopoPlatform platform,
String managedObjectDnSlashForm)
throws EMTopoServiceException

platform is the Topology API platform.

managedObjectDnSlashForm is the fully distinguished name (fdn) of the managed object

Returns the RPC agent configuration object unique identifier; null if the managed object is not mananaged by a RPC agent.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMRpcAgent.DN attribute that associates the EMRpcAgent instance with a particular RPC agent object in the MIS. This method is useful when you want to reuse the EMRpcAgent instance to access a different RPC agent object and do not want the previous values to remain in effect.

public void clearAllAttributes()

Overrides clearAllAttributes in class EMObject.

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMRpcAgent.DN attribute which associates the EMRpcAgent instance with a particular RPC agent object in the MIS. This method is useful when you want to reuse a EMRpcAgent instance to access a different proxy agent object and do not want the previous values to remain in effect.

public void clearSomeAttributes(EMAttributeSet attributes)

attributes is the object attributes to have their cached values cleared.

Overrides clearSomeAttributes in class EMObject.

clone

Returns a clone of this EMRpcAgent object.

public Object clone()

Returns a clone of this EMRpcAgent.

Overrides clone in class Object.

createWithAllAttributes

Creates a new RPC agent object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set:

EMTopoAttribute.DN

EMRpcAgentAttribute.ADMINISTRATIVE_STATE

EMRpcAgentAttribute.INFOS


Note – EMAgentAttribute.OPERATIONAL_STATE cannot be set at creation time, and therefore is ignored regardless of whether it has a cached value.

public void createWithAllAttributes() 
throws EMTopoServiceException


Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the any of the mandatory attributes are not set.

Overrides createWithAllAttributes in class EMObject.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and then only if the attribute is active, that is,has been given a value. All other attributes will be give a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set and must be members of the EMAttributeSet attributes:

EMTopoAttribute.DN

EMRpcAgentAttribute.ADMINISTRATIVE_STATE

EMRpcAgentAttribute.INFOS

EMAgentAttribute.OPERATIONAL_STATE cannot be set at creation time, and therefore is ignored regardless of whether it has a cached value. If EMAgentAttribute.OPERATIONAL_STATE is a member of the EMAttributeSet attributes, then an EMAttributeNotCreatableException will be thrown.

public void createWithSomeAttributes(EMAttributeSet 
attributes)
throws EMTopoServiceException

attributes is subset of the EMRpcAgent's attributes to store in the new object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the any of the mandatory attributes are not set.

EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

Overrides createWithSomeAttributes in class EMObject.

destroy

Deletes the object identified by EMRpcAgent.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public void destroy()throws EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMRpcAgent.DN does not exist.

Overrides destroy in class EMObject.

differences

Compares this EMRpcAgent against the specified EMRpcAgent, and returns either the set of attributes for which the EMRpcAgents have different values, or null if the EMRpcAgents are equal. If the argument obj is null or not an instance of EMRpcAgent, then all active attributes of this EMRpcAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMRpcAgent but not the other, or if the attribute is active for both EMRpcAgents but the values of the attribute are not equal.

public EMAttributeSet differences(EMObject obj)

obj isthe object to compare against

Returns the set of attributes for which the EMRpcAgents have different values or null if the EMRpcAgents are equal.

Overrides differences in class EMObject.

differencesSubset

Compares this EMRpcAgent against the specified EMRpcAgent, but only for those attributes specified by the second parameter, and returns the set of attributes for which the EMRpcAgents have different values or null if the EMRpcAgents are equal. If the argument obj is null or not an instance of EMRpcAgent, then all active attributes of this EMRpcAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMRpcAgent but not the other, or if the attribute is active for both EMRpcAgents but the values of the attribute are not equal.

public EMAttributeSet 
differencesSubset(EMObject obj,EMAttributeSet attributes)

obj is the object to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the EMRpcAgents have different values or null if the EMRpcAgents are equal.

Overrides differencesSubset in class EMObject.

equals

Compares this EMRpcAgent against the specified object. If the argument obj is null or not an instance of EMRpcAgent, then the two objects are not equal. Otherwise, if the two EMRpcAgents have the same set of active attributes, and the same value for each active attribute, then the EMRpcAgents are equal.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, false otherwise.

Overrides equals in class Object.

equalsSubset

Compares this EMRpcAgent against the specified object, but only for those attributes specified by the second parameter, restricting the equality check to the the specified attributes. If the argument obj is null or not an instanceof EMRpcAgent, then the two objects are not equal. Otherwise, if the two EMRpcAgents have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the EMRpcAgents are equal.

public boolean equalsSubsett
(EMObject obj, EMAttributeSe attributes)

obj is the object to compare against.

attributes is the subset of attributes.

Returns true if the objects are equal, false otherwise.

Overrides equalsSubset in class EMObject.

exists

Checks to see if the object identified by EMRpcAgent.DN exists.

 public boolean exists() throws EMTopoServiceException

Returns true if the object exists.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides exists in class EMObject.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public EMAttributeSet getActiveAttributes()

Returns the set of active attributes.

Overrides getActiveAttributes in class EMObject.

loadAllAttributes

Loads all attributes of the object identified by EMRpcAgent.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadAllAttributes() throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMRpcAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadAllAttributes in class EMObject

loadSomeAttributes

Loads the specified attributes of the object identified by EMRpcAgent.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMRpcAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadSomeAttributes in class EMObject.

newInstance

Returns a new instance of the EMRpcAgent class without any attributes set.

public EMObject newInstance()

Returns the new object.

Overrides newInstance in class EMObject.

storeAllAttributes

Stores all attributes into the object identified by EMRpcAgent.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the EMAgentAttribute.OPERATIONAL_STATE attribute is read-only and therefore cannot be stored in the MIS. This attribute is ignored even if it has cached values.

public void storeAllAttributes() 
throws EMTopoServiceException,EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMRpcAgent.DN does not exist.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

Overrides storeAllAttributes in class EMObject.

storeSomeAttributes

Stores the specified attributes into the object identified by EMRpcAgent.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the EMAgentAttribute.OPERATIONAL_STATE attribute is read-only and therefore cannot be stored in the MIS. If this attributes is a member of the EMAttributeSet attributes, then an EMAttributeNotStoreableException will be thrown.

public void storeSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to store in the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMRpcAgent.DN does not exist.

EMAttributeNotStoreableException if attributes contains any attributes which cannot be set at creation time.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeSomeAttributes in class EMObject.

getAdministrativeState

Returns the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public EMAgentAdministrativeState 
getAdministrativeState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getAdministrativeState in class EMAgent.

See Also: ADMINISTRATIVE_STATE

getDn

Returns the EMTopoAttribute.DN attribute.

public EMObjectDn getDn()

Returns the attribute value.

Throws: EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getDn in class EMObject

See Also: DN

getGetCommunityString

Returns the EMRpcAgentAttribute.GET_COMMUNITY_STRING attribute.

public String getGetCommunityString()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: GET_COMMUNITY_STRING

getOperationalState

Returns the EMAgentAttribute.OPERATIONAL_STATE attribute.

public EMAgentOperationalState getOperationalState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getOperationalState in class EMAgent.

See Also: OPERATIONAL_STATE

getInfos

Returns the EMRpcAgentAttribute.INFOS attribute.

public EMRpcAgentInfo[] getInfos()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: INFOS

getSetCommunityString

Returns the EMRpcAgentAttribute.SET_COMMUNITY_STRING attribute.

public String getSetCommunityString()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SET_COMMUNITY_STRING

setAdministrativeState

Sets the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public void setAdministrativeState
(EMAgentAdministrativeState administrativeState)

administrativeState is the attribute value.

Throws NullPointerException if administrativeState is null.

Overrides setAdministrativeState in class EMAgent.

See Also: ADMINISTRATIVE_STATE

setDn

Sets the EMTopoAttribute.DN attribute.

public void setDn(EMObjectDn dn)

dn is the attribute value.

Throws: NullPointerException if dn is null.

ClassCastException if dn is not an instance of EMRpcAgentDn.

Overrides setDn in class EMObject.

See Also: DN

setGetCommunityString

Sets the EMRpcAgentAttribute.GET_COMMUNITY_STRING attribute.

public void setGetCommunityString(String getCommunityString)

getCommunityString is the attribute value.

Throws NullPointerException if getCommunityString is null.

See Also: GET_COMMUNITY_STRING

setInfos

Sets the EMRpcAgentAttribute.INFOS attribute.

public void setInfos(EMRpcAgentInfo infos[])

infos is the attribute value.

Throws NullPointerException if infos is null.

See Also: INFOS

addInfo

Adds the specified info to the EMRpcAgentAttribute.INFOS attribute.

public void addInfo(EMRpcAgentInfo info) 

info is the attribute value.

See Also: INFOS

removeInfo

Removes the specified supported MIB from the EMRpcAgentAttribute.INFOS attribute.

public void removeInfo(EMRpcAgentInfo info)

info is the attribute value.

See Also: INFOS

setSetCommunityString

Sets the EMRpcAgentAttribute.SET_COMMUNITY_STRING attribute.

public void setSetCommunityString(String setCommunityString)

setCommunityString is the attribute value.

Throws NullPointerException if setCommunityString is null.

See Also: SET_COMMUNITY_STRING

toString

Returns a String representation of the EMRpcAgent.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.23 EMRpcAgentAttribute Class

public class EMRpcAgentAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMRpcAgentAttribute class represents a single attribute of the EMRpcAgent POC.

4.23.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMRpcAgentAttribute

4.23.2 Variables

GET_COMMUNITY_STRING_ID

public static final int GET_COMMUNITY_STRING_ID

GET_COMMUNITY_STRING

Community name for GET requests, that is, "public" or "private".

public static final EMRpcAgentAttribute 
GET_COMMUNITY_STRING

SET_COMMUNITY_STRING_ID

 public static final int SET_COMMUNITY_STRING_ID

SET_COMMUNITY_STRING

Community name for SET requests, that is, "public" or "private".

public static final EMRpcAgentAttribute 
SET_COMMUNITY_STRING

INFOS_ID

public static final int INFOS_ID

INFOS

List of RPC proxy hostname and rpc name pairs, that is, "rpchost", "RPC Proxy -ping".

public static final EMRpcAgentAttribute INFOS

4.23.3 Methods

toString

Returns a String representation of the EMRpcAgentAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute.

4.24 EMRpcAgentAttributeSet Class

public class EMRpcAgentAttributeSet

extends EMAttributeSet implements Cloneable, Serializable

The com.sun.em.api.topology.EMRpcAgentAttributeSet class implements an abstract class which forms the basis for the attributes set classes of each EMRpcAgent. EMRpcAgentAttributeSet is used in the Topology API to communicate which attributes of an EMRpcAgent an API method should operate on.

4.24.1 Inheritance

java.lang.Object
   |
   +----com.sun.em.api.common.EMAttributeSet
           |
           
+----com.sun.em.api.topology.EMRpcAgentAttributeSet

4.24.2 Constructors

EMRpcAgentAttributeSet

Creates an EMRpcAgentAttributeSet which contains no attributes.

public EMRpcAgentAttributeSet()

clone

Returns a clone of this EMRpcAgentAttributeSet object.

public Object clone()

Overrides clone in class EMAttributeSet.

elements

Returns an enumeration of the attributes in this set.

public Enumeration elements()

Returns an enumeration of the attributes in this set.

Overrides elements in class EMAttributeSet.

4.25 EMRpcAgentDn Class

public final class EMRpcAgentDn

extends EMObjectDn and implements Serializable, Comparable.

An instance of the com.sun.em.api.topology.EMRpcAgentDn class uniquely identifies a RPC agent.

4.25.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObjectDn
           |
           +----com.sun.em.api.topology.EMRpcAgentDn

4.25.2 Constructors

EMRpcAgentDn

Creates an EMRpcAgentDn with the specified system name and agent name.

public EMRpcAgentDn(String systemName,String 
uniqueName)

systemName is the name of the MIS where the RPC agent is stored.

uniqueName is the unique name of the RPC agent within the MIS.

4.25.3 Methods

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMRpcAgentDn object which identifies the same RPC agent as this object.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, false otherwise.

Overrides equals in class Object.

compareTo

Compares this EMRpcAgentDn with another object which implements Comparable interface. Order is determined by first lexicographically comparing the system name and then the unique name, if necessary.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical. Less than 0 if this object is 'less than' the specified object. Greater than 0 if this object is 'greater than' the specified object.

Throws ClassCastException if the object parameter is not of class EMRpcAgentDn.

getSystemName

Returns the name of the MIS where the RPC agent is stored.

public String getSystemName()

Returns the MIS name.

Overrides getSystemName in class EMObjectDn.

getUniqueName

Returns the name of the RPC agent. This name is unique within the MIS.

public String getUniqueName()

Returns the unique name of the RPC agent.

Overrides getUniqueName in class EMObjectDn.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

Overrides hashCode in class Object.

toString

Returns a String representation of the EMRpcAgentDn.

public String toString()

Returns the String representation.

Overrides toString in class .

4.26 EMRpcAgentInfo Class

Public class EMRpcAgentInfo

Extends Object implements Cloneable, Serializable, Comparable.

The com.sun.em.api.topology.EMRpcAgentInfo class is a holder class for the EMRpcAgent class.

4.26.1 Variables

name

public String name

proxyHostname

public String proxyHostname

4.26.2 Constructors

EMRpcAgentInfo

public EMRpcAgentInfo(String name,String proxyHostname)

4.26.3 Methods

clone

 public Object clone()

Returns a clone of this EMRpcAgentInfo object.

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a location object that contains the same values for name and proxyHostname.

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMRpcAgentInfo with another object that implements Comparable interface. The order is determined first by comparing the name, and then comparing the proxyHostname.

 public int compareTo(Comparable comparable)

Returns 0 if the objects are identical. Less than 0 if this object is less than the specified object. Greater than 0 if this object is greater than the specified object.

Throws: ClassCastException if the object parameter is not of class EMRpcAgentInfo.

toString

Returns a String representation of the EMRpcAgentInfo.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.27 EMSnmpAgent Class

public class EMSnmpAgent

extends EMAgent implements Cloneable

An instance of the com.sun.em.api.topology.EMSnmpAgent class represents the MIS object that contains configuration information for an SNMP agent. The configuration information includes the GET and SET community strings, the supported MIBs, and the transport address.


Note – This class does not provide an interface to the agent's managed objects, but only to Solstice EM's configuration information for the agent.

4.27.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMAgent
                   |
                   
+----com.sun.em.api.topology.EMSnmpAgent

4.27.2 Constructors

EMSnmpAgent

Constructs an instance of EMSnmpAgent representing a particular SNMP agent configuration object.

public EMSnmpAgent(EMTopoPlatform platform, 
EMSnmpAgentDn dn)

platform is the Topology API platform.

dn is the unique identifier of the SNMP agent configuration object.

4.27.3 Methods

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMSnmpAgent.DN attribute that associates the EMSnmpAgent instance with a particular SNMP agent object in the MIS. This method is useful when you want to reuse the EMSnmpAgent instance to access a different SNMP agent object and do not want the previous values to remain in effect.

public void clearAllAttributes()

Overrides: clearAllAttributes in class EMObject.

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMSnmpAgent.DN attribute that associates the EMSnmpAgent instance with a particular SNMP agent object in the MIS. This method is useful when you want to reuse a EMSnmpAgent instance to access a different proxy agent object and do not want the previous values to remain in effect.

public void clearSomeAttributes (EMAttributeSet 
attributes)

attributes is the object attributes to have their cached values cleared.

Overrides clearSomeAttributes in class EMObject.

clone

Returns a clone of this EMSnmpAgent object.

public Object clone()

Overrides clone in class Object.

createWithAllAttributes

Creates a new SNMP agent object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set:

EMTopoAttribute.DN

EMAgentAttribute.ADMINISTRATIVE_STATE

EMSnmpAgentAttribute.SYSTEM_TITLE

EMSnmpAgentAttribute.GET_COMMUNITY_STRING

EMSnmpAgentAttribute.SET_COMMUNITY_STRING

EMSnmpAgentAttribute.TRANSPORT_ADDRESS

EMSnmpAgentAttribute.SUPPORTED_MIBS

EMSnmpAgentAttribute.MANAGEMENT_PROTOCOL

EMSnmpAgentAttribute.ACCESS_CONTROL_ENFORCEMENT

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMAgentAttribute.OPERATIONAL_STATE

public void createWithAllAttributes()
throws EMTopoServiceException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if any of the mandatory attributes are not set.

Overrides createWithAllAttributes in class EMObject.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and then only if the attribute is active (i.e. has been given a value). All other attributes will be given a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set and members of the EMAttributeSet attributes:

EMTopoAttribute.DN

EMAgentAttribute.ADMINISTRATIVE_STATE

EMSnmpAgentAttribute.SYSTEM_TITLE

EMSnmpAgentAttribute.GET_COMMUNITY_STRING

EMSnmpAgentAttribute.SET_COMMUNITY_STRING

EMSnmpAgentAttribute.TRANSPORT_ADDRESS

EMSnmpAgentAttribute.SUPPORTED_MIBS

EMSnmpAgentAttribute.MANAGEMENT_PROTOCOL

EMSnmpAgentAttribute.ACCESS_CONTROL_ENFORCEMENT

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value or not:

EMAgentAttribute.OPERATIONAL_STATE

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotCreatableException will be thrown.

public void createWithSomeAttributes(EMAttributeSet 
attributes)
throws EMTopoServiceException

attributes is subset of the EMSnmpAgent's attributes to store in the new object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the any of the mandatory attributes are not set.

EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

Overrides createWithSomeAttributes in class EMObject.

destroy

Deletes the object identified by EMSnmpAgent.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public void destroy() throws EMTopoServiceException,
EMUnknownObjectExceptionpublic

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMSnmpAgent.DN does not exist.

Overrides destroy in class EMObject.

differences

Compares this EMSnmpAgent against the specified EMSnmpAgent, and returns the set of attributes for which the EMSnmpAgents have different values or null if the EMSnmpAgents are equal. If the argument obj is null or not an instance of EMSnmpAgent, then all active attributes of this EMSnmpAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMSnmpAgent but not the other, or if the attribute is active for both EMSnmpAgents but the values of the attribute are not equal.

public EMAttributeSet differences(EMObject 
obj)

obj is the object to compare against.

Returns the set of attributes for which the EMSnmpAgents have different values or null if the EMSnmpAgents are equal.

Overrides differences in class EMObject.

differencesSubset

Compares this EMSnmpAgent against the specified EMSnmpAgent, and returns the set of attributes for which the EMSnmpAgents have different values or null if the EMSnmpAgents are equal. If the argument obj is null or not an instance of EMSnmpAgent, then all active attributes of this EMSnmpAgent are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMSnmpAgent but not the other, or if the attribute is active for both EMSnmpAgents but the values of the attribute are not equal.

public EMAttributeSet 
differencesSubset(EMObject obj,EMAttributeSet attributes)

obj is the object to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the EMSnmpAgents have different values or null if the EMSnmpAgents are equal.

Overrides differencesSubset in class EMObject.

equals

Compares this EMSnmpAgent against the specified object. If the argument obj is null or not an instance of EMSnmpAgent, then the two objects are not equal. Otherwise, if the two EMSnmpAgents have the same set of active attributes, and the same value for each active attribute, then the EMSnmpAgents are equal.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, false otherwise.

Overrides equals in class Object.

equalsSubset

Compares this EMSnmpAgent against the specified object, restricting the equality check to the specified attributes. If the argument obj is null or not an instance of EMSnmpAgent, then the two objects are not equal. Otherwise, if the two EMSnmpAgents have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the EMSnmpAgents are equal.

public Boolean equalsSubset(EMObject obj, EMAttributeSet 
attributes)

obj is the object to compare against.

attributes is the subset of attributes.

Returns true if the objects are equal, false otherwise.

Overrides equalsSubset in class EMObject.

exists

Checks to see if the object identified by EMSnmpAgent.DN exists.

public boolean exists() throws EMTopoServiceException

Returns true if the object exists.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides exists in class EMObject.

getSnmpAgentFromManagedObject

Returns the unique identifier of the SNMP agent configuration object whose management domain includes the specified managed object.

public static EMSnmpAgentDn t
getSnmpAgentFromManagedObjec(EMTopoPlatform platform,
String managedObjectDnSlashForm)
throws EMTopoServiceException

platform is the Topology API platform.

managedObjectDnSlashForm is the fully distinguished name (FDN) of the managed object.

Returns the SNMP agent configuration object unique identifier; null if the managed object is not mananaged by an SNMP agent.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public EMAttributeSet getActiveAttributes()

Returns the set of active attributes.

Overrides getActiveAttributes in class EMObject.

loadAllAttributes

Loads all attributes of the object identified by the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadAllAttributes()throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMSnmpAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadAllAttributes in class EMObject.

loadSomeAttributes

Loads the specified attributes of the object identified by EMSnmpAgent.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMSnmpAgent.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadSomeAttributes in class EMObject.

newInstance

Returns a new instance of the EMSnmpAgent class without any attributes set.

public EMObject newInstance()

Returns the new object overrides newInstance in class EMObject.

storeAllAttributes

Stores all attributes into the object identified by EMSnmpAgent.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the following EMSnmpAgent attributes are read-only and therefore cannot be stored in the MIS:

EMAgentAttribute.OPERATIONAL_STATE

EMSnmpAgentAttribute.SYSTEM_TITLE

These attributes are ignored even if they have cached values.

public void storeAllAttributes() 
throws EMTopoServiceException, EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMSnmpAgent.DN does not exist.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

Overrides: storeAllAttributes in class EMObject.

storeSomeAttributes

Stores the specified attributes into the object identified by EMSnmpAgent.DN. For attributes that have not been given a value by calling load or setter methods (a default value, usually null or empty string or 0) will be stored. Note that the following EMSnmpAgent attributes are read-only and therefore cannot be stored in the MIS:

EMAgentAttribute.OPERATIONAL_STATE

EMSnmpAgentAttribute.SYSTEM_TITLE

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotStoreableException will be thrown.

public void storeSomeAttributes(EMAttributeSet attributes) throws

attributes is the object attributes to store in the MIS.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMSnmpAgent.DN does not exist.

EMAttributeNotStoreableException if attribute contains any attributes which cannot be set at creation time.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to the MIS.

Overrides storeSomeAttributes in class EMObject.

getAdministrativeState

Returns the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public EMAgentAdministrativeState 
getAdministrativeState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getAdministrativeState in class EMAgent.

getDn

Returns the EMTopoAttribute.DN attribute.

public EMObjectDn getDn()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getDn in class EMObject.

See Also: DN

getGetCommunityString

Returns the EMSnmpAgentAttribute.GET_COMMUNITY_STRING attribute.

public String getGetCommunityString()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: GET_COMMUNITY_STRING

getOperationalState

Returns the EMAgentAttribute.OPERATIONAL_STATE attribute.

public EMAgentOperationalState getOperationalState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getOperationalState in class EMAgent.

See Also: OPERATIONAL_STATE

getSetCommunityString

Returns the EMSnmpAgentAttribute.SET_COMMUNITY_STRING attribute.

public String getSetCommunityString()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SET_COMMUNITY_STRING

getSupportedMIBs

Returns the EMSnmpAgentAttribute.SUPPORTED_MIBS attribute.

public String[] getSupportedMIBs()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SUPPORTED_MIBS

getSystemTitle

Returns the EMSnmpAgentAttribute.SYSTEM_TITLE attribute.

public String getSystemTitle()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SYSTEM_TITLE

getTransportAddress

Returns the EMSnmpAgentAttribute.TRANSPORT_ADDRESS attribute.

public String getTransportAddress()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: TRANSPORT_ADDRESS

getManagementProtocol

Returns the EMSnmpAgentAttribute.MANAGEMENT_PROTOCOL attribute.

public EMSnmpAgentManagementProtocol 
getManagementProtocol()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MANAGEMENT_PROTOCOL

getAccessControlEnforcement

Returns the EMSnmpAgentAttribute.ACCESS_CONTROL_ENFORCEMEN T attribute.

public EMSnmpAgentAccessControlEnforcement
getAccessControlEnforcement()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ACCESS_CONTROL_ENFORCEMENT

getAccessControlMechanism

Returns the EMSnmpAgentAttribute.ACCESS_CONTROL_MECHANISM< /font> attribute.

public EMSnmpAgentAccessControlMechanism
getAccessControlMechanism()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ACCESS_CONTROL_MECHANISM

setAdministrativeState

Sets the EMAgentAttribute.ADMINISTRATIVE_STATE attribute.

public void setAdministrativeState
(EMAgentAdministrativeState administrativeState)

administrativeState is the attribute value.

Throws NullPointerException if administrativeState is null.

Overrides setAdministrativeState in class EMAgent.

See Also: ADMINISTRATIVE_STATE

setDn

Sets the EMTopoAttribute.DN attribute.

public void setDn(EMObjectDn dn)

dn is the attribute value.

Throws NullPointerException if dn is null.

Throws ClassCastException if dn is not an instance of EMSnmpAgentDn.

Overrides setDn in class EMObject.

See Also: DN

setGetCommunityString

Sets the EMSnmpAgentAttribute.GET_COMMUNITY_STRING attribute.

public void setGetCommunityString(String getCommunityString)

getCommunityString is the attribute value.

Throws NullPointerException if getCommunityString is null.

See Also: GET_COMMUNITY_STRING

setSetCommunityString

Sets the EMSnmpAgentAttribute.SET_COMMUNITY_STRING attribute.

public void setSetCommunityString(String setCommunityString)

setCommunityString is the attribute value.

Throws NullPointerException if setCommunityString is null.

See Also: SET_COMMUNITY_STRING

setSupportedMIBs

Sets the EMSnmpAgentAttribute.SUPPORTED_MIBS attribute.

public void setSupportedMIBs(String supportedMIBs[])

supportedMIBs is the attribute value.

Throws NullPointerException if supportedMIBs is null.

See Also: SUPPORTED_MIBS

addSupportedMIB

Adds the specified supported MIB to the EMSnmpAgentAttribute.SUPPORTED_MIBS attribute.

public void addSupportedMIB(String supportedMIB)

supportedMIB is the attribute value.

See Also: SUPPORTED_MIBS

removeSupportedMIB

Removes the specified supportedMIB from the EMSnmpAgentAttribute.SUPPORTED_MIBS attribute.

public void removeSupportedMIB(String supportedMIB)

supportedMIB is the attribute value.

See Also: SUPPORTED_MIBS

setSystemTitle

Sets the EMSnmpAgentAttribute.SYSTEM_TITLE attribute.

public void setSystemTitle(String systemTitle)

systemTitle is the attribute value.

Throws NullPointerException if systemTitle is null.

See Also: SYSTEM_TITLE

setTransportAddress

Sets the EMSnmpAgentAttribute.TRANSPORT_ADDRESS attribute.

public void setTransportAddress(String transportAddress)

transportAddress is the attribute value.

Throws NullPointerException if transportAddress is null.

See Also: TRANSPORT_ADDRESS

setManagementProtocol

Sets the EMSnmpAgentAttribute.MANAGEMENT_PROTOCOL attribute.

public void setManagementProtocol
(EMSnmpAgentManagementProtocol managementProtocol)

managementProtocol is the attribute value.

Throws NullPointerException if managementProtocol is null.

See Also: MANAGEMENT_PROTOCOL

setAccessControlEnforcement

Sets the EMSnmpAgentAttribute.ACCESS_CONTROL_ENFORCEMEN T attribute.

public void setAccessControlEnforcement
(EMSnmpAgentAccessControlEnforcement accessControlEnforcement)

accessControlEnforcement is the attribute value.

Throws NullPointerException if managementProtocol is null.

See Also: ACCESS_CONTROL_ENFORCEMENT

setAccessControlMechanism

Sets the EMSnmpAgentAttribute.ACCESS_CONTROL_MECHANISM< /font> attribute.

public void setAccessControlMechanism
(EMSnmpAgentAccessControlMechanism accessControlMechanism )

accessControlMechanism is the attribute value.

Throws NullPointerException if managementProtocol is null.

See Also: ACCESS_CONTROL_MECHANISM

toString

Returns a String representation of the EMSnmpAgent.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.28 EMSnmpAgentAccessControl
Enforcement
Class

public class EMSnmpAgentAccessControlEnforcement

extends Object implements Serializable

The com.sun.em.api.topology.EMSnmpAgentAccessContr olEnforcement class represents the Internet management protocol used by a proxy agent to manage devices.

4.28.1 Variables

AGENT

AGENT means that access control is applied at the Internet agent.

public static final EMSnmpAgentAccessControlEnforcement 
AGENT

PROXY

PROXY means that access control is applied at the ISO/Internet proxy.

public static final EMSnmpAgentAccessControlEnforcement 
PROXY

BOTH

BOTH means that access control is applied at both the Internet agent and the ISO/Internet proxy.

public static final EMSnmpAgentAccessControlEnforcement 
BOTH

MIN_ACCESS_CONTROL_ENFORCEMENT

MIN_ACCESS_CONTROL_ENFORCEMENT means the same as AGENT.

public static final 
EMSnmpAgentAccessControlEnforcement
MIN_ACCESS_CONTROL_ENFORCEMENT

MAX_ACCESS_CONTROL_ENFORCEMENT

MAX_ACCESS_CONTROL_ENFORCEMENT means the same as BOTH.

public static final 
EMSnmpAgentAccessControlEnforcement
MAX_ACCESS_CONTROL_ENFORCEMENT

4.28.2 Methods

equals

Compares this EMSnmpAgentAccessControlEnforcement against the specified object. The result is true if, and only if, the argument is not null and is a EMSnmpAgentAccessControlEnforcement object with the same value as this EMSnmpAgentAccessControlEnforcement.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise false.

Overrides equals in class Object.

toString

Returns a String representation of the EMSnmpAgentAccessControlEnforcement.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.29 EMSnmpAgentAccessControlMechanism Class

public class EMSnmpAgentAccessControlMechanism

extends Object implements Serializable

The com.sun.em.api.topology.EMSnmpAgentAccessContr olMechanism class represents the Internet management protocol used by a proxy agent to manage devices.

4.29.1 Variables

NO_ACCESS_CONTROL

NO_ACCESS_CONTROL means no access control is used.

public static final 
EMSnmpAgentAccessControlMechanism
NO_ACCESS_CONTROL

INTERNET

INTERNET means that Internet access control as specified in SNMPv2SEC is used.

public static final EMSnmpAgentAccessControlMechanism 
INTERNET

ISO

ISO means that ISO/CCITT access control as specified in ISO10164-9 is used.

public static final EMSnmpAgentAccessControlMechanism 
ISO

MIN_ACCESS_CONTROL_MECHANISM

MIN_ACCESS_CONTROL_MECHANISM means the same as NO_ACCESS_CONTROL.

public static final EMSnmpAgentAccessControlMechanism 	
 
MIN_ACCESS_CONTROL_MECHANISM

MAX_ACCESS_CONTROL_MECHANISM

MAX_ACCESS_CONTROL_MECHANISM means the same as ISO.

public static final 
EMSnmpAgentAccessControlMechanism
MAX_ACCESS_CONTROL_MECHANISM

4.29.2 Methods

equals

Compares this EMSnmpAgentAccessControlMechanism against the specified object. The result is true if, and only if, the argument is not null and is a EMSnmpAgentAccessControlMechanism object with the same value as this EMSnmpAgentAccessControlMechanism.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

toString

Returns a String representation of the EMSnmpAgentAccessControlMechanism.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.30 EMSnmpAgentAttribute Class

public class EMSnmpAgentAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMSnmpAgentAttribute class represents a single attribute of the EMSnmpAgent POC.

4.30.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMSnmpAgentAttribute

4.30.2 Variables

SYSTEM_TITLE_ID

public static final int SYSTEM_TITLE_ID

SYSTEM_TITLE

OID of system title, that is, "1.2.3.4".

public static final EMSnmpAgentAttribute SYSTEM_TITLE

GET_COMMUNITY_STRING_ID

public static final int GET_COMMUNITY_STRING_ID

GET_COMMUNITY_STRING

Community name for GET requests, that is, "public" or "private".

public static final EMSnmpAgentAttribute 
GET_COMMUNITY_STRING

SET_COMMUNITY_STRING_ID

public static final int SET_COMMUNITY_STRING_ID

SET_COMMUNITY_STRING

Community name for SET requests, that is, "public" or "private".

public static final EMSnmpAgentAttribute 
SET_COMMUNITY_STRING

TRANSPORT_ADDRESS_ID

public static final int TRANSPORT_ADDRESS_ID

TRANSPORT_ADDRESS

IP address of the system associated with the Internet agent, specified as a string, such as "12.34.56.78". An optional port number may be appended, such as "12.34.56.78:1234".

public static final EMSnmpAgentAttribute 
TRANSPORT_ADDRESS

SUPPORTED_MIBS_ID

public static final int SUPPORTED_MIBS_ID

SUPPORTED_MIBS

The names of the MIBs the SNMP agent supports.

public static final EMSnmpAgentAttribute SUPPORTED_MIBS

MANAGEMENT_PROTOCOL_ID

public static final int MANAGEMENT_PROTOCOL_ID

MANAGEMENT_PROTOCOL

The version of SNMP protocol the SNMP agent supports.

public static final EMSnmpAgentAttribute 
MANAGEMENT_PROTOCOL

ACCESS_CONTROL_ENFORCEMENT_ID

public static final int ACCESS_CONTROL_ENFORCEMENT_ID

ACCESS_CONTROL_ENFORCEMENT

The indication of where access control is applied.

public static final EMSnmpAgentAttribute
ACCESS_CONTROL_ENFORCEMENT

ACCESS_CONTROL_MECHANISM_ID

public static final int ACCESS_CONTROL_MECHANISM_ID

ACCESS_CONTROL_MECHANISM

The indication of what type of access control is used.

public static final EMSnmpAgentAttribute
ACCESS_CONTROL_MECHANISM

4.30.3 Methods

toString

Returns a String representation of the EMSnmpAgentAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute.

4.31 EMSnmpAgentAttributeSet Class

public class EMSnmpAgentAttributeSet

extends EMAttributeSet implements Cloneable, Serializable

The com.sun.em.api.topology.EMSnmpAgentAttributeSe t class implements an abstract class which forms the basis for the attributes set classes of each EMSnmpAgent. EMSnmpAgentAttributeSet is used to communicate the attributes of an EMSnmpAgent that an API method should operate on.

4.31.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMAttributeSet
           |
           
+----com.sun.em.api.topology.EMSnmpAgentAttributeSet

4.31.2 Constructors

EMSnmpAgentAttributeSet

public EMSnmpAgentAttributeSet()

Creates an EMSnmpAgentAttributeSet which contains no attributes.

4.31.3 Methods

clone

Returns a clone of this EMSnmpAgentAttributeSet object.

public Object clone()

Returns a clone of this EMSnmpAgentAttributeSet.

Overrides clone in class EMAttributeSet.

elements

Returns an enumeration of the attributes in this set.

public Enumeration elements()

Returns an enumeration of the attributes in this set.

Overrides elements in class EMAttributeSet.

4.32 EMSnmpAgentDn Class

public final class EMSnmpAgentDn

extends EMObjectDn implements Serializable, Comparable

An instance of the com.sun.em.api.topology.EMSnmpAgentDn class uniquely identifies a SNMP agent.

4.32.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObjectDn
           |
           +----com.sun.em.api.topology.EMSnmpAgentDn

4.32.2 Constructors

EMSnmpAgentDn

Creates an EMSnmpAgentDn with the specified system name and agent name.

public EMSnmpAgentDn(String systemName, String 
uniqueName)

systemName is the name of the MIS where the SNMP agent is stored.

uniqueName is the unique name of the SNMP agent within the MIS.

4.32.3 Methods

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMSnmpAgentDn object that identifies the same SNMP agent as this object.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMSnmpAgentDn with another object that implements Comparable interface. Order is determined by first lexicographically comparing the system name, and then the unique name if necessary.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical. Less than 0 if this object is 'less than' the specified object. Greater than 0 if this object is 'greater than' the specified object.

Throws ClassCastException if the object parameter is not of class EMSnmpAgentDn.

getSystemName

Returns the name of the MIS where the SNMP agent is stored.

public String getSystemName()

Returns the MIS name.

Overrides getSystemName in class EMObjectDn.

getUniqueName

Returns the name of the SNMP agent. This name is unique within the MIS.

public String getUniqueName()

Returns the unique name of the SNMP agent.

Overrides getUniqueName in class EMObjectDn.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

Overrides hashCode in class Object.

toString

Returns a String representation of the EMSnmpAgentDn.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.33 EMSnmpAgentManagementProtocol Class

public class EMSnmpAgentManagementProtocol

extends Object implements Serializable

The com.sun.em.api.topology.EMSnmpAgentManagementP rotocol class represents the Internet management protocol used by a proxy agent to manage devices.

4.33.1 Variables

SNMP_V1

The SNMP_V1 protocol means that the agent is using SNMP version 1 as management protocol.

public static final EMSnmpAgentManagementProtocol 
SNMP_V1

SNMP_V2

The SNMP_V2 protocol means that the agent is using SNMP version 2 as management protocol. Note that SNMP_V2 is not supported yet.

public static final EMSnmpAgentManagementProtocol 
SNMP_V2

4.33.2 Methods

equals

Compares this EMSnmpAgentManagementProtocol against the specified object. The result is true if, and only if, the argument is not null and is an EMSnmpAgentManagementProtocol object with the same value as this EMSnmpAgentManagementProtocol.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

toString

Returns a String representation of the EMSnmpAgentManagementProtocol.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.34 EMTopoNode Class

public class EMTopoNode

extends EMObject implements Cloneable, Serializable

The com.sun.em.api.topology.EMTopoNode class represents a topology node, which is the unit of management in Solstice EM. Using the standard POC methods, you can create, delete, and compare topology nodes. Using the EMTopoNode's access methods you can get and set the name, topology pathname, logical and geographical location, topology type, and associated managed objects and their corresponding CMIP, RPC, and/or SNMP agent objects among other attributes. The EMTopoNode class also provides a callback mechanism to notify clients when a topology node has been created, deleted, or had one or more attributes changed.

4.34.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMTopoNode

4.34.2 Constructors

EMTopoNode

Creates an instance of EMTopoNode without initializing it to a particular topology node. The version of the constructor is typically used when creating topology nodes, although you can use the setDn() method to set the DN attribute after construction time.

public EMTopoNode(EMTopoPlatform platform)

platform is the Topology API platform.

EMTopoNode

Creates an instance of EMTopoNode to represent a particular topology node.

public EMTopoNode(EMTopoPlatform platform, EMTopoNodeDn 
dn)

platform is the Topology API platform.

dn is the unique identifier of the topology node.

4.34.3 Methods

addEMTopoNodeListener

Adds the listener to the list of objects to be called when a topology node is created, deleted, or changed.

public static void addEMTopoNodeListener(
EMTopoPlatform platform, EMTopoNodeListener listener)
throws EMTopoServiceException

platform is the Topology API platform.

listener is listener of topology node events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMTopoNodeListener

findNodesByManagedObject

Returns all nodes whose MANAGED_OBJECTS attributes include the specified managed object. The nodes from both the local and remote MISs, that is, the list returned by EMTopoPlatform.getSystemNames(), are included in the search set.

public static EMTopoNodeDn[] t
findNodesByManagedObjec (EMTopoPlatform platform,String
managedObjectDnSlashForm)
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

managedObjectDnSlashForm is the managed object fully distinguished name (FDN) in slash form, that is, "/systemId=\"ultra\"/networkId=23/bstId=43".

Returns nodes that have the specified managed object.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

Throws EMInvalidArgException if managedObjectDnSlashForm is an invalid FDN.

findNodesByManagedObject

Returns all nodes whose MANAGED_OBJECTS attributes includes the specified managed object. Only the nodes contained in the specified MIS systems are included in the search set.

public static EMTopoNodeDn[] 
findNodesByManagedObject(EMTopoPlatform platform, String
managedObjectDnSlashForm, String systemNames[])
throws EMInvalidArgException, EMTopoServiceException

platform is the Topology API platform.

managedObjectDnSlashForm is the managed object dn in slash form, that is, "/systemId=\"ultra\"/networkId=23/bstId=43"

systemNames is the MIS systems to restrict the query to.

Returns nodes that have the specified managed object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if one of the specified system names is not a valid system name of an MIS that is visible through the current Platform connection.

findNodesByName

Returns all nodes whose NAME attribute equals the specified name. The nodes from both the local and remote MISs, that is,the list returned by EMTopoPlatform.getSystemNames(), are included in the search set.

public static EMTopoNodeDn[] 
findNodesByName(EMTopoPlatform platform,String name)
throws EMTopoServiceException

platform is the Topology API platform.

name is the name to match.

Returns nodes with the given administrative name.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

findNodesByName

Returns all nodes whose NAME attribute equals the specified name. Only the nodes contained in the specified MIS systems are included in the search set.

public static EMTopoNodeDn[] 
findNodesByNamem (EMTopoPlatfor platform, String name,
String systemNames[])
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

name is the name to match.

systemNames is the MIS systems to restrict the query to.

Returns nodes with the given administrative name.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if one of the specified system names is not a valid system name of an MIS that is visible through the current Platform connection.

findNodesByType

Returns all nodes whose TYPE_NAME attribute equals the specified type name. The nodes from both the local and remote MISs, that is, the list returned by EMTopoPlatform.getSystemNames(), are included in the search set.

public static EMTopoNodeDn[] 
findNodesByType(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

typeName is the type name to match.

Returns nodes of the specified type.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

findNodesByType

Returns all nodes whose TYPE_NAME attribute equals the specified type name. Only the nodes contained in the specified MIS systems are included in the search set.

public static EMTopoNodeDn[] 
findNodesByType(EMTopoPlatform platform, String typeName,
String systemNames[])
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

typeName is the type name to match.

systemNames is the MIS systems to restrict the query to.

Returns nodes of the specified type.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if one of the specified system names is not a valid system name of an MIS that is visible through the current Platform connection.

findMOsByNodes

Returns the names of all the managed objects corresponding to the specified topology nodes in the specified MIS system. In other words, the returned managed object names are contained in the specified topology nodes' EMTopoNodeAttribute.MANAGED_OBJECTS attribute.

public static MOName[] 
findMOsByNodes(EMTopoPlatform platform,String systemName,
int nodeIDs[], boolean needDNs)
throws EMTopoServiceExceptionloadNodesInView

platform is the Topology API platform.

systemName is the MIS system to restrict the query to.

nodeIDs is the group of topology nodes this query is performed on; topology node ID is the integer part of topology node DN.

needDNs indicates whether the return MONames should contain managed object names (FDNs) in addition to the internal managed object IDs. See MOName class for details.

Returns the managed object names correponding to the specified topology nodes in the specified MIS system.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

loadNodesInView

Returns all the nodes in the specified view. The returned nodes would only have the specified attributes filled in.

public static EMTopoNode[]
loadNodesInView(EMTopoPlatform platform, EMTopoNodeDn viewDn,
EMTopoNodeAttributeSet attributes)
throws EMTopoServiceException

platform is the Topology API platform.

viewDn is the parent view.

attributes is the set specifying the attributes that will be returned.

Returns the nodes of the specified view with the specified attributes.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

findRootNodes

Returns all nodes named "Root". The nodes from both the local and remote MISs, (the list returned by EMTopoPlatform.getSystemNames()) are included in the search set.

public static EMTopoNodeDn[] 
findRootNodes(EMTopoPlatform platform)
throws EMTopoServiceException

platform is the Topology API platform.

Returns the root nodes.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

findRootNodes

Returns all nodes named "Root". Only the nodes contained in the specified MIS systems are included in the search set.

public static EMTopoNodeDn[] 
findRootNodes (EMTopoPlatform platform, String systemNames[])
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

systemNames is the MIS systems to restrict the query to.

Returns the root nodes.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if one of the specified system names is not a valid system name of an MIS that is visible through the current Platform connection.

getTopologyPathnames

Constructs all possible topology pathnames for the specified topology node name contained in the specified view. At a minimum, there will be one pathname for each parent view of viewDn. However, the actual number of pathnames may be higher since each parent can also have more than one parent continuing until the root of the topology graph "Root" is reached.

public static String[] 
getTopologyPathnames(EMTopoPlatform platform,
EMTopoNodeDn viewDn,String name)
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

viewDn is the unique identifier of a topology node which is a view.

name is a topology node NAME. Note that the name does not have to the name of a real topology node contained within viewDn.

Returns the topology pathnames of the view with the topology node name appended.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if viewDn is not a view.

getTopologyPathnamesOfView

Constructs all possible topology pathnames for the specified topology view. At a minimum, there will be one pathname for each parent view of viewDn . However, the actual number of pathnames may be higher since each parent can also have more than one parent continuing until the root of the topology graph "Root" is reached.

public static String[] 
getTopologyPathnamesOfView(EMTopoPlatform platform,
EMTopoNodeDn viewDn)
throws EMTopoServiceException, EMInvalidArgException

platform is the Topology API platform.

viewDn is the unique identifier of a topology node which is a view.

Returns the topology pathnames of the view.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMInvalidArgException if viewDn is not a view.

isView

Returns true if the node's TYPE_NAME is a view type, that is, if EMTopoType.isView(TYPE_NAME) equals true. This method is more efficient than the client loading the TYPE_NAME and calling EMTopoType.isView(TYPE_NAME).

public static boolean isView 
(EMTopoPlatform platform,EMTopoNodeDn dn)
throws EMTopoServiceException

platform is the Topology API platform.

dn is the unique identifier of the topology node.

Returns true if the node's TYPE_NAME is a view type.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

loadNodes

Loads the specified attributes for each of the specified topology nodes and returns the result. When loading a large block of topology nodes, using loadNodes() is faster than creating an EMTopoNode and calling EMTopoNode.loadSomeAttributes() for each one.

public static EMTopoNode[] 
loadNodes(EMTopoPlatform platform,EMTopoNodeAtt ributeSet
attributes, EMTopoNodeDn nodeDns[])

throws EMTopoServiceException, EMUnknownObjectException

platform is the Topology API platform.

attributes is the attributes to load for each topology node.

nodeDns is the topology nodes to load.

Returns the cached attributes for the specified topology nodes.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMAttributeDecodeException if an error occurred in converting the attribute values received in ASN.1 format into the local cache data format.

loadNodesInBatches

Asynchronously loads specified attributes for each of the specified topology nodes, calling the specified listener's batchReceived() method after each batch of topology nodes have been loaded.

public static void loadNodesInBatches
(EMTopoPlatform platform,EMAttributeSe t attributes,EMTopoNodeD n
nodeDns[], int batchSize,EMTopoNodeBa tchLoaderListener listener)

platform is the Topology API platform.

attributes is the attributes to load for each topology node.

nodeDns is the topology nodes to load.

batchSize is the number of nodes to load in each batch.

listener is the listener to notify after each batch is loaded.

See Also: EMTopoNodeBatchLoaderListener

removeEMTopoNodeListener

Removes the specified listener from the list of objects to be called when a topology node is created, deleted, or changed.

public static void removeEMTopoNodeListener
(EMTopoPlatform platform,EMTopoNodeLis tener listener)
throws EMTopoServiceException

platform is the Topology API platform.

listener is the listener of topology events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMTopoNodeListener

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMTopoAttribute.DN attribute which associates the EMTopoNode instance with a particular topology node object in the MIS. This method is useful when you want to reuse the EMTopoNode instance to access a different topology node object and do not want the previous values to remain in effect.

public void clearAllAttributes()

Overrides clearAllAttributes in class EMObject.

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMTopoAttribute.DN attribute which associates the EMTopoNode instance with a particular topology node object in the MIS.

This method is useful when you want to reuse a EMTopoNode instance to access a different proxy agent object and do not want the previous values to remain in effect.

public void clearSomeAttributes(EMAttributeSet attributes)

attributes is the object attributes to have their cached values cleared.

Overrides clearSomeAttributes in class EMObject.

clone

Returns a clone of this EMTopoNode object.

public Object clone()

Returns a clone of this EMTopoNode.

Overrides clone in class Object.

createWithAllAttributes

Creates a new topology node object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on a default value defined by the GDMO (generally null or empty string). In order for the create to succeed, the following attributes must be set:

EMTopoNodeAttribute.NAME

EMTopoNodeAttribute.TYPE_NAME

EMTopoNodeAttribute.PARENTS

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMTopoAttribute.DN

EMTopoNodeAttribute.TOPOLOGY_PATHNAMES

EMTopoNodeAttribute.CHILDREN

EMTopoNodeAttribute.VIEW_CHILDREN

EMTopoNodeAttribute.PROPAGATED_SEVERITY

EMTopoNodeAttribute.MONITOR_VISIBLE_CHILDREN

EMTopoNodeAttribute.MONITOR_HIDDEN_CHILDREN

EMTopoNodeAttribute.MONITOR_MAX_VISIBLE_CHILDREN

public void createWithAllAttributes() 
throws EMTopoServiceException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if any of the mandatory attributes are not set: EMTopoNodeAttribute.NAME, EMTopoNodeAttribute.TYPE_NAME, and EMTopoNodeAttribute.PARENTS.

Overrides createWithAllAttributes in class EMObject.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and then only if the attribute is active, that is, has been given a value. All other attributes will be give a default value defined by the GDMO, generally null or empty string. In order for the create to succeed, the following attributes must be set and members of the EMAttributeSet attributes:

EMTopoNodeAttribute.NAME

EMTopoNodeAttribute.TYPE_NAME

EMTopoNodeAttribute.PARENTS

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMTopoAttribute.DN

EMTopoNodeAttribute.TOPOLOGY_PATHNAMES

EMTopoNodeAttribute.CHILDREN

EMTopoNodeAttribute.VIEW_CHILDREN

EMTopoNodeAttribute.PROPAGATED_SEVERITY

EMTopoNodeAttribute.MONITOR_VISIBLE_CHILDREN

EMTopoNodeAttribute.MONITOR_HIDDEN_CHILDREN

EMTopoNodeAttribute.MONITOR_MAX_VISIBLE_CHILDREN

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotCreatableException will be thrown.

public void createWithSomeAttributes(EMAttributeSet 
attributes) 
throws EMTopoServiceException

attributes is subset of the EMTopoNode's attributes to store in the new object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if any of the mandatory attributes are not set: EMTopoNodeAttribute.NAME, EMTopoNodeAttribute.TYPE_NAME, and EMTopoNodeAttribute.PARENTS.

EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

Overrides createWithSomeAttributes in class EMObject.

destroy

Deletes the object identified by EMTopoAttribute.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public void destroy()throws EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

Overrides destroy in class EMObject

differences

Compares this EMTopoNode against the specified EMTopoNode, and returns the set of attributes for which the EMTopoNodes have different values or null if the EMTopoNodes are equal. If the argument obj is null or not an instance of EMTopoNode, then all active attributes of this EMTopoNode are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMTopoNode but not the other, or if the attribute is active for both EMTopoNodes but the values of the attribute are not equal

public EMAttributeSet differences(EMObject obj)

.

obj is the object to compare against.

Returns the set of attributes for which the EMTopoNodes have different values or null if the EMTopoNodes are equal.

Overrides differences in class EMObject.

differencesSubset

Compares this EMTopoNode against the specified EMTopoNode, and returns the set of attributes for which the EMTopoNodes have different values or null if the EMTopoNodes are equal. If the argument obj is null or not an instance of EMTopoNode, then all active attributes of this EMTopoNode are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMTopoNode but not the other, or if the attribute is active for both EMTopoNodes but the values of the attribute are not equal.

public EMAttributeSet 
differencesSubset(EMObject obj,EMAttributeSet attributes)

obj is the object to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the EMTopoNodes have different values or null if the EMTopoNodes are equal.

Overrides differencesSubset in class EMObject.

equals

Compares this EMTopoNode against the specified object. If the argument obj is null or not an instance of EMTopoNode, then the two objects are not equal. Otherwise, if the two EMTopoNodes have the same set of active attributes and the same value for each active attribute, then the EMTopoNodes are equal.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

equalsSubset

Compares this EMTopoNode against the specified object, restricting the equality check to the specified attributes. If the argument obj is null or not an instance of EMTopoNode, then the two objects are not equal. Otherwise, if the two EMTopoNodes have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the EMTopoNodes are equal.

public boolean equalsSubset(EMObject obj, 
EMAttributeSet attributes)

obj is the object to compare against.

attributes is the subset of attributes.

Returns true if the objects are equal, otherwise returns false.

Overrides equalsSubset in class EMObject.

exists

Checks to see if the object identified by EMTopoAttribute.DN exists.

public boolean exists() throws EMTopoServiceException

Returns true if the object exists.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides exists in class EMObject.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public EMAttributeSet getActiveAttributes()

Returns the set of active attributes.

Overrides getActiveAttributes in class EMObject.

loadAllAttributes

Loads all attributes of the object identified by EMTopoAttribute.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadAllAttributes()throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadAllAttributes in class EMObject.

loadSomeAttributes

Loads the specified attributes of the object identified by EMTopoAttribute.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadSomeAttributes in class EMObject.

newInstance

Returns a new instance of the EMTopoNode class without any attributes set.

public EMObject newInstance()

Returns the new object.

Overrides newInstance in class EMObject.

storeAllAttributes

Stores all attributes into the object identified by EMTopoAttribute.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the following EMTopoNode attributes are read-only and therefore cannot be stored in the MIS:

EMTopoNodeAttribute.TOPOLOGY_PATHNAMES

EMTopoNodeAttribute.CHILDREN

EMTopoNodeAttribute.VIEW_CHILDREN

EMTopoNodeAttribute.PROPAGATED_SEVERITY

EMTopoNodeAttribute.MONITOR_HIDDEN_CHILDREN

EMTopoNodeAttribute.MONITOR_MAX_VISIBLE_CHILDREN

These attributes are ignored even if they have cached values.

public void storeAllAttributes()throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to MIS.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides storeAllAttributes in class EMObject

storeSomeAttributes

Stores the specified attributes into the object identified by EMTopoAttribute.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the following EMTopoNode attributes are read-only and therefore cannot be stored in the MIS:

EMTopoNodeAttribute.TOPOLOGY_PATHNAMES

EMTopoNodeAttribute.CHILDREN

EMTopoNodeAttribute.VIEW_CHILDREN

EMTopoNodeAttribute.PROPAGATED_SEVERITY

EMTopoNodeAttribute.MONITOR_HIDDEN_CHILDREN

EMTopoNodeAttribute.MONITOR_MAX_VISIBLE_CHILDREN

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotStoreableException will be thrown.

public void storeSomeAttributes(EMAttributeSet attributes) 
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to store in the MIS.

Throws:

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMAttributeNotStoreableException if attributes contains any attributes which cannot be set at creation time.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeSomeAttributes in class EMObject.

getChildren

Returns the EMTopoNodeAttribute.CHILDREN attribute.

public EMTopoNodeDn[] getChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: CHILDREN

getCmipAgents

Returns the EMTopoNodeAttribute.CMIP_AGENTS attribute.

public EMCmipAgentDn[] getCmipAgents()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: CMIP_AGENTS

getDisplayStatuses

Returns the EMTopoNodeAttribute.DISPLAY_STATUSES attribute.

public EMTopoNodeDisplayStatus[] getDisplayStatuses()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: DISPLAY_STATUSES

getDn

Returns the EMTopoNodeAttribute.DN attribute.

public EMObjectDn getDn()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getDn in class EMObject.

See Also: DN

getGeographicalLocation

Returns the EMTopoNodeAttribute.GEOGRAPHICAL_LOCATION attribute.

public EMTopoNodeGeoLocation getGeographicalLocation()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: GEOGRAPHICAL_LOCATION

getLayerName

Returns the EMTopoNodeAttribute.LAYER_NAME attribute.

public String getLayerName()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: LAYER_NAME

getLinks

Returns the EMTopoNodeAttribute.LINKS attribute.

public EMTopoNodeDn[] getLinks()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: LINKS

getLogicalLocation

Returns the logical location of the topology node in the specified parent view.

public EMTopoNodeLocation 
getLogicalLocation(EMTopoNodeDn parentDn)
throws EMInvalidArgException

Returns the logical lcoation.

Throws:

EMAttributeNotSetException if the attribute has not been set in the cache.

EMInvalidArgException if there is no location for the specified parent view in the EMTopoNodeAttribute.LOGICAL_LOCATIONS attribute.

See Also: LOGICAL_LOCATIONS

getLogicalLocations

Returns the EMTopoNodeAttribute.LOGICAL_LOCATIONS attribute.

public EMTopoNodeLocationInParent[] 
getLogicalLocations()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: LOGICAL_LOCATIONS

getManagedObjects

Returns the EMTopoNodeAttribute.MANAGED_OBJECTS attribute.

public String[] getManagedObjects()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MANAGED_OBJECTS

getMonitorHiddenChildren

Returns the EMTopoNodeAttribute.MONITOR_HIDDEN_CHILDREN attribute.

public EMTopoNodeDn[] getMonitorHiddenChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MONITOR_HIDDEN_CHILDREN

getMonitorMaxVisibleChildren

Returns the EMTopoNodeAttribute.MONITOR_MAX_VISIBLE_CHILDR EN attribute.

public Integer getMonitorMaxVisibleChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MONITOR_MAX_VISIBLE_CHILDREN

getMonitorRotation

Returns the EMTopoNodeAttribute.MONITOR_ROTATION attribute.

public Integer getMonitorRotation()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MONITOR_ROTATION

getMonitorVisibleChildren

Returns the EMTopoNodeAttribute.MONITOR_VISIBLE_CHILDREN attribute.

public EMTopoNodeDn[] getMonitorVisibleChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: MONITOR_VISIBLE_CHILDREN

getArrayVisibleChildren

Returns the EMTopoNodeAttribute.ARRAY_VISIBLE_CHILDREN attribute.

public EMTopoNodeDn[] getArrayVisibleChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ARRAY_VISIBLE_CHILDREN

getArrayHiddenChildren

Returns the EMTopoNodeAttribute.ARRAY_HIDDEN_CHILDREN attribute.

public EMTopoNodeDn[] getArrayHiddenChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ARRAY_HIDDEN_CHILDREN

getArrayCellSize

Returns the EMTopoNodeAttribute.ARRAY_CELL_SIZE attribute.

public EMTopoNodeArrayCellSize getArrayCellSize() 

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ARRAY_CELL_SIZE

getArrayOrientation

Returns the EMTopoNodeAttribute.ARRAY_ORIENTATION attribute.

public EMTopoNodeArrayOrientation getArrayOrientation()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ARRAY_ORIENTATION

getArrayNumColumns

Returns the EMTopoNodeAttribute.ARRAY_NUM_COLUMNS attribute.

public Integer getArrayNumColumns()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ARRAY_NUM_COLUMNS

getBusLogicalLocations

Returns the EMTopoNodeAttribute.BUS_LOGICAL_LOCATIONS attribute.

public EMTopoNodeLocation[] getBusLogicalLocations()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: BUS_LOGICAL_LOCATIONS

getName

Returns the EMTopoNodeAttribute.NAME attribute.

public String getName()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: NAME

getParents

Returns the EMTopoNodeAttribute.PARENTS attribute.

public EMTopoNodeDn[] getParents()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: PARENTS

getPropagatePeers

Returns the EMTopoNodeAttribute.PROPAGATE_PEERS attribute.

public EMTopoNodeDn[] getPropagatePeers()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: PROPAGATE_PEERS

getPropagatedSeverity

Returns the EMTopoNodeAttribute.PROPAGATED_SEVERITY attribute.

public EMSeverity getPropagatedSeverity()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: PROPAGATED_SEVERITY

getRpcAgents

Returns the EMTopoNodeAttribute.RPC_AGENTS attribute.

public EMRpcAgentDn[] getRpcAgents()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: RPC_AGENTS

getSeverity

Returns the EMTopoNodeAttribute.SEVERITY attribute.

public EMSeverity getSeverity()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SEVERITY

getSnmpAgents

Returns the EMTopoNodeAttribute.SNMP_AGENTS attribute.

public EMSnmpAgentDn[] getSnmpAgents()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SNMP_AGENTS

getState

Returns the EMTopoNodeAttribute.STATE attribute.

public Integer getState()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: STATE

getTopologyPathnames

Returns the EMTopoNodeAttribute.TOPOLOGY_PATHNAMES attribute.

public String[] getTopologyPathnames()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: TOPOLOGY_PATHNAMES

getTypeName

Returns the EMTopoNodeAttribute.TYPE_NAME attribute.

public String getTypeName()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: TYPE_NAME

getUserData

Returns the EMTopoNodeAttribute.USER_DATA attribute.

public EMTopoNodeUserDatum[] getUserData()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: USER_DATA

getViewBackgroundImageFilename

Returns the EMTopoNodeAttribute.VIEW_BACKGROUND_IMAGE_FILE NAME attribute.

public String getViewBackgroundImageFilename()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: VIEW_BACKGROUND_IMAGE_FILENAME

getViewChildren

Returns the EMTopoNodeAttribute.VIEW_CHILDREN attribute.

public EMTopoNodeDn[] getViewChildren() 

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: VIEW_CHILDREN

getViewDefaultGeoArea

Returns the EMTopoNodeAttribute.VIEW_DEFAULT_GEO_AREA attribute.

public EMTopoNodeViewDefaultGeoArea 
getViewDefaultGeoArea()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: VIEW_DEFAULT_GEO_AREA

getViewMapConfigFilename

Returns the EMTopoNodeAttribute.VIEW_MAP_CONFIG_FILENAME attribute.

public String getViewMapConfigFilename()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: VIEW_MAP_CONFIG_FILENAME

isSeverityPropagated

Returns the EMTopoNodeAttribute.IS_SEVERITY_PROPAGATED attribute.

public Boolean isSeverityPropagated()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: IS_SEVERITY_PROPAGATED

setDisplayStatuses

Sets the EMTopoNodeAttribute.DISPLAY_STATUSES attribute.

public void setDisplayStatuses
(EMTopoNodeDisplayStatus displayStatuses[])

displayStatuses is the attribute value.

Throws NullPointerException if displayStatuses is null.

See Also: DISPLAY_STATUSES

setDn

Sets the EMTopoAttribute.DN attribute.

public void setDn(EMObjectDn dn)

dn is the attribute value.

Throws:

NullPointerException if dn is null.

ClassCastException if dn is not an instance of EMTopoNodeDn.

Overrides setDn in class EMObject.

See Also: DN

setGeographicalLocation

Sets the EMTopoNodeAttribute.GEOGRAPHICAL_LOCATION attribute.

public void setGeographicalLocation
(EMTopoNodeGeoLocation geoLocation)

geoLocation is the attribute value.

Throws NullPointerException if geoLocation is null.

See Also: GEOGRAPHICAL_LOCATION

setIsSeverityPropagated

Sets the EMTopoNodeAttribute.IS_SEVERITY_PROPAGATED attribute.

public void setIsSeverityPropagated(Boolean isSeverityPropagated)

isSeverityPropagated is the attribute value.

Throws NullPointerException if isSeverityPropagated is null.

See Also: IS_SEVERITY_PROPAGATED

setLayerName

Sets the EMTopoNodeAttribute.LAYER_NAME attribute.

public void setLayerName(String layerName)

layerName is the attribute value.

Throws NullPointerException if layerName is null.

See Also: LAYER_NAME

setLinks

Sets the EMTopoNodeAttribute.LINKS attribute.

public void setLinks(EMTopoNodeDn links[])

links is the attribute value.

Throws NullPointerException if links is null.

See Also: LINKS

setLogicalLocations

Sets the EMTopoNodeAttribute.LOGICAL_LOCATIONS attribute.

public void setLogicalLocations
(EMTopoNodeLocationInParent locations[])

locations is the attribute value.

Throws NullPointerException if locations is null.

See Also: LOGICAL_LOCATIONS

setManagedObjects

Sets the EMTopoNodeAttribute.MANAGED_OBJECTS attribute.

public void setManagedObjects(String managedObjects[])

managedObjects is the attribute value.

Throws NullPointerException if managedObjects is null.

See Also: MANAGED_OBJECTS

setMonitorRotation

Sets the EMTopoNodeAttribute.MONITOR_ROTATION attribute.

public void setMonitorRotation(Integer monitorRotation)

monitorRotation is the attribute value.

Throws NullPointerException if monitorRotation is null.

See Also:MONITOR_ROTATION

setMonitorVisibleChildren

Sets the EMTopoNodeAttribute.MONITOR_VISIBLE_CHILDREN attribute.

public void setMonitorVisibleChildren
(EMTopoNodeDn monitorVisibleChildren[])
throws EMInvalidArgException

monitorVisibleChildren is the attribute value.

Throws:

NullPointerException if monitorVisibleChildren is null.

EMInvalidArgException if maximum number of visible children is exceeded.

See Also: MONITOR_VISIBLE_CHILDREN

setArrayVisibleChildren

Sets the EMTopoNodeAttribute.ARRAY_VISIBLE_CHILDREN attribute.

public void setArrayVisibleChildren
(EMTopoNodeDn arrayVisibleChildren[] )

arrayVisibleChildren is the attribute value.

Throws NullPointerException if arrayVisibleChildren is null.

See Also: ARRAY_VISIBLE_CHILDREN

addArrayVisibleChild

Adds the specified arrayVisibleChild to the EMTopoNodeAttribute.ARRAY_VISIBLE_CHILDREN attribute.

public void 
addArrayVisibleChild(EMTopoNodeDn arrayVisibleChild)

arrayVisibleChild is the attribute value.

See Also: ARRAY_VISIBLE_CHILDREN

removeArrayVisibleChild

Removes the specified arrayVisibleChild from the EMTopoNodeAttribute.ARRAY_VISIBLE_CHILDREN attribute.

public void removeArrayVisibleChild
(EMTopoNodeDn arrayVisibleChild)

arrayVisibleChild is the attribute value.

See Also: ARRAY_VISIBLE_CHILDREN

setArrayCellSize

Sets the EMTopoNodeAttribute.ARRAY_CELL_SIZE attribute.

public void setArrayCellSize(EMTopoNodeArrayCellSize 
arrayCellSize)

arrayCellSize is the attribute value.

Throws NullPointerException if arrayCellSize is null.

See Also: ARRAY_CELL_SIZE

setArrayOrientation

Sets the EMTopoNodeAttribute.ARRAY_ORIENTATION attribute.

public void setArrayOrientation
(EMTopoNodeArrayOrientation arrayOrientation)

arrayOrientation is the attribute value.

Throws NullPointerException if arrayOrientation is null.

See Also: ARRAY_ORIENTATION

setArrayNumColumns

Sets the EMTopoNodeAttribute.ARRAY_NUM_COLUMNS attribute.

public void setArrayNumColumns(Integer arrayNumColumns)

arrayNumColumns is the attribute value.

Throws NullPointerException if arrayNumColumns is null.

See Also:ARRAY_NUM_COLUMNS

setBusLogicalLocations

Sets the EMTopoNodeAttribute.BUS_LOGICAL_LOCATIONS attribute.

public void setBusLogicalLocations
(EMTopoNodeLocation busLogicalLocations[])

busLogicalLocations is the attribute value.

Throws NullPointerException if busLogicalLocations is null.

See Also: BUS_LOGICAL_LOCATIONS

setName

Sets the EMTopoNodeAttribute.NAME attribute.

public void setName(String name)

name is the attribute value.

Throws NullPointerException if name is null.

See Also: NAME

setParents

Sets the EMTopoNodeAttribute.PARENTS attribute.

public void setParents(EMTopoNodeDn parents[])

parents is the attribute value.

Throws NullPointerException if parents is null.

See Also: PARENTS

setPropagatePeers

Sets the EMTopoNodeAttribute.PROPAGATE_PEERS attribute.

public void setPropagatePeers(EMTopoNodeDn 
propagatePeers[])

propagatePeers is the attribute value.

Throws NullPointerException if propagatePeers is null.

See Also: PROPAGATE_PEERS

setState

Sets the EMTopoNodeAttribute.STATE attribute.

public void setState(Integer state)

state is the attribute value.

Throws NullPointerException if state is null.

See Also: STATE

setTypeName

Sets the EMTopoNodeAttribute.TYPE_NAME attribute.

public void setTypeName(String typeName)

typeName is the attribute value.

Throws NullPointerException if typeName is null.

See Also: TYPE_NAME

setUserData

Sets the EMTopoNodeAttribute.USER_DATA attribute.

public void setUserData(EMTopoNodeUserDatum userData[])

userData is the attribute value.

Throws NullPointerException if userData is null.

See Also: USER_DATA

setViewBackgroundImageFilename

Sets the EMTopoNodeAttribute.VIEW_BACKGROUND_IMAGE_FILE NAME attribute.

 public void setViewBackgroundImageFilename(String filename)

filename is the attribute value.

Throws NullPointerException if filename is null.

See Also: VIEW_BACKGROUND_IMAGE_FILENAME

setViewMapConfigFilename

Sets the EMTopoNodeAttribute.VIEW_MAP_CONFIG_FILENAME attribute.

public void setViewMapConfigFilename(String filename)

filename is the attribute value.

Throws NullPointerException if filename is null.

See Also: VIEW_MAP_CONFIG_FILENAME

setViewDefaultGeoArea

Sets the EMTopoNodeAttribute.VIEW_DEFAULT_GEO_AREA attribute.

public void setViewDefaultGeoArea
(EMTopoNodeViewDefaultGeoArea defaultGeoArea)

defaultGeoArea is the attribute value.

Throws NullPointerException if defaultGeoArea is null.

See Also: VIEW_DEFAULT_GEO_AREA

addEMIndividualNodeListener

Adds the listener to the list of objects to be called when this topology node is changed or deleted.

public void addEMIndividualNodeListener
(EMIndividualNodeListener listener)
throws EMTopoServiceException

listener is listener of topology node events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMIndividualNodeListener

removeEMIndividualNodeListener

Removes the specified listener from the list of objects to be called when this topology node is changed or deleted.

public void removeEMIndividualNodeListener
(EMIndividualNodeListener listener)
throws EMTopoServiceException

listener is listener of topology events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMIndividualNodeListener

toString

Returns a String representation of the EMTopoNode.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.35 EMTopoNodeArrayCellSize Class

public class EMTopoNodeArrayCellSize

extends Object implements Cloneable, Serializable, Comparable

The com.sun.em.api.topology.EMTopoNodeArrayCellSiz e class is a holder class for the width (in characters) and height (in pixels) of an array cell. Because this is simply a holder class, the data members are public.

4.35.1 Variables

width

public int width

height

public int height

4.35.2 Constructors

EMTopoNodeArrayCellSize

Creates an instance of EMTopoNodeArrayCellSize with the specified width in characters and height in pixels.

public EMTopoNodeArrayCellSize(int width, int height)

width is the width in characters. Value 0 means the cell width will be set to the minimum width necessary for the widest cell label to be visible.

height is the height in pixels.

4.35.3 Methods

clone

Return a clone of this EMTopoNodeArrayCellSize object.

public Object clone()

Returns a clone of this EMTopoNodeArrayCellSize.

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeArrayCellSize object that contains the same values for width and height.

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeArrayCellSize with another object that implements Comparable interface. Order is determined by first comparing the width, then height if the widths are equal.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is less than the specified object, and greater than 0 if this object is greater than the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeArrayCellSize.

toString

Returns a String representation of the EMTopoNodeArrayCellSize.

public String toString()

Returns the String representation.

Overrides toString in class Object

4.36 EMTopoNodeArrayOrientation Class

public class EMTopoNodeArrayOrientation

extends Object implements Serializable

The com.sun.em.api.topology.EMTopoNodeArrayOrienta tion class represents the orientation of an array, either horizontal or vertical. This indicates whether the topology nodes grouped by the array should be laid down row by row or column by column.

4.36.1 Variables

HORIZONTAL

The HORIZONTAL orientation means that the topology nodes grouped by the array will be laid down row by row.

public static final EMTopoNodeArrayOrientation 
HORIZONTAL

VERTICAL

The VERTICAL orientation means that the topology nodes grouped by the array will be laid down column by column.

public static final EMTopoNodeArrayOrientation VERTICAL

4.36.2 Methods

equals

Compares this EMTopoNodeArrayOrientation against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeArrayOrientation object with the same value as this EMTopoNodeArrayOrientation.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, false otherwise.

Overrides equals in class Object.

toString

Returns a String representation of the EMTopoNodeArrayOrientation.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.37 EMTopoNodeAttribute Class

public class EMTopoNodeAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMTopoNodeAttribute class represents a single attribute of the EMTopoNode persistent object class (POC).

4.37.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMTopoNodeAttribute

4.37.2 Variables

ARRAY_VISIBLE_CHILDREN

Subset of the CHILDREN list of nodes that should be included in the array node's cells when displayed in the Viewer. The ARRAY_VISIBLE_CHILDREN nodes are placed in order into the array cells according to ARRAY_ORIENTATION. Note that this attribute is valid only if the node is an array, that is, if EMTopoType.isArray(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
ARRAY_VISIBLE_CHILDREN

ARRAY_HIDDEN_CHILDREN

List of remaining nodes after ARRAY_VISIBLE_CHILDREN is subtracted from CHILDREN. These nodes do not appear in array cells, even if there are empty cells. Note that this attribute is valid only if the node is an array, that is, if EMTopoType.isArray(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
ARRAY_HIDDEN_CHILDREN

ARRAY_ORIENTATION

The orientation of the array, either horizontal or vertical. It indicates whether the topology nodes grouped by the array should be laid down row by row or column by column. Note that this attribute is valid only if the node is an array, that is, if EMTopoType.isArray(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
ARRAY_ORIENTATION

ARRAY_NUM_COLUMNS

The number of columns or the number of rows for the horizontal or vertical orientation, respectively. Note that this attribute is valid only if the node is an array, that is, if EMTopoType.isArray(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
ARRAY_NUM_COLUMNS

ARRAY_CELL_SIZE

The width (in characters) and height (in pixels) of the array. Note that this attribute is valid only if the node is an array, that is,if EMTopoType.isArray(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute ARRAY_CELL_SIZE

BUS_LOGICAL_LOCATIONS

List of (x,y) points which define the bus's shape. The points are constrained so that all line segments are alternately horizontal or vertical. Note that this attribute is valid only if the node is bus, that is, if EMTopoType.isBus(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
BUS_LOGICAL_LOCATIONS

CHILDREN

List of topology nodes that are contained by this node.

public static final EMTopoNodeAttribute CHILDREN 

CMIP_AGENTS

List of CMIP agents which have managed objects listed as part of MANAGED_OBJECTS attribute.

public static final EMTopoNodeAttribute CMIP_AGENTS

DISPLAY_STATUSES

A list of user-defined string labels and integer value pairs, that for example, "CPUUsage", 45. This attribute can be used by developers to store a limited amount of integer data with each topology node.

public static final EMTopoNodeAttribute DISPLAY_STATUSES

GEOGRAPHICAL_LOCATION

The latitude and longitude in degrees floating-point of the location of this node, for example, 45.6780 degrees latitude, -152.234 degrees longitude.

public static final EMTopoNodeAttribute 
GEOGRAPHICAL_LOCATION

IS_SEVERITY_PROPAGATED

If true, then the node's severity will be propagated to each of its parents and each of its PROPAGATE_PEERS where it will factor in the calculation of their PROPAGATED_SEVERITY.

public static final EMTopoNodeAttribute 
IS_SEVERITY_PROPAGATED

LAYER_NAME

The name of the logical layer that the node belongs to.

public static final EMTopoNodeAttribute LAYER_NAME

LINKS

For links (topology nodes with TYPE_NAME equal to EMTopoTypeDn.LINK), LINKS is a list of topology nodes that the link is connected to. For non-link topology nodes, LINKS is a list of links the topology node is connected to.

public static final EMTopoNodeAttribute LINKS

LOGICAL_LOCATIONS

A list of parent node-coordinate pairs which locate a node within each parent node's view in a logical coordinate space. Note that a node can have a different logical coordinate for each parent that contains it, whereas the node can only have one geographical coordinate.

public static final EMTopoNodeAttribute 
LOGICAL_LOCATIONS

MANAGED_OBJECTS

List of managed object DNs in ASCII slash format associated with this node. Note that a managed object may be associated with multiple nodes. To find out the topology nodes that a managed object dn is associated with, call EMTopoPlatform.findNodesByMananagedObject().

public static final EMTopoNodeAttribute MANAGED_OBJECTS

MONITOR_HIDDEN_CHILDREN

List of remaining nodes after MONITOR_VISIBLE_CHILDREN is subtracted from CHILDREN. These nodes do not appear in a monitor section, even if there are empty sections. Note that this attribute is valid only if the node is a monitor, that is, if EMTopoType.isMonitor(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
MONITOR_HIDDEN_CHILDREN

MONITOR_MAX_VISIBLE_CHILDREN

Maximum number of sections supported by the particular type of monitor. Note that this attribute is valid only if the node is a monitor, that is, if EMTopoType.isMonitor(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute
MONITOR_MAX_VISIBLE_CHILDREN

MONITOR_ROTATION

Number of degrees to rotate the monitor node when displaying in the Viewer's canvas. The starting point for the rotation is at 12 o'clock. Note that this attribute is valid only if the node is a monitor, that is,if EMTopoType.isMonitor(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute MONITOR_ROTATION

MONITOR_VISIBLE_CHILDREN

Subset of the CHILDREN list of nodes that should be included in the monitor node's sections when displayed in the Viewer. The MONITOR_VISIBLE_CHILDREN nodes are placed, in order, into the monitor sections, starting at 12 o'clock and moving clockwise until all monitor sections are filled or there are no more nodes in MONITOR_VISIBLE_CHILDREN. Note that this attribute is valid only if the node is a monitor, that is, if EMTopoType.isMonitor(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
MONITOR_VISIBLE_CHILDREN

NAME

The administrative name of this node. Note that the NAME is not unique; multiple topology nodes may have the same name. To find out the topology nodes that a managed object dn is associated with, call EMTopoPlatform.findNodesByName(). Note that the name "Root" is reserved for the topology node that is the root of the topology graph.

public static final EMTopoNodeAttribute NAME

PARENTS

List of topology nodes that contain this node in the topology directed acyclic graph (DAG).

public static final EMTopoNodeAttribute PARENTS

PROPAGATE_PEERS

List of topology nodes to propagate this topology node's severity to if IS_SEVERITY_PROPAGATED is true.

public static final EMTopoNodeAttribute PROPAGATE_PEERS

PROPAGATED_SEVERITY

The highest severity amongst the topology node's severity, the severities of all the node's children whose IS_SEVERITY_PROPAGATED attribute is true, and the severities of all nodes whose PROPAGATE_PEERS attribute include this node and IS_SEVERITY_PROPAGATED attribute is true. Note that normally an application never sets the PROPAGATED_SEVERITY attribute; the Alarm Service automatically updates the PROPAGATED_SEVERITY attribute based on the above criteria.

public static final EMTopoNodeAttribute 
PROPAGATED_SEVERITY

RPC_AGENTS

List of RPC agents which have managed objects listed as part of the MANAGED_OBJECTS attribute.

public static final EMTopoNodeAttribute RPC_AGENTS

SNMP_AGENTS

List of SNMP agents that have managed objects listed as part of the MANAGED_OBJECTS attribute.

public static final EMTopoNodeAttribute SNMP_AGENTS

STATE

Can be used to store an integer value.

public static final EMTopoNodeAttribute STATE

SEVERITY

The highest severity alarm posted against any of the topology node's MANAGED_OBJECTS. Note that normally an application never sets the SEVERITY attribute; the Alarm Service automatically updates the SEVERITY attribute to reflect the current outstanding alarms posted against the topology node.

public static final EMTopoNodeAttribute SEVERITY

TOPOLOGY_PATHNAMES

List of all topology pathnames for the node. At a minimum, there will be one pathname for each parent. However, the actual number of pathnames may be higher since each parent can also have more than one parent, for example,

"/Root/Internet/129.146.74.0/host-45"

"/Root/hosts/host-45"

public static final EMTopoNodeAttribute 
TOPOLOGY_PATHNAMES

TYPE_NAME

Type name of this node.

public static final EMTopoNodeAttribute TYPE_NAME

USER_DATA

A list of user-defined attribute name-value pairs. A single attribute name-value pair should appear for each attribute listed in EMTopoType.USER_DATA_ATTRIBUTE_NAMES attribute of this node's EMTopoType identified by the TYPE_NAME attribute.

public static final EMTopoNodeAttribute USER_DATA

VIEW_BACKGROUND_IMAGE_FILENAME

Absolute pathname of the raster file image to be displayed when the Viewer is displaying this view node in logical view mode. Note that this attribute is valid only if the node is a view, that is if EMTopoType.isView(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute
VIEW_BACKGROUND_IMAGE_FILENAME

VIEW_CHILDREN

Subset of CHILDREN whose TYPE_NAME is a view; that is, EMTopoType.isView(TYPE_NAME) returns true.

public static final EMTopoNodeAttribute VIEW_CHILDREN

VIEW_DEFAULT_GEO_AREA

Default geographical area (specified as a center and view width in km) to be displayed when the VIEW_MAP_CONFIG_FILENAME is first displayed. Note that this attribute is valid only if the node is a view, that is, if EMTopoType.isView(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
VIEW_DEFAULT_GEO_AREA

VIEW_MAP_CONFIG_FILENAME

Absolute pathname of geographical map configuration (GMC) file to be displayed when the Viewer is displaying this view node in geographical view mode. Note that this attribute is valid only if the node is a view, that is, if EMTopoType.isView(platform,TYPE_NAME) returns true.

public static final EMTopoNodeAttribute 
VIEW_MAP_CONFIG_FILENAME

4.37.3 Methods

toString

Returns a String representation of the EMTopoNodeAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute

4.38 EMTopoNodeAttributeSet Class

public class EMTopoNodeAttributeSet

extends EMAttributeSet

implements Cloneable, Serializable

The com.sun.em.api.topology.EMTopoNodeAttributeSet class implements is an abstract class which forms the basis for the attributes set classes of each EMTopoNode. EMTopoNodeAttributeSet is used in the Topology API to communicate which attributes of an EMTopoNode an API method should operate on.

4.38.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMAttributeSet
           |
           
+----com.sun.em.api.topology.EMTopoNodeAttributeSet

4.38.2 Constructors

EMTopoNodeAttributeSet

Creates an EMTopoNodeAttributeSet that contains no attributes.

public EMTopoNodeAttributeSet()

4.38.3 Methods

clone

Returns a clone of this EMTopoNodeAttributeSet object.

public Object clone()

Overrides clone in class EMAttributeSet.

elements

Returns an enumeration of the attributes in this set.

public Enumeration elements()

Overrides elements in class EMAttributeSet.

4.39 EMTopoNodeBatchLoaderEvent Class

public class EMTopoNodeBatchLoaderEvent

extends EventObject implements Cloneable, Serializable

The com.sun.em.api.topology.EMTopoNodeBatchLoaderEvent class contains the event information for batch loading of topology nodes. When EMTopoNodeBatchLoaderListener.batchReceived()< /font> method is called, an instance of EMTopoNodeBatchLoaderEvent is passed as an argument. The event contains the EMTopoNodes that have been loaded in this batch.

See Also: EMTopoNodeBatchLoaderListener, loadNodesInBatches

4.39.1 Inheritance

 
java.lang.Object
   |
   +----java.util.EventObject
           |
           
+----com.sun.em.api.topology.EMTopoNodeBatchLoaderEvent

4.39.2 Constructors

EMTopoNodeBatchLoaderEvent

Creates an instance of EMTopoNodeBatchLoaderEvent.

public EMTopoNodeBatchLoaderEvent
(Object source, EMTopoNodenodes[])

source is the source of the event.

nodes is the nodes loaded in this batch.

4.39.3 Methods

getNodes

Returns the topology nodes from this batch. To find out how many topology nodes, call the array size() method.

public EMTopoNode[] getNodes()

Returns the nodes from this batch.

4.40 EMTopoNodeBatchLoaderListener Interface

public interface EMTopoNodeBatchLoaderListener

extends EventListener

The com.sun.em.api.topology.EMTopoNodeBatchLoaderL istener listener is the interface for asynchronously loading arbitrary numbers of topology nodes in fixed-size batches.

See Also: EMTopoNodeBatchLoaderEvent, loadNodesInBatches

4.40.1 Methods

batchReceived

Invoked once batchSize number of topology nodes have been loaded.

public void batchReceived
(EMTopoNodeBatchLoaderEvent event)

event is the event information.

4.41 EMTopoNodeDisplayStatus Class

public class EMTopoNodeDisplayStatus

extends Object implements Cloneable, Serializable, Comparable

The com.sun.em.api.topology.EMTopoNodeDisplayStatu s class is a holder class for the string label and integer value pairs which make up EMTopoNode's DISPLAY_STATUSES attribute. Because this is simply a holder class, the data members are public.

See Also: DISPLAY_STATUSES, getDisplayStatuses, setDisplayStatuses

4.41.1 Variables

label

The label, that is, "CPU Usage".

public String label

value

The integer value associated with the label.

public int value

4.41.2 Constructors

EMTopoNodeDisplayStatus

Creates an instance of EMTopoNodeDisplayStatus with the specified label and value pair.

public EMTopoNodeDisplayStatus(String label, int value)

label is the label.

value is the value.

4.41.3 Methods

clone

Returns a clone of this EMTopoNodeDisplayStatus object.

public Object clone()

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a DisplayStatus object that contains the same values for label and value

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeDisplayStatus with another object which implements Comparable interface. Order is determined by first lexicographically comparing the label and then the value if the labels are equal.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is less than the specified object, greater than 0 if this object is greater than the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeDisplayStatus.

toString

Returns a String representation of the EMTopoNodeDisplayStatus.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.42 EMTopoNodeDn Class

public final class EMTopoNodeDn

extends EMObjectDn

implements Serializable, Comparable

An instance of the com.sun.em.api.topology.EMTopoNodeDn class uniquely identifies a topology node.

4.42.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObjectDn
           |
           +----com.sun.em.api.topology.EMTopoNodeDn

4.42.2 Constructors

EMTopoNodeDn

Creates an EMTopoNodeDn with the specified system name and unique ID.

public EMTopoNodeDn(String systemName, int uniqueId)

systemName is the name of the MIS where the topology node is stored.

uniqueId is the unique identifier of the topology node within the MIS.

4.42.3 Methods

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeDn object which identifies the same topology node as this object.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, false otherwise.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeDn with another object that implements Comparable interface. Order is determined by comparing the system name lexicographically, and then comparing the unique identifier.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is 'less than' the specified object, greater than 0 if this object is 'greater than' the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeDn.

getSystemName

Returns the name of the MIS where the topology node is stored.

public String getSystemName()

Returns the MIS name.

Overrides getSystemName in class EMObjectDn.

getUniqueName

Returns the integer identifier of the topology node as a string. This identifier is unique within the MIS.

public String getUniqueName()

Returns the unique identifier.

Overrides getUniqueName in class EMObjectDn.

getUniqueId

public int getUniqueId()

Returns the integer identifier of the topology node. This identifier is unique within the MIS.

Returns the unique identifier.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

Overrides hashCode in class Object.

toString

Returns a String representation of the EMTopoNodeDn.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.43 EMTopoNodeEvent Class

public class EMTopoNodeEvent

extends EventObject

implements Cloneable

The com.sun.em.api.topology.EMTopoNodeEvent class contains information on topology node creation, deletion, and change events. When EMTopoNodeListener nodeCreated(), nodeDeleted(), or nodeChanged() methods are called, they are passed an instance of EMTopoNodeEvent containing the event information. The event information includes the type of event (creation, deletion, change), the node dn the event occured on, and for change events, an instance of EMTopoNode containing the new values of the modified attributes.

See Also: EMTopoNodeListener, addEMTopoNodeListener, removeEMTopoNodeListener

4.43.1 Inheritance

 
java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.sun.em.api.topology.EMTopoNodeEvent

4.43.2 Variables

OBJECT_CREATED

A topology node was created in the MIS.

public static final int OBJECT_CREATED

OBJECT_DELETED

A topology node was deleted in the MIS.

public static final int OBJECT_DELETED

OBJECT_CHANGED

One or more attributes of a topology node were changed in the MIS.

public static final int OBJECT_CHANGED

4.43.3 Constructors

EMTopoNodeEvent

Creates an instance of EMTopoNodeEvent.

public EMTopoNodeEvent
(Object source, int eventType,EMTopoNodeDn nodeDn)

source is the source of the event.

eventType is the type of event.

nodeDn is the unique identifier of the topology node the event occured on.

EMTopoNodeEvent

Creates an instance of EMTopoNodeEvent. This version of the constructor should only be used for OBJECT_CHANGED events.

public EMTopoNodeEvent
(Object source, int eventType, EMTopoNodeDnnodeDn, EMTopoNode changes)

source is the object which is the source of the event.

eventType is the type of topology node event.

nodeDn is the unique identifier of the topology node the event occured on.

changes is the new values of the modified attributes.

4.43.4 Methods

getEventType

Returns the type of topology node event.

public int getEventType()

Returns type of topology node event.

getNodeDn

Returns the unique identifier of the topology node the event occurred on.

public EMTopoNodeDn getNodeDn()

Returns unique identifier of topology node.

getChanges

For OBJECT_CHANGED events, returns the new values of the modified attributes; otherwise, returns null. To find out which attributes were changed, call EMTopoNode.getActiveAttributes(). The normal EMTopoNode getter methods may then be used to get the new values of the active attributes.

public EMTopoNode getChanges()

Returns the new values of the modified attributes.

isView

This method should only be used for OBJECT_CHANGED events. It returns true if the topology node represents a view; otherwise it returns false. This method is meant to save a callback to the server side when the information about the node being a view or not is needed.

public boolean isView()

Returns the boolean value indicating if topology node represents a view.

getViewChildren

This method should only be used for OBJECT_CHANGED events and when the changed attributes include EMTopoNodeAttribute.CHILDREN. It returns a list of the view children node Dns of the topology node that the event is about. Note that its view children node Dns are only a subset of its children node Dns. This method is meant to save a call back to the server side when view children is needed.

public EMTopoNodeDn[] getViewChildren()

Returns the array of view children node Dns of the topology node

toString

Returns a String representation of the EMTopoNodeEvent.

public String toString()

Returns the String representation.

Overrides toString in class EventObject.

4.44 EMTopoNodeGeoLocation Class

public class EMTopoNodeGeoLocation

extends Object implements Cloneable, Serializable

The com.sun.em.api.topology.EMTopoNodeGeoLocation< /font> class is a holder class for the longitude, latitude value of EMTopoNode's GEOGRAPHICAL_LOCATION attribute. Because this is simply a holder class, the data members are public.

See Also: GEOGRAPHICAL_LOCATION, getGeographicalLocation, setGeographicalLocation

4.44.1 Variables

longitude

The longitude (x) coordinate. Valid range is -180.0 degrees to 180.0 degrees.

public double longitude

latitude

 public double latitude

4.44.2 Constructors

EMTopoNodeGeoLocation

Creates an instance of EMTopoNodeGeoLocation with the specified longitude and latitude.

public EMTopoNodeGeoLocation(double longitude, double 
latitude)

longitude is the longitude.

latitude is the latitude.

4.44.3 Methods

clone

Returns a clone of this EMTopoNodeGeoLocation object.

public Object clone()

Returns a clone of this EMTopoNodeGeoLocation.

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeGeoLocation object that contains the same values for longitude and latitude .

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

toString

Returns a String representation of the EMTopoNodeGeoLocation object.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.45 EMTopoNodeListener Interface

public interface EMTopoNodeListener

extends EventListener

The com.sun.em.api.topology.EMTopoNodeListener listener is the interface for receiving topology node events.

See Also: EMTopoNodeEvent, addEMTopoNodeListener, removeEMTopoNodeListener

4.45.1 Methods

nodeCreated

Invoked when a topology node is created in the MIS.

public void nodeCreated(EMTopoNodeEvent event)

event is the event information.

nodeDeleted

Invoked when a topology node is deleted from the MIS.

public abstract void nodeDeleted(EMTopoNodeEvent event)

event is the event information.

nodeChanged

Invoked when one or more attributes of a topology node were changed in the MIS.

public abstract void nodeChanged(EMTopoNodeEvent event)

event is the event information.

4.46 EMTopoNodeLocation Class

public class EMTopoNodeLocation

extends Object implements Cloneable, Serializable, Comparable

The com.sun.em.api.topology.EMTopoNodeLocation class is a holder class for the x, y, and z coordinates which mark a logical location. Because this is simply a holder class, the data members are public.

4.46.1 Variables

x

public int x

y

public int y

z

public int z

4.46.2 Constructors

EMTopoNodeLocation

Creates an instance of EMTopoNodeLocation with the specified x, y, and z coordinates.

public EMTopoNodeLocation(int x, int y, int z)

x is the x coordinate.

y is the y coordinate.

z is the z coordinate.

4.46.3 Methods

clone

Return a clone of this EMTopoNodeLocation object.

public Object clone()

Returnsa clone of this EMTopoNodeLocation.

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeLocation object that contains the same values for x , y , and z .

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeLocation with another object which implements Comparable interface. Order is determined by first comparing the x coordinate, then y coordinate if the x coordinates are equal, and finally the z coordinate if both the x and y coordinates are equal.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is less than the specified object, greater than 0 if this object is greater than the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeLocation.

toString

Returns a String representation of the EMTopoNodeLocation object.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.47 EMTopoNodeLocationInParent Class

public class EMTopoNodeLocationInParent

extends Object implements Cloneable, Serializable, Comparable

The com.sun.em.api.topology.EMTopoNodeLocatioInPar ent class is a holder class for the node dn and logical location pairs which make up the EMTopoNode's LOGICIAL_LOCATIONS attribute. Because this is simply a holder class, the data members are public.

See Also: LOGICAL_LOCATIONS, getLogicalLocation, getLogicalLocations, setLogicalLocations

4.47.1 Variables

parent

The relevant topology node's logical view.

public EMTopoNodeDn parent

location

The logical location.

public EMTopoNodeLocation location

4.47.2 Constructors

EMTopoNodeLocationInParent

Creates an instance of EMTopoNodeLocationInParent with the specified view node and logical location.

public EMTopoNodeLocationInParent
(EMTopoNodeDn parent, EMTopoNodeLocation location)

view is the view node.

location is the logical location.

4.47.3 Methods

clone

Returns a clone of this EMTopoNodeLocationInParent object.

public Object clone()

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a LocationInParent object that contains the same values for parent and location

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeLocationInParent with another object that implements Comparable interface. Order is determined by first comparing the parent dn, then the location if the parent dns are equal.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is less than the specified object, greater than 0 if this object is greater than the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeLocationInParent.

toString

Returns a String representation of the EMTopoNodeLocationInParent.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.48 EMTopoNodeUserDatum Class

public class EMTopoNodeUserDatum

extends Object implements Cloneable, Serializable, Comparable

The com.sun.em.api.topology.EMTopoNodeUserDatum class is a holder class for the attribute name and value pairs which make up EMTopoNode's USER_DATA attribute. Because this is simply a holder class, the data members are public.

See Also: USER_DATA, getUserData, setUserData

4.48.1 Constructors

EMTopoNodeUserDatum

Creates an instance of EMTopoNodeUserDatum with the specified attribute name and value.

public EMTopoNodeUserDatum
(String attributeName, AbstractData value)

attributeName is the name of the attribute.

value is the attribute value.

4.48.2 Methods

getAttributeName

Returns the name of the user data attribute. It is the GDMO attribute name. In order to minimize possibility of namespace clashes, it should be a fully specified name with documentName:attributeName, for example, "Rec. X.721 | ISO/IEC 10165-2 : 1992":perceivedSeverity.

public String getAttributeName()

Returns the attributeName.

getAttributeValue

Returns the value of the user data attribute in the form of an AbstractData object.

public AbstractData getAttributeValue()

Returns the attributeValue.

clone

Returns a clone of this EMTopoNodeUserDatum object.

public Object clone()

Overrides clone in class Object.

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a UserDatum object that contains the same values for attributeName and value.

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same; otherwise false.

Overrides equals in class Object.

compareTo

Compares this EMTopoNodeUserDatum with another object that implements Comparable interface. Order is determined by first lexicographically comparing the attributeName, and then the attribute value if the attributeNames are equal.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is less than the specified object, greater than 0 if this object is greater than the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoNodeUserDatum.

toString

Returns a String representation of the EMTopoNodeUserDatum object.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.49 EMTopoNodeViewDefaultGeoArea Class

public class EMTopoNodeViewDefaultGeoArea

extends Object implements Cloneable, Serializable.

The com.sun.em.api.topology.EMTopoNodeViewDefaultG eoArea class is a holder class for the center and view width (in km) values of EMTopoNode's VIEW_DEFAULT_GEO_AREA attribute. Because this is simply a holder class, the data members are public.

See Also: VIEW_DEFAULT_GEO_AREA, getViewDefaultGeoArea, setViewDefaultGeoArea

4.49.1 Variables

center

The center of the default view for geographical mode.

public EMTopoNodeGeoLocation center

widthInKm

The number of kilometers that should be displayed horizontally from edge-to-edge in the Viewer's Canvas. This variable controls how far zoomed in/out the default view will appear in geographical mode.

public double widthInKm

4.49.2 Constructors

EMTopoNodeViewDefaultGeoArea

Creates an instance of EMTopoNodeViewDefaultGeoArea with the specified center and view width (in km).

public EMTopoNodeViewDefaultGeoArea
(EMTopoNodeGeoLocation center,double widthInKm)

center is the center of the default geographical view.

widthInKm is the number of kilometers that should be displayed horizontally from edge-to-edge in the Viewer's Canvas.

4.49.3 Methods

clone

Returns a clone of this EMTopoNodeViewDefaultGeoArea object.

public Object clone()

equals

Compares this object against the specified object. The result is true if, and only if, the argument is not null and is a EMTopoNodeViewDefaultGeoArea object that contains the same values for center and widthInKm.

public boolean equals(Object obj)

obj is the object to compare with.

Returns true if the objects are the same, otherwise returns false.

Overrides equals in class Object.

toString

Returns a String representation of the EMTopoNodeViewDefaultGeoArea object.

public String toString()

Overrides toString in class Object.

4.50 EMTopoPlatform Class

com.sun.em.api.topology.public class EMTopoPlatform

extends Object

The com.sun.em.api.topology.EMTopoPlatform class represents the Topology API as a whole. Constructors of Persistent Object Classes (POC) and static methods require the EMTopoPlatform as the first argument. More than one EMTopoPlatform can be instantiated and used simultaneously just like Java PMI's Platform. This allows a program to connect directly to two different MISs and access their topology information without setting up MIS to MIS Communication (MMC) between the two.

The EMTopoPlatform provides methods to query which MISs are visible through the connection to the local MIS, and register listeners to be called when MMC is added or removed between the local MIS and another MIS.

4.50.1 Constructors

EMTopoPlatform

Constructs an instance of the EMTopoPlatform class.

public EMTopoPlatform(Platform platform)
throws EMTopoServiceException

platform is PMI Platform class.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

4.50.2 Methods

addEMPlatformConfigListener

Adds the specified listener to the list of objects to be called when MMC (MIS to MIS Communication) is added or removed between the local MIS and another MIS.

public void addEMPlatformConfigListener(
EMPlatformConfigListener listener)
throws EMTopoServiceException

listener is listener of MMC events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMPlatformConfigListener

getLocalSystemName

Returns the name of the MIS that the Topology API is directly connected to.

public String getLocalSystemName() throws 
EMTopoServiceException

Returns the local MIS name.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

getSystemNames

Returns all MIS names that are visible through the connection to the local MIS, including the local MIS name. Note that for an MIS to be visible as a remote MIS through the connection to the local MIS, MMC (MIS to MIS Communication) must be setup between the local MIS and each such MIS. This can be accomplished at the user level with the MIS Manager (em_mismgr) application.

public String[] getSystemNames() throws 
EMTopoServiceException

Returns names of all MISs visible through the connection to the local MIS.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

4.51 removeEMPlatformConfigListener Class

Removes the specified listener from the list of objects to be called when MIS to MIS Communication (MMC) is added or removed between the local MIS and another MIS.

public void removeEMPlatformConfigListener	 
(EMPlatformConfigListener listener)
throws EMTopoServiceException

listener is listener of MMC events.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

See Also: EMPlatformConfigListener

4.52 EMTopoType Class

public class EMTopoType

extends EMObject implements Cloneable

An instance of the com.sun.em.api.topology.EMTopoType class represents a topology type. Every topology node is classified as a particular topology type. The topology types form a hierarchy with the seven base types Array, Bus, Container, Device, Link, Monitor, and Sun with other subtypes derived from them. Beyond the standard persistent object class (POC) methods which allow you to create, delete and compare topology types, the EMTopoType class provides the following additional services:

  • static methods isArray(), isBus(), isContainer(), isDevice(), isMonitor(), isLink() to categorize types by their base types.
  • static method isView() to determine whether topology nodes of the given type are allowed to contain other topology nodes of at least one type.

4.52.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObject
           |
           +----com.sun.em.api.topology.EMTopoType

4.52.2 Constructors

EMTopoType

Constructs an instance of EMTopoType representing a particular topology type.

public EMTopoType(EMTopoPlatform platform, EMTopoTypeDn 
dn)

platform is the Topology API platform.

dn is the unique identifier of the topology type.

4.52.3 Methods

findAllTypes

Returns all topology types located on the local MIS. Note that there is no method to get all the topology types on a remote MIS. A basic assumption is that in a multiple MIS configuration, each MIS will be configured with the exact same set of topology types.

public static EMTopoTypeDn[] findAllTypes(EMTopoPlatform 
platform) 
throws EMTopoServiceException

platform is the Topology API platform.

Returns all topology types located on the local MIS.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

findRootTypes

Returns the root topology types located on the local MIS. Some of the root topology types are EMTopoTypeDn.CONTAINER, EMTopoTypeDn.DEVICE, EMTopoTypeDn.MONITOR, EMTopoTypeDn.LINK. Additional root types can be added, thus the need for this method. Note that there is no method to get the root topology types on a remote MIS. A basic assumption is that in a multiple MIS configuration, each MIS will be configured with the exact same set of topology types.

public static EMTopoTypeDn[] 
findRootTypes(EMTopoPlatform platform)
throws EMTopoServiceException

platform is the Topology API platform.

Returns the root topology types located on the local MIS.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

isContainer

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.CONTAINER; otherwise, returns false.

public static boolean isContainer 	 
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.CONTAINER.

Throws EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isDevice

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.DEVICE; otherwise, returns false.

public static boolean isDevice
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.DEVICE.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isLink

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.LINK; otherwise, returns false.

public static boolean isLink(EMTopoPlatform 
platform,
String
typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.LINK.

Throws :

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isMonitor

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.MONITOR; otherwise, returns false.

public static boolean isMonitor
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.MONITOR.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isArray

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.ARRAY; otherwise, returns false.

public static boolean isArray
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.ARRAY.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isBus

Returns true if the specified type's ALL_BASE_TYPES attribute contains EMTopoTypeDn.BUS; otherwise, returns false.

public static boolean isBus
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the type is a descendent of EMTopoTypeDn.BUS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

isView

Returns true if the specified type's LEGAL_CHILDREN attribute contains at least one type; otherwise, returns false.

public static boolean isView
(EMTopoPlatform platform, String typeName)
throws EMTopoServiceException

platform is the Topology API platform.

Returns true if the topology nodes of this type can contain at least one type of topology nodes.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

NullPointerException if typeName is null.

clearAllAttributes

Clears the cached values for all object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMTopoType.DN attribute which associates the EMTopoType instance with a particular topology type object in the MIS. This method is useful when you want to reuse the EMTopoType instance to access a different topology type object and do not want the previous values to remain in effect.

public void clearAllAttributes()

Overrides clearAllAttributes in class EMObject.

clearSomeAttributes

Clears the cached values for the specified object attributes, resetting them back to their default values (usually null or empty string or 0). This includes the EMTopoType.DN attribute which associates the EMTopoType instance with a particular topology type object in the MIS. This method is useful when you want to reuse a EMTopoType instance to access a different proxy agent object and do not want the previous values to remain in effect.

public void clearSomeAttributes(EMAttributeSet attributes)

attributes is the object attributes whose cached values will be cleared.

Overrides clearSomeAttributes in class EMObject.

clone

Return a clone of this EMTopoType object.

public Object clone()

Overrides clone in class Object.

createWithAllAttributes

Creates a new topology type object in the MIS, storing all active attribute values in the object. Any attribute which was not given a value will take on a default value defined by the GDMO, generally null or empty string. In order for the create to succeed, the following attributes must be set:

EMTopoAttribute.DN

EMTopoTypeAttribute.BASE_TYPE

EMTopoTypeAttribute.LAYER_NAME

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMTopoTypeAttribute.ALL_BASE_TYPES

EMTopoTypeAttribute.SUB_TYPES

public void createWithAllAttributes()
throws EMTopoServiceException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if any of the mandatory attributes are not set: EMTopoAttribute.DN, EMTopoTypeAttribute.BASE_TYPE, and EMTopoTypeAttribute.LAYER_NAME.

Overrides createWithAllAttributes in class EMObject.

createWithSomeAttributes

Creates a new object in the MIS, storing a subset of the active attribute values in the object. Only attributes specified in the parameter attributes will be stored in the new object, and only if the attribute is active, that is it has been given a value. All other attributes will be given a default value defined by the GDMO, generally null or empty string. In order for the create to succeed, the following attributes must be set and must be members of the EMAttributeSet attributes:

EMTopoAttribute.DN

EMTopoTypeAttribute.BASE_TYPE

EMTopoTypeAttribute.LAYER_NAME

The following attributes cannot be set at creation time, and therefore are ignored regardless of whether they have a cached value:

EMTopoTypeAttribute.ALL_BASE_TYPES

EMTopoTypeAttribute.SUB_TYPES

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotCreatableException will be thrown.

public void createWithSomeAttributes(EMAttributeSet 
attributes)
throws EMTopoServiceException

attributes is subset of the EMTopoType's attributes to store in the new object.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the any of the mandatory attributes are not set.

EMAttributeNotCreatableException if attributes contains any attributes which cannot be set at creation time.

Overrides createWithSomeAttributes in class EMObject.

destroy

Deletes the object identified by EMTopoType.DN from the MIS. This is a permanent, non-reversible operation, so some care should be taken when using this method.

public void destroy() throws EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMTopoType.DN does not exist.

Overrides destroy in class EMObject.

differences

Compares this EMTopoType against the specified EMTopoType, and returns the set of attributes for which the EMTopoTypes have different values or null if the EMTopoTypes are equal. If the argument obj is null or not an instance of EMTopoType, then all active attributes of this EMTopoType are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMTopoType but not the other, or if the attribute is active for both EMTopoTypes but the values of the attribute are not equal.

 public EMAttributeSet differences(EMObject obj)

obj is the object to compare against.

Returns the set of attributes for which the EMTopoTypes have different values or null if the EMTopoTypes are equal.

Overrides differences in class EMObject.

differencesSubset

Compares this EMTopoType against the specified EMTopoType, and returns the set of attributes for which the EMTopoTypes have different values or null if the EMTopoTypes are equal. If the argument obj is null or not an instance of EMTopoType, then all active attributes of this EMTopoType are considered to be differences. Otherwise, an attribute has differing values if the attribute is active for one EMTopoType but not the other, or if the attribute is active for both EMTopoTypes but the values of the attribute are not equal.

public EMAttributeSet 
differencesSubset(EMObject obj,EMAttributeSet attributes)

obj is the object to compare against.

attributes is the set of attributes to compare.

Returns the set of attributes for which the EMTopoTypes have different values or null if the EMTopoTypes are equal.

Overrides differencesSubset in class EMObject.

equals

Compares this EMTopoType against the specified object. If the argument obj is null or not an instance of EMTopoType, then the two objects are not equal. Otherwise, if the two EMTopoTypes have the same set of active attributes, and the same value for each active attribute, then the EMTopoTypes are equal.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

equalsSubset

Compares this EMTopoType against the specified object, restricting the equality check to the specified attributes. If the argument obj is null or not an instance of EMTopoType, then the two objects are not equal. Otherwise, if the two EMTopoTypes have the same set of active attributes out of the specified attributes, and the same value for each active attribute, then the EMTopoTypes are equal.

public boolean equalsSubset(EMObject obj, EMAttributeSet 
attributes)

obj is the object to compare against.

attributes is the subset of attributes.

Returns true if the objects are equal, otherwise returns false.

Overrides equalsSubset in class EMObject.

exists

Checks to see if the object identified by EMTopoType.DN exists.

public boolean exists() throws EMTopoServiceException

Returns true if the object exists.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

Overrides exists in class EMObject.

getActiveAttributes

Returns the set of object attributes which have been given a value.

public EMAttributeSet getActiveAttributes()

Returns the set of active attributes.

Overrides getActiveAttributes in class EMObject.

loadAllAttributes

Loads all attributes of the object identified by EMTopoType.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadAllAttributes() throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMTopoType.DN does not exist.

EMAttributeDecodeException if an error occured in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides loadAllAttributes in class EMObject.

loadSomeAttributes

Loads the specified attributes of the object identified by EMTopoType.DN from the MIS into the object's attribute cache. These attributes are now considered to be active and can be retrieved with the appropriate getter methods.

public void loadSomeAttributes(EMAttributeSet attributes) 
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to load from the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMTopoType.DN does not exist.

EMAttributeDecodeException if an error occurred in converting the attribute values received in ASN.1 format into the local cache data format.

Overrides: loadSomeAttributes in class EMObject.

newInstance

Returns a new instance of the EMTopoType class without any attributes set.

public EMObject newInstance()

Returns the new object.

Overrides newInstance in class EMObject.

storeAllAttributes

Stores all attributes into the object identified by EMTopoType.DN. For attributes that have not been given a value by calling load or setter methods, a default value, usually null or empty string or 0, will be stored. Note that the following EMTopoType attributes are read-only and therefore cannot be stored in the MIS:

EMTopoTypeAttribute.BASE_TYPE

EMTopoTypeAttribute.ALL_BASE_TYPES

EMTopoTypeAttribute.SUB_TYPES

These attributes are ignored even if they have cached values.

public void storeAllAttributes() throws 
EMTopoServiceException,
EMUnknownObjectException

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMUnknownObjectException if the object EMTopoType.DN does not exist.

EMAttributeEncodeException if an error occurred in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeAllAttributes in class EMObject.

storeSomeAttributes

Stores the specified attributes into the object identified by EMTopoType.DN. For attributes that have not been given a value by calling load or setter methods, a default value (usually null or empty string or 0) will be stored. Note that the following EMTopoType attributes are read-only and therefore cannot be stored in the MIS:

EMTopoTypeAttribute.BASE_TYPE

EMTopoTypeAttribute.ALL_BASE_TYPES

EMTopoTypeAttribute.SUB_TYPES

If any of these attributes are members of the EMAttributeSet attributes, then an EMAttributeNotStoreableException will be thrown.

public void storeSomeAttributes(EMAttributeSet attributes)
throws EMTopoServiceException, EMUnknownObjectException

attributes is the object attributes to store in the MIS.

Throws:

EMTopoServiceException if there is an internal error in the topology service, or a fault in the communication link to the topology service.

EMAttributeNotSetException if the EMTopoAttribute.DN attribute is not set.

EMAttributeNotStoreableException if attributes contains any attributes which cannot be set at creation time.

EMUnknownObjectException if the object EMTopoAttribute.DN does not exist.

EMAttributeEncodeException if an error occured in converting the attribute values to ASN.1 for transmission to MIS.

Overrides storeSomeAttributes in class EMObject.

addLegalChild

Adds child to the EMTopoTypeAttribute.LEGAL_CHILDREN attribute.

public void addLegalChild(String child)

child is the name of the type to add.

Throws:

EMAttributeNotSetException if the attribute has not been set in the cache.

NullPointerException if child is null.

See Also: LEGAL_CHILDREN

getAllBaseTypes

Returns the EMTopoTypeAttribute.ALL_BASE_TYPES attribute.

public String[] getAllBaseTypes()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: ALL_BASE_TYPES

getBaseType

Returns the EMTopoTypeAttribute.BASE_TYPE attribute.

public String getBaseType()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: BASE_TYPE

getDn

Returns the EMTopoTypeAttribute.DN attribute.

public EMObjectDn getDn()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

Overrides getDn in class EMObject.

See Also: DN

getLayerName

Returns the EMTopoTypeAttribute.LAYER_NAME attribute.

public String getLayerName()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: LAYER_NAME

getLegalChildren

Returns the EMTopoTypeAttribute.LEGAL_CHILDREN attribute.

public String[] getLegalChildren()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: LEGAL_CHILDREN

getSubTypes

Returns the EMTopoTypeAttribute.SUB_TYPES attribute.

public String[] getSubTypes()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: SUB_TYPES

getUserDataAttributeNames

Returns the EMTopoTypeAttribute.USER_DATA_ATTRIBUTE_NAMES< /font> attribute.

public String[] getUserDataAttributeNames()

Returns the attribute value.

Throws EMAttributeNotSetException if the attribute has not been set in the cache.

See Also: USER_DATA_ATTRIBUTE_NAMES

setBaseType

Sets the EMTopoTypeAttribute.BASE_TYPE attribute.

public void setBaseType(String baseType)

baseType is the attribute value.

Throws NullPointerException if baseType is null.

See Also: BASE_TYPE

setDn

Sets the EMTopoAttribute.DN attribute.

public void setDn(EMObjectDn dn)

dn is the attribute value.

Throws:

NullPointerException if dn is null.

ClassCastException if dn is not an instance of EMTopoTypeDn.

Overrides setDn in class EMObject.

See Also: DN

setLayerName

Sets the EMTopoTypeAttribute.LAYER_NAME attribute.

public void setLayerName(String layerName)

layerName is the attribute value.

Throws NullPointerException if layerName is null.

See Also: LAYER_NAME

setUserDataAttributeNames

Sets the EMTopoTypeAttribute.USER_DATA_ATTRIBUTE_NAMES attribute.

public void setUserDataAttributeNames
(String userDataAttributeNames[])

userDataAttributeNames is the attribute value.

Throws NullPointerException if userDataAttributeNames is null.

See Also: USER_DATA_ATTRIBUTE_NAMES

addUserDataAttributeName

Adds the specified userDataAttributeName to the EMTopoTypeAttribute.USER_DATA_ATTRIBUTE_NAMES< /font> attribute.

public void addUserDataAttributeName(String userDataAttributeName)

userDataAttributeName is the attribute value.

See Also: USER_DATA_ATTRIBUTE_NAMES

removeUserDataAttributeName

Removes the specified userDataAttributeName from the EMTopoTypeAttribute.USER_DATA_ATTRIBUTE_NAMES< /font> attribute.

public void removeUserDataAttributeName
(String userDataAttributeName)

userDataAttributeName is the attribute value.

See Also: USER_DATA_ATTRIBUTE_NAMES

toString

Returns a String representation of the EMTopoType.

public String toString()

Returns the String representation.

Overrides toString in class Object.

4.53 EMTopoTypeAttribute Class

public class EMTopoTypeAttribute

extends EMTopoAttribute implements Serializable

The com.sun.em.api.topology.EMTopoTypeAttribute class represents a single attribute of the EMTopoType persistent object class (POC).

4.53.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMObjectAttribute
           |
           +----com.sun.em.api.topology.EMTopoAttribute
                   |
                   
+----com.sun.em.api.topology.EMTopoTypeAttribute

4.53.2 Variables

BASE_TYPE

The name of the base type of this type. For example, for a type Device-Router-XyzRouter, the BASE_TYPE would be Router.

public static final EMTopoTypeAttribute BASE_TYPE

ALL_BASE_TYPES

A list of all the base types of this type. For example, for a type Device-Router-XyzRouter, the list would contain Device, Router.

public static final EMTopoTypeAttribute ALL_BASE_TYPES

SUB_TYPES

The names of all topology types whose BASE_TYPE is this type. For example, for the type hierarchy:

A-B-C, A-B-D, A-B-C-E

The SUB_TYPES of B is C and D but not E.

public static final EMTopoTypeAttribute SUB_TYPES

LEGAL_CHILDREN

List of topology types of topology nodes that topology nodes of this type can contain within the topology node graph. If this list is not empty, then EMTopoType.isView() will evaluate to true for this type.

public static final EMTopoTypeAttribute LEGAL_CHILDREN

LAYER_NAME

Name of the layer that includes topology nodes of this type.

public static final EMTopoTypeAttribute LAYER_NAME

USER_DATA_ATTRIBUTE_NAMES

A list of GDMO attribute names that define the contents of the EMTopoNode.USER_DATA attribute for topology nodes of this type.

public static final EMTopoTypeAttribute
USER_DATA_ATTRIBUTE_NAMES

4.53.3 Methods

toString

Returns a String representation of the EMTopoTypeAttribute.

public String toString()

Returns the String representation.

Overrides toString in class EMTopoAttribute.

4.54 EMTopoTypeAttributeSet Class

public class EMTopoTypeAttributeSet

extends EMAttributeSet implements Cloneable, Serializable

The com.sun.em.api.topology.EMTopoTypeAttributeSet class implements an abstract class that forms the basis for the attributes set classes of each EMTopoType. EMTopoTypeAttributeSet is used in the Topology API to communicate which attributes of a EMTopoType an API method should operate on.

4.54.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.common.EMAttributeSet
           |
           
+----com.sun.em.api.topology.EMTopoTypeAttributeSet

4.54.2 Constructors

EMTopoTypeAttributeSet

Creates an EMTopoTypeAttributeSet which contains no attributes.

public EMTopoTypeAttributeSet()

4.54.3 Methods

clone

Returns a clone of this EMTopoTypeAttributeSet object.

public Object clone()

Overrides clone in class EMAttributeSet .

elements

Returns an enumeration of the attributes in this set.

public Enumeration elements()

Overrides elements in class EMAttributeSet.

4.55 EMTopoTypeDn Class

public final class EMTopoTypeDn

extends EMObjectDn implements Serializable, Comparable

An instance of the com.sun.em.api.topology.EMTopoTypeDn class uniquely identifies a topology type.

4.55.1 Inheritance

 
java.lang.Object
   |
   +----com.sun.em.api.topology.EMObjectDn
           |
           +----com.sun.em.api.topology.EMTopoTypeDn

4.55.2 Variables

CONTAINER

Container type. In the out-of-the-box type hierarchy, the Container type is the base type for most of the topology types whose topology nodes can be containers or views of other nodes. However, any topology type can be made to be a container by modifying the EMTopoType.LEGAL_CHILREN attribute.

public static final String CONTAINER

DEVICE

Device type. In the out-of-the-box type hierarchy, the Device type is the base type for most of the topology types that represent managed devices. In general, these types have an empty attribute, so nodes of these types cannot contain other nodes.

public static final String DEVICE

LINK

Link type. Topology nodes of type Link or of a subtype of Link will be displayed as lines drawn between the two topology nodes specified in the node's LINKS attribute.

public static final String LINK

MONITOR

Monitor type. Topology nodes whose type is a subtype of Monitor act as containers of other nodes. They are drawn with special graphics in the Viewer. Instead of a static icon, Monitors are drawn as circles or hexagons whose middles are divided into 1, 3, 6, or 36 sections. Each section represents one topology node that is contained within the Monitor node. The EMTopoNode attributes MONITOR_ROTATION and MONITOR_VISIBLE_CHILDREN control the appearance of the Monitor in the Viewer. Note that no topology nodes should be created with the base type Monitor; instead, use one of the subtypes OMNISECTOR, HEXAGON, HEXAGON120, or CIRCLE.

public static final String MONITOR

OMNISECTOR

OmniSector type, a subclass of Monitor. An OmniSector Monitor has a hexagon shape with the whole interior representing a single child topology node.

public static final String OMNISECTOR

HEXAGON

Hexagon type, a subclass of Monitor. The Hexagon Monitor has a hexagon shape with the interior divided into six equal sections with each section representing a child topology node.

public static final String HEXAGON

HEXAGON120

Hexagon120 type, a subclass of Monitor. The Hexagon120 Monitor has a hexagon shape with the interior divided into three equal sections with each section representing a child topology node.

public static final String HEXAGON120

CIRCLE

Circle type, a subclass of Monitor. The Circle Monitor has a circular shape with the interior divided dynamically into as many equal sections necessary, up to a maximum of 36, to display each node listed in the node's MONITOR_VISIBLE_CHILDREN attribute.

public static final String CIRCLE

4.55.3 Constructors

EMTopoTypeDn

Creates an EMTopoTypeDn with the specified system name and type name.

public EMTopoTypeDn(String systemName, String 
uniqueName)

systemName is the name of the MIS where the topology type is stored.

uniqueName is the unique name of the topology type within the MIS.

4.55.4 Methods

equals

Compares this object against the specified object. The result is true, if and only if, the argument is not null and is an EMTopoTypeDn object that identifies the same topology type as this object.

public boolean equals(Object obj)

obj is the object to compare against.

Returns true if the objects are equal, otherwise returns false.

Overrides equals in class Object.

compareTo

Compares this EMTopoTypeDn with another object that implements Comparable interface. Order is determined by first lexicographically comparing the system name, and then the unique name if necessary.

public int compareTo(Comparable comparable)

Returns 0 if the objects are identical, less than 0 if this object is 'less than' the specified object, greater than 0 if this object is 'greater than' the specified object.

Throws ClassCastException if the object parameter is not of class EMTopoTypeDn.

getSystemName

Returns the name of the MIS where the topology type is stored.

public String getSystemName()

Returns the MIS name.

Overrides getSystemName in class EMObjectDn.

getUniqueName

Returns the name of the topology type. This name is unique within the MIS.

public String getUniqueName()

Returns the unique name of the topology type.

Overrides getUniqueName in class EMObjectDn.

hashCode

Returns a hashcode for this object.

public int hashCode()

Returns the hashcode.

Overrides hashCode in class Object.

toString

Returns a String representation of the EMTopoTypeDn.

public String toString()

Returns the String representation.

Overrides toString in class Object.


Sun Microsystems, Inc.
Copyright information. All rights reserved.
Doc Set  |   Contents   |   Previous   |   Index