Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

Spring.Messaging.Ems Assembly

Referenced Assemblies

Assembly Reference Description
Common.Logging  
mscorlib  
mscorlib  
Spring.Core  
Spring.Data  
System  
System.Data  
System.Xml  
TIBCO.EMS  

Namespaces

Namespace Description
Spring.Messaging.Ems.Common Missing <summary> Documentation for Spring.Messaging.Ems.Common
Spring.Messaging.Ems.Config Missing <summary> Documentation for Spring.Messaging.Ems.Config
Spring.Messaging.Ems.Connections Missing <summary> Documentation for Spring.Messaging.Ems.Connections
Spring.Messaging.Ems.Core Missing <summary> Documentation for Spring.Messaging.Ems.Core
Spring.Messaging.Ems.Listener Missing <summary> Documentation for Spring.Messaging.Ems.Listener
Spring.Messaging.Ems.Listener.Adapter Missing <summary> Documentation for Spring.Messaging.Ems.Listener.Adapter
Spring.Messaging.Ems.Support Missing <summary> Documentation for Spring.Messaging.Ems.Support
Spring.Messaging.Ems.Support.Converter Missing <summary> Documentation for Spring.Messaging.Ems.Support.Converter
Spring.Messaging.Ems.Support.Destinations Missing <summary> Documentation for Spring.Messaging.Ems.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 EmsAccessor base class.
AbstractMessageListenerContainer Abstract base class for message listener containers. Can either host a standard EMS MessageListener or a Spring-specific ISessionAwareMessageListener
CachedMessageConsumer EMS 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.
CertificateStoreConfig Missing <summary> documentation for T:Spring.Messaging.Ems.Common.CertificateStoreConfig
ChainedExceptionListener Implementation of Spring IExceptionListener interface that supports chaining allowing the addition of multiple ExceptionListener instances in order.
ConnectionFactoryUtils Helper class for obtaining transactional EMS resources for a given ConnectionFactory.
DynamicDestinationResolver Simple DestinationResolver implementation resolving destination names as dynamic destinations.
EmsAccessor Base class for EmsTemplate and other EMS-accessing gateway helpers
EmsConnection Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsConnection
EmsConnectionFactory Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsConnectionFactory
EmsDestinationAccessor Base class for EmsTemplate} and other EMS-accessing gateway helpers, adding destination-related properties to EmsAccessor's common properties.
EmsGatewaySupport Convenient super class for application classes that need EMS access.
EmsMessageConsumer Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsMessageConsumer
EmsMessageProducer Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsMessageProducer
EmsNamespaceParser Namespace parser for the EMS namespace.
EmsResourceHolder Connection holder, wrapping a EMS Connection and a EMS Session. EmsTransactionManager binds instances of this class to the thread, for a given EMS ConnectionFactory.

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

EmsSession Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsSession
EmsSSLFileStoreInfo Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsSSLFileStoreInfo
EmsSSLSystemStoreInfo Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsSSLSystemStoreInfo
EmsTemplate Helper class that simplifies EMS access code.
EmsTopicSubscriber Missing <summary> documentation for T:Spring.Messaging.Ems.Common.EmsTopicSubscriber
EmsTransactionManager A AbstractPlatformTransactionManager implementation for a single EMS
ConnectionFactory
. Binds a Connection/Session pair from the specified ConnecctionFactory to the thread, potentially allowing for one thread-bound Session per ConnectionFactory.
EmsUtils Generic utility methods for working with EMS. Mainly for internal use within the framework, but also useful for custom EMS access code.
ListenerExecutionFailedException Exception to be thrown when the execution of a listener method failed.
LocallyExposedEmsResourceHolder EmsResourceHolder 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 EMS API.
MessageListenerContainerObjectDefinitionParser Parser for the EMS
<listener-container>
element.
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 TextMessages, BytesMessages, MapMessages, and ObjectMessages. Used as default by EmsTemplate, for
ConvertAndSend
and
ReceiveAndConvert
operations.

Converts a String to a EMS TextMessage, a byte array to a EMS BytesMessage, a Map to a EMS MapMessage, and a Serializable object to a EMS ObjectMessage (or vice versa).

SimpleMessageListenerContainer Message listener container that uses the plain EMS 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.
IBrowserCallback Callback for browsing the messages in an EMS queue.
IConnection Missing <summary> documentation for T:Spring.Messaging.Ems.Common.IConnection
IConnectionFactory Missing <summary> documentation for T:Spring.Messaging.Ems.Common.IConnectionFactory
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 EMS destinations.
IEmsOperations Specifies a basic set of EMS operations.
IEmsSSLStoreType Market interface for EMS SSL store types
IMessageConsumer Missing <summary> documentation for T:Spring.Messaging.Ems.Common.IMessageConsumer
IMessageConverter Strategy interface that specifies a IMessageConverter between .NET objects and EMS messages.
IMessageCreator Creates a EMS message given a Session
IMessagePostProcessor To be used with EmsTemplate's send method that convert an object to a message.
IMessageProducer Missing <summary> documentation for T:Spring.Messaging.Ems.Common.IMessageProducer
IProducerCallback Callback for sending a message to a EMS destination.
ISession Missing <summary> documentation for T:Spring.Messaging.Ems.Common.ISession
ISessionAwareMessageListener Variant of the standard EMS 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
IConnectionFactory
interface, indicating how to release Connections obtained from it.
ITopicSubscriber Missing <summary> documentation for T:Spring.Messaging.Ems.Common.ITopicSubscriber
ITypeMapper Provides a layer of indirection when adding the 'type' of the object as a message property.

Delegates

Delegate Description
BrowserDelegate Delegate callback for browsing the messages in an EMS queue.
MessageCreatorDelegate Delegate that creates a EMS message given a Session
MessagePostProcessorDelegate Delegate that is used with EmsTemplate'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.