|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Session
A user session.
To get the current session, use Sessions.getCurrent()
,
or Desktop.getSession()
.
A session, Session
, might have multiple pages,
Page
, while a page belongs to exactly one session.
A page, Page
, might have many components, Component
, while
a component belongs to exactly one page.
Method Summary | |
---|---|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the specified custom attribute. |
java.util.Map<java.lang.String,java.lang.Object> |
getAttributes()
Returns a map of custom attributes associated with this session. |
java.lang.String |
getDeviceType()
Returns the device type that this session belongs to. |
java.lang.String |
getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on which the first request was received (and creates this session). |
java.lang.String |
getLocalName()
Returns the host name of the Internet Protocol (IP) interface on which the first request was received (and creates this session). |
int |
getMaxInactiveInterval()
Return the time, in seconds, between client requests before the servlet container will invalidate this session. |
java.lang.Object |
getNativeSession()
Returns the native session, or null if not available. |
java.lang.String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy that sent the first request creating this session. |
java.lang.String |
getRemoteHost()
Returns the fully qualified name of the client or the last proxy that sent the first request creating this session. |
java.lang.String |
getServerName()
Returns the host name of the server to which the first request was sent (and created this session). |
WebApp |
getWebApp()
Returns the Web application that this session belongs to. |
void |
invalidate()
Invalidates this session then unbinds any objects bound to it. |
java.lang.Object |
removeAttribute(java.lang.String name)
Removes the specified custom attribute. |
java.lang.Object |
setAttribute(java.lang.String name,
java.lang.Object value)
Sets the value of the specified custom attribute. |
void |
setMaxInactiveInterval(int interval)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Method Detail |
---|
java.lang.String getDeviceType()
A device type identifies the type of a client. For example, "ajax" represents the Web browsers with Ajax support, while "mil" represents clients that supports Mobile Interactive markup Language (on Limited Connected Device, such as mobile phones).
All desktops of the same session must belong to the same device type.
The session's device type is determined by the first desktop's device type.
java.lang.Object getAttribute(java.lang.String name)
getAttribute
in interface Scope
java.lang.Object setAttribute(java.lang.String name, java.lang.Object value)
setAttribute
in interface Scope
java.lang.Object removeAttribute(java.lang.String name)
removeAttribute
in interface Scope
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
getAttributes
in interface Scope
WebApp getWebApp()
java.lang.String getRemoteHost()
java.lang.String getRemoteAddr()
java.lang.String getServerName()
getLocalName()
java.lang.String getLocalName()
Note: it is the host name defined in the server. To retrieve the name
in URL, use getServerName()
.
getServerName()
java.lang.String getLocalAddr()
void invalidate()
Note: you usually have to ask the client to redirect to another page
(or reload the same page) by use of Executions.sendRedirect(java.lang.String)
.
The session is not invalidated immediately. Rather, it is invalidated after processing the current request.
void setMaxInactiveInterval(int interval)
Configuration.setTimerKeepAlive(boolean)
,
Configuration.setSessionMaxInactiveInterval(int)
int getMaxInactiveInterval()
Configuration.isTimerKeepAlive()
,
Configuration.getSessionMaxInactiveInterval()
java.lang.Object getNativeSession()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |