Author: upul Date: Wed Dec 12 23:58:27 2007 New Revision: 11062 Log:
updated configuration document with pinnedServers, jms destination type details Modified: trunk/esb/java/modules/distribution/src/main/docs/ESB_Configuration_Language.html Modified: trunk/esb/java/modules/distribution/src/main/docs/ESB_Configuration_Language.html ============================================================================== --- trunk/esb/java/modules/distribution/src/main/docs/ESB_Configuration_Language.html (original) +++ trunk/esb/java/modules/distribution/src/main/docs/ESB_Configuration_Language.html Wed Dec 12 23:58:27 2007 @@ -257,6 +257,31 @@ </timeout>? </address></pre> +<p>Following are some sample uri definitions.</p> + +<p>HTTP</p> +<pre>http://localhost:9000/soap/SimpleStockQuoteService</pre> + +<p>JMS full definition</p> +<pre>jms:/SimpleStockQuoteService?transport.jms.ConnectionFactoryJNDIName=QueueConnectionFactory&java.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory&java.naming.provider.url=tcp://localhost:61616&transport.jms.DestinationType=topic</pre> + +<p>JMS connection factory reference which is defined in JMSListener of +axis2.xml as a parameter</p> +<pre>jms:/SimpleStockQuoteService?transport.jms.ConnectionFactory=myQueueConnectionFactory</pre> + +<p>SMTP</p> +<pre>mailto:[EMAIL PROTECTED]</pre> + +<p>Directory</p> +<pre>vfs:file:///home/user/directory</pre> + +<p>File</p> +<pre>vfs:file:///home/user/file</pre> + +<p>FTP</p> + +<pre>vfs:ftp://guest:[EMAIL PROTECTED]/directory?vfs.passive=true</pre> + <h4><a name="wsdl-endpoint">WSDL Endpoint</a></h4> <p>WSDL endpoint is an endpoint based on a WSDL document. It can extract the @@ -325,7 +350,7 @@ <h2><a name="proxy">Proxy service</a></h2> <p>A <proxy> element is used to define a Synapse Proxy service.</p> -<pre> <proxy name="string" [transports="(http |https |jms )+|all"]> +<pre> <proxy name="string" [transports="(http |https |jms )+|all"] [pinnedServers="(serverName)+"]> <description>...</description>? <target [inSequence="name"] [outSequence="name"] [faultSequence="name"] [endpoint="name"]> <inSequence>...</inSequence>? @@ -350,15 +375,28 @@ Axis2 conventions - based on the service name. (Note: that currently Axis2 does not allow custom URI's to be set for services on some transports.) The Proxy service could be exposed over all enabled Axis2 transports such as -http, https, JMS etc. or on a subset of these. Each service could define the -target for received messages as a named sequence or a direct endpoint. Target -inSequence or endpoint is required for the proxy configuration, and a target -outSequence defines how responses should be handled. Any supplied WS-Policies -would apply as service level policies, and any service parameters could be -passed into the proxy services' AxisService instance using the parameter -elements (e.g. the JMS destination etc). If the proxy service should enable -WS-Reliable Messaging or Security, the appropriate modules could be engaged, -and specified policies will apply.</p> +http, https, JMS etc. or on a subset of these. </p> + +<p>You can give a list of synapse server names where this proxy service +should be deployed using pinnedServers attribute.� It takes the server names +separated by comma or space character. If there is no pinned server list then +proxy service will start in all server instances.� If a pinned server names +list is given it will only start in the given named Synapse server instances. +The Synapse server name is taken as follows. First it looks for the system +property SynapseServerName.� If it is not found it will take the hostname of +the machine. Otherwise it will default to name 'localhost'. You can give a +name to the starting Synapse server instance using ./synapse.sh +-DSynapseServerName=<ServerName></p> + +<p>Each service could define the target for received messages as a named +sequence or a direct endpoint. Target inSequence or endpoint is required for +the proxy configuration, and a target outSequence defines how responses +should be handled. Any supplied WS-Policies would apply as service level +policies, and any service parameters could be passed into the proxy services' +AxisService instance using the parameter elements (e.g. the JMS destination +etc). If the proxy service should enable WS-Reliable Messaging or Security, +the appropriate modules could be engaged, and specified policies will +apply.</p> <p>A Dynamic Proxy may be defined by specifying the properties of the proxy as dynamic entries by refering them with the key. (For example one could @@ -398,6 +436,13 @@ <tr> <td></td> <td>Optional</td> + <td>transport.jms.DestinationType</td> + <td>The JMS destination� type. Accept values 'queue' or 'topic'� + (default: queue)</td> + </tr> + <tr> + <td></td> + <td>Optional</td> <td>transport.jms.ReplyDestination</td> <td>The Destination where a reply would be posted</td> </tr> @@ -513,7 +558,7 @@ <h2><a name="task">Tasks</a></h2> <p>A <task> element is used to define a Synapse Startup Task.</p> -<pre> <task class="org.my.synapse.Task" name="string"> +<pre> <task class="org.my.synapse.Task" name="string" [pinnedServers="(serverName)+"]> <property name="stringProp" value="String"/> <property name="xmlProp"> <somexml>config</somexml> @@ -540,7 +585,16 @@ could be specified as true in which case this task will be executed only once just after the initialization of Synapse</p> -<p></p> +<p>You can give a list of synapse server names where this task should be +started using pinnedServers attribute.� It takes the server names separated +by comma or space character. If there is no pinned server list then task will +start in all server instances.� If a pinned server names list is given it +will only start in the given named Synapse server instances. The Synapse +server name is taken as follows. First it looks for the system property +SynapseServerName.� If it is not found it will take the hostname of the +machine. Otherwise it will default to name 'localhost'. You can give a name +to the starting Synapse server instance using ./synapse.sh +-DSynapseServerName=<ServerName></p> <h2><a name="mediator">Mediators</a></h2> @@ -763,7 +817,7 @@ expression into its string value, and match it against the given regular expressions. If the specified cases does not match and a default case exists, it will be executed.</p> -<a name="in"></a> +<a name="in"></a> <h4><a name="out">In / Out</a></h4> <pre><in><br> mediator+ _______________________________________________ Esb-java-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
