Jakarta EE 11.0.0 · com.sun.faces.application.resource.ResourceHandlerImpl

Modifier and Type	Field and Description
private long	creationTime
pack-priv List<Pattern>	excludePatterns
private static final Logger	LOGGER
pack-priv ResourceManager	manager
private long	maxAge
private final WebConfiguration	webconfig

Access	Constructor and Description
public	ResourceHandlerImpl() Creates a new instance of ResourceHandlerImpl

Method Summary

Modifier and Type	Method and Description
private ByteBuffer	allocateByteBuffer()
public Resource	createResource(String the name of the resource. resourceName) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Create an instance of `ViewResource` given the argument `resourceName`.
public Resource	createResource(String the name of the resource. resourceName, String the name of the library (or contract) in which this resource resides, may be `null`. If there is a conflict between the name of a resource library and a resource library contract, the resource library takes precedence. May not include relative paths, such as "../". libraryName) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Create an instance of `Resource` with a resourceName given by the value of the argument `resourceName` that is a member of the library named by the argument `libraryName`.
public Resource	createResource(String the name of the resource. resourceName, String the name of the library in which this resource resides, may be `null`. May not include relative paths, such as "../". libraryName, String the mime content that this `Resource` instance will return from `Resource#getContentType`. If the value is `null`, The content-type of the resource is derived by passing the resourceName to `jakarta.faces.context.ExternalContext#getMimeType` contentType) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Create an instance of `Resource` with a resourceName given by the value of the argument `resourceName` that is a member of the library named by the argument `libraryName` that claims to have the content-type given by the argument `content-type`.
public Resource	createResourceFromId(String the resource identifier of the resource. resourceId) Overrides jakarta.faces.application.ResourceHandler.createResourceFromId. Create an instance of `Resource` given the argument `resourceId`.
public Resource	createViewResource(FacesContext the `FacesContext` for this request. facesContext, String the name of the resource to be interpreted as a view by the `jakarta.faces.view.ViewDeclarationLanguage`. resourceName) Overrides jakarta.faces.application.ResourceHandler.createViewResource. Create an instance of `Resource` given the argument `resourceName`, which may contain "/" characters.
private String	Returns: the content type for this resource getContentType(FacesContext ctx, String the resource of interest. The resourceName in question may consist of zero or more path elements such that resourceName could be something like path1/path2/resource.jpg or resource.jpg resourceName)
pack-priv long	Returns: the time when the ResourceHandler was instantiated (in milliseconds) getCreationTime() This method is leveraged by `ResourceImpl` to detemine if a resource has been upated.
public String	getRendererTypeForResourceName(String the resource name. resourceName) Implements abstract jakarta.faces.application.ResourceHandler.getRendererTypeForResourceName. Return the `renderer-type` for a `jakarta.faces.render.Renderer` that is capable of rendering this resource.
public Stream<String>	getViewResources(FacesContext The `FacesContext` for this request. facesContext, String The initial path from which to start looking for view resources path, ResourceVisitOption... The options to influence the traversal. See `ResourceVisitOption` for details on those. options) Overrides jakarta.faces.application.ResourceHandler.getViewResources. Return a `Stream` possibly lazily populated by walking the resource tree rooted at a given initial path.
public Stream<String>	getViewResources(FacesContext The `FacesContext` for this request. facesContext, String The initial path from which to start looking for view resources path, int The absolute maximum depth of nested directories to visit counted from the root (`/`). maxDepth, ResourceVisitOption... The options to influence the traversal. See `ResourceVisitOption` for details on those. options) Overrides jakarta.faces.application.ResourceHandler.getViewResources. Return a `Stream` possibly lazily populated by walking the resource tree rooted at a given initial path.
pack-priv WebConfiguration	Returns: the `WebConfiguration` for this application getWebConfig() Utility method leveraged by ResourceImpl to reduce the cost of looking up the WebConfiguration per-instance.
private void	handleHeaders(FacesContext ctx, Resource resource)
public void	handleResourceRequest(FacesContext the `jakarta.faces.context.FacesContext` for this request context) Implements abstract jakarta.faces.application.ResourceHandler.handleResourceRequest. This method specifies the contract for satisfying resource requests.
private void	initExclusions(Map<String, Object> appMap) Initialize the exclusions for this application.
private void	initMaxAge()
private static boolean	isConnectionAbort(IOException ioe)
private boolean	Returns: `true` if the request matces an excluded resource, otherwise `false` isExcluded(String the normalized request path as returned by `normalizeResourceRequest(jakarta.faces.context.FacesContext)` resourceId)
public boolean	isResourceRequest(FacesContext the `jakarta.faces.context.FacesContext` for this request context) Implements abstract jakarta.faces.application.ResourceHandler.isResourceRequest. Return `true` if the current request is a resource request.
public boolean	libraryExists(String the library name. libraryName) Implements abstract jakarta.faces.application.ResourceHandler.libraryExists. Return `true` if the resource library named by the argument `libraryName` can be found.
private boolean	libraryNameIsSafe(String libraryName)
private void	logMissingResource(FacesContext the `FacesContext` for the current request ctx, String the resource name resourceName, String the resource library libraryName, Throwable the exception caught when attempting to find the resource t) Log a message indicating a particular resource (reference by name and/or library) could not be found.
private void	logMissingResource(FacesContext the `FacesContext` for the current request ctx, String the resource name resourceId, Throwable the exception caught when attempting to find the resource t) Log a message indicating a particular resource (reference by name and/or library) could not be found.
private String	Returns: the request path without Faces invocation information normalizeResourceRequest(FacesContext the `FacesContext` for the current request context) Normalize the request path to exclude Faces invocation information.
private void	send304(FacesContext ctx)
private void	send404(FacesContext ctx, String resourceName, String libraryName, boolean logMessage)
private void	send404(FacesContext ctx, String resourceName, String libraryName, Throwable t, boolean logMessage)
pack-priv void	setCreationTime(long the time in milliseconds creationTime) This method is here soley for the purpose of unit testing and will not be invoked during normal runtime.

