<!--Arbortext, Inc., 1988-2007, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<!--Arbortext, Inc., 1988-2007, v.4002-->
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="create-connector-connection-pool-1">
<!-- @(#)create-connector-connection-pool.1 1.11 07/07/25 SMI; -->
<refmeta><refentrytitle>create-connector-connection-pool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems,
Inc. All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>create-connector-connection-pool</primary>
</indexterm><indexterm><primary>adds a connection pool with the specified
connection pool name</primary></indexterm>
<refname>create-connector-connection-pool</refname><refpurpose> adds
a connection pool with the specified connection pool name</refpurpose>
</refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>create-connector-connection-pool</command> &synopsis-common;
 [--steadypoolsize <replaceable>8</replaceable>] [--maxpoolsize <replaceable>
32</replaceable>] [--maxwait <replaceable>60000</replaceable>]
 [--poolresize <replaceable>2</replaceable>] [--idletimeout <replaceable>
300</replaceable>] [--failconnection=<replaceable>false</replaceable>]
 --raname <replaceable>resource_adapter_name</replaceable> --connectiondefinition <replaceable>
connection_definition_name</replaceable>
 [--transactionsupport <replaceable>transaction_support</replaceable>] [--isconnectvalidatereq=<replaceable>
false</replaceable>]
 [--description <replaceable>text</replaceable>] [<option
role="double-dash">property</option> (<replaceable>name</replaceable>=<replaceable>
value</replaceable>)[:<replaceable>name</replaceable>=<replaceable>value</replaceable>]*]
 <replaceable>connector_connection_pool_name</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>create-connector-connection-pool</command> adds
a new connector connection pool with the specified connection pool
name.</para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">&options-common;
<varlistentry><term><option role="double-dash">target</option></term>
<listitem><para>The target option is deprecated.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">raname</option></term>
<listitem><para>The name of the resource adapter.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">connectiondefinition</option></term>
<listitem><para>The name of the connection definition.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-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="double-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="double-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="double-dash">poolresize</option></term>
<listitem><para>Quantity by which the pool will scale-up or scale-down
the number of connections. Scale-up: When the pool has
no free connections, pool will scale-up by this quantity. Scale-down:
All the invalid and idle connections are removed, sometimes resulting
in removing connections of quantity greater than this value. Steadypoolsize
will be ensured. Possible values are from 0 to MAX_INTEGER. The default
value is 2.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-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="double-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="double-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>--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="double-dash">description</option></term>
<listitem><para>Text providing descriptive details about the connector
connection pool.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">property</option></term>
<listitem><para>Optional attribute name value pairs for configuring
the resource. </para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="wide">
<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 role="examples"><title></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 role="exit-status"><title></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 role="see-also"><title></title>
<para><olink targetdoc="asrefman" targetptr="delete-connector-connection-pool-1">delete-connector-connection-pool(1)</olink>, <olink targetdoc="asrefman" targetptr="list-connector-connection-pools-1">list-connector-connection-pools(1)</olink></para>
</refsect1>
</refentry>
<?Pub *0000008205 0>
