Difference between revisions of "Session Module"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}")
Line 13: Line 13:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:id||xs:string}}
 
|{{Func|session:id||xs:string}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the session ID of a servlet request.
 
|Returns the session ID of a servlet request.
|-
+
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
 
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|{{Error|not-found|#Errors}} No session is available for the current client.
|-
+
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
 
|Running the server-side XQuery file {{Code|id.xq}} via <code><nowiki>http://localhost:8984/id.xq</nowiki></code>:
 
|Running the server-side XQuery file {{Code|id.xq}} via <code><nowiki>http://localhost:8984/id.xq</nowiki></code>:
Line 34: Line 34:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:created||xs:dateTime}}
 
|{{Func|session:created||xs:dateTime}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the creation time of a session.
 
|Returns the creation time of a session.
|-
+
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
 
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|{{Error|not-found|#Errors}} No session is available for the current client.
Line 48: Line 48:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:accessed||xs:dateTime}}
 
|{{Func|session:accessed||xs:dateTime}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the last access time of a session.
 
|Returns the last access time of a session.
|-
+
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
 
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|{{Error|not-found|#Errors}} No session is available for the current client.
Line 62: Line 62:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:names||xs:string*}}
 
|{{Func|session:names||xs:string*}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the names of all attributes bound to the current session.
 
|Returns the names of all attributes bound to the current session.
|-
+
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
 
|Running the server-side XQuery file {{Code|names.xq}} via <code><nowiki>http://localhost:8984/names.xq</nowiki></code>:
 
|Running the server-side XQuery file {{Code|names.xq}} via <code><nowiki>http://localhost:8984/names.xq</nowiki></code>:
Line 80: Line 80:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:get|$name as xs:string|item()*}}<br/>{{Func|session:get|$name as xs:string, $default as item()*|item()*}}
 
|{{Func|session:get|$name as xs:string|item()*}}<br/>{{Func|session:get|$name as xs:string, $default as item()*|item()*}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the value of a session attribute with the specified <code>$name</code>. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead.
 
|Returns the value of a session attribute with the specified <code>$name</code>. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead.
|-
+
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
 
|Running the server-side XQuery file {{Code|get.xq}} via <code><nowiki>http://localhost:8984/get.xq?key=user</nowiki></code>:
 
|Running the server-side XQuery file {{Code|get.xq}} via <code><nowiki>http://localhost:8984/get.xq?key=user</nowiki></code>:
Line 98: Line 98:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:set|$name as xs:string, $value as item()*|empty-sequence()}}
 
|{{Func|session:set|$name as xs:string, $value as item()*|empty-sequence()}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Binds the specified {{Code|$value}} to the session attribute with the specified {{Code|$name}}.
 
|Binds the specified {{Code|$value}} to the session attribute with the specified {{Code|$name}}.
|-
+
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
 
|{{Error|not-found|#Errors}} No session is available for the current client.
 
|{{Error|not-found|#Errors}} No session is available for the current client.
|-
+
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
 
|Running the server-side XQuery file {{Code|set.xq}} via <code><nowiki>http://localhost:8984/set.xq?key=user&value=john</nowiki></code>:
 
|Running the server-side XQuery file {{Code|set.xq}} via <code><nowiki>http://localhost:8984/set.xq?key=user&value=john</nowiki></code>:
Line 119: Line 119:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:delete|$name as xs:string|empty-sequence()}}
 
|{{Func|session:delete|$name as xs:string|empty-sequence()}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Deletes a session attribute with the specified <code>$name</code>.
 
|Deletes a session attribute with the specified <code>$name</code>.
|-
+
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
 
|Running the server-side XQuery file {{Code|delete.xq}} via <code><nowiki>http://localhost:8984/delete.xq?key=user</nowiki></code>:
 
|Running the server-side XQuery file {{Code|delete.xq}} via <code><nowiki>http://localhost:8984/delete.xq?key=user</nowiki></code>:
Line 137: Line 137:
  
 
{| width='100%'
 
{| width='100%'
|-
+
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
 
|{{Func|session:close||empty-sequence()}}
 
|{{Func|session:close||empty-sequence()}}
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Unregisters a session and all data associated with it.
 
|Unregisters a session and all data associated with it.
Line 150: Line 150:
 
! width="110"|Code
 
! width="110"|Code
 
|Description
 
|Description
|-
+
|- valign="top"
 
|{{Code|not-found}}
 
|{{Code|not-found}}
 
|No session is available for the current client.
 
|No session is available for the current client.

Revision as of 13:20, 20 July 2022

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:
import module namespace session = "http://basex.org/modules/session";
'Session ID: ' || session:id()

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:
import module namespace session = "http://basex.org/modules/session";
session:names() ! element variable { . }

session:get

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:
import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:get($key)

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 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:
import module namespace session = "http://basex.org/modules/session";
session:set($key, $value), 'Variable was set.'

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:
import module namespace session = "http://basex.org/modules/session";
session:delete($key), 'Variable was deleted.'

session:close

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

Errors

Code Description
not-found No session is available for the current client.

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.