Differences between revisions 2 and 3
Revision 2 as of 2006-05-08 23:45:19
Size: 2330
Comment: typos
Revision 3 as of 2006-06-09 21:10:19
Size: 2308
Comment: typo
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
||<^>'''cipux_rpc_login''' (user,pass) > cookie session | false||<^>This function allow the login and authentication of the remote user. it create a session and returns the session cookie. ||
||'''cipux_rpc_logout '''(cookie) > true | false||Disconnect the user having session cookie ''cookie'' and return true if it was successfully disconnected||
||'''cipux_rpc_ping''' (cookie) > true | false||Ping the xml rpc server to know if the session with cookie ''cookie'' is still valid. Prevent idle timeout of user session.||
||<^>'''cipux_rpc_login''' (user,pass) > cookie session | false||<^>This function allow the login and authentication of the remote user. It create a session and returns the session cookie. ||
||'''cipux_rpc_logout '''(cookie) > true | false||Disconnect the user's session cookie and returns true if it was successfully disconnected||
||'''cipux_rpc_ping''' (cookie) > true | false||Ping the xml rpc server to know if the session with ''cookie'' is still valid. Prevent idle timeout of user session.||

Cipux XMLRPC Server

It is now possible to access some CipUX functions from another process or even another computer. XML RPC is a remote procedure call norm that allow any process to call functions located on another process. CipUX is using Frontier Perl module to create a stand alone HTTPS server that wait for XML RPC function calls.

The cipux_task_* function are exported with the same parameters and return results as the shell commands.

The user authentication is based on LDAP user account list and some XML RPX specific functions are exported by XML RPC as follow :

Function

Explanation

cipux_rpc_login (user,pass) > cookie session | false

This function allow the login and authentication of the remote user. It create a session and returns the session cookie.

cipux_rpc_logout (cookie) > true | false

Disconnect the user's session cookie and returns true if it was successfully disconnected

cipux_rpc_ping (cookie) > true | false

Ping the xml rpc server to know if the session with cookie is still valid. Prevent idle timeout of user session.

The other functions are based on cipux_task_* shell scripts. The first parameter is always a session cookie. Those functions should returns an error code if something gone wrong

cipux_task_list_users
cipux_task_create_user
cipux_task_enable_user
cipux_task_enable_user_posix_account
cipux_task_change_user_password
cipux_task_delete_user
cipux_task_delete_user_homedir
cipux_task_disable_user
cipux_task_disable_user_posix_account

cipux_task_list_teachers
cipux_task_list_students

cipux_task_add_user_to_course
cipux_task_create_course
cipux_task_disable_course
cipux_task_enable_course
cipux_task_enable_course_posix_account
cipux_task_disable_course_posix_account
cipux_task_change_course_password
cipux_task_delete_course
cipux_task_remove_user_from_course
cipux_task_list_courses

The french project will use this XML RPC server for the Moodle XML RPC user and group management system, let's see (in french) : http://wiki.skolelinux.fr/cgi-bin/skolelinux/moin.cgi/XmlRpc

?Navigation(siblings,1)