AuthRulesUrlMapping Class Reference

#include <AuthRulesUrlMapping.h>

Inheritance diagram for AuthRulesUrlMapping:

List of all members.

---

Detailed Description

This class interprets the rules encoded by the authrules XML schema (see the description elements in the schem files for the structure and contents of the file):.

• AuthRules: sipXcommserverLib/meta/authrules.xml Specifies a set of rules for what permissions are required to send a request to a particular target URI. The permissions returned (see getPermissionRequired) must be checked against those that the authorizing party has - if the authorizing party has any one of the required permissions, then the call is allowed. This mode is is used in the proxy (specifically the EnforceAuthRules AuthPlugin).

Public Member Functions
	AuthRulesUrlMapping ()
virtual	~AuthRulesUrlMapping ()
virtual OsStatus	loadMappings (const UtlString &configFileName, const UtlString &mediaserver="", const UtlString &voicemail="", const UtlString &localhost="")
	Read a mappings file into the XML DOM, providing translations for replacement tokens.
OsStatus	getPermissionRequired (const Url &requestUri, ResultSet &rPermissions) const
	Evaluate a request URI using authrules semantics, and return the set of permissions.
Private Member Functions
OsStatus	parsePermMatchContainer (const Url &requestUri, const UtlString &vdigits, ResultSet &rPermissions, const TiXmlNode *pUserMatchNode) const

---

Constructor & Destructor Documentation

AuthRulesUrlMapping

(

)

~AuthRulesUrlMapping

(

)

[virtual]

---

Member Function Documentation

OsStatus loadMappings	(	const UtlString &	configFileName,
		const UtlString &	mediaserver = "",
		const UtlString &	voicemail = "",
		const UtlString &	localhost = ""
	)			[virtual]

Read a mappings file into the XML DOM, providing translations for replacement tokens.

Reimplemented from UrlMapping.

OsStatus getPermissionRequired	(	const Url &	requestUri,
		ResultSet &	rPermissions
	)			const

Evaluate a request URI using authrules semantics, and return the set of permissions.

Parameters:

requestUri	target to check
rPermissions	required permissions (or'ed)

OsStatus parsePermMatchContainer	(	const Url &	requestUri,
		const UtlString &	vdigits,
		ResultSet &	rPermissions,
		const TiXmlNode *	pUserMatchNode
	)			const [private]