A RESTful browser for eXist Function Modules

session
http://exist-db.org/xquery/session
A module for dealing with the HTTP session.
clear
session:clear() empty()
Removes all attributes from the current HTTP session. Does NOT invalidate the session.
create
session:create() empty()
Initialize an HTTP session if not already present
encode-url
session:encode-url($url as xs:anyURI) xs:anyURI
Encodes the specified URL with the current HTTP session-id.
$urlThe URL to encode
Returns the encoded URL
exists
session:exists() xs:boolean
Returns whether a session object exists.
Returns true if the session object exists
get-attribute
session:get-attribute($name as xs:string) xs:string*
Returns an attribute stored in the current session object or an empty sequence if the attribute cannot be found.
$nameThe session attribute name
Returns the attribute value
get-attribute-names
session:get-attribute-names() xs:string*
Returns a sequence containing the names of all session attributes defined within the current HTTP session.
Returns the list of attribute names
get-creation-time
session:get-creation-time() 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 the date-time when the session was created
get-id
session:get-id() xs:string?
Returns the ID of the current session or an empty sequence if there is no session.
Returns the session ID
get-last-accessed-time
session:get-last-accessed-time() 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 the date-time when the session was last accessed
get-max-inactive-interval
session:get-max-inactive-interval() 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 the maximum time interval, in seconds
invalidate
session:invalidate() empty()
Invalidate (remove) the current HTTP session if present
remove-attribute
session:remove-attribute($name as xs:string) empty()
Removes the attribute with the supplied name from the current session
$nameThe attribute name
set-attribute
session:set-attribute($name as xs:string, $value as item()*) empty()
Stores a value in the current session using the supplied attribute name. If no session exists, then one will be created.
$nameThe attribute name
$valueThe value to be stored in the session by the attribute name
set-current-user
session:set-current-user($user-name as xs:string, $password as xs:string) xs:boolean?
Change the user identity for the current HTTP session. Subsequent XQueries in the session will run with the new user identity.
$user-nameThe user name
$passwordThe password
Returns true if the user name and password represent a valid user
set-max-inactive-interval
session:set-max-inactive-interval($interval as xs:int) empty()
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.
$intervalThe maximum inactive interval (in seconds) before closing the session
Return to list of all modules