<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY metainfo SYSTEM "metainfo.sgm">
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY Dash "&ndash;">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="create-connector-connection-pool-1">
<refmeta><refentrytitle>create-connector-connection-pool</refentrytitle><manvolnum>
1</manvolnum>&metainfo;
</refmeta>
<refnamediv><indexterm><primary sortas="create-connector-connection-pool">
create-connector-connection-pool &mdash; adds a connection pool with the specified
connection pool name</primary></indexterm><indexterm><primary sortas="adds a connecton pool with the specified connection pool name">
adds a connection pool with the specified connection pool name &mdash; create-connector-connection-pool
</primary></indexterm><refname>create-connector-connection-pool</refname>
<refpurpose> adds a connection pool with the specified connection pool name
</refpurpose></refnamediv>
<refsynopsisdiv><title>&synp-tt;</title>
<cmdsynopsis><command>create-connector-connection-pool</command>&synopsis-common;
<arg>--steadypoolsize <replaceable>8</replaceable></arg><arg>--maxpoolsize <replaceable>
32</replaceable></arg><arg>--maxwait <replaceable>60000</replaceable></arg>
<arg>--poolresize <replaceable>2</replaceable></arg><arg>--idletimeout <replaceable>
300</replaceable></arg><arg>--failconnection=<replaceable>false</replaceable></arg>
<arg choice="plain">--raname <replaceable>resource_adapter_name</replaceable></arg>
<arg choice="plain">--connectiondefinition <replaceable>connection_definition_name
</replaceable></arg><arg>--transactionsupport <replaceable>transaction_support
</replaceable></arg><arg>--isconnectvalidatereq=<replaceable>false</replaceable></arg>
<arg>--description <replaceable>text</replaceable></arg><arg><option role="nodash">&Dash;&Dash;property (<replaceable>
name</replaceable>=<replaceable>value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>
value</replaceable>]*</option></arg><arg choice="plain"><replaceable>connector_connection_pool_name
</replaceable></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1><title>&desc-tt;</title>
<para>The <command>create-connector-connection-pool</command> adds a new connector
connection pool with the specified connection pool name.</para>
</refsect1>
<refsect1><title>&opts-tt;</title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="nodash">&Dash;&Dash;target</option></term>
<listitem><para>The target option is deprecated.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;raname</option></term>
<listitem><para>The name of the resource adapter.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;connectiondefinition
</option></term><listitem><para>The name of the connection definition.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;steadypoolsize</option></term>
<listitem><para>The minimum and initial number of connections maintained in
the pool. The default value is 8. </para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;maxpoolsize</option></term>
<listitem><para>The maximum number of connections that can be created to satisfy
client requests. The default value is 32.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;maxwaittime</option></term>
<listitem><para>The amount of time, in milliseconds, that a caller must wait
before a connection is created, if a connection is not available. If set to
0, the caller is blocked indefinitely until a resource is available or until
an error occurs. The default value is 60000.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;poolresize</option></term>
<listitem><para>The number of connections to be destroyed if the existing
number of connections is above the steady-pool-size (subject to the limit
specified in the maxpoolsize option). Possible values are from 0 to MAX_INTEGER.
The default value is 2.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;idletimeout</option></term>
<listitem><para>The maximum time that a connection can remain idle in the
pool. After this amount of time, the pool can close this connection. The default
value is 300.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;failconnection</option></term>
<listitem><para>If set to true, all connections in the pool are closed if
a single validation check fails. This parameter is mandatory if the is-connection-validation-required
is set to true. Legal values are <literal>on</literal>, <literal>off</literal>, <literal>
yes</literal>, <literal>no</literal>, <literal>1</literal>,<literal>0</literal>, <literal>
true</literal> or <literal>false</literal>. The default value is false.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;transactionsupport</option></term>
<listitem><para>Indicates the level of transaction support that this pool
will have. Possible values are <literal>XATransaction</literal>, <literal>
LocalTransaction</literal> and <literal>NoTransaction</literal>. This attribute
can have a value lower than or equal to but not higher than the resource adapter's
transaction support attribute. The resource adapter's transaction support
attribute has an order of values, where <literal>XATransaction</literal> is
the highest, and <literal>NoTransaction</literal> the lowest.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">--isconnectvalidatereq</option></term>
<listitem><para>If the value is set to true, the connections will be checked
to see if they are usable, before they are given out to the application. The
default value is false.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;description</option></term>
<listitem><para>Text providing descriptive details about the connector connection
pool.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">&Dash;&Dash;property</option></term>
<listitem><para>Optional attribute name value pairs for configuring the resource. 
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&oper-tt;</title>
<variablelist termlength="wide"><?Pub Caret>
<varlistentry><term><replaceable>connector_connection_pool_name</replaceable></term>
<listitem><para> The name of the connection pool to be created.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&exam-tt;</title>
<example>
<title>Using the <command>create-connector-connection-pool</command> command
</title>
<screen>asadmin> <userinput>create-connector-connection-pool 
--passwordfile passwords.txt --steadypoolsize 20 
--maxpoolsize 100 --poolresize 2 --maxwait 60000 --raname jmsra 
--connectiondefinition javax.jms.QueueConnectionFactory jms/qConnPool</userinput>
Command create-connector-connection-pool executed successfully</screen>
<para>Where jms/qConnPool is the name of the new connector connection pool. 
</para>
</example>
</refsect1>
<refsect1><title>&exit-tt;</title>
<variablelist termlength="medium">
<varlistentry><term>0</term><listitem><para>command executed successfully
</para>
</listitem></varlistentry>
<varlistentry><term>1</term><listitem><para>error in executing the command
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1><title>&also-tt;</title>
<para><link linkend="delete-connector-connection-pool-1"><citerefentry><refentrytitle>
delete-connector-connection-pool</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link
linkend="list-connector-connection-pools-1"><citerefentry><refentrytitle>
list-connector-connection-pools</refentrytitle><manvolnum>1</manvolnum></citerefentry></link></para>
</refsect1>
</refentry>
<?Pub *0000008210>
