Faces

java.lang.Object
- org.omnifaces.util.Faces

```
public final class Faces
extends Object
```
Collection of utility methods for the JSF API that are mainly shortcuts for obtaining stuff from the thread local FacesContext. In effects, it 'flattens' the hierarchy of nested objects.
Do note that using the hierarchy is actually a better software design practice, but can lead to verbose code.
In addition, note that there's normally a minor overhead in obtaining the thread local FacesContext. In case client code needs to call methods in this class multiple times it's expected that performance will be slightly better if instead the FacesContext is obtained once and the required methods are called on that, although the difference is practically negligible when used in modern server hardware.

Author:

Arjan Tijms, Bauke Scholtz

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addRenderIds(String... clientIds)` Add the given client IDs to the collection of render IDs of the current partial view context.
`static void`	`addResponseCookie(String name, String value, String path, int maxAge)` Add a cookie with given name, value, path and maxage to the HTTP response.
`static void`	`addResponseHeader(String name, String value)` Add a header with given name and value to the HTTP response.
`static <T> T`	`evaluateExpressionGet(String expression)` Programmatically evaluate the given EL expression and return the evaluated value.
`static void`	`evaluateExpressionSet(String expression, Object value)` Programmatically evaluate the given EL expression and set the given value.
`static Application`	`getApplication()` Returns the application singleton.
`static <T> T`	`getApplicationAttribute(String name)` Returns the application scope attribute value associated with the given name.
`static Map<String,Object>`	`getApplicationMap()` Returns the application scope map.
`static FacesContext`	`getContext()` Returns the current faces context.
`static PhaseId`	`getCurrentPhaseId()` Returns the current phase ID.
`static Locale`	`getDefaultLocale()` Returns the default locale, or `null` if there is none.
`static ExternalContext`	`getExternalContext()` Returns the current external context.
`static <T> T`	`getFaceletAttribute(String name)` Returns the Facelet attribute value associated with the given name.
`static FaceletContext`	`getFaceletContext()` Returns the Facelet context.
`static Flash`	`getFlash()` Returns the flash scope.
`static <T> T`	`getFlashAttribute(String name)` Returns the flash scope attribute value associated with the given name.
`static String`	`getImplInfo()` Returns the implementation information of currently loaded JSF implementation.
`static String`	`getInitParameter(String name)` Returns the application initialization parameter.
`static Map<String,String>`	`getInitParameterMap()` Returns the application initialization parameter map.
`static Locale`	`getLocale()` Returns the current locale.
`static String`	`getMapping()` Determines and returns the faces servlet mapping used in the current request.
`static String`	`getMimeType(String name)` Returns the mime type for the given file name.
`static PartialViewContext`	`getPartialViewContext()` Returns the current partial view context (the ajax context).
`static String`	`getRemoteUser()` Returns the name of the logged-in user for container managed FORM based authentication, if any.
`static HttpServletRequest`	`getRequest()` Returns the HTTP servlet request.
`static <T> T`	`getRequestAttribute(String name)` Returns the request scope attribute value associated with the given name.
`static String`	`getRequestBaseURL()` Returns the HTTP request base URL.
`static String`	`getRequestContextPath()` Returns the HTTP request context path.
`static String`	`getRequestCookie(String name)` Returns the value of the HTTP request cookie associated with the given name.
`static String`	`getRequestDomainURL()` Returns the HTTP request domain URL.
`static String`	`getRequestHeader(String name)` Returns the HTTP request header value associated with the given name.
`static Map<String,String>`	`getRequestHeaderMap()` Returns the HTTP request header map.
`static String[]`	`getRequestHeaderValues(String name)` Returns the HTTP request header values associated with the given name.
`static Map<String,String[]>`	`getRequestHeaderValuesMap()` Returns the HTTP request header values map.
`static Map<String,Object>`	`getRequestMap()` Returns the request scope map.
`static String`	`getRequestParameter(String name)` Returns the HTTP request parameter value associated with the given name.
`static Map<String,String>`	`getRequestParameterMap()` Returns the HTTP request parameter map.
`static String[]`	`getRequestParameterValues(String name)` Returns the HTTP request parameter values associated with the given name.
`static Map<String,String[]>`	`getRequestParameterValuesMap()` Returns the HTTP request parameter values map.
`static String`	`getRequestPathInfo()` Returns the HTTP request path info.
`static String`	`getRequestQueryString()` Returns the HTTP request query string.
`static String`	`getRequestServletPath()` Returns the HTTP request servlet path.
`static String`	`getRequestURI()` Returns the HTTP request URI.
`static String`	`getRequestURL()` Returns the HTTP request URL.
`static InputStream`	`getResourceAsStream(String path)` Returns an input stream for an application resource mapped to the specified path, if it exists; otherwise, return `null`.
`static Set<String>`	`getResourcePaths(String path)` Returns a set of available application resource paths matching the specified path.
`static HttpServletResponse`	`getResponse()` Returns the HTTP servlet response.
`static String`	`getServerInfo()` Returns the server information of currently running application server implementation.
`static ServletContext`	`getServletContext()` Returns the servlet context.
`static HttpSession`	`getSession()` Returns the HTTP session and creates one if one doesn't exist.
`static HttpSession`	`getSession(boolean create)` Returns the HTTP session and creates one if one doesn't exist and `create` argument is `true`, otherwise don't create one and return `null`.
`static <T> T`	`getSessionAttribute(String name)` Returns the session scope attribute value associated with the given name.
`static long`	`getSessionCreationTime()` Returns the time when the HTTP session was created, measured in epoch time.
`static long`	`getSessionLastAccessedTime()` Returns the time of the previous request associated with the current HTTP session, measured in epoch time.
`static Map<String,Object>`	`getSessionMap()` Returns the session scope map.
`static int`	`getSessionMaxInactiveInterval()` Returns the HTTP session timeout in seconds.
`static List<Locale>`	`getSupportedLocales()` Returns a list of all supported locales on this application, with the default locale as the first item, if any.
`static <T> T`	`getViewAttribute(String name)` Returns the view scope attribute value associated with the given name.
`static String`	`getViewId()` Returns the ID of the current view root, or `null` if there is no view.
`static Map<String,Object>`	`getViewMap()` Returns the view scope map.
`static Collection<UIViewParameter>`	`getViewParameters()` Returns the view parameters of the current view, or an empty collection if there is no view.
`static UIViewRoot`	`getViewRoot()` Returns the current view root.
`static boolean`	`hasSession()` Returns whether the HTTP session has already been created.
`static boolean`	`hasSessionTimedOut()` Returns whether the HTTP session has been timed out for the current request.
`static void`	`includeFacelet(UIComponent component, String path)` Include the Facelet file at the given (relative) path as child of the given UI component.
`static void`	`invalidateSession()` Invalidates the current HTTP session.
`static boolean`	`isAjaxRequest()` Returns whether the current request is an ajax request.
`static boolean`	`isDevelopment()` Returns whether we're in development stage.
`static boolean`	`isPostback()` Returns whether the current request is a postback.
`static boolean`	`isPrefixMapping()` Returns whether the faces servlet mapping used in the current request is a prefix mapping.
`static boolean`	`isPrefixMapping(String mapping)` Returns whether the faces servlet mapping used in the current request is a prefix mapping.
`static boolean`	`isResponseCommitted()` Returns whether the response is already committed.
`static boolean`	`isSessionNew()` Returns whether the HTTP session has been created for the first time in the current request.
`static boolean`	`isUserInRole(String role)` Returns whether the currently logged-in user has the given role.
`static boolean`	`isValidationFailed()` Returns whether the validations phase of the current request has failed.
`static void`	`login(String username, String password)` Perform programmatic login for container managed FORM based authentication.
`static void`	`logout()` Perform programmatic logout for container managed FORM based authentication.
`static void`	`navigate(String outcome)` Perform the JSF navigation to the given outcome.
`static String`	`normalizeViewId(String path)` Normalize the given path as a valid view ID based on the current mapping, if necessary.
`static void`	`redirect(String url)` Sends a temporary (302) redirect to the given URL.
`static void`	`redirectPermanent(String url)` Sends a permanent (301) redirect to the given URL.
`static <T> T`	`removeApplicationAttribute(String name)` Removes the application scope attribute value associated with the given name.
`static <T> T`	`removeFlashAttribute(String name)` Removes the flash scope attribute value associated with the given name.
`static <T> T`	`removeRequestAttribute(String name)` Removes the request scope attribute value associated with the given name.
`static void`	`removeResponseCookie(String name, String path)` Remove the cookie with given name and path from the HTTP response.
`static <T> T`	`removeSessionAttribute(String name)` Removes the session scope attribute value associated with the given name.
`static <T> T`	`removeViewAttribute(String name)` Removes the view scope attribute value associated with the given name.
`static void`	`responseReset()` Resets the current response.
`static void`	`responseSendError(int status, String message)` Sends a HTTP response error with the given status and message.
`static void`	`sendFile(byte[] content, String filename, boolean attachment)` Send the given byte array as a file to the response.
`static void`	`sendFile(File file, boolean attachment)` Send the given file to the response.
`static void`	`sendFile(InputStream content, String filename, boolean attachment)` Send the given input stream as a file to the response.
`static void`	`setApplicationAttribute(String name, Object value)` Sets the application scope attribute value associated with the given name.
`static void`	`setFaceletAttribute(String name, Object value)` Sets the Facelet attribute value associated with the given name.
`static void`	`setFlashAttribute(String name, Object value)` Sets the flash scope attribute value associated with the given name.
`static void`	`setRequestAttribute(String name, Object value)` Sets the request scope attribute value associated with the given name.
`static void`	`setSessionAttribute(String name, Object value)` Sets the session scope attribute value associated with the given name.
`static void`	`setSessionMaxInactiveInterval(int seconds)` Sets the HTTP session timeout in seconds.
`static void`	`setViewAttribute(String name, Object value)` Sets the view scope attribute value associated with the given name.
`static void`	`setViewRoot(String viewId)` Sets the current view root to the given view ID.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getContext
```
public static FacesContext getContext()
```
    Returns the current faces context.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The current faces context.
    See Also:
    FacesContext.getCurrentInstance()
  - getExternalContext
```
public static ExternalContext getExternalContext()
```
    Returns the current external context.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The current external context.
    See Also:
    FacesContext.getExternalContext()
  - getPartialViewContext
```
public static PartialViewContext getPartialViewContext()
```
    Returns the current partial view context (the ajax context).
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The current partial view context.
    See Also:
    FacesContext.getPartialViewContext()
  - getApplication
```
public static Application getApplication()
```
    Returns the application singleton.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The faces application singleton.
    See Also:
    FacesContext.getApplication()
  - getImplInfo
```
public static String getImplInfo()
```
    Returns the implementation information of currently loaded JSF implementation. E.g. "Mojarra 2.1.7-FCS".
    
    Returns:
    The implementation information of currently loaded JSF implementation.
    See Also:
    Package.getImplementationTitle(), Package.getImplementationVersion()
  - getServerInfo
```
public static String getServerInfo()
```
    Returns the server information of currently running application server implementation.
    
    Returns:
    The server information of currently running application server implementation.
    See Also:
    ServletContext.getServerInfo()
  - isDevelopment
```
public static boolean isDevelopment()
```
    Returns whether we're in development stage. This will be the case when the javax.faces.PROJECT_STATE context parameter in web.xml is set to Development.
    
    Returns:
    true if we're in development stage, otherwise false.
    See Also:
    Application.getProjectStage()
  - getMapping
```
public static String getMapping()
```
    Determines and returns the faces servlet mapping used in the current request. If JSF is prefix mapped (e.g. /faces/*), then this returns the whole path, with a leading slash (e.g. /faces). If JSF is suffix mapped (e.g. *.xhtml), then this returns the whole extension (e.g. .xhtml).
    
    Returns:
    The faces servlet mapping (without the wildcard).
    See Also:
    getRequestPathInfo(), getRequestServletPath()
  - isPrefixMapping
```
public static boolean isPrefixMapping()
```
    Returns whether the faces servlet mapping used in the current request is a prefix mapping.
    
    Returns:
    true if the faces servlet mapping used in the current request is a prefix mapping, otherwise false.
    See Also:
    getMapping(), isPrefixMapping(String)
  - isPrefixMapping
```
public static boolean isPrefixMapping(String mapping)
```
    Returns whether the faces servlet mapping used in the current request is a prefix mapping. Use this method in preference to isPrefixMapping() when you already have obtained the mapping from getMapping() so that the mapping won't be calculated twice.
    
    Parameters:
    mapping - The mapping to be tested.
    
    Returns:
    true if the faces servlet mapping used in the current request is a prefix mapping, otherwise false.
    
    Throws:
    
    NullPointerException - When mapping is null.
  - getCurrentPhaseId
```
public static PhaseId getCurrentPhaseId()
```
    Returns the current phase ID.
    
    Returns:
    The current phase ID.
    See Also:
    FacesContext.getCurrentPhaseId()
  - evaluateExpressionGet
```
public static <T> T evaluateExpressionGet(String expression)
```
    Programmatically evaluate the given EL expression and return the evaluated value.
    
    Type Parameters:
    T - The expected return type.
    Parameters:
    expression - The EL expression to be evaluated.
    
    Returns:
    The evaluated value of the given EL expression.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    Application.evaluateExpressionGet(FacesContext, String, Class)
  - evaluateExpressionSet
```
public static void evaluateExpressionSet(String expression,
                         Object value)
