Package com.adaptris.core.msmq

Provides adapter connectivity to Microsoft Message Queueing Services (MSMQ).

See: Description

Interface Summary

Interface	Description
MsmqMessageFormat	Interface that controls how the AdaptrisMessage is copeid into the MSMQ Message is generated

Class Summary

Class	Description
ByteArrayMessageFormat	Generates a MSMQ Message Body that has a variant of VT_UI1 | VT_ARRAY.
ConfiguredProperty	Add a statically configured value as a MSMQMessage property.
MessageIdMapper	Copies the AdaptrisMessage uniqueId to and from MSMQMessage fields.
MetadataMapper	Copy AdaptrisMessage metadata values to and from MSMQMessage fields.
MsmqConnection	Connection for MSMQ.
MsmqPollingConsumer	MSMQ Polling Consumer.
MsmqProducerBase	Abstract MSMQ implementation of AdaptrisMessageProducer Request reply is not supported, an UnsupportedOperationException is thrown if an attempt is made to use request() The AdaptrisConnection associated with this producer type should be a MsmqConnection.
PropertyMapper	Abstract base class for mapping MSMQMessage fields to AdaptrisMessage objects and vice versa.
StandardMsmqProducer	MSMQ Producer implementation.
StringMessageFormat	Generates a MSMQ Message Body that has a variant of VT_BSTR.
XpathProperty	Resolve an XPath on the AdaptrisMessage payload and use that as a MSMQMessage field.

Package com.adaptris.core.msmq Description

Provides adapter connectivity to Microsoft Message Queueing Services (MSMQ).

An example channel configuration for use with this set of produce / consumers could be.

<channel>
  <produce-connection xsi:type="java:com.adaptris.core.msmq.MsmqConnection"/>
  <consume-connection xsi:type="java:com.adaptris.core.msmq.MsmqConnection"/>
  <workflow-list>
    <workflow xsi:type="java:com.adaptris.core.StandardWorkflow">
      <consumer xsi:type="java:com.adaptris.core.msmq.MsmqPollingConsumer">
          <destination xsi:type="java:com.adaptris.core.ConfiguredConsumeDestination">
              <destination>DIRECT=OS:.\private$\myqueue</destination>
              <configured-thread-name>MSMQ_LOOPBAK</configured-thread-name>
          </destination>
          <share-mode>MQ_DENY_NONE</share-mode>
          <transaction-mode>MQ_NO_TRANSACTION</transaction-mode>
          <property-mapper xsi:type="java:com.adaptris.core.msmq.MetadataMapper">
            <property-name>Label</property-name>
            <convert-null>true</convert-null>
            <metadata-key>msmqLabelMetadataKey</metadata-key>
          </property-mapper>
          <property-mapper xsi:type="java:com.adaptris.core.msmq.MetadataMapper">
            <property-name>ArrivedTime</property-name>
            <metadata-key>msmqArrivedTimeMetadataKey</metadata-key>
          </property-mapper>          
          <property-mapper xsi:type="java:com.adaptris.core.msmq.MetadataMapper">
            <property-name>Id</property-name>
            <metadata-key>msmqIdMetadataKey</metadata-key>
            <byte-translator xsi:type="java:com.adaptris.util.text.Base64ByteTranslator"/>            
          </property-mapper>                         
      </consumer>
      <service-collection xsi:type="java:com.adaptris.core.ServiceList"/>
      <producer xsi:type="java:com.adaptris.core.msmq.MsmqProducer">
          <destination xsi:type="java:com.adaptris.core.ConfiguredProduceDestination">
              <destination>DIRECT=OS:.\private$\myqueue</destination>
          </destination>
          <share-mode>MQ_DENY_NONE</share-mode>
          <transaction-mode>MQ_NO_TRANSACTION</transaction-mode>
          <property-mapper xsi:type="java:com.adaptris.core.msmq.MetadataMapper">
            <property-name>Label</property-name>
            <metadata-key>msmqLabelMetadataKey</metadata-key>
          </property-mapper>
          <property-mapper xsi:type="java:com.adaptris.core.msmq.MetadataMapper">
            <property-name>CorrelationId</property-name>
            <convert-null>true</convert-null>
            <metadata-key>msmqIdMetadataKey</metadata-key>
            <byte-translator xsi:type="java:com.adaptris.util.text.Base64ByteTranslator"/>            
          </property-mapper>
      </producer>
     </workflow>
  </workflow-list>
</channel>
  

There is no support for transactions using MQTransaction objects, but MQ_MTS_TRANSACTION, MQ_XA_TRANSACTION and MQ_SINGLE_MESSAGE are supported.