com.ibm.adt.topology
Class TopologyService

java.lang.Object
  extended by com.ibm.adt.topology.TopologyService

public final class TopologyService
extends java.lang.Object

Implements public interfaces for calling TopologyService services. Establishes a context for queries that can be used to scope searches for configuration artifacts to only those TopologyProvider instances that are registered with the TopologyService instance.


Constructor Summary
TopologyService()
          Internal use only.
 
Method Summary
 void destroy()
          Destroys this TopologyService instance.
 java.lang.String[] getApplicationTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.APPLICATION.
 java.lang.String[] getArtifactTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.ARTIFACT.
 java.lang.String[] getComputerSystemTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.COMPUTER_SYSTEM.
 TopologyObject[] getProviderTopologyObjects()
          Get the root TopologyObject instances for all registered providers.
 java.util.List getRegisteredProviders()
          Get all registered TopologyProvider instances.
 java.lang.String[] getRegisteredProviderTypes()
          Get all registered TopologyProvider types.
 RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey)
          Get all defined relationships from all registered providers that correspond to specified relationshipKey.
 java.lang.String[] getResourceTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.RESOURCE.
 java.lang.String[] getServerCollectionTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.SERVER_COLLECTION.
 java.lang.String[] getServerTypes()
          Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.SERVER.
 TopologyObject[] getTopologyObjects(java.lang.String objectKey)
          Get all TopologyObject instances from all registered providers that correspond to the given objectKey.
 void registerTopologyProvider(TopologyProvider provider)
          Unregisters a TopologyProvider instance with this TopologyService instance.
 void unregisterTopologyProvider(TopologyProvider provider)
          Registers a TopologyProvider instance with this TopologyService instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TopologyService

TopologyService()
Internal use only.

Method Detail

getProviderTopologyObjects

public TopologyObject[] getProviderTopologyObjects()
                                            throws TopologyException
Get the root TopologyObject instances for all registered providers.

Returns:
all known TopologyObject instances of supertype TopologyObjectType.PROVIDER
Throws:
TopologyException

getTopologyObjects

public TopologyObject[] getTopologyObjects(java.lang.String objectKey)
                                    throws TopologyException
Get all TopologyObject instances from all registered providers that correspond to the given objectKey.

Parameters:
objectKey - in the form of "objectType::objectName/objectType::objectName/..."
Returns:
an array of TopologyObject(s)
Throws:
TopologyException

getRelationshipsMetaInfo

public RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey)
                                                throws TopologyException
Get all defined relationships from all registered providers that correspond to specified relationshipKey.

Parameters:
relationshipKey - in the form of "key=value::key=value::..." where key can be any of the following: relationshipType, sourceType, label, targetType, isCrossProvider, sourceRole, targetRole, navigable, uniqueId
Returns:
an array of RelationshipMetaInfo objects
Throws:
TopologyException

getRegisteredProviderTypes

public java.lang.String[] getRegisteredProviderTypes()
Get all registered TopologyProvider types.

Returns:
an array of provider types

getServerTypes

public java.lang.String[] getServerTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.SERVER.

Returns:
an array of object types

getComputerSystemTypes

public java.lang.String[] getComputerSystemTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.COMPUTER_SYSTEM.

Returns:
an array of object types

getArtifactTypes

public java.lang.String[] getArtifactTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.ARTIFACT.

Returns:
an array of object types

getServerCollectionTypes

public java.lang.String[] getServerCollectionTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.SERVER_COLLECTION.

Returns:
an array of object types

getResourceTypes

public java.lang.String[] getResourceTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.RESOURCE.

Returns:
an array of object types

getApplicationTypes

public java.lang.String[] getApplicationTypes()
Get all registered TopologyObject types from all registered providers that are of supertype TopologyObjectType.APPLICATION.

Returns:
an array of object types

registerTopologyProvider

public void registerTopologyProvider(TopologyProvider provider)
                              throws TopologyException
Unregisters a TopologyProvider instance with this TopologyService instance.

Parameters:
provider -
Throws:
TopologyException

unregisterTopologyProvider

public void unregisterTopologyProvider(TopologyProvider provider)
                                throws TopologyException
Registers a TopologyProvider instance with this TopologyService instance.

Parameters:
provider -
Throws:
TopologyException

getRegisteredProviders

public java.util.List getRegisteredProviders()
Get all registered TopologyProvider instances.

Returns:
a Collection of TopologyProvider instances

destroy

public void destroy()
Destroys this TopologyService instance.



© Copyright 2006 IBM Corp. 2006 All Rights Reserved