|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataDiscovery
Top-level interface for metadata discovery facilities. Implementations of this interface are provided by metadata discovery service providers, and are instantiated during the bootstrap process in the tool environment. MetadataDiscovery may be used by tools dedicated to both design-time and admin-time activities. Using implementations of this interface, tool environments can discover the types of resources that can be exposed into the tool environment, the types of connections that can be established to those resources, and the objects those resources contain or provide.
Implementations of this interface must have a default constructor so that tool environments are able to create instances of it during the bootstrap process. Implementations must be thread compatible (not thread-safe), as they may run in a threaded environment. Thread compatible requires that if a unique instance is used in each thread then correct behaviour is observed. Also, if the tool synchronizes calls to the methods then correct behaviour is observed except when internal state is changed. Setting the Configuration and ToolContext will change state.
Method Summary | |
---|---|
ServiceDescription |
createServiceDescription(MetadataSelection importSelection)
Creates a ServiceDescription representing the objects configured in the given MetadataSelection. |
MetadataTree |
getMetadataTree(MetadataConnection conn)
Obtain an instance of the MetadataTree that is to be used to
access objects in the metadata repository of an EIS (as accessed through
MetadataConnection). |
Methods inherited from interface commonj.connector.metadata.MetadataService |
---|
getAdapterType, getAdapterTypeSummaries, getConfiguration, getSupportedConfiguration, setConfiguration, setToolContext |
Method Detail |
---|
MetadataTree getMetadataTree(MetadataConnection conn) throws MetadataException
MetadataTree
that is to be used to
access objects in the metadata repository of an EIS (as accessed through
MetadataConnection). The MetadataTree is used to traverse objects in the
metadata tree, and select them for import into a service description.
This method is the starting point for tool environments to begin browsing the metadata offered by an EIS.
conn
- a non null
MetadataConnection. This connection
is used to populate the MetadataObjects in the MetadataTree.
null
MetadataTree instance.
MetadataException
- is thrown if any error occurs during execution.createServiceDescription(MetadataSelection)
,
OutboundConnectionType.openMetadataConnection(commonj.connector.metadata.discovery.connection.OutboundConnectionConfiguration)
ServiceDescription createServiceDescription(MetadataSelection importSelection) throws MetadataException
The ServiceDescription returned must be complete in the sense that all its contents are available immediately. All the getter methods to retrieve the various information from the ServiceDescription must behave as simple accessors, and not do any excessive computation or establish physical communication with the EIS.
Tool environments are responsible for generating meaningfull artifacts from the returned ServiceDescription. For example, a tool may generate Java proxies to invoke the functions defined in the ServiceDescription. If a tool wishes to modify existing artifacts generated from a past ServiceDescription instance, they should re-establish the metadata connection that was used to obtain the original ServiceDescription. The tool should then follow the same path of selection parameters and MetadataTree navigation in order to create the ServiceDescription again, while modifying the selection values according to how the new ServiceDescription should differ from the old one. Once the selection is complete this method is called again and the tool environment is then responsible for merging the new ServiceDescription with the old one, or the artifacts generated from the old one.
importSelection
- a non null
MetadataSelection object
representing the selected metadata from which the service
description will be created from.
null
ServiceDescription
representing the selected metadata.
MetadataException
- is thrown if any error occurs during execution.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |