LibreOffice: cppuhelper/access_control.hxx Source File

LibreOffice LibreOffice 25.8 SDK C/C++ API Reference

Loading...
Searching...
No Matches
access_control.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20/*
21 * This file is part of LibreOffice published API.
22 */
23#ifndef INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
24#define INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
25
26#include "cppuhelper/cppuhelperdllapi.h"
27#include "com/sun/star/uno/Reference.hxx"
28
29 namespace com { namespace sun { namespace star { namespace security { class XAccessController; } } } }
30namespace com { namespace sun { namespace star { namespace uno { class XComponentContext; } } } }
31
32namespace cppu
33{
34
37 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC AccessControl
38{
39 css::uno::Reference< css::security::XAccessController > m_xController;
40
41public:
46 AccessControl(
47 css::uno::Reference< css::uno::XComponentContext > const & xContext );
52 AccessControl(
53 css::uno::Reference< css::security::XAccessController > const & xController );
58 AccessControl( ::cppu::AccessControl const & ac );
59
60#if defined LIBO_INTERNAL_ONLY
61 AccessControl & operator =(AccessControl const &) = default; // avoid deprecation warnings
62#endif
63
66 void SAL_CALL clear()
67 { m_xController.clear(); }
68
73 css::uno::Reference< css::security::XAccessController > const & SAL_CALL get() const
74 { return m_xController; }
75
80 css::security::XAccessController * SAL_CALL operator -> () const
81 { return m_xController.get(); }
82
83
90 void SAL_CALL checkRuntimePermission(
91 ::rtl::OUString const & name );
92
99 void SAL_CALL checkFilePermission(
100 ::rtl::OUString const & url,
101 ::rtl::OUString const & actions );
102
110 void SAL_CALL checkSocketPermission(
111 ::rtl::OUString const & host,
112 ::rtl::OUString const & actions );
113};
114
115}
116
117#endif
118
119/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition types.h:611
cppuhelperdllapi.h
CPPUHELPER_DLLPUBLIC
#define CPPUHELPER_DLLPUBLIC
Definition cppuhelperdllapi.h:32
Reference.hxx
com
Definition types.h:377
com::sun
Definition types.h:377
com::sun::star
Definition types.h:377
com::sun::star::uno
Definition typedescription.hxx:43
cppu
Definition Enterable.hxx:31
com::sun::star::security
Definition access_control.hxx:29
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition ustring.hxx:172
com::sun::star::uno::Reference< css::security::XAccessController >
com::sun::star::uno::Reference::get
interface_type * get() const
Gets interface pointer.
Definition Reference.h:405
cppu::AccessControl
Helper class for retrieving access controller singleton from component context.
Definition access_control.hxx:38
cppu::AccessControl::clear
void clear()
Clears the access controller reference being used.
Definition access_control.hxx:66
cppu::AccessControl::checkFilePermission
void checkFilePermission(::rtl::OUString const &url, ::rtl::OUString const &actions)
A com.sun.star.io.FilePermission represents access to a file or directory.
cppu::AccessControl::get
css::uno::Reference< css::security::XAccessController > const & get() const
Returns access to the access controller reference being used.
Definition access_control.hxx:73
cppu::AccessControl::AccessControl
AccessControl(css::uno::Reference< css::security::XAccessController > const &xController)
Ctor.
cppu::AccessControl::checkRuntimePermission
void checkRuntimePermission(::rtl::OUString const &name)
A com.sun.star.security.RuntimePermission is for runtime permissions.
cppu::AccessControl::AccessControl
AccessControl(css::uno::Reference< css::uno::XComponentContext > const &xContext)
Ctor.
cppu::AccessControl::checkSocketPermission
void checkSocketPermission(::rtl::OUString const &host, ::rtl::OUString const &actions)
A com.sun.star.connection.SocketPermission represents access to a network via sockets.
cppu::AccessControl::AccessControl
AccessControl(::cppu::AccessControl const &ac)
Copy ctor.