Package org.apache.myfaces.application

Class ResourceHandlerImpl

java.lang.Object

jakarta.faces.application.ResourceHandler

org.apache.myfaces.application.ResourceHandlerImpl

public class ResourceHandlerImpl
extends ResourceHandler

DOCUMENT ME!

Version:

$Revision$ $Date$

Author:

Simon Lessard (latest modification by $Author$)

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	LIBRARY_VERSION_CHECKER
static String	RENDERED_RESOURCES_SET
static Pattern	RESOURCE_VERSION_CHECKER

Fields inherited from class jakarta.faces.application.ResourceHandler

FACES_SCRIPT_LIBRARY_NAME, FACES_SCRIPT_RESOURCE_NAME, JSF_SCRIPT_LIBRARY_NAME, JSF_SCRIPT_RESOURCE_NAME, LOCALE_PREFIX, RESOURCE_CONTRACT_XML, RESOURCE_EXCLUDES_DEFAULT_VALUE, RESOURCE_EXCLUDES_PARAM_NAME, RESOURCE_IDENTIFIER, WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME, WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
ResourceHandlerImpl()

Method Summary

Modifier and Type	Method	Description
protected String	_getContentType(Resource resource, ExternalContext externalContext)
Resource	createResource(String resourceName)
Resource	createResource(String resourceName, String libraryName)
Resource	createResource(String resourceName, String libraryName, String contentType)
Resource	createResourceFromId(String resourceId)
Resource	createViewResource(FacesContext facesContext, String resourceName)
protected ResourceMeta	deriveResourceMeta(FacesContext context, ContractResourceLoader resourceLoader, String resourceId, String contractName)
protected ResourceMeta	deriveResourceMeta(FacesContext context, ResourceLoader resourceLoader, String resourceId)
protected ResourceMeta	deriveResourceMeta(ContractResourceLoader resourceLoader, String resourceName, String libraryName, String localePrefix, String contractName)
protected ResourceMeta	deriveResourceMeta(ResourceLoader resourceLoader, String resourceName, String libraryName, String localePrefix)	This method try to create a ResourceMeta for a specific resource loader.
protected ResourceMeta	deriveViewResourceMeta(FacesContext context, ContractResourceLoader resourceLoader, String resourceName, String localePrefix, String contractName)
protected ResourceMeta	deriveViewResourceMeta(FacesContext context, ResourceLoader resourceLoader, String resourceName, String localePrefix)
protected String	getContractNameForLocateResource(FacesContext context)
protected String	getLocalePrefixForLocateResource()
protected String	getLocalePrefixForLocateResource(FacesContext context)
String	getRendererTypeForResourceName(String resourceName)
protected int	getResourceBufferSize()
protected ResourceHandlerCache	getResourceHandlerCache()
protected ResourceHandlerSupport	getResourceHandlerSupport()
Stream<String>	getViewResources(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options)
void	handleResourceRequest(FacesContext facesContext)	Handle the resource request, writing in the output.
protected boolean	isAllowSlashesLibraryName()
protected boolean	isResourceIdentifierExcluded(FacesContext context, String resourceIdentifier)
boolean	isResourceRendered(FacesContext facesContext, String resourceName, String libraryName)
boolean	isResourceRequest(FacesContext facesContext)
boolean	libraryExists(String libraryName)	Check if a library exists or not.
void	markResourceRendered(FacesContext facesContext, String resourceName, String libraryName)
void	setResourceHandlerSupport(ResourceHandlerSupport resourceHandlerSupport)

Methods inherited from class jakarta.faces.application.ResourceHandler

getViewResources, isResourceURL

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_VERSION_CHECKER

public static final Pattern LIBRARY_VERSION_CHECKER

RESOURCE_VERSION_CHECKER

public static final Pattern RESOURCE_VERSION_CHECKER

RENDERED_RESOURCES_SET

public static final String RENDERED_RESOURCES_SET

See Also:

Constant Field Values

Constructor Detail

ResourceHandlerImpl

public ResourceHandlerImpl()

Method Detail

createResource

public Resource createResource(String resourceName)

