---

Class ::xo::ProtocolHandler

::xo::ProtocolHandler create ... \
           [ -package package ] \
           [ -url url ]

Class Relations

• class: ::xotcl::Class
• superclass: ::xotcl::Object
• subclass: ::xo::dav

Methods (to be applied on instances)

• get_package_id (scripted, public)

   <instance of xo::ProtocolHandler> get_package_id

  Initialize the given package and return the package_id

  Returns:

  package_id

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

  Testcases:

  No testcase defined.

• handle_request (scripted, public)

   <instance of xo::ProtocolHandler> 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):

  Testcases:

  No testcase defined.

• initialize (scripted, public)

   <instance of xo::ProtocolHandler> initialize

  Setup connection object and authenticate user

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

  Testcases:

  No testcase defined.

• preauth (scripted, public)

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

  Handle authorization. This method is called via ns_filter.

  Parameters:

  args
  

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

  Testcases:

  No testcase defined.

• register (scripted, public)

   <instance of xo::ProtocolHandler> 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):

  Testcases:

  No testcase defined.

• set_user_id (scripted, public)

   <instance of xo::ProtocolHandler> set_user_id

  Set user_id based on authentication header

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

  Testcases:

  No testcase defined.

• unknown (scripted, private)

   <instance of xo::ProtocolHandler> unknown method args \
      [ args... ]

  Return connection information similar to ad_conn

  Parameters:

  method
  args
  

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

  Testcases:

  No testcase defined.

---