udkapi/com/sun/star/security/XAccessControlContext.idl

   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
  22 module com {  module sun {  module star {  module security {
  23
  24
  25 /** An XAccessControlContext is used to make system resource access decisions
  26     based on the context it encapsulates.
  27     <p>
  28     More specifically, it encapsulates a context and has methods to check
  29     permissions equivalent to XAccessController interface,
  30     with one difference:
  31     The XAccessControlContext makes access decisions
  32     based on the context it encapsulates, rather than
  33     that of the current execution thread.
  34     </p>
  35
  36     @since OOo 1.1.2
  37 */
  38 published interface XAccessControlContext : com::sun::star::uno::XInterface
  39 {
  40     /** Determines whether the access request indicated by the specified
  41         permission should be allowed or denied, based on this context.
  42         The semantics are equivalent to the security permission classes of
  43         the Java platform.
  44         <p>
  45         You can also pass a sequence of permissions (sequence< any >) to check
  46         a set of permissions, e.g. for performance reasons.
  47         This method quietly returns if the access request is permitted,
  48         or throws a suitable AccessControlException otherwise.
  49         </p>
  50
  51         @param perm
  52                permission to be checked
  53
  54         @throws AccessControlException
  55                 thrown if access is denied
  56
  57         @see ::com::sun::star::security::AccessControlException
  58         @see ::com::sun::star::security::AllPermission
  59         @see ::com::sun::star::security::RuntimePermission
  60         @see ::com::sun::star::io::FilePermission
  61         @see ::com::sun::star::connection::SocketPermission
  62     */
  63     void checkPermission(
  64         [in] any perm )
  65         raises (AccessControlException);
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */