Class ::xo::ConnectionContext

::xo::ConnectionContext[i] create ... \
           [ -mobile mobile ] \
           [ -requester requester ] \
           [ -url url ] \
           [ -user user ] \
           [ -user_id user_id ]

Class Relations

  • class: ::xotcl::Class[i]
  • superclass: ::xo::Context[i]

Methods (to be applied on the object)

  • require (scripted)

     xo::ConnectionContext[i] require

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_test_xo_cc test_xo_cc (test ) xo::ConnectionContext proc require xo::ConnectionContext proc require test_test_xo_cc->xo::ConnectionContext proc require test_xotcl-core xotcl-core (test ) test_xotcl-core->xo::ConnectionContext proc require ad_conn ad_conn (public) xo::ConnectionContext proc require->ad_conn ad_log ad_log (public) xo::ConnectionContext proc require->ad_log ad_try ad_try (public) xo::ConnectionContext proc require->ad_try ds_database_enabled_p ds_database_enabled_p (public) xo::ConnectionContext proc require->ds_database_enabled_p lang::conn::locale lang::conn::locale (public) xo::ConnectionContext proc require->lang::conn::locale

    Testcases:
    test_xo_cc, xotcl-core

Methods (to be applied on instances)

  • eval_as_user (scripted, public)

     <instance of xo::ConnectionContext[i]> eval_as_user \
        [ -user_id user_id ] cmd

    Run a command as the specified different user. Essentially, this method updates xo::cc and the ad_conn array array with the specified user, runs the command and resets the user to the previous value.

    Switches:
    -user_id
    (optional)
    switch temporarily to this user
    Parameters:
    cmd - command to be exevuted

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test xowf) xo::ConnectionContext instproc eval_as_user xo::ConnectionContext instproc eval_as_user test_create_test_items->xo::ConnectionContext instproc eval_as_user

    Testcases:
    create_test_items
  • form_parameter (scripted)

     <instance of xo::ConnectionContext[i]> form_parameter

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test ) xo::ConnectionContext instproc form_parameter xo::ConnectionContext instproc form_parameter test_create_workflow_with_instance->xo::ConnectionContext instproc form_parameter test_xowf xowf (test ) test_xowf->xo::ConnectionContext instproc form_parameter test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->xo::ConnectionContext instproc form_parameter xo::validate_parameter_constraints xo::validate_parameter_constraints (public) xo::ConnectionContext instproc form_parameter->xo::validate_parameter_constraints

    Testcases:
    create_workflow_with_instance, xowf, xowiki_test_cases
  • get_all_form_parameter (scripted)

     <instance of xo::ConnectionContext[i]> get_all_form_parameter

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xo::ConnectionContext instproc get_all_form_parameter xo::ConnectionContext instproc get_all_form_parameter test_create_form_with_form_instance->xo::ConnectionContext instproc get_all_form_parameter test_xowiki xowiki (test ) test_xowiki->xo::ConnectionContext instproc get_all_form_parameter test_xowiki_test_cases xowiki_test_cases (test ) test_xowiki_test_cases->xo::ConnectionContext instproc get_all_form_parameter

    Testcases:
    xowiki_test_cases, xowiki, create_form_with_form_instance
  • get_parameter (scripted)

     <instance of xo::ConnectionContext[i]> get_parameter

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_link_tests link_tests (test xowiki) xo::ConnectionContext instproc get_parameter xo::ConnectionContext instproc get_parameter test_link_tests->xo::ConnectionContext instproc get_parameter test_xowiki xowiki (test ) test_xowiki->xo::ConnectionContext instproc get_parameter test_xowiki_test_cases xowiki_test_cases (test ) test_xowiki_test_cases->xo::ConnectionContext instproc get_parameter

    Testcases:
    xowiki_test_cases, xowiki, link_tests
  • mobile (setter)

     <instance of xo::ConnectionContext[i]> mobile

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test ) xo::ConnectionContext instproc mobile xo::ConnectionContext instproc mobile test_create_workflow_with_instance->xo::ConnectionContext instproc mobile test_xowf xowf (test ) test_xowf->xo::ConnectionContext instproc mobile

    Testcases:
    create_workflow_with_instance, xowf
  • permission (scripted, public)

     <instance of xo::ConnectionContext[i]> permission \
        [ -object_id object_id ] -privilege privilege  \
        [ -party_id party_id ]

    Call ::permission::permission_p but avoid multiple calls in the same request through caching in the connection context

    Switches:
    -object_id
    (optional)
    -privilege
    (required)
    -party_id
    (optional)

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki_test_cases xowiki_test_cases (test xowiki) xo::ConnectionContext instproc permission xo::ConnectionContext instproc permission test_xowiki_test_cases->xo::ConnectionContext instproc permission permission::permission_p permission::permission_p (public) xo::ConnectionContext instproc permission->permission::permission_p

    Testcases:
    xowiki_test_cases
  • query_parameter (scripted, public)

     <instance of xo::ConnectionContext[i]> query_parameter __spec \
        [ default ]

    Get query parameter with default and optional value constraints. In case the value check for the query parameter fails, and no further precautions are performed (::aa_test_noabort is set), the method raises an exception with "ad_return_complaint" and aborts the script.

    Parameters:
    __spec - has the formname or name:value_constraint
    default (optional) - default value
    Returns:
    actual value of the query parameter

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_api__context api__context (test xotcl-core) xo::ConnectionContext instproc query_parameter xo::ConnectionContext instproc query_parameter test_api__context->xo::ConnectionContext instproc query_parameter test_path_resolve path_resolve (test xowiki) test_path_resolve->xo::ConnectionContext instproc query_parameter test_test_xo_cc test_xo_cc (test xotcl-core) test_test_xo_cc->xo::ConnectionContext instproc query_parameter xo::validate_parameter_constraints xo::validate_parameter_constraints (public) xo::ConnectionContext instproc query_parameter->xo::validate_parameter_constraints

    Testcases:
    api__context, test_xo_cc, path_resolve
  • returnredirect (scripted)

     <instance of xo::ConnectionContext[i]> returnredirect

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_xowiki xowiki (test ) xo::ConnectionContext instproc returnredirect xo::ConnectionContext instproc returnredirect test_xowiki->xo::ConnectionContext instproc returnredirect test_xowiki_test_cases xowiki_test_cases (test ) test_xowiki_test_cases->xo::ConnectionContext instproc returnredirect

    Testcases:
    xowiki_test_cases, xowiki
  • set_parameter (scripted)

     <instance of xo::ConnectionContext[i]> set_parameter

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test ) xo::ConnectionContext instproc set_parameter xo::ConnectionContext instproc set_parameter test_create_workflow_with_instance->xo::ConnectionContext instproc set_parameter test_xowf xowf (test ) test_xowf->xo::ConnectionContext instproc set_parameter

    Testcases:
    create_workflow_with_instance, xowf
  • url (setter)

     <instance of xo::ConnectionContext[i]> url

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_workflow_with_instance create_workflow_with_instance (test ) xo::ConnectionContext instproc url xo::ConnectionContext instproc url test_create_workflow_with_instance->xo::ConnectionContext instproc url test_xowf xowf (test ) test_xowf->xo::ConnectionContext instproc url test_xowiki_test_cases xowiki_test_cases (test xowiki) test_xowiki_test_cases->xo::ConnectionContext instproc url

    Testcases:
    create_workflow_with_instance, xowf, xowiki_test_cases
  • user_id (setter)

     <instance of xo::ConnectionContext[i]> user_id

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_form_with_form_instance create_form_with_form_instance (test xowiki) xo::ConnectionContext instproc user_id xo::ConnectionContext instproc user_id test_create_form_with_form_instance->xo::ConnectionContext instproc user_id test_create_workflow_with_instance create_workflow_with_instance (test xowf) test_create_workflow_with_instance->xo::ConnectionContext instproc user_id test_link_tests link_tests (test xowiki) test_link_tests->xo::ConnectionContext instproc user_id test_package_normalize_path package_normalize_path (test xowiki) test_package_normalize_path->xo::ConnectionContext instproc user_id test_path_resolve path_resolve (test xowiki) test_path_resolve->xo::ConnectionContext instproc user_id

    Testcases:
    xotcl_core_tutorial_2, xotcl-core, create_workflow_with_instance, package_normalize_path, xowiki_test_cases, link_tests, slot_interactions, path_resolve, create_form_with_form_instance