• Publicity: Public Only All

authority-procs.tcl

Procs for authority management.

Location:
packages/acs-authentication/tcl/authority-procs.tcl
Created:
2003-05-14
Author:
Lars Pind <lars@collaobraid.biz>
CVS Identification:
$Id: authority-procs.tcl,v 1.39.2.7 2021/12/05 16:16:18 gustafn Exp $

Procedures in this file

Detailed information

auth::authority::batch_sync (public)

 auth::authority::batch_sync -authority_id authority_id

Execute batch synchronization for this authority now.

Switches:
-authority_id (required)
Returns:
job_id

Partial Call Graph (max 5 caller/called nodes):
%3 test_sync_batch_for_local sync_batch_for_local (test acs-authentication) auth::authority::batch_sync auth::authority::batch_sync test_sync_batch_for_local->auth::authority::batch_sync test_sync_batch_ims_example_doc sync_batch_ims_example_doc (test acs-authentication) test_sync_batch_ims_example_doc->auth::authority::batch_sync test_sync_batch_ims_test sync_batch_ims_test (test acs-authentication) test_sync_batch_ims_test->auth::authority::batch_sync auth::sync::sweeper auth::sync::sweeper (private) auth::sync::sweeper->auth::authority::batch_sync packages/acs-admin/www/auth/batch-job-run.tcl packages/acs-admin/ www/auth/batch-job-run.tcl packages/acs-admin/www/auth/batch-job-run.tcl->auth::authority::batch_sync

Testcases:
sync_batch_for_local, sync_batch_ims_example_doc, sync_batch_ims_test

auth::authority::create (public)

 auth::authority::create [ -authority_id authority_id ] -array array

Create a new authentication authority.

Switches:
-authority_id (optional)
-array (required)
Name of an array containing the column values. The entries are:
  • short_name Short name for authority. Used as a key by applications to identify this authority.
  • pretty_name Label for the authority to be shown in a list to users picking an authority.
  • enabled_p 't' if this authority available, 'f' if it's disabled. Defaults to 'f'.
  • sort_order Sort ordering determines the order in which authorities are listed in the user interface. Defaults to the currently highest sort order plus one.
  • auth_impl_id The ID of the implementation of the 'auth_authentication' service contract. Defaults to none.
  • pwd_impl_id The ID of the implementation of the 'auth_password' service contract. Defaults to none.
  • forgotten_pwd_url An alternative URL to redirect to when the user has forgotten his/her password. Defaults to none.
  • change_pwd_url An alternative URL to redirect to when the user wants to change his/her password. Defaults to none.
  • register_impl_id The ID of the implementation of the 'auth_registration' service contract. Defaults to none.
  • register_url An alternative URL to redirect to when the user wants to register for an account. Defaults to none.
  • user_info_impl_id The ID of the implementation of the 'auth_user_info' service contract. Defaults to none.
  • get_doc_impl_id Id of the 'auth_sync_retrieve' service contract implementation
  • process_doc_impl_id Id of the 'auth_sync_process' service contract implementation
  • batch_sync_enabled_p Is batch sync enabled for the authority?
Options:
-authority_id
Authority_id, or blank if you want one generated for you.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::create auth::authority::create test_auth_authority_api->auth::authority::create test_sync_batch_ims_example_doc sync_batch_ims_example_doc (test acs-authentication) test_sync_batch_ims_example_doc->auth::authority::create test_sync_batch_ims_test sync_batch_ims_test (test acs-authentication) test_sync_batch_ims_test->auth::authority::create acs::test::auth::install acs::test::auth::install (private) acs::test::auth::install->auth::authority::create packages/acs-admin/www/auth/authority.tcl packages/acs-admin/ www/auth/authority.tcl packages/acs-admin/www/auth/authority.tcl->auth::authority::create

Testcases:
auth_authority_api, sync_batch_ims_example_doc, sync_batch_ims_test

auth::authority::delete (public)

 auth::authority::delete -authority_id authority_id

Delete an authority.

Switches:
-authority_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::delete auth::authority::delete test_auth_authority_api->auth::authority::delete packages/acs-admin/www/auth/authority-delete.tcl packages/acs-admin/ www/auth/authority-delete.tcl packages/acs-admin/www/auth/authority-delete.tcl->auth::authority::delete

