org.opennms.core.utils

Class PropertiesCache

java.lang.Object

org.opennms.core.utils.PropertiesCache

public class PropertiesCache
extends Object

Caches properties files in order to improve performance.

Version:

$Id: $

Author:

Mathew Brozowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PropertiesCache.PropertiesHolder

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_TIMEOUT
static String	CHECK_LAST_MODIFY_STRING
static int	DEFAULT_CACHE_TIMEOUT
protected com.google.common.cache.Cache<String,PropertiesCache.PropertiesHolder>	m_cache

Constructor Summary

Constructors

Modifier	Constructor and Description
	PropertiesCache()
protected	PropertiesCache(com.google.common.cache.CacheBuilder<Object,Object> cacheBuilder)

Method Summary

Modifier and Type	Method and Description
void	clear() clear
Properties	findProperties(File propFile) findProperties
Properties	getProperties(File propFile) Get the current properties object from the cache loading it in memory
String	getProperty(File propFile, String key) getProperty
void	saveProperties(File propFile, Map<String,String> attributeMappings)
void	saveProperties(File propFile, Properties properties) saveProperties
void	setProperty(File propFile, String key, String value) setProperty
void	updateProperties(File propFile, Map<String,String> props) updateProperties

Methods inherited from class java.lang.Object

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

Field Detail

CHECK_LAST_MODIFY_STRING

public static final String CHECK_LAST_MODIFY_STRING

See Also:

Constant Field Values

CACHE_TIMEOUT

public static final String CACHE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CACHE_TIMEOUT

public static final int DEFAULT_CACHE_TIMEOUT

See Also:

Constant Field Values

m_cache

protected final com.google.common.cache.Cache<String,PropertiesCache.PropertiesHolder> m_cache

Constructor Detail

PropertiesCache

public PropertiesCache()

PropertiesCache

protected PropertiesCache(com.google.common.cache.CacheBuilder<Object,Object> cacheBuilder)

Method Detail

clear

public void clear()

clear

getProperties

public Properties getProperties(File propFile)
                         throws IOException

Get the current properties object from the cache loading it in memory

Parameters:

propFile - a File object.

Returns:

a Properties object.

Throws:

IOException - if any.

findProperties

public Properties findProperties(File propFile)
                          throws IOException

findProperties

Parameters:

propFile - a File object.

Returns:

a Properties object.

Throws:

IOException - if any.

saveProperties

public void saveProperties(File propFile,
                           Properties properties)
                    throws IOException

saveProperties

Parameters:

propFile - a File object.

properties - a Properties object.

Throws:

IOException - if any.

saveProperties

public void saveProperties(File propFile,
                           Map<String,String> attributeMappings)
                    throws IOException

Throws:

IOException

updateProperties

public void updateProperties(File propFile,
                             Map<String,String> props)
                      throws IOException

updateProperties

Parameters:

propFile - a File object.

props - a Map object.

Throws:

IOException - if any.

setProperty

public void setProperty(File propFile,
                        String key,
                        String value)
                 throws IOException

setProperty

Parameters:

propFile - a File object.

key - a String object.

value - a String object.

Throws:

IOException - if any.

getProperty

public String getProperty(File propFile,
                          String key)
                   throws IOException

getProperty

Parameters:

propFile - a File object.

key - a String object.

Returns:

a String object.

Throws:

IOException - if any.