Difference between revisions of "Session Module"

From BaseX Documentation
Jump to navigation Jump to search
(47 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
=Conventions=
 
=Conventions=
  
As sessions are side-effecting operations, all functions in this module are flagged as ''non-deterministic''. This means that the evaluation order of the functions will not be influenced by the compiler.
+
* 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 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. Prior to {{Version|9.2}}, the module needed to be imported in the query prolog:
All functions are assigned to the {{Code|http://basex.org/modules/session}} namespace, which must be dynamically imported. In this documentation, the namespace is bound to the {{Code|session}} prefix. Errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.
+
<pre class="brush:xquery">
 +
import module namespace session = "http://basex.org/modules/session";
 +
...
 +
</pre>
 +
* 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.
  
 
=Functions=
 
=Functions=
  
 
==session:id==
 
==session:id==
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
 
|{{Func|session:id||xs:string}}
 
|{{Func|session:id||xs:string}}
 
|-
 
|-
Line 19: Line 25:
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
|Running a RESTXQ function via <code><nowiki>http://localhost:8984/restxq/id</nowiki></code>:
+
|Running the server-side XQuery file {{Code|id.xq}} via <code><nowiki>http://localhost:8984/id.xq</nowiki></code>:
 
<pre class="brush:xquery">
 
<pre class="brush:xquery">
module namespace test = 'http://basex.org/examples/test';
 
 
import module namespace session = "http://basex.org/modules/session";
 
import module namespace session = "http://basex.org/modules/session";
declare %restxq:path("/id") function test:id() {
+
'Session ID: ' || session:id()
  'Session ID: ' || session:id()
 
};
 
 
</pre>
 
</pre>
 
|}
 
|}
  
==session:attribute-names==
+
==session:created==
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|session:attribute-names||xs:string*}}
+
|{{Func|session:created||xs:dateTime}}
 +
|-
 +
| '''Summary'''
 +
|Returns the creation time of a session.
 +
|}
 +
 
 +
==session:accessed==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|session:accessed||xs:dateTime}}
 +
|-
 +
| '''Summary'''
 +
|Returns the last access time of a session.
 +
|}
 +
 
 +
==session:names==
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|session:names||xs:string*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
Line 39: Line 65:
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
|Running the server-side XQuery file {{Code|attributes.xq}} via <code><nowiki>http://localhost:8984/attributes.xq</nowiki></code>:
+
|Running the server-side XQuery file {{Code|names.xq}} via <code><nowiki>http://localhost:8984/names.xq</nowiki></code>:
 
<pre class="brush:xquery">
 
<pre class="brush:xquery">
 
import module namespace session = "http://basex.org/modules/session";
 
import module namespace session = "http://basex.org/modules/session";
session:attributes() ! element attribute { . }
+
session:names() ! element variable { . }
 
</pre>
 
</pre>
 
|}
 
|}
  
==session:attribute==
+
==session:get==
 +
 
 +
{{Mark|Updated with Version 9.3:}} Values that have no XQuery type will be returned as strings.
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|session:attribute|$key as xs:string|xs:string?}}<br/>{{Func|session:attribute|$key as xs:string, $default as xs:string|xs:string}}
+
|{{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 an attribute bound to the current session. If the attribute does not exist, an empty sequence or the optionally specified default value is 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.
|-
 
| '''Errors'''
 
|{{Error|BXSE0002|#Errors}} the value of a session attribute could not be retrieved.
 
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 62: Line 88:
 
<pre class="brush:xquery">
 
<pre class="brush:xquery">
 
import module namespace session = "http://basex.org/modules/session";
 
import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:attribute($key)
+
'Value of ' || $key || ': ' || session:get($key)
 
</pre>
 
</pre>
 
|}
 
|}
  
==session:update-attribute==
+
==session:set==
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|session:update-attribute|$key as xs:string, $value as xs:string|empty-sequence()}}
+
|{{Func|session:set|$name as xs:string, $value as item()*|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Assigns a value to a session attribute.
+
|Binds the specified {{Code|$value}} to the session attribute with the specified {{Code|$name}}.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
|{{Error|BXSE0001|#Errors}} a function item was specified as value of a session attribute.
+
|{{Error|set|#Errors}} The supplied value cannot be materialized.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 82: Line 109:
 
<pre class="brush:xquery">
 
<pre class="brush:xquery">
 
import module namespace session = "http://basex.org/modules/session";
 
import module namespace session = "http://basex.org/modules/session";
session:update-attribute($key, $value), 'Attribute was set.'
+
session:set($key, $value), 'Variable was set.'
 
</pre>
 
</pre>
 
|}
 
|}
  
==session:delete-attribute==
+
==session:delete==
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
|{{Func|session:delete-attribute|$key as xs:string|empty-sequence()}}
+
|{{Func|session:delete|$name as xs:string|empty-sequence()}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Deletes a session attribute.
+
|Deletes a session attribute with the specified <code>$name</code>.
|-
 
| '''Errors'''
 
|{{Error|BXSE0001|#Errors}} a function item was specified as value of a session attribute.
 
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
Line 102: Line 127:
 
<pre class="brush:xquery">
 
<pre class="brush:xquery">
 
import module namespace session = "http://basex.org/modules/session";
 
import module namespace session = "http://basex.org/modules/session";
session:delete-attribute($key), 'Attribute was deleted.'
+
session:delete($key), 'Variable was deleted.'
 
</pre>
 
</pre>
 
|}
 
|}
  
 
==session:close==
 
==session:close==
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signatures'''
+
| width='120' | '''Signatures'''
 
|{{Func|session:close||empty-sequence()}}
 
|{{Func|session:close||empty-sequence()}}
 
|-
 
|-
Line 119: Line 145:
  
 
{| class="wikitable" width="100%"
 
{| class="wikitable" width="100%"
! width="5%"|Code
+
! width="110" |Code
! width="95%"|Description
+
|Description
 
|-
 
|-
|{{Code|BXSE0001}}
+
|{{Code|set}}
|A function item was specified as value of a session attribute.
+
|The supplied value cannot be materialized.
|-
 
|{{Code|BXSE0002}}
 
|An error occurred while retrieving the value of a session attribute.
 
 
|}
 
|}
  
 
=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
 +
 +
* Updated: Allow sequences as session values.
  
 
This module was introduced with Version 7.5.
 
This module was introduced with Version 7.5.
 
[[Category:XQuery]]
 

Revision as of 12:29, 11 July 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.

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. Prior to Version 9.2, the module needed to be imported in the query prolog:
import module namespace session = "http://basex.org/modules/session";
...
  • 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.