Testcases:
auth_authority_api

auth::authority::edit (public)

 auth::authority::edit -authority_id authority_id -array array

Edit info about an authority. Note that there's no checking that the columns you name exist.

Switches:
-authority_id (required)
The authority you want to get.
-array (required)
Name of an array with column values to update.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::edit auth::authority::edit test_auth_authority_api->auth::authority::edit test_auth_authority_edit auth_authority_edit (test acs-authentication) test_auth_authority_edit->auth::authority::edit auth::authority::create auth::authority::create (public) auth::authority::create->auth::authority::edit auth::local::install auth::local::install (private) auth::local::install->auth::authority::edit auth::local::uninstall auth::local::uninstall (private) auth::local::uninstall->auth::authority::edit packages/acs-admin/www/auth/authority-set-enabled-p.tcl packages/acs-admin/ www/auth/authority-set-enabled-p.tcl packages/acs-admin/www/auth/authority-set-enabled-p.tcl->auth::authority::edit packages/acs-admin/www/auth/authority-set-sort-order.tcl packages/acs-admin/ www/auth/authority-set-sort-order.tcl packages/acs-admin/www/auth/authority-set-sort-order.tcl->auth::authority::edit

Testcases:
auth_authority_api, auth_authority_edit

auth::authority::get (public)

 auth::authority::get [ -authority_id authority_id ] [ -array array ]

Get info about an authority and return the authority_id. If no authority is specified, then return

Switches:
-authority_id (optional)
The authority you want to get. If not specified, return the default authority
-array (optional)
Name of an array into which the detailed attributes should be delivered
Returns:
authority_id
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::get auth::authority::get test_auth_authority_api->auth::authority::get test_auth_authority_edit auth_authority_edit (test acs-authentication) test_auth_authority_edit->auth::authority::get test_auth_driver_get_parameter_values auth_driver_get_parameter_values (test acs-authentication) test_auth_driver_get_parameter_values->auth::authority::get acs_user::get_by_username acs_user::get_by_username (public) acs_user::get_by_username->auth::authority::get auth::authority::batch_sync auth::authority::batch_sync (public) auth::authority::batch_sync->auth::authority::get auth::authority::get_element auth::authority::get_element (public) auth::authority::get_element->auth::authority::get auth::get_local_account auth::get_local_account (private) auth::get_local_account->auth::authority::get auth::get_register_authority auth::get_register_authority (public) auth::get_register_authority->auth::authority::get

Testcases:
auth_authority_api, auth_driver_get_parameter_values, auth_authority_edit

auth::authority::get_authority_options (public)

 auth::authority::get_authority_options

Returns options (value label pairs) for building the authority HTML select box.

Author:
Simon Carstensen

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::get_authority_options auth::authority::get_authority_options test_auth_authority_api->auth::authority::get_authority_options auth::authority::get auth::authority::get (public) auth::authority::get->auth::authority::get_authority_options http_auth::set_user_id http_auth::set_user_id (public) http_auth::set_user_id->auth::authority::get_authority_options oacs_dav::set_user_id oacs_dav::set_user_id (public) oacs_dav::set_user_id->auth::authority::get_authority_options packages/acs-authentication/lib/search.tcl packages/acs-authentication/ lib/search.tcl packages/acs-authentication/lib/search.tcl->auth::authority::get_authority_options packages/acs-subsite/lib/login.tcl packages/acs-subsite/ lib/login.tcl packages/acs-subsite/lib/login.tcl->auth::authority::get_authority_options

Testcases:
auth_authority_api

auth::authority::get_element (public)

 auth::authority::get_element [ -authority_id authority_id ] \
    -element element

Return a specific element of the auth_authority data table.

Switches:
-authority_id (optional)
-element (required)

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_edit auth_authority_edit (test acs-authentication) auth::authority::get_element auth::authority::get_element test_auth_authority_edit->auth::authority::get_element auth::authenticate auth::authenticate (public) auth::authenticate->auth::authority::get_element auth::authentication::authenticate auth::authentication::authenticate (public) auth::authentication::authenticate->auth::authority::get_element auth::authority::edit auth::authority::edit (public) auth::authority::edit->auth::authority::get_element auth::create_local_account auth::create_local_account (public) auth::create_local_account->auth::authority::get_element auth::create_user auth::create_user (public) auth::create_user->auth::authority::get_element

Testcases:
auth_authority_edit

auth::authority::get_id (public)

 auth::authority::get_id -short_name short_name

Get authority_id by short_name.

Switches:
-short_name (required)
The short_name of the authority you wish to get information for.
Returns:
authority_id or the empty string if short_name doesn't exist.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::get_id auth::authority::get_id test_auth_authority_api->auth::authority::get_id test_auth_authority_edit auth_authority_edit (test acs-authentication) test_auth_authority_edit->auth::authority::get_id test_auth_use_email_for_login_p auth_use_email_for_login_p (test acs-authentication) test_auth_use_email_for_login_p->auth::authority::get_id test_party_procs_test party_procs_test (test acs-tcl) test_party_procs_test->auth::authority::get_id test_person_procs_test person_procs_test (test acs-tcl) test_person_procs_test->auth::authority::get_id acs::test::auth::install acs::test::auth::install (private) acs::test::auth::install->auth::authority::get_id acs::test::user::create acs::test::user::create (public) acs::test::user::create->auth::authority::get_id auth::authority::local auth::authority::local (public) auth::authority::local->auth::authority::get_id auth::get_register_authority auth::get_register_authority (public) auth::get_register_authority->auth::authority::get_id

Testcases:
auth_authority_api, auth_use_email_for_login_p, auth_authority_edit, person_procs_test, party_procs_test

auth::authority::get_sc_impl_columns (public)

 auth::authority::get_sc_impl_columns

Get a list of column names for storing service contract implementation ids of the authority.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_authority__get_sc_impl_columns authority__get_sc_impl_columns (test acs-authentication) auth::authority::get_sc_impl_columns auth::authority::get_sc_impl_columns test_authority__get_sc_impl_columns->auth::authority::get_sc_impl_columns packages/acs-admin/www/auth/authority-parameters.tcl packages/acs-admin/ www/auth/authority-parameters.tcl packages/acs-admin/www/auth/authority-parameters.tcl->auth::authority::get_sc_impl_columns packages/acs-admin/www/auth/authority.tcl packages/acs-admin/ www/auth/authority.tcl packages/acs-admin/www/auth/authority.tcl->auth::authority::get_sc_impl_columns

Testcases:
authority__get_sc_impl_columns

auth::authority::get_short_names (public)

 auth::authority::get_short_names

Return a list of authority short names.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_authority_api auth_authority_api (test acs-authentication) auth::authority::get_short_names auth::authority::get_short_names test_auth_authority_api->auth::authority::get_short_names auth::get_register_authority auth::get_register_authority (public) auth::get_register_authority->auth::authority::get_short_names

Testcases:
auth_authority_api

auth::authority::local (public)

 auth::authority::local

Returns the authority_id of the local authority.

Partial Call Graph (max 5 caller/called nodes):
%3 test_auth_driver_get_parameter_values auth_driver_get_parameter_values (test acs-authentication) auth::authority::local auth::authority::local test_auth_driver_get_parameter_values->auth::authority::local test_auth_password_reset auth_password_reset (test acs-authentication) test_auth_password_reset->auth::authority::local test_auth_use_email_for_login_p auth_use_email_for_login_p (test acs-authentication) test_auth_use_email_for_login_p->auth::authority::local test_sync_actions sync_actions (test acs-authentication) test_sync_actions->auth::authority::local test_sync_batch_for_local sync_batch_for_local (test acs-authentication) test_sync_batch_for_local->auth::authority::local auth::authenticate auth::authenticate (public) auth::authenticate->auth::authority::local auth::create_local_account auth::create_local_account (public) auth::create_local_account->auth::authority::local auth::get_local_account auth::get_local_account (private) auth::get_local_account->auth::authority::local auth::get_register_authority auth::get_register_authority (public) auth::get_register_authority->auth::authority::local auth::local::authentication::Authenticate auth::local::authentication::Authenticate (private) auth::local::authentication::Authenticate->auth::authority::local

Testcases:
auth_password_reset, auth_driver_get_parameter_values, auth_use_email_for_login_p, sync_start_end, sync_actions, sync_snapshot, sync_batch_for_local
[ show source ]