Inherited from jakarta.faces.application.ResourceHandler:: isResourceRendered isResourceURL markResourceRendered

creationTime	back to summary
private long creationTime

excludePatterns	back to summary
pack-priv List<Pattern> excludePatterns

LOGGER	back to summary
private static final Logger LOGGER

manager	back to summary
pack-priv ResourceManager manager

maxAge	back to summary
private long maxAge

webconfig	back to summary
private final WebConfiguration webconfig

ResourceHandlerImpl	back to summary
public ResourceHandlerImpl() Creates a new instance of ResourceHandlerImpl

Method Detail

allocateByteBuffer	back to summary
private ByteBuffer allocateByteBuffer()

createResource back to summary

createResource	back to summary
public Resource createResource(String resourceName) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Doc from jakarta.faces.application.ResourceHandler.createResource. Create an instance of `ViewResource` given the argument `resourceName`. The content-type of the resource is derived by passing the resourceName to `jakarta.faces.context.ExternalContext#getMimeType` The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the `Resource`. New requirements were introduced in version 2.2 of the specification. For historical reasons, this method operate correctly when the argument `resourceName` is of the form `libraryName/resourceName`, even when `resourceName` contains '/' characters. Parameters resourceName:String the name of the resource. Returns:Resource a newly created `Resource` instance, suitable for use in encoding or decoding the named resource. Annotations @Override See Also `ResourceHandler#createResource(String)`

public Resource createResource(String resourceName)

Implements abstract jakarta.faces.application.ResourceHandler.createResource.

Doc from jakarta.faces.application.ResourceHandler.createResource.

Create an instance of ViewResource given the argument resourceName. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType

The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the Resource. New requirements were introduced in version 2.2 of the specification. For historical reasons, this method operate correctly when the argument resourceName is of the form libraryName/resourceName, even when resourceName contains '/' characters.

Parameters

resourceName:String: the name of the resource.

Returns:Resource

a newly created Resource instance, suitable for use in encoding or decoding the named resource.

Annotations

@Override

createResource back to summary

createResource	back to summary
public Resource createResource(String resourceName, String libraryName) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Doc from jakarta.faces.application.ResourceHandler.createResource. Create an instance of `Resource` with a resourceName given by the value of the argument `resourceName` that is a member of the library named by the argument `libraryName`. The content-type of the resource is derived by passing the resourceName to `jakarta.faces.context.ExternalContext#getMimeType`. The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the `Resource`. New requirements were introduced in version 2.2 of the specification. Parameters resourceName:String the name of the resource. libraryName:String the name of the library (or contract) in which this resource resides, may be `null`. If there is a conflict between the name of a resource library and a resource library contract, the resource library takes precedence. May not include relative paths, such as "../". Returns:Resource a newly created `Resource` instance, suitable for use in encoding or decoding the named resource. Annotations @Override See Also `ResourceHandler#createResource(String, String)`

public Resource createResource(String resourceName, String libraryName)

Implements abstract jakarta.faces.application.ResourceHandler.createResource.

Doc from jakarta.faces.application.ResourceHandler.createResource.

Create an instance of Resource with a resourceName given by the value of the argument resourceName that is a member of the library named by the argument libraryName. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType.

Parameters

resourceName:String: the name of the resource.
libraryName:String: the name of the library (or contract) in which this resource resides, may be null. If there is a conflict between the name of a resource library and a resource library contract, the resource library takes precedence. May not include relative paths, such as "../".

Returns:Resource

a newly created Resource instance, suitable for use in encoding or decoding the named resource.

Annotations

@Override

createResource back to summary

createResource	back to summary
public Resource createResource(String resourceName, String libraryName, String contentType) Implements abstract jakarta.faces.application.ResourceHandler.createResource. Doc from jakarta.faces.application.ResourceHandler.createResource. Create an instance of `Resource` with a resourceName given by the value of the argument `resourceName` that is a member of the library named by the argument `libraryName` that claims to have the content-type given by the argument `content-type`. The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the `Resource`. New requirements were introduced in version 2.2 of the specification. Parameters resourceName:String the name of the resource. libraryName:String the name of the library in which this resource resides, may be `null`. May not include relative paths, such as "../". contentType:String the mime content that this `Resource` instance will return from `Resource#getContentType`. If the value is `null`, The content-type of the resource is derived by passing the resourceName to `jakarta.faces.context.ExternalContext#getMimeType` Returns:Resource a newly created `Resource` instance, suitable for use in encoding or decoding the named resource. Annotations @Override See Also `ResourceHandler#createResource(String, String, String)`

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

Implements abstract jakarta.faces.application.ResourceHandler.createResource.

Doc from jakarta.faces.application.ResourceHandler.createResource.

Create an instance of Resource with a resourceName given by the value of the argument resourceName that is a member of the library named by the argument libraryName that claims to have the content-type given by the argument content-type.

Parameters

resourceName:String: the name of the resource.
libraryName:String: the name of the library in which this resource resides, may be null. May not include relative paths, such as "../".
contentType:String: the mime content that this Resource instance will return from Resource#getContentType. If the value is null, The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType

Returns:Resource

a newly created Resource instance, suitable for use in encoding or decoding the named resource.

Annotations

@Override

createResourceFromId back to summary

createResourceFromId	back to summary
public Resource createResourceFromId(String resourceId) Overrides jakarta.faces.application.ResourceHandler.createResourceFromId. Doc from jakarta.faces.application.ResourceHandler.createResourceFromId. Create an instance of `Resource` given the argument `resourceId`. The content-type of the resource is derived by passing the resourceName to `jakarta.faces.context.ExternalContext#getMimeType` The resource must be identified according to the specification in section 2.6.1.3 "Resource Identifiers" of the Jakarta Faces Specification Document. New requirements were introduced in version 2.2 of the specification. Parameters resourceId:String the resource identifier of the resource. Returns:Resource a newly created `Resource` instance, suitable for use in encoding or decoding the named resource. Annotations @Override See Also `ResourceHandler#createResourceFromId(String)`

public Resource createResourceFromId(String resourceId)

Overrides jakarta.faces.application.ResourceHandler.createResourceFromId.

Doc from jakarta.faces.application.ResourceHandler.createResourceFromId.

Create an instance of Resource given the argument resourceId. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType

The resource must be identified according to the specification in section 2.6.1.3 "Resource Identifiers" of the Jakarta Faces Specification Document. New requirements were introduced in version 2.2 of the specification.

Parameters

resourceId:String: the resource identifier of the resource.

Returns:Resource

a newly created Resource instance, suitable for use in encoding or decoding the named resource.

Annotations

@Override

createViewResource back to summary

