com.broadleafcommerce.theme.service

Interface ThemeService

All Known Implementing Classes:

ThemeServiceImpl

public interface ThemeService

Service interface for performing theme operations.

Author:

Andre Azzolini (apazzolini), Brian Polster (bpolster)

Method Summary

Modifier and Type	Method and Description
ThemeDefinition	findDefaultThemeDefinition()
ThemeConfiguration	findThemeById(Long id)
ThemeDefinition	findThemeDefinitionById(Long id)
Map<String,ThemeField>	findThemeFieldMapByThemeId(Long themeId) Return a map of the ThemeFields for the passed in ThemeId
ThemeConfiguration	getCurrentTheme()
String	getDefaultThemeBaseDirectory() Returns the default base directory for theme files.
String	getThemeResourceLocation(String resourcePath) Returns a directory that should be prefixed in front of the resource to find file system based Theme resources.
String	replaceCssThemeFields(String contents, ThemeConfiguration tc)
String	replaceJsThemeFields(String contents, ThemeConfiguration tc)
ThemeConfiguration	save(ThemeConfiguration themeConfiguration) Saves a theme to the database
void	setDefaultThemeBaseDirectory(String defaultThemeBaseDirectory) Sets the default theme base directory.

Method Detail

getCurrentTheme

ThemeConfiguration getCurrentTheme()

Returns:

the currently activated theme

findThemeById

ThemeConfiguration findThemeById(Long id)

Parameters:

id -

Returns:

the theme identified by the given id

findThemeFieldMapByThemeId

Map<String,ThemeField> findThemeFieldMapByThemeId(Long themeId)

Return a map of the ThemeFields for the passed in ThemeId

Parameters:

themeId -

Returns:

save

ThemeConfiguration save(ThemeConfiguration themeConfiguration)

Saves a theme to the database

Parameters:

themeConfiguration -

Returns:

the saved theme

findThemeDefinitionById

ThemeDefinition findThemeDefinitionById(Long id)

Parameters:

id -

Returns:

the theme definition identified by the given id

findDefaultThemeDefinition

ThemeDefinition findDefaultThemeDefinition()

Returns:

the default theme definition

getDefaultThemeBaseDirectory

String getDefaultThemeBaseDirectory()

Returns the default base directory for theme files. Returns "/WEB-INF/" if not explicitly set

Returns:

setDefaultThemeBaseDirectory

void setDefaultThemeBaseDirectory(String defaultThemeBaseDirectory)

Sets the default theme base directory. This method ensures that the value both starts and ends with a "/".

Parameters:

defaultThemeBaseDirectory -

getThemeResourceLocation

String getThemeResourceLocation(String resourcePath)

Returns a directory that should be prefixed in front of the resource to find file system based Theme resources.

Spring's SimpleUrlHandlerMapping is normally used to serve static resources. Broadeaf's sample application contains URL mapping configuration similar to the following :

 
   
   
       
          blJsResources
          blCssResources
          blImageResources
          blFontResources
      
  
 
 

If a resource is matched using one of the patterns above, the pattern is stripped off of the request path prior to it being sent to the ThemeFileResourceResolver. For example, "/css/style.css" will come through as just "style.css".

This method looks up the mapping string which is set at HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE by Spring's AbstractUrlHandlerMapping which SimpleUrlHandlerMapping extends.

The resourcePath is passed in for possible override needs but is not used by the default implementation.

The result of this method is to return the proper path to the resource within a themeBaseDirectory. It depends on both Theme and Request being set on the BroadleafRequestContext

Parameters:

resourcePath -

replaceCssThemeFields

String replaceCssThemeFields(String contents,
                             ThemeConfiguration tc)

replaceJsThemeFields

String replaceJsThemeFields(String contents,
                            ThemeConfiguration tc)