```
    Programmatically evaluate the given EL expression and set the given value.
    
    Parameters:
    expression - The EL expression to be evaluated.
    value - The value to be set in the property behind the EL expression.
    Since:
    
    1.1
    
    See Also:
    Application.getExpressionFactory(), ExpressionFactory.createValueExpression(ELContext, String, Class), ValueExpression.setValue(ELContext, Object)
  - getViewRoot
```
public static UIViewRoot getViewRoot()
```
    Returns the current view root.
    
    Returns:
    The current view root.
    See Also:
    FacesContext.getViewRoot()
  - setViewRoot
```
public static void setViewRoot(String viewId)
```
    Sets the current view root to the given view ID. The view ID must start with a leading slash. If an invalid view ID is given, then the response will simply result in a 404.
    
    Parameters:
    viewId - The ID of the view which needs to be set as the current view root.
    Since:
    
    1.1
    
    See Also:
    ViewHandler.createView(FacesContext, String), FacesContext.setViewRoot(UIViewRoot)
  - getViewId
```
public static String getViewId()
```
    Returns the ID of the current view root, or null if there is no view.
    
    Returns:
    The ID of the current view root, or null if there is no view.
    See Also:
    UIViewRoot.getViewId()
  - normalizeViewId
```
public static String normalizeViewId(String path)
```
    Normalize the given path as a valid view ID based on the current mapping, if necessary.
    - If the current mapping is a prefix mapping and the given path starts with it, then remove it.
    - If the current mapping is a suffix mapping and the given path does not end with it, then replace it.
    Parameters:
    path - The path to be normalized as a valid view ID based on the current mapping.
    
    Returns:
    The path as a valid view ID.
    See Also:
    getMapping(), isPrefixMapping(String)
  - getViewParameters
```
public static Collection<UIViewParameter> getViewParameters()
```
    Returns the view parameters of the current view, or an empty collection if there is no view.
    
    Returns:
    The view parameters of the current view, or an empty collection if there is no view.
    See Also:
    ViewMetadata.getViewParameters(UIViewRoot)
  - getLocale
```
public static Locale getLocale()
```
    Returns the current locale. If the locale set in the JSF view root is not null, then return it. Else if the client preferred locale is not null and is among supported locales, then return it. Else if the JSF default locale is not null, then return it. Else return the system default locale.
    
    Returns:
    The current locale.
    See Also:
    UIViewRoot.getLocale(), ExternalContext.getRequestLocale(), Application.getDefaultLocale(), Locale.getDefault()
  - getDefaultLocale
```
public static Locale getDefaultLocale()
```
    Returns the default locale, or null if there is none.
    
    Returns:
    The default locale, or null if there is none.
    See Also:
    Application.getDefaultLocale()
  - getSupportedLocales
```
public static List<Locale> getSupportedLocales()
```
    Returns a list of all supported locales on this application, with the default locale as the first item, if any. This will return an empty list if there are no locales definied in faces-config.xml.
    
    Returns:
    A list of all supported locales on this application, with the default locale as the first item, if any.
    See Also:
    Application.getDefaultLocale(), Application.getSupportedLocales()
  - navigate
```
public static void navigate(String outcome)
```
    Perform the JSF navigation to the given outcome.
    
    Parameters:
    outcome - The navigation outcome.
    See Also:
    Application.getNavigationHandler(), NavigationHandler.handleNavigation(FacesContext, String, String)
  - addRenderIds
```
public static void addRenderIds(String... clientIds)
```
    Add the given client IDs to the collection of render IDs of the current partial view context. This will force JSF to ajax-render/update the components with the given client IDs on render response. Note that those client IDs should not start with the naming container separator character like :.
    
    Parameters:
    clientIds - The client IDs to be added to the collection of render IDs of the current partial view context.
    Since:
    
    1.1
  - getFaceletContext
```
public static FaceletContext getFaceletContext()
```
    Returns the Facelet context.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The Facelet context.
    Since:
    
    1.1
    
    See Also:
    FaceletContext
  - includeFacelet
```
public static void includeFacelet(UIComponent component,
                  String path)
                           throws IOException
```
    Include the Facelet file at the given (relative) path as child of the given UI component. This has the same effect as using <ui:include>. The path is relative to the current view ID and absolute to the webcontent root.
    
    Parameters:
    component - The component to include the Facelet file in.
    path - The (relative) path to the Facelet file.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
    Since:
    
    1.1
    
    See Also:
    FaceletContext.includeFacelet(UIComponent, String)
  - getFaceletAttribute
```
public static <T> T getFaceletAttribute(String name)
```
    Returns the Facelet attribute value associated with the given name. This basically returns the value of the <ui:param> which is been declared inside the Facelet file, or is been passed into the Facelet file by e.g. an <ui:include>.
    
    Parameters:
    name - The Facelet attribute name.
    
    Returns:
    The Facelet attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    FaceletContext.getAttribute(String)
  - setFaceletAttribute
```
public static void setFaceletAttribute(String name,
                       Object value)
```
    Sets the Facelet attribute value associated with the given name. This basically does the same as an <ui:param> which is been declared inside the Facelet file, or is been passed into the Facelet file by e.g. an <ui:include>.
    
    Parameters:
    name - The Facelet attribute name.
    value - The Facelet attribute value.
    Since:
    
    1.1
    
    See Also:
    FaceletContext.setAttribute(String, Object)
  - getRequest
```
public static HttpServletRequest getRequest()
```
    Returns the HTTP servlet request.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The HTTP servlet request.
    See Also:
    ExternalContext.getRequest()
  - isAjaxRequest
```
public static boolean isAjaxRequest()
```
    Returns whether the current request is an ajax request.
    
    Returns:
    true for an ajax request, false for a non-ajax (synchronous) request.
    See Also:
    PartialViewContext.isAjaxRequest()
  - isPostback
```
public static boolean isPostback()
```
    Returns whether the current request is a postback.
    
    Returns:
    true for a postback, false for a non-postback (GET) request.
    See Also:
    FacesContext.isPostback()
  - isValidationFailed
```
public static boolean isValidationFailed()
```
    Returns whether the validations phase of the current request has failed.
    
    Returns:
    true if the validations phase of the current request has failed, otherwise false.
    See Also:
    FacesContext.isValidationFailed()
  - getRequestParameterMap
```
public static Map<String,String> getRequestParameterMap()
```
    Returns the HTTP request parameter map.
    
    Returns:
    The HTTP request parameter map.
    See Also:
    ExternalContext.getRequestParameterMap()
  - getRequestParameter
```
public static String getRequestParameter(String name)
```
    Returns the HTTP request parameter value associated with the given name.
    
    Parameters:
    name - The HTTP request parameter name.
    
    Returns:
    The HTTP request parameter value associated with the given name.
    See Also:
    ExternalContext.getRequestParameterMap()
  - getRequestParameterValuesMap
```
public static Map<String,String[]> getRequestParameterValuesMap()
```
    Returns the HTTP request parameter values map.
    
    Returns:
    The HTTP request parameter values map.
    See Also:
    ExternalContext.getRequestParameterValuesMap()
  - getRequestParameterValues
```
public static String[] getRequestParameterValues(String name)
```
    Returns the HTTP request parameter values associated with the given name.
    
    Parameters:
    name - The HTTP request parameter name.
    
    Returns:
    The HTTP request parameter values associated with the given name.
    See Also:
    ExternalContext.getRequestParameterValuesMap()
  - getRequestHeaderMap
```
public static Map<String,String> getRequestHeaderMap()
```
    Returns the HTTP request header map.
    
    Returns:
    The HTTP request header map.
    See Also:
    ExternalContext.getRequestHeaderMap()
  - getRequestHeader
```
public static String getRequestHeader(String name)
```
    Returns the HTTP request header value associated with the given name.
    
    Parameters:
    name - The HTTP request header name.
    
    Returns:
    The HTTP request header value associated with the given name.
    See Also:
    ExternalContext.getRequestHeaderMap()
  - getRequestHeaderValuesMap
```
public static Map<String,String[]> getRequestHeaderValuesMap()
```
    Returns the HTTP request header values map.
    
    Returns:
    The HTTP request header values map.
    See Also:
    ExternalContext.getRequestHeaderValuesMap()
  - getRequestHeaderValues
```
public static String[] getRequestHeaderValues(String name)
```
    Returns the HTTP request header values associated with the given name.
    
    Parameters:
    name - The HTTP request header name.
    
    Returns:
    The HTTP request header values associated with the given name.
    See Also:
    ExternalContext.getRequestHeaderValuesMap()
  - getRequestContextPath
```
public static String getRequestContextPath()
```
    Returns the HTTP request context path. It's the webapp context name, with a leading slash. If the webapp runs on context root, then it returns an empty string.
    
    Returns:
    The HTTP request context path.
    See Also:
    ExternalContext.getRequestContextPath()
  - getRequestServletPath
```
public static String getRequestServletPath()
```
    Returns the HTTP request servlet path. If JSF is prefix mapped (e.g. /faces/*), then this returns the whole prefix mapping (e.g. /faces). If JSF is suffix mapped (e.g. *.xhtml), then this returns the whole part after the context path, with a leading slash.
    
    Returns:
    The HTTP request servlet path.
    See Also:
    ExternalContext.getRequestServletPath()
  - getRequestPathInfo
```
public static String getRequestPathInfo()
```
    Returns the HTTP request path info. If JSF is prefix mapped (e.g. /faces/*), then this returns the whole part after the prefix mapping, with a leading slash. If JSF is suffix mapped (e.g. *.xhtml), then this returns null.
    
    Returns:
    The HTTP request path info.
    See Also:
    ExternalContext.getRequestPathInfo()
  - getRequestBaseURL
```
public static String getRequestBaseURL()
```
    Returns the HTTP request base URL. This is the URL from the scheme, domain until with context path, including the trailing slash. This is the value you could use in HTML <base> tag.
    
    Returns:
    The HTTP request base URL.
    See Also:
    HttpServletRequest.getRequestURL(), HttpServletRequest.getRequestURI(), HttpServletRequest.getContextPath()
  - getRequestDomainURL
```
public static String getRequestDomainURL()
```
    Returns the HTTP request domain URL. This is the URL with the scheme and domain, without any trailing slash.
    
    Returns:
    The HTTP request domain URL.
    Since:
    
    1.1
    
    See Also:
    HttpServletRequest.getRequestURL(), HttpServletRequest.getRequestURI()
  - getRequestURL
```
public static String getRequestURL()
```
    Returns the HTTP request URL. This is the full request URL as the enduser sees in browser address bar. This does not include the request query string.
    
    Returns:
    The HTTP request URL.
    Since:
    
    1.1
    
    See Also:
    HttpServletRequest.getRequestURL()
  - getRequestURI
```
public static String getRequestURI()
```
    Returns the HTTP request URI. This is the part after the domain in the request URL, including the leading slash. This does not include the request query string.
    
    Returns:
    The HTTP request URI.
    Since:
    
    1.1
    
    See Also:
    HttpServletRequest.getRequestURI()
  - getRequestQueryString
```
public static String getRequestQueryString()
```
    Returns the HTTP request query string. This is the part after the ? in the request URL as the enduser sees in browser address bar.
    
    Returns:
    The HTTP request query string.
    Since:
    
    1.1
    
    See Also:
    HttpServletRequest.getQueryString()
  - getResponse
```
public static HttpServletResponse getResponse()
```
    Returns the HTTP servlet response.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The HTTP servlet response.
    See Also:
    ExternalContext.getResponse()
  - redirect
```
public static void redirect(String url)
                     throws IOException
