• Publicity: Public Only All

50-protocol-handler-procs.tcl

Protocol handles, mostly for defining extra HTTP methods.

Location:
packages/xotcl-core/tcl/50-protocol-handler-procs.tcl
Author:
Gustaf Neumann <neumann@wu-wien.ac.at>

Procedures in this file

Detailed information

xo::ProtocolHandler instproc get_package_id (public)

 <instance of xo::ProtocolHandler[i]> get_package_id

Initialize the given package and return the package_id

Returns:
package_id

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

xo::ProtocolHandler instproc handle_request (public)

 <instance of xo::ProtocolHandler[i]> handle_request args \
    [ args... ]

Process the incoming HTTP request. This method could be overloaded by the application and dispatches the HTTP requests.

Parameters:
args

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

xo::ProtocolHandler instproc initialize (public)

 <instance of xo::ProtocolHandler[i]> initialize

Setup connection object and authenticate user

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) xo::ProtocolHandler instproc initialize xo::ProtocolHandler instproc initialize xo::ProtocolHandler instproc initialize->ad_conn

Testcases:
No testcase defined.

xo::ProtocolHandler instproc preauth (public)

 <instance of xo::ProtocolHandler[i]> preauth args [ args... ]

Handle authorization. This method is called via ns_filter.

Parameters:
args

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) security::RestrictLoginToSSLP security::RestrictLoginToSSLP (public) security::secure_conn_p security::secure_conn_p (public) xo::ProtocolHandler instproc preauth xo::ProtocolHandler instproc preauth xo::ProtocolHandler instproc preauth->ad_conn xo::ProtocolHandler instproc preauth->security::RestrictLoginToSSLP xo::ProtocolHandler instproc preauth->security::secure_conn_p

Testcases:
No testcase defined.

xo::ProtocolHandler instproc register (public)

 <instance of xo::ProtocolHandler[i]> register

Register the NaviServer/AOLserver filter and traces. This method is typically called via *-init.tcl. Note that the specified url must not have an entry in the site-nodes, otherwise the OpenACS request processor performs always the cockie-based authorization. To change that, it would be necessary to register the filter before the request processor (currently, there are no hooks for that).

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

xo::ProtocolHandler instproc set_user_id (public)

 <instance of xo::ProtocolHandler[i]> set_user_id

Set user_id based on authentication header

Partial Call Graph (max 5 caller/called nodes):
%3 ad_conn ad_conn (public) auth::authenticate auth::authenticate (public) auth::get_register_authority auth::get_register_authority (public) http_auth::basic_authentication_decode http_auth::basic_authentication_decode (public) xo::ProtocolHandler instproc set_user_id xo::ProtocolHandler instproc set_user_id xo::ProtocolHandler instproc set_user_id->ad_conn xo::ProtocolHandler instproc set_user_id->auth::authenticate xo::ProtocolHandler instproc set_user_id->auth::get_register_authority xo::ProtocolHandler instproc set_user_id->http_auth::basic_authentication_decode

Testcases:
No testcase defined.
[ show source ]