XQuery Function Documentation

Search and Browse

http://exist-db.org/xquery/session

java:org.exist.xquery.functions.session.SessionModule

A module for dealing with the HTTP session.

session:clear

session:clear() as xs:string

Removes all attributes from the current HTTP session. Does NOT invalidate the session.

Returns:
xs:string

session:create

session:create() as item()

Initialize an HTTP session if not already present

Returns:
item()

session:encode-url

session:encode-url($url as xs:anyURI) as xs:anyURI

Encodes the specified URL with the current HTTP session-id.

Parameters:
$url The URL to encode
Returns:
xs:anyURI : the encoded URL

session:exists

session:exists() as xs:boolean

Returns whether a session object exists.

Returns:
xs:boolean : true if the session object exists

session:get-attribute

session:get-attribute($name as xs:string) as item()*

Returns an attribute stored in the current session object or an empty sequence if the attribute cannot be found.

Parameters:
$name The session attribute name
Returns:
item()* : the attribute value

session:get-attribute-names

session:get-attribute-names() as xs:string*

Returns a sequence containing the names of all session attributes defined within the current HTTP session.

Returns:
xs:string* : the list of attribute names

session:get-creation-time

session:get-creation-time() as xs:dateTime

Returns the time when this session was created. If a session does not exist, a new one is created. If the session is already invalidated, it returns January 1, 1970 GMT

Returns:
xs:dateTime : the date-time when the session was created

session:get-id

session:get-id() as xs:string?

Returns the ID of the current session or an empty sequence if there is no session.

Returns:
xs:string? : the session ID

session:get-last-accessed-time

session:get-last-accessed-time() as xs:dateTime

Returns the last time the client sent a request associated with this session. If a session does not exist, a new one is created. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time. If the session is already invalidated, it returns January 1, 1970 GMT

Returns:
xs:dateTime : the date-time when the session was last accessed

session:get-max-inactive-interval

session:get-max-inactive-interval() as xs:int

Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the session:set-max-inactive-interval function. A negative time indicates the session should never timeout.

Returns:
xs:int : the maximum time interval, in seconds

session:invalidate

session:invalidate() as item()

Invalidate (remove) the current HTTP session if present

Returns:
item()

session:remove-attribute

session:remove-attribute($name as xs:string) as item()

Removes the attribute with the supplied name from the current session

Parameters:
$name The attribute name
Returns:
item()

session:set-attribute

session:set-attribute($name as xs:string, $value as item()*) as item()

Stores a value in the current session using the supplied attribute name. If no session exists, then one will be created.

Parameters:
$name The attribute name
$value* The value to be stored in the session by the attribute name
Returns:
item()

session:set-current-user

session:set-current-user($user-name as xs:string, $password as xs:string) as xs:boolean?

Change the user identity for the current HTTP session. Subsequent XQueries in the session will run with the new user identity.

Parameters:
$user-name The user name
$password The password
Returns:
xs:boolean? : true if the user name and password represent a valid user

session:set-max-inactive-interval

session:set-max-inactive-interval($interval as xs:int) as item()

Sets the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. A negative time indicates the session should never timeout.

Parameters:
$interval The maximum inactive interval (in seconds) before closing the session
Returns:
item()