SipLineMgr Class Reference

#include <SipLineMgr.h>

Inheritance diagram for SipLineMgr:

Collaboration diagram for SipLineMgr:

Public Member Functions
	SipLineMgr (const char *authenticationScheme=HTTP_DIGEST_AUTHENTICATION)
	SipLineMgr (const SipLineMgr &rSipLineMgr)
virtual	~SipLineMgr ()
void	StartLineMgr ()
UtlBoolean	initializeRefreshMgr (SipRefreshMgr *refreshMgr)
void	setDefaultContactUri (const Url &contactUri)
void	setOwner (const UtlString &owner)
UtlBoolean	addLine (SipLine &line, UtlBoolean doEnable=TRUE)
void	deleteLine (const Url &identity)
void	setDefaultOutboundLine (const Url &outboundLine)
UtlBoolean	enableLine (const Url &identity)
void	disableLine (const Url &identity, UtlBoolean onStartup=FALSE, const UtlString &lineId="")
void	lineHasBeenUnregistered (const Url &identity)
void	enableAllLines ()
UtlBoolean	buildAuthenticatedRequest (const SipMessage *response, const SipMessage *request, SipMessage *newAuthRequest)
void	setFirstLineAsDefaultOutBound ()
void	setCallHandlingForLine (const Url &identity, UtlBoolean useCallHandling=TRUE)
void	setAutoEnableForLine (const Url &identity, UtlBoolean isAutoEnable=TRUE)
void	setStateForLine (const Url &identity, int state)
void	setVisibilityForLine (const Url &identity, UtlBoolean Visibility=TRUE)
void	setUserForLine (const Url &identity, const UtlString User)
void	setUserEnteredUrlForLine (const Url &identity, UtlString sipUrl)
UtlBoolean	setContactTypeForLine (const Url &identity, LINE_CONTACT_TYPE eContactType)
UtlBoolean	addCredentialForLine (const Url &identity, const UtlString strRealm, const UtlString strUserID, const UtlString strPasswd, const UtlString type)
UtlBoolean	deleteCredentialForLine (const Url &identity, const UtlString strRealm)
void	addMessageObserver (OsMsgQ &messageQueue, void *observerData=NULL)
UtlBoolean	removeMessageObserver (OsMsgQ &messageQueue, void *pObserverData=NULL)
void	notifyChangeInLineProperties (Url &identity)
	param: messageQueue - All observers dispatching to this message queue More...
void	notifyChangeInOutboundLine (Url &identity)
void	storeLine (OsConfigDb *pConfigDb, UtlString strSubKey, SipLine line)
UtlBoolean	loadLine (OsConfigDb *pConfigDb, UtlString strSubkey, SipLine &line)
	param: (in) pConfigDb - Configuration database to save to. param: (in) strSubKey - ROOT sub key of configuration. For example More...
void	purgeLines (OsConfigDb *pConfigDb)
	param: (in) pConfigDb - Configuration database to loaded from. param: (in) strSubKey - ROOT sub key of configuration. For example More...
const UtlString &	getOwner () const
	param: (in) pConfigDb - Configuration database to be cleared. More...
void	getDefaultOutboundLine (UtlString &rOutBoundLine)
UtlBoolean	getLine (const UtlString &toUrl, const UtlString &localContact, SipLine &sipline) const
UtlBoolean	getLines (int maxLines, int &actualLines, SipLine *lines[]) const
	returns The line identified by the designated To and Local Contact More...
UtlBoolean	getLines (int maxLines, int &actualLines, SipLine lines[]) const
int	getNumLines () const
int	getNumOfCredentialsForLine (const Url &identity) const
UtlBoolean	getCredentialListForLine (const Url &identity, int maxEnteries, int &actualEnteries, UtlString realmList[], UtlString userIdList[], UtlString typeList[], UtlString passTokenList[])
UtlBoolean	getCallHandlingForLine (const Url &identity) const
UtlBoolean	getEnableForLine (const Url &identity) const
int	getStateForLine (const Url &identity) const
UtlBoolean	getVisibilityForLine (const Url &identity) const
UtlBoolean	getUserForLine (const Url &identity, UtlString &User) const
UtlBoolean	getUserEnteredUrlForLine (const Url &identity, UtlString &sipUrl) const
UtlBoolean	getCanonicalUrlForLine (const Url &identity, UtlString &sipUrl) const
UtlBoolean	getContactTypeForLine (const Url &identity, LINE_CONTACT_TYPE &eContactType) const
UtlBoolean	isUserIdDefined (const SipMessage *request) const

