java.lang.Object | |
↳ | com.google.inject.servlet.ServletScopes |
Servlet scopes.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Scope | REQUEST | HTTP servlet request scope. | |||||||||
Scope | SESSION | HTTP session scope. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Wraps the given callable in a contextual callable that "continues" the
HTTP request in another thread.
| |||||||||||
Returns true if
binding is request-scoped. | |||||||||||
Scopes the given callable inside a request scope.
| |||||||||||
Wraps the given callable in a contextual callable that "transfers" the
request to another thread.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Wraps the given callable in a contextual callable that "continues" the HTTP request in another thread. This acts as a way of transporting request context data from the request processing thread to to worker threads.
There are some limitations:
The returned callable will throw a ScopingException
when called
if the HTTP request scope is still active on the current thread.
callable | code to be executed in another thread, which depends on the request scope. |
---|---|
seedMap | the initial set of scoped instances for Guice to seed the
request scope with. To seed a key with null, use null as
the value. |
OutOfScopeException | if this method is called from a non-request thread, or if the request has completed. |
---|
Returns true if binding
is request-scoped. If the binding is a
linked key binding
and
belongs to an injector (i. e. it was retrieved via
Injector.getBinding()
), then this method will
also return true if the target binding is request-scoped.
Scopes the given callable inside a request scope. This is not the same as the HTTP request scope, but is used if no HTTP request scope is in progress. In this way, keys can be scoped as @RequestScoped and exist in non-HTTP requests (for example: RPC requests) as well as in HTTP request threads.
The returned callable will throw a ScopingException
when called
if there is a request scope already active on the current thread.
callable | code to be executed which depends on the request scope. Typically in another thread, but not necessarily so. |
---|---|
seedMap | the initial set of scoped instances for Guice to seed the
request scope with. To seed a key with null, use null as
the value. |
seedMap
as scoped keys.Wraps the given callable in a contextual callable that "transfers" the request to another thread. This acts as a way of transporting request context data from the current thread to a future thread.
As opposed to continueRequest(Callable
, this method propagates all
existing scoped objects. The primary use case is in server implementations
where you can detach the request processing thread while waiting for data,
and reattach to a different thread to finish processing at a later time.
Because HttpServletRequest
objects are not typically
thread-safe, the callable returned by this method must not be run on a
different thread until the current request scope has terminated. In other
words, do not use this method to propagate the current request scope to
worker threads that may run concurrently with the current thread.
The returned callable will throw a ScopingException
when called
if the request scope being transferred is still active on a different
thread.
callable | code to be executed in another thread, which depends on the request scope. |
---|
OutOfScopeException | if this method is called from a non-request thread, or if the request has completed. |
---|