create-connector-connection-pool.1


sun.com \| docs.sun.com		How To Buy \| My Sun \| Worldwide Sites

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
OPERANDS
EXAMPLES
EXIT STATUS
SEE ALSO

NAME

create-connector-connection-pool - adds a connection pool with the specified connection pool name

SYNOPSIS

create-connector-connection-pool --user admin_user [ --password admin_password ] [ --host localhost ] [ --port 4848 ] [ --secure|-s ] [ --passwordfile filename ] [ --terse=false ] [ --echo=false ] [ --interactive=true ] [ --steadypoolsize 8 ] [ --maxpoolsize 32 ] [ --maxwaittime 3000 ] [ --poolresize 2 ] [ --idletimeout 300 ] [ --failallconnections=false ]--raname resource_adapter_name --connectiondefinition connection-definition_name [ --property name=value[ :name=value ]* ] pool_name

DESCRIPTION

Adds a new connector connection pool. Before you can add a new connector connection pool, you must first deploy the associated RAR file.

This command is supported in remote mode only.

OPTIONS

--user: authorized domain application server administrative username.
--password: password to administer the domain application server.
--host: machine name where the domain application server is running.
--port: port number of the domain application server listening for administration requests.
--secure: if true, uses SSL/TLS to communicate with the domain application server.
--passwordfile: file containing the domain application server password.
--terse: indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.
--echo: setting to true will echo the command line statement on the standard output. Default is false.
--interactive: if set to true (default), only the required password options are prompted.
--steadypoolsize: minimum and initial number of connections maintained in the pool (default is 8).
--maxpoolsize: maximum number of connections that can be created to satisfy client requests (default is 32).
--maxwaittime: amount of time, in milliseconds, that a caller will have to wait before a connection is created if a connection is not available. If set to 0 the caller is blocked indefinately until a resource is available or an error occurs (default is 60000).
--poolresize: the number of connections to be removed when idletimeout timer expires. Connections that have idled for longer than the timeout are candidates for removal. When the pool size reaches the steadypoolsize, the connection removal stops.
--idletimeout: the maximum time that a connection can remain idle in the pool. After this amount of time, the pool can close this connection (default is 300).
--failallconnections: if true, closes all connections in the pool if a single validation check fails. This parameter is mandatory only if the is-connection-validation-required is set to true. Legal values are: on, off, yes, no, 1, 0, true or false (default is false).
--raname: module name of the deployed resource adapter. In case of a resource adapter that is embedded in an application, the raname will be appname#raname.
--connectiondefinition: identifies one of the connection definitions in the deployment descriptor of a resource adapter. Value of connectionfactory-interface sub-element in the connection-definition element.
--property: name/value pair of the configuration properties of the managedconnectionfactory-class of the connectiondefinition for which the pool is being created. The UserName and Password are accepted by default for all pools. The escape character "\" is used in this --property option to distinguish the colons (:) and the backslash(/).

OPERANDS

pool_name: name of the connection pool to be created.

EXAMPLES

Example 1. Using create-connector-connection-pool

The JMS resource adapter that is prepackaged with the application server is used for this example. Before you can add a new connector connection pool, you must first deploy the associated RAR file.

To deploy the RAR file:

asadmin> deploy --user admin --password adminadmin jmsra.rar
Command deploy executed successfully

asadmin> create-connector-connection-pool --user admin1 
--password adminadmin1 --steadypoolsize 20 --maxpoolsize 100 --poolresize 2 
--maxwait 60000 --raname jmsra --connectiondefinition javax.jms.QueueConnectionFactory 
--property UserName=guest:Password=guest jms/qConnPool
Command create-connector-connection-pool executed successfully

EXIT STATUS

0: command executed successfully
1: error in executing the command