Class ExternalContext
- Direct Known Subclasses:
ExternalContextWrapper
This class allows the Faces API to be unaware of the nature of its containing application environment. In particular, this class allows JavaServer Faces based appications to run in either a Servlet or a Portlet environment.
The documentation for this class only
specifies the behavior for the Servlet implementation of
ExternalContext
. The Portlet implementation of
ExternalContext
is specified under the revision of the
Portlet Bridge
Specification for JavaServer Faces JSR that corresponds to
this version of the JSF specification. See the Preface of the
"prose document", linked
from the javadocs, for a reference.
If a reference to an
ExternalContext
is obtained during application startup or shutdown
time, any method documented as "valid to call this method during
application startup or shutdown" must be supported during application startup or shutdown
time. The result of calling a method during application startup or shutdown time
that does not have this designation is undefined.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the cookie represented by the arguments to the response.void
addResponseHeader
(String name, String value) Add the given name and value to the response header.abstract void
Dispatch a request to the specified resource to create output for this response.abstract String
encodeActionURL
(String url) Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable action in the current application.The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl.abstract String
encodeNamespace
(String name) Return the specified name, after prefixing it with a namespace that ensures that it will be unique within the context of a particular page.Return the input URL, after performing any rewriting needed to ensure that it can be used in a partial page submission (ajax request) to correctly identify an addressable action in the current application.The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl.abstract String
encodeResourceURL
(String url) Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable resource in the current application.Return the name of the container context for this application.Return a mutableMap
representing the application scope attributes for the current application.abstract String
Return the name of the authentication scheme used to authenticate the current user, if any; otherwise, returnnull
.Return theClientWindow
set in a preceding call tosetClientWindow(javax.faces.lifecycle.ClientWindow)
, ornull
if no such call has been made.abstract Object
Return the application environment object instance for the current appication.Return the name of the container context for this application.getFlash()
Return the threadsafeFlash
for this application.abstract String
getInitParameter
(String name) Return the value of the specified application initialization parameter (if any).abstract Map
Return an immutableMap
whose keys are the set of application initialization parameter names configured for this application, and whose values are the corresponding parameter values.getMimeType
(String file) Returns the MIME type of the specified file ornull
if the MIME type is not known.getRealPath
(String path) Returns a String containing the real path for a given virtual path.abstract String
Return the login name of the user making the current request if any; otherwise, returnnull
.abstract Object
Return the environment-specific object instance for the current request.Return the character encoding currently being used to interpret this request.int
Return the result of callinggetContentLenth()
on theServletRequest
instance for this request.Return the MIME Content-Type for this request.abstract String
Return the portion of the request URI that identifies the web application context for this request.Return an immutableMap
whose keys are the set of cookie names included in the current request, and whose values (of typejavax.servlet.http.Cookie
) are the first (or only) cookie for each cookie name returned by the underlying request.Return an immutableMap
whose keys are the set of request header names included in the current request, and whose values (of type String) are the first (or only) value for each header name returned by the underlying request.Return an immutableMap
whose keys are the set of request header names included in the current request, and whose values (of type String[]) are all of the value for each header name returned by the underlying request.abstract Locale
Return the preferredLocale
in which the client will accept content.Return anIterator
over the preferredLocale
s specified in the request, in decreasing order of preference.Return a mutableMap
representing the request scope attributes for the current application.Return an immutableMap
whose keys are the set of request parameters names included in the current request, and whose values (of type String) are the first (or only) value for each parameter name returned by the underlying request.Return anIterator
over the names of all request parameters included in the current request.Return an immutableMap
whose keys are the set of request parameters names included in the current request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying request.abstract String
Return the extra path information (if any) included in the request URI; otherwise, returnnull
.Returns the name of the scheme used to make this request, for example, http, https, or ftp.Returns the host name of the server to which the request was sent.int
Returns the port number to which the request was sent.abstract String
Return the servlet path information (if any) included in the request URI; otherwise, returnnull
.abstract URL
getResource
(String path) Return aURL
for the application resource mapped to the specified path, if it exists; otherwise, returnnull
.abstract InputStream
getResourceAsStream
(String path) Return anInputStream
for an application resource mapped to the specified path, if it exists; otherwise, returnnull
.getResourcePaths
(String path) Return theSet
of resource paths for all application resources whose resource path starts with the specified argument.abstract Object
Return the environment-specific object instance for the current response.int
Return the buffer size for the current response.Returns the name of the character encoding (MIME charset) used for the body sent in this response.Return the MIME Content-Type for this response.Returns anOutputStream
suitable for writing binary data to the user-agent.Returns aWriter
suitable for writing character data to the user-agent.abstract Object
getSession
(boolean create) If thecreate
parameter istrue
, create (if necessary) and return a session instance associated with the current request.getSessionId
(boolean create) Return the id of the current session or the empty string if no session has been created and thecreate
parameter isfalse
.Return a mutableMap
representing the session scope attributes for the current application.int
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.abstract Principal
Return thePrincipal
object containing the name of the current authenticated user, if any; otherwise, returnnull
.void
Invalidates this session then unbinds any objects bound to it.boolean
Check if the current response has been committed.boolean
isSecure()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.abstract boolean
isUserInRole
(String role) Returntrue
if the currently authenticated user is included in the specified role.abstract void
Log the specified message to the application object.abstract void
Log the specified message and exception to the application object.abstract void
Redirect a request to the specified URL, and cause theresponseComplete()
method to be called on theFacesContext
instance for the current request.void
Flushes the buffered response content to the client.void
Resets the current response.void
responseSendError
(int statusCode, String message) Sends an HTTP status code with message.void
setClientWindow
(ClientWindow window) Associate this instance with aClientWindow
.void
setRequest
(Object request) Set the environment-specific request to be returned by subsequent calls togetRequest()
.void
setRequestCharacterEncoding
(String encoding) Overrides the name of the character encoding used in the body of this request.void
setResponse
(Object response) Set the environment-specific response to be returned by subsequent calls togetResponse()
.void
setResponseBufferSize
(int size) Set the buffer size for the current response.void
setResponseCharacterEncoding
(String encoding) Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.void
setResponseContentLength
(int length) Set the content length of the response.void
setResponseContentType
(String contentType) Sets the content type of the response being sent to the client, if the response has not been committed yet.void
setResponseHeader
(String name, String value) Set the response header with the given name and value.void
setResponseStatus
(int statusCode) Sets the HTTP status code for the response.void
setSessionMaxInactiveInterval
(int interval) Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
-
Field Details
-
BASIC_AUTH
String identifier for BASIC authentication.
- See Also:
-
CLIENT_CERT_AUTH
String identifier for CLIENT_CERT authentication.
- See Also:
-
DIGEST_AUTH
String identifier for DIGEST authentication.
- See Also:
-
FORM_AUTH
String identifier for FORM authentication.
- See Also:
-
-
Constructor Details
-
ExternalContext
public ExternalContext()
-
-
Method Details
-
addResponseCookie
Adds the cookie represented by the arguments to the response.
Servlet: This must be accomplished by calling the
javax.servlet.http.HttpServletResponse
methodaddCookie()
. TheCookie
argument must be constructed by passing thename
andvalue
parameters. If theproperties
arugument is non-null
and not empty, theCookie
instance must be initialized as described below.Key in "values" Map
Expected type of value. Name of setter method on Cookie
instance to be set with the value from theMap
.comment String setComment domain String setDomain maxAge Integer setMaxAge secure Boolean setSecure path String setPath httpOnly Boolean setHttpOnly The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
name
- To be passed as the first argument to theCookie
constructor.value
- To be passed as the second argument to theCookie
constructor.properties
- AMap
containg key/value pairs to be passed as arguments to the setter methods as described above.- Throws:
IllegalArgumentException
- if theproperties Map
is not-null
and not empty and contains any keys that are not one of the keys listed above.- Since:
- 2.0
-
dispatch
Dispatch a request to the specified resource to create output for this response.
Servlet: This must be accomplished by calling the
javax.servlet.ServletContext
methodgetRequestDispatcher(path)
, and calling theforward()
method on the resulting object.If the call to
getRequestDisatcher(path)
returnsnull
, send aServletResponse SC_NOT_FOUND
error code.- Parameters:
path
- Context relative path to the specified resource, which must start with a slash ("/") character- Throws:
FacesException
- thrown if aServletException
occursIOException
- if an input/output error occurs
-
encodeActionURL
Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable action in the current application.
Encoding the
ClientWindow
Call
ClientWindow.isClientWindowRenderModeEnabled(javax.faces.context.FacesContext)
. If the result isfalse
take no further action and return the rewritten URL. If the result istrue
, callgetClientWindow()
. If the result is non-null
, callClientWindow.getId()
and append the id to the query string of the URL, making the necessary allowances for a pre-existing query string or no query-string.Call
ClientWindow.getQueryURLParameters(javax.faces.context.FacesContext)
. If the result is non-null
, for each parameter in the map, unconditionally add that parameter to the URL.The name of the query string parameter is given by the value of the constant
ResponseStateManager.CLIENT_WINDOW_URL_PARAM
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletResponse
methodencodeURL(url)
.- Parameters:
url
- The input URL to be encoded- Throws:
NullPointerException
- ifurl
isnull
-
encodeNamespace
Return the specified name, after prefixing it with a namespace that ensures that it will be unique within the context of a particular page.
Servlet: The input value must be returned unchanged.
- Parameters:
name
- Name to be encoded
-
encodeResourceURL
Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable resource in the current application.
Servlet: This must be the value returned by the
javax.servlet.http.HttpServletResponse
methodencodeURL(url)
.- Parameters:
url
- The input URL to be encoded- Throws:
NullPointerException
- ifurl
isnull
-
getApplicationMap
Return a mutable
Map
representing the application scope attributes for the current application. The returnedMap
must implement the entire contract for a modifiable map as described in the JavaDocs forjava.util.Map
. Modifications made in theMap
must cause the corresponding changes in the set of application scope attributes. Particularly theclear()
,remove()
,put()
,putAll()
, andget()
operations must take the appropriate action on the underlying data structure.For any of the
Map
methods that cause an element to be removed from the underlying data structure, the following action regarding managed-beans must be taken. If the element to be removed is a managed-bean, and it has one or more public no-argument void return methods annotated withjavax.annotation.PreDestroy
, each such method must be called before the element is removed from the underlying data structure. Elements that are not managed-beans, but do happen to have methods with that annotation must not have those methods called on removal. Any exception thrown by thePreDestroy
annotated methods must by caught and not rethrown. The exception may be logged.It is valid to call this method during application startup or shutdown. If called at startup or shutdown time, this method returns a
Map
that is backed by the same container context instance (ServletContext
orPortletContext
) as the one returned by callinggetApplicationMap()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the set of attributes available via the
javax.servlet.ServletContext
methodsgetAttribute()
,getAttributeNames()
,removeAttribute()
, andsetAttribute()
. -
getAuthType
Return the name of the authentication scheme used to authenticate the current user, if any; otherwise, return
null
. For standard authentication schemes, the returned value will match one of the following constants:BASIC_AUTH
,CLIENT_CERT_AUTH
,DIGEST_AUTH
, orFORM_AUTH
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetAuthType()
. -
getFlash
Return the threadsafe
Flash
for this application. The default implementation will throwUnsupportedOperationException
. Compliant JSF runtimes must provide an implementation of this method.- Since:
- 2.0
-
getMimeType
Returns the MIME type of the specified file or
null
if the MIME type is not known. The MIME type is determined by the container.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the
getMimeType()
method on the same container context instance (ServletContext
orPortletContext
) as the one used when callinggetMimeType()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the value returned by the
javax.servlet.ServletContext
methodgetMimeType()
.- Parameters:
file
- The file for which the mime type should be obtained.- Since:
- 2.0
-
getContext
Return the application environment object instance for the current appication.
It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this returns the same container context instance (
ServletContext
orPortletContext
) as the one returned when callinggetContext()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the current application's
javax.servlet.ServletContext
instance. -
getContextName
Return the name of the container context for this application.
Return the result of calling
getServletContextName()
on theServletContext
instance for this application. It is valid to call this method during application startup or shutdown.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class. -
getApplicationContextPath
Return the name of the container context for this application.
Servlet: Return the result of calling
getContextPath()
on theServletContext
instance for this application.It is valid to call this method during application startup or shutdown.
The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.2
-
getInitParameter
Return the value of the specified application initialization parameter (if any).
Servlet: This must be the result of the
javax.servlet.ServletContext
methodgetInitParameter(name)
.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the actual container context to return the init parameter value.
- Parameters:
name
- Name of the requested initialization parameter- Throws:
NullPointerException
- ifname
isnull
-
getInitParameterMap
Return an immutable
Map
whose keys are the set of application initialization parameter names configured for this application, and whose values are the corresponding parameter values. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns a
Map
that is backed by the same container context instance (ServletContext
orPortletContext
) as the one returned by callinggetInitParameterMap()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This result must be as if it were synthesized by calling the
javax.servlet.ServletContext
methodgetInitParameterNames
, and putting each configured parameter name/value pair into the result. -
getRemoteUser
Return the login name of the user making the current request if any; otherwise, return
null
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetRemoteUser()
. -
getRequest
Return the environment-specific object instance for the current request.
Servlet: This must be the current request's
javax.servlet.http.HttpServletRequest
instance. -
setRequest
Set the environment-specific request to be returned by subsequent calls to
getRequest()
. This may be used to install a wrapper for the request.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getRequestScheme
Returns the name of the scheme used to make this request, for example, http, https, or ftp.
Servlet: This must be the value returned by the
javax.servlet.ServletRequest
methodgetScheme()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
getRequestServerName
Returns the host name of the server to which the request was sent.
Servlet: This must be the value returned by the
javax.servlet.ServletRequest
methodgetServerName()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
getRequestServerPort
public int getRequestServerPort()Returns the port number to which the request was sent.
Servlet: This must be the value returned by the
javax.servlet.ServletRequest
methodgetServerPort()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
setRequestCharacterEncoding
Overrides the name of the character encoding used in the body of this request.
Calling this method after the request has been accessed will have no no effect, unless a
Reader
orStream
has been obtained from the request, in which case anIllegalStateException
is thrown.Servlet: This must call through to the
javax.servlet.ServletRequest
methodsetCharacterEncoding()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Throws:
UnsupportedEncodingException
- if this is not a valid encoding- Since:
- 1.2
-
getRealPath
Returns a String containing the real path for a given virtual path.
Servlet: This must be the value returned by the
javax.servlet.ServletContext
methodgetRealPath()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
path
- The context of the requested initialization parameter- Since:
- 2.0
-
getRequestContextPath
Return the portion of the request URI that identifies the web application context for this request.
Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetContextPath()
. -
getRequestCookieMap
Return an immutable
Map
whose keys are the set of cookie names included in the current request, and whose values (of typejavax.servlet.http.Cookie
) are the first (or only) cookie for each cookie name returned by the underlying request. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetCookies()
, unlessnull
was returned, in which case this must be a zero-length array. -
getRequestHeaderMap
Return an immutable
Map
whose keys are the set of request header names included in the current request, and whose values (of type String) are the first (or only) value for each header name returned by the underlying request. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
. In addition, key comparisons must be performed in a case insensitive manner.Servlet: This must be the set of headers available via the
javax.servlet.http.HttpServletRequest
methodsgetHeader()
andgetHeaderNames()
. -
getRequestHeaderValuesMap
Return an immutable
Map
whose keys are the set of request header names included in the current request, and whose values (of type String[]) are all of the value for each header name returned by the underlying request. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
. In addition, key comparisons must be performed in a case insensitive manner.Servlet: This must be the set of headers available via the
javax.servlet.http.HttpServletRequest
methodsgetHeaders()
andgetHeaderNames()
. -
getRequestLocale
Return the preferred
Locale
in which the client will accept content.Servlet: This must be the value returned by the
javax.servlet.ServletRequest
methodgetLocale()
. -
getRequestLocales
Return an
Iterator
over the preferredLocale
s specified in the request, in decreasing order of preference.Servlet: This must be an
Iterator
over the values returned by thejavax.servlet.ServletRequest
methodgetLocales()
. -
getRequestMap
Return a mutable
Map
representing the request scope attributes for the current application. The returnedMap
must implement the entire contract for a modifiable map as described in the JavaDocs forjava.util.Map
. Modifications made in theMap
must cause the corresponding changes in the set of request scope attributes. Particularly theclear()
,remove()
,put()
,putAll()
, andget()
operations must take the appropriate action on the underlying data structure.For any of the
Map
methods that cause an element to be removed from the underlying data structure, the following action regarding managed-beans must be taken. If the element to be removed is a managed-bean, and it has one or more public no-argument void return methods annotated withjavax.annotation.PreDestroy
, each such method must be called before the element is removed from the underlying data structure. Elements that are not managed-beans, but do happen to have methods with that annotation must not have those methods called on removal. Any exception thrown by thePreDestroy
annotated methods must by caught and not rethrown. The exception may be logged.Servlet: This must be the set of attributes available via the
javax.servlet.ServletRequest
methodsgetAttribute()
,getAttributeNames()
,removeAttribute()
, andsetAttribute()
. -
getRequestParameterMap
Return an immutable
Map
whose keys are the set of request parameters names included in the current request, and whose values (of type String) are the first (or only) value for each parameter name returned by the underlying request. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
.Servlet: This must be the set of parameters available via the
javax.servlet.ServletRequest
methodsgetParameter()
andgetParameterNames()
. -
getRequestParameterNames
Return an
Iterator
over the names of all request parameters included in the current request.Servlet: This must be an
Iterator
over the values returned by thejavax.servlet.ServletRequest
methodgetParameterNames()
. -
getRequestParameterValuesMap
Return an immutable
Map
whose keys are the set of request parameters names included in the current request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying request. The returnedMap
must implement the entire contract for an unmodifiable map as described in the JavaDocs forjava.util.Map
.Servlet: This must be the set of parameters available via the
javax.servlet.ServletRequest
methodsgetParameterValues()
andgetParameterNames()
. -
getRequestPathInfo
Return the extra path information (if any) included in the request URI; otherwise, return
null
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetPathInfo()
. -
getRequestServletPath
Return the servlet path information (if any) included in the request URI; otherwise, return
null
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetServletPath()
. -
getRequestCharacterEncoding
Return the character encoding currently being used to interpret this request.
Servlet: This must return the value returned by the
javax.servlet.ServletRequest
methodgetCharacterEncoding()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getRequestContentType
Return the MIME Content-Type for this request. If not available, return
null
.Servlet: This must return the value returned by the
javax.servlet.ServletRequest
methodgetContentType()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getRequestContentLength
public int getRequestContentLength()Return the result of calling
getContentLenth()
on theServletRequest
instance for this request.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
getResponseCharacterEncoding
Returns the name of the character encoding (MIME charset) used for the body sent in this response.
Servlet: This must return the value returned by the
javax.servlet.ServletResponse
methodgetCharacterEncoding()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getResponseContentType
Return the MIME Content-Type for this response. If not available, return
null
.Servlet: This must return the value returned by the
javax.servlet.ServletResponse
methodgetContentType()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getResource
Return a
URL
for the application resource mapped to the specified path, if it exists; otherwise, returnnull
.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the
getResource()
method on the same container context instance (ServletContext
orPortletContext
) as the one used when callinggetResource()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the value returned by the
javax.servlet.ServletContext
methodgetResource(path)
.- Parameters:
path
- The path to the requested resource, which must start with a slash ("/" character- Throws:
MalformedURLException
- if the specified path is not in the correct formNullPointerException
- ifpath
isnull
-
getResourceAsStream
Return an
InputStream
for an application resource mapped to the specified path, if it exists; otherwise, returnnull
.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the
getResourceAsStream()
method on the same container context instance (ServletContext
orPortletContext
) as the one used when callinggetResourceAsStream()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the value returned by the
javax.servlet.ServletContext
methodgetResourceAsStream(path)
.- Parameters:
path
- The path to the requested resource, which must start with a slash ("/" character- Throws:
NullPointerException
- ifpath
isnull
-
getResourcePaths
Return the
Set
of resource paths for all application resources whose resource path starts with the specified argument.It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the
getResourcePaths()
method on the same container context instance (ServletContext
orPortletContext
) as the one used when callinggetResourcePaths()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be the value returned by the
javax.servlet.ServletContext
methodgetResourcePaths(path).
- Parameters:
path
- Partial path used to match resources, which must start with a slash ("/") character- Throws:
NullPointerException
- ifpath
isnull
-
getResponse
Return the environment-specific object instance for the current response.
Servlet: This is the current request's
javax.servlet.http.HttpServletResponse
instance. -
setResponse
Set the environment-specific response to be returned by subsequent calls to
getResponse()
. This may be used to install a wrapper for the response.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
getResponseOutputStream
Returns an
OutputStream
suitable for writing binary data to the user-agent.Servlet: This must return the value returned by the
javax.servlet.ServletResponse
methodgetOutputStream()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Throws:
IOException
- Since:
- 2.0
-
getResponseOutputWriter
Returns a
Writer
suitable for writing character data to the user-agent.Servlet: This must return the value returned by the
ServletResponse.getWriter()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Throws:
IOException
- Since:
- 2.0
-
setResponseCharacterEncoding
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
Servlet: This must call through to the
javax.servlet.ServletResponse
methodsetCharacterEncoding()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 1.2
-
setResponseContentType
Sets the content type of the response being sent to the client, if the response has not been committed yet.
Servlet: This must call
setContentType()
on the underlyingjavax.servlet.ServletResponse
instance.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
contentType
- The content type to be set as the contentType of the response.- Since:
- 2.0
-
getSession
If the
create
parameter istrue
, create (if necessary) and return a session instance associated with the current request. If thecreate
parameter isfalse
return any existing session instance associated with the current request, or returnnull
if there is no such session.Servlet: This must return the result of calling
getSession(create)
on the underlyingjavax.servlet.http.HttpServletRequest
instance.- Parameters:
create
- Flag indicating whether or not a new session should be created if there is no session associated with the current request
-
getSessionId
Return the id of the current session or the empty string if no session has been created and the
create
parameter isfalse
.Servlet: If
create
is true, obtain a reference to theHttpSession
for the current request (creating the session if necessary) and return its id. Ifcreate
isfalse
, obtain a reference to the current session, if one exists, and return its id. If no session exists, return the empty string.- Parameters:
create
- Flag indicating whether or not a new session should be created if there is no session associated with the current request- Since:
- 2.2
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the
setSessionMaxInactiveInterval(int)
method.A return value of zero or less indicates that the session will never timeout.
Servlet: This must return the result of calling
getMaxInactiveInterval
on the underlyingjavax.servlet.http.HttpServletRequest
instance.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.1
-
getSessionMap
Return a mutable
Map
representing the session scope attributes for the current application. The returnedMap
must implement the entire contract for a modifiable map as described in the JavaDocs forjava.util.Map
. Modifications made in theMap
must cause the corresponding changes in the set of session scope attributes. Particularly theclear()
,remove()
,put()
, andget()
operations must take the appropriate action on the underlying data structure. Accessing attributes via thisMap
must cause the creation of a session associated with the current request, if such a session does not already exist.For any of the
Map
methods that cause an element to be removed from the underlying data structure, the following action regarding managed-beans must be taken. If the element to be removed is a managed-bean, and it has one or more public no-argument void return methods annotated withjavax.annotation.PreDestroy
, each such method must be called before the element is removed from the underlying data structure. Elements that are not managed-beans, but do happen to have methods with that annotation must not have those methods called on removal. Any exception thrown by thePreDestroy
annotated methods must by caught and not rethrown. The exception may be logged.Servlet: This must be the set of attributes available via the
javax.servlet.http.HttpSession
methodsgetAttribute()
,getAttributeNames()
,removeAttribute()
, andsetAttribute()
. -
getUserPrincipal
Return the
Principal
object containing the name of the current authenticated user, if any; otherwise, returnnull
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodgetUserPrincipal()
. -
getClientWindow
Return the
ClientWindow
set in a preceding call tosetClientWindow(javax.faces.lifecycle.ClientWindow)
, ornull
if no such call has been made.- Since:
- 2.2
-
invalidateSession
public void invalidateSession()Invalidates this session then unbinds any objects bound to it.
Servlet: This must be the value returned by the
javax.servlet.http.HttpSession
methodinvalidate()
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
isUserInRole
Return
true
if the currently authenticated user is included in the specified role. Otherwise, returnfalse
.Servlet: This must be the value returned by the
javax.servlet.http.HttpServletRequest
methodisUserInRole(role)
.- Parameters:
role
- Logical role name to be checked- Throws:
NullPointerException
- ifrole
isnull
-
log
Log the specified message to the application object.
It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this calls the
log()
method on the same container context instance (ServletContext
orPortletContext
) as the one used during a call tolog()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be performed by calling the
javax.servlet.ServletContext
methodlog(String)
.- Parameters:
message
- Message to be logged- Throws:
NullPointerException
- ifmessage
isnull
-
log
Log the specified message and exception to the application object.
It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this calls the
log()
method on the same container context instance (ServletContext
orPortletContext
) as the one used when callinglog()
on theExternalContext
returned by theFacesContext
during an actual request.Servlet: This must be performed by calling the
javax.servlet.ServletContext
methodlog(String,Throwable)
.- Parameters:
message
- Message to be loggedexception
- Exception to be logged- Throws:
NullPointerException
- ifmessage
orexception
isnull
-
redirect
Redirect a request to the specified URL, and cause the
responseComplete()
method to be called on theFacesContext
instance for the current request.The implementation must determine if the request is an
Ajax
request by obtaining aPartialViewContext
instance from theFacesContext
and callingPartialViewContext.isAjaxRequest()
.Servlet: For non
Ajax
requests, this must be accomplished by calling thejavax.servlet.http.HttpServletResponse
methodsendRedirect()
.For Ajax requests, the implementation must:- Get a
PartialResponseWriter
instance from theFacesContext
. - Call
setResponseContentType(java.lang.String)
withtext/xml
- Call
setResponseCharacterEncoding(java.lang.String)
withUTF-8
- Call
addResponseHeader(java.lang.String, java.lang.String)
withCache-Control
,no-cache
- Call
PartialResponseWriter.startDocument()
- Call
PartialResponseWriter.redirect(java.lang.String)
with theurl
argument. - Call
PartialResponseWriter.endDocument()
- Parameters:
url
- Absolute URL to which the client should be redirected- Throws:
IllegalArgumentException
- if the specified url is relativeIllegalStateException
- if, in a portlet environment, the current response object is aRenderResponse
instead of anActionResponse
IllegalStateException
- if, in a servlet environment, the current response has already been committedIOException
- if an input/output error occurs
- Get a
-
setResponseHeader
Set the response header with the given name and value.
Servlet:This must be performed by calling the
javax.servlet.http.HttpServletResponse
setHeader
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
name
- The name of the response header.value
- The value of the response header.- Since:
- 2.0
-
addResponseHeader
Add the given name and value to the response header.
Servlet:This must be performed by calling the
javax.servlet.http.HttpServletResponse
addHeader
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
name
- The name of the response header.value
- The value of the response header.- Since:
- 2.0
-
setResponseBufferSize
public void setResponseBufferSize(int size) Set the buffer size for the current response.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
setBufferSize
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
size
- the new buffer size- Since:
- 2.0
-
getResponseBufferSize
public int getResponseBufferSize()Return the buffer size for the current response.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
getBufferSize
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
isResponseCommitted
public boolean isResponseCommitted()Check if the current response has been committed.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
isCommitted
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
responseReset
public void responseReset()Resets the current response.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
reset
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
responseSendError
Sends an HTTP status code with message.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
sendError
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
statusCode
- an HTTP status codemessage
- an option message to detail the cause of the code- Throws:
IOException
- Since:
- 2.0
-
setResponseStatus
public void setResponseStatus(int statusCode) Sets the HTTP status code for the response.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
setStatus
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
statusCode
- an HTTP status code- Since:
- 2.0
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval) Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
An interval value of zero or less indicates that the session should never timeout.
Servlet: This must call
setMaxInactiveInterval
on the underlyingjavax.servlet.http.HttpServletRequest
instance.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.1
-
setClientWindow
Associate this instance with a
ClientWindow
.- Parameters:
window
- the window with which this instance is associated.- Since:
- 2.2
-
responseFlushBuffer
Flushes the buffered response content to the client.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
flushBuffer
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Throws:
IOException
- Since:
- 2.0
-
setResponseContentLength
public void setResponseContentLength(int length) Set the content length of the response.
Servlet: This must be performed by calling the
javax.servlet.http.HttpServletResponse
setContentLength
method.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.0
-
encodeBookmarkableURL
The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl. This method must be able to encode the parameters to a baseUrl that may or may not have existing query parameters. The parameter values should be encoded appropriately for the environment so that the resulting URL can be used as the target of a link (e.g., in an href attribute) in a JSF response. It's possible for an ExternalContext implementation to override this method in any way that would make the URL bookmarkable in that environment.
See
encodeActionURL(java.lang.String)
for the required specification of how to encode theClientWindow
.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Parameters:
baseUrl
- The base URL onto which the query string generated by this method will be appended. The URL may contain query parameters.parameters
- The collection of Parameter objects, representing name=value pairs that are used to produce a query string- Since:
- 2.0
-
encodeRedirectURL
The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl. This method must be able to encode the parameters to a baseUrl that may or may not have existing query parameters. The parameter values should be encoded appropriately for the environment so that the resulting URL can be used as the target of a redirect. It's possible for an ExternalContext implementation to override this method to accomodate the definition of redirect for that environment.See
encodeActionURL(java.lang.String)
for the required specification of how to encode theClientWindow
.- Parameters:
baseUrl
- The base URL onto which the query string generated by this method will be appended. The URL may contain query parameters.parameters
- The collection of Parameter objects, representing name=value pairs that are used to produce a query string- Since:
- 2.0
-
encodePartialActionURL
Return the input URL, after performing any rewriting needed to ensure that it can be used in a partial page submission (ajax request) to correctly identify an addressable action in the current application.
See
encodeActionURL(java.lang.String)
for the required specification of how to encode theClientWindow
.Servlet:Returns the same encoded URL as the
encodeActionURL(String url)
method.Portlet:Returns an encoded URL that, upon HTTP POST, will invoke the RESOURCE_PHASE of the portlet lifecycle.
- Parameters:
url
- The input URL to be encoded- Throws:
NullPointerException
- ifurl
isnull
- Since:
- 2.0
-
isSecure
public boolean isSecure()Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
Servlet: This must return the result of calling
isSecure
on the underlyingjavax.servlet.http.HttpServletRequest
instance.The default implementation throws
UnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.- Since:
- 2.1
-