Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

Spring.Messaging Assembly

Referenced Assemblies

Assembly Reference Description
Common.Logging  
mscorlib  
mscorlib  
Spring.Core  
Spring.Data  
System  
System.Messaging  
System.Transactions  
System.Xml  

Namespaces

Namespace Description
Spring.Messaging Missing <summary> Documentation for Spring.Messaging
Spring.Messaging.Core Missing <summary> Documentation for Spring.Messaging.Core
Spring.Messaging.Listener Missing <summary> Documentation for Spring.Messaging.Listener
Spring.Messaging.Support Missing <summary> Documentation for Spring.Messaging.Support
Spring.Messaging.Support.Converters Missing <summary> Documentation for Spring.Messaging.Support.Converters

Classes

Class Description
AbstractListenerContainer Provides basic lifecyle management methods for implementing a message listener container.
AbstractMessageListenerContainer Defines a minimal programming model for message listener containers. They are expected to invoke a IMessageListener upon asynchronous receives of a MSMQ message. Access to obtain MessageQueue and IMessageConverter instances is available through the IMessageQueueFactory property, the default implementation DefaultMessageQueueFactory provides per-thread instances of these classes.
AbstractPeekingMessageListenerContainer Base class for listener container implementations which are based on Peeking for messages on a MessageQueue. Peeking is the only resource efficient approach that can be used in order to have MessageQueue receipt in conjunction with transactions, either local MSMQ transactions, local ADO.NET based transactions, or DTC transactions. See SimpleMessageListenerContainer for an implementation based on a synchronous receives and you do not require transactional support.
AbstractSendToQueueExceptionHandler Provides common functionality to exception handlers that will send the exceptional message to another queue.
AbstractTransactionalMessageListenerContainer An implementation of a Peeking based MessageListener container that starts a transaction before recieving a message. The IPlatformTransactionManager implementation determines the type of transaction that will be started. An exception while processing the message will result in a rollback, otherwise a transaction commit will be performed.
ActiveXMessageConverter An IMessageConverter implementation that delegates to an instance of ActiveXMessageFormatter to convert messages.
BinaryMessageConverter An IMessageConverter implementation that delegates to an instance of BinaryMessageFormatter to convert messages.
DefaultMessageQueueFactory A IMessageQueueFactory implementation that caches MessageQueue and IMessageConverter instances. The MessageQueue objects are created by retrieving them by-name from the ApplicationContext.
DistributedTxMessageListenerContainer A MessageListenerContainer that uses distributed (DTC) based transactions. Exceptions are handled by instances of IDistributedTransactionExceptionHandler.
LocallyExposedMessageQueueResourceHolder MessageQueueResourceHolder marker subclass that indicates local exposure, i.e. that does not indicate an externally managed transaction.
MessageListenerAdapter Message listener adapter that delegates the handling of messages to target listener methods via reflection DynamicReflectionManager, with flexible message type conversion. Allows listener methods to operate on message content types, completely independent from the MSMQ API.
MessageQueueFactoryObject Factory for creating MessageQueues. This factory will create prototype instances, i.e. every call to GetObject will return a new MessageQueue object.
MessageQueueGatewaySupport Convenient super class for application classes that need MSMQ access.
MessageQueueMetadata Encapsulates additional metadata information about the MessageQueue that can not be easily obtained from the MessageQueue itself.
MessageQueueMetadataCache Missing <summary> documentation for T:Spring.Messaging.Core.MessageQueueMetadataCache
MessageQueueResourceHolder MessageQueue resource holder, wrapping a MessageQueueTransaction. MessageQueueTransactionManager binds instances of this class to the thread.
MessageQueueTemplate Helper class that simplifies MSMQ access code.
MessageQueueTransactionManager IPlatformTransactionManager implementation for MSMQ. Binds a MessageQueueTransaction to the thread.
MessagingException Base exception class for exceptions thrown by Spring in Spring.Messaging
NonTransactionalMessageListenerContainer An implementation of a Peeking based MessageListener container that does not surround the receive operation with a transaction.
QueueUtils Utility methods to support Spring's MSMQ functionality
SendToQueueDistributedTransactionExceptionHandler detects poison messages by tracking the Message Id property in memory with a count of how many times an exception has occurred. If that count is greater than the handler's MaxRetry count it will be sent to another queue. The queue to send the message to is specified via the property M essageQueueObjectName.
SendToQueueExceptionHandler Keeps track of the Message's Id property in memory with a count of how many times an exception has occurred. If that count is greater than the handler's MaxRetry count it will be sent to another queue using the provided MessageQueueTransaction. The queue to send the message to is specified via the property MessageQueueObjectName.
TransactionalMessageListenerContainer A MessageListenerContainer that uses local (non-DTC) based transactions. Exceptions are handled by instances of IMessageTransactionExceptionHandler.
XmlDocumentConverter Converts an XmlDocument to a Message and vice-versa by using the message's body stream.
XmlMessageConverter An IMessageConverter implementation that delegates to an instance of XmlMessageFormatter to convert messages.

Interfaces

Interface Description
IDistributedTransactionExceptionHandler Exception handler for use with DTC based message listener container. such as DistributedTxMessageListenerContainer. See SendToQueueDistributedTransactionExceptionHandler for an implementation that detects poison messages and send them to another queue.
IExceptionHandler Exception handler called when an exception occurs during non-transactional receive processing.
IMessageConverter An interface specifying the contract to convert to and from Message objects.
IMessageListener The callback invoked when a message is received.
IMessageQueueFactory An interface for creating MessageQueue and IMessageConverter objects from object definitions defined in the application context.
IMessageQueueOperations Specifies a basic set of helper MSMQ opertions.
IMessageTransactionExceptionHandler The exception handler within a transactional context.
IResourceFactory Callback interface for resource creation. Serving as argument for the 
GetMessageQueueTransaction
method.

Delegates

Delegate Description
MessageConverterCreatorDelegate Delegate for creating IMessageConverter instance. Used by DefaultMessageQueueFactory to register a creation function with a given name.
MessagePostProcessorDelegate To be used with MessageQueueTemplate's send method that convert an object to a message.
MessageQueueCreatorDelegate Delegate for creating MessageQueue instance. Used by DefaultMessageQueueFactory to register a creation function with a given name.

Enumerations

Enumeration Description
TransactionAction Action to perform on the MessageQueueTransaction when handling message listener exceptions.