org.apache.slider.core.conf

Class ConfTreeOperations

java.lang.Object

org.apache.slider.core.conf.ConfTreeOperations

public class ConfTreeOperations
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
ConfTree	confTree
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ConfTreeOperations(ConfTree confTree)

Method Summary

Methods

Modifier and Type	Method and Description
static ConfTreeOperations	fromFile(File resource) Load from a resource.
static ConfTreeOperations	fromInstance(ConfTree instance) Build from an existing instance -which is cloned via JSON ser/deser
static ConfTreeOperations	fromResource(String resource) Load from a resource.
String	get(String key) get a global option
MapOperations	getComponent(String component) look up a component and return its options
Set<String>	getComponentNames()
String	getComponentOpt(String name, String option, String defVal) Get a component option
int	getComponentOptInt(String name, String option, int defVal) Get a component opt; use Integer.decode(String) so as to take hex oct and bin values too.
Map<String,Map<String,String>>	getComponents() Get at the underlying component map
ConfTree	getConfTree() Get the underlying conf tree
MapOperations	getGlobalOptions() Get operations on the global set
MapOperations	getMandatoryComponent(String name) Get a component whose presence is mandatory
MapOperations	getOrAddComponent(String name) Get a component -adding it to the components map if none with that name exists
void	merge(ConfTree that) Merge in another tree with overwrites
void	mergeComponents(Map<String,Map<String,String>> commandOptions) Merge in components
void	mergeComponentsPrefix(Map<String,Map<String,String>> commandOptions, String prefix, boolean overwrite) Merge in components
void	mergeFile(File file) Load from a file and merge it in
void	mergeFile(File file, InputPropertiesValidator validator) Load from a file and merge it in
void	mergeInGlobal(Map<String,String> component) Merge any options
void	mergeSingleComponentMap(String component, Map<String,String> map) Merge the map of a single component
void	mergeSingleComponentMapPrefix(String component, Map<String,String> map, String prefix, boolean overwrite) Merge the map of a single component
void	mergeWithoutOverwrite(ConfTree that) Merge in another tree -no overwrites of global or conf data (note that metadata does a naive putAll merge/overwrite)
void	propagateGlobalKeys(ConfTreeOperations src, String prefix) Propagate all global keys matching a prefix
void	propagateGlobalKeys(ConfTree src, String prefix) Propagate all global keys matching a prefix
void	resolve() Resolve a ConfTree by mapping all global options into each component -if there is none there already
void	set(String key, Object value) Set a global option, converting it to a string as needed
void	setComponentOpt(String role, String option, int val) Set an integer role option, creating the role if necessary
void	setComponentOpt(String role, String option, long val) Set a long role option, creating the role if necessary
void	setComponentOpt(String component, String option, String val) Set a component option, creating the component if necessary
String	toJson() Convert to a JSON string
String	toString()
void	validate() Validate the configuration
void	validate(InputPropertiesValidator validator) Validate the configuration

Methods inherited from class java.lang.Object

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

Field Detail

confTree

public final ConfTree confTree

log

protected static final org.slf4j.Logger log

Constructor Detail

ConfTreeOperations

public ConfTreeOperations(ConfTree confTree)

Method Detail

getConfTree

public ConfTree getConfTree()

Get the underlying conf tree

Returns:

the tree

validate

public void validate()
              throws BadConfigException

Validate the configuration

Throws:

BadConfigException

validate

public void validate(InputPropertiesValidator validator)
              throws BadConfigException

Validate the configuration

Parameters:

validator - a provided properties validator

Throws:

BadConfigException

resolve

public void resolve()

Resolve a ConfTree by mapping all global options into each component -if there is none there already

mergeInGlobal

public void mergeInGlobal(Map<String,String> component)

Merge any options

Parameters:

component - dest values

getGlobalOptions

public MapOperations getGlobalOptions()

Get operations on the global set

Returns:

a wrapped map

getComponent

public MapOperations getComponent(String component)

look up a component and return its options

Parameters:

component - component name

Returns:

component mapping or null

getComponents

public Map<String,Map<String,String>> getComponents()

Get at the underlying component map

Returns:

a map of components. This is the raw ConfTree data structure

getOrAddComponent

public MapOperations getOrAddComponent(String name)

Get a component -adding it to the components map if none with that name exists

Parameters:

name - role

Returns:

role mapping

getComponentNames

public Set<String> getComponentNames()

getMandatoryComponent

public MapOperations getMandatoryComponent(String name)
                                    throws BadConfigException

