SASLContext Class Reference

Inheritance diagram for SASLContext:

Collaboration diagram for SASLContext:

Public Member Functions
	~SASLContext ()
shared_ptr< SASLSession >	createSession (const string &serviceName, shared_ptr< authenticator > auth, shared_ptr< SASLMechanism > mech)
shared_ptr< SASLMechanism >	createMechanism (const string &name)
shared_ptr< SASLMechanism >	suggestMechanism (const std::vector< shared_ptr< SASLMechanism > > &mechs)
void	decodeB64 (const string &input, byte_t **output, size_t *outputLen)
const string	encodeB64 (const byte_t *input, const size_t inputLen)

Static Public Member Functions
static shared_ptr< SASLContext >	create ()

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

An SASL client context.

Constructor & Destructor Documentation

~SASLContext()

~SASLContext

(

)

Member Function Documentation

create()

shared_ptr< SASLContext > create ( )

static

Construct and initialize a new SASL context.

Returns

pointer to a new SASL context

References SASLContext::createSession().

Referenced by POP3Connection::disconnect(), and SMTPConnection::hasExtension().

createMechanism()

shared_ptr< SASLMechanism > createMechanism

(

const string &

name

)

Create an instance of an SASL mechanism.

Parameters

name	mechanism name

Returns

a new instance of the specified SASL mechanism

Exceptions

exceptions::no_such_mechanism

if no mechanism is registered for the specified name

References SASLMechanismFactory::create(), SASLMechanismFactory::getInstance(), and SASLContext::suggestMechanism().

createSession()

shared_ptr< SASLSession > createSession	(	const string &	serviceName,
		shared_ptr< authenticator >	auth,
		shared_ptr< SASLMechanism >	mech
	)

Create and initialize a new SASL session.

Parameters

serviceName	name of the service which will use the session
auth	authenticator object to use during the session
mech	SASL mechanism

Returns

a new SASL session

References SASLSession::create().

Referenced by SASLContext::create().

decodeB64()

void decodeB64	(	const string &	input,
		byte_t **	output,
		size_t *	outputLen
	)

Helper function for decoding Base64-encoded challenge.

Parameters

input	input buffer
output	output buffer
outputLen	length of output buffer

References encoderFactory::getInstance().

encodeB64()

const string encodeB64	(	const byte_t *	input,
		const size_t	inputLen
	)

Helper function for encoding challenge in Base64.

Parameters

input	input buffer
inputLen	length of input buffer

Returns

Base64-encoded challenge

References ERROR, and encoderFactory::getInstance().

suggestMechanism()

shared_ptr< SASLMechanism > suggestMechanism

(

const std::vector< shared_ptr< SASLMechanism > > &

mechs

)

Suggests an SASL mechanism among a set of mechanisms supported by the server.

Parameters

mechs

list of mechanisms

Returns

suggested mechanism (usually the safest mechanism supported by both the client and the server)

Referenced by SASLContext::createMechanism().

---

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

• SASLContext.hpp
• SASLContext.cpp