cms::ConnectionFactory Class Reference

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

---

Detailed Description

Defines the interface for a factory that creates connection objects.

Public Member Functions
virtual	~ConnectionFactory ()
virtual Connection *	createConnection ()=0 throw ( CMSException )
	Creates a connection with the default user identity.
virtual cms::Connection *	createConnection (const std::string &username, const std::string &password)=0 throw ( cms::CMSException )
	Creates a connection with the default specified identity.
virtual cms::Connection *	createConnection (const std::string &username, const std::string &password, const std::string &clientId)=0 throw ( cms::CMSException )
	Creates a connection with the specified user identity.

---

Constructor & Destructor Documentation

virtual cms::ConnectionFactory::~ConnectionFactory

(

)

[inline, virtual]

---

Member Function Documentation

virtual Connection* cms::ConnectionFactory::createConnection

(

)

throw ( CMSException ) [pure virtual]

Creates a connection with the default user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Returns:

Pointer to a connection object, caller owns the pointer

Exceptions:

CMSException

virtual cms::Connection* cms::ConnectionFactory::createConnection	(	const std::string &	username,
		const std::string &	password
	)			throw ( cms::CMSException ) [pure virtual]

Creates a connection with the default specified identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called. The username and password values passed here do not change the defaults, subsequent calls to the parameterless createConnection will continue to use the default values that were set in the Constructor.

Parameters:

	username	to authenticate with
	password	to authenticate with

Returns:

a Connection Pointer

Exceptions:

CMSException

virtual cms::Connection* cms::ConnectionFactory::createConnection	(	const std::string &	username,
		const std::string &	password,
		const std::string &	clientId
	)			throw ( cms::CMSException ) [pure virtual]

Creates a connection with the specified user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called. The username and password values passed here do not change the defaults, subsequent calls to the parameterless createConnection will continue to use the default values that were set in the Constructor.

Parameters:

	username	to authenticate with
	password	to authenticate with
	clientId	to assign to connection if "" then a random client Id is created for this connection.

Returns:

a Connection Pointer

Exceptions:

CMSException

---

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

• src/main/cms/ConnectionFactory.h

---