org.broadleafcommerce.presentation.resolver

Interface BroadleafTemplateResolver

All Known Implementing Classes:

AbstractBroadleafTemplateResolver, BroadleafClasspathTemplateResolver, BroadleafDatabaseTemplateResolver, BroadleafThemeAwareTemplateResolver

public interface BroadleafTemplateResolver

Class used to indicate a new Template Resolver to be used to resolve file names

Author:

Jay Aisenbrey (cja769)

Method Summary

Methods

Modifier and Type	Method and Description
Long	getCacheTTLMs()
String	getCharacterEncoding()
Integer	getOrder()
String	getPrefix()
BroadleafTemplateResolverType	getResolverType()
String	getSuffix()
String	getTemplateFolder()
BroadleafTemplateMode	getTemplateMode()
Boolean	isCacheable()
Boolean	isEmailResolver()
InputStream	resolveResource(String template, String resourceName) Custom logic for resolving the given resource.

Method Detail

getPrefix

String getPrefix()

Returns:

The string that should be automatically added to the beginning of given template name (i.e. for servlet template resolvers /WEB-INF/)

getSuffix

String getSuffix()

Returns:

The string that should be automatically added to the end of given template name (i.e. .html)

getTemplateFolder

String getTemplateFolder()

Returns:

The string that should be added after the prefix but before the given template name to designate set of templates (i.e. templates/) note string should end in a /

isCacheable

Boolean isCacheable()

Returns:

A boolean indicating if the templates resolved through the template resolver should be cached

getCacheTTLMs

Long getCacheTTLMs()

Returns:

The amount of time (in minutes) for a template to live in cache

getCharacterEncoding

String getCharacterEncoding()

Returns:

The character encoding of the templates that this resolver returns (i.e. Usually UTF-8)

getOrder

Integer getOrder()

Returns:

The order in the list of all BroadleafThymeleafTemplateResolver that this resolver should run

getTemplateMode

BroadleafTemplateMode getTemplateMode()

Returns:

The type of templates this resolver resolves for

getResolverType

BroadleafTemplateResolverType getResolverType()

Returns:

The type of resolver this resolver is

isEmailResolver

Boolean isEmailResolver()

Returns:

true if this resolver should be in the set of email resolvers

resolveResource

InputStream resolveResource(String template,
                          String resourceName)

Custom logic for resolving the given resource.

Parameters:

template -

resourceName -

Returns:

The requested resource as an input stream.