commonj.connector.metadata.discovery
Interface MetadataEdit


public interface MetadataEdit

Top-level interface for editing connection information, InteractionSpec, ConnectionSpec, and adminstered objects. Implementations of this interface are provided by EMD service providers, and are instantiated during the bootstrap process of the tool environment. MetadataEdit may be used by tools for application authoring as well as runtime administration.

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.

Since:
1.0

Method Summary
 EditableType getAdministeredObjectType(String aoClassName)
          Returns an EditableType for editing the specified administered object.
 EditableType getConnectionSpecType(String csClassName)
          Returns a EditableType for editing the specified ConnectionSpec.
 InboundConnectionType getInboundConnectionType(String asClassName)
          Returns a ConnectionType which can be used for editing the ResourceAdapterJava bean and ActivationSpec.
 EditableType getInteractionSpecType(String isClassName)
          Returns an EditableType for editing the specified InteractionSpec.
 OutboundConnectionType getOutboundConnectionType(String mcfClassName)
          Returns an OutboundConnectionType which can be used for editing the ResourceAdapterJava bean, and ManagedConnectionFactory.
 

Method Detail

getInteractionSpecType

EditableType getInteractionSpecType(String isClassName)
                                    throws MetadataException
Returns an EditableType for editing the specified InteractionSpec.

Parameters:
isClassName - The non null fully qualified class name of the desired InteractionSpec.
Returns:
a non null EditableType for the specified InteractionSpec.
Throws:
MetadataException - if an error occurs during execution. This includes conditions when an unsupported isClassName is specified.
See Also:
InteractionSpec

getConnectionSpecType

EditableType getConnectionSpecType(String csClassName)
                                   throws MetadataException
Returns a EditableType for editing the specified ConnectionSpec.

Parameters:
csClassName - The non null fully qualified class name of the desired ConnectionSpec.
Returns:
a non null EditableType for the specified ConnectionSpec.
Throws:
MetadataException - if an error occurs during execution. This includes conditions when an unsupported csClassName is specified.
See Also:
ConnectionSpec

getAdministeredObjectType

EditableType getAdministeredObjectType(String aoClassName)
                                       throws MetadataException
Returns an EditableType for editing the specified administered object.

Parameters:
aoClassName - The non null fully qualified class name of the desired administered object.
Returns:
a non null EditableType for the specified administered object.
Throws:
MetadataException - if an error occurs during execution. This includes conditions when an unsupported aoClassName is specified.
See Also:
"Section 12.4.2 of the J2EE™ Connector Architecture Specification, Version: 1.5"

getOutboundConnectionType

OutboundConnectionType getOutboundConnectionType(String mcfClassName)
                                                 throws MetadataException
Returns an OutboundConnectionType which can be used for editing the ResourceAdapterJava bean, and ManagedConnectionFactory.

Parameters:
mcfClassName - The non null fully qualified class name of the ManagedConnectionFactory.
Returns:
a non null OutboundConnectionType for the specified class.
Throws:
MetadataException - if an error occurs during execution. This includes conditions where the class name is invalid.

getInboundConnectionType

InboundConnectionType getInboundConnectionType(String asClassName)
                                               throws MetadataException
Returns a ConnectionType which can be used for editing the ResourceAdapterJava bean and ActivationSpec.

Parameters:
asClassName - The non null fully qualified class name of the ActivationSpec.
Returns:
a non null InboundConnectionType for the class.
Throws:
MetadataException - if an error occurs during execution. This includes conditions where the class name is invalid.