org.itsnat.core

Interface ItsNatSession

All Superinterfaces:

ItsNatUserData

All Known Subinterfaces:

ItsNatHttpSession

public interface ItsNatSession
extends ItsNatUserData

Is the ItsNat user session, the session concept is borrowed from the HTTP Java Servlet session concept. In fact ItsNat HTTP implementation is a wrapper over the javax.servlet.http.HttpSession object.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatServletRequest.getItsNatSession(), ClientDocument.getItsNatSession()

Method Summary

Methods

Modifier and Type	Method and Description
ItsNatVariableResolver	createItsNatVariableResolver() Creates a variable resolver bound to this session.
Object	getAttribute(String name) Returns the object bound with the specified name in this session ItsNatHttpSession implementation delegates to HttpSession.getAttribute(String)
Enumeration	getAttributeNames() Returns a String enumeration of names of all the objects bound to this session.
String	getId() Returns the client identity.
ItsNatDocument	getItsNatDocumentById(String id) Returns the "live" ItsNat document with the given id loaded by this session.
int	getItsNatDocumentCount() Returns the number of live ItsNat documents loaded by this session.
ItsNatDocument[]	getItsNatDocuments() Returns all live ItsNat documents loaded by this session.
ItsNatServletContext	getItsNatServletContext() Returns the ItsNat servlet context of this ItsNat application.
void	removeAttribute(String name) Removes the object bound with the specified name from this session.
void	setAttribute(String name, Object value) Binds an object to this session, using the name specified.

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getId

String getId()

Returns the client identity. This value is unique per ItsNatServletContext and never reused in this context.

The identity value is unique no other context-identified object in the same ItsNat servlet context shares the same id.

Although this object is garbage collected, the identity value is never reused by another context-identified object in the same context.

Returns:

the identity value.

getItsNatServletContext

ItsNatServletContext getItsNatServletContext()

Returns the ItsNat servlet context of this ItsNat application.

Returns:

the ItsNat servlet contex.

getItsNatDocumentById

ItsNatDocument getItsNatDocumentById(String id)

Returns the "live" ItsNat document with the given id loaded by this session.

A live document is a document still loaded by the user (not invalid). When a document is unloaded (the user leaves the page) the document is invalid and automatically unregistered.

Parameters:

id - the document id to search for.

Returns:

the document with this id or null if not found.

See Also:

ItsNatDocument.getId(), ItsNatDocument.isInvalid()

getItsNatDocumentCount

int getItsNatDocumentCount()

Returns the number of live ItsNat documents loaded by this session.

Returns:

the number of live documents.

See Also:

getItsNatDocuments()

getItsNatDocuments

ItsNatDocument[] getItsNatDocuments()

Returns all live ItsNat documents loaded by this session.

Returns:

an array containing all live documents in this session.

See Also:

getItsNatDocumentCount(), getItsNatDocumentById(String)

createItsNatVariableResolver

ItsNatVariableResolver createItsNatVariableResolver()

Creates a variable resolver bound to this session.

Returns:

a variable resolver bound to this session.

getAttribute

Object getAttribute(String name)

Returns the object bound with the specified name in this session

ItsNatHttpSession implementation delegates to HttpSession.getAttribute(String)

Parameters:

name - the object name.

Returns:

the object bound with the specified name or null if not found.

getAttributeNames

Enumeration getAttributeNames()

Returns a String enumeration of names of all the objects bound to this session.

ItsNatHttpSession implementation delegates to HttpSession.getAttributeNames()

Returns:

a String enumeration of atribute names.

setAttribute

void setAttribute(String name,
                Object value)

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

ItsNatHttpSession implementation delegates to HttpSession.setAttribute(String,Object)

Parameters:

name - the attribute name.

value - the attribute value.

removeAttribute

void removeAttribute(String name)

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

ItsNatHttpSession implementation delegates to HttpSession.removeAttribute(String)

Parameters:

name - the attribute name to remove.