commonj.connector.metadata.discovery.connection
Interface OutboundConnectionConfiguration

All Superinterfaces:
ConnectionConfiguration

public interface OutboundConnectionConfiguration
extends ConnectionConfiguration

A configuration object representing properties of the outbound connection. The interface extends the ConnectionConfiguration and adds properties specific to the outbound configuration. The added properties are from the ManagedConnectionFactory Java Bean.

All resource adapters supporting outbound connections must implement this interface.

Since:
1.0

Method Summary
 boolean applyManagedConnectionFactoryProperties(PropertyGroup propertyValues)
          Apply values of the properties of the ManagedConnectionFactory to the configuration.
 PropertyGroup createManagedConnectionFactoryProperties()
          Creates a new instance of the properties that are defined for the managed connection factory bean that will be used to support the connections represented by this configuration.
 OutboundConnectionType getOutboundConnectionType()
          Get the outbound connection type associated with this configuration.
 
Methods inherited from interface commonj.connector.metadata.discovery.connection.ConnectionConfiguration
applyResourceAdapterProperties, applyUnifiedProperties, createResourceAdapterProperties, createUnifiedProperties, getConnectionType, getDescription, getName, setDescription, setName
 

Method Detail

getOutboundConnectionType

OutboundConnectionType getOutboundConnectionType()
Get the outbound connection type associated with this configuration.

Returns:
OutboundConnectionType The type of the connection specified by this configuration. The return value must not be null.

createManagedConnectionFactoryProperties

PropertyGroup createManagedConnectionFactoryProperties()
Creates a new instance of the properties that are defined for the managed connection factory bean that will be used to support the connections represented by this configuration.

The value settings of the properties returned must match any values currently applied via a previous call to applyManagedConnectionFactoryProperties(commonj.connector.metadata.discovery.properties.PropertyGroup).

Returns:
PropertyGroup A set of properties of the ManagedConnectionFactory Java Bean. The return value must not be null unless ManagedConnectionFactory Java Bean has no properties.

applyManagedConnectionFactoryProperties

boolean applyManagedConnectionFactoryProperties(PropertyGroup propertyValues)
Apply values of the properties of the ManagedConnectionFactory to the configuration. The PropertyGroup argument should have been created by getManagedConnectionFactoryProperties method. The argument must not be null.

Parameters:
propertyValues - A PropertyGroup containing values of the ManagedConnectionFactory Java Bean properties.
Returns:
Returns true if the applied property values change the connection configuration such that a restart of any associated live connections would be required for the changes to take effect. Returns false if the changes can be applied to a live connection without requiring a re-start.