org.broadleafcommerce.common.config.service

Class SystemPropertiesServiceImpl

java.lang.Object

org.broadleafcommerce.common.config.service.SystemPropertiesServiceImpl

All Implemented Interfaces:

SystemPropertiesService

@Service(value="blSystemPropertiesService")
public class SystemPropertiesServiceImpl
extends Object
implements SystemPropertiesService

Service that retrieves property settings from the database. If not set in the DB then returns the value from property files.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.cache.CacheManager	cacheManager
protected org.springframework.core.env.Environment	env
protected static String	ENV_CACHE_PREFIX
protected SystemPropertyServiceExtensionManager	extensionManager
protected static ThreadLocal<Boolean>	originatedFromEnvironment If the property resoltion comes from the Spring Environment I don't want to try to re-resolve a property from the Environment.
static String	PROPERTY_SOURCE_NAME
protected static String	SYSTEM_PROPERTY_CACHE_NAME
protected SystemPropertiesDao	systemPropertiesDao
protected javax.cache.Cache<String,String>	systemPropertyCache
protected int	systemPropertyCacheTimeout

Constructor Summary

Constructors

Constructor and Description
SystemPropertiesServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addPropertyToCache(String propertyName, String propertyValue)
protected String	buildKey(String propertyName) Properties can vary by site.
protected String	buildKey(String propertyName, Long siteId)
protected String	buildKey(String propertyName, Long siteId, boolean forceEnvPrefix)
protected String	buildKey(SystemProperty systemProperty) Properties can vary by site.
protected String	buildKey(SystemProperty systemProperty, boolean forceEnvPrefix)
SystemProperty	findById(Long id) Finds a SystemProperty by its internal id
protected String	getCacheName()
protected String	getPropertyFromCache(String propertyName)
protected javax.cache.Cache<String,String>	getSystemPropertyCache()
boolean	isValueValidForType(String value, SystemPropertyFieldType type) Determines if the given value is valid for the specified type
void	removeFromCache(SystemProperty systemProperty) Evicts the given SystemProperty from the cache
boolean	resolveBooleanSystemProperty(String name) Resolves a boolean system property.
boolean	resolveBooleanSystemProperty(String name, boolean defaultValue)
int	resolveIntSystemProperty(String name) Resolves an int system property.
int	resolveIntSystemProperty(String name, int defaultValue)
long	resolveLongSystemProperty(String name) Resolves an long system property.
long	resolveLongSystemProperty(String name, long defaultValue)
String	resolveSystemProperty(String name) Preferred method for looking up properties.
String	resolveSystemProperty(String name, String defaultValue)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SOURCE_NAME

public static final String PROPERTY_SOURCE_NAME

See Also:

Constant Field Values

ENV_CACHE_PREFIX

protected static final String ENV_CACHE_PREFIX

See Also:

Constant Field Values

SYSTEM_PROPERTY_CACHE_NAME

protected static final String SYSTEM_PROPERTY_CACHE_NAME

See Also:

Constant Field Values

originatedFromEnvironment

protected static final ThreadLocal<Boolean> originatedFromEnvironment

If the property resoltion comes from the Spring Environment I don't want to try to re-resolve a property from the Environment. This ensures that we don't get a StackOverflowException

systemPropertyCache

protected javax.cache.Cache<String,String> systemPropertyCache

systemPropertiesDao

protected SystemPropertiesDao systemPropertiesDao

extensionManager

protected SystemPropertyServiceExtensionManager extensionManager

systemPropertyCacheTimeout

@Value(value="${system.property.cache.timeout}")
protected int systemPropertyCacheTimeout

cacheManager

protected javax.cache.CacheManager cacheManager

env

@Autowired
protected org.springframework.core.env.Environment env

Constructor Detail

SystemPropertiesServiceImpl

public SystemPropertiesServiceImpl()

Method Detail

resolveSystemProperty

public String resolveSystemProperty(String name,
                                    String defaultValue)

Specified by:

resolveSystemProperty in interface SystemPropertiesService

resolveSystemProperty

public String resolveSystemProperty(String name)

Description copied from interface: SystemPropertiesService

Preferred method for looking up properties. The method will return the configured value or if no override value is found, it will return the value passed in to the method as the default value.

Specified by:

resolveSystemProperty in interface SystemPropertiesService

Returns:

addPropertyToCache

protected void addPropertyToCache(String propertyName,
                                  String propertyValue)

getPropertyFromCache

protected String getPropertyFromCache(String propertyName)

buildKey

protected String buildKey(String propertyName)

Properties can vary by site. If a site is found on the request, use the site id as part of the cache-key.

Parameters:

propertyName -

Returns:

buildKey

protected String buildKey(SystemProperty systemProperty)

Properties can vary by site. If a site is found on the request, use the site id as part of the cache-key.

Parameters:

systemProperty -

Returns:

buildKey

protected String buildKey(SystemProperty systemProperty,
                          boolean forceEnvPrefix)

buildKey

protected String buildKey(String propertyName,
                          Long siteId)

buildKey

protected String buildKey(String propertyName,
                          Long siteId,
                          boolean forceEnvPrefix)

getSystemPropertyCache

protected javax.cache.Cache<String,String> getSystemPropertyCache()

getCacheName

protected String getCacheName()

findById

public SystemProperty findById(Long id)

Description copied from interface: SystemPropertiesService

Finds a SystemProperty by its internal id

Specified by:

findById in interface SystemPropertiesService

Returns:

the SystemProperty

removeFromCache

public void removeFromCache(SystemProperty systemProperty)

Description copied from interface: SystemPropertiesService

Evicts the given SystemProperty from the cache

Specified by:

removeFromCache in interface SystemPropertiesService

resolveIntSystemProperty

public int resolveIntSystemProperty(String name)

Description copied from interface: SystemPropertiesService

Resolves an int system property. Returns 0 when no matching property is found.

Specified by:

resolveIntSystemProperty in interface SystemPropertiesService

Returns:

resolveIntSystemProperty

public int resolveIntSystemProperty(String name,
                                    int defaultValue)

Specified by:

resolveIntSystemProperty in interface SystemPropertiesService

resolveBooleanSystemProperty

public boolean resolveBooleanSystemProperty(String name)

Description copied from interface: SystemPropertiesService

Resolves a boolean system property. Returns false when no matching system property is found.

Specified by:

resolveBooleanSystemProperty in interface SystemPropertiesService

Returns:

resolveBooleanSystemProperty

public boolean resolveBooleanSystemProperty(String name,
                                            boolean defaultValue)

Specified by:

resolveBooleanSystemProperty in interface SystemPropertiesService

resolveLongSystemProperty

public long resolveLongSystemProperty(String name)

Description copied from interface: SystemPropertiesService

Resolves an long system property. Returns 0 when no matching property is found.

Specified by:

resolveLongSystemProperty in interface SystemPropertiesService

Returns:

resolveLongSystemProperty

public long resolveLongSystemProperty(String name,
                                      long defaultValue)

Specified by:

resolveLongSystemProperty in interface SystemPropertiesService

isValueValidForType

public boolean isValueValidForType(String value,
                                   SystemPropertyFieldType type)

Description copied from interface: SystemPropertiesService

Determines if the given value is valid for the specified type

Specified by:

isValueValidForType in interface SystemPropertiesService

Returns:

whether or not the SystemProperty is in a valid state