Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: security ::
interface XAccessController
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XAccessController
Description Interface for checking permissions and invoking privileged or restricted actions. Since version OpenOffice.org 1.1.1

Methods' Summary
checkPermission | Determines whether the access request indicated by the specified permission should be allowed or denied, based on the security policy currently in effect. The semantics are equivalent to the security permission classes of the Java platform.
doRestricted | Perform the specified action restricting permissions to the given XAccessControlContext. The action is performed with the intersection of the permissions of the currently installed XAccessControlContext, the given XAccessControlContext and the security policy currently in effect. The latter includes static security, e.g. based on user credentials.
doPrivileged | Perform the specified action adding a set of permissions defined by the given XAccessControlContext. The action is performed with the union of the permissions of the currently installed XAccessControlContext, the given XAccessControlContext and the security policy currently in effect. The latter includes static security, e.g. based on user credentials.
getContext | This method takes a "snapshot" of the current calling context and returns it.

Methods' Details
checkPermission
void checkPermission( | [in] any raises( | perm ) AccessControlException );
Description Determines whether the access request indicated by the specified permission should be allowed or denied, based on the security policy currently in effect. The semantics are equivalent to the security permission classes of the Java platform. You can also pass a sequence of permissions (sequence< any > ) to check a set of permissions, e.g. for performance reasons. This method quietly returns if the access request is permitted, or throws a suitable AccessControlException otherwise. Parameter perm permission to be checked Throws AccessControlException thrown if access is denied See also AccessControlException See also AllPermission See also RuntimePermission See also ::com::sun::star::io::FilePermission See also ::com::sun::star::connection::SocketPermission
doRestricted
any doRestricted( | [in] XAction [in] XAccessControlContext raises( | action, restriction ) ::com::sun::star::uno::Exception );
Description Perform the specified action restricting permissions to the given XAccessControlContext. The action is performed with the intersection of the permissions of the currently installed XAccessControlContext, the given XAccessControlContext and the security policy currently in effect. The latter includes static security, e.g. based on user credentials. If the specified XAccessControlContext is null, then the action is performed with unmodified permissions, i.e. the call makes no sense. Parameter action action object to be executed Parameter restriction access control context to restrict permission; null for no restriction Returns result Throws com::sun::star::uno::Exception any UNO exception may be thrown
doPrivileged
any doPrivileged( | [in] XAction [in] XAccessControlContext raises( | action, restriction ) ::com::sun::star::uno::Exception );
Description Perform the specified action adding a set of permissions defined by the given XAccessControlContext. The action is performed with the union of the permissions of the currently installed XAccessControlContext, the given XAccessControlContext and the security policy currently in effect. The latter includes static security, e.g. based on user credentials. If the given XAccessControlContext is null, then the action is performed only with the permissions of the security policy currently in effect. @attention Do carefully use this method only for well known use-cases to avoid exploits! Script engines executing sandboxed scripts should generally deny calling this method. Parameter action action object to be executed Parameter restriction access control context to restrict permission; null for no restriction Returns result Throws com::sun::star::uno::Exception any UNO exception may be thrown
getContext
XAccessControlContext getContext(); |  |
Description This method takes a "snapshot" of the current calling context and returns it. This context may then be checked at a later point, possibly in another thread. Returns snapshot of context

Top of Page

Copyright © 2003 Sun Microsystems, Inc.