Difference between revisions of "Session Module"
Jump to navigation
Jump to search
(25 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | * The {{Code|basex-api}} | + | * The module will be available if the {{Code|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 are assigned to the | + | * All functions and errors are assigned to the <code><nowiki>http://basex.org/modules/session</nowiki></code> namespace, which is statically bound to the {{Code|session}} prefix. |
− | < | + | * If any of the functions is called outside the servlet context, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised. |
− | + | * As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, some query optimizations will be suppressed. | |
− | |||
− | </ | ||
− | |||
− | |||
− | * If any of the functions is called outside the servlet context, | ||
− | * As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. | ||
=Functions= | =Functions= | ||
==session:id== | ==session:id== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 34: | Line 29: | ||
==session:created== | ==session:created== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 44: | Line 40: | ||
==session:accessed== | ==session:accessed== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 54: | Line 51: | ||
==session:names== | ==session:names== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 60: | Line 58: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the names of all | + | |Returns the names of all attributes bound to the current session. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 71: | Line 69: | ||
==session:get== | ==session:get== | ||
+ | |||
+ | {{Mark|Updated with Version 9.3:}} Values that have no XQuery type will be returned as strings. | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|session:get|$ | + | |{{Func|session:get|$name as xs:string|item()*}}<br/>{{Func|session:get|$name as xs:string, $default as item()*|item()*}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the value of a | + | |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. |
− | |||
− | |||
− | |||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 95: | Line 93: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|session:set|$ | + | |{{Func|session:set|$name as xs:string, $value as item()*|empty-sequence()}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Binds the specified | + | |Binds the specified {{Code|$value}} to the session attribute with the specified {{Code|$name}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|set|#Errors}} The supplied value cannot be materialized. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 112: | Line 110: | ||
==session:delete== | ==session:delete== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|session:delete|$ | + | |{{Func|session:delete|$name as xs:string|empty-sequence()}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Deletes a session | + | |Deletes a session attribute with the specified <code>$name</code>. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 129: | Line 128: | ||
==session:close== | ==session:close== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 144: | Line 144: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|set}} |
− | | | + | |The supplied value cannot be materialized. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.3 | ||
+ | |||
+ | * Updated: [[#session:get|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 | ;Version 8.0 | ||
− | * Updated: | + | |
+ | * 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 06:53, 29 November 2019
This XQuery Module contains functions for accessing and modifying server-side session information. This module is mainly useful in the context of Web Applications.
Contents
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 thesession
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. |
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. |
session:accessed
Signatures | session:accessed() as xs:dateTime
|
Summary | Returns the last access time of a session. |
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
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 :
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 | set : The supplied value cannot be materialized.
|
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 |
---|---|
set
|
The supplied value cannot be materialized. |
Changelog
- 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.