public final class FacesLocal extends Object
FacesContext
argument. In effect, it 'flattens' the hierarchy of nested objects.
The difference with Faces
is that no one method of FacesLocal
obtains the FacesContext
from
the current thread by FacesContext.getCurrentInstance()
. This job is up to the caller.
Note that methods which are directly available on FacesContext
instance itself, such as
getExternalContext()
, getViewRoot()
, isValidationFailed()
, etc are not
delegated by the current utility class, because it would design technically not make any sense to delegate a
single-depth method call like
ExternalContext externalContext = FacesLocal.getExternalContext(facesContext);
instead of just calling it directly
ExternalContext externalContext = facesContext.getExternalContext();
Modifier and Type | Method and Description |
---|---|
static void |
addResponseCookie(javax.faces.context.FacesContext context,
String name,
String value,
int maxAge) |
static void |
addResponseCookie(javax.faces.context.FacesContext context,
String name,
String value,
String path,
int maxAge) |
static void |
addResponseCookie(javax.faces.context.FacesContext context,
String name,
String value,
String domain,
String path,
int maxAge) |
static void |
addResponseHeader(javax.faces.context.FacesContext context,
String name,
String value) |
static boolean |
authenticate(javax.faces.context.FacesContext context) |
static <T> T |
evaluateExpressionGet(javax.faces.context.FacesContext context,
String expression) |
static void |
evaluateExpressionSet(javax.faces.context.FacesContext context,
String expression,
Object value) |
static <T> T |
getApplicationAttribute(javax.faces.context.FacesContext context,
String name) |
static Map<String,Object> |
getApplicationMap(javax.faces.context.FacesContext context) |
static String |
getBookmarkableURL(javax.faces.context.FacesContext context,
Collection<ParamHolder> params,
boolean includeViewParams) |
static String |
getBookmarkableURL(javax.faces.context.FacesContext context,
Map<String,List<String>> params,
boolean includeViewParams) |
static String |
getBookmarkableURL(javax.faces.context.FacesContext context,
String viewId,
Collection<ParamHolder> params,
boolean includeViewParams) |
static String |
getBookmarkableURL(javax.faces.context.FacesContext context,
String viewId,
Map<String,List<String>> params,
boolean includeViewParams) |
static <T> T |
getContextAttribute(javax.faces.context.FacesContext context,
String name) |
static Locale |
getDefaultLocale(javax.faces.context.FacesContext context) |
static <T> T |
getFaceletAttribute(javax.faces.context.FacesContext context,
String name) |
static javax.faces.view.facelets.FaceletContext |
getFaceletContext(javax.faces.context.FacesContext context) |
static javax.faces.context.Flash |
getFlash(javax.faces.context.FacesContext context) |
static <T> T |
getFlashAttribute(javax.faces.context.FacesContext context,
String name) |
static String |
getForwardRequestQueryString(javax.faces.context.FacesContext context) |
static String |
getForwardRequestURI(javax.faces.context.FacesContext context) |
static String |
getForwardRequestURIWithQueryString(javax.faces.context.FacesContext context) |
static String |
getInitParameter(javax.faces.context.FacesContext context,
String name) |
static Map<String,String> |
getInitParameterMap(javax.faces.context.FacesContext context) |
static Locale |
getLocale(javax.faces.context.FacesContext context) |
static String |
getMapping(javax.faces.context.FacesContext context) |
static ResourceBundle |
getMessageBundle(javax.faces.context.FacesContext context) |
static <T> T |
getMetadataAttribute(javax.faces.context.FacesContext context,
String name) |
static <T> T |
getMetadataAttribute(javax.faces.context.FacesContext context,
String viewId,
String name) |
static Map<String,Object> |
getMetadataAttributes(javax.faces.context.FacesContext context,
String viewId) |
static String |
getMimeType(javax.faces.context.FacesContext context,
String name) |
static String |
getRealPath(javax.faces.context.FacesContext context,
String webContentPath) |
static String |
getRemoteAddr(javax.faces.context.FacesContext context) |
static String |
getRemoteUser(javax.faces.context.FacesContext context) |
static javax.servlet.http.HttpServletRequest |
getRequest(javax.faces.context.FacesContext context) |
static <T> T |
getRequestAttribute(javax.faces.context.FacesContext context,
String name) |
static String |
getRequestBaseURL(javax.faces.context.FacesContext context) |
static String |
getRequestContextPath(javax.faces.context.FacesContext context) |
static String |
getRequestCookie(javax.faces.context.FacesContext context,
String name) |
static String |
getRequestDomainURL(javax.faces.context.FacesContext context) |
static String |
getRequestHeader(javax.faces.context.FacesContext context,
String name) |
static Map<String,String> |
getRequestHeaderMap(javax.faces.context.FacesContext context) |
static String[] |
getRequestHeaderValues(javax.faces.context.FacesContext context,
String name) |
static Map<String,String[]> |
getRequestHeaderValuesMap(javax.faces.context.FacesContext context) |
static String |
getRequestHostname(javax.faces.context.FacesContext context) |
static Map<String,Object> |
getRequestMap(javax.faces.context.FacesContext context) |
static String |
getRequestParameter(javax.faces.context.FacesContext context,
String name) |
static Map<String,String> |
getRequestParameterMap(javax.faces.context.FacesContext context) |
static String[] |
getRequestParameterValues(javax.faces.context.FacesContext context,
String name) |
static Map<String,String[]> |
getRequestParameterValuesMap(javax.faces.context.FacesContext context) |
static String |
getRequestPathInfo(javax.faces.context.FacesContext context) |
static String |
getRequestQueryString(javax.faces.context.FacesContext context) |
static Map<String,List<String>> |
getRequestQueryStringMap(javax.faces.context.FacesContext context) |
static String |
getRequestServletPath(javax.faces.context.FacesContext context) |
static String |
getRequestURI(javax.faces.context.FacesContext context) |
static String |
getRequestURIWithQueryString(javax.faces.context.FacesContext context) |
static String |
getRequestURL(javax.faces.context.FacesContext context) |
static String |
getRequestURLWithQueryString(javax.faces.context.FacesContext context) |
static URL |
getResource(javax.faces.context.FacesContext context,
String path) |
static InputStream |
getResourceAsStream(javax.faces.context.FacesContext context,
String path) |
static Set<String> |
getResourcePaths(javax.faces.context.FacesContext context,
String path) |
static javax.servlet.http.HttpServletResponse |
getResponse(javax.faces.context.FacesContext context) |
static int |
getResponseBufferSize(javax.faces.context.FacesContext context) |
static String |
getResponseCharacterEncoding(javax.faces.context.FacesContext context) |
static String |
getServerInfo(javax.faces.context.FacesContext context) |
static javax.servlet.ServletContext |
getServletContext(javax.faces.context.FacesContext context) |
static javax.servlet.http.HttpSession |
getSession(javax.faces.context.FacesContext context) |
static javax.servlet.http.HttpSession |
getSession(javax.faces.context.FacesContext context,
boolean create) |
static <T> T |
getSessionAttribute(javax.faces.context.FacesContext context,
String name) |
static long |
getSessionCreationTime(javax.faces.context.FacesContext context) |
static String |
getSessionId(javax.faces.context.FacesContext context) |
static long |
getSessionLastAccessedTime(javax.faces.context.FacesContext context) |
static Map<String,Object> |
getSessionMap(javax.faces.context.FacesContext context) |
static int |
getSessionMaxInactiveInterval(javax.faces.context.FacesContext context) |
static List<Locale> |
getSupportedLocales(javax.faces.context.FacesContext context) |
static <T> T |
getViewAttribute(javax.faces.context.FacesContext context,
String name) |
static javax.faces.view.ViewDeclarationLanguage |
getViewDeclarationLanguage(javax.faces.context.FacesContext context) |
static String |
getViewId(javax.faces.context.FacesContext context) |
static Map<String,Object> |
getViewMap(javax.faces.context.FacesContext context) |
static Map<String,List<String>> |
getViewParameterMap(javax.faces.context.FacesContext context) |
static Collection<javax.faces.component.UIViewParameter> |
getViewParameters(javax.faces.context.FacesContext context) |
static boolean |
hasSession(javax.faces.context.FacesContext context) |
static boolean |
hasSessionTimedOut(javax.faces.context.FacesContext context) |
static void |
invalidateSession(javax.faces.context.FacesContext context) |
static boolean |
isAjaxRequest(javax.faces.context.FacesContext context) |
static boolean |
isDevelopment(javax.faces.context.FacesContext context) |
static boolean |
isPrefixMapping(javax.faces.context.FacesContext context) |
static boolean |
isRenderResponse(javax.faces.context.FacesContext context) |
static boolean |
isResponseCommitted(javax.faces.context.FacesContext context) |
static boolean |
isSessionNew(javax.faces.context.FacesContext context) |
static boolean |
isUserInRole(javax.faces.context.FacesContext context,
String role) |
static void |
login(javax.faces.context.FacesContext context,
String username,
String password) |
static void |
logout(javax.faces.context.FacesContext context) |
static void |
navigate(javax.faces.context.FacesContext context,
String outcome) |
static String |
normalizeViewId(javax.faces.context.FacesContext context,
String path) |
static void |
redirect(javax.faces.context.FacesContext context,
String url,
String... paramValues) |
static void |
redirectPermanent(javax.faces.context.FacesContext context,
String url,
String... paramValues) |
static <T> T |
removeApplicationAttribute(javax.faces.context.FacesContext context,
String name) |
static <T> T |
removeFlashAttribute(javax.faces.context.FacesContext context,
String name) |
static <T> T |
removeRequestAttribute(javax.faces.context.FacesContext context,
String name) |
static void |
removeResponseCookie(javax.faces.context.FacesContext context,
String name,
String path) |
static <T> T |
removeSessionAttribute(javax.faces.context.FacesContext context,
String name) |
static <T> T |
removeViewAttribute(javax.faces.context.FacesContext context,
String name) |
static void |
responseReset(javax.faces.context.FacesContext context) |
static void |
responseSendError(javax.faces.context.FacesContext context,
int status,
String message) |
static void |
sendFile(javax.faces.context.FacesContext context,
byte[] content,
String filename,
boolean attachment) |
static void |
sendFile(javax.faces.context.FacesContext context,
File file,
boolean attachment) |
static void |
sendFile(javax.faces.context.FacesContext context,
InputStream content,
String filename,
boolean attachment) |
static void |
setApplicationAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setContextAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setFaceletAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setFlashAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setLocale(javax.faces.context.FacesContext context,
Locale locale) |
static void |
setRequestAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setResponseStatus(javax.faces.context.FacesContext context,
int status) |
static void |
setSessionAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setSessionMaxInactiveInterval(javax.faces.context.FacesContext context,
int seconds) |
static void |
setViewAttribute(javax.faces.context.FacesContext context,
String name,
Object value) |
static void |
setViewRoot(javax.faces.context.FacesContext context,
String viewId) |
public static String getServerInfo(javax.faces.context.FacesContext context)
Faces.getServerInfo()
public static boolean isDevelopment(javax.faces.context.FacesContext context)
Faces.isDevelopment()
public static String getMapping(javax.faces.context.FacesContext context)
Faces.getMapping()
public static boolean isPrefixMapping(javax.faces.context.FacesContext context)
Faces.isPrefixMapping()
public static <T> T evaluateExpressionGet(javax.faces.context.FacesContext context, String expression)
Faces.evaluateExpressionGet(String)
public static void evaluateExpressionSet(javax.faces.context.FacesContext context, String expression, Object value)
public static <T> T getContextAttribute(javax.faces.context.FacesContext context, String name)
Faces.getContextAttribute(String)
public static void setContextAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static void setViewRoot(javax.faces.context.FacesContext context, String viewId)
Faces.setViewRoot(String)
public static String getViewId(javax.faces.context.FacesContext context)
Faces.getViewId()
public static javax.faces.view.ViewDeclarationLanguage getViewDeclarationLanguage(javax.faces.context.FacesContext context)
Faces.getViewDeclarationLanguage()
public static String normalizeViewId(javax.faces.context.FacesContext context, String path)
Faces.normalizeViewId(String)
public static Collection<javax.faces.component.UIViewParameter> getViewParameters(javax.faces.context.FacesContext context)
Faces.getViewParameters()
public static Map<String,List<String>> getViewParameterMap(javax.faces.context.FacesContext context)
Faces.getViewParameterMap()
public static Map<String,Object> getMetadataAttributes(javax.faces.context.FacesContext context, String viewId)
Faces.getMetadataAttributes(String)
public static <T> T getMetadataAttribute(javax.faces.context.FacesContext context, String viewId, String name)
public static <T> T getMetadataAttribute(javax.faces.context.FacesContext context, String name)
Faces.getMetadataAttribute(String)
public static Locale getLocale(javax.faces.context.FacesContext context)
Faces.getLocale()
public static Locale getDefaultLocale(javax.faces.context.FacesContext context)
Faces.getDefaultLocale()
public static List<Locale> getSupportedLocales(javax.faces.context.FacesContext context)
Faces.getSupportedLocales()
public static void setLocale(javax.faces.context.FacesContext context, Locale locale)
Faces.setLocale(Locale)
public static ResourceBundle getMessageBundle(javax.faces.context.FacesContext context)
Faces.getMessageBundle()
public static void navigate(javax.faces.context.FacesContext context, String outcome)
Faces.navigate(String)
public static String getBookmarkableURL(javax.faces.context.FacesContext context, Map<String,List<String>> params, boolean includeViewParams)
public static String getBookmarkableURL(javax.faces.context.FacesContext context, String viewId, Map<String,List<String>> params, boolean includeViewParams)
public static String getBookmarkableURL(javax.faces.context.FacesContext context, Collection<ParamHolder> params, boolean includeViewParams)
public static String getBookmarkableURL(javax.faces.context.FacesContext context, String viewId, Collection<ParamHolder> params, boolean includeViewParams)
public static javax.faces.view.facelets.FaceletContext getFaceletContext(javax.faces.context.FacesContext context)
Faces.getFaceletContext()
public static <T> T getFaceletAttribute(javax.faces.context.FacesContext context, String name)
Faces.getFaceletAttribute(String)
public static void setFaceletAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static javax.servlet.http.HttpServletRequest getRequest(javax.faces.context.FacesContext context)
Faces.getRequest()
public static boolean isAjaxRequest(javax.faces.context.FacesContext context)
Faces.isAjaxRequest()
public static Map<String,String> getRequestParameterMap(javax.faces.context.FacesContext context)
Faces.getRequestParameterMap()
public static String getRequestParameter(javax.faces.context.FacesContext context, String name)
Faces.getRequestParameter(String)
public static Map<String,String[]> getRequestParameterValuesMap(javax.faces.context.FacesContext context)
Faces.getRequestParameterValuesMap()
public static String[] getRequestParameterValues(javax.faces.context.FacesContext context, String name)
public static Map<String,String> getRequestHeaderMap(javax.faces.context.FacesContext context)
Faces.getRequestHeaderMap()
public static String getRequestHeader(javax.faces.context.FacesContext context, String name)
Faces.getRequestHeader(String)
public static Map<String,String[]> getRequestHeaderValuesMap(javax.faces.context.FacesContext context)
Faces.getRequestHeaderValuesMap()
public static String[] getRequestHeaderValues(javax.faces.context.FacesContext context, String name)
Faces.getRequestHeaderValues(String)
public static String getRequestContextPath(javax.faces.context.FacesContext context)
Faces.getRequestContextPath()
public static String getRequestServletPath(javax.faces.context.FacesContext context)
Faces.getRequestServletPath()
public static String getRequestPathInfo(javax.faces.context.FacesContext context)
Faces.getRequestPathInfo()
public static String getRequestHostname(javax.faces.context.FacesContext context)
Faces.getRequestHostname()
public static String getRequestBaseURL(javax.faces.context.FacesContext context)
Faces.getRequestBaseURL()
public static String getRequestDomainURL(javax.faces.context.FacesContext context)
Faces.getRequestDomainURL()
public static String getRequestURL(javax.faces.context.FacesContext context)
Faces.getRequestURL()
public static String getRequestURI(javax.faces.context.FacesContext context)
Faces.getRequestURI()
public static String getRequestQueryString(javax.faces.context.FacesContext context)
Faces.getRequestQueryString()
public static Map<String,List<String>> getRequestQueryStringMap(javax.faces.context.FacesContext context)
Faces.getRequestQueryStringMap()
public static String getRequestURLWithQueryString(javax.faces.context.FacesContext context)
Faces.getRequestURLWithQueryString()
public static String getRequestURIWithQueryString(javax.faces.context.FacesContext context)
Faces.getRequestURIWithQueryString()
public static String getForwardRequestURI(javax.faces.context.FacesContext context)
Faces.getForwardRequestURI()
public static String getForwardRequestQueryString(javax.faces.context.FacesContext context)
Faces.getForwardRequestQueryString()
public static String getForwardRequestURIWithQueryString(javax.faces.context.FacesContext context)
public static String getRemoteAddr(javax.faces.context.FacesContext context)
Faces.getRemoteAddr()
public static javax.servlet.http.HttpServletResponse getResponse(javax.faces.context.FacesContext context)
Faces.getResponse()
public static int getResponseBufferSize(javax.faces.context.FacesContext context)
Faces.getResponseBufferSize()
public static String getResponseCharacterEncoding(javax.faces.context.FacesContext context)
Faces.getResponseCharacterEncoding()
public static void setResponseStatus(javax.faces.context.FacesContext context, int status)
Faces.setResponseStatus(int)
public static void redirect(javax.faces.context.FacesContext context, String url, String... paramValues) throws IOException
IOException
Faces.redirect(String, String...)
public static void redirectPermanent(javax.faces.context.FacesContext context, String url, String... paramValues)
public static void responseSendError(javax.faces.context.FacesContext context, int status, String message) throws IOException
IOException
Faces.responseSendError(int, String)
public static void addResponseHeader(javax.faces.context.FacesContext context, String name, String value)
public static boolean isResponseCommitted(javax.faces.context.FacesContext context)
Faces.isResponseCommitted()
public static void responseReset(javax.faces.context.FacesContext context)
Faces.responseReset()
public static boolean isRenderResponse(javax.faces.context.FacesContext context)
Faces.isRenderResponse()
public static void login(javax.faces.context.FacesContext context, String username, String password) throws javax.servlet.ServletException
javax.servlet.ServletException
Faces.login(String, String)
public static boolean authenticate(javax.faces.context.FacesContext context) throws javax.servlet.ServletException, IOException
javax.servlet.ServletException
IOException
Faces.authenticate()
public static void logout(javax.faces.context.FacesContext context) throws javax.servlet.ServletException
javax.servlet.ServletException
Faces.logout()
public static String getRemoteUser(javax.faces.context.FacesContext context)
Faces.getRemoteUser()
public static boolean isUserInRole(javax.faces.context.FacesContext context, String role)
Faces.isUserInRole(String)
public static String getRequestCookie(javax.faces.context.FacesContext context, String name)
Faces.getRequestCookie(String)
public static void addResponseCookie(javax.faces.context.FacesContext context, String name, String value, int maxAge)
public static void addResponseCookie(javax.faces.context.FacesContext context, String name, String value, String path, int maxAge)
public static void addResponseCookie(javax.faces.context.FacesContext context, String name, String value, String domain, String path, int maxAge)
public static void removeResponseCookie(javax.faces.context.FacesContext context, String name, String path)
public static javax.servlet.http.HttpSession getSession(javax.faces.context.FacesContext context)
Faces.getSession()
public static javax.servlet.http.HttpSession getSession(javax.faces.context.FacesContext context, boolean create)
Faces.getSession(boolean)
public static String getSessionId(javax.faces.context.FacesContext context)
Faces.getSessionId()
public static void invalidateSession(javax.faces.context.FacesContext context)
Faces.invalidateSession()
public static boolean hasSession(javax.faces.context.FacesContext context)
Faces.hasSession()
public static boolean isSessionNew(javax.faces.context.FacesContext context)
Faces.isSessionNew()
public static long getSessionCreationTime(javax.faces.context.FacesContext context)
Faces.getSessionCreationTime()
public static long getSessionLastAccessedTime(javax.faces.context.FacesContext context)
Faces.getSessionLastAccessedTime()
public static int getSessionMaxInactiveInterval(javax.faces.context.FacesContext context)
public static void setSessionMaxInactiveInterval(javax.faces.context.FacesContext context, int seconds)
public static boolean hasSessionTimedOut(javax.faces.context.FacesContext context)
Faces.hasSessionTimedOut()
public static javax.servlet.ServletContext getServletContext(javax.faces.context.FacesContext context)
Faces.getServletContext()
public static Map<String,String> getInitParameterMap(javax.faces.context.FacesContext context)
Faces.getInitParameterMap()
public static String getInitParameter(javax.faces.context.FacesContext context, String name)
Faces.getInitParameter(String)
public static String getMimeType(javax.faces.context.FacesContext context, String name)
Faces.getMimeType(String)
public static URL getResource(javax.faces.context.FacesContext context, String path) throws MalformedURLException
MalformedURLException
Faces.getResource(String)
public static InputStream getResourceAsStream(javax.faces.context.FacesContext context, String path)
Faces.getResourceAsStream(String)
public static Set<String> getResourcePaths(javax.faces.context.FacesContext context, String path)
Faces.getResourcePaths(String)
public static String getRealPath(javax.faces.context.FacesContext context, String webContentPath)
Faces.getRealPath(String)
public static Map<String,Object> getRequestMap(javax.faces.context.FacesContext context)
Faces.getRequestMap()
public static <T> T getRequestAttribute(javax.faces.context.FacesContext context, String name)
Faces.getRequestAttribute(String)
public static void setRequestAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static <T> T removeRequestAttribute(javax.faces.context.FacesContext context, String name)
Faces.removeRequestAttribute(String)
public static javax.faces.context.Flash getFlash(javax.faces.context.FacesContext context)
Faces.getFlash()
public static <T> T getFlashAttribute(javax.faces.context.FacesContext context, String name)
Faces.getFlashAttribute(String)
public static void setFlashAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static <T> T removeFlashAttribute(javax.faces.context.FacesContext context, String name)
Faces.removeFlashAttribute(String)
public static Map<String,Object> getViewMap(javax.faces.context.FacesContext context)
Faces.getViewMap()
public static <T> T getViewAttribute(javax.faces.context.FacesContext context, String name)
Faces.getViewAttribute(String)
public static void setViewAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static <T> T removeViewAttribute(javax.faces.context.FacesContext context, String name)
Faces.removeViewAttribute(String)
public static Map<String,Object> getSessionMap(javax.faces.context.FacesContext context)
Faces.getSessionMap()
public static <T> T getSessionAttribute(javax.faces.context.FacesContext context, String name)
Faces.getSessionAttribute(String)
public static void setSessionAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static <T> T removeSessionAttribute(javax.faces.context.FacesContext context, String name)
Faces.removeSessionAttribute(String)
public static Map<String,Object> getApplicationMap(javax.faces.context.FacesContext context)
Faces.getApplicationMap()
public static <T> T getApplicationAttribute(javax.faces.context.FacesContext context, String name)
public static void setApplicationAttribute(javax.faces.context.FacesContext context, String name, Object value)
public static <T> T removeApplicationAttribute(javax.faces.context.FacesContext context, String name)
public static void sendFile(javax.faces.context.FacesContext context, File file, boolean attachment) throws IOException
IOException
Faces.sendFile(File, boolean)
public static void sendFile(javax.faces.context.FacesContext context, byte[] content, String filename, boolean attachment) throws IOException
IOException
Faces.sendFile(byte[], String, boolean)
public static void sendFile(javax.faces.context.FacesContext context, InputStream content, String filename, boolean attachment) throws IOException
IOException
Faces.sendFile(InputStream, String, boolean)
Copyright © 2012–2014 OmniFaces. All rights reserved.