|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContainerContext
Contextual information about the application container provided to an
application instance. The ContainerContext
will be stored
as a context property of an application's ApplicationInstance
,
under the key constant CONTEXT_PROPERTY_NAME
.
This interface should not be implemented outside of the core
framework.
Field Summary | |
---|---|
static java.lang.String |
CONTEXT_PROPERTY_NAME
Property name by which a ContainerContext may be retrieved
from an ApplicationInstance 's context properties. |
Method Summary | |
---|---|
void |
addCookie(javax.servlet.http.Cookie cookie)
Adds a Cookie to the client on the outgoing connection, if one is available. |
ClientProperties |
getClientProperties()
Returns the ClientProperties describing the user's
client web browser environment. |
javax.servlet.http.Cookie[] |
getCookies()
Return any Cookie s sent on the current HTTP request. |
java.util.Map |
getInitialRequestParameterMap()
Returns an immutable Map containing the HTTP request
parameters sent on the initial request to the application. |
java.lang.String |
getServiceUri(Service service)
Returns the URI of the specified Service . |
java.lang.String |
getServletUri()
Returns the URI of the Echo servlet. |
javax.servlet.http.HttpSession |
getSession()
Returns the HttpSession in which the application is
being stored. |
java.security.Principal |
getUserPrincipal()
Returns the authenticated user Principal . |
boolean |
isUserInRole(java.lang.String role)
Determines if the authenticated user is in the specified logical "role", by querying the inbound servlet request. |
void |
setClientConfiguration(ClientConfiguration clientConfiguration)
Sets the ClientConfiguration describing
application-specific client configuration settings. |
void |
setTaskQueueCallbackInterval(nextapp.echo.app.TaskQueueHandle taskQueue,
int ms)
Sets the interval between asynchronous callbacks from the client to check for queued tasks for a given TaskQueue . |
Field Detail |
---|
static final java.lang.String CONTEXT_PROPERTY_NAME
ContainerContext
may be retrieved
from an ApplicationInstance
's context properties.
ApplicationInstance.getContextProperty(java.lang.String)
Method Detail |
---|
void addCookie(javax.servlet.http.Cookie cookie) throws java.lang.IllegalStateException
Cookie
to the client on the outgoing connection, if one is available.
cookie
- the cookie to add
java.lang.IllegalStateException
- if no connection is available to store the cookieClientProperties getClientProperties()
ClientProperties
describing the user's
client web browser environment.
ClientProperties
javax.servlet.http.Cookie[] getCookies()
Cookie
s sent on the current HTTP request.
Cookie
sjava.util.Map getInitialRequestParameterMap()
Map
containing the HTTP request
parameters sent on the initial request to the application.
java.lang.String getServiceUri(Service service)
Service
.
service
- the Service
java.lang.String getServletUri()
javax.servlet.http.HttpSession getSession()
HttpSession
in which the application is
being stored.
HttpSession
java.security.Principal getUserPrincipal()
Principal
.
Principal
boolean isUserInRole(java.lang.String role)
void setClientConfiguration(ClientConfiguration clientConfiguration)
ClientConfiguration
describing
application-specific client configuration settings.
clientConfiguration
- the new ClientConfiguration
void setTaskQueueCallbackInterval(nextapp.echo.app.TaskQueueHandle taskQueue, int ms)
TaskQueue
. If multiple
TaskQueue
s are active, the smallest specified interval should
be used. The default interval is 500ms.
taskQueue
- the TaskQueue
ms
- the number of milliseconds between asynchronous client
callbacks
|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |