Module jakarta.faces

Package com.sun.faces.application.resource

Class ClasspathResourceHelper

java.lang.Object

com.sun.faces.application.resource.ResourceHelper

com.sun.faces.application.resource.ClasspathResourceHelper

public class ClasspathResourceHelper
extends ResourceHelper

A ResourceHelper implementation for finding/serving resources found on the classpath within the META-INF/resources directory.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
ClasspathResourceHelper()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LibraryInfo	findLibrary(String libraryName, String localePrefix, String contract, FacesContext ctx)	Search for the specified library/localPrefix combination in an implementation dependent manner.
LibraryInfo	findLibraryWithZipDirectoryEntryScan(String libraryName, String localePrefix, String contract, FacesContext ctx, boolean forceScan)
ResourceInfo	findResource(LibraryInfo library, String resourceName, String localePrefix, boolean compressable, FacesContext ctx)	Search for the specified resource based in the library/localePrefix/resourceName combination in an implementation dependent manner.
String	getBaseContractsPath()
String	getBaseResourcePath()
protected InputStream	getNonCompressedInputStream(ResourceInfo resource, FacesContext ctx)	If a ResourceInfo is not compressable, ResourceHelper.getInputStream(ResourceInfo, jakarta.faces.context.FacesContext) will call this method to return a stream to the actual resource.
URL	getURL(ResourceInfo resource, FacesContext ctx)
int	hashCode()

Methods inherited from class com.sun.faces.application.resource.ResourceHelper

clientAcceptsCompression, compressContent, getBasePath, getInputStream, getLastModified, getLocalizedPaths, getVersion, handleCompression, resourceSupportsEL, trimLeadingSlash

Methods inherited from class java.lang.Object

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

Constructor Details

ClasspathResourceHelper

public ClasspathResourceHelper()

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getBaseResourcePath

public String getBaseResourcePath()

Specified by:

getBaseResourcePath in class ResourceHelper

Returns:

the base path in which resources will be stored

See Also:

• ResourceHelper.getBaseResourcePath()

getBaseContractsPath

public String getBaseContractsPath()

Specified by:

getBaseContractsPath in class ResourceHelper

getNonCompressedInputStream

protected InputStream getNonCompressedInputStream(ResourceInfo resource,
 FacesContext ctx)
                                           throws IOException

Description copied from class: ResourceHelper

If a ResourceInfo is not compressable, ResourceHelper.getInputStream(ResourceInfo, jakarta.faces.context.FacesContext) will call this method to return a stream to the actual resource.

Specified by:

getNonCompressedInputStream in class ResourceHelper

Parameters:

resource - the resource to obtain an InputStream to

ctx - the FacesContext for the current request

Returns:

an InputStream to the resource

Throws:

IOException - if an error occurs obtaining the stream

See Also:

• ResourceHelper.getNonCompressedInputStream(com.sun.faces.application.resource.ResourceInfo, jakarta.faces.context.FacesContext)

getURL

public URL getURL(ResourceInfo resource,
 FacesContext ctx)

Specified by:

getURL in class ResourceHelper

Parameters:

resource - the resource to obtain a URL reference to

ctx - the FacesContext for the current request

Returns:

a URL to the specified resource, otherwise null if no resource is found

See Also:

• ResourceHelper.getURL(com.sun.faces.application.resource.ResourceInfo, jakarta.faces.context.FacesContext)

findLibrary

public LibraryInfo findLibrary(String libraryName,
 String localePrefix,
 String contract,
 FacesContext ctx)

Description copied from class: ResourceHelper

Search for the specified library/localPrefix combination in an implementation dependent manner.

Specified by:

findLibrary in class ResourceHelper

Parameters:

libraryName - the name of the library

localePrefix - the logicial identifier for a locale specific library. if no localePrefix is configured, pass null

contract - the name of the contract

ctx - the FacesContext for the current request @return a LibraryInfo if a matching library based off the inputs can be found, otherwise returns null

Returns:

library info

See Also:

• ResourceHelper.findLibrary(String, String, String, jakarta.faces.context.FacesContext)

findLibraryWithZipDirectoryEntryScan

public LibraryInfo findLibraryWithZipDirectoryEntryScan(String libraryName,
 String localePrefix,
 String contract,
 FacesContext ctx,
 boolean forceScan)

findResource

public ResourceInfo findResource(LibraryInfo library,
 String resourceName,
 String localePrefix,
 boolean compressable,
 FacesContext ctx)

Description copied from class: ResourceHelper

Search for the specified resource based in the library/localePrefix/resourceName combination in an implementation dependent manner.

If the resource is found, and is compressable, call ResourceHelper.handleCompression(com.sun.faces.application.resource.ClientResourceInfo) to compress the content.

Specified by:

findResource in class ResourceHelper

Parameters:

library - the library this resource should be a part of. If the the resource that is being searched for isn't part of a library, then pass null

resourceName - the name of the resource that is being searched for

localePrefix - the logicial identifier for a locale specific library. if no localePrefix is configured, pass null

compressable - true if the resource can be compressed

ctx - the FacesContext for the current request

Returns:

a ResourceInfo if a matching resource based off the inputs can be found, otherwise returns null

See Also:

• ResourceHelper.findResource(LibraryInfo, String, String, boolean, jakarta.faces.context.FacesContext)