```
    Sends a temporary (302) redirect to the given URL. If the given URL does not start with http://, https:// or /, then the request context path will be prepended, otherwise it will be the unmodified redirect URL.
    
    Parameters:
    url - The URL to redirect the current response to.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
    
    NullPointerException - When url is null.
    See Also:
    ExternalContext.redirect(String)
  - redirectPermanent
```
public static void redirectPermanent(String url)
                              throws IOException
```
    Sends a permanent (301) redirect to the given URL. If the given URL does not start with http://, https:// or /, then the request context path will be prepended, otherwise it will be the unmodified redirect URL.
    
    Parameters:
    url - The URL to redirect the current response to.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
    
    NullPointerException - When url is null.
    See Also:
    ExternalContext.setResponseStatus(int), ExternalContext.setResponseHeader(String, String)
  - responseSendError
```
public static void responseSendError(int status,
                     String message)
                              throws IOException
```
    Sends a HTTP response error with the given status and message. This will end up in either a custom <error-page> whose <error-code> matches the given status, or in a servlet container specific default error page if there is none. The message will be available in the error page as a request attribute with name javax.servlet.error.message. The FacesContext.responseComplete() will implicitly be called after sending the error.
    
    Parameters:
    status - The HTTP response status which is supposed to be in the range 4nn-5nn. You can use the constant field values of HttpServletResponse for this.
    message - The message which is supposed to be available in the error page.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
    See Also:
    ExternalContext.responseSendError(int, String)
  - addResponseHeader
```
public static void addResponseHeader(String name,
                     String value)
