|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConnectionConfiguration
A configuration object representing properties of the connection. The interface presents two views of the properties, a unified view with all the properties and the per bean view where properties are presented in groups corresponding to the resource adapter beans, ResourceAdatper, ActivationSpec and ManagedConnectionFactory.
The providers of the metadata discovery service implement subinterfaces of the ConnectionConfiguration
specialized for the inbound or outbound configuratin.
InboundConnectionConfiguration
,
OutboundConnectionConfiguration
Method Summary | |
---|---|
boolean |
applyResourceAdapterProperties(PropertyGroup propertyValues)
Apply values to properties of the Resource Adapter. |
boolean |
applyUnifiedProperties(PropertyGroup propertyValues)
Apply values to the unified properties defining this connection. |
PropertyGroup |
createResourceAdapterProperties()
Creates a new instance of the properties associated with the ResourceAdapter JavaBean needed to support connections represented by this configuration. |
PropertyGroup |
createUnifiedProperties()
Get all the properties that define the connection represented by this configuration. |
ConnectionType |
getConnectionType()
Gets the ConnectionType object associated with this configuration. |
String |
getDescription()
A description of the connection configuration. |
String |
getName()
Returns the name associated with this instance of the connection configuration. |
void |
setDescription(String description)
A description of the connection configuration. |
void |
setName(String name)
Sets the name associated with this connection configuration. |
Method Detail |
---|
String getName()
null
.void setName(String name)
null
.
The setter allows to change the default value when the connection is persisted.
The value is persisted in the current locale and later retrieved
using current locale of the tooling environment.
The setter method allows to associate user specifid name with the configuration.
name
- The name to be associated with the connection configuration.
The argument must not be null
.ConnectionType getConnectionType()
OutboundConnectionType.createOutboundConnectionConfiguration()
,
InboundConnectionType.createInboundConnectionConfiguration()
PropertyGroup createResourceAdapterProperties()
The value settings of the properties returned must match any values
currently applied via a previous call to
applyResourceAdapterProperties(commonj.connector.metadata.discovery.properties.PropertyGroup)
.
null
.boolean applyResourceAdapterProperties(PropertyGroup propertyValues)
propertyValues
- A property group containing values of properties to be set on the ResourceAdapter
Java Bean. The PropertyGroup should have been created using getResourceAdapterProperties()
.
The argument must not be null
unless ResourceAdapter Java Bean has no properties.
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.PropertyGroup createUnifiedProperties()
null
unless ResourceAdapter Java Bean and either ManagedConnectionFactory Java Bean
or ActivationSpec Java Bean have no properties.boolean applyUnifiedProperties(PropertyGroup propertyValues)
propertyValues
- A property group containing values of all properties to be set on beans representing
this connection. The PropertyGroup should have been created using getUnifiedProperties()
.
The argument must not be null
.
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.InboundConnectionConfiguration
,
OutboundConnectionConfiguration
String getDescription()
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
ResourceBundle
,
MessageFormat
void setDescription(String description)
This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.
description
- A description of the connection configuration.ResourceBundle
,
MessageFormat
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |