com.ibm.adt.topology.provider
Interface TopologyProvider

All Known Implementing Classes:
TopologyProviderImpl

public interface TopologyProvider

Defines the public interface for a Provider implementation.


Method Summary
 java.lang.String[] getApplicationTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.APPLICATION.
 java.lang.String[] getArtifactTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.ARTIFACT.
 java.lang.String[] getComputerSystemTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.COMPUTER_SYSTEM.
 java.lang.String getId()
          Gets the id associated with the Provider.
 TopologyObject getProviderTopologyObject()
          Get the root TopologyObject instance for the Provider.
 java.lang.String getProviderType()
          Get the TopologyProvider type.
 RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey)
          Get all defined relationships that correspond to specified relationshipKey.
 java.lang.String[] getResourceTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.RESOURCE.
 java.lang.String[] getServerCollectionTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.SERVER_COLLECTION.
 java.lang.String[] getServerTypes()
          Get all registered TopologyObject types that are of supertype TopologyObjectType.SERVER.
 TopologyObject[] getTopologyObjects(java.lang.String objectKey)
          Get all TopologyObject instances that correspond to the given objectKey.
 java.lang.String[] getTopologyObjectTypes()
          Get all registered TopologyObject types.
 void initialize(ProviderInfo info)
          Initializes the provider instance using the specified ProviderInfo.
 void registerTopologyService(TopologyService service)
          Registers this provider instance with the specified service instance.
 boolean setObjectCachingEnabled(boolean enable)
          Controls provider TopologyObject caching.
 boolean setPropertyCachingEnabled(boolean enable)
          Controls provider Property caching.
 void shutdown()
          Shuts down the provider instance.
 void unregisterTopologyService(TopologyService service)
          Unregisters this provider instance with the specified service instance.
 

Method Detail

getProviderTopologyObject

TopologyObject getProviderTopologyObject()
                                         throws TopologyException
Get the root TopologyObject instance for the Provider.

Returns:
the provider's TopologyObject instance
Throws:
TopologyException

getProviderType

java.lang.String getProviderType()
Get the TopologyProvider type.

Returns:
the provider's type

getServerTypes

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

Returns:
an array of object types

getComputerSystemTypes

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

Returns:
an array of object types

getArtifactTypes

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

Returns:
an array of object types

getServerCollectionTypes

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

Returns:
an array of object types

getResourceTypes

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

Returns:
an array of object types

getApplicationTypes

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

Returns:
an array of object types

getTopologyObjectTypes

java.lang.String[] getTopologyObjectTypes()
Get all registered TopologyObject types.

Returns:
an array of object types

getRelationshipsMetaInfo

RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey)
                                                throws TopologyException
Get all defined relationships 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

getTopologyObjects

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

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

initialize

void initialize(ProviderInfo info)
                throws TopologyException
Initializes the provider instance using the specified ProviderInfo.

Parameters:
info - a ProviderInfo object that specifies the initialization parameters.
Throws:
TopologyException

shutdown

void shutdown()
              throws TopologyException
Shuts down the provider instance.

Throws:
TopologyException

registerTopologyService

void registerTopologyService(TopologyService service)
Registers this provider instance with the specified service instance.

Parameters:
service -

unregisterTopologyService

void unregisterTopologyService(TopologyService service)
Unregisters this provider instance with the specified service instance.

Parameters:
service -

getId

java.lang.String getId()
Gets the id associated with the Provider.

Returns:
the provider Id

setObjectCachingEnabled

boolean setObjectCachingEnabled(boolean enable)
Controls provider TopologyObject caching. Used to temporarily disable provider TopologyObject caching if the provider supports it. Method returns the current caching value so that it may be restored to the initial value.

Parameters:
enable -
Returns:
the previous value

setPropertyCachingEnabled

boolean setPropertyCachingEnabled(boolean enable)
Controls provider Property caching. Used to temporarily disable provider Property caching if the provider supports it. Method returns the current caching value so that it may be restored to the initial value.

Parameters:
enable -
Returns:
the previous value


© Copyright 2006 IBM Corp. 2006 All Rights Reserved