Protected Member Functions
SipLineMgr &	operator= (const SipLineMgr &rhs)
UtlBoolean	handleMessage (OsMsg &eventMessage)
void	queueMessageToObservers (SipLineEvent &event)
void	removeFromList (SipLine *line)
void	addToList (SipLine *line)
SipLine *	getLineforAuthentication (const SipMessage *request, const SipMessage *response, const UtlBoolean &isIncomingRequest=FALSE, const UtlBoolean &fromTempList=FALSE) const
void	removeFromTempList (SipLine *line)
void	addToTempList (SipLine *line)
void	storeCredential (OsConfigDb *pConfigDb, UtlString strSubKey, UtlString strRealm, UtlString strUserId, UtlString strPassToken, UtlString strType)
UtlBoolean	loadCredential (OsConfigDb *pConfigDb, UtlString strSubKey, SipLine &line)
	param: (in) pConfigDb - Configuration database to saved to. param: (in) strSubKey - ROOT sub key of configuration. For example More...

Constructor & Destructor Documentation

SipLineMgr

(

const char *

authenticationScheme = HTTP_DIGEST_AUTHENTICATION

)

SipLineMgr

(

const SipLineMgr &

rSipLineMgr

)

~SipLineMgr ( )

virtual

Member Function Documentation

void StartLineMgr

(

)

UtlBoolean initializeRefreshMgr

(

SipRefreshMgr *

refreshMgr

)

void setDefaultContactUri

(

const Url &

contactUri

)

void setOwner

(

const UtlString &

owner

)

UtlBoolean addLine	(	SipLine &	line,
		UtlBoolean	doEnable = TRUE
	)

void deleteLine

(

const Url &

identity

)

void setDefaultOutboundLine

(

const Url &

outboundLine

)

UtlBoolean enableLine

(

const Url &

identity

)

void disableLine	(	const Url &	identity,
		UtlBoolean	onStartup = FALSE,
		const UtlString &	lineId = ""
	)

void lineHasBeenUnregistered

(

const Url &

identity

)

void enableAllLines

(

)

UtlBoolean buildAuthenticatedRequest	(	const SipMessage *	response,
		const SipMessage *	request,
		SipMessage *	newAuthRequest
	)

void setFirstLineAsDefaultOutBound

(

)

void setCallHandlingForLine	(	const Url &	identity,
		UtlBoolean	useCallHandling = TRUE
	)

void setAutoEnableForLine	(	const Url &	identity,
		UtlBoolean	isAutoEnable = TRUE
	)

void setStateForLine	(	const Url &	identity,
		int	state
	)

void setVisibilityForLine	(	const Url &	identity,
		UtlBoolean	Visibility = TRUE
	)

void setUserForLine	(	const Url &	identity,
		const UtlString	User
	)

void setUserEnteredUrlForLine	(	const Url &	identity,
		UtlString	sipUrl
	)

UtlBoolean setContactTypeForLine	(	const Url &	identity,
		LINE_CONTACT_TYPE	eContactType
	)

UtlBoolean addCredentialForLine	(	const Url &	identity,
		const UtlString	strRealm,
		const UtlString	strUserID,
		const UtlString	strPasswd,
		const UtlString	type
	)

UtlBoolean deleteCredentialForLine	(	const Url &	identity,
		const UtlString	strRealm
	)

void addMessageObserver	(	OsMsgQ &	messageQueue,
		void *	observerData = NULL
	)

UtlBoolean removeMessageObserver	(	OsMsgQ &	messageQueue,
		void *	pObserverData = NULL
	)

void notifyChangeInLineProperties

(

Url &

identity

)

