property Class Reference

A service property. More...

Collaboration diagram for property:

Public Types
enum	Types { TYPE_INTEGER, TYPE_STRING, TYPE_BOOL, TYPE_DEFAULT = TYPE_STRING }
enum	Flags { FLAG_NONE = 0, FLAG_REQUIRED = (1 << 0), FLAG_HIDDEN = (1 << 1), FLAG_DEFAULT = FLAG_NONE }
Public Member Functions
	property (const string &name, const Types type, const string &defaultValue="", const int flags=FLAG_DEFAULT)
	property (const property &p, const int addFlags=FLAG_NONE, const int removeFlags=FLAG_NONE)
	property (const property &p, const string &newDefaultValue, const int addFlags=FLAG_NONE, const int removeFlags=FLAG_NONE)
property &	operator= (const property &p)
const string &	getName () const
const string &	getDefaultValue () const
Types	getType () const
int	getFlags () const
Static Public Attributes
static const property	SERVER_ADDRESS
static const property	SERVER_PORT
static const property	SERVER_ROOTPATH
static const property	AUTH_USERNAME
static const property	AUTH_PASSWORD
static const property	CONNECTION_TLS
static const property	CONNECTION_TLS_REQUIRED

Detailed Description

A service property.

Member Enumeration Documentation

enum Flags

Property flags.

Enumerator:

FLAG_NONE
FLAG_REQUIRED
FLAG_HIDDEN
FLAG_DEFAULT

enum Types

Value types.

Enumerator:

TYPE_INTEGER
TYPE_STRING
TYPE_BOOL
TYPE_DEFAULT

Constructor & Destructor Documentation

property	(	const string &	name,
		const Types	type,
		const string &	defaultValue = `""`,
		const int	flags = `FLAG_DEFAULT`
	)

Construct a new property.

Parameters:

	name	property name
	type	value type
	defaultValue	default value
	flags	property attributes

property	(	const property &	p,
		const int	addFlags = `FLAG_NONE`,
		const int	removeFlags = `FLAG_NONE`
	)

Construct a new property from an existing property.

Parameters:

	p	source property
	addFlags	flags to add
	removeFlags	flags to remove

property	(	const property &	p,
		const string &	newDefaultValue,
		const int	addFlags = `FLAG_NONE`,
		const int	removeFlags = `FLAG_NONE`
	)

Construct a new property from an existing property.

Parameters:

	p	source property
	newDefaultValue	new default value
	addFlags	flags to add
	removeFlags	flags to remove

Member Function Documentation

const string & getDefaultValue ( ) const

Return the default value of the property or an empty string if there is no default value.

Returns:: default value for the property

Referenced by serviceInfos::getPropertyValue().

int getFlags ( ) const

Return the attributes of the property (see serviceInfos::property::Types constants).

Returns:: property attributes

Referenced by serviceInfos::getPropertyValue().

const string & getName ( ) const

Return the name of the property.

Returns:: property name

Referenced by serviceInfos::getPropertyValue(), and serviceInfos::hasProperty().

serviceInfos::property::Types getType ( ) const

Return the value type of the property.

Returns:: property value type

serviceInfos::property & operator= ( const property & p )

Member Data Documentation

const serviceInfos::property AUTH_PASSWORD [static]

The common property 'auth.password' which is the password used to authenticate with the server.

Referenced by defaultAuthenticator::getPassword(), POP3ServiceInfos::getProperties(), and IMAPServiceInfos::getProperties().

const serviceInfos::property AUTH_USERNAME [static]

The common property 'auth.username' which is the username used to authenticate with the server.

Referenced by POP3ServiceInfos::getProperties(), IMAPServiceInfos::getProperties(), and defaultAuthenticator::getUsername().

const serviceInfos::property CONNECTION_TLS [static]

The common property 'connection.tls': this is used to start a secured connection if it is supported by the server (STARTTLS extension).

Referenced by POP3ServiceInfos::getProperties(), and IMAPServiceInfos::getProperties().

const serviceInfos::property CONNECTION_TLS_REQUIRED [static]

The common property 'connection.tls.required' should be set to 'true' to make the connection process fail if the server can't start a secured connection (no effect if 'connection.tls' is not set to 'true').

Referenced by POP3ServiceInfos::getProperties(), and IMAPServiceInfos::getProperties().

const serviceInfos::property SERVER_ADDRESS [static]

The common property 'server.address' which is the host name or the IP address of the server.

Referenced by POP3ServiceInfos::getProperties(), and IMAPServiceInfos::getProperties().

const serviceInfos::property SERVER_PORT [static]

The common property 'server.port' which is the port used to connect to the server.

Referenced by POP3ServiceInfos::getProperties(), and IMAPServiceInfos::getProperties().

const serviceInfos::property SERVER_ROOTPATH [static]

The common property 'server.rootpath' which is the full path of the folder on the server (for maildir, this is the local filesystem directory).

Referenced by maildirServiceInfos::getProperties().

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