Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

Spring.Messaging.Nms Assembly

Referenced Assemblies

Assembly Reference Description
Apache.NMS  
Common.Logging  
mscorlib  
mscorlib  
Spring.Core  
Spring.Data  
System.Data  
System.Xml  

Namespaces

Namespace Description
Spring.Messaging.Nms.Config Missing <summary> Documentation for Spring.Messaging.Nms.Config
Spring.Messaging.Nms.Connections Missing <summary> Documentation for Spring.Messaging.Nms.Connections
Spring.Messaging.Nms.Core Missing <summary> Documentation for Spring.Messaging.Nms.Core
Spring.Messaging.Nms.Listener Missing <summary> Documentation for Spring.Messaging.Nms.Listener
Spring.Messaging.Nms.Listener.Adapter Missing <summary> Documentation for Spring.Messaging.Nms.Listener.Adapter
Spring.Messaging.Nms.Support Missing <summary> Documentation for Spring.Messaging.Nms.Support
Spring.Messaging.Nms.Support.Converter Missing <summary> Documentation for Spring.Messaging.Nms.Support.Converter
Spring.Messaging.Nms.Support.Destinations Missing <summary> Documentation for Spring.Messaging.Nms.Support.Destinations

Classes

Class Description
AbstractListenerContainer Common base class for all containers which need to implement listening based on a Connection (either shared or freshly obtained for each attempt). Inherits basic Connection and Session configuration handling from the NmsAccessor base class.
AbstractMessageListenerContainer Abstract base class for message listener containers. Can either host a standard NMS MessageListener or a Spring-specific ISessionAwareMessageListener
CachedMessageConsumer NMS MessageConsumer decorator that adapts all calls to a shared MessageConsumer instance underneath.
CachedMessageProducer MessageProducer decorator that adapts calls to a shared MessageProducer instance underneath, managing QoS settings locally within the decorator.
CachedSession Wrapper for Session that caches producers and registers itself as available to the session cache when being closed. Generally used for testing purposes or if need to get at the wrapped Session object via the TargetSession property (for vendor specific methods).
CachingConnectionFactory SingleConnectionFactory subclass that adds Session, MessageProducer, and MessageConsumer caching. This ConnectionFactory also switches the ReconnectOnException property to true by default, allowing for automatic recovery of the underlying Connection.
ChainedExceptionListener Implementation of Spring IExceptionListener interface that supports chaining allowing the addition of multiple ExceptionListener instances in order.
ConnectionFactoryUtils Helper class for obtaining transactional NMS resources for a given ConnectionFactory.
DynamicDestinationResolver Simple DestinationResolver implementation resolving destination names as dynamic destinations.
ListenerExecutionFailedException Exception to be thrown when the execution of a listener method failed.
LocallyExposedNmsResourceHolder MessageResourceHolder marker subclass that indicates local exposure, i.e. that does not indicate an externally managed transaction.
MessageConversionException Thrown by IMessageConverter implementations when the conversion of an object to/from a Message fails.
MessageListenerAdapter Message listener adapter that delegates the handling of messages to target listener methods via reflection, with flexible message type conversion. Allows listener methods to operate on message content types, completely independent from the NMS API.
MessageListenerContainerObjectDefinitionParser Parser for the NMS
<listener-container>
element.
NmsAccessor Base class for NmsTemplate and other NMS-accessing gateway helpers
NmsDestinationAccessor Base class for NmsTemplate} and other NMS-accessing gateway helpers, adding destination-related properties to MessagingAccessor's common properties.
NmsGatewaySupport Convenient super class for application classes that need NMS access.
NmsNamespaceParser Namespace parser for the nms namespace.
NmsResourceHolder Connection holder, wrapping a NMS Connection and a NMS Session. MessageTransactionManager binds instances of this class to the thread, for a given NMS ConnectionFactory.

Note: This is an SPI class, not intended to be used by applications.

NmsTemplate Helper class that simplifies NMS access code.
NmsTransactionManager A AbstractPlatformTransactionManager implementation for a single NMS
ConnectionFactory
. Binds a Connection/Session pair from the specified ConnecctionFactory to the thread, potentially allowing for one thread-bound Session per ConnectionFactory.
NmsUtils Generic utility methods for working with NMS. Mainly for internal use within the framework, but also useful for custom NMS access code.
RecoveryTimeExceededException Exception thrown when the maximum connection recovery time has been exceeded.
SharedConnectionNotInitializedException Exception that indicates that the initial setup of this container's shared Connection failed. This is indicating to invokers that they need to establish the shared Connection themselves on first access.
SimpleMessageConverter A simple message converter that can handle ITextMessages, IBytesMessages, IMapMessages, and IObjectMessages. Used as default by NmsTemplate, for
ConvertAndSend
and
ReceiveAndConvert
operations.

Converts a String to a NMS ITextMessage, a byte array to a NMS IBytesMessage, a Map to a NMS IMapMessage, and a Serializable object to a NMS IObjectMessage (or vice versa).

SimpleMessageListenerContainer Message listener container that uses the plain NMS client API's MessageConsumer.Listener method to create concurrent MessageConsumers for the specified listeners.
SingleConnectionFactory A ConnectionFactory adapter that returns the same Connection from all CreateConnection() calls, and ignores calls to Connection.Close(). According to the JMS Connection model, this is perfectly thread-safe. The shared Connection can be automatically recovered in case of an Exception.
SynchedLocalTransactionFailedException Exception thrown when a synchronized local transaction failed to complete (after the main transaction has already completed).
TypeMapper Provides a layer of indirection when adding the 'type' of the object as a message property.
XmlMessageConverter Convert an object via XML serialization for sending via an ITextMessage

Interfaces

Interface Description
ConnectionFactoryUtils.ResourceFactory Callback interface for resource creation. Serving as argument for the
DoGetTransactionalSession
method.
IDecoratorSession Subinterface of Session to be implemented by implementations that wrap an Session to provide added functionality. Allows access to the the underlying target Session.
IDestinationResolver Strategy interface for resolving NMS destinations.
IExceptionListener Exception handler for exceptions from the messaging infrastrcture.
IMessageConverter Strategy interface that specifies a IMessageConverter between .NET objects and NMS messages.
IMessageCreator Creates a NMS message given a Session
IMessageListener Interfaced based approach to listen to messaging events.
IMessagePostProcessor To be used with NmsTemplate's send method that convert an object to a message.
INmsOperations Specifies a basic set of NMS operations.
IProducerCallback Callback for sending a message to a NMS destination.
ISessionAwareMessageListener Variant of the standard NMS MessageListener interface, offering not only the received Message but also the underlying Session object. The latter can be used to send reply messages, without the need to access an external Connection/Session, i.e. without the need to access the underlying ConnectionFactory.
ISessionCallback Callback for executing any number of operations on a provided Session
ISmartConnectionFactory Extension of the
ConnectionFactory
interface, indicating how to release Connections obtained from it.
ITypeMapper Provides a layer of indirection when adding the 'type' of the object as a message property.

Delegates

Delegate Description
MessageCreatorDelegate Delegate that creates a NMS message given a ISession
MessagePostProcessorDelegate Delegate that is used with NmsTemplate's ConvertAndSend method that converts an object.
ProducerDelegate Perform operations on the given Session and MessageProducer. The message producer is not associated with any destination.
SessionDelegate Callback delegate for code that operates on a Session.