Difference between revisions of "Sessions Module"

From BaseX Documentation
Jump to navigation Jump to search
(Created page with "This XQuery Module can only be called from users with ''Admin'' permissions. It contains functions for accessing and modifying all registered server-side sessi...")
 
Line 19: Line 19:
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the IDs of all registered sessions.
 
|Returns the IDs of all registered sessions.
 +
|}
 +
 +
==sessions:created==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|sessions:created||xs:dateTime}}
 +
|-
 +
| '''Summary'''
 +
|Returns the creation time of the session specified by {{Mono|$id}}.
 +
|}
 +
 +
==sessions:accessed==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|sessions:accessed||xs:dateTime}}
 +
|-
 +
| '''Summary'''
 +
|Returns the last access time of the session specified by {{Mono|$id}}.
 
|}
 
|}
  

Revision as of 01:52, 26 September 2012

This XQuery 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

As sessions are side-effecting operations, all functions in this module are flagged as non-deterministic. This means that the evaluation order of the functions will not be influenced by the compiler.

All functions are assigned to the http://basex.org/modules/sessions namespace, which must be dynamically imported. In this documentation, the namespace is bound to the sessions prefix. Errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.

If the module is called outside the servlet context, the error BXSE0003 is raised. If a specified session is not found, BXSE0004 is raised.

Functions

sessions:id

Signatures sessions:ids() as xs:string
Summary Returns the IDs of all registered sessions.

sessions:created

Signatures sessions:created() as xs:dateTime
Summary Returns the creation time of the session specified by $id.

sessions:accessed

Signatures sessions:accessed() as xs:dateTime
Summary Returns the last access time of the session specified by $id.

sessions:names

Signatures sessions:names($id as xs:string) as xs:string*
Summary Returns the names of all variables bound to the session specified by $id.

sessions:get

Signatures sessions:get($id as xs:string, $key as xs:string) as xs:string?
sessions:get($id as xs:string, $key as xs:string, $default as xs:string) as xs:string
Summary Returns the value of a variable bound to the session specified by $id. If the variable does not exist, an empty sequence or the optionally specified default value is returned instead.
Errors BXSE0002: the value of a session variable could not be retrieved.

sessions:set

Signatures sessions:set($id as xs:string, $key as xs:string, $value as xs:string) as empty-sequence()
Summary Assigns a value to a variable bound to the session specified by $id.
Errors BXSE0001: a function item was specified as value of a session variable.

sessions:delete

Signatures sessions:delete($id as xs:string, $key as xs:string) as empty-sequence()
Summary Deletes a variable bound to the session specified by $id.

sessions:close

Signatures sessions:close($id as xs:string) as empty-sequence()
Summary Unregisters the session specified by $id.

Errors

Code Description
BXSE0001 A function item was specified as value of a session attribute.
BXSE0002 An error occurred while retrieving the value of a session attribute.
BXSE0003 A function was called outside the servlet context.
BXSE0004 The specified session was not found.

Changelog

This module was introduced with Version 7.5.