You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by hi...@apache.org on 2008/06/28 11:50:07 UTC
svn commit: r672485 - in /synapse/trunk/java:
modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java
src/site/xdoc/Synapse_Samples.xml src/site/xdoc/Synapse_Samples_Setup.xml
Author: hiranya
Date: Sat Jun 28 02:50:07 2008
New Revision: 672485
URL: http://svn.apache.org/viewvc?rev=672485&view=rev
Log:
Made a few documentation changes to resolve SYNAPSE-379.
* Added a section describing FIX transport parameters to the samples setup guide
* Made a minor change in the samples guide
Modified:
synapse/trunk/java/modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java
synapse/trunk/java/src/site/xdoc/Synapse_Samples.xml
synapse/trunk/java/src/site/xdoc/Synapse_Samples_Setup.xml
Modified: synapse/trunk/java/modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java?rev=672485&r1=672484&r2=672485&view=diff
==============================================================================
--- synapse/trunk/java/modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java (original)
+++ synapse/trunk/java/modules/transports/src/main/java/org/apache/synapse/transport/fix/FIXSessionFactory.java Sat Jun 28 02:50:07 2008
@@ -46,7 +46,7 @@
* and a MessageStoreFactroy. By default this implementation attempts to pass null as the LogFactory and a
* MemoryStoreFactory as the MessageStoreFactory. These can be configured in the services.xml as follows.
* <p/>
- * <parameter name="transport.fix.AcceptorLogger">file</parameter>
+ * <parameter name="transport.fix.AcceptorLogFactory">file</parameter>
* (acceptable values: console, file, jdbc)
* <p/>
* <parameter name="transport.fix.AcceptorMessageStore">file</parameter>
Modified: synapse/trunk/java/src/site/xdoc/Synapse_Samples.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/java/src/site/xdoc/Synapse_Samples.xml?rev=672485&r1=672484&r2=672485&view=diff
==============================================================================
--- synapse/trunk/java/src/site/xdoc/Synapse_Samples.xml (original)
+++ synapse/trunk/java/src/site/xdoc/Synapse_Samples.xml Sat Jun 28 02:50:07 2008
@@ -3822,6 +3822,11 @@
has to establish a session with the Executor. But all the subsequent messages
will pass through almost instantaneously.
</p>
+ <p>
+ To get an idea about the various transport parameters being used in this sample
+ see <a href="Synapse_Samples_Setup.html#fixparameters">FIX Transport Parameters
+ </a>.
+ </p>
<h2>
<a name="Sample258" id="Sample258">Sample 258: Switching from HTTP to FIX </a>
</h2>
Modified: synapse/trunk/java/src/site/xdoc/Synapse_Samples_Setup.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/java/src/site/xdoc/Synapse_Samples_Setup.xml?rev=672485&r1=672484&r2=672485&view=diff
==============================================================================
--- synapse/trunk/java/src/site/xdoc/Synapse_Samples_Setup.xml (original)
+++ synapse/trunk/java/src/site/xdoc/Synapse_Samples_Setup.xml Sat Jun 28 02:50:07 2008
@@ -522,20 +522,6 @@
<h2 id="fixtransport">
Configuring Synapse for the FIX Transport
</h2>
- <p>
- First of all you need to put the following jar files into the lib folder of the
- synapse distribution
- </p>
- <ul>
- <li>quickfixj-core-1.3.1.jar</li>
- <li>quickfixj-msg-fix40-1.3.1.jar</li>
- <li>quickfixj-msg-fix41-1.3.1.jar</li>
- <li>quickfixj-msg-fix42-1.3.1.jar</li>
- <li>quickfixj-msg-fix43-1.3.1.jar</li>
- <li>quickfixj-msg-fix44-1.3.1.jar</li>
- <li>slf4j-api-1.3.0.jar</li>
- <li>slf4j-jdk14-1.3.0.jar</li>
- </ul>
<h3 id="fixtransport">
Setting up the FIX Transport
</h3>
@@ -547,9 +533,9 @@
<p>
To enable the FIX transport for samples, you need to uncomment the FIX
transport sender and FIX transport receiver configurations in the
- repository/conf/axis2.xml. Simply locate and uncomment the FIXTransportSender
- and FIXTransportListener sample configurations. Also add the following jars to
- the Synapse class path (SYNAPSE_HOME/lib directory).
+ SYNAPSE_HOME/repository/conf/axis2.xml. Simply locate and uncomment the
+ FIXTransportSender and FIXTransportListener sample configurations. Also
+ add the following jars to the Synapse class path (SYNAPSE_HOME/lib directory).
</p>
<ul>
<li>quickfixj-core.jar</li>
@@ -560,7 +546,8 @@
<li>quickfixj-msg-fix44.jar</li>
<li>mina-core-1.1.0.jar</li>
<li>slf4j-api-1.3.0.jar</li>
- </ul>
+ <li>slf4j-jdk14-1.3.0.jar</li>
+ </ul>
<p>
All these jars are shipped with the Quickfix/J binary distribution.
</p>
@@ -675,6 +662,101 @@
refer the <a href="http://www.quickfixj.org/quickfixj/usermanual/usage/configuration.html">Configuring Quickfix/J</a> section of the Quickfix/J
documentation.
</p>
+ <h3 id="fixparameters">
+ FIX Transport Parameters
+ </h3>
+ <p>
+ This is the list of all parameters accepted by the FIX transport. Refer
+ the sample 257 and 258 to see how some of them are used in practice.
+ </p>
+ <ul>
+ <li>
+ transport.fix.AcceptorConfigURL - If a service needs to listen to incoming
+ FIX messages from a remote initiator then Synapse needs to create an acceptor.
+ This parameter should contain the URL of the file which contains the FIX
+ configuration for the acceptor. (See sample 257)
+ </li>
+
+ <li>
+ transport.fix.InitiatorConfigURL - If a service needs to send FIX messages
+ to a remote acceptor Synapse should create an initiator. This parameter should
+ contain the URL of the file which contains the FIX configuration for the
+ initiator. (See sample 257)
+ </li>
+
+ <li>
+ transport.fix.AcceptorMessageStore - The type of message store to be used
+ with the acceptor. Allowed values for this parameter are 'file', 'jdbc', 'memory'
+ and 'sleepycat'. If not specified memory based message store will be used by
+ default. Additional parameters required to configure each of the message stores
+ should be specified in the acceptor configuration file.
+ </li>
+
+ <li>
+ transport.fix.InitiatorMessageStore - Same as the above but applies only
+ for the initiators. Additional parameters required to configure each of
+ the message stores should be specified in the initiator configuration file.
+ </li>
+
+ <li>
+ transport.fix.AcceptorLogFactory - Specifies the transport level log factory
+ to be used to log messages going through the acceptor. FIX messages are logged
+ without putting them in SOAP envelopes at this level. Accepted values are
+ 'console', 'file' and 'jdbc'. If not specified no logging will be done at the transport
+ level. Additional parameters required to configure each of the lof factories should be
+ specified in the acceptor configuration file.
+ </li>
+
+ <li>
+ transport.fix.InitiatorLogFactory - Specifies the transport level log factory
+ to be used to log messages going through the initiator. Functionality is similar
+ to the above. Additional parameters required to configure each of the lof factories
+ should be specified in the initiator configuration file.
+ </li>
+
+ <li>
+ transport.fix.ResponseDeliverToCompID - If a response FIX message sent from
+ Synapse to a remote FIX engine should be forwarded from the remote engine to
+ another party this parameter can be used to set the DeliverToCompID field
+ of the messages at Synapse.
+ </li>
+
+ <li>
+ transport.fix.ResponseDeliverToSubID -If a response FIX message sent from
+ Synapse to a remote FIX engine should be forwarded from the remote engine to
+ another party this parameter can be used to set the DeliverToSubID field
+ of the messages at Synapse.
+ </li>
+
+ <li>
+ transport.fix.ResponseDeliverToLocationID - If a response FIX message sent from
+ Synapse to a remote FIX engine should be forwarded from the remote engine to
+ another party this parameter can be used to set the DeliverToLocationID field
+ of the messages at Synapse.
+ </li>
+
+ <li>
+ transport.fix.ServiceName - Used when messages coming over a different protocol
+ has to be forwarded over FIX. The value must be equal to the name of the service
+ and the scope must be 'axis2-client' (See sample 258)
+ </li>
+
+ <li>
+ transport.fix.SendAllToInSequence - When there are multiple responses to a FIX
+ request and when we need only one of them to be sent to the original requester
+ this parameter has to be set to 'false'. This mostly comes handy when the original
+ requester is communicating over a different protocol (like HTTP). If this parameter
+ is not set to 'false' at such scenarios messages might get into a loop. (See
+ sample 258)
+ </li>
+
+ <li>
+ transport.fix.BeginStringValidation - When the FIX messages sent to Synapse should not
+ be forwarded to a FIX session with a different BeginString value this parameter can be
+ set to 'true'. Setting this parameter to 'true' will enforce this restriction.
+ </li>
+
+ </ul>
<p/>
<h2 id="script">
Configuring Synapse for Script Mediator Support