You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ge...@apache.org on 2013/02/08 21:35:05 UTC
svn commit: r1444219 [14/20] - in /servicemix/site/production/docs/4.4.x: ./
activemq/ architecture/ camel/ camel/deployment/ commands/
developers-guide/ images/ jbi/ jbi/components/ karaf/developers-guide/
karaf/users-guide/ nmr/ quickstart/ user/ use...
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-scripting.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-scripting.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-scripting.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-scripting.html Fri Feb 8 20:35:02 2013
@@ -118,7 +118,7 @@
<p>JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project.
Take a look at our <a href="../../users-guide/getting-started/technology-selection.html"</a>technology selection guidelines</a> for more information.</p>
</div>
- <h2 id="servicemixscripting">servicemix-scripting</h2><h3 id="Overview">Overview</h3><p>The ServiceMix Scripting component provides support for processing scripts using JSR-223 compliant scripting languages.</p><p>The component is currently shipping with:</p><ul><li>Groovy (1.5.6)</li><li>JRuby (1.1.2)</li><li>Rhino JavaScript (1.7R1)</li></ul><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/scripting/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:scripting=</span><span class="s">"http://servicemix.apache.org/scripting/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add scripting:endpoint here --></span>

<span class="nt
"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-scripting component defines a single endpoint type:</p><ul style="list-style: square"><li><tt>scripting:endpoint</tt> :: The scripting endpoint can be used to use scripts to handle exchanges or send new exchanges</li></ul><h3 id="scriptingendpoint"><tt>scripting:endpoint</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> bindings </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> A Map with additional variables that are made available during script execution. </td></tr><tr><td class="confluenceTd"> copyAttachments </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Copy the at
tachments into the 'out' message. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> copyProperties </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Copy the properties into the 'out' message. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> disableOutput </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Set this flag to true to <code>true</code> to avoid sending back a response message. Defaults to <code>false</code> </td></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> language </td><td class="co
nfluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The scripting language to be used. Defaults to <code>autodetect</code> to determine the language by the script file extension. </td></tr><tr><td class="confluenceTd"> logResourceBundle </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The resource bundle to use when logging internationalized messages. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.scripting.ScriptingMarshalerSupport</em> </td><td class="confluenceTd"> Custom marshaler implementation to handle startup/shutdown, loading the script code and registering additional user beans. </td></tr><tr><td class="confluenceTd"> script </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Spring Resource referring to the script location. </td></tr><tr><td class="confluenceTd"> scriptLogger </td><td cla
ss="confluenceTd"> <em>java.util.logging.Logger</em> </td><td class="confluenceTd"> returns the script logger </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr><tr><td class="confluenceTd"> targetEndpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Target endpoint for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetInterface </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target interface for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetOperation </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target operation for the output exchange that is created by the script. </td></tr><tr>
<td class="confluenceTd"> targetService </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target service for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetUri </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> URI for configuring target service/endpoint/interface for the exchange that is created by the script. </td></tr></table></div>
+ <h2 id="servicemixscripting">servicemix-scripting</h2><h3 id="Overview">Overview</h3><p>The ServiceMix Scripting component provides support for processing scripts using JSR-223 compliant scripting languages.</p><p>The component is currently shipping with:</p><ul><li><p>Groovy (1.5.6)</p></li><li><p>JRuby (1.1.2)</p></li><li><p>Rhino JavaScript (1.7R1)</p></li></ul><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/scripting/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:scripting=</span><span class="s">"http://servicemix.apache.org/scripting/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add scripting:endpoint here --></span>
&#
x000A;<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-scripting component defines a single endpoint type:</p><ul style="list-style: square"><li><p><tt>scripting:endpoint</tt> :: The scripting endpoint can be used to use scripts to handle exchanges or send new exchanges</p></li></ul><h3 id="scriptingendpoint"><tt>scripting:endpoint</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> bindings </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> A Map with additional variables that are made available during script execution. </td></tr><tr><td class="confluenceTd"> copyAttachments </td><td class="confluenceTd"> <em>boolean</em> </td><td class
="confluenceTd"> Copy the attachments into the 'out' message. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> copyProperties </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Copy the properties into the 'out' message. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> disableOutput </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Set this flag to true to <code>true</code> to avoid sending back a response message. Defaults to <code>false</code> </td></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd">
language </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The scripting language to be used. Defaults to <code>autodetect</code> to determine the language by the script file extension. </td></tr><tr><td class="confluenceTd"> logResourceBundle </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The resource bundle to use when logging internationalized messages. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.scripting.ScriptingMarshalerSupport</em> </td><td class="confluenceTd"> Custom marshaler implementation to handle startup/shutdown, loading the script code and registering additional user beans. </td></tr><tr><td class="confluenceTd"> script </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Spring Resource referring to the script location. </td></tr><tr><td class="confluenceTd
"> scriptLogger </td><td class="confluenceTd"> <em>java.util.logging.Logger</em> </td><td class="confluenceTd"> returns the script logger </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr><tr><td class="confluenceTd"> targetEndpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Target endpoint for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetInterface </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target interface for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetOperation </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target operation for the output exchange that is created b
y the script. </td></tr><tr><td class="confluenceTd"> targetService </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> Target service for the output exchange that is created by the script. </td></tr><tr><td class="confluenceTd"> targetUri </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> URI for configuring target service/endpoint/interface for the exchange that is created by the script. </td></tr></table></div>
</div>
</div>
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-snmp.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-snmp.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-snmp.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-snmp.html Fri Feb 8 20:35:02 2013
@@ -118,7 +118,7 @@
<p>JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project.
Take a look at our <a href="../../users-guide/getting-started/technology-selection.html"</a>technology selection guidelines</a> for more information.</p>
</div>
- <h2 id="servicemixsnmp">servicemix-snmp</h2><h3 id="Overview">Overview</h3><p>The ServiceMix SNMP component provides support for receiving SNMP events via the enterprise service bus by using the SNMP4J library.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/snmp/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:snmp=</span><span class="s">"http://servicemix.apache.org/snmp/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add snmp:poller or snmp:sender definitions here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-snmp compo
nent defines two endpoint types:</p><ul style="list-style: square"><li><tt>snmp:poller</tt> :: Periodically polls a device status using SNMP and sends the OIDs as a JBI MessageExchange</li><li><tt>snmp:trap-consumer</tt> :: Consumes an SNMP trap message and sends the OIDs as a JBI MessageExchange</li></ul><h3 id="snmppoller"><tt>snmp:poller</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> address </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI used to connect to a snmp capable device. <br /><br /> <b><u>Template:</u></b> <br /> nbsp; i><rotocol><ost><ort>/i> <br /><br /> <b><u>Details:</u></b><br /><br/
> <table border="0" cellpadding="0" cellspacing="0"> <tr> <td width="40%" align="left"><b><u>Name</u></b></td> <td width="60%" align="left"><b><u>Description</u></b></td> </tr> <tr> <td>protocol</td> <td>the protocol to use (udp or tcp)</td> </tr> <tr> <td>host</td> <td>the name or ip address of the snmp capable device</td> </tr> <tr> <td>port</td> <td>the port number to use</td> </tr> </table> <br/> <b><u>Example:</u></b><br /> nbsp; i>udp:192.168.2.122/161</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> concurrentPolling </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>. </td></tr><tr><td class="confluenceTd"> del
ay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of time in milliseconds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> firstTime </td><td class="confluenceTd"> <em>java.util.Date</em> </td><td class="confluenceTd"> Sets the date on which the first poll will be executed. If a delay is also set using <code>setDelay</code>, the delay interval will be added after the date specified. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.snmp.marshaler.Snmp
MarshalerSupport</em> </td><td class="confluenceTd"> <p>Specifies a marshaler class which provides the logic for converting a snmp response into a normalized message. This class has to implement the <code>SnmpMarshalerSupport</code> interface. If you don't specify a marshaler, the <code>DefaultSnmpMarshaler</code> will be used.</p> </td></tr><tr><td class="confluenceTd"> oids </td><td class="confluenceTd"> (<em>java.lang.Object</em>)\* </td><td class="confluenceTd"> <p>Specifies a reference to a list of OID values which will be used for the snmp request. You have two possibilities how to specify the value: <br /><br /> i>a) referencing to a file containing a list of OID values separated by a line feed <br/> nbsp; nbsp;or<br/> i>b) defining a coma (<b>,</b>) separated list of OID values <br /><br /> <b><u>Examples:</u></b><br /> nbsp; i>a) oids="classpath:myOids.txt"<br /> nb
sp; nbsp; nbsp; ids="file:/home/lhein/snmp/device_a/oids.txt"<br/> <br /> nbsp; i>b) oids="1.3.6.1.2.1.1.3.0 , 1.3.6.1.2.1.25.3.2.1.5.1 , 1.3.6.1.2.1.25.3.5.1.1.1 , 1.3.6.1.2.1.43.5.1.1.11.1"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> period </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the number of milliseconds between polling attempts. </td></tr><tr><td class="confluenceTd"> retries </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the connection retries.</p> <i> nbsp; he default value is <b>2</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> scheduler </td><td class="confluenceTd"> <em>org.apache.servicemix.common.scheduler.Scheduler</em> </td><td class="confluenceTd"> Set a custom Scheduler implementation if you need more fine-grain
ed control over the polling schedule. </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr><tr><td class="confluenceTd"> snmpCommunity </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the snmp community to use.</p> <i> nbsp; he default value is <b>"public"</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> snmpVersion </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the snmp protocol version to use.</p> <i> nbsp; he default value is <b>0 (version 1)</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> targetEndpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> the name of the endpoint to which requests are sen
t </td></tr><tr><td class="confluenceTd"> targetInterface </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the interface to which requests are sent </td></tr><tr><td class="confluenceTd"> targetOperation </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the operation to which requests are sent </td></tr><tr><td class="confluenceTd"> targetService </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the service to which requests are sent </td></tr><tr><td class="confluenceTd"> targetUri </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Set the target service/endpoint/interface using a URI. </td></tr><tr><td class="confluenceTd"> timeout </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the connection time out in millisecond
s.</p> <i> nbsp; he default value is <b>1500</b></i><br/><br/> </td></tr></table></div><h3 id="vfstrapconsumer"><tt>vfs:trap-consumer</tt></h3><h4 id="Endpointproperties2">Endpoint properties</h4>
+ <h2 id="servicemixsnmp">servicemix-snmp</h2><h3 id="Overview">Overview</h3><p>The ServiceMix SNMP component provides support for receiving SNMP events via the enterprise service bus by using the SNMP4J library.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/snmp/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:snmp=</span><span class="s">"http://servicemix.apache.org/snmp/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add snmp:poller or snmp:sender definitions here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-snmp compo
nent defines two endpoint types:</p><ul style="list-style: square"><li><p><tt>snmp:poller</tt> :: Periodically polls a device status using SNMP and sends the OIDs as a JBI MessageExchange</p></li><li><p><tt>snmp:trap-consumer</tt> :: Consumes an SNMP trap message and sends the OIDs as a JBI MessageExchange</p></li></ul><h3 id="snmppoller"><tt>snmp:poller</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> address </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI used to connect to a snmp capable device. <br /><br /> <b><u>Template:</u></b> <br /> nbsp; i><rotocol><ost><ort>/i> <br /><br /> <b><u>Details:</u></b>&l
t;br /><br/> <table border="0" cellpadding="0" cellspacing="0"> <tr> <td width="40%" align="left"><b><u>Name</u></b></td> <td width="60%" align="left"><b><u>Description</u></b></td> </tr> <tr> <td>protocol</td> <td>the protocol to use (udp or tcp)</td> </tr> <tr> <td>host</td> <td>the name or ip address of the snmp capable device</td> </tr> <tr> <td>port</td> <td>the port number to use</td> </tr> </table> <br/> <b><u>Example:</u></b><br /> nbsp; i>udp:192.168.2.122/161</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> concurrentPolling </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>. </td></tr><tr><td class="conf
luenceTd"> delay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of time in milliseconds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> firstTime </td><td class="confluenceTd"> <em>java.util.Date</em> </td><td class="confluenceTd"> Sets the date on which the first poll will be executed. If a delay is also set using <code>setDelay</code>, the delay interval will be added after the date specified. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.snmp.
marshaler.SnmpMarshalerSupport</em> </td><td class="confluenceTd"> <p>Specifies a marshaler class which provides the logic for converting a snmp response into a normalized message. This class has to implement the <code>SnmpMarshalerSupport</code> interface. If you don't specify a marshaler, the <code>DefaultSnmpMarshaler</code> will be used.</p> </td></tr><tr><td class="confluenceTd"> oids </td><td class="confluenceTd"> (<em>java.lang.Object</em>)\* </td><td class="confluenceTd"> <p>Specifies a reference to a list of OID values which will be used for the snmp request. You have two possibilities how to specify the value: <br /><br /> i>a) referencing to a file containing a list of OID values separated by a line feed <br/> nbsp; nbsp;or<br/> i>b) defining a coma (<b>,</b>) separated list of OID values <br /><br /> <b><u>Examples:</u></b><br /> nbsp; i>a) oids="classpath:myOids.txt"<
br /> nbsp; nbsp; nbsp; ids="file:/home/lhein/snmp/device_a/oids.txt"<br/> <br /> nbsp; i>b) oids="1.3.6.1.2.1.1.3.0 , 1.3.6.1.2.1.25.3.2.1.5.1 , 1.3.6.1.2.1.25.3.5.1.1.1 , 1.3.6.1.2.1.43.5.1.1.11.1"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> period </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the number of milliseconds between polling attempts. </td></tr><tr><td class="confluenceTd"> retries </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the connection retries.</p> <i> nbsp; he default value is <b>2</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> scheduler </td><td class="confluenceTd"> <em>org.apache.servicemix.common.scheduler.Scheduler</em> </td><td class="confluenceTd"> Set a custom Scheduler implementation if you need m
ore fine-grained control over the polling schedule. </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr><tr><td class="confluenceTd"> snmpCommunity </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the snmp community to use.</p> <i> nbsp; he default value is <b>"public"</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> snmpVersion </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the snmp protocol version to use.</p> <i> nbsp; he default value is <b>0 (version 1)</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> targetEndpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> the name of the endpoint to which re
quests are sent </td></tr><tr><td class="confluenceTd"> targetInterface </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the interface to which requests are sent </td></tr><tr><td class="confluenceTd"> targetOperation </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the operation to which requests are sent </td></tr><tr><td class="confluenceTd"> targetService </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> the QName of the service to which requests are sent </td></tr><tr><td class="confluenceTd"> targetUri </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Set the target service/endpoint/interface using a URI. </td></tr><tr><td class="confluenceTd"> timeout </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>Specifies the connection time out
in milliseconds.</p> <i> nbsp; he default value is <b>1500</b></i><br/><br/> </td></tr></table></div><h3 id="vfstrapconsumer"><tt>vfs:trap-consumer</tt></h3><h4 id="Endpointproperties2">Endpoint properties</h4>
</div>
</div>
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-validation.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-validation.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-validation.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-validation.html Fri Feb 8 20:35:02 2013
@@ -118,7 +118,7 @@
<p>JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project.
Take a look at our <a href="../../users-guide/getting-started/technology-selection.html"</a>technology selection guidelines</a> for more information.</p>
</div>
- <h2 id="servicemixvalidation">servicemix-validation</h2><h3 id="Overview">Overview</h3><p>The ServiceMix Validation component provides schema validation of documents using JAXP 1.3 and XMLSchema or RelaxNG.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/validation/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:scripting=</span><span class="s">"http://servicemix.apache.org/validation/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add validation:endpoint here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-validation compo
nent defines a single endpoint type:</p><ul style="list-style: square"><li><tt>validation:endpoint</tt> :: Validates the incoming XML message - can be configured to fail the exchange or to send validation errors back to the sender in the message body.</li></ul><h3 id="validationendpoint"><tt>validation:endpoint</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> errorHandlerFactory </td><td class="confluenceTd"> <em>org.apache.servicemix.validation.handler.MessageAwareErrorHandlerFactory</em> </td><td class="confluenceTd"> Set a custom error handler to deal with validation errors. Defaults to
a <code>CountingErrorHandlerFactory</code>. </td></tr><tr><td class="confluenceTd"> handlingErrorMethod </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Configure how validation errors should be handled. Default value is <code>FAULT_JBI</code>. <dl> <dt><code>FAULT_JBI</code></dt> <dd>A jbi exception is thrown on validation errors (depending on used MEP)</dd> <dt><code>FAULT_FLOW</code></dt> <dd>The validation result will be sent in out / fault message (depending on used MEP)</dd> </dl> </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> noNamespaceSchemaResource </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Set the validatio
n schema to be used when no namespace is specified. </td></tr><tr><td class="confluenceTd"> schema </td><td class="confluenceTd"> <em>javax.xml.validation.Schema</em> </td><td class="confluenceTd"> Set the validation schema instance. </td></tr><tr><td class="confluenceTd"> schemaLanguage </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Set the validation schema language. Defaults to <code>http://www.w3.org/2001/XMLSchema</code> </td></tr><tr><td class="confluenceTd"> schemaResource </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Set the validation schema as a Spring Resource. </td></tr><tr><td class="confluenceTd"> schemaSource </td><td class="confluenceTd"> <em>javax.xml.transform.Source</em> </td><td class="confluenceTd"> Set the validation schema as an XML Source. </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namespace.QNa
me</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr></table></div>
+ <h2 id="servicemixvalidation">servicemix-validation</h2><h3 id="Overview">Overview</h3><p>The ServiceMix Validation component provides schema validation of documents using JAXP 1.3 and XMLSchema or RelaxNG.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/validation/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:scripting=</span><span class="s">"http://servicemix.apache.org/validation/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add validation:endpoint here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-validation compo
nent defines a single endpoint type:</p><ul style="list-style: square"><li><p><tt>validation:endpoint</tt> :: Validates the incoming XML message - can be configured to fail the exchange or to send validation errors back to the sender in the message body.</p></li></ul><h3 id="validationendpoint"><tt>validation:endpoint</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> errorHandlerFactory </td><td class="confluenceTd"> <em>org.apache.servicemix.validation.handler.MessageAwareErrorHandlerFactory</em> </td><td class="confluenceTd"> Set a custom error handler to deal with validation errors. Defa
ults to a <code>CountingErrorHandlerFactory</code>. </td></tr><tr><td class="confluenceTd"> handlingErrorMethod </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Configure how validation errors should be handled. Default value is <code>FAULT_JBI</code>. <dl> <dt><code>FAULT_JBI</code></dt> <dd>A jbi exception is thrown on validation errors (depending on used MEP)</dd> <dt><code>FAULT_FLOW</code></dt> <dd>The validation result will be sent in out / fault message (depending on used MEP)</dd> </dl> </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> noNamespaceSchemaResource </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Set the va
lidation schema to be used when no namespace is specified. </td></tr><tr><td class="confluenceTd"> schema </td><td class="confluenceTd"> <em>javax.xml.validation.Schema</em> </td><td class="confluenceTd"> Set the validation schema instance. </td></tr><tr><td class="confluenceTd"> schemaLanguage </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Set the validation schema language. Defaults to <code>http://www.w3.org/2001/XMLSchema</code> </td></tr><tr><td class="confluenceTd"> schemaResource </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Set the validation schema as a Spring Resource. </td></tr><tr><td class="confluenceTd"> schemaSource </td><td class="confluenceTd"> <em>javax.xml.transform.Source</em> </td><td class="confluenceTd"> Set the validation schema as an XML Source. </td></tr><tr><td class="confluenceTd"> service </td><td class="confluenceTd"> <em>javax.xml.namesp
ace.QName</em> </td><td class="confluenceTd"> The qualified name of the service the endpoint exposes. </td></tr></table></div>
</div>
</div>
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-vfs.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-vfs.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-vfs.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-vfs.html Fri Feb 8 20:35:02 2013
@@ -118,7 +118,7 @@
<p>JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project.
Take a look at our <a href="../../users-guide/getting-started/technology-selection.html"</a>technology selection guidelines</a> for more information.</p>
</div>
- <h2 id="servicemixvfs">servicemix-vfs</h2><h3 id="Overview">Overview</h3><p>The ServiceMix VFS component provides support for reading from and writing to virtual file systems via the enterprise service bus by using the Apache commons-vfs library.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/vfs/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:vfs=</span><span class="s">"http://servicemix.apache.org/vfs/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add vfs:poller or vfs:sender here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The se
rvicemix-vfs component defines two endpoint types:</p><ul style="list-style: square"><li><tt>vfs:poller</tt> :: Periodically polls a directory on one of the VFS-supported file systems for files and sends an exchange for every file</li><li><tt>vfs:sender</tt> :: Writes the contents of an exchange to a file on one of the VFS-supported file systems</li></ul><h3 id="vfspoller"><tt>vfs:poller</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> comparator </td><td class="confluenceTd"> <em>java.util.Comparator</em> </td><td class="confluenceTd"> Specifies a <code>Comparator</code> object. </td></tr><tr><td class="confluenceTd"> component </td><td class="confluenceTd"> <em><a href="#org.apache.servicemix.common.DefaultComponenttypes">org.apache.servicem
ix.common.DefaultComponent</a></em> </td><td class="confluenceTd"> the default component </td></tr><tr><td class="confluenceTd"> concurrentExchange </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> concurrentPolling </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>. </td></tr><tr><td class="confluenceTd"> delay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of time in milliseconds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> deleteFile </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if files should be deleted after they are processed. Default value is <code>true</code>. </td></tr><tr><td class="confluenceTd"> endpoint <
/td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> fileSystemManager </td><td class="confluenceTd"> <em>org.apache.commons.vfs.FileSystemManager</em> </td><td class="confluenceTd"> sets the file system manager </td></tr><tr><td class="confluenceTd"> firstTime </td><td class="confluenceTd"> <em>java.util.Date</em> </td><td class="confluenceTd"> Sets the date on which the first poll will be executed. If a delay is also set using <code>setDelay</code>, the delay interval will be added after the date specified. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> lockManager </td><td class="confluenceTd"> <em>org.apache.servicemix.common.locks.LockManager</em> </td><td class="c
onfluenceTd"> Bean defining the class implementing the file locking strategy. This bean must be an implementation of the <code>org.apache.servicemix.locks.LockManager</code> interface. By default, this will be set to an instances of <code>org.apache.servicemix.common.locks.impl.SimpleLockManager</code>. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.components.util.FileMarshaler</em> </td><td class="confluenceTd"> Specifies a <code>FileMarshaler</code> object that will marshal file data into the NMR. The default file marshaller can read valid XML data. <code>FileMarshaler</code> objects are implementations of <code>org.apache.servicemix.components.util.FileMarshaler</code>. </td></tr></table></div><p>| path | <em>java.lang.String</em> | Specifies a <code>String</code> object representing the path of the file/folder to be polled.<br /><br /> <b><u>Examples:</u></b
><br /> <ul> <li>file:///home/lhein/pollFolder</li> <li>zip:file:///home/lhein/pollFolder/myFile.zip</li> <li>jar:http://www.myhost.com/files/Examples.jar</li> <li>jar:../lib/classes.jar!/META-INF/manifest.mf</li> <li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li> <li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li> <li>gz:/my/gz/file.gz</li> <li>http://myusername@somehost/index.html</li> <li>webdav://somehost:8080/dist</li> <li>ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>smb://somehost/home</li> <li>tmp://dir/somefile.txt</li> <li>res:path/in/classpath/image.png</li> <li>ram:///any/path/to/file.txt</li> <li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li> </ul> </p><h3 id="vfssender"><tt>vfs:sender</tt></h3><h4 id="Endp
ointproperties2">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> fileSystemManager </td><td class="confluenceTd"> <em>org.apache.commons.vfs.FileSystemManager</em> </td><td class="confluenceTd"> sets the file system manager </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.components.util.FileMarshaler</em> </td><td class="confluenceTd"> Specifies a <code>Fi
leMarshaler</code> object that will marshal file data into the NMR. The default file marshaller can read valid XML data. <code>FileMarshaler</code> objects are implementations of <code>org.apache.servicemix.components.util.FileMarshaler</code>. </td></tr></table></div><p>| path | <em>java.lang.String</em> | Specifies a <code>String</code> object representing the path of the file/folder to be polled.<br /><br /> <b><u>Examples:</u></b><br /> <ul> <li>file:///home/lhein/pollFolder</li> <li>zip:file:///home/lhein/pollFolder/myFile.zip</li> <li>jar:http://www.myhost.com/files/Examples.jar</li> <li>jar:../lib/classes.jar!/META-INF/manifest.mf</li> <li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li> <li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li> <li>gz:/my/gz/file.gz</li> <li>http://myusername@somehost/index.html</li> <li>webdav://somehost:80
80/dist</li> <li>ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>smb://somehost/home</li> <li>tmp://dir/somefile.txt</li> <li>res:path/in/classpath/image.png</li> <li>ram:///any/path/to/file.txt</li> <li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li> </ul> </p>
+ <h2 id="servicemixvfs">servicemix-vfs</h2><h3 id="Overview">Overview</h3><p>The ServiceMix VFS component provides support for reading from and writing to virtual file systems via the enterprise service bus by using the Apache commons-vfs library.</p><h4 id="Namespaceandxbean.xml">Namespace and xbean.xml</h4><p>The namespace URI for the servicemix-bean JBI component is <tt>http://servicemix.apache.org/vfs/1.0</tt>. This is an example of an <tt>xbean.xml</tt> file with a namespace definition with prefix <tt>bean</tt>.</p><div class="syntax"><div class="highlight"><pre><span class="nt"><beans</span> <span class="na">xmlns:vfs=</span><span class="s">"http://servicemix.apache.org/vfs/1.0"</span><span class="nt">></span>

 <span class="c"><!-- add vfs:poller or vfs:sender here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The se
