Class ::xo::ProtocolHandler

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

Defined in

Class Relations

  • class: ::xotcl::Class[i]
  • superclass: ::xotcl::Object[i]
  • subclass: ::xo::dav[i]

Methods (to be applied on instances)

  • GET (scripted)

  • OPTIONS (scripted)

  • PROPFIND (scripted)

  • PUT (scripted)

  • get_package_id (scripted, public)

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

    Initialize the given package and return the package_id

    Returns:
    package_id

    Testcases:
    No testcase defined.
  • handle_request (scripted, 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 (required)

    Testcases:
    No testcase defined.
  • http_date (scripted)

  • initialize (scripted, public)

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

    Setup connection object and authenticate user

    Testcases:
    No testcase defined.
  • log (scripted)

  • multiStatus (scripted)

  • multiStatusError (scripted)

  • multiStatusResponse (scripted)

  • package (setter)

  • preauth (scripted, public)

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

    Handle authorization. This method is called via ns_filter.

    Parameters:
    args (required)

    Testcases:
    No testcase defined.
  • register (scripted, 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).

    Testcases:
    No testcase defined.
  • set_user_id (scripted, public)

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

    Set user_id based on authentication header

    Testcases:
    No testcase defined.
  • tcl_time_to_http_date (scripted)

  • tcl_time_to_iso8601 (scripted)

  • unknown (scripted, private)

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

    Return connection information similar to ad_conn

    Parameters:
    method (required)
    args (required)

    Testcases:
    No testcase defined.
  • url (setter)