|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
TopologyObject getProviderTopologyObject() throws TopologyException
TopologyException
java.lang.String getProviderType()
java.lang.String[] getServerTypes()
java.lang.String[] getComputerSystemTypes()
java.lang.String[] getArtifactTypes()
java.lang.String[] getServerCollectionTypes()
java.lang.String[] getResourceTypes()
java.lang.String[] getApplicationTypes()
java.lang.String[] getTopologyObjectTypes()
RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey) throws TopologyException
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
TopologyException
TopologyObject[] getTopologyObjects(java.lang.String objectKey) throws TopologyException
objectKey
- in the form of
"objectType::objectName/objectType::objectName/..."
TopologyException
void initialize(ProviderInfo info) throws TopologyException
info
- a ProviderInfo object that specifies the initialization
parameters.
TopologyException
void shutdown() throws TopologyException
TopologyException
void registerTopologyService(TopologyService service)
service
- void unregisterTopologyService(TopologyService service)
service
- java.lang.String getId()
boolean setObjectCachingEnabled(boolean enable)
enable
-
boolean setPropertyCachingEnabled(boolean enable)
enable
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |