include/cppuhelper/access_control.hxx

   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; } } } }
  30 namespace com { namespace sun { namespace star { namespace uno { class XComponentContext; } } } }
  31
  32 namespace cppu
  33 {
  34
  35 /** Helper class for retrieving access controller singleton from component context.
  36 */
  37 class SAL_WARN_UNUSED CPPUHELPER_DLLPUBLIC AccessControl
  38 {
  39     css::uno::Reference< css::security::XAccessController > m_xController;
  40
  41 public:
  42     /** Ctor.
  43
  44         @param xContext component context to retrieve access controller singleton
  45     */
  46     AccessControl(
  47         css::uno::Reference< css::uno::XComponentContext > const & xContext );
  48     /** Ctor.
  49
  50         @param xController access controller
  51     */
  52     AccessControl(
  53         css::uno::Reference< css::security::XAccessController > const & xController );
  54     /** Copy ctor.
  55
  56         @param ac another object
  57     */
  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
  64     /** Clears the access controller reference being used.
  65     */
  66     void SAL_CALL clear()
  67         { m_xController.clear(); }
  68
  69     /** Returns access to the access controller reference being used.
  70
  71         @return access controller
  72     */
  73     css::uno::Reference< css::security::XAccessController > const & SAL_CALL get() const
  74         { return m_xController; }
  75
  76     /** Returns access to the access controller reference being used.
  77
  78         @return access controller
  79     */
  80     css::security::XAccessController * SAL_CALL operator -> () const
  81         { return m_xController.get(); }
  82
  83
  84     /** A com.sun.star.security.RuntimePermission is for runtime permissions.
  85         A RuntimePermission contains a name (also referred to as a "target name") but no
  86         actions list; you either have the named permission or you don't.
  87
  88         @param name name of permission
  89     */
  90     void SAL_CALL checkRuntimePermission(
  91         ::rtl::OUString const & name );
  92
  93     /** A com.sun.star.io.FilePermission represents access to a file or directory.
  94         A FilePermission consists of a file url and a set of actions valid for that pathname.
  95
  96         @param url file url
  97         @param actions actions list
  98     */
  99     void SAL_CALL checkFilePermission(
 100         ::rtl::OUString const & url,
 101         ::rtl::OUString const & actions );
 102
 103     /** A com.sun.star.connection.SocketPermission represents access to a network via sockets.
 104         A SocketPermission consists of a host specification and a set of "actions"
 105         specifying ways to connect to that host.
 106
 107         @param host host and optional portrange
 108         @param actions actions list
 109     */
 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: */