com.haulmont.cuba.core.app

Interface ConfigStorageAPI

All Known Implementing Classes:

ConfigStorage

public interface ConfigStorageAPI

Supports configuration parameters framework functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear properties cache.
java.util.Map<java.lang.String,java.lang.String>	getDbProperties() Loads all properties stored in the database.
java.lang.String	getDbProperty(java.lang.String name) Loads a property from the database.
void	setDbProperty(java.lang.String name, java.lang.String value) Saves a property into the database.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getDbProperties

java.util.Map<java.lang.String,java.lang.String> getDbProperties()

Loads all properties stored in the database.

Returns:

the properties map

getDbProperty

@Nullable
java.lang.String getDbProperty(java.lang.String name)

Loads a property from the database.

Parameters:

name - property name

Returns:

property value or null if not found

setDbProperty

void setDbProperty(java.lang.String name,
                   @Nullable
                   java.lang.String value)

Saves a property into the database.

If an active transaction exists, it will be used without creating a new one. This allows you to include saving properties into your business logic. If you want to separate the property saving, just start a new transaction prior to calling this method.

Parameters:

name - property name

value - property value

clearCache

void clearCache()

Clear properties cache. Invoke this method if you changed the properties directly in the database.