|
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
public abstract class UserInstance
An abstract base class representing a single user-instance of an application hosted in an application container.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_CLIENT_CONFIGURATION
|
static java.lang.String |
PROPERTY_SERVER_DELAY_MESSAGE
|
Constructor Summary | |
---|---|
UserInstance(Connection conn)
Creates a new UserInstance . |
Method Summary | |
---|---|
java.lang.String |
getCharacterEncoding()
Returns the default character encoding in which responses should be rendered. |
ClientConfiguration |
getClientConfiguration()
the ServerDelayMessage displayed during
client/server-interactions. |
ClientProperties |
getClientProperties()
Retrieves the ClientProperties object providing
information about the client of this instance. |
long |
getCurrentTransactionId()
Returns the current transaction id. |
long |
getNextTransactionId()
Increments the current transaction id and returns it. |
ServerDelayMessage |
getServerDelayMessage()
Retrieves the ServerDelayMessage displayed during
client/server-interactions. |
java.lang.String |
getServiceUri(Service service)
Determines the URI to invoke the specified Service . |
java.lang.String |
getServiceUri(Service service,
java.lang.String[] parameterNames,
java.lang.String[] parameterValues)
Determines the URI to invoke the specified Service with
additional request parameters. |
java.lang.String |
getServletUri()
Returns the URI of the servlet managing this UserInstance . |
javax.servlet.http.HttpSession |
getSession()
Returns the HttpSession containing this
UserInstance . |
UserInstanceUpdateManager |
getUserInstanceUpdateManager()
Returns the UserInstanceUpdateManager providing information
about updated UserInstance properties. |
void |
sessionDidActivate(javax.servlet.http.HttpSessionEvent e)
|
void |
sessionWillPassivate(javax.servlet.http.HttpSessionEvent e)
|
void |
setClientConfiguration(ClientConfiguration clientConfiguration)
Sets the ClientConfiguration information containing
application-specific client behavior settings. |
void |
setServerDelayMessage(ServerDelayMessage serverDelayMessage)
Sets the ServerDelayMessage displayed during
client/server-interactions. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent e)
Listener implementation of HttpSessionBindingListener . |
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent e)
Listener implementation of HttpSessionBindingListener . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROPERTY_CLIENT_CONFIGURATION
public static final java.lang.String PROPERTY_SERVER_DELAY_MESSAGE
Constructor Detail |
---|
public UserInstance(Connection conn)
UserInstance
.
conn
- the client/server Connection
for which the
instance is being instantiatedMethod Detail |
---|
public java.lang.String getCharacterEncoding()
public ClientConfiguration getClientConfiguration()
ServerDelayMessage
displayed during
client/server-interactions.
Retrieves the ClientConfiguration
information containing
application-specific client behavior settings.
ClientProperties
public ClientProperties getClientProperties()
ClientProperties
object providing
information about the client of this instance.
ClientProperties
public long getCurrentTransactionId()
public long getNextTransactionId()
public ServerDelayMessage getServerDelayMessage()
ServerDelayMessage
displayed during
client/server-interactions.
ServerDelayMessage
public java.lang.String getServiceUri(Service service)
Service
.
service
- the Service
public java.lang.String getServiceUri(Service service, java.lang.String[] parameterNames, java.lang.String[] parameterValues)
Service
with
additional request parameters. The additional parameters are provided by
way of the parameterNames
and parameterValues
arrays. The value of a parameter at a specific index in the
parameterNames
array is provided in the
parameterValues
array at the same index. The arrays must
thus be of equal length. Null values are allowed in the
parameterValues
array, and in such cases only the parameter
name will be rendered in the returned URI.
service
- the Service
parameterNames
- the names of the additional URI parametersparameterValues
- the values of the additional URI parameters
public java.lang.String getServletUri()
UserInstance
.
public UserInstanceUpdateManager getUserInstanceUpdateManager()
UserInstanceUpdateManager
providing information
about updated UserInstance
properties.
UserInstanceUpdateManager
public javax.servlet.http.HttpSession getSession()
HttpSession
containing this
UserInstance
.
HttpSession
public void sessionDidActivate(javax.servlet.http.HttpSessionEvent e)
sessionDidActivate
in interface javax.servlet.http.HttpSessionActivationListener
HttpSessionActivationListener.sessionDidActivate(javax.servlet.http.HttpSessionEvent)
public void sessionWillPassivate(javax.servlet.http.HttpSessionEvent e)
sessionWillPassivate
in interface javax.servlet.http.HttpSessionActivationListener
HttpSessionActivationListener.sessionWillPassivate(javax.servlet.http.HttpSessionEvent)
public void setClientConfiguration(ClientConfiguration clientConfiguration)
ClientConfiguration
information containing
application-specific client behavior settings.
clientConfiguration
- the new ClientConfiguration
public void setServerDelayMessage(ServerDelayMessage serverDelayMessage)
ServerDelayMessage
displayed during
client/server-interactions.
serverDelayMessage
- the new ServerDelayMessage
public void valueBound(javax.servlet.http.HttpSessionBindingEvent e)
HttpSessionBindingListener
.
Stores reference to session when invoked.
valueBound
in interface javax.servlet.http.HttpSessionBindingListener
HttpSessionBindingListener.valueBound(HttpSessionBindingEvent)
public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent e)
HttpSessionBindingListener
.
Removes reference to session when invoked.
valueUnbound
in interface javax.servlet.http.HttpSessionBindingListener
HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent)
|
NextApp Echo2 v2.1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |