Difference between revisions of "Sessions Module"
Jump to navigation
Jump to search
m (Text replacement - "\[\[#([^]:]+:[^|]+)\|([^]:]+:[^|]+)\]\]" to "{{Function||$1}}") |
|||
Line 14: | Line 14: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:ids||xs:string*}} | |{{Func|sessions:ids||xs:string*}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the IDs of all registered sessions. | |Returns the IDs of all registered sessions. | ||
Line 25: | Line 25: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:created|$id as xs:string|xs:dateTime}} | |{{Func|sessions:created|$id as xs:string|xs:dateTime}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the creation time of the session specified by {{Mono|$id}}. | |Returns the creation time of the session specified by {{Mono|$id}}. | ||
Line 36: | Line 36: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:accessed|$id as xs:string|xs:dateTime}} | |{{Func|sessions:accessed|$id as xs:string|xs:dateTime}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the last access time of the session specified by {{Mono|$id}}. | |Returns the last access time of the session specified by {{Mono|$id}}. | ||
Line 47: | Line 47: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:names|$id as xs:string|xs:string*}} | |{{Func|sessions:names|$id as xs:string|xs:string*}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the names of all attributes bound to the session specified by {{Mono|$id}}. | |Returns the names of all attributes bound to the session specified by {{Mono|$id}}. | ||
Line 58: | Line 58: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:get|$id as xs:string, $name as xs:string|item()*}}<br/>{{Func|sessions:get|$id as xs:string, $name as xs:string, $default as item()*|item()*}} | |{{Func|sessions:get|$id as xs:string, $name as xs:string|item()*}}<br/>{{Func|sessions:get|$id as xs:string, $name as xs:string, $default as item()*|item()*}} | ||
− | |- | + | |- valign="top" |
| '''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. | ||
Line 69: | Line 69: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:set|$id as xs:string, $name as xs:string, $value as item()*|empty-sequence()}} | |{{Func|sessions:set|$id as xs:string, $name as xs:string, $value as item()*|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns the specified {{Code|value}} to the attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. | |Returns the specified {{Code|value}} to the attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. | ||
Line 80: | Line 80: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:delete|$id as xs:string, $name as xs:string|empty-sequence()}} | |{{Func|sessions:delete|$id as xs:string, $name as xs:string|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Deletes an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. | |Deletes an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. | ||
Line 91: | Line 91: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|sessions:close|$id as xs:string|empty-sequence()}} | |{{Func|sessions:close|$id as xs:string|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Unregisters the session specified by {{Mono|$id}}. | |Unregisters the session specified by {{Mono|$id}}. | ||
Line 104: | Line 104: | ||
! width="110"|Code | ! width="110"|Code | ||
|Description | |Description | ||
− | |- | + | |- valign="top" |
|{{Code|not-found}} | |{{Code|not-found}} | ||
|The specified session is not available. | |The specified session is not available. |
Revision as of 14:20, 20 July 2022
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.
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 of the
http://basex.org/modules/sessions
namespace, which is statically bound to thesessions
prefix. - 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
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 .
|
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 |
---|---|
not-found
|
The specified session is not available. |
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.