```
    Add a header with given name and value to the HTTP response.
    
    Parameters:
    name - The header name.
    value - The header value.
    See Also:
    ExternalContext.addResponseHeader(String, String)
  - isResponseCommitted
```
public static boolean isResponseCommitted()
```
    Returns whether the response is already committed. That is, when the response headers and a part of the response body has already been sent to the client. This is usually a point of no return and you can't change the response anymore.
    
    Returns:
    true if the response is already committed, otherwise false.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.isResponseCommitted()
  - responseReset
```
public static void responseReset()
```
    Resets the current response. This will clear any headers which are been set and any data which is written to the response buffer which isn't committed yet.
    
    Throws:
    
    IllegalStateException - When the response is already committed.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.responseReset()
  - login
```
public static void login(String username,
         String password)
                  throws ServletException
```
    Perform programmatic login for container managed FORM based authentication. Note that configuration is container specific and unrelated to JSF. Refer the documentation of the servletcontainer using the keyword "realm".
    
    Parameters:
    username - The login username.
    password - The login password.
    
    Throws:
    
    ServletException - When the login is invalid, or when container managed FORM based authentication is not enabled.
    See Also:
    HttpServletRequest.login(String, String)
  - logout
```
public static void logout()
                   throws ServletException
```
    Perform programmatic logout for container managed FORM based authentication. Note that this basically removes the user principal from the session. It's however better practice to just invalidate the session altogether, which will implicitly also remove the user principal. Just invoke invalidateSession() instead. Note that the user principal is still present in the response of the current request, it's therefore recommend to send a redirect after logout() or invalidateSession(). You can use redirect(String) for this.
    
    Throws:
    
    ServletException - When the logout has failed.
    See Also:
    HttpServletRequest.logout()
  - getRemoteUser
```
public static String getRemoteUser()
```
    Returns the name of the logged-in user for container managed FORM based authentication, if any.
    
    Returns:
    The name of the logged-in user for container managed FORM based authentication, if any.
    See Also:
    ExternalContext.getRemoteUser()
  - isUserInRole
```
public static boolean isUserInRole(String role)
```
    Returns whether the currently logged-in user has the given role.
    
    Parameters:
    role - The role to be checked on the currently logged-in user.
    
    Returns:
    true if the currently logged-in user has the given role, otherwise false.
    See Also:
    ExternalContext.isUserInRole(String)
  - getRequestCookie
```
public static String getRequestCookie(String name)
```
    Returns the value of the HTTP request cookie associated with the given name. The value is implicitly URL-decoded with a charset of UTF-8.
    
    Parameters:
    name - The HTTP request cookie name.
    
    Returns:
    The value of the HTTP request cookie associated with the given name.
    
    Throws:
    
    UnsupportedOperationException - If UTF-8 is not supported on this machine.
    See Also:
    ExternalContext.getRequestCookieMap()
  - addResponseCookie
```
public static void addResponseCookie(String name,
                     String value,
                     String path,
                     int maxAge)
