org.apache.brooklyn.core.config

Class ConfigUtils

java.lang.Object

org.apache.brooklyn.core.config.ConfigUtils

public class ConfigUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ConfigUtils()

Method Summary

Modifier and Type	Method and Description
static void	addUnprefixedConfigKeyInConfigBack(java.lang.String configPrefix, ConfigBag configBag, java.util.Map<java.lang.String,java.lang.Object> destinationBucket) Look for keys with configPrefix in configBag and those which have configPrefix are added in destinationBucket but without configPrefix.
static BrooklynProperties	filterFor(BrooklynProperties properties, <any> filter)
static BrooklynProperties	filterForPrefix(BrooklynProperties properties, java.lang.String prefix)
static BrooklynProperties	filterForPrefixAndStrip(java.util.Map<java.lang.String,?> properties, java.lang.String prefix) prefix generally ends with a full stop
static <T> T	getRequiredConfig(Entity entity, ConfigKey<T> key)
static java.util.Set<ConfigKey.HasConfigKey<?>>	getStaticKeysOnClass(java.lang.Class<?> type)
static BrooklynProperties	loadFromFile(java.lang.String file)
static <T> ConfigKey<T>	prefixedKey(java.lang.String prefix, ConfigKey<T> key) prepends the given prefix to the key.
static <T> ConfigKey<T>	unprefixedKey(java.lang.String prefix, ConfigKey<T> key) removes the given prefix from the key for configuration purposes; logs warning and does nothing if there is no such prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

getRequiredConfig

public static <T> T getRequiredConfig(Entity entity,
                                      ConfigKey<T> key)

prefixedKey

public static <T> ConfigKey<T> prefixedKey(java.lang.String prefix,
                                           ConfigKey<T> key)

prepends the given prefix to the key. prefix will typically end with a ".". this is useful for configuration purposes when a subsystem uses a short-name config (e.g. "user") but in entity config or at the root (brooklyn.properties) there are longer names (e.g. "brooklyn.ssh.config.user"), and we wish to convert from the shorter names to the longer names.

unprefixedKey

public static <T> ConfigKey<T> unprefixedKey(java.lang.String prefix,
                                             ConfigKey<T> key)

removes the given prefix from the key for configuration purposes; logs warning and does nothing if there is no such prefix. prefix will typically end with a ".". this is useful for configuration purposes when a subsystem uses a short-name config (e.g. "user") but in entity config or at the root (brooklyn.properties) there are longer names (e.g. "brooklyn.ssh.config.user"), and we wish to convert from the longer names to the short-name.

loadFromFile

public static BrooklynProperties loadFromFile(java.lang.String file)

filterFor

public static BrooklynProperties filterFor(BrooklynProperties properties,
                                           <any> filter)

filterForPrefix

public static BrooklynProperties filterForPrefix(BrooklynProperties properties,
                                                 java.lang.String prefix)

filterForPrefixAndStrip

public static BrooklynProperties filterForPrefixAndStrip(java.util.Map<java.lang.String,?> properties,
                                                         java.lang.String prefix)

prefix generally ends with a full stop

getStaticKeysOnClass

public static java.util.Set<ConfigKey.HasConfigKey<?>> getStaticKeysOnClass(java.lang.Class<?> type)

addUnprefixedConfigKeyInConfigBack

public static void addUnprefixedConfigKeyInConfigBack(java.lang.String configPrefix,
                                                      ConfigBag configBag,
                                                      java.util.Map<java.lang.String,java.lang.Object> destinationBucket)

Look for keys with configPrefix in configBag and those which have configPrefix are added in destinationBucket but without configPrefix.

Parameters:

configPrefix - prefix to look for

configBag - keys to look in

destinationBucket - should not be an ImmutableMap