Module org.omnifaces

Package org.omnifaces.resourcehandler

Class GraphicResourceHandler

java.lang.Object

jakarta.faces.application.ResourceHandler

jakarta.faces.application.ResourceHandlerWrapper

org.omnifaces.resourcehandler.DefaultResourceHandler

org.omnifaces.resourcehandler.GraphicResourceHandler

All Implemented Interfaces:

FacesWrapper<ResourceHandler>

public class GraphicResourceHandler
extends DefaultResourceHandler

This ResourceHandler implementation deals with GraphicResource requests.

Since:

2.0

Author:

Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field	Description
static String	LIBRARY_NAME	The default library name of a graphic resource.

Fields inherited from class org.omnifaces.resourcehandler.DefaultResourceHandler

FACES_SCRIPT_RESOURCE_NAME, RES_NOT_FOUND

Fields inherited from class jakarta.faces.application.ResourceHandler

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
GraphicResourceHandler(ResourceHandler wrapped)	Creates a new instance of this graphic resource handler which wraps the given resource handler.

Method Summary

Modifier and Type	Method	Description
Resource	createResourceFromLibrary(String resourceName, String contentType)	Returns a new GraphicResource.
String	getLibraryName()	Returns LIBRARY_NAME.

Methods inherited from class org.omnifaces.resourcehandler.DefaultResourceHandler

createResource, createResource, createResource, decorateResource, decorateResource

Methods inherited from class jakarta.faces.application.ResourceHandlerWrapper

createResourceFromId, createViewResource, getRendererTypeForResourceName, getViewResources, getViewResources, getWrapped, handleResourceRequest, isResourceRendered, isResourceRequest, isResourceURL, libraryExists, markResourceRendered

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_NAME

public static final String LIBRARY_NAME

The default library name of a graphic resource. Make sure that this is never used for other libraries.

See Also:

Constant Field Values

Constructor Detail

GraphicResourceHandler

public GraphicResourceHandler(ResourceHandler wrapped)

Creates a new instance of this graphic resource handler which wraps the given resource handler.

Parameters:

wrapped - The resource handler to be wrapped.

Method Detail

getLibraryName

public String getLibraryName()

Returns LIBRARY_NAME.

Overrides:

getLibraryName in class DefaultResourceHandler

Returns:

The library name on which this resource handler implementation should listen.

createResourceFromLibrary

public Resource createResourceFromLibrary(String resourceName,
                                          String contentType)

Returns a new GraphicResource.

Overrides:

createResourceFromLibrary in class DefaultResourceHandler

Parameters:

resourceName - The resource name.

contentType - The content type.

Returns:

The library-specific resource.