Base class for activemq.cmsutil.CmsTemplate
and other CMS-accessing gateway helpers, defining common properties such as the CMS cms.ConnectionFactory
to operate on.
More...
#include <src/main/activemq/cmsutil/CmsAccessor.h>
Base class for activemq.cmsutil.CmsTemplate
and other CMS-accessing gateway helpers, defining common properties such as the CMS cms.ConnectionFactory
to operate on.
The subclass activemq.cmsutil.CmsDestinationAccessor
adds further, destination-related properties.
Not intended to be used directly.
- See also
- activemq.cmsutil.CmsDestinationAccessor
-
activemq.cmsutil.CmsTemplate
◆ CmsAccessor() [1/2]
◆ CmsAccessor() [2/2]
activemq::cmsutil::CmsAccessor::CmsAccessor |
( |
| ) |
|
◆ ~CmsAccessor()
virtual activemq::cmsutil::CmsAccessor::~CmsAccessor |
( |
| ) |
|
|
virtual |
◆ checkConnectionFactory()
virtual void activemq::cmsutil::CmsAccessor::checkConnectionFactory |
( |
| ) |
|
|
protectedvirtual |
Verifies that the connection factory is valid.
- Exceptions
-
IllegalStateException | if this object has not been initialized. |
◆ createConnection()
virtual cms::Connection * activemq::cmsutil::CmsAccessor::createConnection |
( |
| ) |
|
|
protectedvirtual |
Create a CMS Connection via this template's ConnectionFactory.
- Returns
- the new CMS Connection
- Exceptions
-
CMSException | if thrown by CMS API methods |
IllegalStateException | if this object has not been initialized. |
◆ createSession()
Create a CMS Session for the given Connection.
- Parameters
-
con | The CMS Connection to create a Session for |
- Returns
- the new CMS Session
- Exceptions
-
CMSException | if thrown by CMS API methods |
IllegalStateException | if this object has not been initialized. |
◆ destroy()
virtual void activemq::cmsutil::CmsAccessor::destroy |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ getConnectionFactory() [1/2]
Return the ConnectionFactory that this accessor uses for obtaining CMS Connections.
◆ getConnectionFactory() [2/2]
Return the ConnectionFactory that this accessor uses for obtaining CMS Connections.
◆ getResourceLifecycleManager() [1/2]
◆ getResourceLifecycleManager() [2/2]
◆ getSessionAcknowledgeMode()
Return the acknowledgment mode for CMS sessions.
- Returns
- the acknowledgment mode applied by this accessor
◆ init()
virtual void activemq::cmsutil::CmsAccessor::init |
( |
| ) |
|
|
protectedvirtual |
Initializes this object and prepares it for use.
This should be called before any other methods are called. This version does nothing.
- Exceptions
-
CMSException | if an error occurs during initialization. |
IllegalStateException | if this object has already been initialized. |
Reimplemented in activemq::cmsutil::CmsDestinationAccessor, and activemq::cmsutil::CmsTemplate.
◆ operator=()
◆ setConnectionFactory()
virtual void activemq::cmsutil::CmsAccessor::setConnectionFactory |
( |
cms::ConnectionFactory * | connectionFactory | ) |
|
|
inlinevirtual |
Set the ConnectionFactory to use for obtaining CMS Connections.
◆ setSessionAcknowledgeMode()
Set the CMS acknowledgment mode that is used when creating a CMS Session to send a message.
Default is AUTO_ACKNOWLEDGE
.
- Parameters
-
sessionAcknowledgeMode | The acknowledgment mode to assign to the Session. |
The documentation for this class was generated from the following file: