org.apache.brooklyn.core.mgmt.internal

Class DeferredBrooklynProperties

java.lang.Object

org.apache.brooklyn.core.mgmt.internal.DeferredBrooklynProperties

All Implemented Interfaces:

java.util.Map, ConfigMap, StringConfigMap, BrooklynProperties

public class DeferredBrooklynProperties
extends java.lang.Object
implements BrooklynProperties

Delegates to another BrooklynProperties implementation, but intercepts all calls to get. The results are transformed: if they are in the external-config format then they are automatically converted to DeferredSupplier. The external-config format is that same as that for camp-yaml blueprints (i.e. $brooklyn:external("myprovider", "mykey").

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.internal.BrooklynProperties

BrooklynProperties.Factory

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Nested classes/interfaces inherited from interface org.apache.brooklyn.config.ConfigMap

ConfigMap.ConfigMapWithInheritance<TContainer>

Constructor Summary

Constructors

Constructor and Description
DeferredBrooklynProperties(BrooklynProperties delegate, ManagementContextInternal mgmt)

Method Summary

Modifier and Type	Method and Description
BrooklynProperties	addEnvironmentVars()
BrooklynProperties	addFrom(ConfigBag cfg)
BrooklynProperties	addFrom(java.io.File f)
BrooklynProperties	addFrom(java.io.InputStream i)
BrooklynProperties	addFrom(java.util.Map map)
BrooklynProperties	addFrom(java.net.URL u)
BrooklynProperties	addFromMap(java.util.Map properties) adds the indicated properties
BrooklynProperties	addFromUrl(java.lang.String url)
BrooklynProperties	addFromUrlProperty(java.lang.String urlProperty) expects a property already set in scope, whose value is acceptable to BrooklynProperties.addFromUrl(String); if property not set, does nothing
BrooklynProperties	addSystemProperties()
java.util.Map<java.lang.String,java.lang.Object>	asMapWithStringKeys() returns a read-only map view which has string keys (corresponding to the config key names); callers encouraged to use the typed keys (and so not use this method), but in some compatibility areas having a Properties-like view is useful
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry>	entrySet()
boolean	equals(java.lang.Object o)
java.util.Set<ConfigKey<?>>	findKeys(com.google.common.base.Predicate<? super ConfigKey<?>> filter) returns all keys matching the given filter predicate; see ConfigPredicates for common predicates
java.lang.String	get(java.util.Map flags, java.lang.String key) Deprecated.
java.lang.Object	get(java.lang.Object key)
java.util.Map<ConfigKey<?>,java.lang.Object>	getAllConfig() Deprecated.
java.util.Map<ConfigKey<?>,java.lang.Object>	getAllConfigLocalRaw() returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents
<T> T	getConfig(ConfigKey.HasConfigKey<T> key)
<T> T	getConfig(ConfigKey.HasConfigKey<T> key, T defaultValue)
<T> T	getConfig(ConfigKey<T> key)
<T> T	getConfig(ConfigKey<T> key, T defaultValue) Returns value stored against the given key, resolved (if it is a Task, possibly blocking), and coerced to the appropriate type, or given default value if not set, unless the default value is null in which case it returns the default.
Maybe<java.lang.Object>	getConfigLocalRaw(ConfigKey<?> key) returns the value stored against the given key, not any default, not inherited (if there is an inheritance hierarchy), not type-coerced or further resolved (eg a task or supplier, if such rules are applicable)
Maybe<java.lang.Object>	getConfigRaw(ConfigKey<?> key)
Maybe<java.lang.Object>	getConfigRaw(ConfigKey<?> key, boolean includeInherited) Deprecated.
java.lang.String	getFirst(java.util.Map flags, java.lang.String... keys) Discouraged; returns the String so if it is external config, it will be the $brooklyn:external(...) format.
java.lang.String	getFirst(java.lang.String... keys) Discouraged; returns the String so if it is external config, it will be the $brooklyn:external(...) format.
int	hashCode()
boolean	isEmpty()
java.util.Set	keySet()
<T> java.lang.Object	put(ConfigKey.HasConfigKey<T> key, T value)
<T> java.lang.Object	put(ConfigKey<T> key, T value)
java.lang.Object	put(java.lang.Object key, java.lang.Object value) like normal map.put, except config keys are dereferenced on the way in
void	putAll(java.util.Map vals) like normal map.putAll, except config keys are dereferenced on the way in
<T> boolean	putIfAbsent(ConfigKey<T> key, T value)
boolean	putIfAbsent(java.lang.String key, java.lang.Object value) inserts the value under the given key, if it was not present
java.lang.Object	remove(java.lang.Object key)
int	size()
BrooklynProperties	submap(com.google.common.base.Predicate<ConfigKey<?>> filter) returns submap matching the given filter predicate; see ConfigPredicates for common predicates
java.lang.String	toString()
java.util.Collection	values()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DeferredBrooklynProperties

public DeferredBrooklynProperties(BrooklynProperties delegate,
                                  ManagementContextInternal mgmt)

Method Detail

getConfig

public <T> T getConfig(ConfigKey<T> key)

Specified by:

getConfig in interface ConfigMap

Specified by:

getConfig in interface BrooklynProperties

See Also:

#getConfig(ConfigKey, Object), with default value as per the key, or null

getConfig

public <T> T getConfig(ConfigKey.HasConfigKey<T> key)

Specified by:

getConfig in interface ConfigMap

Specified by:

getConfig in interface BrooklynProperties

See Also:

#getConfig(ConfigKey, Object), with default value as per the key, or null

getConfig

public <T> T getConfig(ConfigKey.HasConfigKey<T> key,
                       T defaultValue)

Specified by:

getConfig in interface BrooklynProperties

getConfig

public <T> T getConfig(ConfigKey<T> key,
                       T defaultValue)

Description copied from interface: BrooklynProperties

Returns value stored against the given key, resolved (if it is a Task, possibly blocking), and coerced to the appropriate type, or given default value if not set, unless the default value is null in which case it returns the default.

Specified by:

getConfig in interface BrooklynProperties

getConfigRaw

public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key)

Specified by:

getConfigRaw in interface BrooklynProperties

getConfigRaw

@Deprecated
public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key,
                                                        boolean includeInherited)

Deprecated.

Description copied from interface: BrooklynProperties

Inheritance is ignored here. Preferable to use BrooklynProperties.getConfigRaw(ConfigKey).

Specified by:

getConfigRaw in interface ConfigMap

Specified by:

getConfigRaw in interface BrooklynProperties

Parameters:

key - key to look up

includeInherited - for ConfigMap instances which have an inheritance hierarchy, whether to traverse it or not; has no effects where there is no inheritance

Returns:

raw, unresolved, uncoerced value of key in map, but not any default on the key

getConfigLocalRaw

public Maybe<java.lang.Object> getConfigLocalRaw(ConfigKey<?> key)

Description copied from interface: ConfigMap

returns the value stored against the given key, not any default, not inherited (if there is an inheritance hierarchy), not type-coerced or further resolved (eg a task or supplier, if such rules are applicable)

Specified by:

getConfigLocalRaw in interface ConfigMap

Parameters:

key - key to look up

Returns:

raw, unresolved, uncoerced value of key explicitly in map

getAllConfigLocalRaw

public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfigLocalRaw()

Description copied from interface: ConfigMap

returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents

Specified by:

getAllConfigLocalRaw in interface ConfigMap

getAllConfig

@Deprecated
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()

Deprecated.

Description copied from interface: ConfigMap

returns a map of all config keys to their raw (unresolved+uncoerced) contents

Specified by:

getAllConfig in interface ConfigMap

Specified by:

getAllConfig in interface BrooklynProperties

asMapWithStringKeys

public java.util.Map<java.lang.String,java.lang.Object> asMapWithStringKeys()

Description copied from interface: StringConfigMap

returns a read-only map view which has string keys (corresponding to the config key names); callers encouraged to use the typed keys (and so not use this method), but in some compatibility areas having a Properties-like view is useful

Specified by:

asMapWithStringKeys in interface ConfigMap

Specified by:

asMapWithStringKeys in interface StringConfigMap

Specified by:

asMapWithStringKeys in interface BrooklynProperties

get

@Deprecated
public java.lang.String get(java.util.Map flags,
                                        java.lang.String key)

Deprecated.

Discouraged; returns the String so if it is external config, it will be the $brooklyn:external(...) format.

Specified by:

get in interface BrooklynProperties

getFirst

public java.lang.String getFirst(java.lang.String... keys)

Discouraged; returns the String so if it is external config, it will be the $brooklyn:external(...) format.

Specified by:

getFirst in interface StringConfigMap

Specified by:

getFirst in interface BrooklynProperties

See Also:

StringConfigMap.getFirst(java.util.Map, String...)

getFirst

public java.lang.String getFirst(java.util.Map flags,
                                 java.lang.String... keys)

Discouraged; returns the String so if it is external config, it will be the $brooklyn:external(...) format.

Specified by:

getFirst in interface StringConfigMap

Specified by:

getFirst in interface BrooklynProperties

submap

public BrooklynProperties submap(com.google.common.base.Predicate<ConfigKey<?>> filter)

Description copied from interface: StringConfigMap

returns submap matching the given filter predicate; see ConfigPredicates for common predicates

Specified by:

submap in interface ConfigMap

Specified by:

submap in interface StringConfigMap

Specified by:

submap in interface BrooklynProperties

findKeys

public java.util.Set<ConfigKey<?>> findKeys(com.google.common.base.Predicate<? super ConfigKey<?>> filter)

Description copied from interface: ConfigMap

returns all keys matching the given filter predicate; see ConfigPredicates for common predicates

Specified by:

findKeys in interface ConfigMap

addEnvironmentVars

public BrooklynProperties addEnvironmentVars()

Specified by:

addEnvironmentVars in interface BrooklynProperties

addSystemProperties

public BrooklynProperties addSystemProperties()

Specified by:

addSystemProperties in interface BrooklynProperties

addFrom

public BrooklynProperties addFrom(ConfigBag cfg)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynProperties addFrom(java.util.Map map)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynProperties addFrom(java.io.InputStream i)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynProperties addFrom(java.io.File f)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynProperties addFrom(java.net.URL u)

Specified by:

addFrom in interface BrooklynProperties

addFromUrl

public BrooklynProperties addFromUrl(java.lang.String url)

Specified by:

addFromUrl in interface BrooklynProperties

See Also:

of the form form file:///home/... or http:// or classpath://xx ; for convenience if not starting with xxx: it is treated as a classpath reference or a file; throws if not found (but does nothing if argument is null)

addFromUrlProperty

public BrooklynProperties addFromUrlProperty(java.lang.String urlProperty)

Description copied from interface: BrooklynProperties

expects a property already set in scope, whose value is acceptable to BrooklynProperties.addFromUrl(String); if property not set, does nothing

Specified by:

addFromUrlProperty in interface BrooklynProperties

addFromMap

public BrooklynProperties addFromMap(java.util.Map properties)

Description copied from interface: BrooklynProperties

adds the indicated properties

Specified by:

addFromMap in interface BrooklynProperties

putIfAbsent

public boolean putIfAbsent(java.lang.String key,
                           java.lang.Object value)

Description copied from interface: BrooklynProperties

inserts the value under the given key, if it was not present

Specified by:

putIfAbsent in interface BrooklynProperties

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)

Description copied from interface: BrooklynProperties

like normal map.put, except config keys are dereferenced on the way in

Specified by:

put in interface java.util.Map

Specified by:

put in interface BrooklynProperties

putAll

public void putAll(java.util.Map vals)

Description copied from interface: BrooklynProperties

like normal map.putAll, except config keys are dereferenced on the way in

Specified by:

putAll in interface java.util.Map

Specified by:

putAll in interface BrooklynProperties

put

public <T> java.lang.Object put(ConfigKey.HasConfigKey<T> key,
                                T value)

Specified by:

put in interface BrooklynProperties

put

public <T> java.lang.Object put(ConfigKey<T> key,
                                T value)

Specified by:

put in interface BrooklynProperties

putIfAbsent

public <T> boolean putIfAbsent(ConfigKey<T> key,
                               T value)

Specified by:

putIfAbsent in interface BrooklynProperties

size

public int size()

Specified by:

size in interface java.util.Map

Specified by:

size in interface ConfigMap

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

Specified by:

isEmpty in interface ConfigMap

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

clear

public void clear()

Specified by:

clear in interface java.util.Map

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

entrySet

public java.util.Set<java.util.Map.Entry> entrySet()

Specified by:

entrySet in interface java.util.Map

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object