createViewResource	back to summary
public Resource createViewResource(FacesContext facesContext, String resourceName) Overrides jakarta.faces.application.ResourceHandler.createViewResource. Doc from jakarta.faces.application.ResourceHandler.createViewResource. Create an instance of `Resource` given the argument `resourceName`, which may contain "/" characters. The `jakarta.faces.view.ViewDeclarationLanguage` calls this method when it needs to load a view from a persistent store, such as a filesystem. This method is functionality equivalent to `createResource(java.lang.String)`, but all callsites that need to load VDL views must use this method so that classes that want to decorate the `ResourceHandler` in order to only affect the loading of views may do so without affecting the processing of other kinds of resources, such as scripts and stylesheets. A `jakarta.faces.context.FacesContext` must be present before calling this method. To preserve compatibility with prior revisions of the specification, a default implementation must be provided that calls `createResource(java.lang.String)`. The default implementation must look for the resource in the following places, in this order. Considering resource library contracts (at the locations specified in the Jakarta Faces Specification Document section 2.7 "Resource Library Contracts"). Considering the web app root. Considering faces flows (at the locations specified in the Jakarta Faces Specification Document section 11.3.3 "Faces Flows"). Call `FacesContext#getResourceLibraryContracts`. If the result is non-`null` and not empty, for each value in the list, treat the value as the name of a resource library contract. If the argument `resoureName` exists as a resource in the resource library contract, return it. Otherwise, return the resource (not in the resource library contract), if found. Otherwise, return `null`. Parameters facesContext:FacesContext the `FacesContext` for this request. resourceName:String the name of the resource to be interpreted as a view by the `jakarta.faces.view.ViewDeclarationLanguage`. Returns:Resource a newly created `ViewResource` instance, suitable for use by the `jakarta.faces.view.ViewDeclarationLanguage`. Annotations @Override

public Resource createViewResource(FacesContext facesContext, String resourceName)

Overrides jakarta.faces.application.ResourceHandler.createViewResource.

Doc from jakarta.faces.application.ResourceHandler.createViewResource.

Create an instance of Resource given the argument resourceName, which may contain "/" characters. The jakarta.faces.view.ViewDeclarationLanguage calls this method when it needs to load a view from a persistent store, such as a filesystem. This method is functionality equivalent to createResource(java.lang.String), but all callsites that need to load VDL views must use this method so that classes that want to decorate the ResourceHandler in order to only affect the loading of views may do so without affecting the processing of other kinds of resources, such as scripts and stylesheets. A jakarta.faces.context.FacesContext must be present before calling this method. To preserve compatibility with prior revisions of the specification, a default implementation must be provided that calls createResource(java.lang.String).

The default implementation must look for the resource in the following places, in this order.

Considering resource library contracts (at the locations specified in the Jakarta Faces Specification Document section 2.7 "Resource Library Contracts").
Considering the web app root.
Considering faces flows (at the locations specified in the Jakarta Faces Specification Document section 11.3.3 "Faces Flows").

Call FacesContext#getResourceLibraryContracts. If the result is non-null and not empty, for each value in the list, treat the value as the name of a resource library contract. If the argument resoureName exists as a resource in the resource library contract, return it. Otherwise, return the resource (not in the resource library contract), if found. Otherwise, return null.

Parameters

facesContext:FacesContext: the FacesContext for this request.
resourceName:String: the name of the resource to be interpreted as a view by the jakarta.faces.view.ViewDeclarationLanguage.

Returns:Resource

a newly created ViewResource instance, suitable for use by the jakarta.faces.view.ViewDeclarationLanguage.

Annotations

@Override

getContentType	back to summary
private String getContentType(FacesContext ctx, String resourceName) Parameters resourceName:String the resource of interest. The resourceName in question may consist of zero or more path elements such that resourceName could be something like path1/path2/resource.jpg or resource.jpg Returns:String the content type for this resource

getCreationTime back to summary

getCreationTime	back to summary
pack-priv long getCreationTime() This method is leveraged by `ResourceImpl` to detemine if a resource has been upated. In short, a resource has been updated if the timestamp is newer than the timestamp of the ResourceHandler creation time. Returns:long the time when the ResourceHandler was instantiated (in milliseconds) Annotations @SuppressWarnings:UnusedDeclaration

pack-priv long getCreationTime()

This method is leveraged by ResourceImpl to detemine if a resource has been upated. In short, a resource has been updated if the timestamp is newer than the timestamp of the ResourceHandler creation time.

Returns:long

the time when the ResourceHandler was instantiated (in milliseconds)

Annotations

@SuppressWarnings:UnusedDeclaration

getRendererTypeForResourceName back to summary

public String getRendererTypeForResourceName(String resourceName)

Implements abstract jakarta.faces.application.ResourceHandler.getRendererTypeForResourceName.

