Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

AbstractListenerContainer Members

AbstractListenerContainer overview

Public Instance Properties

Active Gets a value indicating whether this container is currently active, that is, whether it has been set up but not shut down yet.
AutoStartup Set whether to automatically start the listener after initialization. Default is "true"; set this to "false" to allow for manual startup.
ClientId Gets or sets the client id for a shared Connection created and used by this container.
ConnectionFactory (inherited from EmsAccessor) Gets or sets the connection factory to use for obtaining EMS Connections.
DestinationResolver (inherited from EmsDestinationAccessor) Gets or sets the destination resolver that is to be used to resolve Destination references for this accessor.
IsRunning Gets a value indicating whether this container is currently running, that is, whether it has been started and not stopped yet.
ObjectName Set the name of the object in the object factory that created this object.
PubSubDomain (inherited from EmsDestinationAccessor) Gets or sets a value indicating whether Publish/Subscribe domain (Topics) is used. Otherwise, the Point-to-Point domain (Queues) is used.
SessionAcknowledgeMode (inherited from EmsAccessor) Gets or sets the session acknowledge mode for EMS Sessions including whether or not the session is transacted
SessionTransacted (inherited from EmsAccessor) Set the transaction mode that is used when creating a EMS Session. Default is "false".

Public Instance Methods

AfterPropertiesSet Call base class method, then ValidateConfiguration and then Initialize
Dispose Calls Shutdown when the application context destroys the container instance.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
Initialize Initializes this container. Creates a Connection, starts the Connection (if the property AutoStartup hasn't been turned off), and calls DoInitialize.
ResolveDestinationName (inherited from EmsDestinationAccessor) Resolves the given destination name to a EMS destination.
Shutdown Stop the shared connection, call DoShutdown, and close this container.
Start Starts this container.
Stop Stops this container.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

AbstractListenerContainer Constructor Initializes a new instance of the AbstractListenerContainer class.

Protected Instance Fields

lifecycleMonitor The monitor object to lock on when performing operations that update the lifecycle of the container.
sharedConnectionMonitor The monitor object to lock on when performing operations on the connection.

Protected Instance Properties

RunningAllowed Gets a value indicating whether this container's listeners are generally allowed to run.
SharedConnection Gets the shared connection maintained by this container. Available after initialization.
SharedConnectionEnabled Return whether a shared EMS Connection should be maintained by this listener container base class.

Protected Instance Methods

CreateConnection (inherited from EmsAccessor) Creates the connection via the ConnectionFactory.
CreateSession (inherited from EmsAccessor) Creates the session for the given Connection
CreateSharedConnection Creates the shared connection for this container.
DoInitialize Register any invokers within this container. Subclasses need to implement this method for their specific invoker management process. A shared Connection, if any, will already have been started at this point.
DoShutdown Close the registered invokers. Subclasses need to implement this method for their specific invoker management process. A shared Connection, if any, will automatically be closed afterwards.
DoStart Start the shared Connection, if any, and notify all invoker tasks.
DoStop Notify all invoker tasks and stop the shared Connection, if any.
EstablishSharedConnection Establishes a shared Connection for this container.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
IsClientAcknowledge (inherited from EmsAccessor) Returns whether the Session is in client acknowledgement mode.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
PrepareSharedConnection Prepares the given connection, which is about to be registered as shared Connection for this container.
RefreshSharedConnection Refreshes the shared connection that this container holds.
StartSharedConnection Starts the shared connection.
StopSharedConnection Stops the shared connection.
ValidateConfiguration Validates the configuration of this container. The default implementation is empty. To be overriden in subclasses.

See Also

AbstractListenerContainer Class | Spring.Messaging.Ems.Listener Namespace