public abstract class ClientReqSession
extends java.lang.Object
implements javax.servlet.http.HttpSession
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SESSION_IS_DESIGNER
true if the session belongs to a designer. |
static java.lang.String |
SESSION_MEM_USED |
static java.lang.String |
SESSION_PROJECT
The id (a Long) of the project that this session has loaded
|
static java.lang.String |
SESSION_PROJECT_NAME
The name (a String) of the project that this session has loaded
|
static java.lang.String |
SESSION_PROJECT_VERSION
If the session is a client, this is the
ProjectVersion that the client is running. |
static java.lang.String |
SESSION_REMOTE_ADDR
This is the address of the client, a String, as returned by
ServletRequest.getRemoteAddr() |
static java.lang.String |
SESSION_REMOTE_HOST
This holds the self-reported "hostname" (a String) that the client sent when it first logged in.
|
static java.lang.String |
SESSION_TIMEZONE
Holds the
TimeZone that the client JVM is in |
static java.lang.String |
SESSION_USER
The
User the session belongs to. |
static java.lang.String |
SESSION_USERNAME
The username (String) of the
User the session belongs to. |
Constructor and Description |
---|
ClientReqSession() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addNotification(java.lang.String moduleId,
java.lang.String messageType,
java.io.Serializable message)
Adds a notification message that will be sent down to this session's client and delivered as a PushNotification.
|
static boolean |
exists()
Checks if the
Session threadlocal is set in this thread |
static ClientReqSession |
get()
Get the session for the calling thread.
|
abstract java.util.Locale |
getLocale() |
abstract java.lang.String |
getPublicId()
Returns a unique but irreversible hash of the true id
|
abstract int |
getScope()
Returns this client's ApplicationScope, either Client or Designer
|
boolean |
isDesigner() |
protected static void |
set(ClientReqSession session)
Sets session for calling thread.
|
abstract void |
setMessageFilter(java.lang.String name,
MessageFilter filter)
Sets a named filter on this session.
|
protected static void |
unset()
Clears the session for calling thread.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAttribute, getAttributeNames, getCreationTime, getId, getLastAccessedTime, getMaxInactiveInterval, getServletContext, getSessionContext, getValue, getValueNames, invalidate, isNew, putValue, removeAttribute, removeValue, setAttribute, setMaxInactiveInterval
public static final java.lang.String SESSION_IS_DESIGNER
true
if the session belongs to a designer.public static final java.lang.String SESSION_USERNAME
User
the session belongs to.public static final java.lang.String SESSION_USER
User
the session belongs to.public static final java.lang.String SESSION_PROJECT
public static final java.lang.String SESSION_PROJECT_NAME
public static final java.lang.String SESSION_PROJECT_VERSION
ProjectVersion
that the client is running.public static final java.lang.String SESSION_REMOTE_ADDR
ServletRequest.getRemoteAddr()
public static final java.lang.String SESSION_MEM_USED
public static final java.lang.String SESSION_REMOTE_HOST
InetAddress.getLocalHost().getHostName()returns from the client JVM.
public static final java.lang.String SESSION_TIMEZONE
TimeZone
that the client JVM is inpublic abstract java.util.Locale getLocale()
public abstract void addNotification(java.lang.String moduleId, java.lang.String messageType, java.io.Serializable message)
public boolean isDesigner()
public abstract int getScope()
ApplicationScope
public static boolean exists()
Session
threadlocal is set in this threadSession.get()
can return the instance of session, false otherwisepublic static ClientReqSession get()
public abstract java.lang.String getPublicId()
protected static void set(ClientReqSession session)
session
- The sessionprotected static void unset()
public abstract void setMessageFilter(java.lang.String name, MessageFilter filter)