Doc from jakarta.faces.application.ResourceHandler.getRendererTypeForResourceName.

Return the renderer-type for a jakarta.faces.render.Renderer that is capable of rendering this resource. The default implementation must return values according to the following table. If no renderer-type can be determined, null must be returned.

resource name to renderer-type mapping
example resource name	renderer-type
mycomponent.js	`jakarta.faces.resource.Script`
mystyle.css	`jakarta.faces.resource.Stylesheet`

Parameters

resourceName:String: the resource name.

Returns:String

the renderer type.

Annotations

@Override

getViewResources back to summary

getViewResources	back to summary
public Stream<String> getViewResources(FacesContext facesContext, String path, ResourceVisitOption... options) Overrides jakarta.faces.application.ResourceHandler.getViewResources. Doc from jakarta.faces.application.ResourceHandler.getViewResources. Return a `Stream` possibly lazily populated by walking the resource tree rooted at a given initial path. The resource tree is traversed breadth-first, the elements in the stream are view resource names that would yield a `ViewResource` when passed into `ResourceHandler#createViewResource` as the `resourceName` parameter. This method works as if invoking it were equivalent to evaluating the expression: getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the resource tree. Parameters facesContext:FacesContext The `FacesContext` for this request. path:String The initial path from which to start looking for view resources options:ResourceVisitOption[] The options to influence the traversal. See `ResourceVisitOption` for details on those. Returns:Stream<String> the `Stream` of view resource names Annotations @Override See Also `ResourceHandler#getViewResources(FacesContext, String, ResourceVisitOption...)`

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

Overrides jakarta.faces.application.ResourceHandler.getViewResources.

Doc from jakarta.faces.application.ResourceHandler.getViewResources.

Return a Stream possibly lazily populated by walking the resource tree rooted at a given initial path. The resource tree is traversed breadth-first, the elements in the stream are view resource names that would yield a ViewResource when passed into ResourceHandler#createViewResource as the resourceName parameter.

This method works as if invoking it were equivalent to evaluating the expression:

getViewResources(facesContext, start, Integer.MAX_VALUE, options)

Put differently, it visits all levels of the resource tree.

Parameters

facesContext:FacesContext: The FacesContext for this request.
path:String: The initial path from which to start looking for view resources
options:ResourceVisitOption[]: The options to influence the traversal. See ResourceVisitOption for details on those.

Returns:Stream<String>

the Stream of view resource names

Annotations

@Override

getViewResources back to summary

getViewResources	back to summary
public Stream<String> getViewResources(FacesContext facesContext, String path, int maxDepth, ResourceVisitOption... options) Overrides jakarta.faces.application.ResourceHandler.getViewResources. Doc from jakarta.faces.application.ResourceHandler.getViewResources. Return a `Stream` possibly lazily populated by walking the resource tree rooted at a given initial path. The resource tree is traversed breadth-first, the elements in the stream are view resource names that would yield a `ViewResource` when passed into `ResourceHandler#createViewResource` as the `resourceName` parameter. The `maxDepth` parameter is the maximum depth of directory levels to visit beyond the initial path, which is always visited. The value is relative to the root (`/`), not to the given initial path. E.g. given `maxDepth` = `3` and initial path `/foo/`, visiting will proceed up to `/foo/bar/`, where `/` counts as depth `1`, `/foo/` as depth `2` and `/foo/bar/` as depth `3`. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of `MAX_VALUE` may be used to indicate that all levels should be visited. Parameters facesContext:FacesContext The `FacesContext` for this request. path:String The initial path from which to start looking for view resources maxDepth:int The absolute maximum depth of nested directories to visit counted from the root (`/`). options:ResourceVisitOption[] The options to influence the traversal. See `ResourceVisitOption` for details on those. Returns:Stream<String> the `Stream` of view resource names Annotations @Override See Also `ResourceHandler#getViewResources(FacesContext, String, int, ResourceVisitOption...)`

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

Overrides jakarta.faces.application.ResourceHandler.getViewResources.

Doc from jakarta.faces.application.ResourceHandler.getViewResources.

The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of MAX_VALUE may be used to indicate that all levels should be visited.

Parameters

facesContext:FacesContext: The FacesContext for this request.
path:String: The initial path from which to start looking for view resources
maxDepth:int: The absolute maximum depth of nested directories to visit counted from the root (/).
options:ResourceVisitOption[]: The options to influence the traversal. See ResourceVisitOption for details on those.

Returns:Stream<String>

the Stream of view resource names

Annotations

@Override

getWebConfig back to summary

getWebConfig	back to summary
pack-priv WebConfiguration getWebConfig() Utility method leveraged by ResourceImpl to reduce the cost of looking up the WebConfiguration per-instance. Returns:WebConfiguration the `WebConfiguration` for this application Annotations @SuppressWarnings:UnusedDeclaration

pack-priv WebConfiguration getWebConfig()

Utility method leveraged by ResourceImpl to reduce the cost of looking up the WebConfiguration per-instance.

Returns:WebConfiguration

the WebConfiguration for this application

Annotations

@SuppressWarnings:UnusedDeclaration

handleHeaders	back to summary
private void handleHeaders(FacesContext ctx, Resource resource)

handleResourceRequest back to summary

handleResourceRequest	back to summary
public void handleResourceRequest(FacesContext context) throws IOException Implements abstract jakarta.faces.application.ResourceHandler.handleResourceRequest. Doc from jakarta.faces.application.ResourceHandler.handleResourceRequest. This method specifies the contract for satisfying resource requests. This method is called from `jakarta.faces.webapp.FacesServlet#service` after that method determines the current request is a resource request by calling `isResourceRequest`. Thus, `handleResourceRequest` may assume that the current request is a resource request. The default implementation must implement an algorithm semantically identical to the following algorithm. For discussion, in all cases when a status code is to be set, this spec talks only using the Jakarta Servlet API, but it is understood that in a portlet environment the appropriate equivalent API must be used. If the resourceIdentifier ends with any of the extensions listed in the value of the `RESOURCE_EXCLUDES_PARAM_NAME` init parameter, `HttpServletRequest.SC_NOT_FOUND` must be passed to `HttpServletResponse.setStatus()`, then `handleResourceRequest` must immediately return. Extract the resourceName from the resourceIdentifier by taking the substring of resourceIdentifier that starts at `RESOURCE_IDENTIFIER.length() + 1` and goes to the end of resourceIdentifier. If no resourceName can be extracted, `HttpServletRequest.SC_NOT_FOUND` must be passed to `HttpServletResponse.setStatus()`, then `handleResourceRequest` must immediately return. Extract the libraryName from the request by looking in the request parameter map for an entry under the key "ln", without the quotes. If found, use its value as the libraryName. If resourceName and libraryName are present, call `createResource(String, String)` to create the `Resource`. If only resourceName is present, call `createResource(String)` to create the `Resource`. If the `Resource` cannot be successfully created, `HttpServletRequest.SC_NOT_FOUND` must be passed to `HttpServletResponse.setStatus()`, then `handleResourceRequest` must immediately return. Call `Resource#userAgentNeedsUpdate`. If this method returns false, `HttpServletRequest.SC_NOT_MODIFIED` must be passed to `HttpServletResponse.setStatus()`, then `handleResourceRequest` must immediately return. Pass the result of `Resource#getContentType` to `HttpServletResponse.setContentType.` Call `Resource#getResponseHeaders`. For each entry in this `Map`, call `HttpServletResponse.setHeader()`, passing the key as the first argument and the value as the second argument. Call `Resource#getInputStream` and serve up the bytes of the resource to the response. Call `HttpServletResponse.setContentLength()` passing the byte count of the resource. If an `IOException` is thrown during any of the previous steps, log a descriptive, localized message, including the resourceName and libraryName (if present). Then, `HttpServletRequest.SC_NOT_FOUND` must be passed to `HttpServletResponse.setStatus()`, then `handleResourceRequest` must immediately return. In all cases in this method, any streams, channels, sockets, or any other IO resources must be closed before this method returns. Parameters context:FacesContext the `jakarta.faces.context.FacesContext` for this request Annotations @Override Exceptions IOException: when an I/O error occurs. See Also `jakarta.faces.application.ResourceHandler#handleResourceRequest(jakarta.faces.context.FacesContext)`

public void handleResourceRequest(FacesContext context) throws IOException

Implements abstract jakarta.faces.application.ResourceHandler.handleResourceRequest.

Doc from jakarta.faces.application.ResourceHandler.handleResourceRequest.

This method specifies the contract for satisfying resource requests. This method is called from jakarta.faces.webapp.FacesServlet#service after that method determines the current request is a resource request by calling isResourceRequest. Thus, handleResourceRequest may assume that the current request is a resource request.

