• Publicity: Public Only All

sync-procs.tcl

API for managing synchronization of user data.

Location:
packages/acs-authentication/tcl/sync-procs.tcl
Created:
2003-09-05
Author:
Lars Pind <lars@collaboraid.biz>
CVS Identification:
$Id: sync-procs.tcl,v 1.44.2.7 2024/08/20 08:58:02 gustafn Exp $

Procedures in this file

Detailed information

auth::sync::job::action (public)

 auth::sync::job::action -job_id job_id -operation operation \
    -username username [ -array array ]

Inserts/updates/deletes a user, depending on the operation.

Switches:
-job_id (required)
The job which this is part of for logging purposes.
-operation (required)
'insert', 'update', 'delete', or 'snapshot'.
-username (required)
The username which this action refers to.
-array (optional)
Name of an array containing the relevant registration elements. Not required if this is a delete operation.
Returns:
entry_id of newly created entry

Testcases:
sync_actions, sync_snapshot

auth::sync::job::create_entry (public)

 auth::sync::job::create_entry -job_id job_id -operation operation \
    -username username [ -user_id user_id ] [ -success ] \
    [ -message message ] [ -element_messages element_messages ]

Record a batch job entry.

Switches:
-job_id (required)
The ID of the batch job you're ending.
-operation (required)
One of 'insert', 'update', or 'delete'.
-username (required)
The username of the user being inserted/updated/deleted.
-user_id (optional)
The user_id of the local user account, if known.
-success (optional, boolean)
Whether or not the operation went well.
-message (optional)
Any error message to stick into the log.
-element_messages (optional)
Returns:
entry_id

Testcases:
sync_start_end, auth_sync_process_ims_implementations

auth::sync::job::end (public)

 auth::sync::job::end -job_id job_id [ -message message ]

Record the end of a batch job. Closes out the transaction log and sends out notifications.

Switches:
-job_id (required)
The ID of the batch job you're ending.
-message (optional)
Returns:
array list with result of auth::sync::job::get.
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Testcases:
sync_start_end, sync_actions, sync_snapshot

auth::sync::job::end_get_document (public)

 auth::sync::job::end_get_document -job_id job_id \
    -doc_status doc_status [ -doc_message doc_message ] \
    [ -document document ] [ -snapshot ]

Record the time that we've finished getting the document, and record the status.

Switches:
-job_id (required)
The ID of the batch job you're ending.
-doc_status (required)
-doc_message (optional)
-document (optional)
-snapshot (optional, boolean)
Set this if this is a snapshot job, as opposed to an incremental ('event driven') job.

Testcases:
sync_start_end

auth::sync::job::get (public)

 auth::sync::job::get -job_id job_id -array array

Get information about a batch job in an array.

Switches:
-job_id (required)
The ID of the batch job you're ending.
-array (required)
Name of an array into which you want the information.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
sync_batch_for_local, sync_batch_ims_example_doc, sync_batch_ims_test

auth::sync::job::get_authority_id (public)

 auth::sync::job::get_authority_id -job_id job_id

Get the authority_id from a job_id. Cached.

Switches:
-job_id (required)
The ID of the batch job you're ending.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
sync_start_end

auth::sync::job::get_entries (public)

 auth::sync::job::get_entries -job_id job_id

Get a list of entry_ids of the job log entries, ordered by entry_time.

Switches:
-job_id (required)
The ID of the batch job you're ending.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
sync_batch_ims_example_doc, sync_batch_ims_test

auth::sync::job::get_entry (public)

 auth::sync::job::get_entry -entry_id entry_id -array array

Get information about a log entry

Switches:
-entry_id (required)
-array (required)

Testcases:
sync_actions, sync_snapshot, sync_batch_ims_example_doc, sync_batch_ims_test

auth::sync::job::snapshot_delete_remaining (public)

 auth::sync::job::snapshot_delete_remaining -job_id job_id

Deletes the users that weren't included in the snapshot.

Switches:
-job_id (required)

Testcases:
sync_snapshot

auth::sync::job::start (public)

 auth::sync::job::start [ -job_id job_id ] -authority_id authority_id \
    [ -interactive ] [ -creation_user creation_user ]

Record the beginning of a job.

Switches:
-job_id (optional)
-authority_id (required)
The ID of the authority you're trying to sync
-interactive (optional, boolean)
Set this if this is an interactive job, i.e. it's initiated by a user.
-creation_user (optional)
Returns:
job_id An ID for the new batch job. Used when calling other procs in this API.
Author:
Lars Pind <lars@collaboraid.biz>

Testcases:
sync_start_end, sync_actions, sync_snapshot, auth_sync_process_ims_implementations

auth::sync::job::start_get_document (public)

 auth::sync::job::start_get_document -job_id job_id

Record the time that we're starting to get the document.

Switches:
-job_id (required)
The ID of the batch job you're ending.

Testcases:
sync_start_end

auth::sync::purge_jobs (public)

 auth::sync::purge_jobs [ -num_days num_days ]

Purge jobs that are older than KeepBatchLogDays days.

Switches:
-num_days (optional)

Testcases:
sync_start_end
[ show source ]