Author: indika Date: Fri Jun 26 01:25:11 2009 New Revision: 40013 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40013
Log: update dblookup documentation Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/dblookup.xml Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/dblookup.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/mediators/dblookup.xml?rev=40013&r1=40012&r2=40013&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/mediators/dblookup.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/mediators/dblookup.xml Fri Jun 26 01:25:11 2009 @@ -19,6 +19,71 @@ DataSource or specified in-line, in which case an Apache DBCP connection pool is established and used. </p> +<p><strong>In-lined Data Source</strong></p> +<ul> + <li><strong>driver</strong> - Database driver class name</li> + <li><strong>url</strong> - Database URL</li> + <li><strong>user</strong> - User name for access Database</li> + <li><strong>password</strong> Password for access Database</li> +</ul> + +<p>This new Datasource is based on Apache DBCP connection pools. This +connection pool support the following configuration properties: </p> +<ul> + <li>autocommit = true | false </li> + <li>isolation = Connection.TRANSACTION_NONE | + Connection.TRANSACTION_READ_COMMITTED | + Connection.TRANSACTION_READ_UNCOMMITTED | + Connection.TRANSACTION_REPEATABLE_READ | + Connection.TRANSACTION_SERIALIZABLE </li> + <li>initialsize = int </li> + <li>maxactive = int </li> + <li>maxidle = int </li> + <li>maxopenstatements = int </li> + <li>maxwait = long </li> + <li>minidle = int </li> + <li>poolstatements = true | false </li> + <li>testonborrow = true | false </li> + <li>testonreturn = true | false </li> + <li>testwhileidle = true | false </li> + <li>validationquery = String </li> +</ul> + +<p><strong>External Data Source</strong></p> +<ul> + <li><strong>dsName</strong> - The name of the Datasource to be looked up</li> + <li><strong>icClass</strong> - Initial context factory class. The + corresponding java environment property is + <strong>java.naming.factory.initial</strong></li> + <li><strong>url</strong> - The naming service provider url . The + corresponding java environment property is + <strong>java.naming.provider.url</strong></li> + <li><strong>user</strong> - This is corresponding to the java environment + property <strong>java.naming.security.principal</strong></li> + <li><strong>password</strong> - This is corresponding to the java environment + property This is corresponding to the java environment property + <strong>java.naming.security.principal</strong></li> +</ul> + +<p><strong>SQL Statements </strong></p> +<ul> + <li><strong>sql </strong>- One or more SQL Statements </li> + <li><strong>parameter</strong> - Specify how the values of parameter in the + SQL would be calculated. </li> + <li><strong>result</strong> - Specify how to deal with rerun result from + Database query execution. </li> +</ul> + +<p>More than one statement may be specified, and the SQL statement may specify +parameters which could be specified as values or XPath expressions. The types +of parameters could be any valid SQL types. Only the first row of a result set +will be considered and any others are ignored. The single +<strong><result></strong> element contains the '<strong>name</strong>' +and the '<strong>column</strong>' attributes. The '<strong>name</strong>' +attribute defines the name under which the result is stored in the Synapse +message context, and the column attribute specifies a column number or name . +</p> + <h3>Syntax</h3> <pre xml:space="preserve"><dblookup> <connection> @@ -45,7 +110,49 @@ </statement>+ </dblookup></pre> -<p>Apache DBCP connection pools support the following properties: </p> +<h3>UI Configuration<img +src="../dblookup-mediator/docs/images/dblookup-options.png" alt="" /> </h3> + +<div class="image"> +<p>Figure 1: DBLookup mediator options </p> +</div> + +<p>DBLookup mediator options field descriptions, </p> +<ul> + <li>Connection Information - Specify whether the connection is taken from a + connection pool or from a data source </li> + <li>Driver - Database driver</li> + <li>Url - JDBC URL of the database that data will be looked up.</li> + <li>User - Username that's used to connect to the database.</li> + <li>Password - Password used to connect to the database. </li> +</ul> + +<h4>Data sources</h4> + +<div> +<img src="../dblookup-mediator/docs/images/ds.png" alt="Data Source" /> </div> + +<h4>Existing</h4> + +<p>If existing data source is choosen, clicking "Load Data Sources" will give +the available datasource. Then a data source can be selected.</p> + +<h4>Inline</h4> + +<p>Like in Pool connection data source configuration properties should be +specified.</p> + +<h4>Adding properties</h4> + +<p>Figure 2 shows the screen after clicking Add Property, </p> + +<div class="image"> +<img src="../dblookup-mediator/docs/images/add-properties.png" alt="" /> + +<p>Figure 2: Adding a property </p> +</div> + +<p>Property field descriptions, </p> <ul> <li>autocommit = true | false </li> <li>isolation = Connection.TRANSACTION_NONE | @@ -61,111 +168,29 @@ <li>minidle = int </li> <li>poolstatements = true | false </li> <li>testonborrow = true | false </li> - <li>testonreturn = true | false </li> <li>testwhileidle = true | false </li> <li>validationquery = String </li> </ul> -<p>More than one statement may be specified, and the SQL statement may specify -parameters which could be specified as values or XPath expressions. The types -of parameters could be any valid SQL types. Only the first row of a result set -will be considered and any others are ignored. The single <result> -element contains the 'name' and the column' attributes. The 'name' attribute -defines the name under which the result is stored in the Synapse message -context, and the column attribute specifies a column number or name . </p> - -<h3>UI Configuration</h3> - <div class="image"> - <img src="../dblookup-mediator/docs/images/dblookup-options.png" alt=""/> - <p> - Figure 1: DBLookup mediator options - </p> - </div> - <p> - DBLookup mediator options field descriptions, - </p> - <ul> - <li> - Connection Information - Specify whether the connection is - taken from a connection pool or from a data source - </li> - <li>Driver - Database driver</li> - - <li>Url - JDBC URL of the database that data will be looked up.</li> - <li>User - Username that's used to connect to the database.</li> - <li>Password - Password used to connect to the database. </li> - </ul> - <h4>Data sources</h4> - <div> - <img src="../dblookup-mediator/docs/images/ds.png" alt="Data Source"/> - </div> - <h4>Existing</h4> - <p>If existing data source is choosen, clicking "Load Data Sources" will give the available datasource. Then a data source can be selected.</p> - <h4>Inline</h4> - <p>Like in Pool connection data source configuration properties should be specified.</p> - <h4>Adding properties</h4> - <p> - Figure 2 shows the screen after clicking Add Property, - </p> - <div class="image"> - <img src="../dblookup-mediator/docs/images/add-properties.png" alt=""/> - <p> - Figure 2: Adding a property - </p> - </div> - <p> - Property field descriptions, - </p> - <ul> - <li> autocommit = true | false </li> - <li> - isolation = Connection.TRANSACTION_NONE | - Connection.TRANSACTION_READ_COMMITTED | - Connection.TRANSACTION_READ_UNCOMMITTED | - Connection.TRANSACTION_REPEATABLE_READ | - Connection.TRANSACTION_SERIALIZABLE - </li> - <li>initialsize = int </li> - <li> maxactive = int </li> - <li> maxidle = int </li> - <li> maxopenstatements = int </li> - <li> maxwait = long </li> - <li> minidle = int </li> - <li> poolstatements = true | false </li> - <li> testonborrow = true | false </li> - <li> testwhileidle = true | false </li> - <li> validationquery = String </li> - </ul> - <h4>Adding SQL statements</h4> - <ol> - <li> - Click Add Statement link shown in figure 2 and it'll open - up - the screen where you could enter SQL statement option. This is shown in - figure 3. - </li> - <li>More than one statement may be specified.</li> - </ol> - <ul> - <li> - The SQL statement may - specify parameters which could be specified as values or XPath - expressions. - </li> - <li> - The types of parameters could be any valid SQL types. - Only - the first row of a result set will be considered and any others are - ignored. - </li> - </ul> - <div class="image"> - <img src="../dblookup-mediator/docs/images/add-sql.png" alt=""/> - <p> - Figure 3: Adding SQL statements - </p> - </div> +<h4>Adding SQL statements</h4> +<ol> + <li>Click Add Statement link shown in figure 2 and it'll open up the screen + where you could enter SQL statement option. This is shown in figure 3. </li> + <li>More than one statement may be specified.</li> +</ol> +<ul> + <li>The SQL statement may specify parameters which could be specified as + values or XPath expressions. </li> + <li>The types of parameters could be any valid SQL types. Only the first row + of a result set will be considered and any others are ignored. </li> +</ul> + +<div class="image"> +<img src="../dblookup-mediator/docs/images/add-sql.png" alt="" /> + +<p>Figure 3: Adding SQL statements </p> +</div> - <p></p> +<p></p> </body> </html> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
