public class Configurations extends Object
Modifier and Type | Class and Description |
---|---|
static interface |
Configurations.Runnable |
Modifier and Type | Field and Description |
---|---|
static String |
CONFIG_RESOURCE_ANCHOR |
static String |
CONFIG_RESOURCE_PATH |
Constructor and Description |
---|
Configurations() |
Modifier and Type | Method and Description |
---|---|
static String |
combinePlugins(String orig,
String override)
Return a plugin string that combines the properties of the given plugin
strings, where properties of
override will override the
same properties of orig . |
static void |
configureInstance(Object obj,
Configuration conf,
Properties properties)
Configures the given object with the given properties by
matching the properties string to the object's setter
methods.
|
static void |
configureInstance(Object obj,
Configuration conf,
Properties properties,
String configurationName)
Configures the given object with the given properties by
matching the properties string to the object's setter
methods.
|
static void |
configureInstance(Object obj,
Configuration conf,
String properties)
Configures the given object with the given properties by
matching the properties string to the object's setter
methods.
|
static void |
configureInstance(Object obj,
Configuration conf,
String properties,
String configurationName)
Configures the given object with the given properties by
matching the properties string to the object's setter
methods.
|
static boolean |
containsProperty(String partialKey,
Map props)
Test whether the map contains the given partial key, prefixed with any
possible configuration prefix.
|
static boolean |
containsProperty(Value value,
Map props)
Test whether the map contains the given partial key, prefixed with any
possible configuration prefix.
|
static String |
getClassName(String plugin)
Return the class name from the given plugin string, or null if none.
|
static List<String> |
getFullyQualifiedAnchorsInPropertiesLocation(Options opts)
Return a List
opts . |
static String |
getPlugin(String clsName,
String props)
Combine the given class name and properties into a plugin string.
|
static String |
getProperties(String plugin)
Return the properties part of the given plugin string, or null if none.
|
static Object |
getProperty(String partialKey,
Map m)
Get the property under the given partial key, prefixed with any possible
configuration prefix.
|
static Object |
lookup(String name,
String userKey,
Log log)
Looks up the given name in JNDI.
|
static Object |
newInstance(String clsName,
ClassLoader loader)
Create the instance with the given class name, using the given
class loader.
|
static Object |
newInstance(String clsName,
Configuration conf,
Properties props,
ClassLoader loader)
Create and configure an instance with the given class name and
properties.
|
static Object |
newInstance(String clsName,
Configuration conf,
String props,
ClassLoader loader)
Create and configure an instance with the given class name and
properties as a String.
|
static Map<String,String> |
parseConfigResource(String props) |
static Options |
parseProperties(String properties)
Parse a set of properties from a comma-separated string.
|
static void |
populateConfiguration(Configuration conf,
Options opts)
Set the given
Configuration instance from the command line
options provided. |
static Object |
removeProperty(String partialKey,
Map props)
Remove the property under the given partial key, prefixed with any
possible configuration prefix.
|
static void |
removeProperty(String partialKey,
Map<?,?> remaining,
Map<?,?> props) |
static boolean |
runAgainstAllAnchors(Options opts,
Configurations.Runnable runnable)
Runs
runnable against all the anchors in the configuration
pointed to by opts . |
static String |
serializeProperties(Map map)
Turn a set of properties into a comma-separated string.
|
public static final String CONFIG_RESOURCE_PATH
public static final String CONFIG_RESOURCE_ANCHOR
public static String getClassName(String plugin)
public static String getProperties(String plugin)
public static String getPlugin(String clsName, String props)
public static String combinePlugins(String orig, String override)
override
will override the
same properties of orig
.public static Object newInstance(String clsName, ClassLoader loader)
public static Object newInstance(String clsName, Configuration conf, String props, ClassLoader loader)
public static Object newInstance(String clsName, Configuration conf, Properties props, ClassLoader loader)
public static List<String> getFullyQualifiedAnchorsInPropertiesLocation(Options opts)
opts
. If no properties
location is listed in opts
, this returns whatever the
product derivations can find in their default configurations.
If the properties location specified in opts
already
contains an anchor spec, this returns that anchor. Note that in this
fully-qualified-input case, the logic involving product derivations
and resource parsing is short-circuited, so this method
should not be used as a means to test that a particular anchor is
defined in a given location by invoking with a fully-qualified anchor.
This does not mutate opts
.public static void populateConfiguration(Configuration conf, Options opts)
Configuration
instance from the command line
options provided. All property names of the given configuration are
recognized; additionally, if a properties
or
p
argument exists, the resource it
points to will be loaded and set into the given configuration instance.
It can point to either a file or a resource name.public static void configureInstance(Object obj, Configuration conf, String properties)
RuntimeException
- on configuration errorpublic static void configureInstance(Object obj, Configuration conf, String properties, String configurationName)
RuntimeException
- on configuration errorpublic static void configureInstance(Object obj, Configuration conf, Properties properties)
RuntimeException
- on configuration errorpublic static void configureInstance(Object obj, Configuration conf, Properties properties, String configurationName)
configurationName
is
non-null
, validates that setter methods exist for
the properties.RuntimeException
- on configuration errorpublic static String serializeProperties(Map map)
public static Options parseProperties(String properties)
public static Object lookup(String name, String userKey, Log log)
public static boolean containsProperty(Value value, Map props)
public static boolean containsProperty(String partialKey, Map props)
public static Object getProperty(String partialKey, Map m)
public static Object removeProperty(String partialKey, Map props)
public static void removeProperty(String partialKey, Map<?,?> remaining, Map<?,?> props)
public static boolean runAgainstAllAnchors(Options opts, Configurations.Runnable runnable)
runnable
against all the anchors in the configuration
pointed to by opts
. Each invocation gets a fresh clone of
opts
with the properties
option set
appropriately.Copyright © 2006–2020 Apache Software Foundation. All rights reserved.