|
|
Package com.dassault_systemes.catjsystem |
Class CATSession
|
Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.catjsystem.CATSession
Class Location |
Class Description |
public class CATSession
An object that represents a client session.
A session is established at the first interaction between a Web client and a Web application hosted on a server. A session lasts until it gets terminated either by the client itself, or because the timeout has been reached. The timeout value is the one set on the server by the administrator.
Volatile properties may be stored in a session instance during a single client/server interaction. Such interaction is most of the time triggered by an event that occurred on the client side through the user interface, such as for example a click on a button or a tree expansion.
All Implemented Interfaces: Serializable
Field Summary |
Constructor Summary |
Method Summary |
String | getLocale() |
CATMessageCatalog | getMessageCatalog() |
Enumeration | getVolatileProperties() |
Object | removeVolatileProperty(String iName) |
void | setVolatileProperty(String iName, Object iValue) |
Object | getVolatileProperty(String iName) |
CATEnvironment | getEnv() |
CATSession | getCurrentSession() |
Field Detail |
Constructor Detail |
Method Detail |
String getLocale()Returns the client locale.
CATMessageCatalog getMessageCatalog()Returns the message catalog associated with the current client locale.
Enumeration getVolatileProperties()Returns an enumeration of all the volatile properties name (see class documentation for details on this topic).
Object removeVolatileProperty(String iName)Removes a previously stored volatile property and returns its value, or returns null if the specified property doesn't exist (see class documentation for details on this topic).
iName
void setVolatileProperty(String iName, Object iValue)Sets a volatile property, i.e. a property that will be stored only during the client request lifetime.
This property is removed from the session when the request ends (see class documentation for details on this topic).
iName
iValue
Object getVolatileProperty(String iName)Returns a volatile property, i.e. a property that has been stored during a given request lifetime.
This property is removed from the session when the request ends (see class documentation for details on this topic).
iName
CATEnvironment getEnv()Returns the environment associated with the current instance.
CATSession getCurrentSession()Returns the current CATSession instance based on the current thread.