Session Functions

This module contains functions for accessing and modifying server-side session information. 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 to the http://basex.org/modules/session namespace, which is statically bound to the session prefix.
• If any of the functions is called outside the servlet context, basex:http is raised.
• As sessions are side-effecting operations, all functions are flagged as nondeterministic. As a result, some query optimizations will be suppressed.

Functions

session:id

session:id() as xs:string

import module namespace session = "http://basex.org/modules/session";
'Session ID: ' || session:id()

session:client-id

Added: New function.

session:client-id() as xs:string

session:created

session:created() as xs:dateTime

session:accessed

session:accessed() as xs:dateTime

session:names

session:names() as xs:string*

import module namespace session = "http://basex.org/modules/session";
session:names() ! element variable { . }

session:get

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

import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:get($key)

session:set

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

import module namespace session = "http://basex.org/modules/session";
session:set($key, $value), 'Variable was set.'

session:delete

session:delete(
  $name  as xs:string
) as empty-sequence()

import module namespace session = "http://basex.org/modules/session";
session:delete($key), 'Variable was deleted.'

session:close

session:close() as empty-sequence()

Errors

Changelog

• Added: session:client-id.

• Updated: Only create session if required.

• Updated: session: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.