diff options
author | Daniel Boelzle <dbo@openoffice.org> | 2000-12-13 12:23:32 +0000 |
---|---|---|
committer | Daniel Boelzle <dbo@openoffice.org> | 2000-12-13 12:23:32 +0000 |
commit | 85f42299f3fc22a4adb3ab06e3ce8983044b5caa (patch) | |
tree | 4b018d1e5c6ac7bc72b64b9b1af1295c20c68294 /udkapi/com/sun/star | |
parent | 983202ea7beba3a6437781cd8b7020fcc6a56b04 (diff) |
corrected documentation
Diffstat (limited to 'udkapi/com/sun/star')
4 files changed, 46 insertions, 23 deletions
diff --git a/udkapi/com/sun/star/security/AccessControlException.idl b/udkapi/com/sun/star/security/AccessControlException.idl index 32ed2af460c2..2a8fd710f2c7 100644 --- a/udkapi/com/sun/star/security/AccessControlException.idl +++ b/udkapi/com/sun/star/security/AccessControlException.idl @@ -2,9 +2,9 @@ * * $RCSfile: AccessControlException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2000-12-12 17:02:56 $ + * last change: $Author: dbo $ $Date: 2000-12-13 13:23:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ module com { module sun { module star { module security { */ exception AccessControlException : com::sun::star::uno::SecurityException { + /** denied permission + */ Permission LackingPermission; }; diff --git a/udkapi/com/sun/star/security/AccessController.idl b/udkapi/com/sun/star/security/AccessController.idl index f0e21285cf9a..debae59bac98 100644 --- a/udkapi/com/sun/star/security/AccessController.idl +++ b/udkapi/com/sun/star/security/AccessController.idl @@ -2,9 +2,9 @@ * * $RCSfile: AccessController.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2000-12-12 17:02:56 $ + * last change: $Author: dbo $ $Date: 2000-12-13 13:23:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,9 +74,11 @@ module com { module sun { module star { module security { /** This service supports the XAccessController interface for checking security permissions along with the current threads' permissions. + <p> It obviously has also to be ensured that the object is process-local to assure that permission checks are not corrupted via insecure inter-process communication. + </p> */ service AccessController { diff --git a/udkapi/com/sun/star/security/XAccessControlContext.idl b/udkapi/com/sun/star/security/XAccessControlContext.idl index 99522bfc2204..280cdaac013b 100644 --- a/udkapi/com/sun/star/security/XAccessControlContext.idl +++ b/udkapi/com/sun/star/security/XAccessControlContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAccessControlContext.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2000-12-12 17:02:56 $ + * last change: $Author: dbo $ $Date: 2000-12-13 13:23:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,22 +82,28 @@ module com { module sun { module star { module security { /** An XAccessControlContext is used to make system resource access decisions based on the context it encapsulates. + <p> More specifically, it encapsulates a context and has methods to check permissions equivalent to XAccessController interface, - with one difference: The XAccessControlContext makes access decisions - based on the context it encapsulates, rather than - that of the current execution thread. + with one difference: + The XAccessControlContext makes access decisions + based on the context it encapsulates, rather than + that of the current execution thread. + </p> */ [ uik(7908B562-9C21-4330-8DF6840D-A46399F2), ident( "XAccessControlContext", 1.0 ) ] interface XAccessControlContext : com::sun::star::uno::XInterface { /** Determines whether the access request indicated by the specified permission should be allowed or denied, based on this context. + <p> This method quietly returns if the access request is permitted, or throws a suitable AccessControlException otherwise. - - @param perm access permission to be checked - @exception AccessControlException thrown if access is denied + </p> + @param perm + access permission to be checked + @throws AccessControlException + thrown if access is denied */ void checkPermission( [in] Permission perm ) diff --git a/udkapi/com/sun/star/security/XAccessController.idl b/udkapi/com/sun/star/security/XAccessController.idl index 69a6d3d2ba62..266fcfec04d7 100644 --- a/udkapi/com/sun/star/security/XAccessController.idl +++ b/udkapi/com/sun/star/security/XAccessController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAccessController.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2000-12-12 17:02:56 $ + * last change: $Author: dbo $ $Date: 2000-12-13 13:23:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,9 +89,11 @@ module com { module sun { module star { module security { //============================================================================= /** Interface for checking permissions and invoking privileged code. + <p> A privileged call runs at least in the protection domain of the callers code, although you can give an additional AccessControlContext to restrict access. + </p> */ [ uik(2E78F3CB-3172-44b3-BE60EDCB-91384BC9), ident( "XAccessController", 1.0 ) ] interface XAccessController : com::sun::star::uno::XInterface @@ -99,11 +101,14 @@ interface XAccessController : com::sun::star::uno::XInterface /** Determines whether the access request indicated by the specified permission should be allowed or denied, based on the security policy currently in effect. + <p> This method quietly returns if the access request is permitted, or throws a suitable AccessControlException otherwise. - - @param perm access permission to be checked - @exception AccessControlException thrown if access is denied + </p> + @param perm + access permission to be checked + @throws AccessControlException + thrown if access is denied */ void checkPermission( [in] Permission perm ) @@ -111,15 +116,21 @@ interface XAccessController : com::sun::star::uno::XInterface /** Perform the specified action with privileges enabled and restricted by the specified AccessControlContext. + <p> The action is performed with the intersection of the the permissions possessed by the caller's protection domain, and those possessed by the domains represented by the specified AccessControlContext. If specified XAccessControlContext is null, then the action is performed only with the permissions possessed by the caller's protection domain. - - @param action action object to be execute - @return result - @param restriction access control context to restrict permission; null for no restriction + </p> + @param action + action object to be execute + @param restriction + access control context to restrict permission; null for no restriction + @return + result + @throws com::sun::star::uno::Exception + any UNO exception may be thrown */ any doPrivileged( [in] XPrivilegedAction action, @@ -128,9 +139,11 @@ interface XAccessController : com::sun::star::uno::XInterface /** This method takes a "snapshot" of the current calling context and returns it. + <p> This context may then be checked at a later point, possibly in another thread. - - @return snapshot of context + </p> + @return + snapshot of context */ XAccessControlContext getContext(); }; |