The default implementation must implement an algorithm semantically identical to the following algorithm.

For discussion, in all cases when a status code is to be set, this spec talks only using the Jakarta Servlet API, but it is understood that in a portlet environment the appropriate equivalent API must be used.

If the resourceIdentifier ends with any of the extensions listed in the value of the RESOURCE_EXCLUDES_PARAM_NAME init parameter, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return.
Extract the resourceName from the resourceIdentifier by taking the substring of resourceIdentifier that starts at RESOURCE_IDENTIFIER.length() + 1 and goes to the end of resourceIdentifier. If no resourceName can be extracted, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return.
Extract the libraryName from the request by looking in the request parameter map for an entry under the key "ln", without the quotes. If found, use its value as the libraryName.
If resourceName and libraryName are present, call createResource(String, String) to create the Resource. If only resourceName is present, call createResource(String) to create the Resource. If the Resource cannot be successfully created, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return.
Call Resource#userAgentNeedsUpdate. If this method returns false, HttpServletRequest.SC_NOT_MODIFIED must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return.
Pass the result of Resource#getContentType to HttpServletResponse.setContentType.
Call Resource#getResponseHeaders. For each entry in this Map, call HttpServletResponse.setHeader(), passing the key as the first argument and the value as the second argument.
Call Resource#getInputStream and serve up the bytes of the resource to the response.
Call HttpServletResponse.setContentLength() passing the byte count of the resource.
If an IOException is thrown during any of the previous steps, log a descriptive, localized message, including the resourceName and libraryName (if present). Then, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return.
In all cases in this method, any streams, channels, sockets, or any other IO resources must be closed before this method returns.

Parameters

context:FacesContext: the jakarta.faces.context.FacesContext for this request

Annotations

@Override

Exceptions

IOException:: when an I/O error occurs.

initExclusions	back to summary
private void initExclusions(Map<String, Object> appMap) Initialize the exclusions for this application. If no explicit exclusions are configured, the defaults of .class .properties .xhtml will be used.

initExclusions

back to summary

private void initExclusions(Map<String, Object> appMap)

Initialize the exclusions for this application. If no explicit exclusions are configured, the defaults of

.class
.properties
.xhtml

will be used.

initMaxAge	back to summary
private void initMaxAge()

isConnectionAbort	back to summary
private static boolean isConnectionAbort(IOException ioe)

isExcluded	back to summary
private boolean isExcluded(String resourceId) Parameters resourceId:String the normalized request path as returned by `normalizeResourceRequest(jakarta.faces.context.FacesContext)` Returns:boolean `true` if the request matces an excluded resource, otherwise `false`

isResourceRequest back to summary

isResourceRequest	back to summary
public boolean isResourceRequest(FacesContext context) Implements abstract jakarta.faces.application.ResourceHandler.isResourceRequest. Doc from jakarta.faces.application.ResourceHandler.isResourceRequest. Return `true` if the current request is a resource request. This method is called by `jakarta.faces.webapp.FacesServlet#service` to determine if this request is a view request or a resource request. Parameters context:FacesContext the `jakarta.faces.context.FacesContext` for this request Returns:boolean `true` if the current request is a resource request, `false` otherwise. Annotations @Override See Also `ResourceHandler#isResourceRequest(jakarta.faces.context.FacesContext)`

public boolean isResourceRequest(FacesContext context)

Implements abstract jakarta.faces.application.ResourceHandler.isResourceRequest.

Doc from jakarta.faces.application.ResourceHandler.isResourceRequest.

Return true if the current request is a resource request. This method is called by jakarta.faces.webapp.FacesServlet#service to determine if this request is a view request or a resource request.

Parameters

context:FacesContext: the jakarta.faces.context.FacesContext for this request

Returns:boolean

true if the current request is a resource request, false otherwise.

Annotations

@Override

libraryExists back to summary

libraryExists	back to summary
public boolean libraryExists(String libraryName) Implements abstract jakarta.faces.application.ResourceHandler.libraryExists. Doc from jakarta.faces.application.ResourceHandler.libraryExists. Return `true` if the resource library named by the argument `libraryName` can be found. If there is a `localePrefix` for this application, as defined in `LOCALE_PREFIX`, first look for the library with the prefix. If no such library is found, look for the library without the prefix. This allows developers to avoid duplication of files. For example, consider the case where the developer wants to have a resource library containing a localized image resource and a non-localized script resource. By checking both locations for the existence of the library, along with other spec changes in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document, this scenario is enabled. Parameters libraryName:String the library name. Returns:boolean `true` if the library exists, `false` otherwise. Annotations @Override

