policy-procs.tcl

XOTcl API for policies

Location:
packages/xotcl-core/tcl/policy-procs.tcl
Created:
2007-03-09
Author:
Gustaf Neumann
CVS Identification:
$Id: policy-procs.tcl,v 1.29.2.20 2023/02/08 19:15:34 gustafn Exp $

Procedures in this file

Detailed information

xo::Policy instproc check_permissions (public)

 <instance of xo::Policy[i]> check_permissions [ -user_id user_id ] \
    [ -package_id package_id ] [ -link link ] object method

This method checks whether the current or specified user is allowed to invoke a method based on the given policy. This method is purely checking and does not force logins or other side effects. It can be safely used for example to check whether links should be shown or not.

Switches:
-user_id
(optional)
-package_id
(optional)
-link
(optional)
Parameters:
object
method
Returns:
0 or 1
See Also:
  • enforce_permissions

Partial Call Graph (max 5 caller/called nodes):
%3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xo::Policy instproc check_permissions xo::Policy instproc check_permissions test_xowiki_test_cases->xo::Policy instproc check_permissions

Testcases:
xowiki_test_cases

xo::Policy instproc enforce_permissions (public)

 <instance of xo::Policy[i]> enforce_permissions \
    [ -user_id user_id ] [ -package_id package_id ] object method

This method checks whether the current user is allowed or not to invoke a method based on the given policy and forces logins if required.

Switches:
-user_id
(optional)
-package_id
(optional)
Parameters:
object
method
Returns:
0 or 1
See Also:
  • check_permissions

Partial Call Graph (max 5 caller/called nodes):
%3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xo::Policy instproc enforce_permissions xo::Policy instproc enforce_permissions test_xowiki_test_cases->xo::Policy instproc enforce_permissions _ _ (public) xo::Policy instproc enforce_permissions->_ ad_return_forbidden ad_return_forbidden (public) xo::Policy instproc enforce_permissions->ad_return_forbidden ad_script_abort ad_script_abort (public) xo::Policy instproc enforce_permissions->ad_script_abort auth::require_login auth::require_login (public) xo::Policy instproc enforce_permissions->auth::require_login

Testcases:
xowiki_test_cases
[ show source ]