org.broadleafcommerce.presentation.resolver

Class AbstractBroadleafTemplateResolver

java.lang.Object

org.broadleafcommerce.presentation.resolver.AbstractBroadleafTemplateResolver

All Implemented Interfaces:

BroadleafTemplateResolver

Direct Known Subclasses:

BroadleafClasspathTemplateResolver, BroadleafDatabaseTemplateResolver, BroadleafThemeAwareTemplateResolver

public abstract class AbstractBroadleafTemplateResolver
extends Object
implements BroadleafTemplateResolver

Abstract implementation of BroadleafTemplateResolver that has some defaults. Most of the time you'll want to create a bean of an existing implementation of this class.

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	cacheable
protected Long	cacheTimeToLive
protected String	characterEncoding
protected Boolean	emailResolver
protected Integer	order
protected String	prefix
protected String	suffix
protected String	templateFolder
protected BroadleafTemplateMode	templateMode

Constructor Summary

Constructors

Constructor and Description
AbstractBroadleafTemplateResolver()

Method Summary

Modifier and Type	Method and Description
Long	getCacheTTLMs()
String	getCharacterEncoding()
Integer	getOrder()
String	getPrefix()
String	getSuffix()
String	getTemplateFolder()
BroadleafTemplateMode	getTemplateMode()
Boolean	isCacheable()
Boolean	isEmailResolver()
InputStream	resolveResource(String template, String resourceName) Custom logic for resolving the given resource.
void	setCacheable(Boolean cacheable)
void	setCacheTTLMs(Long cacheTimeToLive)
void	setCharacterEncoding(String characterEncoding)
void	setEmailResolver(Boolean emailResolver)
void	setOrder(Integer order)
void	setPrefix(String prefix)
void	setSuffix(String suffix)
void	setTemplateFolder(String templateFolder)
void	setTemplateMode(BroadleafTemplateMode templateMode)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.presentation.resolver.BroadleafTemplateResolver

getResolverType

Field Detail

prefix

protected String prefix

suffix

protected String suffix

templateFolder

protected String templateFolder

cacheable

protected Boolean cacheable

cacheTimeToLive

protected Long cacheTimeToLive

characterEncoding

protected String characterEncoding

order

protected Integer order

templateMode

protected BroadleafTemplateMode templateMode

emailResolver

protected Boolean emailResolver

Constructor Detail

AbstractBroadleafTemplateResolver

public AbstractBroadleafTemplateResolver()

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface BroadleafTemplateResolver

Returns:

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

setPrefix

public void setPrefix(String prefix)

getSuffix

public String getSuffix()

Specified by:

getSuffix in interface BroadleafTemplateResolver

Returns:

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

setSuffix

public void setSuffix(String suffix)

getTemplateFolder

public String getTemplateFolder()

Specified by:

getTemplateFolder in interface BroadleafTemplateResolver

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 /

setTemplateFolder

public void setTemplateFolder(String templateFolder)

isCacheable

public Boolean isCacheable()

Specified by:

isCacheable in interface BroadleafTemplateResolver

Returns:

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

setCacheable

public void setCacheable(Boolean cacheable)

getCacheTTLMs

public Long getCacheTTLMs()

Specified by:

getCacheTTLMs in interface BroadleafTemplateResolver

Returns:

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

setCacheTTLMs

public void setCacheTTLMs(Long cacheTimeToLive)

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface BroadleafTemplateResolver

Returns:

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

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)

getOrder

public Integer getOrder()

Specified by:

getOrder in interface BroadleafTemplateResolver

Returns:

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

setOrder

public void setOrder(Integer order)

getTemplateMode

public BroadleafTemplateMode getTemplateMode()

Specified by:

getTemplateMode in interface BroadleafTemplateResolver

Returns:

The type of templates this resolver resolves for

setTemplateMode

public void setTemplateMode(BroadleafTemplateMode templateMode)

isEmailResolver

public Boolean isEmailResolver()

Specified by:

isEmailResolver in interface BroadleafTemplateResolver

Returns:

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

setEmailResolver

public void setEmailResolver(Boolean emailResolver)

resolveResource

public InputStream resolveResource(String template,
                                   String resourceName)

Description copied from interface: BroadleafTemplateResolver

Custom logic for resolving the given resource.

Specified by:

resolveResource in interface BroadleafTemplateResolver

Returns:

The requested resource as an input stream.