session Class Reference

Inheritance diagram for session:

Collaboration diagram for session:

List of all members.

Public Member Functions
	session ()
	session (const session &sess)
	session (const propertySet &props)
virtual	~session ()
ref< transport >	getTransport (ref< security::authenticator > auth=NULL)
ref< transport >	getTransport (const string &protocol, ref< security::authenticator > auth=NULL)
ref< transport >	getTransport (const utility::url &url, ref< security::authenticator > auth=NULL)
ref< store >	getStore (ref< security::authenticator > auth=NULL)
ref< store >	getStore (const string &protocol, ref< security::authenticator > auth=NULL)
ref< store >	getStore (const utility::url &url, ref< security::authenticator > auth=NULL)
const propertySet &	getProperties () const
propertySet &	getProperties ()

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

---

Detailed Description

An object that contains all the information needed for connection to a service.

---

Constructor & Destructor Documentation

session

(

)

session

(

const session &

sess

)

session

(

const propertySet &

props

)

~session ( )

virtual

---

Member Function Documentation

const propertySet & getProperties

(

)

const

Properties for the session and for the services.

propertySet & getProperties

(

)

Properties for the session and for the services.

ref< store > getStore

(

ref< security::authenticator >

auth = NULL

)

Return a transport service instance for the protocol specified in the session properties.

The property "store.protocol" specify the protocol to use.

Parameters:

auth	authenticator object to use for the new store service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new store service

ref< store > getStore	(	const string &	protocol,
		ref< security::authenticator >	auth = NULL
	)

Return a store service instance for the specified protocol.

Parameters:

protocol	store protocol to use (eg. "imap")
auth	authenticator object to use for the new store service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new store service

References serviceFactory::create(), serviceFactory::getInstance(), and service::TYPE_STORE.

ref< store > getStore	(	const utility::url &	url,
		ref< security::authenticator >	auth = NULL
	)

Return a store service instance for the specified URL.

Parameters:

url	full URL with at least the protocol to use (eg: "imap://username:password@myserver.com/")
auth	authenticator object to use for the new store service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new store service

References serviceFactory::create(), serviceFactory::getInstance(), and service::TYPE_STORE.

ref< transport > getTransport

(

ref< security::authenticator >

auth = NULL

)

Return a transport service instance for the protocol specified in the session properties.

The property "transport.protocol" specify the protocol to use.

Parameters:

auth	authenticator object to use for the new transport service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new transport service

ref< transport > getTransport	(	const string &	protocol,
		ref< security::authenticator >	auth = NULL
	)

Return a transport service instance for the specified protocol.

Parameters:

protocol	transport protocol to use (eg. "smtp")
auth	authenticator object to use for the new transport service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new transport service

References serviceFactory::create(), serviceFactory::getInstance(), and service::TYPE_TRANSPORT.

ref< transport > getTransport	(	const utility::url &	url,
		ref< security::authenticator >	auth = NULL
	)

Return a transport service instance for the specified URL.

Parameters:

url	full URL with at least the protocol to use (eg: "smtp://myserver.com/")
auth	authenticator object to use for the new transport service. If NULL, a default one is used. The default authenticator simply return user credentials by reading the session properties "auth.username" and "auth.password".

Returns:

a new transport service

References serviceFactory::create(), serviceFactory::getInstance(), and service::TYPE_TRANSPORT.

---

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

• session.hpp
• session.cpp