org.omnifaces.facesviews

Class FacesViewsUtils

java.lang.Object

org.omnifaces.facesviews.FacesViewsUtils

public final class FacesViewsUtils
extends Object

Collection of utilities for working with auto-scanned- and extensionless views.

Author:

Arjan Tijms

Field Summary

Fields

Modifier and Type	Field and Description
static String	WEB_INF_VIEWS

Method Summary

Methods

Modifier and Type	Method and Description
static Application	getApplication() Gets the JSF Application instance.
static <T> T	getApplicationAttribute(FacesContext context, String name)
static <T> T	getApplicationAttribute(ServletContext context, String name)
static String	getExtension(String resource) Gets the extension of a resource if any.
static ServletRegistration	getFacesServletRegistration(ServletContext servletContext) Gets the ServletRegistration associated with the FacesServlet.
static <T> T	getRequestAttribute(FacesContext context, String name)
static boolean	isDirectory(String resourcePath) Checks if the given resource path obtained from ServletContext.getResourcePaths(String) represents a directory.
static boolean	isExtensionless(String viewId)
static Map<String,String>	scanAndStoreViews(ServletContext context) Scans for faces-views resources and stores the result at the designated location "org.omnifaces.facesviews" in the ServletContext.
static Map<String,String>	scanViews(ServletContext servletContext, Set<String> resourcePaths) Scans resources (views) recursively starting with the given resource paths and returns a flat map containing all resources encountered.
static void	scanViews(ServletContext servletContext, Set<String> resourcePaths, Map<String,String> collectedViews) Scans resources (views) recursively starting with the given resource paths, and collects those in a flat map.
static void	scanViews(ServletContext servletContext, Set<String> resourcePaths, Map<String,String> collectedViews, Set<String> collectedExtentions) Scans resources (views) recursively starting with the given resource paths, and collects those and all unique extensions encountered in a flat map respectively set.
static String	stripExtension(String resource) Strips the extension from a resource if any.
static String	stripPrefixPath(String resource) Strips the special 'faces-views' prefix path from the resource if any.
static void	tryScanAndStoreViews(ServletContext context) Checks if resources haven't been scanned yet, and if not does scanning and stores the result at the designated location "org.omnifaces.facesviews" in the ServletContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEB_INF_VIEWS

public static final String WEB_INF_VIEWS

See Also:

Constant Field Values

Method Detail

getApplication

public static Application getApplication()

Gets the JSF Application instance.

Returns:

The JSF Application instance.

isDirectory

public static boolean isDirectory(String resourcePath)

Checks if the given resource path obtained from ServletContext.getResourcePaths(String) represents a directory.

Parameters:

resourcePath - the resource path to check

Returns:

true if the resource path represents a directory, false otherwise

stripPrefixPath

public static String stripPrefixPath(String resource)

Strips the special 'faces-views' prefix path from the resource if any.

Parameters:

resource -

Returns:

the resource without the special prefix path, or as-is if it didn't start with this prefix.

stripExtension

public static String stripExtension(String resource)

Strips the extension from a resource if any. This extension is defined as everything after the last occurrence of a period, including the period itself. E.g. input "index.xhtml" will return "index".

Parameters:

resource -

Returns:

the resource without its extension, of as-is if it doesn't have an extension.

getExtension

public static String getExtension(String resource)

Gets the extension of a resource if any. This extension is defined as everything after the last occurrence of a period, including the period itself. E.g. input "index.xhtml" will return ".xhtml'.

Parameters:

resource -

Returns:

the extension of the resource, or null if it doesn't have an extension.

isExtensionless

public static boolean isExtensionless(String viewId)

getApplicationAttribute

public static <T> T getApplicationAttribute(FacesContext context,
                            String name)

getApplicationAttribute

public static <T> T getApplicationAttribute(ServletContext context,
                            String name)

getRequestAttribute

public static <T> T getRequestAttribute(FacesContext context,
                        String name)

getFacesServletRegistration

public static ServletRegistration getFacesServletRegistration(ServletContext servletContext)

Gets the ServletRegistration associated with the FacesServlet.

Parameters:

servletContext - the context to get the ServletRegistration from.

Returns:

ServletRegistration for FacesServlet, or null if the FacesServlet is not installed.

scanViews

public static void scanViews(ServletContext servletContext,
             Set<String> resourcePaths,
             Map<String,String> collectedViews,
             Set<String> collectedExtentions)

Scans resources (views) recursively starting with the given resource paths, and collects those and all unique extensions encountered in a flat map respectively set.

Parameters:

servletContext -

resourcePaths -

collectedViews -

collectedExtentions -

scanViews

public static Map<String,String> scanViews(ServletContext servletContext,
                           Set<String> resourcePaths)

Scans resources (views) recursively starting with the given resource paths and returns a flat map containing all resources encountered.

Parameters:

servletContext -

resourcePaths -

Returns:

views

scanViews

public static void scanViews(ServletContext servletContext,
             Set<String> resourcePaths,
             Map<String,String> collectedViews)

Scans resources (views) recursively starting with the given resource paths, and collects those in a flat map.

Parameters:

servletContext -

resourcePaths -

collectedViews -

tryScanAndStoreViews

public static void tryScanAndStoreViews(ServletContext context)

Checks if resources haven't been scanned yet, and if not does scanning and stores the result at the designated location "org.omnifaces.facesviews" in the ServletContext.

Parameters:

context -

scanAndStoreViews

public static Map<String,String> scanAndStoreViews(ServletContext context)

Scans for faces-views resources and stores the result at the designated location "org.omnifaces.facesviews" in the ServletContext.

Parameters:

context -

Returns:

the view found during scanning, or the empty map if no views encountered