Collapse all Symbian^3 Product Developer Library

CUpnpSecAccessController Class Reference

class CUpnpSecAccessController : public CBase

Access controller class

upnpsecurity.lib

Since: S60 3.0

Inherits from

CUpnpSecAccessController
- CBase

Public Member Functions
	~CUpnpSecAccessController()
IMPORT_C TInt	AddAllowedAddress(const TInetAddr &)
IMPORT_C TInt	AddAllowedFile(const TDesC &)
IMPORT_C void	CheckAuthorizationL(const TInetAddr &, const TDesC &, const TDesC8 &)
IMPORT_C void	DisableMediaServerSecurityL()
IMPORT_C void	EnableMediaServerSecurityL()
IMPORT_C TBool	IsMediaServerSecurityEnabledL()
IMPORT_C CUpnpSecAccessController *	NewL()
IMPORT_C void	QueryAuthorizationL(const TInetAddr &)
IMPORT_C TInt	RemoveAllowedAddress(const TInetAddr &)
IMPORT_C TInt	RemoveAllowedFile(const TDesC &)
IMPORT_C TInt	ResetAddressList()
IMPORT_C TInt	ResetFileList()

Private Member Functions
	CUpnpSecAccessController()
void	ConstructL()
TBool	IsAllowedAction(const TDesC8 &)
TBool	IsAllowedFile(const TDesC &)
void	SetSecurityManagerSettingL(const TDesC8 &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
RUpnpSecurityManagerClientSession *	iSecurityManagerClientSession

Constructor & Destructor Documentation

CUpnpSecAccessController()

CUpnpSecAccessController

(

)

[private]

C++ default constructor.

~CUpnpSecAccessController()

IMPORT_C

~CUpnpSecAccessController

(

)

[virtual]

Destructor.

Member Functions Documentation

AddAllowedAddress(const TInetAddr &)

IMPORT_C TInt

AddAllowedAddress

(

const TInetAddr &

aIpAddress

)

Adds allowed IP address, so that no authorization is requested when client with that IP address makes connection request.

Since: S60 3.0

Parameters

const TInetAddr & aIpAddress

reference to allowed IP address

AddAllowedFile(const TDesC &)

IMPORT_C TInt

AddAllowedFile

(

const TDesC &

aFileName

)

Adds allowed file, so that no authorization is requested when client gets this file.

Since: S60 3.0

Parameters

const TDesC & aFileName

reference to allowed file

CheckAuthorizationL(const TInetAddr &, const TDesC &, const TDesC8 &)

IMPORT_C void	CheckAuthorizationL	(	const TInetAddr &	aIpAddress,
			const TDesC &	aFileName,
			const TDesC8 &	aActionName
		)

Checks if the given IP-address/action/file is authorized. Null parameters (filename and/or action name) are allowed.

Leaves with standard e32err error code in case of an error, or with KErrAccessDenied if access is not authorized.

Since: S60 3.1

Parameters

const TInetAddr & aIpAddress	(const TInetAddr&) IP address
const TDesC & aFileName	(const TDesC&) filename
const TDesC8 & aActionName	(const TDesC8&) action name

ConstructL()

void

ConstructL

(

)

[private]

Second-phase constructor.

DisableMediaServerSecurityL()

IMPORT_C void

DisableMediaServerSecurityL

(

)

[static]

Disables the security plugin in Media Server.

Since: S60 3.1

EnableMediaServerSecurityL()

IMPORT_C void

EnableMediaServerSecurityL

(

)

[static]

Enables the security plugin in Media Server.

Since: S60 3.1

IsAllowedAction(const TDesC8 &)

TBool

IsAllowedAction

(

const TDesC8 &

aActionName

)

[private]

Checks if the requested action is automatically allowed.

Since: S60 3.1

Parameters

const TDesC8 & aActionName

(const TDesC8&) action name that request concerns

IsAllowedFile(const TDesC &)

TBool

IsAllowedFile

(

const TDesC &

aFileName

)

[private]

Checks if the requested file is automatically allowed.

Since: S60 3.1

Parameters

const TDesC & aFileName

(const TDesC&) the file that request concerns

IsMediaServerSecurityEnabledL()

IMPORT_C TBool

IsMediaServerSecurityEnabledL

(

)

[static]

Returns the status of the Media Server security plugin.

Since: S60 3.1

NewL()

IMPORT_C CUpnpSecAccessController *

NewL

(

)

[static]

Two-phased constructor.

QueryAuthorizationL(const TInetAddr &)

IMPORT_C void

QueryAuthorizationL

(

const TInetAddr &

aIpAddress

)

Query user to authorize connection from an IP-address.

Leaves with standard e32err error code in case of an error, or with KErrAccessDenied if access is not authorized.

Since: S60 3.1

Parameters

const TInetAddr & aIpAddress

(const TInetAddr&) reference to IP Address

RemoveAllowedAddress(const TInetAddr &)

IMPORT_C TInt

RemoveAllowedAddress

(

const TInetAddr &

aIpAddress

)

Removes allowed IP address.

Since: S60 3.0

Parameters

const TInetAddr & aIpAddress

reference to IP address to be removed

RemoveAllowedFile(const TDesC &)

IMPORT_C TInt

RemoveAllowedFile

(

const TDesC &

aFileName

)

Removes file from white list.

Since: S60 3.0

Parameters

const TDesC & aFileName

reference to file to be removed

ResetAddressList()

IMPORT_C TInt

ResetAddressList

(

)

Removes all allowed IP Addresses from white list.

Since: S60 3.0

ResetFileList()

IMPORT_C TInt

ResetFileList

(

)

Removes all allowed files from white list.

Since: S60 3.0

SetSecurityManagerSettingL(const TDesC8 &)

void

SetSecurityManagerSettingL

(

const TDesC8 &

aSettingToSet

)

[private, static]

Set securitymanagersetting to given value

Parameters

const TDesC8 & aSettingToSet

value to set

Member Data Documentation

RUpnpSecurityManagerClientSession * iSecurityManagerClientSession

RUpnpSecurityManagerClientSession *

iSecurityManagerClientSession

[private]