```
    Add a cookie with given name, value, path and maxage to the HTTP response. The cookie value will implicitly be URL-encoded with UTF-8 so that any special characters can be stored in the cookie. The cookie will implicitly be set to secure when the current request is secure (i.e. when the current request is a HTTPS request).
    
    Parameters:
    name - The cookie name.
    value - The cookie value.
    path - The cookie path. If this is /, then the cookie is available in all pages of the webapp. If this is /somespecificpath, then the cookie is only available in pages under the specified path.
    maxAge - The maximum age of the cookie, in seconds. If this is 0, then the cookie will be removed. Note that the name and path must be exactly the same as it was when the cookie was created. If this is -1 then the cookie will become a session cookie and thus live as long as the established HTTP session.
    
    Throws:
    
    UnsupportedOperationException - If UTF-8 is not supported on this machine.
    See Also:
    ExternalContext.addResponseCookie(String, String, Map)
  - removeResponseCookie
```
public static void removeResponseCookie(String name,
                        String path)
```
    Remove the cookie with given name and path from the HTTP response. Note that the name and path must be exactly the same as it was when the cookie was created.
    
    Parameters:
    name - The cookie name.
    path - The cookie path.
    See Also:
    ExternalContext.addResponseCookie(String, String, Map)
  - getSession
```
public static HttpSession getSession()
```
    Returns the HTTP session and creates one if one doesn't exist.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The HTTP session.
    See Also:
    ExternalContext.getSession(boolean)
  - getSession
```
public static HttpSession getSession(boolean create)
```
    Returns the HTTP session and creates one if one doesn't exist and create argument is true, otherwise don't create one and return null.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    The HTTP session.
    See Also:
    ExternalContext.getSession(boolean)
  - invalidateSession
```
public static void invalidateSession()
```
    Invalidates the current HTTP session. So, any subsequent HTTP request will get a new one when necessary.
    
    See Also:
    ExternalContext.invalidateSession()
  - hasSession
```
public static boolean hasSession()
```
    Returns whether the HTTP session has already been created.
    
    Returns:
    true if the HTTP session has already been created, otherwise false.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getSession(boolean)
  - isSessionNew
```
public static boolean isSessionNew()
```
    Returns whether the HTTP session has been created for the first time in the current request. This returns also false when there is no means of a HTTP session.
    
    Returns:
    true if the HTTP session has been created for the first time in the current request, otherwise false.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getSession(boolean), HttpSession.isNew()
  - getSessionCreationTime
```
public static long getSessionCreationTime()
```
    Returns the time when the HTTP session was created, measured in epoch time. This implicitly creates the session if one doesn't exist.
    
    Returns:
    The time when the HTTP session was created.
    Since:
    
    1.1
    
    See Also:
    HttpSession.getCreationTime()
  - getSessionLastAccessedTime
```
public static long getSessionLastAccessedTime()
```
    Returns the time of the previous request associated with the current HTTP session, measured in epoch time. This implicitly creates the session if one doesn't exist.
    
    Returns:
    The time of the previous request associated with the current HTTP session.
    Since:
    
    1.1
    
    See Also:
    HttpSession.getLastAccessedTime()
  - getSessionMaxInactiveInterval
```
public static int getSessionMaxInactiveInterval()
```
    Returns the HTTP session timeout in seconds. This implicitly creates the session if one doesn't exist.
    
    Returns:
    The HTTP session timeout in seconds.
    Since:
    
    1.1
    
    See Also:
    HttpSession.getMaxInactiveInterval()
  - setSessionMaxInactiveInterval
```
public static void setSessionMaxInactiveInterval(int seconds)
```
    Sets the HTTP session timeout in seconds. A value of 0 or less means that the session should never timeout. This implicitly creates the session if one doesn't exist.
    
    Parameters:
    seconds - The HTTP session timeout in seconds.
    Since:
    
    1.1
    
    See Also:
    HttpSession.setMaxInactiveInterval(int)
  - hasSessionTimedOut
```
public static boolean hasSessionTimedOut()
```
    Returns whether the HTTP session has been timed out for the current request. This is helpful if you need to distinguish between a first-time request on a fresh session and a first-time request on a timed out session, for example to display "Oops, you have been logged out because your session has been timed out!".
    
    Returns:
    true if the HTTP session has been timed out for the current request, otherwise false.
    Since:
    
    1.1
    
    See Also:
    HttpServletRequest.getRequestedSessionId(), HttpServletRequest.isRequestedSessionIdValid()
  - getServletContext
```
public static ServletContext getServletContext()
```
    Returns the servlet context.
    Note that whenever you absolutely need this method to perform a general task, you might want to consider to submit a feature request to OmniFaces in order to add a new utility method which performs exactly this general task.
    
    Returns:
    the servlet context.
    See Also:
    ExternalContext.getContext()
  - getInitParameterMap
```
public static Map<String,String> getInitParameterMap()
```
    Returns the application initialization parameter map. This returns the parameter name-value pairs of all <context-param> entries in in web.xml.
    
    Returns:
    The application initialization parameter map.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getInitParameterMap()
  - getInitParameter
```
public static String getInitParameter(String name)
```
    Returns the application initialization parameter. This returns the <param-value> of a <context-param> in web.xml associated with the given <param-name>.
    
    Parameters:
    name - The application initialization parameter name.
    
    Returns:
    The application initialization parameter value associated with the given name.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getInitParameter(String)
  - getMimeType
```
public static String getMimeType(String name)
```
    Returns the mime type for the given file name. The mime type is determined based on file extension and configureable by <mime-mapping> entries in web.xml. When the mime type is unknown, then a default of application/octet-stream will be returned.
    
    Parameters:
    name - The file name to return the mime type for.
    
    Returns:
    The mime type for the given file name.
    See Also:
    ExternalContext.getMimeType(String)
  - getResourceAsStream
```
public static InputStream getResourceAsStream(String path)
```
    Returns an input stream for an application resource mapped to the specified path, if it exists; otherwise, return null.
    
    Parameters:
    path - The application resource path to return an input stream for.
    
    Returns:
    An input stream for an application resource mapped to the specified path.
    See Also:
    ExternalContext.getResourceAsStream(String)
  - getResourcePaths
```
public static Set<String> getResourcePaths(String path)
```
    Returns a set of available application resource paths matching the specified path.
    
    Parameters:
    path - The partial application resource path used to return matching resource paths.
    
    Returns:
    A set of available application resource paths matching the specified path.
    See Also:
    ExternalContext.getResourcePaths(String)
  - getRequestMap
```
public static Map<String,Object> getRequestMap()
```
    Returns the request scope map.
    
    Returns:
    The request scope map.
    See Also:
    ExternalContext.getRequestMap()
  - getRequestAttribute
```
public static <T> T getRequestAttribute(String name)
```
    Returns the request scope attribute value associated with the given name.
    
    Parameters:
    name - The request scope attribute name.
    
    Returns:
    The request scope attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    ExternalContext.getRequestMap()
  - setRequestAttribute
```
public static void setRequestAttribute(String name,
                       Object value)
