Module io.inverno.mod.configuration

Package io.inverno.mod.configuration.source

Class RedisConfigurationSource

java.lang.Object

io.inverno.mod.configuration.internal.AbstractConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,String,RedisConfigurationSource>

io.inverno.mod.configuration.internal.AbstractConfigurableConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,RedisConfigurationSource.RedisConfigurationUpdate,RedisConfigurationSource.RedisExecutableConfigurationUpdate,String,RedisConfigurationSource>

io.inverno.mod.configuration.source.RedisConfigurationSource

All Implemented Interfaces:

ConfigurableConfigurationSource, ConfigurationSource, DefaultableConfigurationSource

public class RedisConfigurationSource
extends io.inverno.mod.configuration.internal.AbstractConfigurableConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,RedisConfigurationSource.RedisConfigurationUpdate,RedisConfigurationSource.RedisExecutableConfigurationUpdate,String,RedisConfigurationSource>
implements DefaultableConfigurationSource

A configurable configuration source that stores and looks up properties in a Redis data store.

Configuration are stored as string entries, the property key is of the form: keyPrefix ":PROP:" propertyName "[" [ key "=" value [ "," key "=" value ]* "]".

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisConfigurationSource.RedisConfigurationQuery	The configuration query used by the Redis configuration source.
static class	RedisConfigurationSource.RedisConfigurationUpdate	The configuration update used by the Redis configuration source.
static class	RedisConfigurationSource.RedisExecutableConfigurationQuery	The executable configuration query used by the Redis configuration source.
static class	RedisConfigurationSource.RedisExecutableConfigurationUpdate	The executable configuration update used by the Redis configuration source.
static class	RedisConfigurationSource.RedisListConfigurationQuery	The list configuration query used by the Redis configuration source.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KEY_PREFIX	The default key prefix.

Fields inherited from class io.inverno.mod.configuration.internal.AbstractConfigurableConfigurationSource

encoder

Fields inherited from class io.inverno.mod.configuration.internal.AbstractConfigurationSource

decoder, defaultParameters, original

Constructor Summary

Constructors

Constructor	Description
RedisConfigurationSource(RedisClient<String,String> redisClient)	Creates a redis configuration source with the specified redis client.
RedisConfigurationSource(RedisClient<String,String> redisClient, JoinablePrimitiveEncoder<String> encoder, SplittablePrimitiveDecoder<String> decoder)	Creates a redis configuration source with the specified redis client, string value encoder and decoder.

Method Summary

Modifier and Type	Method	Description
RedisConfigurationSource.RedisExecutableConfigurationQuery	get(String... names)	Creates a configuration query to retrieve the specified properties.
final String	getKeyPrefix()	Returns the prefix that is prepended to configuration property keys.
RedisConfigurationSource.RedisListConfigurationQuery	list(String name)	Creates a list configuration query to list configuration properties defined with the specified property name.
RedisConfigurationSource.RedisExecutableConfigurationUpdate	set(Map<String,Object> values)	Creates a configuration update to set the configuration properties extracted from the specified values.
final void	setKeyPrefix(String keyPrefix)	Sets the prefix that is prepended to configuration property keys.
RedisConfigurationSource	unwrap()	Returns the original configuration source.
RedisConfigurationSource	withDefaultingStrategy(DefaultingStrategy defaultingStrategy)	Returns a proxy of the defaultable configuration source instance using the specified defaulting strategy.
RedisConfigurationSource	withParameters(List<ConfigurationKey.Parameter> parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.

Methods inherited from class io.inverno.mod.configuration.internal.AbstractConfigurableConfigurationSource

getEncoder, set, set, set, set, set, set, set, set, set, set, setEncoder

Methods inherited from class io.inverno.mod.configuration.internal.AbstractConfigurationSource

getDecoder, setDecoder, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.configuration.ConfigurationSource

withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters

Field Details

DEFAULT_KEY_PREFIX

public static final String DEFAULT_KEY_PREFIX

The default key prefix.

See Also:

• Constant Field Values

Constructor Details

RedisConfigurationSource

public RedisConfigurationSource(RedisClient<String,String> redisClient)

Creates a redis configuration source with the specified redis client.

Parameters:

redisClient - a redis client

RedisConfigurationSource

public RedisConfigurationSource(RedisClient<String,String> redisClient,
 JoinablePrimitiveEncoder<String> encoder,
 SplittablePrimitiveDecoder<String> decoder)

Creates a redis configuration source with the specified redis client, string value encoder and decoder.

Parameters:

redisClient - a redis client

encoder - a string encoder

decoder - a string decoder

Method Details

getKeyPrefix

public final String getKeyPrefix()

Returns the prefix that is prepended to configuration property keys.

A configuration property key is of the form: keyPrefix ":PROP:" propertyName "[" [ key "=" value [ "," key "=" value ]* "]".

Returns:

the key prefix

setKeyPrefix

public final void setKeyPrefix(String keyPrefix)

Sets the prefix that is prepended to configuration property keys.

A configuration property key is of the form: keyPrefix ":PROP:" propertyName "[" [ key "=" value [ "," key "=" value ]* "]".

Parameters:

keyPrefix - the key prefix to set

withParameters

public RedisConfigurationSource withParameters(List<ConfigurationKey.Parameter> parameters)
                                        throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Defines parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ConfigurationSource

Specified by:

withParameters in class io.inverno.mod.configuration.internal.AbstractConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,String,RedisConfigurationSource>

Parameters:

parameters - a list of parameters

Returns:

the executable configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withDefaultingStrategy

public RedisConfigurationSource withDefaultingStrategy(DefaultingStrategy defaultingStrategy)

Description copied from interface: DefaultableConfigurationSource

Returns a proxy of the defaultable configuration source instance using the specified defaulting strategy.

Specified by:

withDefaultingStrategy in interface DefaultableConfigurationSource

Parameters:

defaultingStrategy - a defaulting strategy

Returns:

a new defaultable configuration source

unwrap

public RedisConfigurationSource unwrap()

Description copied from interface: ConfigurationSource

Returns the original configuration source.

A configuration source can be decorated in order to provide a fixed set of parameters for all queries or to use a particular DefaultingStrategy when considering a DefaultableConfigurationSource. This method helps retrieving the original source (i.e. before any transformations).

Specified by:

unwrap in interface ConfigurationSource

Overrides:

unwrap in class io.inverno.mod.configuration.internal.AbstractConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,String,RedisConfigurationSource>

Returns:

the original configuration or this configuration

get

public RedisConfigurationSource.RedisExecutableConfigurationQuery get(String... names)
                                                               throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Creates a configuration query to retrieve the specified properties.

Specified by:

get in interface ConfigurationSource

Specified by:

get in class io.inverno.mod.configuration.internal.AbstractConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,String,RedisConfigurationSource>

Parameters:

names - an array of property names

Returns:

an executable configuration query

Throws:

IllegalArgumentException - if the array of names is null or empty

list

public RedisConfigurationSource.RedisListConfigurationQuery list(String name)
                                                          throws IllegalArgumentException

Description copied from interface: ConfigurationSource

Creates a list configuration query to list configuration properties defined with the specified property name.

Specified by:

list in interface ConfigurationSource

Specified by:

list in class io.inverno.mod.configuration.internal.AbstractConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,String,RedisConfigurationSource>

Parameters:

name - a property name

Returns:

a list configuration query

Throws:

IllegalArgumentException - if the name is null or empty

set

public RedisConfigurationSource.RedisExecutableConfigurationUpdate set(Map<String,Object> values)
                                                                throws IllegalArgumentException

Description copied from interface: ConfigurableConfigurationSource

Creates a configuration update to set the configuration properties extracted from the specified values.

Specified by:

set in interface ConfigurableConfigurationSource

Specified by:

set in class io.inverno.mod.configuration.internal.AbstractConfigurableConfigurationSource<RedisConfigurationSource.RedisConfigurationQuery,RedisConfigurationSource.RedisExecutableConfigurationQuery,RedisConfigurationSource.RedisListConfigurationQuery,RedisConfigurationSource.RedisConfigurationUpdate,RedisConfigurationSource.RedisExecutableConfigurationUpdate,String,RedisConfigurationSource>

Parameters:

values - a map containing properties keys and values to set in the configuration source

Returns:

an executable configuration update

Throws:

IllegalArgumentException - if the map of properties is null or empty