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