```
    Sets the request scope attribute value associated with the given name.
    
    Parameters:
    name - The request scope attribute name.
    value - The request scope attribute value.
    See Also:
    ExternalContext.getRequestMap()
  - removeRequestAttribute
```
public static <T> T removeRequestAttribute(String name)
```
    Removes the request scope attribute value associated with the given name.
    
    Parameters:
    name - The request scope attribute name.
    
    Returns:
    The request scope attribute value previously associated with the given name, or null if there is no such attribute.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getRequestMap()
  - getFlash
```
public static Flash getFlash()
```
    Returns the flash scope. Note that Flash implements Map<String, Object>, so you can just treat it like a Map<String, Object>.
    
    Returns:
    The flash scope.
    See Also:
    ExternalContext.getFlash()
  - getFlashAttribute
```
public static <T> T getFlashAttribute(String name)
```
    Returns the flash scope attribute value associated with the given name.
    
    Parameters:
    name - The flash scope attribute name.
    
    Returns:
    The flash scope attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    ExternalContext.getFlash()
  - setFlashAttribute
```
public static void setFlashAttribute(String name,
                     Object value)
```
    Sets the flash scope attribute value associated with the given name.
    
    Parameters:
    name - The flash scope attribute name.
    value - The flash scope attribute value.
    See Also:
    ExternalContext.getFlash()
  - removeFlashAttribute
```
public static <T> T removeFlashAttribute(String name)
```
    Removes the flash scope attribute value associated with the given name.
    
    Parameters:
    name - The flash scope attribute name.
    
    Returns:
    The flash scope attribute value previously associated with the given name, or null if there is no such attribute.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getFlash()
  - getViewMap
```
public static Map<String,Object> getViewMap()
```
    Returns the view scope map.
    
    Returns:
    The view scope map.
    See Also:
    UIViewRoot.getViewMap()
  - getViewAttribute
```
public static <T> T getViewAttribute(String name)
```
    Returns the view scope attribute value associated with the given name.
    
    Parameters:
    name - The view scope attribute name.
    
    Returns:
    The view scope attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    UIViewRoot.getViewMap()
  - setViewAttribute
```
public static void setViewAttribute(String name,
                    Object value)
