cppu::AccessControl Class Reference

Helper class for retrieving access controller singleton from component context. More...

#include <access_control.hxx>

Public Member Functions
	AccessControl (css::uno::Reference< css::uno::XComponentContext > const &xContext)
	Ctor. More...
	AccessControl (css::uno::Reference< css::security::XAccessController > const &xController)
	Ctor. More...
	AccessControl (::cppu::AccessControl const &ac)
	Copy ctor. More...
void SAL_CALL	clear ()
	Clears the access controller reference being used. More...
css::uno::Reference< css::security::XAccessController > const &SAL_CALL	get () const
	Returns access to the access controller reference being used. More...
css::security::XAccessController *SAL_CALL	operator-> () const
	Returns access to the access controller reference being used. More...
void SAL_CALL	checkRuntimePermission (::rtl::OUString const &name)
	A com.sun.star.security.RuntimePermission is for runtime permissions. More...
void SAL_CALL	checkFilePermission (::rtl::OUString const &url, ::rtl::OUString const &actions)
	A com.sun.star.io.FilePermission represents access to a file or directory. More...
void SAL_CALL	checkSocketPermission (::rtl::OUString const &host, ::rtl::OUString const &actions)
	A com.sun.star.connection.SocketPermission represents access to a network via sockets. More...

Private Attributes
css::uno::Reference< css::security::XAccessController >	m_xController

Detailed Description

Helper class for retrieving access controller singleton from component context.

Definition at line 37 of file access_control.hxx.

Constructor & Destructor Documentation

AccessControl() [1/3]

cppu::AccessControl::AccessControl

(

css::uno::Reference< css::uno::XComponentContext > const &

xContext

)

Ctor.

Parameters

xContext

component context to retrieve access controller singleton

AccessControl() [2/3]

cppu::AccessControl::AccessControl

(

css::uno::Reference< css::security::XAccessController > const &

xController

)

Ctor.

Parameters

xController

access controller

AccessControl() [3/3]

cppu::AccessControl::AccessControl

(

::cppu::AccessControl const &

ac

)

Copy ctor.

Parameters

ac	another object

Member Function Documentation

checkFilePermission()

void cppu::AccessControl::checkFilePermission	(	::rtl::OUString const &	url,
		::rtl::OUString const &	actions
	)

A com.sun.star.io.FilePermission represents access to a file or directory.

A FilePermission consists of a file url and a set of actions valid for that pathname.

Parameters

url	file url
actions	actions list

Definition at line 105 of file access_control.cxx.

References m_xController.

checkRuntimePermission()

void cppu::AccessControl::checkRuntimePermission

(

::rtl::OUString const &

name

)

A com.sun.star.security.RuntimePermission is for runtime permissions.

A RuntimePermission contains a name (also referred to as a "target name") but no actions list; you either have the named permission or you don't.

Parameters

name	name of permission

Definition at line 97 of file access_control.cxx.

References m_xController, and name.

checkSocketPermission()

void cppu::AccessControl::checkSocketPermission	(	::rtl::OUString const &	host,
		::rtl::OUString const &	actions
	)

A com.sun.star.connection.SocketPermission represents access to a network via sockets.

A SocketPermission consists of a host specification and a set of "actions" specifying ways to connect to that host.

Parameters

host	host and optional portrange
actions	actions list

Definition at line 114 of file access_control.cxx.

References m_xController.

clear()

void SAL_CALL cppu::AccessControl::clear ( )

inline

Clears the access controller reference being used.

Definition at line 66 of file access_control.hxx.

get()

css::uno::Reference< css::security::XAccessController > const &SAL_CALL cppu::AccessControl::get ( ) const

inline

Returns access to the access controller reference being used.

Returns

access controller

Definition at line 73 of file access_control.hxx.

operator->()

css::security::XAccessController *SAL_CALL cppu::AccessControl::operator-> ( ) const

inline

Returns access to the access controller reference being used.

Returns

access controller

Definition at line 80 of file access_control.hxx.

Member Data Documentation

m_xController

css::uno::Reference< css::security::XAccessController > cppu::AccessControl::m_xController

private

Definition at line 39 of file access_control.hxx.

Referenced by checkFilePermission(), checkRuntimePermission(), and checkSocketPermission().

---

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

• access_control.hxx
• access_control.cxx