Provides a simple
implementation of ResourceHandler that can be subclassed by developers wishing to provide specialized
behavior to an existing ResourceHandler instance. The default implementation of all methods is to call
through to the wrapped ResourceHandler.
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to
access the instance being wrapped.
| Modifier and Type | Field and Description |
|---|---|
| private ResourceHandler |
| Access | Constructor and Description |
|---|---|
| public | ResourceHandlerWrapper()
Deprecated
Use the other constructor taking the implementation being wrapped.
|
| public | ResourceHandlerWrapper(ResourceHandler
The implementation being wrapped. wrapped)If this resource handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public Resource | createResource(String
the name of the resource. resourceName)Implements abstract jakarta.
The default behavior of this method is to call |
| 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 libraryName)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 "../".Implements abstract jakarta.
The default behavior of this method is to call |
| public Resource | createResource(String
the name of the resource. resourceName, String the name of the library in which this resource resides, may be libraryName, String null.
May not include relative paths, such as "../".the mime content that this contentType)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.Implements abstract jakarta.
The default behavior of this method is to call |
| public Resource | createResourceFromId(String
the resource identifier of the resource. resourceId)Overrides jakarta.
The default behavior of this method is to call |
| public ViewResource | createViewResource(FacesContext
the context, String FacesContext for this request.the name of the resource to be interpreted as a view by the
resourceName)jakarta..Overrides jakarta.
The default behavior of this method is to call |
| public String | getRendererTypeForResourceName(String
the resource name. resourceName)Implements abstract jakarta.
The default behavior of this method is to call |
| public Stream | getViewResources(FacesContext
The facesContext, String FacesContext for this request.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 options)ResourceVisitOption for details on those.Overrides jakarta.
The default behavior of this method is to call
|
| public Stream | getViewResources(FacesContext
The facesContext, String FacesContext for this request.The initial path from which to start looking for view resources path, ResourceVisitOption... The options to influence the traversal. See options)ResourceVisitOption for details on those.Overrides jakarta.
The default behavior of this method is to call
|
| public ResourceHandler | getWrapped()
Implements jakarta. A class that implements this interface uses this method to return an instance of the class being wrapped. |
| public void | handleResourceRequest(FacesContext
the context)jakarta. for this requestImplements abstract jakarta.
The default behavior of this method is to call
|
| public boolean | isResourceRendered(FacesContext
The context, String FacesContext for this request.The name of the resource. resourceName, String The name of the library in which this resource resides, may be libraryName)null.Overrides jakarta.
The default behavior of this method is to call
|
| public boolean | isResourceRequest(FacesContext
the context)jakarta. for this requestImplements abstract jakarta.
The default behavior of this method is to call
|
| public boolean | isResourceURL(String
the url to inspect for the presence of url)ResourceHandler#RESOURCE_IDENTIFIER.Overrides jakarta.
The default behavior of this method is to call |
| public boolean | libraryExists(String
the library name. libraryName)Implements abstract jakarta.
The default behavior of this method is to call |
| public void | markResourceRendered(FacesContext
The context, String FacesContext for this request.The name of the resource. resourceName, String The name of the library in which the resource resides, may be libraryName)null.Overrides jakarta.
The default behavior of this method is to call
|
| wrapped | back to summary |
|---|---|
| private ResourceHandler wrapped | |
| ResourceHandlerWrapper | back to summary |
|---|---|
| public ResourceHandlerWrapper()
Deprecated Use the other constructor taking the implementation being wrapped.
| |
| ResourceHandlerWrapper | back to summary |
|---|---|
| public ResourceHandlerWrapper(ResourceHandler wrapped)
If this resource handler has been decorated, the implementation doing the decorating should push the implementation
being wrapped to this constructor. The
| |
| createResource | back to summary |
|---|---|
| public Resource createResource(String resourceName) Implements abstract jakarta.
The default behavior of this method is to call
| |
| createResource | back to summary |
|---|---|
| public Resource createResource(String resourceName, String libraryName) Implements abstract jakarta.
The default behavior of this method is to call
| |
| createResource | back to summary |
|---|---|
| public Resource createResource(String resourceName, String libraryName, String contentType) Implements abstract jakarta.
The default behavior of this method is to call
| |
| createResourceFromId | back to summary |
|---|---|
| public Resource createResourceFromId(String resourceId) Overrides jakarta.
The default behavior of this method is to call
| |
| createViewResource | back to summary |
|---|---|
| public ViewResource createViewResource(FacesContext context, String resourceName) Overrides jakarta.
The default behavior of this method is to call
| |
| getRendererTypeForResourceName | back to summary |
|---|---|
| public String getRendererTypeForResourceName(String resourceName) Implements abstract jakarta.
The default behavior of this method is to call
| |
| getViewResources | back to summary |
|---|---|
| public Stream Overrides jakarta.
The default behavior of this method is to call
| |
| getWrapped | back to summary |
|---|---|
| public ResourceHandler getWrapped() Implements jakarta. Doc from jakarta. A class that implements this interface uses this method to return an instance of the class being wrapped.
| |
| handleResourceRequest | back to summary |
|---|---|
| public void handleResourceRequest(FacesContext context) throws IOException Implements abstract jakarta.
The default behavior of this method is to call
| |
| isResourceRendered | back to summary |
|---|---|
| public boolean isResourceRendered(FacesContext context, String resourceName, String libraryName) Overrides jakarta.
The default behavior of this method is to call
| |
| isResourceRequest | back to summary |
|---|---|
| public boolean isResourceRequest(FacesContext context) Implements abstract jakarta.
The default behavior of this method is to call
| |
| isResourceURL | back to summary |
|---|---|
| public boolean isResourceURL(String url) Overrides jakarta.
The default behavior of this method is to call
| |
| libraryExists | back to summary |
|---|---|
| public boolean libraryExists(String libraryName) Implements abstract jakarta.
The default behavior of this method is to call
| |
| markResourceRendered | back to summary |
|---|---|
| public void markResourceRendered(FacesContext context, String resourceName, String libraryName) Overrides jakarta.
The default behavior of this method is to call
| |