Get a component whose presence is mandatory

Parameters:

name - component name

Returns:

the mapping

Throws:

BadConfigException - if the name is not there

set

public void set(String key,
       Object value)

Set a global option, converting it to a string as needed

Parameters:

key - key

value - non null value

get

public String get(String key)

get a global option

Parameters:

key - key

Returns:

value or null

propagateGlobalKeys

public void propagateGlobalKeys(ConfTree src,
                       String prefix)

Propagate all global keys matching a prefix

Parameters:

src - source

prefix - prefix

propagateGlobalKeys

public void propagateGlobalKeys(ConfTreeOperations src,
                       String prefix)

Propagate all global keys matching a prefix

Parameters:

src - source

prefix - prefix

mergeSingleComponentMap

public void mergeSingleComponentMap(String component,
                           Map<String,String> map)

Merge the map of a single component

Parameters:

component - component name

map - map to merge

mergeSingleComponentMapPrefix

public void mergeSingleComponentMapPrefix(String component,
                                 Map<String,String> map,
                                 String prefix,
                                 boolean overwrite)

Merge the map of a single component

Parameters:

component - component name

map - map to merge

mergeComponents

public void mergeComponents(Map<String,Map<String,String>> commandOptions)

Merge in components

Parameters:

commandOptions - component options on the CLI

mergeComponentsPrefix

public void mergeComponentsPrefix(Map<String,Map<String,String>> commandOptions,
                         String prefix,
                         boolean overwrite)

Merge in components

Parameters:

commandOptions - component options on the CLI

mergeWithoutOverwrite

public void mergeWithoutOverwrite(ConfTree that)

Merge in another tree -no overwrites of global or conf data (note that metadata does a naive putAll merge/overwrite)

Parameters:

that - the other tree

merge

public void merge(ConfTree that)

Merge in another tree with overwrites

Parameters:

that - the other tree

fromResource

public static ConfTreeOperations fromResource(String resource)
                                       throws IOException

Load from a resource. The inner conf tree is the loaded data -unresolved

Parameters:

resource - resource

Returns:

loaded value

Throws:

IOException - load failure

fromFile

public static ConfTreeOperations fromFile(File resource)
                                   throws IOException

Load from a resource. The inner conf tree is the loaded data -unresolved

Parameters:

resource - resource

Returns:

loaded value

Throws:

IOException - load failure

fromInstance

public static ConfTreeOperations fromInstance(ConfTree instance)
                                       throws IOException

Build from an existing instance -which is cloned via JSON ser/deser

Parameters:

instance - the source instance

Returns:

loaded value

Throws:

IOException - load failure

mergeFile

public void mergeFile(File file)
               throws IOException,
                      BadConfigException

Load from a file and merge it in

Parameters:

file - file

Throws:

IOException - any IO problem

BadConfigException - if the file is invalid

mergeFile

public void mergeFile(File file,
             InputPropertiesValidator validator)
               throws IOException,
                      BadConfigException

Load from a file and merge it in

Parameters:

file - file

validator - properties validator

Throws:

IOException - any IO problem

BadConfigException - if the file is invalid

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()
              throws IOException,
                     org.codehaus.jackson.JsonGenerationException,
                     org.codehaus.jackson.map.JsonMappingException

Convert to a JSON string

Returns:

a JSON string description

Throws:

IOException

org.codehaus.jackson.JsonGenerationException

org.codehaus.jackson.map.JsonMappingException

getComponentOpt

public String getComponentOpt(String name,
                     String option,
                     String defVal)

Get a component option

Parameters:

name - component name

option - option name

defVal - default value

Returns:

resolved value

getComponentOptInt

public int getComponentOptInt(String name,
                     String option,
                     int defVal)

Get a component opt; use Integer.decode(String) so as to take hex oct and bin values too.

Parameters:

name - component name

option - option name

defVal - default value

Returns:

parsed value

Throws:

NumberFormatException - if the role could not be parsed.

setComponentOpt

public void setComponentOpt(String component,
                   String option,
                   String val)

Set a component option, creating the component if necessary

Parameters:

component - component name

option - option name

val - value

setComponentOpt

public void setComponentOpt(String role,
                   String option,
                   int val)

Set an integer role option, creating the role if necessary

Parameters:

role - role name

option - option name

val - integer value

setComponentOpt

public void setComponentOpt(String role,
                   String option,
                   long val)

Set a long role option, creating the role if necessary

Parameters:

role - role name

option - option name

val - long value