public boolean libraryExists(String libraryName)

Implements abstract jakarta.faces.application.ResourceHandler.libraryExists.

Doc from jakarta.faces.application.ResourceHandler.libraryExists.

Return true if the resource library named by the argument libraryName can be found. If there is a localePrefix for this application, as defined in LOCALE_PREFIX, first look for the library with the prefix. If no such library is found, look for the library without the prefix. This allows developers to avoid duplication of files. For example, consider the case where the developer wants to have a resource library containing a localized image resource and a non-localized script resource. By checking both locations for the existence of the library, along with other spec changes in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document, this scenario is enabled.

Parameters

libraryName:String: the library name.

Returns:boolean

true if the library exists, false otherwise.

Annotations

@Override

libraryNameIsSafe	back to summary
private boolean libraryNameIsSafe(String libraryName)

logMissingResource back to summary

logMissingResource	back to summary
private void logMissingResource(FacesContext ctx, String resourceName, String libraryName, Throwable t) Log a message indicating a particular resource (reference by name and/or library) could not be found. If this was due to an exception, the exception provided will be logged as well. Parameters ctx:FacesContext the `FacesContext` for the current request resourceName:String the resource name libraryName:String the resource library t:Throwable the exception caught when attempting to find the resource

private void logMissingResource(FacesContext ctx, String resourceName, String libraryName, Throwable t)

Log a message indicating a particular resource (reference by name and/or library) could not be found. If this was due to an exception, the exception provided will be logged as well.

Parameters

ctx:FacesContext: the FacesContext for the current request
resourceName:String: the resource name
libraryName:String: the resource library
t:Throwable: the exception caught when attempting to find the resource

logMissingResource back to summary

logMissingResource	back to summary
private void logMissingResource(FacesContext ctx, String resourceId, Throwable t) Log a message indicating a particular resource (reference by name and/or library) could not be found. If this was due to an exception, the exception provided will be logged as well. Parameters ctx:FacesContext the `FacesContext` for the current request resourceId:String the resource name t:Throwable the exception caught when attempting to find the resource

private void logMissingResource(FacesContext ctx, String resourceId, Throwable t)

Log a message indicating a particular resource (reference by name and/or library) could not be found. If this was due to an exception, the exception provided will be logged as well.

Parameters

ctx:FacesContext: the FacesContext for the current request
resourceId:String: the resource name
t:Throwable: the exception caught when attempting to find the resource

normalizeResourceRequest back to summary

normalizeResourceRequest	back to summary
private String normalizeResourceRequest(FacesContext context) Normalize the request path to exclude Faces invocation information. If the FacesServlet servicing this request was extension mapped, then the extension will be trimmed off. If the FacesServlet servicing this request was prefix mapped, then the path to the FacesServlet will be removed. Parameters context:FacesContext the `FacesContext` for the current request Returns:String the request path without Faces invocation information

private String normalizeResourceRequest(FacesContext context)

Normalize the request path to exclude Faces invocation information.

If the FacesServlet servicing this request was extension mapped, then the extension will be trimmed off.

If the FacesServlet servicing this request was prefix mapped, then the path to the FacesServlet will be removed.

Parameters

context:FacesContext: the FacesContext for the current request

Returns:String

the request path without Faces invocation information

send304	back to summary
private void send304(FacesContext ctx)

send404	back to summary
private void send404(FacesContext ctx, String resourceName, String libraryName, boolean logMessage)

send404	back to summary
private void send404(FacesContext ctx, String resourceName, String libraryName, Throwable t, boolean logMessage)

setCreationTime	back to summary
pack-priv void setCreationTime(long creationTime) This method is here soley for the purpose of unit testing and will not be invoked during normal runtime. Parameters creationTime:long the time in milliseconds Annotations @SuppressWarnings:UnusedDeclaration

setCreationTime

back to summary

pack-priv void setCreationTime(long creationTime)

This method is here soley for the purpose of unit testing and will not be invoked during normal runtime.

Parameters

creationTime:long: the time in milliseconds

Annotations

@SuppressWarnings:UnusedDeclaration

public Class ResourceHandlerImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail