commonj.connector.metadata.discovery.connection
Interface InboundConnectionType

All Superinterfaces:
ConnectionType

public interface InboundConnectionType
extends ConnectionType

Describes a specific type of inbound connection. It defines the properties needed to obtain a connection of this type as well as other key information about the connection.

All resource adapters supporting inbound connections must implement this interface.

Since:
1.0

Nested Class Summary
static interface InboundConnectionType.InboundConnectionBeans
          Represents the JavaBean instances needed to support inbound communication, a runtime representation of the inbound connection configuration.
 
Method Summary
 InboundConnectionType.InboundConnectionBeans createInboundConnectionBeans()
          Creates a new InboundConnectionBeans instance which has new default instances of the ResourceAdapter and ActivationSpec Java Beans for this InboundConnectionType.
 InboundConnectionConfiguration createInboundConnectionConfiguration()
          Creates a new InboundConnectionConfiguration instance.
 void synchronizeFromActivationSpecToPropertyGroup(ActivationSpec bean, PropertyGroup pg)
          Synchronizes from the ActivationSpec to the PropertyGroup.
 void synchronizeFromInboundBeansToUnifiedPropertyGroup(InboundConnectionType.InboundConnectionBeans inboundConnectionBeans, PropertyGroup pg)
          Synchronizes from the inbound connection beans to the unified inbound connection PropertyGroup.
 void synchronizeFromPropertyGroupToActivationSpec(PropertyGroup pg, ActivationSpec bean)
          Synchronizes from the PropertyGroup to the ActivationSpec.
 void synchronizeFromUnifiedPropertyGroupToBeans(PropertyGroup pg, InboundConnectionType.InboundConnectionBeans inboundConnectionBeans)
          Synchronizes from the unified inbound connection PropertyGroup to the provided inbound connection beans.
 
Methods inherited from interface commonj.connector.metadata.discovery.connection.ConnectionType
getAdapterType, getConnectionPersistence, getDescription, getDisplayName, getId, isConnectionConfigurationComplete, synchronizeFromPropertyGroupToResourceAdapter, synchronizeFromResourceAdapterToPropertyGroup
 

Method Detail

createInboundConnectionConfiguration

InboundConnectionConfiguration createInboundConnectionConfiguration()
Creates a new InboundConnectionConfiguration instance. Properties needed to configure connections of this type are provided in the returned configuration instance. Tools should set the values for these properties directly into the InboundConnectionConfiguration instance. This instance may then be used for persistence and reuse through the ConnectionPersistence interface.

Returns:
InboundConnectionConfiguration A configuration object describing the inbound connection. The return value must not be null.
See Also:
ConnectionType.getConnectionPersistence()

synchronizeFromInboundBeansToUnifiedPropertyGroup

void synchronizeFromInboundBeansToUnifiedPropertyGroup(InboundConnectionType.InboundConnectionBeans inboundConnectionBeans,
                                                       PropertyGroup pg)
                                                       throws MetadataException
Synchronizes from the inbound connection beans to the unified inbound connection PropertyGroup.

Parameters:
inboundConnectionBeans - The inbound connection beans.
pg - PropertyGroup populated from the bean, which provides rich editing for a unified view of the inbound connection.
Throws:
MetadataException - if any error occured.
See Also:
PropertyGroup

synchronizeFromUnifiedPropertyGroupToBeans

void synchronizeFromUnifiedPropertyGroupToBeans(PropertyGroup pg,
                                                InboundConnectionType.InboundConnectionBeans inboundConnectionBeans)
                                                throws MetadataException
Synchronizes from the unified inbound connection PropertyGroup to the provided inbound connection beans.

Parameters:
pg - The unified inbound connection PropertyGroup which has user interface updates.
inboundConnectionBeans - The inbound connection beans which will be updated from values in the PropertyGroup.
Throws:
MetadataException - if any error occured.
See Also:
PropertyGroup

synchronizeFromActivationSpecToPropertyGroup

void synchronizeFromActivationSpecToPropertyGroup(ActivationSpec bean,
                                                  PropertyGroup pg)
                                                  throws MetadataException
Synchronizes from the ActivationSpec to the PropertyGroup.

Parameters:
bean - The source ActivationSpec.
pg - The target PropertyGroup.
Throws:
MetadataException - if any error occured.
See Also:
PropertyGroup

synchronizeFromPropertyGroupToActivationSpec

void synchronizeFromPropertyGroupToActivationSpec(PropertyGroup pg,
                                                  ActivationSpec bean)
                                                  throws MetadataException
Synchronizes from the PropertyGroup to the ActivationSpec.

Parameters:
pg - The source PropertyGroup which has user interface updates.
bean - The target ActivationSpec.
Throws:
MetadataException - if any error occured.
See Also:
PropertyGroup

createInboundConnectionBeans

InboundConnectionType.InboundConnectionBeans createInboundConnectionBeans()
Creates a new InboundConnectionBeans instance which has new default instances of the ResourceAdapter and ActivationSpec Java Beans for this InboundConnectionType.

Returns:
InboundConnectionBeans The runtime representation of the inbound connection. The return value must not be null.