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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_security_XAccessControlContext_idl__
  28 #define __com_sun_star_security_XAccessControlContext_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_security_AccessControlException_idl__
  34 #include <com/sun/star/security/AccessControlException.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module security {
  41
  42 //=============================================================================
  43
  44 /** An XAccessControlContext is used to make system resource access decisions
  45     based on the context it encapsulates.
  46     <p>
  47     More specifically, it encapsulates a context and has methods to check
  48     permissions equivalent to XAccessController interface,
  49     with one difference:
  50     The XAccessControlContext makes access decisions
  51     based on the context it encapsulates, rather than
  52     that of the current execution thread.
  53     </p>
  54
  55     @since OOo 1.1.2
  56 */
  57 published interface XAccessControlContext : com::sun::star::uno::XInterface
  58 {
  59     /** Determines whether the access request indicated by the specified
  60         permission should be allowed or denied, based on this context.
  61         The semantics are equivalent to the security permission classes of
  62         the Java platform.
  63         <p>
  64         You can also pass a sequence of permissions (sequence< any >) to check
  65         a set of permissions, e.g. for performance reasons.
  66         This method quietly returns if the access request is permitted,
  67         or throws a suitable AccessControlException otherwise.
  68         </p>
  69
  70         @param perm
  71                permission to be checked
  72
  73         @throws AccessControlException
  74                 thrown if access is denied
  75
  76         @see ::com::sun::star::security::AccessControlException
  77         @see ::com::sun::star::security::AllPermission
  78         @see ::com::sun::star::security::RuntimePermission
  79         @see ::com::sun::star::io::FilePermission
  80         @see ::com::sun::star::connection::SocketPermission
  81     */
  82     void checkPermission(
  83         [in] any perm )
  84         raises (AccessControlException);
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif