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 [12/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-jms.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-jms.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-jms.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-jms.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="servicemixjms">servicemix-jms</h2><h3 id="Overview">Overview</h3><p>ServiceMix ships with a JBI compliant JMS binding component named servicemix-jms.</p><p>Here are the main features:</p><ul><li>JBI compliant Binding Component</li><li>Usable in a lightweight mode in servicemix.xml configuration files</li><li>SOAP 1.1 and 1.2 support</li><li>MIME attachments</li><li>WS-Addressing support</li><li>WSDL based and XBean based deployments</li><li>Support for all MEPs as consumers or providers</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/jms/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:jms=</span><span class="s">"http://servicemix.apache.org/jms/1.0"</sp
an><span class="nt">></span>

 <span class="c"><!-- add jms:consumer, jms:soap-consumer, jms:jca-consumer,</span>
<span class="c"> jms:provider, jms:soap-provider and jms:jca-provider definitions here --></span>

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-jms component defines six endpoint type:</p><ul style="list-style: square"><li><tt>jms:consumer</tt> :: This endpoint allows you to expose a service in the ESB to the outside world over JMS. Whenever it receives a JMS message, it will interact with the configured services on the ESB.</li><li><tt>jms:soap-consumer</tt> :: Similar to <tt>jms:consumer</tt>, but specifically geared towards handing SOAP requests and responses</li><li><tt>jms:jca-consumer</tt> :: Similar to <tt>jms:consumer</tt>, but adds the possibility of using a JCA resource adapter</li><li><tt>jms:provider</tt> :: Thi
s endpoint allows you to access remote services from within the ESB. It will send a JMS message whenever it receives a JBI MessageExchange</li><li><tt>jms:soap-provider</tt> :: Similar to <tt>jms:provider</tt>, but specifically geared towards performing SOAP requests</li><li><tt>jms:jca-provider</tt> :: Similar to <tt>jms:provider</tt>, but adds the possibility of using a JCA resource adapter</li></ul><p>It also provides one additional legacy endpoints, which are still available to ease migration from ServiceMix 3:</p><ul style="list-style: square"><li><tt>jms:endpoint</tt> :: (Deprecated) Legacy endpoint, capable to acting as a consumer or provider based on the configuration</li></ul><h3 id="jmsendpoint"><tt>jms: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"> activationSpec </td><td class="confluenceTd"> <em>javax.resource.spi.ActivationSpec</em> </td><td class="confluenceTd"> The ActivationSpec to use on a JCA consumer endpoint. </td></tr><tr><td class="confluenceTd"> bootstrapContext </td><td class="confluenceTd"> <em>javax.resource.spi.BootstrapContext</em> </td><td class="confluenceTd"> The BootstrapContext to use for a JCA consumer endpoint. </td></tr><tr><td class="confluenceTd"> connectionFactory </td><td class="confluenceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> A configured ConnectionFactory to use on this endpoint. </td></tr><tr><td class="confluenceTd"> defaultMep </td><td class="confluenceTd"> <em>java.net.URI</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> defaultOperation </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> description </td><td class=
"confluenceTd"> <em>org.w3c.dom.Document</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> destination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> A configured Destination to use on this endpoint. </td></tr><tr><td class="confluenceTd"> destinationStyle </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the destination type used with the jmsProviderDestinationName. Can be <code>queue</code> or <code>topic</code>. </td></tr><tr><td class="confluenceTd"> dynamic </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> </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"> initialContextFactory </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceT
d"> The class name of the JNDI InitialContextFactory to use. </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"> jmsProviderDestinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the destination created by a call to <code>Session.createQueue</code> or <code>Session.createTopic</code>. This property is used when <code>destination</code> and <code>jndiDestinationName</code> are both <code>null</code>. </td></tr><tr><td class="confluenceTd"> jmsProviderReplyToName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the reply destination created by a call to <code>Session.createQueue</code> or <code>Session.createTopic</code>. This pr
operty is used when <code>jndiReplyToName</code> is <code>null</code>. A temporary queue will be used if a replyTo is not provided. </td></tr><tr><td class="confluenceTd"> jndiConnectionFactoryName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the JMS ConnectionFactory to lookup in JNDI. Used if <code>connectionFactory</code> is <code>null</code> </td></tr><tr><td class="confluenceTd"> jndiDestinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the JMS Destination to lookup in JNDI. Used if <code>destination</code> is <code>null</code>. </td></tr><tr><td class="confluenceTd"> jndiProviderURL </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The provider URL used to create the JNDI context. </td></tr><tr><td class="confluenceTd"> jndiReplyToName </td><td class="confluenceTd"> <em>java.lang.S
tring</em> </td><td class="confluenceTd"> The name of the JMS Reply-to destination to lookup in JNDI. If this property is not set a temporary replyTo queue is used. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.JmsMarshaler</em> </td><td class="confluenceTd"> Specifies the class implementing the logic for marshaling and unmarshaling messages between the JMS destination and the endpoint. Defaults to <code>DefaultJmsMarshaler</code>. </td></tr><tr><td class="confluenceTd"> needJavaIdentifiers </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Indicates if the JMS properties used by the endpoint need to be spec compliant. </td></tr><tr><td class="confluenceTd"> policies </td><td class="confluenceTd"> (<em>java.lang.Object</em>)\* </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> processorName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td c
lass="confluenceTd"> Specifies the processor family to use for this endpoint. Can be: <ul> <li><code>multiplexing</code> (default)</li> <li><code>standard</code></li> <li><code>jca</code></li> </ul> </td></tr><tr><td class="confluenceTd"> resourceAdapter </td><td class="confluenceTd"> <em>javax.resource.spi.ResourceAdapter</em> </td><td class="confluenceTd"> The ResourceAdapter to use on a JCA consumer endpoint. </td></tr><tr><td class="confluenceTd"> role </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the role of this endpoint. Endpoints can be <code>consumer</code> or <code>provider</code>. </td></tr><tr><td class="confluenceTd"> roleAsString </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> rollbackOnError </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Indicat
es if the JBI exchange is rolled back if an error is encountered. </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"> soap </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> soapVersion </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> store </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> Specifies a persistent data store to hold pending exchanges for the endpoint. </td></tr><tr><td class="confluenceTd"> storeFactory </td><td class="confluenceTd"> <em>org.apache.servicemix.store.StoreFactory</em> </td><td class="confluenceTd"> Specifies the factory used to create presistent data stores fo
r this endpoint. </td></tr><tr><td class="confluenceTd"> synchronous </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Indicates if a JCA consumer endpoint sends the JBI exchange synchronously or asynchronously. This changes the transaction boundary. </td></tr><tr><td class="confluenceTd"> targetEndpoint </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> targetInterfaceName </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> targetService </td><td class="confluenceTd"> <em>javax.xml.namespace.QName</em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> useMsgIdInResponse </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Indicates whether the message id of the request message should be used as the correlation id in the response or the c
orrelation id of the request. </td></tr><tr><td class="confluenceTd"> wsdlResource </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> </td></tr></table></div><h3 id="jmsconsumer"><tt>jms:consumer</tt></h3><h4 id="Endpointproperties2">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"> cacheLevel </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the level of caching allowed by the listener. Valid values are 0 through 3. The values map to the following: <ul> <li>0 - <code>CACHE_NONE</code></li> <li>1 - <code>CACHE_CONNECTION</code></li> <li>2 - <code>CACHE_SESSION</code></li> <li>3 - <code>CACHE_CONSUMER</code></li> </ul> The default is <code>
CACHE_NONE</code>.<br/> This property only effects consumers whose <code>listenerType</code> property is set to <code>default</code>. </td></tr><tr><td class="confluenceTd"> clientId </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the JMS client id for a shared <code>Connection</code> created and used by this listener. </td></tr><tr><td class="confluenceTd"> component </td><td class="confluenceTd"> <em><a href="#org.apache.servicemix.common.DefaultComponenttypes">org.apache.servicemix.common.DefaultComponent</a></em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> concurrentConsumers </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the number of concurrent consumers created by the listener. This property is only used for consumers whose <code>listenerType</code> property is set to either <code>simple</code> or <code>default</
code>. </td></tr><tr><td class="confluenceTd"> connectionFactory </td><td class="confluenceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> Specifies the <code>ConnectionFactory</code> used by the endpoint. </td></tr><tr><td class="confluenceTd"> destination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Specifies the JMS <code>Destination</code> used to receive messages. </td></tr><tr><td class="confluenceTd"> destinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing reply destinations. </td></tr><tr><td class="confluenceTd"> destinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies a string identifying the JMS destination used to recieve messages. The destination is resolved using the <code>Desitinat
ionResolver</code>. </td></tr><tr><td class="confluenceTd"> destinationResolver </td><td class="confluenceTd"> <em>org.springframework.jms.support.destination.DestinationResolver</em> </td><td class="confluenceTd"> Specifies the class implementing logic for converting strings into destinations. The default is <code>DynamicDestinationResolver</code>. </td></tr><tr><td class="confluenceTd"> durableSubscriptionName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the name used to register the durable subscription. </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"> exceptionListener </td><td class="confluenceTd"> <em>javax.jms.ExceptionListener</em> </td><td class="confluenceTd"> Specifies an <code>ExceptionListener</code> to notify in case of a <code>JMSException
</code> is thrown by the registered message listener or the invocation infrastructure. </td></tr></table></div><p>| idleTaskExecutionLimit | <em>int</em> | Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in case of dynamic scheduling; see the "maxConcurrentConsumers" setting). Within each task execution, a number of message reception attempts (according to the "maxMessagesPerTask" setting) will each wait for an incoming message (according to the "receiveTimeout" setting). If all of those receive attempts in a given task return without a message, the task is considered idle with respect to received messages. Such a task may still be rescheduled; however, once it reached the specified "idleTaskExecutionLimit", it will shut down (in case of dynamic scaling). Raise this limit if you encounter too frequent scaling up a
nd down. With this limit being higher, an idle consumer will be kept around longer, avoiding the restart of a consumer once a new load of messages comes in. Alternatively, specify a higher "maxMessagePerTask" and/or "receiveTimeout" value, which will also lead to idle consumers being kept around for a longer time (while also increasing the average execution time of each scheduled task). </p><h3 id="jmsprovider"><tt>jms:provider</tt></h3><h4 id="Endpointproperties3">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"> connectionFactory </td><td class="confluenceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> Specifies the <code>ConnectionFactory</code> used by the endpoint. </td></tr><tr><td class="confluenceTd"> deliveryMode </td><td class="confluenceTd"> <em
>int</em> </td><td class="confluenceTd"> Specifies the JMS delivery mode used for the reply. Defaults to (2)(<code>PERSISTENT</code>). </td></tr><tr><td class="confluenceTd"> destination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Specifies the JMS <code>Destination</code> used to send messages. </td></tr><tr><td class="confluenceTd"> destinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing the destination used to send messages. </td></tr><tr><td class="confluenceTd"> destinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies a string identifying the JMS destination used to send messages. The destination is resolved using the <code>DesitinationResolver</code>. </td></tr><tr><td class="confluenceTd"> destinationResolver
</td><td class="confluenceTd"> <em>org.springframework.jms.support.destination.DestinationResolver</em> </td><td class="confluenceTd"> Specifies the class implementing logic for converting strings into destinations. The default is <code>DynamicDestinationResolver</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"> explicitQosEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the QoS values specified for the endpoint are explicitly used when a messages is sent. The default is <code>false</code>. </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"> jms102 </td><td c
lass="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Determines if the provider used JMS 1.0.2 compliant APIs. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.JmsProviderMarshaler</em> </td><td class="confluenceTd"> Specifies the class implementing the message marshaler. The message marshaller is responsible for marshalling and unmarshalling JMS messages. The default is <code>DefaultProviderMarshaler</code>. </td></tr><tr><td class="confluenceTd"> messageIdEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if your endpoint requires JMS message IDs. Setting the <code>messageIdEnabled</code> property to <code>false</code> causes the endpoint to call its message producer's <code>setDisableMessageID() </code> with a value of <code>true</code>. The JMS broker is then given a hint that it does not need to generate mess
age IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it. </td></tr><tr><td class="confluenceTd"> messageTimestampEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if your endpoints requires time stamps on its messages. Setting the <code>messageTimeStampEnabled</code> property to <code>false</code> causes the endpoint to call its message producer's <code>setDisableMessageTimestamp() </code> method with a value of <code>true</code>. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it. </td></tr><tr><td class="confluenceTd"> preserveMessageQos </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies whether we want to send message using the QoS settings specified on the message instead in
order to preserve message QoS. The default is <code>false</code>. </td></tr><tr><td class="confluenceTd"> priority </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the priority assigned to the JMS messages. Defaults to 4. </td></tr><tr><td class="confluenceTd"> pubSubDomain </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the destination is a topic. <code>true</code> means the destination is a topic. <code>false</code> means the destination is a queue. </td></tr><tr><td class="confluenceTd"> pubSubNoLocal </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if messages published by the listener's <code>Connection</code> are suppressed. The default is <code>false</code>. </td></tr><tr><td class="confluenceTd"> receiveTimeout </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Specifies the timeout for receivi
ng a message in milliseconds. </td></tr><tr><td class="confluenceTd"> replyDestination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Sets the reply destination. This JMS destination will be used as the default destination for the response messages when using an InOut JBI exchange. It will be used if the <code>replyDestinationChooser</code> does not return any value. </td></tr><tr><td class="confluenceTd"> replyDestinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing the destination used to recieve replies. </td></tr><tr><td class="confluenceTd"> replyDestinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Sets the name of the reply destination. This property will be used to create the <code>replyDestination</code> using the <code>d
estinationResolver</code> when the endpoint starts if the <code>replyDestination</code> has not been set. </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"> store </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> Sets the store used to store JBI exchanges that are waiting for a response JMS message. The store will be automatically created if not set. </td></tr><tr><td class="confluenceTd"> storeFactory </td><td class="confluenceTd"> <em>org.apache.servicemix.store.StoreFactory</em> </td><td class="confluenceTd"> Sets the store factory used to create the store. If none is set, a {@link MemoryStoreFactory} will be created and used instead. </td></tr><tr><td class="confluenceTd"> timeToLive </td><td class="confluenceTd"> <em>lon
g</em> </td><td class="confluenceTd"> Specifies the number of milliseconds a message is valid. </td></tr></table></div><h3 id="jmssoapconsumer"><tt>jms:soap-consumer</tt></h3><h4 id="Endpointproperties4">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"> cacheLevel </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the level of caching allowed by the listener. Valid values are 0 through 3. The values map to the following: <ul> <li>0 - <code>CACHE_NONE</code></li> <li>1 - <code>CACHE_CONNECTION</code></li> <li>2 - <code>CACHE_SESSION</code></li> <li>3 - <code>CACHE_CONSUMER</code></li> </ul> The default is <code>CACHE_NONE</code>.<br/> This property only effects consumers whose <code>listen
erType</code> property is set to <code>default</code>. </td></tr><tr><td class="confluenceTd"> clientId </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the JMS client id for a shared <code>Connection</code> created and used by this listener. </td></tr><tr><td class="confluenceTd"> component </td><td class="confluenceTd"> <em><a href="#org.apache.servicemix.common.DefaultComponenttypes">org.apache.servicemix.common.DefaultComponent</a></em> </td><td class="confluenceTd"> </td></tr><tr><td class="confluenceTd"> concurrentConsumers </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the number of concurrent consumers created by the listener. This property is only used for consumers whose <code>listenerType</code> property is set to either <code>simple</code> or <code>default</code>. </td></tr><tr><td class="confluenceTd"> connectionFactory </td><td class="conflue
nceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> Specifies the <code>ConnectionFactory</code> used by the endpoint. </td></tr><tr><td class="confluenceTd"> destination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Specifies the JMS <code>Destination</code> used to receive messages. </td></tr><tr><td class="confluenceTd"> destinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing reply destinations. </td></tr><tr><td class="confluenceTd"> destinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies a string identifying the JMS destination used to recieve messages. The destination is resolved using the <code>DesitinationResolver</code>. </td></tr><tr><td class="confluenceTd"> destinationResolver </td>
<td class="confluenceTd"> <em>org.springframework.jms.support.destination.DestinationResolver</em> </td><td class="confluenceTd"> Specifies the class implementing logic for converting strings into destinations. The default is <code>DynamicDestinationResolver</code>. </td></tr><tr><td class="confluenceTd"> durableSubscriptionName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the name used to register the durable subscription. </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"> exceptionListener </td><td class="confluenceTd"> <em>javax.jms.ExceptionListener</em> </td><td class="confluenceTd"> Specifies an <code>ExceptionListener</code> to notify in case of a <code>JMSException</code> is thrown by the registered message listener or the invocation infrastructure
. </td></tr></table></div><p>| idleTaskExecutionLimit | <em>int</em> | Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in case of dynamic scheduling; see the "maxConcurrentConsumers" setting). Within each task execution, a number of message reception attempts (according to the "maxMessagesPerTask" setting) will each wait for an incoming message (according to the "receiveTimeout" setting). If all of those receive attempts in a given task return without a message, the task is considered idle with respect to received messages. Such a task may still be rescheduled; however, once it reached the specified "idleTaskExecutionLimit", it will shut down (in case of dynamic scaling). Raise this limit if you encounter too frequent scaling up and down. With this limit being higher, an idle consumer will be kept around longer, avoi
ding the restart of a consumer once a new load of messages comes in. Alternatively, specify a higher "maxMessagePerTask" and/or "receiveTimeout" value, which will also lead to idle consumers being kept around for a longer time (while also increasing the average execution time of each scheduled task). </p><h3 id="jmssoapprovider"><tt>jms:soap-provider</tt></h3><h4 id="Endpointproperties5">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"> connectionFactory </td><td class="confluenceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> Specifies the <code>ConnectionFactory</code> used by the endpoint. </td></tr><tr><td class="confluenceTd"> deliveryMode </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the JMS delivery mode used f
or the reply. Defaults to (2)(<code>PERSISTENT</code>). </td></tr><tr><td class="confluenceTd"> destination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Specifies the JMS <code>Destination</code> used to send messages. </td></tr><tr><td class="confluenceTd"> destinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing the destination used to send messages. </td></tr><tr><td class="confluenceTd"> destinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies a string identifying the JMS destination used to send messages. The destination is resolved using the <code>DesitinationResolver</code>. </td></tr><tr><td class="confluenceTd"> destinationResolver </td><td class="confluenceTd"> <em>org.springframework.jms.support.destination.
DestinationResolver</em> </td><td class="confluenceTd"> Specifies the class implementing logic for converting strings into destinations. The default is <code>DynamicDestinationResolver</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"> explicitQosEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the QoS values specified for the endpoint are explicitly used when a messages is sent. The default is <code>false</code>. </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"> jms102 </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Determines
if the provider used JMS 1.0.2 compliant APIs. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.JmsProviderMarshaler</em> </td><td class="confluenceTd"> Specifies the class implementing the message marshaler. The message marshaller is responsible for marshalling and unmarshalling JMS messages. The default is <code>DefaultProviderMarshaler</code>. </td></tr><tr><td class="confluenceTd"> messageIdEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if your endpoint requires JMS message IDs. Setting the <code>messageIdEnabled</code> property to <code>false</code> causes the endpoint to call its message producer's <code>setDisableMessageID() </code> with a value of <code>true</code>. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choos
e to accept the hint or ignore it. </td></tr><tr><td class="confluenceTd"> messageTimestampEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if your endpoints requires time stamps on its messages. Setting the <code>messageTimeStampEnabled</code> property to <code>false</code> causes the endpoint to call its message producer's <code>setDisableMessageTimestamp() </code> method with a value of <code>true</code>. The JMS broker is then given a hint that it does not need to generate message IDs or add them to the messages from the endpoint. The JMS broker can choose to accept the hint or ignore it. </td></tr><tr><td class="confluenceTd"> policies </td><td class="confluenceTd"> (<em>org.apache.servicemix.soap.api.Policy</em>)\* </td><td class="confluenceTd"> Specifies an array of interceptors used to process SOAP messages. </td></tr><tr><td class="confluenceTd"> preserveMessageQos </td><td class="confluenceTd">
<em>boolean</em> </td><td class="confluenceTd"> Specifies whether we want to send message using the QoS settings specified on the message instead in order to preserve message QoS. The default is <code>false</code>. </td></tr><tr><td class="confluenceTd"> priority </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the priority assigned to the JMS messages. Defaults to 4. </td></tr><tr><td class="confluenceTd"> pubSubDomain </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the destination is a topic. <code>true</code> means the destination is a topic. <code>false</code> means the destination is a queue. </td></tr><tr><td class="confluenceTd"> pubSubNoLocal </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if messages published by the listener's <code>Connection</code> are suppressed. The default is <code>false</code>. </td></tr><tr><
td class="confluenceTd"> receiveTimeout </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Specifies the timeout for receiving a message in milliseconds. </td></tr><tr><td class="confluenceTd"> replyDestination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Sets the reply destination. This JMS destination will be used as the default destination for the response messages when using an InOut JBI exchange. It will be used if the <code>replyDestinationChooser</code> does not return any value. </td></tr><tr><td class="confluenceTd"> replyDestinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing the destination used to recieve replies. </td></tr><tr><td class="confluenceTd"> replyDestinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="con
fluenceTd"> Sets the name of the reply destination. This property will be used to create the <code>replyDestination</code> using the <code>destinationResolver</code> when the endpoint starts if the <code>replyDestination</code> has not been set. </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"> store </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> Sets the store used to store JBI exchanges that are waiting for a response JMS message. The store will be automatically created if not set. </td></tr><tr><td class="confluenceTd"> storeFactory </td><td class="confluenceTd"> <em>org.apache.servicemix.store.StoreFactory</em> </td><td class="confluenceTd"> Sets the store factory used to create the store. If none is set, a {
@link MemoryStoreFactory} will be created and used instead. </td></tr><tr><td class="confluenceTd"> timeToLive </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Specifies the number of milliseconds a message is valid. </td></tr><tr><td class="confluenceTd"> useJbiWrapper </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the endpoint expects SOAP messages to be wrapped in the JBI wrapper. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> validateWsdl </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the WSDL is checked WSI-BP compliance. Defaults to <code>true</code>. </td></tr><tr><td class="confluenceTd"> wsdl </td><td class="confluenceTd"> <em>org.springframework.core.io.Resource</em> </td><td class="confluenceTd"> Specifies the WSDL document describing the service's interface. </td></tr></table></div><h3 id="jmsjcaconsumer"><tt>jms
:jca-consumer</tt></h3><h4 id="Endpointproperties6">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"> activationSpec </td><td class="confluenceTd"> <em>javax.resource.spi.ActivationSpec</em> </td><td class="confluenceTd"> Specifies the activation information needed by the endpoint. </td></tr><tr><td class="confluenceTd"> bootstrapContext </td><td class="confluenceTd"> <em>javax.resource.spi.BootstrapContext</em> </td><td class="confluenceTd"> Specifies the <code>BootStrapContext</code> used to start the resource adapter. If this property is not set, a default <code>BootstrpContext</code> will be created. </td></tr><tr><td class="confluenceTd"> connectionFactory </td><td class="confluenceTd"> <em>javax.jms.ConnectionFactory</em> </td><td class="confluenceTd"> Specifies the &l
t;code>ConnectionFactory</code> used by the endpoint. </td></tr><tr><td class="confluenceTd"> destinationChooser </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.DestinationChooser</em> </td><td class="confluenceTd"> Specifies a class implementing logic for choosing reply destinations. </td></tr><tr><td class="confluenceTd"> destinationResolver </td><td class="confluenceTd"> <em>org.springframework.jms.support.destination.DestinationResolver</em> </td><td class="confluenceTd"> Specifies the class implementing logic for converting strings into destinations. The default is <code>DynamicDestinationResolver</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"> jms102 </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the consumer uses JMS 1.0.2 compliant APIs. Defaults to <code>false</code>. </td></tr><tr><td class="confluenceTd"> marshaler </td><td class="confluenceTd"> <em>org.apache.servicemix.jms.endpoints.JmsConsumerMarshaler</em> </td><td class="confluenceTd"> Specifies the class implementing the message marshaler. The message marshaller is responsible for marshalling and unmarshalling JMS messages. The default is <code>DefaultConsumerMarshaler</code>. </td></tr><tr><td class="confluenceTd"> pubSubDomain </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the destination is a topic. <code>true</code> means the destination is a topic. <code>false</code> means the destination is a queue. </td></tr><tr><td class="confluenceTd"> replyDeliveryMode </td
><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the JMS delivery mode used for the reply. Defaults to 2(<code>PERSISTENT</code>). </td></tr><tr><td class="confluenceTd"> replyDestination </td><td class="confluenceTd"> <em>javax.jms.Destination</em> </td><td class="confluenceTd"> Specifies the JMS <code>Destination</code> for the replies. If this value is not set the endpoint will use the <code>destinationChooser</code> property or the <code>replyDestinationName</code> property to determine the desitination to use. </td></tr><tr><td class="confluenceTd"> replyDestinationName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> Specifies the name of the JMS destination to use for the reply. The actual JMS destination is resolved using the <code>DestinationResolver</code> specified by the <code>.destinationResolver</code> property. </td></tr><tr><td class="confluenceTd"> repl
yExplicitQosEnabled </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the QoS values specified for the endpoint are explicitly used when the reply is sent. The default is <code>false</code>. </td></tr><tr><td class="confluenceTd"> replyPriority </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> Specifies the JMS message priority of the reply. Defaults to 4. </td></tr><tr><td class="confluenceTd"> replyProperties </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> Specifies custom properties to be placed in the reply's JMS header. </td></tr><tr><td class="confluenceTd"> replyTimeToLive </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Specifies the number of milliseconds the reply message is valid. The default is unlimited. </td></tr><tr><td class="confluenceTd"> resourceAdapter </td><td class="confluenceTd"> <em>javax.resource.spi.ResourceAdapter
</em> </td><td class="confluenceTd"> Specifies the resource adapter used for the endpoint. </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"> stateless </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the consumer retains state information about the message exchange while it is in process. </td></tr><tr><td class="confluenceTd"> store </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> Specifies the persistent store used to store JBI exchanges that are waiting to be processed. The store will be automatically created if not set and the endpoint's <code>stateless</code> property is set to <code>false</code>. </td></tr><tr><td class="confluenceTd"> storeFactory </td><td class="confluen
ceTd"> <em>org.apache.servicemix.store.StoreFactory</em> </td><td class="confluenceTd"> Specifies the store factory used to create the store. If none is set and the endpoint's <code>stateless</code> property is set to <code>false</code>, a {@link MemoryStoreFactory} will be created and used instead. </td></tr><tr><td class="confluenceTd"> synchronous </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> Specifies if the consumer will block while waiting for a response. This means the consumer can only process one message at a time. Defaults to <code>true</code>. </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 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"> useMessageIdInResponse </td><td class="confluenceTd"> <em>java.lang.Boolean</em> </td><td class="confluenceTd"> Specifies if the request message's ID is used as the reply's correlation ID. The default behavior is to use the request's correlation ID. Setting this to <code>true</code> means the request's message ID
will be used instead. </td></tr></table></div>
[... 5 lines stripped ...]
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-mail.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-mail.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-mail.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-mail.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="servicemixmail">servicemix-mail</h2><h3 id="Overview">Overview</h3><p>he ServiceMix Mail component provides support for receiving and sending mails via the enterprise service bus.</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/mail/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:mail=</span><span class="s">"http://servicemix.apache.org/mail/1.0"</span><span class="nt">></span>

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

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-mail component defines two endpo
int type:</p><ul style="list-style: square"><li><tt>mail:poller</tt> :: Connect to a POP3 or IMAP server and send a MessageExchange for every mail</li><li><tt>mail:sender</tt> :: Connect to an SMTP server and send a mail for every JBI MessageExchange it receives</li></ul><h3 id="mailpoller"><tt>mail: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"> 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"> connection </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI used to connec
t to a mail server. <br /><br /> <b><u>Templates:</u></b> <br /> nbsp; i><rotocol>//<ser><ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?password=<assword>/i> <br /><b> nbsp; nbsp; nbsp;OR</b><br/> nbsp; i><rotocol>//<ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?user=<ser>password=<assword>/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 (example: pop3 or imap)</td> </tr> <tr> <td>user</td> <td>the user name used to log into an account</td
> </tr> <tr> <td>host</td> <td>the name or ip address of the mail server</td> </tr> <tr> <td>port</td> <td>the port number to use (optional)</td> </tr> <tr> <td>folder</td> <td>the folder to poll from (optional)</td> </tr> <tr> <td>password</td> <td>the password for the login</td> </tr> </table> <br/> <b><u>Examples:</u></b><br /> nbsp; i>imap://lhein@imapserver:143/INBOX?password=mypass</i><br /> nbsp; i>pop3://pop3server/INBOX?user=me@myhome.org;password=mypass</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customProperties </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> <p>Specifies a <code>java.util.Map</code> which may contain additional properties for the connection. <br/> <br/><b><u>Example for disab
ling TOP for POP3 headers:</u></b><br /> i><b>key</b>: "mail.pop3.disabletop"</i> <br /> i><b>value</b>: "true"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customTrustManagers </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies one or more trust manager classes separated by a semicolon (<b>;</b>).<br/> These classes have to implement the <code>Trustmanager</code> interface and need to provide an empty default constructor to be valid.<br/><br /> If you want to accept all security certificates without a check you may consider using the <code>DummyTrustManager</code> class. It is actually only an empty stub without any checking logic. <br/><b>But be aware that this will be a security risk in production environments. </b></p> <i> nbsp; he default
value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> debugMode </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>Specifies if the JavaMail is run in <code>DEBUG</code> mode. This means that while connecting to server and processing mails a detailed log is written to debug output. <br /> This mode is very handy if you are experiencing problems with your mail server connection and you want to find out what is going wrong in communication with the server. <br /><br /> nbsp; b>true</b> - <i>the debug mode is <b>enabled</b></i> <br /> nbsp; b>false</b> - <i>the debug mode is <b>disabled</b></i></p> <i> nbsp; he default value is <b>false</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> delay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of time in millisec
onds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> deleteProcessedMessages </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>This flag is used to indicate what happens to a processed mail polled from a mail folder. If it is set to <code>true</code> the mail will be deleted after it was sent into the bus successfully. If set to <code>false</code> the mail will reside inside the mail folder but will be marked as already seen.<br/> If the sending of the mail results in an error, the mail will not be deleted / marked and reprocessed on next run of the polling cycle.<p> <i> nbsp; he default value is <b>false</b></i> </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.mail.marshaler.AbstractMailMarshaler</em> </td><td class="confluenceTd"> <p>With this method you can specify a marshaler class which provides the logic for converting a mail into a normalized message. This class has to extend the abstract class <code>AbstractMailMarshaler</code> or an extending class. If you don't specify a marshaler, the <code>DefaultMailMarshaler</code> will be used.</p> </td></tr><tr><td class="con
fluenceTd"> maxFetchSize </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>This sets the maximum amount of mails to process within one polling cycle. If the maximum amount is reached all other mails in "unseen" state will be skipped.</p> <i> nbsp; he default value is <b>-1 (unlimited)</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"> processOnlyUnseenMessages </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>This flag is used to indicate whether all mails are polled from a mail folder or only the unseen mails are processed.<br/><br /> If it is set to <b><code>true</code></b> only the unseen mails will be processed.<br /> If it is set to <b><code>false</code></b>
all mails will be processed.<br/></p> <i> nbsp; he default value is <b>true</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-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"> storage </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> <p>Specifies a <code>org.apache.servicemix.store.Store</code> object which will be used for storing the identifications of already processed messages.<br/> <b>This store is only used with the POP3 protocol and if unsee
n mails are processed only.</b></p> <i> nbsp; he default value is <b>null</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 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></table></div><h3 id="mailsender"><tt>mail:sender</tt></h3><h4 id="Endpointproperties2">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"> connection </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI used to connect to a mail server. <br /><br /> <b><u>Templates:</u></b> <br /> nbsp; i><rotocol>//<ser><ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?password=<assword>/i> <br /><b> nbsp; nbsp; nbsp;OR</b><br/> nbsp; i><rotoc
ol>//<ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?user=<ser>password=<assword>/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 (example: pop3 or imap)</td> </tr> <tr> <td>user</td> <td>the user name used to log into an account</td> </tr> <tr> <td>host</td> <td>the name or ip address of the mail server</td> </tr> <tr> <td>port</td> <td>the port number to use (optional)</td> </tr> <tr> <td>folder</td> <td>the folder to poll from (optional)</td> </tr> <tr> <td>password</td> <td>the password for the login</td> </
tr> </table> <br/> <b><u>Example:</u></b><br /> nbsp; i>smtp://lhein@myserver?password=myPass</i><br /></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customProperties </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> <p>Specifies a <code>java.util.Map</code> which may contain additional properties for the connection. <br/> <br/><b><u>Example for disabling TOP for POP3 headers:</u></b><br /> i><b>key</b>: "mail.pop3.disabletop"</i> <br /> i><b>value</b>: "true"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customTrustManagers </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies one or more trust manager classes separated
by a semicolon (<b>;</b>).<br/> These classes have to implement the <code>Trustmanager</code> interface and need to provide an empty default constructor to be valid.<br/><br /> If you want to accept all security certificates without a check you may consider using the <code>DummyTrustManager</code> class. It is actually only an empty stub without any checking logic. <br/><b>But be aware that this will be a security risk in production environments. </b></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> debugMode </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>Specifies if the JavaMail is run in <code>DEBUG</code> mode. This means that while connecting to server and processing mails a detailed log is written to debug output. <br /> This mode is very handy if you are experiencing problems with your mail server connecti
on and you want to find out what is going wrong in communication with the server. <br /><br /> nbsp; b>true</b> - <i>the debug mode is <b>enabled</b></i> <br /> nbsp; b>false</b> - <i>the debug mode is <b>disabled</b></i></p> <i> nbsp; he default value is <b>false</b></i><br/><br/> </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"> ignoreMessageProperties </td><td class="confluenceTd"> (<em>java.lang.Object</em>)\* </td><td class="confluenceTd"> <p>Specifies a <code>java.util.List</code> which may contain message properties to skip. <br/> <br/><b><u>Example for skipping all kind of addresses from the normalized message:</u></b><br /> i><b>value</b>: "org.apache.servicemix.mail.to"</i> <br
/> i><b>value</b>: "org.apache.servicemix.mail.cc"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.bcc"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.from"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.replyto"</i> <br /></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </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.mail.marshaler.AbstractMailMarshaler</em> </td><td class="confluenceTd"> <p>With this method you can specify a marshaler class which provides the logic for converting a normalized message into a mail. This class has to extend the abstract class <code>Ab
stractMailMarshaler</code> or an extending class. If you don't specify a marshaler, the <code>DefaultMailMarshaler</code> will be used.</p> </td></tr><tr><td class="confluenceTd"> receiver </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the receiver address(es) of the mail which is being sent.</p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> sender </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the sender address of the mail which is being sent.</p> <i> nbsp; he default value is <b>no-reply@localhost</b></i><br/><br/> </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></table></div>
+ <h2 id="servicemixmail">servicemix-mail</h2><h3 id="Overview">Overview</h3><p>he ServiceMix Mail component provides support for receiving and sending mails via the enterprise service bus.</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/mail/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:mail=</span><span class="s">"http://servicemix.apache.org/mail/1.0"</span><span class="nt">></span>

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

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="Endpointtypes">Endpoint types</h4><p>The servicemix-mail component defines two endpo
int type:</p><ul style="list-style: square"><li><p><tt>mail:poller</tt> :: Connect to a POP3 or IMAP server and send a MessageExchange for every mail</p></li><li><p><tt>mail:sender</tt> :: Connect to an SMTP server and send a mail for every JBI MessageExchange it receives</p></li></ul><h3 id="mailpoller"><tt>mail: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"> 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"> connection </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI
used to connect to a mail server. <br /><br /> <b><u>Templates:</u></b> <br /> nbsp; i><rotocol>//<ser><ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?password=<assword>/i> <br /><b> nbsp; nbsp; nbsp;OR</b><br/> nbsp; i><rotocol>//<ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?user=<ser>password=<assword>/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 (example: pop3 or imap)</td> </tr> <tr> <td>user</td> <td>the user name used to log into an
account</td> </tr> <tr> <td>host</td> <td>the name or ip address of the mail server</td> </tr> <tr> <td>port</td> <td>the port number to use (optional)</td> </tr> <tr> <td>folder</td> <td>the folder to poll from (optional)</td> </tr> <tr> <td>password</td> <td>the password for the login</td> </tr> </table> <br/> <b><u>Examples:</u></b><br /> nbsp; i>imap://lhein@imapserver:143/INBOX?password=mypass</i><br /> nbsp; i>pop3://pop3server/INBOX?user=me@myhome.org;password=mypass</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customProperties </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> <p>Specifies a <code>java.util.Map</code> which may contain additional properties for the connection. <br/> <br/><b><u>Exa
mple for disabling TOP for POP3 headers:</u></b><br /> i><b>key</b>: "mail.pop3.disabletop"</i> <br /> i><b>value</b>: "true"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customTrustManagers </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies one or more trust manager classes separated by a semicolon (<b>;</b>).<br/> These classes have to implement the <code>Trustmanager</code> interface and need to provide an empty default constructor to be valid.<br/><br /> If you want to accept all security certificates without a check you may consider using the <code>DummyTrustManager</code> class. It is actually only an empty stub without any checking logic. <br/><b>But be aware that this will be a security risk in production environments. </b></p> <i> nbsp;&n
bsp;he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> debugMode </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>Specifies if the JavaMail is run in <code>DEBUG</code> mode. This means that while connecting to server and processing mails a detailed log is written to debug output. <br /> This mode is very handy if you are experiencing problems with your mail server connection and you want to find out what is going wrong in communication with the server. <br /><br /> nbsp; b>true</b> - <i>the debug mode is <b>enabled</b></i> <br /> nbsp; b>false</b> - <i>the debug mode is <b>disabled</b></i></p> <i> nbsp; he default value is <b>false</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> delay </td><td class="confluenceTd"> <em>long</em> </td><td class="confluenceTd"> Sets the amount of ti
me in milliseconds that the endpoint should wait before making the first poll. </td></tr><tr><td class="confluenceTd"> deleteProcessedMessages </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>This flag is used to indicate what happens to a processed mail polled from a mail folder. If it is set to <code>true</code> the mail will be deleted after it was sent into the bus successfully. If set to <code>false</code> the mail will reside inside the mail folder but will be marked as already seen.<br/> If the sending of the mail results in an error, the mail will not be deleted / marked and reprocessed on next run of the polling cycle.<p> <i> nbsp; he default value is <b>false</b></i> </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.mail.marshaler.AbstractMailMarshaler</em> </td><td class="confluenceTd"> <p>With this method you can specify a marshaler class which provides the logic for converting a mail into a normalized message. This class has to extend the abstract class <code>AbstractMailMarshaler</code> or an extending class. If you don't specify a marshaler, the <code>DefaultMailMarshaler</code> will be used.</p> </td></tr><tr>
<td class="confluenceTd"> maxFetchSize </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> <p>This sets the maximum amount of mails to process within one polling cycle. If the maximum amount is reached all other mails in "unseen" state will be skipped.</p> <i> nbsp; he default value is <b>-1 (unlimited)</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"> processOnlyUnseenMessages </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>This flag is used to indicate whether all mails are polled from a mail folder or only the unseen mails are processed.<br/><br /> If it is set to <b><code>true</code></b> only the unseen mails will be processed.<br /> If it is set to <b><code>false<
;/code></b> all mails will be processed.<br/></p> <i> nbsp; he default value is <b>true</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-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"> storage </td><td class="confluenceTd"> <em>org.apache.servicemix.store.Store</em> </td><td class="confluenceTd"> <p>Specifies a <code>org.apache.servicemix.store.Store</code> object which will be used for storing the identifications of already processed messages.<br/> <b>This store is only used with the POP3 protoco
l and if unseen mails are processed only.</b></p> <i> nbsp; he default value is <b>null</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 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></table></div><h3 id="mailsender"><tt>mail:sender</tt></h3><h4 id="Endpointproperties2">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"> connection </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the connection URI used to connect to a mail server. <br /><br /> <b><u>Templates:</u></b> <br /> nbsp; i><rotocol>//<ser><ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?password=<assword>/i> <br /><b> nbsp; nbsp; nbsp;OR</b><br/> nbsp;&nb
sp;i><rotocol>//<ost><a href=":<ort>">:<ort></a><a href="../../<older>.html">/<older></a>?user=<ser>password=<assword>/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 (example: pop3 or imap)</td> </tr> <tr> <td>user</td> <td>the user name used to log into an account</td> </tr> <tr> <td>host</td> <td>the name or ip address of the mail server</td> </tr> <tr> <td>port</td> <td>the port number to use (optional)</td> </tr> <tr> <td>folder</td> <td>the folder to poll from (optional)</td> </tr> <tr> <td>password</td> <td>the password for the login
</td> </tr> </table> <br/> <b><u>Example:</u></b><br /> nbsp; i>smtp://lhein@myserver?password=myPass</i><br /></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customProperties </td><td class="confluenceTd"> <em>java.util.Map</em> </td><td class="confluenceTd"> <p>Specifies a <code>java.util.Map</code> which may contain additional properties for the connection. <br/> <br/><b><u>Example for disabling TOP for POP3 headers:</u></b><br /> i><b>key</b>: "mail.pop3.disabletop"</i> <br /> i><b>value</b>: "true"</i></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> customTrustManagers </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies one or more trust manager clas
ses separated by a semicolon (<b>;</b>).<br/> These classes have to implement the <code>Trustmanager</code> interface and need to provide an empty default constructor to be valid.<br/><br /> If you want to accept all security certificates without a check you may consider using the <code>DummyTrustManager</code> class. It is actually only an empty stub without any checking logic. <br/><b>But be aware that this will be a security risk in production environments. </b></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> debugMode </td><td class="confluenceTd"> <em>boolean</em> </td><td class="confluenceTd"> <p>Specifies if the JavaMail is run in <code>DEBUG</code> mode. This means that while connecting to server and processing mails a detailed log is written to debug output. <br /> This mode is very handy if you are experiencing problems with your mail s
erver connection and you want to find out what is going wrong in communication with the server. <br /><br /> nbsp; b>true</b> - <i>the debug mode is <b>enabled</b></i> <br /> nbsp; b>false</b> - <i>the debug mode is <b>disabled</b></i></p> <i> nbsp; he default value is <b>false</b></i><br/><br/> </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"> ignoreMessageProperties </td><td class="confluenceTd"> (<em>java.lang.Object</em>)\* </td><td class="confluenceTd"> <p>Specifies a <code>java.util.List</code> which may contain message properties to skip. <br/> <br/><b><u>Example for skipping all kind of addresses from the normalized message:</u></b><br /> i><b>value</b>: "org.apache.servicemix.mail.to"
</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.cc"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.bcc"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.from"</i> <br /> i><b>value</b>: "org.apache.servicemix.mail.replyto"</i> <br /></p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </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.mail.marshaler.AbstractMailMarshaler</em> </td><td class="confluenceTd"> <p>With this method you can specify a marshaler class which provides the logic for converting a normalized message into a mail. This class has to extend the abstract cla
ss <code>AbstractMailMarshaler</code> or an extending class. If you don't specify a marshaler, the <code>DefaultMailMarshaler</code> will be used.</p> </td></tr><tr><td class="confluenceTd"> receiver </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the receiver address(es) of the mail which is being sent.</p> <i> nbsp; he default value is <b>null</b></i><br/><br/> </td></tr><tr><td class="confluenceTd"> sender </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> <p>Specifies the sender address of the mail which is being sent.</p> <i> nbsp; he default value is <b>no-reply@localhost</b></i><br/><br/> </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></
table></div>
</div>
</div>
Modified: servicemix/site/production/docs/4.4.x/jbi/components/servicemix-osworkflow.html
URL: http://svn.apache.org/viewvc/servicemix/site/production/docs/4.4.x/jbi/components/servicemix-osworkflow.html?rev=1444219&r1=1444218&r2=1444219&view=diff
==============================================================================
--- servicemix/site/production/docs/4.4.x/jbi/components/servicemix-osworkflow.html (original)
+++ servicemix/site/production/docs/4.4.x/jbi/components/servicemix-osworkflow.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="servicemixosworkflow">servicemix-osworkflow</h2><h3 id="Overview">Overview</h3><p>The ServiceMix OSWorkflow component provides workflow functionality to the ESB. You can specify one or more workflows and it's processing will start when a valid message is received.</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/osworkflow/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:osworkflow=</span><span class="s">"http://servicemix.apache.org/osworkflow/1.0"</span><span class="nt">></span>

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

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="E
ndpointtypes">Endpoint types</h4><p>The servicemix-osworkflow component defines a single endpoint type:</p><ul style="list-style: square"><li><tt>osworkflow:endpoint</tt> :: The endpoint will receive messages from the NMR and will then start the processing of the workflow.</li></ul><h3 id="osworkflowendpoint"><tt>osworkflow: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"> action </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> The initial action to trigger in the workflow. </td></tr><tr><td class="confluenceTd"> caller </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The caller user name to be used when executing the workflow. </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"> 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"> workflowName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the workflow to be used for handling the exchange. </td></tr></table></div>
+ <h2 id="servicemixosworkflow">servicemix-osworkflow</h2><h3 id="Overview">Overview</h3><p>The ServiceMix OSWorkflow component provides workflow functionality to the ESB. You can specify one or more workflows and it's processing will start when a valid message is received.</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/osworkflow/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:osworkflow=</span><span class="s">"http://servicemix.apache.org/osworkflow/1.0"</span><span class="nt">></span>

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

<span class="nt"></beans></span>
</pre></div>
</div><h4 id="E
ndpointtypes">Endpoint types</h4><p>The servicemix-osworkflow component defines a single endpoint type:</p><ul style="list-style: square"><li><p><tt>osworkflow:endpoint</tt> :: The endpoint will receive messages from the NMR and will then start the processing of the workflow.</p></li></ul><h3 id="osworkflowendpoint"><tt>osworkflow: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"> action </td><td class="confluenceTd"> <em>int</em> </td><td class="confluenceTd"> The initial action to trigger in the workflow. </td></tr><tr><td class="confluenceTd"> caller </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The caller user name to be used when executing the workflow. </td></tr><tr><td class="confluenceTd"> end
point </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"> 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"> workflowName </td><td class="confluenceTd"> <em>java.lang.String</em> </td><td class="confluenceTd"> The name of the workflow to be used for handling the exchange. </td></tr></table></div>
</div>
</div>