|
NextApp Echo2 v2.1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnextapp.echo2.webrender.UserInstance
nextapp.echo2.webcontainer.ContainerInstance
public class ContainerInstance
Web application container user instance.
Field Summary |
---|
Fields inherited from class nextapp.echo2.webrender.UserInstance |
---|
PROPERTY_CLIENT_CONFIGURATION, PROPERTY_SERVER_DELAY_MESSAGE |
Method Summary | |
---|---|
nextapp.echo2.app.ApplicationInstance |
getApplicationInstance()
Returns the corresponding ApplicationInstance
for this user instance. |
int |
getCallbackInterval()
Determines the application-specified asynchronous monitoring service callback interval. |
nextapp.echo2.app.Component |
getComponentByElementId(java.lang.String elementId)
Retrieves the Component with the specified element id. |
static java.lang.String |
getElementId(nextapp.echo2.app.Component component)
Returns the base HTML element id that should be used when rendering the specified Component . |
IdTable |
getIdTable()
Retrieves the IdTable used by this
ContainerInstance to assign weakly-referenced unique
identifiers to arbitrary objects. |
java.util.Map |
getInitialRequestParameterMap()
Returns an immutable Map containing the HTTP form
parameters sent on the initial request to the application. |
RenderState |
getRenderState(nextapp.echo2.app.Component component)
Retrieves the RenderState of the specified
Component . |
nextapp.echo2.app.update.UpdateManager |
getUpdateManager()
Convenience method to retrieve the application's UpdateManager , which is used to synchronize
client and server states. |
void |
init(nextapp.echo2.webrender.Connection conn)
Initializes the ContainerInstance , creating an instance
of the target ApplicationInstance and initializing the state
of the application. |
static void |
newInstance(nextapp.echo2.webrender.Connection conn)
Creates a new Web Application Container instance using the provided client Connection . |
void |
removeRenderState(nextapp.echo2.app.Component component)
Removes the RenderState of the specified
Component . |
void |
sessionDidActivate(javax.servlet.http.HttpSessionEvent e)
|
void |
sessionWillPassivate(javax.servlet.http.HttpSessionEvent e)
|
void |
setRenderState(nextapp.echo2.app.Component component,
RenderState renderState)
Sets the RenderState of the specified
Component . |
void |
setTaskQueueCallbackInterval(nextapp.echo2.app.TaskQueueHandle taskQueue,
int ms)
Sets the interval between asynchronous callbacks from the client to check for queued tasks for a given TaskQueue . |
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent e)
Listener implementation of HttpSessionBindingListener . |
Methods inherited from class nextapp.echo2.webrender.UserInstance |
---|
getCharacterEncoding, getClientConfiguration, getClientProperties, getCurrentTransactionId, getNextTransactionId, getServerDelayMessage, getServiceUri, getServiceUri, getServletUri, getSession, getUserInstanceUpdateManager, setClientConfiguration, setServerDelayMessage, valueBound |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static java.lang.String getElementId(nextapp.echo2.app.Component component)
Component
.
component
- the component
public static void newInstance(nextapp.echo2.webrender.Connection conn)
Connection
. The instance will automatically
be stored in the relevant HttpSession
conn
- the client/server Connection
for which the
instance is being instantiatedpublic nextapp.echo2.app.ApplicationInstance getApplicationInstance()
ApplicationInstance
for this user instance.
ApplicationInstance
public int getCallbackInterval()
public nextapp.echo2.app.Component getComponentByElementId(java.lang.String elementId)
Component
with the specified element id.
elementId
- the element id, e.g., "c_42323"
public IdTable getIdTable()
IdTable
used by this
ContainerInstance
to assign weakly-referenced unique
identifiers to arbitrary objects.
IdTable
public java.util.Map getInitialRequestParameterMap()
Map
containing the HTTP form
parameters sent on the initial request to the application.
public RenderState getRenderState(nextapp.echo2.app.Component component)
RenderState
of the specified
Component
.
component
- the component
public nextapp.echo2.app.update.UpdateManager getUpdateManager()
UpdateManager
, which is used to synchronize
client and server states.
This method is equivalent to invoking
getApplicationInstance().getUpdateManager()
.
UpdateManager
public void init(nextapp.echo2.webrender.Connection conn)
ContainerInstance
, creating an instance
of the target ApplicationInstance
and initializing the state
of the application.
conn
- the relevant Connection
public void removeRenderState(nextapp.echo2.app.Component component)
RenderState
of the specified
Component
.
component
- the componentpublic void setRenderState(nextapp.echo2.app.Component component, RenderState renderState)
RenderState
of the specified
Component
.
component
- the componentrenderState
- the render statepublic void setTaskQueueCallbackInterval(nextapp.echo2.app.TaskQueueHandle taskQueue, int ms)
TaskQueue
. If multiple
TaskQueue
s are active, the smallest specified interval should
be used. The default interval is 500ms.
Application access to this method should be accessed via the
ContainerContext
.
taskQueue
- the TaskQueue
ms
- the number of milliseconds between asynchronous client
callbacksContainerContext.setTaskQueueCallbackInterval(nextapp.echo2.app.TaskQueueHandle, int)
public void sessionDidActivate(javax.servlet.http.HttpSessionEvent e)
sessionDidActivate
in interface javax.servlet.http.HttpSessionActivationListener
sessionDidActivate
in class nextapp.echo2.webrender.UserInstance
HttpSessionActivationListener.sessionDidActivate(javax.servlet.http.HttpSessionEvent)
public void sessionWillPassivate(javax.servlet.http.HttpSessionEvent e)
sessionWillPassivate
in interface javax.servlet.http.HttpSessionActivationListener
sessionWillPassivate
in class nextapp.echo2.webrender.UserInstance
HttpSessionActivationListener.sessionWillPassivate(javax.servlet.http.HttpSessionEvent)
public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent e)
nextapp.echo2.webrender.UserInstance
HttpSessionBindingListener
.
Removes reference to session when invoked.
valueUnbound
in interface javax.servlet.http.HttpSessionBindingListener
valueUnbound
in class nextapp.echo2.webrender.UserInstance
HttpSessionBindingListener.valueUnbound(javax.servlet.http.HttpSessionBindingEvent)
|
NextApp Echo2 v2.1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |