Sessions Functions

This module can only be called from users with Admin permissions. It contains functions for accessing and modifying all registered server-side sessions. This module is mainly useful in the context of Web Applications.

Conventions

• The module will be available if the basex-api library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war).
• All functions and errors are assigned of the http://basex.org/modules/sessions namespace, which is statically bound to the sessions prefix.
• If any of the functions is called outside the servlet context, basex:http is raised.
• If a specified session id is not found, not-found is raised.
• As sessions are side-effecting operations, all functions are flagged as nondeterministic. As a result, some query optimizations will be suppressed.

Functions

sessions:ids

sessions:ids() as xs:string*

sessions:created

sessions:created(
  $id  as xs:string
) as xs:dateTime

sessions:accessed

sessions:accessed(
  $id  as xs:string
) as xs:dateTime

sessions:names

sessions:names(
  $id  as xs:string
) as xs:string*

sessions:get

sessions:get(
  $id       as xs:string,
  $name     as xs:string,
  $default  as item()*    := ()
) as item()*

sessions:set

sessions:set(
  $id     as xs:string,
  $name   as xs:string,
  $value  as item()*
) as empty-sequence()

sessions:delete

sessions:delete(
  $id    as xs:string,
  $name  as xs:string
) as empty-sequence()

sessions:close

sessions:close(
  $id  as xs:string
) as empty-sequence()

Errors

Changelog

• Updated: sessions:get: Values that have no XQuery type will be returned as strings.

• Updated: error codes updated; errors now use the module namespace

• Updated: Allow sequences as session values.

• Added: New module added.