commonj.connector.metadata.discovery.connection
Interface InboundConnectionConfiguration

All Superinterfaces:
ConnectionConfiguration

public interface InboundConnectionConfiguration
extends ConnectionConfiguration

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

All resource adapters supporting inbound connections must implement this interface.

Since:
1.0

Method Summary
 boolean applyActivationSpecProperties(PropertyGroup propertyValues)
          Apply values of the properties of the ActivationSpec to the configuration.
 PropertyGroup createActivationSpecProperties()
          Creates a new instance of the properties that are defined for the ActivationSpec java bean that will be used to support the connections represented by this configuration.
 InboundConnectionType getInboundConnectionType()
          Get the inbound 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

getInboundConnectionType

InboundConnectionType getInboundConnectionType()
Get the inbound connection type associated with this configuration.

Returns:
InboundConnectionType The connection type that created this configuration. The implementation must not return null.

createActivationSpecProperties

PropertyGroup createActivationSpecProperties()
Creates a new instance of the properties that are defined for the ActivationSpec java 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 applyActivationSpecProperties(commonj.connector.metadata.discovery.properties.PropertyGroup).

Returns:
PropertyGroup A set of properties of the ActivationSpec java bean. The implementation must not return null unless ActivationSpec Java Bean has no properties.

applyActivationSpecProperties

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

Parameters:
propertyValues - The PropertyGroup holding ActivationSpec values to be set on the configuration.
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.