Configuring JDBC/ODBC Adapter Environment
Properties
This task describes how to set the environment properties of the JDBC/ODBC
Adapter.
The Adapter Environment Configuration properties contain parameters
that define how the adapter connects to and interacts with other Sun Enterprise
Service Bus components within the Environment. When you create a new JDBC
External System, you may configure the type of External System required.
Available External System properties include:
To Configure the Environment Properties
-
In Enterprise Explorer, click the Environment Explorer tab.
-
Expand the Environment created for the JDBC Project and locate
the JDBC External System.
-
Right-click the External System created for the JDBC Project and
select Properties from the list box. The Environment Configuration Properties
window appears.
-
Click on any folder to display the default configuration properties
for that section.
-
Click on any property field to make it editable.
-
After modifying the configuration properties, click OK to save the changes.
JDBC Adapter Environment Properties
Adapter External System properties must be configured from within the
Environment. Until you have successfully configured all adapters for your
Java CAPS project, your project cannot be properly executed. The following
list identifies the JDBC Adapter properties. There are four adapter connection
types that the JDBC/ODBC Adapter implements.
Inbound JDBC Adapter Properties
Before deploying your adapter, you will need to set the Environment
properties. The Inbound JDBC Adapter includes the following configuration
section:
Details for the Inbound JDBC Adapter Parameter Settings are listed in
the following table.
Table 54 Inbound JDBC Adapter—Parameter
Settings
|
Name
|
Description
|
Required Value
|
|
Description
|
The description of the database.
|
A valid string.
|
|
ClassName
|
Displays the Java class in the JDBC driver that is used to implement
the Driver Manager interface. Change this as needed for your driver.
|
A valid class name.
See the JDBC/ODBC Drivers section for some of the popular drivers you
can use with this adapter.
|
|
URL
|
This is the JDBC URL required to gain access to the database. The URL
usually starts with jdbc; followed by <subprotocol>
and ends with information that identifies the data source, as follows:
jdbc:<driver>:<data-source-name>[;<attribute-name>=<attribute-value>]
If you do not select URL in the connection method this
parameter is ignored. For more information on the JDBC URL, please consult
the documentation of your specific driver.
|
The applicable JDBC URL.
See the JDBC/ODBC Drivers section for some of the popular drivers you
can use with this adapter.
|
|
User
|
Specifies the user name the adapter uses to connect to the database.
|
Any valid string.
|
|
Password
|
Specifies the password used to access the database.
|
Any valid string.
|
Outbound JDBC Adapter Properties
The Outbound JDBC Adapter includes the following configuration sections:
JDBC Connector Settings
Details for the JDBC Connector Settings used by the external database
are detailed in the following table.
Table 55 Outbound JDBC Adapter—JDBC Connector
Settings
|
Name
|
Description
|
Required Value
|
|
Description
|
The description of the database.
|
A valid string. The configured default is JDBC
Connection Pool Datasource.
|
|
ClassName
|
Specifies the Java class in the JDBC driver that is used to implement the ConnectionPoolDataSource, XADataSource interface.
Change as needed for your driver.
|
A valid class name.
For example:
com.ibm.as400.access.AS400JDBC
ConnectionPoolDataSource
See the JDBC/ODBC Drivers section for some of the popular drivers you
can use with this adapter.
|
|
ClassNamefor
OtherInterfaces
|
For components such as eTL that do not use ConnectionPoolDataSource, use this entry to enter the name of the driver class. This entry
is not used by the JDBC Adapter.
|
A valid class name.
|
|
ServerName
|
This setting specifies the host name of the external database server.
|
Any valid string.
|
|
PortNumber
|
Specifies the I/O port number on which the server is listening for connection
requests.
|
A valid port number.
|
|
DatabaseName
|
Specifies the name of the database instance.
|
Any valid string.
|
|
User
|
Specifies the user name the adapter uses to connect to the database.
|
Any valid string.
|
|
Password
|
Specifies the password used to access the database.
|
Any valid string.
|
|
DriverProperties
|
The Connection Pool DataSource implementation may need to execute additional
methods to assure a successful run. The additional methods will need to be
identified in the Driver Properties. You must ensure that the driver is installed
on both the app server machine and Java CAPS IDE.
|
Set the driver properties according to driver vendor’s instruction.
For example:
setDefTdpName#DBSQL##setWorkspace#Navigator##
|
|
Delimiter
|
This is the delimiter character to be used in the DriverProperties prompt.
|
The default is #.
|
|
DataSource
name
|
Specifies the name of the XADataSource or ConnectionPoolDataSource implementation, to which
the DataSource object delegates behind the scenes when there is connection
pooling or distributed transaction management being done.
|
The name of the XADataSource or ConnectionPoolDataSource implementation.
This property is Optional, in most cases, leave this box empty.
|
|
MinPoolSize
|
Specifies the minimum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
The pool size you set depends on the transaction volume and response
time of the application. If the pool size is too big, you may end up with
too many connections with the database.
|
A valid numeric value. The default is 0.
|
|
MaxPoolSize
|
Specifies the maximum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
If the pool size is too big, you may end up with too many connections
with the database. The pool size depends on the transaction volume and response
time.
|
A valid numeric value. The default is 10.
|
|
MaxIdleTime
|
Specifies the maximum number of seconds that a physical connection may
remain unused before it is closed. 0 (zero) indicates that there is no limit.
|
A valid numeric value. The default is 0.
|
Connection Retry Settings
Details for the Connection Retry Settings used by the external database
are detailed in the following table.
Table 56 Outbound JDBC Adapter—Connection
Retry Settings
|
Name
|
Description
|
Required Value
|
|
ConnectionRetries
|
Specifies the number of retries to establish a connection upon failure
to acquire one.
|
A valid numeric value. The default is 0.
|
|
ConnectionRetryInterval
|
Specifies the milliseconds of pause before each attempt to reaccess
the database. This setting is used in conjunction with the ’Connection
Retries’ setting.
For example: In the event that the adapter cannot connect to the Database,
the adapter will try to reconnect to the database 10 times in 5 seconds apart
when the Connection Retries is 10 and the Connection Retry Interval is 5000
|
A valid numeric value. The default is 1000.
|
Outbound non-Transactional JDBC Adapter Properties
The Outbound non-Transactional JDBC Adapter includes the following configuration
sections:
JDBC Connector Settings
Details for the JDBC Connector Settings used by the external database
are detailed in the following table.
Table 57 Outbound non-Transactional Adapter—
JDBC Connector Settings
|
Name
|
Description
|
Required Value
|
|
Description
|
The description of the database.
|
A valid string. The configured default is JDBC
non-Transactional Connection Pool Datasource.
|
|
ClassName
|
Specifies the Java class in the JDBC driver that is used to implement the ConnectionPoolDataSource/XADataSource interface.
Change as needed for your driver.
|
A valid class name.
For example:
com.ddtek.jdbcx.sequelink.SequeLinkDataSource.
|
|
ClassNamefor
OtherInterfaces
|
For components that do not use ConnectionPoolDataSource, use this entry to enter the name of the driver class. This class
will not be used by the adapter.
|
A valid class name.
|
|
ServerName
|
This setting specifies the host name of the external database server.
|
Any valid string.
|
|
PortNumber
|
Specifies the I/O port number on which the server is listening for connection
requests.
|
A valid port number.
|
|
DatabaseName
|
Specifies the name of the database instance.
|
Any valid string.
|
|
User
|
Specifies the user name the adapter uses to connect to the database.
|
Any valid string.
|
|
Password
|
Specifies the password used to access the database.
|
Any valid string.
|
|
DriverProperties
|
The Connection Pool DataSource implementation may need to execute additional
methods to assure a successful run. The additional methods will need to be
identified in the Driver Properties. You must ensure that the driver is installed
on both the app server machine and Java CAPS IDE.
|
Set the driver properties according to driver vendor’s instruction.
For example:
setDefTdpName#DBSQL##set
Workspace#Navigator##
|
|
Delimiter
|
This is the delimiter character to be used in the DriverProperties prompt.
|
The default is #.
|
|
DataSource
name
|
Specifies the name of the XADataSource or ConnectionPoolDataSource implementation, to which
the DataSource object delegates behind the scenes when there is connection
pooling or distributed transaction management being done.
|
The name of the XADataSource or ConnectionPoolDataSource implementation. This property
is Optional. In most cases, leave this box empty.
|
|
MinPoolSize
|
Specifies the maximum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
The pool size you set depends on the transaction volume and response
time of the application. If the pool size is too big, you may end up with
too many connections with the database.
|
A valid numeric value. The default is 0.
|
|
MaxPoolSize
|
Specifies the maximum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
If the pool size is too big, you may end up with too many connections
with the database. The pool size depends on the transaction volume and response
time.
|
A valid numeric value. The default is 10.
|
|
MaxIdleTime
|
Specifies the maximum number of seconds that a physical connection may
remain unused before it is closed. 0 (zero) indicates that there is no limit.
|
A valid numeric value. The default is 0.
|
Connection Retry Settings
Details for the Connection Retry Settings used by the external database
are detailed in the following table.
Table 58 Outbound non-Transactional Adapter—Connection
Retry Settings
|
Name
|
Description
|
Required Value
|
|
ConnectionRetries
|
Specifies the number of retries to establish a connection upon failure
to acquire one.
|
A valid numeric value. The default is 0.
|
|
ConnectionRetryInterval
|
Specifies the milliseconds of pause before each attempt to reaccess
the database. This setting is used in conjunction with the ’Connection
Retries’ setting.
For example: In the event that the adapter cannot connect to the Database,
the adapter will try to reconnect to the database 10 times in 5 seconds apart
when the Connection Retries is 10 and the Connection Retry Interval is 5000
|
A valid numeric value. The default is 1000.
|
Outbound XA JDBC Adapter Properties
The Outbound XA JDBC Adapter includes the following configuration sections:
JDBC Connector Settings
Details for the JDBC Connector Settings used by the external database
are detailed in the following table.
Table 59 Outbound XA JDBC Adapter—JDBC
Connector Settings
|
Name
|
Description
|
Required Value
|
|
Description
|
The description of the database.
|
A valid string. The configured default is JDBC
XA Datasource.
|
|
ClassName
|
Specifies the Java class in the JDBC driver that is used to implement the ConnectionPoolDataSource or XADataSource interface. Change as needed for your driver.
|
A valid class name.
For example:
com.attunity.jdbc.NvXADataSource
|
|
ClassNamefor
OtherInterfaces
|
For components that do not use ConnectionPoolDataSource, use this entry to enter the name of the driver class. This class
will not be used by the adapter.
|
A valid class name.
|
|
ServerName
|
This setting specifies the host name of the external database server.
|
Any valid string.
|
|
PortNumber
|
Specifies the I/O port number on which the server is listening for connection
requests.
|
A valid port number.
|
|
DatabaseName
|
Specifies the name of the database instance.
|
Any valid string.
|
|
User
|
Specifies the user name the adapter uses to connect to the database.
|
Any valid string.
|
|
Password
|
Specifies the password used to access the database.
|
Any valid string.
|
|
DriverProperties
|
The DataSource implementation may need to execute additional methods
to assure a successful run. The additional methods will need to be identified
in the Driver Properties. You must ensure that the driver is installed on
both the app server machine and Java CAPS IDE.
|
Set the driver properties according to driver vendor’s instruction.
For example:
setDefTdpName#DBSQL##
setWorkspace#Navigator##
|
|
Delimiter
|
This is the delimiter character to be used in the DriverProperties prompt.
|
The default is #.
|
|
DataSource
name
|
Specifies the name of the XADataSource implementation,
to which the DataSource object delegates behind the scenes when there is connection
pooling or distributed transaction management being done.
|
The name of the XADataSource implementation.
This property is Optional. In most cases, leave this box empty.
|
|
MinPoolSize
|
Specifies the maximum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
The pool size you set depends on the transaction volume and response
time of the application. If the pool size is too big, you may end up with
too many connections with the database.
|
A valid numeric value. The default is 0.
|
|
MaxPoolSize
|
Specifies the maximum number of physical connections the pool should
keep available at all times. 0 (zero) indicates that there is no maximum.
If the pool size is too big, you may end up with too many connections
with the database. The pool size depends on the transaction volume and response
time.
|
A valid numeric value. The default is 10.
|
|
MaxIdleTime
|
Specifies the maximum number of seconds that a physical connection may
remain unused before it is closed. 0 (zero) indicates that there is no limit.
|
A valid numeric value. The default is 0.
|
Connection Retry Settings
Details for the Connection Retry Settings used by the external database
are detailed in the following table.
Table 60 Outbound XA JDBC Adapter—Connection
Retry Settings
|
Name
|
Description
|
Required Value
|
|
ConnectionRetries
|
Specifies the number of retries to establish a connection upon failure
to acquire one.
|
A valid numeric value. The default is 0.
|
|
ConnectionRetryInterval
|
Specifies the milliseconds of pause before each attempt to reaccess
the database. This setting is used in conjunction with the ’Connection
Retries’ setting.
For example: In the event that the adapter cannot connect to the Database,
the adapter will try to reconnect to the database 10 times in 5 seconds apart
when the Connection Retries is 10 and the Connection Retry Interval is 5000
|
A valid numeric value. The default is 1000.
|
