Difference between revisions of "Session Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 19: Line 19:
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the session ID of a servlet request.
 
|Returns the session ID of a servlet request.
 +
|-
 +
| '''Errors'''
 +
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 37: Line 40:
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the creation time of a session.
 
|Returns the creation time of a session.
 +
|-
 +
| '''Errors'''
 +
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|}
 
|}
  
Line 48: Line 54:
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the last access time of a session.
 
|Returns the last access time of a session.
 +
|-
 +
| '''Errors'''
 +
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|}
 
|}
  
Line 99: Line 108:
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|set|#Errors}} The supplied value cannot be materialized.
+
|{{Error|set|#Errors}} The supplied value cannot be materialized.<br/>{{Error|not-found|#Errors}} No session is available for the current client.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 152: Line 161:
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 9.4
 +
* Updated: Only create session if required.
  
 
;Version 9.3
 
;Version 9.3
 
 
* Updated: [[#session:get|session:get]]: Values that have no XQuery type will be returned as strings.
 
* Updated: [[#session:get|session:get]]: Values that have no XQuery type will be returned as strings.
  
 
;Version 9.0
 
;Version 9.0
 
 
* Updated: error codes updated; errors now use the module namespace
 
* Updated: error codes updated; errors now use the module namespace
  
 
;Version 8.0
 
;Version 8.0
 
 
* Updated: Allow sequences as session values.
 
* Updated: Allow sequences as session values.
  
 
This module was introduced with Version 7.5.
 
This module was introduced with Version 7.5.

Revision as of 18:01, 16 June 2020

This XQuery 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 non-deterministic. As a result, some query optimizations will be suppressed.

Functions

session:id

Signatures session:id() as xs:string
Summary Returns the session ID of a servlet request.
Errors not-found: No session is available for the current client.
Examples Running the server-side XQuery file id.xq via http://localhost:8984/id.xq:

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

session:created

Signatures session:created() as xs:dateTime
Summary Returns the creation time of a session.
Errors not-found: No session is available for the current client.

session:accessed

Signatures session:accessed() as xs:dateTime
Summary Returns the last access time of a session.
Errors not-found: No session is available for the current client.

session:names

Signatures session:names() as xs:string*
Summary Returns the names of all attributes bound to the current session.
Examples Running the server-side XQuery file names.xq via http://localhost:8984/names.xq:

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

session:get

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

Signatures session:get($name as xs:string) as item()*
session:get($name as xs:string, $default as item()*) as item()*
Summary Returns the value of a session attribute with the specified $name. If the attribute is unknown, an empty sequence or the optionally specified $default value will be returned instead.
Examples Running the server-side XQuery file get.xq via http://localhost:8984/get.xq?key=user:

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

session:set

Signatures session:set($name as xs:string, $value as item()*) as empty-sequence()
Summary Binds the specified $value to the session attribute with the specified $name.
Errors set: The supplied value cannot be materialized.
not-found: No session is available for the current client.
Examples Running the server-side XQuery file set.xq via http://localhost:8984/set.xq?key=user&value=john:

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

session:delete

Signatures session:delete($name as xs:string) as empty-sequence()
Summary Deletes a session attribute with the specified $name.
Examples Running the server-side XQuery file delete.xq via http://localhost:8984/delete.xq?key=user:

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

session:close

Signatures session:close() as empty-sequence()
Summary Unregisters a session and all data associated with it.

Errors

Code Description
set The supplied value cannot be stored.
not-found The session is not available.

Changelog

Version 9.4
  • Updated: Only create session if required.
Version 9.3
  • Updated: session: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.0
  • Updated: Allow sequences as session values.

This module was introduced with Version 7.5.