param: messageQueue - All observers dispatching to this message queue

param: pObserverData - If null, all observers that match the message returns TRUE if one or more observers are removed otherwise FALSE.

void notifyChangeInOutboundLine

(

Url &

identity

)

void storeLine	(	OsConfigDb *	pConfigDb,
		UtlString	strSubKey,
		SipLine	line
	)

UtlBoolean loadLine	(	OsConfigDb *	pConfigDb,
		UtlString	strSubkey,
		SipLine &	line
	)

param: (in) pConfigDb - Configuration database to save to. param: (in) strSubKey - ROOT sub key of configuration. For example

param: (in) line - The line to be serialized

void purgeLines

(

OsConfigDb *

pConfigDb

)

param: (in) pConfigDb - Configuration database to loaded from. param: (in) strSubKey - ROOT sub key of configuration. For example

param: (out) line - The line to be serialized returns: TRUE if successfully loaded otherwise false.

const UtlString & getOwner

(

)

const

param: (in) pConfigDb - Configuration database to be cleared.

void getDefaultOutboundLine

(

UtlString &

rOutBoundLine

)

UtlBoolean getLine	(	const UtlString &	toUrl,
		const UtlString &	localContact,
		SipLine &	sipline
	)		const

UtlBoolean getLines	(	int	maxLines,
		int &	actualLines,
		SipLine *	lines[]
	)		const

returns The line identified by the designated To and Local Contact

UtlBoolean getLines	(	int	maxLines,
		int &	actualLines,
		SipLine	lines[]
	)		const

int getNumLines

(

)

const

int getNumOfCredentialsForLine

(

const Url &

identity

)

const

UtlBoolean getCredentialListForLine	(	const Url &	identity,
		int	maxEnteries,
		int &	actualEnteries,
		UtlString	realmList[],
		UtlString	userIdList[],
		UtlString	typeList[],
		UtlString	passTokenList[]
	)

UtlBoolean getCallHandlingForLine

(

const Url &

identity

)

const

UtlBoolean getEnableForLine

(

const Url &

identity

)

const

int getStateForLine

(

const Url &

identity

)

const

UtlBoolean getVisibilityForLine

(

const Url &

identity

)

const

UtlBoolean getUserForLine	(	const Url &	identity,
		UtlString &	User
	)		const

UtlBoolean getUserEnteredUrlForLine	(	const Url &	identity,
		UtlString &	sipUrl
	)		const

UtlBoolean getCanonicalUrlForLine	(	const Url &	identity,
		UtlString &	sipUrl
	)		const

UtlBoolean getContactTypeForLine	(	const Url &	identity,
		LINE_CONTACT_TYPE &	eContactType
	)		const

UtlBoolean isUserIdDefined

(

const SipMessage *

request

)

const

SipLineMgr& operator= ( const SipLineMgr &  rhs )

protected

UtlBoolean handleMessage ( OsMsg &  eventMessage )

protected

void queueMessageToObservers ( SipLineEvent &  event )

protected

void removeFromList ( SipLine *  line )

protected

void addToList ( SipLine *  line )

protected

SipLine * getLineforAuthentication ( const SipMessage *  request, const SipMessage *  response, const UtlBoolean &  isIncomingRequest = FALSE, const UtlBoolean &  fromTempList = FALSE  ) const

protected

void removeFromTempList ( SipLine *  line )

protected

void addToTempList ( SipLine *  line )

protected

void storeCredential ( OsConfigDb *  pConfigDb, UtlString  strSubKey, UtlString  strRealm, UtlString  strUserId, UtlString  strPassToken, UtlString  strType  )

protected

UtlBoolean loadCredential ( OsConfigDb *  pConfigDb, UtlString  strSubKey, SipLine &  line  )

protected

param: (in) pConfigDb - Configuration database to saved to. param: (in) strSubKey - ROOT sub key of configuration. For example

param: (in) strRealm - Realm for the Credential. param: (in) strUserId - User ID for the Credential. param: (in) strPassToken - Pass Token for the Credential. param: (in) strType - Authentication Type for the Credential.