rvicemix-vfs component defines two endpoint types:</p><ul style="list-style: square"><li><p><tt>vfs:poller</tt> :: Periodically polls a directory on one of the VFS-supported file systems for files and sends an exchange for every file</p></li><li><p><tt>vfs:sender</tt> :: Writes the contents of an exchange to a file on one of the VFS-supported file systems</p></li></ul><h3 id="vfspoller"><tt>vfs:poller</tt></h3><h4 id="Endpointproperties">Endpoint properties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> comparator </td><td class="confluenceTd"> <em>java.util.Comparator</em> </td><td class="confluenceTd"> Specifies a <code>Comparator</code> object. </td></tr><tr><td class="confluenceTd"> component </td><td class="confluenceTd"> <em><a href="#org.apache.servicemix.common.DefaultComponenttypes">org.a
pache.servicemix.common.DefaultComponent</a></em> </td><td class="confluenceTd"> the default component </td></tr><tr><td class="confluenceTd"> concurrentExchange </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> concurrentPolling </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Sets whether more than one poll can be active at a time (true means yes). Default value is <code>false</code>. </td></tr><tr><td class="confluenceTd"> delay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of time in milliseconds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> deleteFile </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if files should be deleted after they are processed. Default value is <code>true</code>. </td></tr><tr><td class="confluenceT
d"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> fileSystemManager </td><td class="confluenceTd"> <em>org.apache.commons.vfs.FileSystemManager</em> </td><td class="confluenceTd"> sets the file system manager </td></tr><tr><td class="confluenceTd"> firstTime </td><td class="confluenceTd"> <em>java.util.Date</em> </td><td class="confluenceTd"> Sets the date on which the first poll will be executed. If a delay is also set using <code>setDelay</code>, the delay interval will be added after the date specified. </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> lockManager </td><td class="confluenceTd"> <em>org.apache.servicemix.common.locks.LockManager</em> </t
d><td class="confluenceTd"> Bean defining the class implementing the file locking strategy. This bean must be an implementation of the <code>org.apache.servicemix.locks.LockManager</code> interface. By default, this will be set to an instances of <code>org.apache.servicemix.common.locks.impl.SimpleLockManager</code>. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.components.util.FileMarshaler</em> </td><td class="confluenceTd"> Specifies a <code>FileMarshaler</code> object that will marshal file data into the NMR. The default file marshaller can read valid XML data. <code>FileMarshaler</code> objects are implementations of <code>org.apache.servicemix.components.util.FileMarshaler</code>. </td></tr><tr><td class="confluenceTd"> path </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd">Specifies a <code>String</code> object representing the path of the fi
le/folder to be polled.<br /><br /> <b><u>Examples:</u></b><br /> <ul> <li>file:///home/lhein/pollFolder</li> <li>zip:file:///home/lhein/pollFolder/myFile.zip</li> <li>jar:http://www.myhost.com/files/Examples.jar</li> <li>jar:../lib/classes.jar!/META-INF/manifest.mf</li> <li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li> <li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li> <li>gz:/my/gz/file.gz</li> <li>http://myusername@somehost/index.html</li> <li>webdav://somehost:8080/dist</li> <li>ftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>smb://somehost/home</li> <li>tmp://dir/somefile.txt</li> <li>res:path/in/classpath/image.png</li> <li>ram:///any/path/to/file.txt</li> <li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li> </ul> </td></tr></table></div><h3 id="vfssender"><tt>vfs:sender</tt></h3><h4 id="Endpointproperties2">Endpoint p
roperties</h4><div class="table-wrap"><table class="confluenceTable"><tr><th class="confluenceTh"> Property Name </th><th class="confluenceTh"> Type </th><th class="confluenceTh"> Description </th></tr><tr><td class="confluenceTd"> endpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the endpoint. </td></tr><tr><td class="confluenceTd"> fileSystemManager </td><td class="confluenceTd"> <em>org.apache.commons.vfs.FileSystemManager</em> </td><td class="confluenceTd"> sets the file system manager </td></tr><tr><td class="confluenceTd"> interfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> The qualified name of the interface exposed by the endpoint. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.components.util.FileMarshaler</em> </td><td class="confluenceTd"> Specifies a <code>FileMarshaler</code> objec
t that will marshal file data into the NMR. The default file marshaller can read valid XML data. <code>FileMarshaler</code> objects are implementations of <code>org.apache.servicemix.components.util.FileMarshaler</code>. </td></tr><tr><td class="confluenceTd"> path </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd">Specifies a <code>String</code> object representing the path of the file/folder to be polled.<br /><br /> <b><u>Examples:</u></b><br /> <ul> <li>file:///home/lhein/pollFolder</li> <li>zip:file:///home/lhein/pollFolder/myFile.zip</li> <li>jar:http://www.myhost.com/files/Examples.jar</li> <li>jar:../lib/classes.jar!/META-INF/manifest.mf</li> <li>tar:gz:http://anyhost/dir/mytar.tar.gz!/mytar.tar!/path/in/tar/README.txt</li> <li>tgz:file://anyhost/dir/mytar.tgz!/somepath/somefile</li> <li>gz:/my/gz/file.gz</li> <li>http://myusername@somehost/index.html</li> <li>webdav://somehost:8080/dist</li> <li>ftp://myusername:mypass
word@somehost/pub/downloads/somefile.tgz</li> <li>sftp://myusername:mypassword@somehost/pub/downloads/somefile.tgz</li> <li>smb://somehost/home</li> <li>tmp://dir/somefile.txt</li> <li>res:path/in/classpath/image.png</li> <li>ram:///any/path/to/file.txt</li> <li>mime:file:///your/path/mail/anymail.mime!/filename.pdf</li> </ul> </td></tr></table></div>
</div>
</div>
Modified: servicemix/site/production/docs/4.4.x/jbi/index.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/index.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/index.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/index.html Fri Feb 8 20:35:02 2013
@@ -118,7 +118,7 @@
<p>JBI 1.0 support is available in Apache ServiceMix 4 to allow existing users to migrate more easily to this latest version - if you're a new user, you should consider JBI deprecated and not use it for your project.
Take a look at our <a href="../users-guide/getting-started/technology-selection.html"</a>technology selection guidelines</a> for more information.</p>
</div>
- <h1 id="JavaBusinessIntegrationJSR208">Java Business Integration (JSR-208)</h1><p>This manual explains all about ServiceMix' support the JBI 1.0 specification.</p><p>ServiceMix 4 ships with:</p><ul style="list-style: square"><li>a JBI 1.0 container implementation</li><li>a set of JBI components</li><li>a JBI clustering engine</li></ul>
+ <h1 id="JavaBusinessIntegrationJSR208">Java Business Integration (JSR-208)</h1><p>This manual explains all about ServiceMix' support the JBI 1.0 specification.</p><p>ServiceMix 4 ships with:</p><ul style="list-style: square"><li><p>a JBI 1.0 container implementation</p></li><li><p>a set of JBI components</p></li><li><p>a JBI clustering engine</p></li></ul>
</div>
</div>