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