LibreOffice: cppuhelper/access_control.hxx Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

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#ifndef INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
20#define INCLUDED_CPPUHELPER_ACCESS_CONTROL_HXX
21
22#include "cppuhelper/cppuhelperdllapi.h"
23#include "com/sun/star/uno/Reference.hxx"
24
25 namespace com { namespace sun { namespace star { namespace security { class XAccessController; } } } }
26namespace com { namespace sun { namespace star { namespace uno { class XComponentContext; } } } }
27
28namespace cppu
29{
30
33 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC AccessControl
34{
35 css::uno::Reference< css::security::XAccessController > m_xController;
36
37public:
42 AccessControl(
43 css::uno::Reference< css::uno::XComponentContext > const & xContext );
48 AccessControl(
49 css::uno::Reference< css::security::XAccessController > const & xController );
54 AccessControl( ::cppu::AccessControl const & ac );
55
58 void SAL_CALL clear()
59 { m_xController.clear(); }
60
65 css::uno::Reference< css::security::XAccessController > const & SAL_CALL get() const
66 { return m_xController; }
67
72 css::security::XAccessController * SAL_CALL operator -> () const
73 { return m_xController.get(); }
74
75
82 void SAL_CALL checkRuntimePermission(
83 ::rtl::OUString const & name );
84
91 void SAL_CALL checkFilePermission(
92 ::rtl::OUString const & url,
93 ::rtl::OUString const & actions );
94
102 void SAL_CALL checkSocketPermission(
103 ::rtl::OUString const & host,
104 ::rtl::OUString const & actions );
105};
106
107}
108
109#endif
110
111/* 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:558
cppuhelperdllapi.h
CPPUHELPER_DLLPUBLIC
#define CPPUHELPER_DLLPUBLIC
Definition: cppuhelperdllapi.h:28
Reference.hxx
cppu
Definition: Enterable.hxx:27
com
Definition: unotype.hxx:35
cppu::AccessControl
Helper class for retrieving access controller singleton from component context.
Definition: access_control.hxx:34
cppu::AccessControl::clear
void clear()
Clears the access controller reference being used.
Definition: access_control.hxx:58
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:65
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.
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:161