LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
cppu::AccessControl Class Reference

Helper class retriving 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 clear ()
 Clears the access controller reference being used. More...
 
css::uno::Reference
< css::security::XAccessController >
const & 
get () const
 Returns access to the access controller reference being used. More...
 
css::security::XAccessController * operator-> () const
 Returns access to the access controller reference being used. More...
 
void checkRuntimePermission (::rtl::OUString const &name)
 A com.sun.star.security.RuntimePermission is for runtime permissions. More...
 
void checkFilePermission (::rtl::OUString const &url,::rtl::OUString const &actions)
 A com.sun.star.io.FilePermission represents access to a file or directory. More...
 
void checkSocketPermission (::rtl::OUString const &host,::rtl::OUString const &actions)
 A com.sun.star.connection.SocketPermission represents access to a network via sockets. More...
 

Detailed Description

Helper class retriving access controller singleton from component context.

Constructor & Destructor Documentation

cppu::AccessControl::AccessControl ( css::uno::Reference< css::uno::XComponentContext > const &  xContext)

Ctor.

Parameters
xContextcomponent context to retrieve access controller singleton
cppu::AccessControl::AccessControl ( css::uno::Reference< css::security::XAccessController > const &  xController)

Ctor.

Parameters
xControlleraccess controller
cppu::AccessControl::AccessControl ( ::cppu::AccessControl const &  ac)

Copy ctor.

Parameters
acanother object

Member Function Documentation

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
urlfile url
actionsactions list
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
namename of permission
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
hosthost and optional portrange
actionsactions list
void cppu::AccessControl::clear ( )
inline

Clears the access controller reference being used.

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

Returns access to the access controller reference being used.

Returns
access controller
css::security::XAccessController* cppu::AccessControl::operator-> ( ) const
inline

Returns access to the access controller reference being used.

Returns
access controller

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