Specified by:

createResource in class ResourceHandler

createResource

public Resource createResource(String resourceName,
                               String libraryName)

Specified by:

createResource in class ResourceHandler

createResource

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

Specified by:

createResource in class ResourceHandler

deriveResourceMeta

protected ResourceMeta deriveResourceMeta(ContractResourceLoader resourceLoader,
                                          String resourceName,
                                          String libraryName,
                                          String localePrefix,
                                          String contractName)

deriveResourceMeta

protected ResourceMeta deriveResourceMeta(ResourceLoader resourceLoader,
                                          String resourceName,
                                          String libraryName,
                                          String localePrefix)

This method try to create a ResourceMeta for a specific resource loader. If no library, or resource is found, just return null, so the algorithm in createResource can continue checking with the next registered ResourceLoader.

getRendererTypeForResourceName

public String getRendererTypeForResourceName(String resourceName)

Specified by:

getRendererTypeForResourceName in class ResourceHandler

handleResourceRequest

public void handleResourceRequest(FacesContext facesContext)
                           throws IOException

Handle the resource request, writing in the output. This method implements an algorithm semantically identical to the one described on the javadoc of ResourceHandler.handleResourceRequest

Specified by:

handleResourceRequest in class ResourceHandler

Throws:

IOException

isResourceRequest

public boolean isResourceRequest(FacesContext facesContext)

Specified by:

isResourceRequest in class ResourceHandler

getLocalePrefixForLocateResource

protected String getLocalePrefixForLocateResource()

getLocalePrefixForLocateResource

protected String getLocalePrefixForLocateResource(FacesContext context)

getContractNameForLocateResource

protected String getContractNameForLocateResource(FacesContext context)

isResourceIdentifierExcluded

protected boolean isResourceIdentifierExcluded(FacesContext context,
                                               String resourceIdentifier)

libraryExists

public boolean libraryExists(String libraryName)

Check if a library exists or not. This is done delegating to each ResourceLoader used, because each one has a different prefix and way to load resources.

Specified by:

libraryExists in class ResourceHandler

setResourceHandlerSupport

public void setResourceHandlerSupport(ResourceHandlerSupport resourceHandlerSupport)

getResourceHandlerSupport

protected ResourceHandlerSupport getResourceHandlerSupport()

getResourceHandlerCache

protected ResourceHandlerCache getResourceHandlerCache()

_getContentType

protected String _getContentType(Resource resource,
                                 ExternalContext externalContext)

isAllowSlashesLibraryName

protected boolean isAllowSlashesLibraryName()

getResourceBufferSize

protected int getResourceBufferSize()

createResourceFromId

public Resource createResourceFromId(String resourceId)

Overrides:

createResourceFromId in class ResourceHandler

deriveResourceMeta

protected ResourceMeta deriveResourceMeta(FacesContext context,
                                          ResourceLoader resourceLoader,
                                          String resourceId)

deriveResourceMeta

protected ResourceMeta deriveResourceMeta(FacesContext context,
                                          ContractResourceLoader resourceLoader,
                                          String resourceId,
                                          String contractName)

deriveViewResourceMeta

protected ResourceMeta deriveViewResourceMeta(FacesContext context,
                                              ResourceLoader resourceLoader,
                                              String resourceName,
                                              String localePrefix)

deriveViewResourceMeta

protected ResourceMeta deriveViewResourceMeta(FacesContext context,
                                              ContractResourceLoader resourceLoader,
                                              String resourceName,
                                              String localePrefix,
                                              String contractName)

createViewResource

public Resource createViewResource(FacesContext facesContext,
                                   String resourceName)

Overrides:

createViewResource in class ResourceHandler

getViewResources

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

Overrides:

getViewResources in class ResourceHandler

isResourceRendered

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

Overrides:

isResourceRendered in class ResourceHandler

Parameters:

facesContext -

resourceName -

libraryName -

Returns:

Since:

2.3

markResourceRendered

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

Overrides:

markResourceRendered in class ResourceHandler

Parameters:

facesContext -

resourceName -

libraryName -

Since:

2.3