```
    Sets the view scope attribute value associated with the given name.
    
    Parameters:
    name - The view scope attribute name.
    value - The view scope attribute value.
    See Also:
    UIViewRoot.getViewMap()
  - removeViewAttribute
```
public static <T> T removeViewAttribute(String name)
```
    Removes the view scope attribute value associated with the given name.
    
    Parameters:
    name - The view scope attribute name.
    
    Returns:
    The view scope attribute value previously associated with the given name, or null if there is no such attribute.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    UIViewRoot.getViewMap()
  - getSessionMap
```
public static Map<String,Object> getSessionMap()
```
    Returns the session scope map.
    
    Returns:
    The session scope map.
    See Also:
    ExternalContext.getSessionMap()
  - getSessionAttribute
```
public static <T> T getSessionAttribute(String name)
```
    Returns the session scope attribute value associated with the given name.
    
    Parameters:
    name - The session scope attribute name.
    
    Returns:
    The session scope attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    ExternalContext.getSessionMap()
  - setSessionAttribute
```
public static void setSessionAttribute(String name,
                       Object value)
```
    Sets the session scope attribute value associated with the given name.
    
    Parameters:
    name - The session scope attribute name.
    value - The session scope attribute value.
    See Also:
    ExternalContext.getSessionMap()
  - removeSessionAttribute
```
public static <T> T removeSessionAttribute(String name)
```
    Removes the session scope attribute value associated with the given name.
    
    Parameters:
    name - The session scope attribute name.
    
    Returns:
    The session scope attribute value previously associated with the given name, or null if there is no such attribute.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getSessionMap()
  - getApplicationMap
```
public static Map<String,Object> getApplicationMap()
```
    Returns the application scope map.
    
    Returns:
    The application scope map.
    See Also:
    ExternalContext.getApplicationMap()
  - getApplicationAttribute
```
public static <T> T getApplicationAttribute(String name)
```
    Returns the application scope attribute value associated with the given name.
    
    Parameters:
    name - The application scope attribute name.
    
    Returns:
    The application scope attribute value associated with the given name.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    See Also:
    ExternalContext.getApplicationMap()
  - setApplicationAttribute
```
public static void setApplicationAttribute(String name,
                           Object value)
```
    Sets the application scope attribute value associated with the given name.
    
    Parameters:
    name - The application scope attribute name.
    value - The application scope attribute value.
    See Also:
    ExternalContext.getApplicationMap()
  - removeApplicationAttribute
```
public static <T> T removeApplicationAttribute(String name)
```
    Removes the application scope attribute value associated with the given name.
    
    Parameters:
    name - The application scope attribute name.
    
    Returns:
    The application scope attribute value previously associated with the given name, or null if there is no such attribute.
    
    Throws:
    
    ClassCastException - When T is of wrong type.
    Since:
    
    1.1
    
    See Also:
    ExternalContext.getApplicationMap()
  - sendFile
```
public static void sendFile(File file,
            boolean attachment)
                     throws IOException
```
    Send the given file to the response. The content type will be determined based on file name. The content length will be set to the length of the file. The FacesContext.responseComplete() will implicitly be called after successful streaming.
    
    Parameters:
    file - The file to be sent to the response.
    attachment - Whether the file should be provided as attachment, or just inline.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
  - sendFile
```
public static void sendFile(byte[] content,
            String filename,
            boolean attachment)
                     throws IOException
```
    Send the given byte array as a file to the response. The content type will be determined based on file name. The content length will be set to the length of the byte array. The FacesContext.responseComplete() will implicitly be called after successful streaming.
    
    Parameters:
    content - The file content as byte array.
    filename - The file name which should appear in content disposition header.
    attachment - Whether the file should be provided as attachment, or just inline.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.
  - sendFile
```
public static void sendFile(InputStream content,
            String filename,
            boolean attachment)
                     throws IOException
```
    Send the given input stream as a file to the response. The content type will be determined based on file name. The content length may not be set because that's not predictable based on input stream. The client may receive a download of an unknown length and thus the download progress may be unknown to the client. Only if the input stream is smaller than the default buffer size, then the content length will be set. The InputStream.close() will implicitly be called after streaming, regardless of whether an exception is been thrown or not. The FacesContext.responseComplete() will implicitly be called after successful streaming.
    
    Parameters:
    content - The file content as input stream.
    filename - The file name which should appear in content disposition header.
    attachment - Whether the file should be provided as attachment, or just inline.
    
    Throws:
    
    IOException - Whenever something fails at I/O level. The caller should preferably not catch it, but just redeclare it in the action method. The servletcontainer will handle it.

Class Faces

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getContext

getExternalContext

getPartialViewContext

getApplication

getImplInfo

getServerInfo

isDevelopment

getMapping

isPrefixMapping

isPrefixMapping

getCurrentPhaseId

evaluateExpressionGet

evaluateExpressionSet

getViewRoot

setViewRoot

getViewId

normalizeViewId

getViewParameters

getLocale

getDefaultLocale

getSupportedLocales

navigate

addRenderIds

getFaceletContext

includeFacelet

getFaceletAttribute

setFaceletAttribute

getRequest

isAjaxRequest

isPostback

isValidationFailed

getRequestParameterMap

getRequestParameter

getRequestParameterValuesMap

getRequestParameterValues

getRequestHeaderMap

getRequestHeader

getRequestHeaderValuesMap

getRequestHeaderValues

getRequestContextPath

getRequestServletPath

getRequestPathInfo

getRequestBaseURL

getRequestDomainURL

getRequestURL

getRequestURI

getRequestQueryString

getResponse

redirect

redirectPermanent

responseSendError

addResponseHeader

isResponseCommitted

responseReset

login

logout

getRemoteUser

isUserInRole

getRequestCookie

addResponseCookie

removeResponseCookie

getSession

getSession

invalidateSession

hasSession

isSessionNew

getSessionCreationTime

getSessionLastAccessedTime

getSessionMaxInactiveInterval

setSessionMaxInactiveInterval

hasSessionTimedOut

getServletContext

getInitParameterMap

getInitParameter

getMimeType

getResourceAsStream