cms::ConnectionMetaData Class Reference

A ConnectionMetaData object provides information describing the Connection object. More...

#include <src/main/cms/ConnectionMetaData.h>

Inheritance diagram for cms::ConnectionMetaData:

Public Member Functions
virtual	~ConnectionMetaData ()
virtual std::string	getCMSVersion () const =0
	Gets the CMS API version.
virtual int	getCMSMajorVersion () const =0
	Gets the CMS major version number.
virtual int	getCMSMinorVersion () const =0
	Gets the CMS minor version number.
virtual std::string	getCMSProviderName () const =0
	Gets the CMS provider name.
virtual std::string	getProviderVersion () const =0
	Gets the CMS provider version.
virtual int	getProviderMajorVersion () const =0
	Gets the CMS provider major version number.
virtual int	getProviderMinorVersion () const =0
	Gets the CMS provider minor version number.
virtual int	getProviderPatchVersion () const =0
	Gets the CMS provider patch version number.
virtual std::vector< std::string >	getCMSXPropertyNames () const =0
	Gets an Vector of the CMSX property names.

Detailed Description

A ConnectionMetaData object provides information describing the Connection object.

Since

1.3

Constructor & Destructor Documentation

~ConnectionMetaData()

virtual cms::ConnectionMetaData::~ConnectionMetaData ( )

virtual

Member Function Documentation

getCMSMajorVersion()

virtual int cms::ConnectionMetaData::getCMSMajorVersion ( ) const

pure virtual

Gets the CMS major version number.

Returns

the CMS API major version number

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getCMSMinorVersion()

virtual int cms::ConnectionMetaData::getCMSMinorVersion ( ) const

pure virtual

Gets the CMS minor version number.

Returns

the CMS API minor version number

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getCMSProviderName()

virtual std::string cms::ConnectionMetaData::getCMSProviderName ( ) const

pure virtual

Gets the CMS provider name.

Returns

the CMS provider name

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getCMSVersion()

virtual std::string cms::ConnectionMetaData::getCMSVersion ( ) const

pure virtual

Gets the CMS API version.

Returns

the CMS API Version in String form.

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getCMSXPropertyNames()

virtual std::vector< std::string > cms::ConnectionMetaData::getCMSXPropertyNames ( ) const

pure virtual

Gets an Vector of the CMSX property names.

Returns

an Vector of CMSX property names

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getProviderMajorVersion()

virtual int cms::ConnectionMetaData::getProviderMajorVersion ( ) const

pure virtual

Gets the CMS provider major version number.

Returns

the CMS provider major version number

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getProviderMinorVersion()

virtual int cms::ConnectionMetaData::getProviderMinorVersion ( ) const

pure virtual

Gets the CMS provider minor version number.

Returns

the CMS provider minor version number

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getProviderPatchVersion()

virtual int cms::ConnectionMetaData::getProviderPatchVersion ( ) const

pure virtual

Gets the CMS provider patch version number.

Returns

the CMS provider patch version number

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

getProviderVersion()

virtual std::string cms::ConnectionMetaData::getProviderVersion ( ) const

pure virtual

Gets the CMS provider version.

Returns

the CMS provider version

Exceptions

CMSException

If the CMS Provider fails to retrieve the metadata due to some internal error.

Implemented in activemq::core::ActiveMQConnectionMetaData.

---

The documentation for this class was generated from the following file:

• src/main/cms/ConnectionMetaData.h