Package jakarta.faces.application

Class ResourceHandler

java.lang.Object

jakarta.faces.application.ResourceHandler

Direct Known Subclasses:

ResourceHandlerWrapper

public abstract class ResourceHandler
extends Object

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	FACES_SCRIPT_LIBRARY_NAME
static String	FACES_SCRIPT_RESOURCE_NAME
static String	JSF_SCRIPT_LIBRARY_NAME	Deprecated.
static String	JSF_SCRIPT_RESOURCE_NAME	Deprecated.
static String	LOCALE_PREFIX
static String	RESOURCE_CONTRACT_XML
static String	RESOURCE_EXCLUDES_DEFAULT_VALUE
static String	RESOURCE_EXCLUDES_PARAM_NAME	Space separated file extensions that will not be served by the default ResourceHandler implementation.
static String	RESOURCE_IDENTIFIER
static String	WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME
static String	WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
ResourceHandler()

Method Summary

Modifier and Type	Method	Description
abstract Resource	createResource(String resourceName)
abstract Resource	createResource(String resourceName, String libraryName)
abstract Resource	createResource(String resourceName, String libraryName, String contentType)
Resource	createResourceFromId(String resourceId)
ViewResource	createViewResource(FacesContext context, String resourceName)
abstract String	getRendererTypeForResourceName(String resourceName)
Stream<String>	getViewResources(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options)
Stream<String>	getViewResources(FacesContext facesContext, String path, ResourceVisitOption... options)
abstract void	handleResourceRequest(FacesContext context)
boolean	isResourceRendered(FacesContext facesContext, String resourceName, String libraryName)
abstract boolean	isResourceRequest(FacesContext context)
boolean	isResourceURL(String url)
abstract boolean	libraryExists(String libraryName)
void	markResourceRendered(FacesContext facesContext, String resourceName, String libraryName)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_PREFIX

public static final String LOCALE_PREFIX

See Also:

Constant Field Values

RESOURCE_EXCLUDES_DEFAULT_VALUE

public static final String RESOURCE_EXCLUDES_DEFAULT_VALUE

See Also:

Constant Field Values

RESOURCE_EXCLUDES_PARAM_NAME

@JSFWebConfigParam(defaultValue=".class .jsp .jspx .properties .xhtml .groovy",
                   since="2.0",
                   group="resources")
public static final String RESOURCE_EXCLUDES_PARAM_NAME

Space separated file extensions that will not be served by the default ResourceHandler implementation.

See Also:

Constant Field Values

RESOURCE_IDENTIFIER

public static final String RESOURCE_IDENTIFIER

See Also:

Constant Field Values

RESOURCE_CONTRACT_XML

public static final String RESOURCE_CONTRACT_XML

Since:

2.2

See Also:

Constant Field Values

WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME

public static final String WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME

Since:

2.2

See Also:

Constant Field Values

WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME

public static final String WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME

Since:

2.2

See Also:

Constant Field Values

JSF_SCRIPT_RESOURCE_NAME

@Deprecated
public static final String JSF_SCRIPT_RESOURCE_NAME

Deprecated.

Since:

2.3

See Also:

Constant Field Values

JSF_SCRIPT_LIBRARY_NAME

@Deprecated
public static final String JSF_SCRIPT_LIBRARY_NAME

Deprecated.

Since:

2.3

See Also:

Constant Field Values

FACES_SCRIPT_RESOURCE_NAME

public static final String FACES_SCRIPT_RESOURCE_NAME

Since:

4.0

See Also:

Constant Field Values

FACES_SCRIPT_LIBRARY_NAME

public static final String FACES_SCRIPT_LIBRARY_NAME

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ResourceHandler

public ResourceHandler()

Method Detail

createResource

public abstract Resource createResource(String resourceName)

createResource

public abstract Resource createResource(String resourceName,
                                        String libraryName)

createResource

public abstract Resource createResource(String resourceName,
                                        String libraryName,
                                        String contentType)

getRendererTypeForResourceName

public abstract String getRendererTypeForResourceName(String resourceName)

handleResourceRequest

public abstract void handleResourceRequest(FacesContext context)
                                    throws IOException

Throws:

IOException

isResourceRequest

public abstract boolean isResourceRequest(FacesContext context)

libraryExists

public abstract boolean libraryExists(String libraryName)

createResourceFromId

public Resource createResourceFromId(String resourceId)

Parameters:

resourceId -

Returns:

Since:

2.2

createViewResource

public ViewResource createViewResource(FacesContext context,
                                       String resourceName)

Parameters:

context -

resourceName -

Returns:

Since:

2.2

isResourceURL

public boolean isResourceURL(String url)

getViewResources

public Stream<String> getViewResources(FacesContext facesContext,
                                       String path,
                                       ResourceVisitOption... options)

Parameters:

facesContext -

path -

options -

Returns:

Since:

2.3

getViewResources

public Stream<String> getViewResources(FacesContext facesContext,
                                       String path,
                                       int maxDepth,
                                       ResourceVisitOption... options)

Parameters:

facesContext -

path -

maxDepth -

options -

Returns:

Since:

2.3

isResourceRendered

public boolean isResourceRendered(FacesContext facesContext,
                                  String resourceName,
                                  String libraryName)

Parameters:

facesContext -

resourceName -

libraryName -

Returns:

Since:

2.3

markResourceRendered

public void markResourceRendered(FacesContext facesContext,
                                 String resourceName,
                                 String libraryName)

Parameters:

facesContext -

resourceName -

libraryName -

Since:

2.3