Difference between revisions of "Session Module"
Jump to navigation
Jump to search
m (Text replace - "| width='90' | '''Signatures'''" to "| width='120' | '''Signatures'''") |
|||
Line 19: | Line 19: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:id||xs:string}} | |{{Func|session:id||xs:string}} | ||
|- | |- | ||
Line 36: | Line 36: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:created||xs:dateTime}} | |{{Func|session:created||xs:dateTime}} | ||
|- | |- | ||
Line 46: | Line 46: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:accessed||xs:dateTime}} | |{{Func|session:accessed||xs:dateTime}} | ||
|- | |- | ||
Line 56: | Line 56: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:names||xs:string*}} | |{{Func|session:names||xs:string*}} | ||
|- | |- | ||
Line 73: | Line 73: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:get|$key as xs:string|xs:string?}}<br/>{{Func|session:get|$key as xs:string, $default as xs:string|xs:string}} | |{{Func|session:get|$key as xs:string|xs:string?}}<br/>{{Func|session:get|$key as xs:string, $default as xs:string|xs:string}} | ||
|- | |- | ||
Line 93: | Line 93: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:set|$key as xs:string, $value as xs:string|empty-sequence()}} | |{{Func|session:set|$key as xs:string, $value as xs:string|empty-sequence()}} | ||
|- | |- | ||
Line 113: | Line 113: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:delete|$key as xs:string|empty-sequence()}} | |{{Func|session:delete|$key as xs:string|empty-sequence()}} | ||
|- | |- | ||
Line 130: | Line 130: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Func|session:close||empty-sequence()}} | |{{Func|session:close||empty-sequence()}} | ||
|- | |- |
Revision as of 11:37, 14 June 2013
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
basex-api
package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX. - All functions are assigned to the
http://basex.org/modules/session
namespace. The module must be imported in the query prolog:
import module namespace session = "http://basex.org/modules/session"; ...
- In this documentation, the namespace is bound to the
session
prefix. - Errors are assigned to the
http://basex.org/errors
namespace, which is statically bound to thebxerr
prefix. - If any of the functions is called outside the servlet context, the error
BXSE0003
: is raised. - As sessions are side-effecting operations, all functions are flagged as non-deterministic. This means that the functions will not be reordered by the compiler.
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 variables 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($key as xs:string) as xs:string? session:get($key as xs:string, $default as xs:string) as xs:string
|
Summary | Returns the value of a variable bound to the current session. If the variable does not exist, an empty sequence or the optionally specified default value is returned instead. |
Errors | BXSE0002 : the value of a session variable could not be retrieved.
|
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($key as xs:string, $value as xs:string) as empty-sequence()
|
Summary | Assigns a value to a session variable. |
Errors | BXSE0001 : a function item was specified as value of a session variable.
|
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($key as xs:string) as empty-sequence()
|
Summary | Deletes a session variable. |
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 |
---|---|
BXSE0001
|
A function item was specified as value of a session attribute. |
BXSE0002
|
An error occurred while retrieving the value of a session attribute. |
BXSE0003
|
A function was called outside the servlet context. |
Changelog
This module was introduced with Version 7.5.