Difference between revisions of "Sessions Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 60: Line 60:
  
 
==sessions:get==
 
==sessions:get==
 +
 +
{{Mark|Updated with Version 9.3:}} Values that have no XQuery type will be returned as strings.
  
 
{| width='100%'
 
{| width='100%'
Line 68: Line 70:
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the value of an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead.
 
|Returns the value of an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead.
|-
 
| '''Errors'''
 
|{{Error|get|#Errors}} the value of an attribute could not be retrieved.
 
 
|}
 
|}
  
Line 114: Line 113:
 
! width="110"|Code
 
! width="110"|Code
 
|Description
 
|Description
|-
 
|{{Code|get}}
 
|The stored attribute is no XQuery value.
 
 
|-
 
|-
 
|{{Code|set}}
 
|{{Code|set}}
Line 126: Line 122:
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 9.3
 +
 +
* Updated: [[#sessions:get|sessions:get]]: Values that have no XQuery type will be returned as strings.
  
 
;Version 9.0
 
;Version 9.0

Revision as of 12:29, 11 July 2019

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

  • 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. Prior to Version 9.2, the module needed to be imported in the query prolog:
import module namespace sessions = "http://basex.org/modules/sessions";
...
  • 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 non-deterministic. As a result, some query optimizations will be suppressed.

Functions

sessions:ids

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

sessions:created

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

sessions:accessed

Signatures sessions:accessed($id as xs:string) 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 attributes bound to the session specified by $id.

sessions:get

Template:Mark Values that have no XQuery type will be returned as strings.

Signatures sessions:get($id as xs:string, $name as xs:string) as item()*
sessions:get($id as xs:string, $name as xs:string, $default as item()*) as item()*
Summary Returns 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

Signatures sessions:set($id as xs:string, $name as xs:string, $value as item()*) as empty-sequence()
Summary Returns the specified value to the attribute with the specified $name from the session with the specified $id.
Errors set: The supplied value cannot be materialized.

sessions:delete

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

sessions:close

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

Errors

Code Description
set The supplied value cannot be materialized.
not-found The specified session was not found.

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.

This module was introduced with Version 7.5.