commonj.connector.metadata.build
Interface MetadataBuild

All Superinterfaces:
MetadataService

public interface MetadataBuild
extends MetadataService

Top-level interface for building service description facilities. Implementations of this interface are provided by build service providers, and are instantiated during the bootstrap process in the tool environment. MetadataBuild may be used by tools dedicated to both design-time and admin-time activities. Using implementations of this interface, tool environments can build 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 ConnectionType will change state.

Since:
1.1

Method Summary
 FunctionBuilder createFunctionBuilder(String functionSelector)
          Create functionBuilder based on set ConnectionTypeID.
 SchemaDefinition[] getCommonSchemas(QName type)
          Allows tooling to obtain the definition for a complex type that is supplied by the adapter.
 QName[] getCommonSchemaTypes()
          Returns an array of QName of the global complex types that are provided by this adapter.
 String[] getConnectionSpecClassName()
          Return the list of ConnectionSpecs that can be used with the set connectionType.
 String getDefaultDataBinding()
          Return a fully qualified class name for a default DataBinding that can be used with the service.
 String getDefaultFunctionSelector()
          Return a fully qualified class name for the default FunctionSelector that can be used with the set inbound connectionType.
 InteractionSpec getDefaultInteractionSpec()
          Return a new default instance of the InteractionSpec that can be used with the set outbound connectionType.
 String[] getListenerClassName()
          Return the list of listener interfaces that can be used with the set inbound connectionType.
 void setConnectionType(String connectionTypeID)
          Set the connectionType to be used when building the service.
 
Methods inherited from interface commonj.connector.metadata.MetadataService
getAdapterType, getAdapterTypeSummaries, getConfiguration, getSupportedConfiguration, setConfiguration, setToolContext
 

Method Detail

setConnectionType

void setConnectionType(String connectionTypeID)
Set the connectionType to be used when building the service.

Parameters:
connectionTypeID - the selected connectionType to be used when building the service.

getDefaultInteractionSpec

InteractionSpec getDefaultInteractionSpec()
Return a new default instance of the InteractionSpec that can be used with the set outbound connectionType. The tooling will use this to populate the FunctionDescription that is being built.

Returns:
a new instance of the adapters InteractionSpec that can be used with the set outbound connectionType.

getDefaultFunctionSelector

String getDefaultFunctionSelector()
Return a fully qualified class name for the default FunctionSelector that can be used with the set inbound connectionType. The tooling will use this to populate the ServiceDescription that is being built.

Returns:
a fully qualified className of the adapters FunctionSelector that can be used with the set inbound connectionType, or null if one is not provided by the adapter.

getDefaultDataBinding

String getDefaultDataBinding()
Return a fully qualified class name for a default DataBinding that can be used with the service. The tooling can use this to populate the ServiceDescription that is being built.

Returns:
a fully qualified className of the adapters DataBinding that can be used with the service, or null if one is not provided by the adapter.

createFunctionBuilder

FunctionBuilder createFunctionBuilder(String functionSelector)
Create functionBuilder based on set ConnectionTypeID.

Parameters:
functionSelector - is the fully qualified className of the the functionSelector specified on the InboundServiceDescription, or null if a functionSelector has not been specified or if this is for an outbound function.
Returns:
FunctionBuilder based on the set connectionTypeID.

getConnectionSpecClassName

String[] getConnectionSpecClassName()
Return the list of ConnectionSpecs that can be used with the set connectionType. This can be used to support the application passing connection specific properties.

Returns:
an array of ConnectionSpecs that can be used with the set connectionType.

getListenerClassName

String[] getListenerClassName()
Return the list of listener interfaces that can be used with the set inbound connectionType. The listener interface is the entry point for inbound notifications and EIS-initiated request-response entry points.

Returns:
an array of fully qualified class names of the listener interfaces supported by the adapter.
See Also:
InboundListener

getCommonSchemaTypes

QName[] getCommonSchemaTypes()
Returns an array of QName of the global complex types that are provided by this adapter.

Returns:
the array of names of the global complex types that are provided by this adapter.

getCommonSchemas

SchemaDefinition[] getCommonSchemas(QName type)
Allows tooling to obtain the definition for a complex type that is supplied by the adapter. This type can be specified in a DataDefinition when FunctionBuilder.updateFunctionBuilder(FunctionDescription) is invoked.

Parameters:
type - specifies the QName of the global complex type.
Returns:
an array of SchemaDefinition containing the definition of the specified global complex type.