|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OutboundConnectionType
Describes a specific type of the outbound connection within the metadata discovery service. A connection type defines the properties needed to obtain a connection of this type as well as other key information about the connection type.
All resource adapters supporting outbound connections must implement this interface.
Nested Class Summary | |
---|---|
static interface |
OutboundConnectionType.OutboundConnectionBeans
Represents the JavaBean instances needed to support the outbound communication to an adapter, a runtime representation of the outbound connection configuration. |
Method Summary | |
---|---|
OutboundConnectionType.OutboundConnectionBeans |
createOutboundConnectionBeans()
Creates a new OutboundConnectionBeans instance which has new default instances of the ResourceAdapter and ManagedConnectionFactory Java Beans for this OutboundConnectionType. |
OutboundConnectionConfiguration |
createOutboundConnectionConfiguration()
Creates a new ConnectionConfiguration instance. |
boolean |
isSupportedAtRuntime()
Indicates if this type of connection is valid for use at runtime to execute functions on a service. |
boolean |
isSupportedInMetadataService()
Indicates if this type of connection is valid for use in creating a MetadataConnection. |
MetadataConnection |
openMetadataConnection(OutboundConnectionConfiguration connectionConfiguration)
Establish a connection for the connection type with the given Connection Configuration. |
void |
synchronizeFromManagedConnectionFactoryToPropertyGroup(ManagedConnectionFactory bean,
PropertyGroup pg)
Synchronizes from the ManagedConnectionFactory to the PropertyGroup. |
void |
synchronizeFromOutboundBeansToUnifiedPropertyGroup(OutboundConnectionType.OutboundConnectionBeans outboundConnectionBeans,
PropertyGroup pg)
Synchronizes from the outbound connection beans to the unified outbound connection PropertyGroup. |
void |
synchronizeFromPropertyGroupToManagedConnectionFactory(PropertyGroup pg,
ManagedConnectionFactory bean)
Synchronizes from the PropertyGroup to the ManagedConnectionFactory. |
void |
synchronizeFromUnifiedPropertyGroupToBeans(PropertyGroup pg,
OutboundConnectionType.OutboundConnectionBeans outboundConnectionBeans)
Synchronizes from the unified outbound connection PropertyGroup to the provided outbound connection beans. |
Methods inherited from interface commonj.connector.metadata.discovery.connection.ConnectionType |
---|
getAdapterType, getConnectionPersistence, getDescription, getDisplayName, getId, isConnectionConfigurationComplete, synchronizeFromPropertyGroupToResourceAdapter, synchronizeFromResourceAdapterToPropertyGroup |
Method Detail |
---|
OutboundConnectionConfiguration createOutboundConnectionConfiguration()
The populated ConnectionConfiguration may be used later in a call to openMetadataConnection() or persisted for reuse by using the ConnectionPersistence interface.
null
.ConnectionType.getConnectionPersistence()
,
MetadataEdit
MetadataConnection openMetadataConnection(OutboundConnectionConfiguration connectionConfiguration) throws MetadataException
connectionConfiguration
- The configuration information needed to
establish the connection. The argument must not be null
.
null
.
MetadataException
- if an error occured during executionboolean isSupportedAtRuntime()
true
if the connection can be used at runtime and false
otherwise.boolean isSupportedInMetadataService()
true
if this connection type can be used for the metadata discovery
service, false
otherwisevoid synchronizeFromOutboundBeansToUnifiedPropertyGroup(OutboundConnectionType.OutboundConnectionBeans outboundConnectionBeans, PropertyGroup pg) throws MetadataException
outboundConnectionBeans
- The outbound connection beans.pg
- PropertyGroup populated from the bean, which provides rich
editing for a unified view of the outbound connection.
MetadataException
- if any error occured.PropertyGroup
void synchronizeFromUnifiedPropertyGroupToBeans(PropertyGroup pg, OutboundConnectionType.OutboundConnectionBeans outboundConnectionBeans) throws MetadataException
pg
- The unified outbound connection PropertyGroup which has user interface updates.outboundConnectionBeans
- The targeted outbound connection beans which will be updated from values in the PropertyGroup.
MetadataException
- if any error occured.PropertyGroup
void synchronizeFromManagedConnectionFactoryToPropertyGroup(ManagedConnectionFactory bean, PropertyGroup pg) throws MetadataException
bean
- The source ManagedConnectionFactory.pg
- The target PropertyGroup.
MetadataException
- if any error occured.PropertyGroup
void synchronizeFromPropertyGroupToManagedConnectionFactory(PropertyGroup pg, ManagedConnectionFactory bean) throws MetadataException
pg
- The source PropertyGroup which has user interface updates.bean
- The target ManagedConnectionFactory.
MetadataException
- if any error occured.PropertyGroup
OutboundConnectionType.OutboundConnectionBeans createOutboundConnectionBeans()
null
for the getResourceAdapterJavaBean() method.
null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |