SipLine Class Reference

#include <SipLine.h>

Collaboration diagram for SipLine:

Public Types
enum	LineStates {   LINE_STATE_UNKNOWN = 0,   LINE_STATE_REGISTERED,   LINE_STATE_DISABLED,   LINE_STATE_FAILED,   LINE_STATE_PROVISIONED,   LINE_STATE_TRYING,   LINE_STATE_EXPIRED }

Public Member Functions
	SipLine (Url userEnteredUrl="", Url identityUri="", UtlString user="", UtlBoolean visible=TRUE, int state=LINE_STATE_REGISTERED, UtlBoolean isAutoEnabled=TRUE, UtlBoolean useCallHandling=FALSE)
virtual	~SipLine ()
	SipLine (const SipLine &rSipLine)
SipLine &	operator= (const SipLine &rSipLine)
UtlBoolean	isDeviceLine ()
UtlBoolean	IsDuplicateRealm (const UtlString realm, const UtlString scheme=HTTP_DIGEST_AUTHENTICATION)
UtlString &	getLineId ()
int	getState ()
void	setState (int state)
UtlString &	getUser ()
void	setUser (const UtlString user)
void	getIdentityAndUrl (Url &identity, Url &userEnteredUrl)
void	setIdentityAndUrl (Url identity, Url userEnteredUrl)
Url &	getUserEnteredUrl ()
Url &	getIdentity ()
Url &	getCanonicalUrl ()
void	setAutoEnableStatus (UtlBoolean isAutoEnabled)
UtlBoolean	getAutoEnableStatus ()
UtlBoolean	getCallHandling ()
void	setCallHandling (UtlBoolean useCallHandling=TRUE)
UtlBoolean	getVisibility ()
void	setVisibility (UtlBoolean isEnable=TRUE)
int	GetNumOfCredentials ()
UtlBoolean	addCredentials (const UtlString &strRealm, const UtlString &strUserID, const UtlString &strPassword, const UtlString &Type)
UtlBoolean	getCredentials (const UtlString &type, const UtlString &realm, UtlString *userID, UtlString *MD5_token)
UtlBoolean	getDuplicateCredentials (const UtlString &type, const UtlString &realm)
UtlBoolean	getAllCredentials (int MaxEnteries, int &actualEnteries, UtlString realms[], UtlString UserId[], UtlString type[], UtlString passtoken[])
UtlBoolean	removeCredential (const UtlString *realm)
void	removeAllCredentials ()
void	setPreferredContactUri (const Url &preferredContactUri)
UtlBoolean	getPreferredContactUri (Url &preferredContactUri) const
LINE_CONTACT_TYPE	getContactType () const
void	setContactType (LINE_CONTACT_TYPE eContactType)

Protected Member Functions
void	copyCredentials (const SipLine &rSipLine)
void	generateLineID (UtlString &lineId)

Protected Attributes
UtlBoolean	mIsVisible
UtlBoolean	mIsAutoEnabled
UtlBoolean	mIsUsingCallHandling
Url	mIdentity
Url	mUserEnteredUrl
Url	mCanonicalUrl
LINE_CONTACT_TYPE	meContactType
	Type of of contact address (either LOCAL or NAT_MAPPED) More...
UtlString	mUser
UtlString	mLineId
int	mCurrentState
Url	mPreferredContactUri
UtlHashBag	mCredentials

Member Enumeration Documentation

enum LineStates

Enumerator
LINE_STATE_UNKNOWN
LINE_STATE_REGISTERED
LINE_STATE_DISABLED
LINE_STATE_FAILED
LINE_STATE_PROVISIONED
LINE_STATE_TRYING
LINE_STATE_EXPIRED

Constructor & Destructor Documentation

SipLine	(	Url	userEnteredUrl = "",
		Url	identityUri = "",
		UtlString	user = "",
		UtlBoolean	visible = TRUE,
		int	state = LINE_STATE_REGISTERED,
		UtlBoolean	isAutoEnabled = TRUE,
		UtlBoolean	useCallHandling = FALSE
	)

~SipLine ( )

virtual

SipLine

(

const SipLine &

rSipLine

)

Member Function Documentation

SipLine & operator=

(

const SipLine &

rSipLine

)

UtlBoolean isDeviceLine

(

)

UtlBoolean IsDuplicateRealm	(	const UtlString	realm,
		const UtlString	scheme = HTTP_DIGEST_AUTHENTICATION
	)

UtlString & getLineId

(

)

int getState

(

)

void setState

(

int

state

)

UtlString & getUser

(

)

void setUser

(

const UtlString

user

)

void getIdentityAndUrl	(	Url &	identity,
		Url &	userEnteredUrl
	)

void setIdentityAndUrl	(	Url	identity,
		Url	userEnteredUrl
	)

Url & getUserEnteredUrl

(

)

Url & getIdentity

(

)

Url & getCanonicalUrl

(

)

void setAutoEnableStatus

(

UtlBoolean

isAutoEnabled

)

UtlBoolean getAutoEnableStatus

(

)

UtlBoolean getCallHandling

(

)

void setCallHandling

(

UtlBoolean

useCallHandling = TRUE

)

UtlBoolean getVisibility

(

)

void setVisibility

(

UtlBoolean

isEnable = TRUE

)

int GetNumOfCredentials

(

)

UtlBoolean addCredentials	(	const UtlString &	strRealm,
		const UtlString &	strUserID,
		const UtlString &	strPassword,
		const UtlString &	Type
	)

UtlBoolean getCredentials	(	const UtlString &	type,
		const UtlString &	realm,
		UtlString *	userID,
		UtlString *	MD5_token
	)

UtlBoolean getDuplicateCredentials	(	const UtlString &	type,
		const UtlString &	realm
	)

UtlBoolean getAllCredentials	(	int	MaxEnteries,
		int &	actualEnteries,
		UtlString	realms[],
		UtlString	UserId[],
		UtlString	type[],
		UtlString	passtoken[]
	)

UtlBoolean removeCredential

(

const UtlString *

realm

)

void removeAllCredentials

(

)

void setPreferredContactUri

(

const Url &

preferredContactUri

)

UtlBoolean getPreferredContactUri

(

Url &

preferredContactUri

)

const

LINE_CONTACT_TYPE getContactType

(

)

const

void setContactType

(

LINE_CONTACT_TYPE

eContactType

)

void copyCredentials ( const SipLine &  rSipLine )

protected

void generateLineID ( UtlString &  lineId )

protected

Member Data Documentation

UtlBoolean mIsVisible

protected

UtlBoolean mIsAutoEnabled

protected

UtlBoolean mIsUsingCallHandling

protected

Url mIdentity

protected

Url mUserEnteredUrl

protected

Url mCanonicalUrl

protected

LINE_CONTACT_TYPE meContactType

protected

Type of of contact address (either LOCAL or NAT_MAPPED)

UtlString mUser

protected

UtlString mLineId

protected

int mCurrentState

protected

Url mPreferredContactUri

protected

UtlHashBag mCredentials

protected