Main Page » XQuery » Functions » Sessions Functions

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

Signature
sessions:ids() as xs:string*
SummaryReturns the IDs of all registered sessions.

sessions:created

Signature
sessions:created(
  $id  as xs:string
) as xs:dateTime
SummaryReturns the creation time of the session specified by $id.

sessions:accessed

Signature
sessions:accessed(
  $id  as xs:string
) as xs:dateTime
SummaryReturns the last access time of the session specified by $id.

sessions:names

Signature
sessions:names(
  $id  as xs:string
) as xs:string*
SummaryReturns the names of all attributes bound to the session specified by $id.

sessions:get

Signature
sessions:get(
  $id       as xs:string,
  $name     as xs:string,
  $default  as item()*    := ()
) as item()*
SummaryReturns the value of an attribute with the specified $name from the session with the specified $id. If the attribute is unknown, an empty sequence or the optionally specified $default value will be returned instead.

sessions:set

Signature
sessions:set(
  $id     as xs:string,
  $name   as xs:string,
  $value  as item()*
) as empty-sequence()
SummaryReturns the specified value to the attribute with the specified $name from the session with the specified $id.

sessions:delete

Signature
sessions:delete(
  $id    as xs:string,
  $name  as xs:string
) as empty-sequence()
SummaryDeletes an attribute with the specified $name from the session with the specified $id.

sessions:close

Signature
sessions:close(
  $id  as xs:string
) as empty-sequence()
SummaryUnregisters the session specified by $id.

Errors

CodeDescription
not-foundThe specified session is not available.

Changelog

Version 9.3
  • Updated: sessions:get: Values that have no XQuery type will be returned as strings.
Version 9.0
  • Updated: error codes updated; errors now use the module namespace
Version 8.4
  • Updated: Allow sequences as session values.
Version 7.5
  • Added: New module added.

⚡Generated with XQuery