org.yarnandtail.andhow.load

Class JndiLoader

java.lang.Object

org.yarnandtail.andhow.load.BaseLoader

org.yarnandtail.andhow.load.JndiLoader

All Implemented Interfaces:

Loader

public class JndiLoader
extends BaseLoader

Loads values from a JNDI context. This loader can handle two types of objects coming from JNDI: Either the incoming object must already be of the correct destination type (such as a DateTime object), or it my be a string that is parsable by the associated ValueType to the destination type. If the incoming value is a String and the destination type is a string, this loader does not trim the value - the value is assumed to already be in final form. This loader does not consider it a problem to find unrecognized properties in the JNDI context (this would nearly always be the case).

Author:

eeverman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JndiLoader.CONFIG

Constructor Summary

Constructors

Constructor and Description
JndiLoader()

Method Summary

Modifier and Type	Method and Description
protected List<String>	buildJndiNames(ConstructionDefinition appConfigDef, List<String> roots, Property prop) Builds a complete list of complete JNDI names to search for a parameter value.
protected List<String>	buildJndiRoots(ValueMap values) Combines the values of STANDARD_JNDI_ROOTS and ADDED_JNDI_ROOTS into one list of jndi root contexts to search.
Class<? extends BasePropertyGroup>	getClassConfig() Returns a PropertyGroup used to globally configure a class of Loader.
SamplePrinter	getConfigSamplePrinter() Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader.
String	getLoaderDialect() The type dialect of the loader.
String	getLoaderType() The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc..
String	getSpecificLoadDescription() For this particular load, where was info loaded from? This may vary from run to run based on config params.
boolean	isTrimmingRequiredForStringValues() If true, values for string properties are trimmed by the Trimmer of the property they are associated with.
boolean	isUnrecognizedPropertyNamesConsideredAProblem() If true, an unrecognized name is considered a problem that will stop application startup.
LoaderValues	load(ConstructionDefinition appConfigDef, ValueMapWithContext existingValues) Builds up a list of LoaderValues by loading property values from a configuration source.
protected List<String>	split(String rootStr) Spits a comma separate list of JNDI roots into individual root strings.

Methods inherited from class org.yarnandtail.andhow.load.BaseLoader

attemptToAdd, attemptToAdd, createValue, findDuplicateProperty, getInstanceConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

JndiLoader

public JndiLoader()

Method Detail

load

public LoaderValues load(ConstructionDefinition appConfigDef,
                         ValueMapWithContext existingValues)

Description copied from interface: Loader

Builds up a list of LoaderValues by loading property values from a configuration source.

Returns:

isTrimmingRequiredForStringValues

public boolean isTrimmingRequiredForStringValues()

Description copied from interface: Loader

If true, values for string properties are trimmed by the Trimmer of the property they are associated with. If false, no trimming is done. Non-String type property values (like Integer or Date type values) are not affected by this. Loaders that read from text files need to trim values to separate white space and carriage returns from the value. Loaders that read from more tightly defined sources, like reading properties from java.lang.System.getProperties(), can assume that trimming has already happened.

Returns:

isUnrecognizedPropertyNamesConsideredAProblem

public boolean isUnrecognizedPropertyNamesConsideredAProblem()

Description copied from interface: Loader

If true, an unrecognized name is considered a problem that will stop application startup. This is a safety feature because a unrecognized property name in a properties file could be a typo. For other property sources, however, like System.properties, there are many non-AndHow related values that are expected to be present, so this rule cannot be enforced.

Returns:

getSpecificLoadDescription

public String getSpecificLoadDescription()

Description copied from interface: Loader

For this particular load, where was info loaded from? This may vary from run to run based on config params. For instance, The PropFileLoader will look multiple places to find a properties file. This method should return the actual location it was found. Assume the text is prefixed with "This loader loaded from: ". An example would be "/home/user/config/my-props.properties" No ending punctuation should be used.

Returns:

getClassConfig

public Class<? extends BasePropertyGroup> getClassConfig()

Description copied from interface: Loader

Returns a PropertyGroup used to globally configure a class of Loader. For loaders that are intended to be single instance and thus have a single set of configuration properties, this method allows them to report their configuration PropertyGroup so it can be included in the list of registered groups. Examples of such loaders would be as system wide naming services like JNDI or a JNDI derivative (like LDAP via JNDI). The BasePropertyGroup returned from this method will be registered and included in generated sample config files. Loader classes should provide default Property values so they work w/o configuration if possible. For configuration properties that should vary between instances of the same loader class, the loader class should accept Properties in its constructor. Those properties should then be returned by getInstanceConfig().

Specified by:

getClassConfig in interface Loader

Overrides:

getClassConfig in class BaseLoader

Returns:

A PropertyGroup that defines configuration for this class, or null if there is none.

getConfigSamplePrinter

public SamplePrinter getConfigSamplePrinter()

Description copied from interface: Loader

Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader. This method may return null if there is no sample printer for this loader.

Specified by:

getConfigSamplePrinter in interface Loader

Overrides:

getConfigSamplePrinter in class BaseLoader

Returns:

buildJndiRoots

protected List<String> buildJndiRoots(ValueMap values)

Combines the values of STANDARD_JNDI_ROOTS and ADDED_JNDI_ROOTS into one list of jndi root contexts to search. Expected values might look like: java: or java:/comp/env/

Parameters:

values - The configuration state.

Returns:

Never null and never non-empty.

buildJndiNames

protected List<String> buildJndiNames(ConstructionDefinition appConfigDef,
                                      List<String> roots,
                                      Property prop)

Builds a complete list of complete JNDI names to search for a parameter value.

Parameters:

appConfigDef -

roots -

prop -

Returns:

An ordered list of jndi names, with (hopefully) the most likely names first.

split

protected List<String> split(String rootStr)

Spits a comma separate list of JNDI roots into individual root strings. Use double quotes to indicate and preserve and empty or white space string.

Parameters:

rootStr -

Returns:

A list of JNDI root strings

getLoaderType

public String getLoaderType()

Description copied from interface: Loader

The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc.. The actual return value is arbitrary, but should be consistent between loaders of the same type. The values returned by getLoaderType and getLoaderDialect are used to removed duplicate loader types when printing sample files. If two loader instances are of the same type and dialect, only one will print the sample file.

Returns:

Must never returns null.

getLoaderDialect

public String getLoaderDialect()

Description copied from interface: Loader

The type dialect of the loader. For property files, this might be either KeyValuePair or xml for example. The actual return value is arbitrary, but should be consistent between loaders of the same type and dialect. The values returned by getLoaderType and getLoaderDialect are used to removed duplicate loader types when printing sample files. If two loader instances are of the same type and dialect, only one will print the sample file.

Returns:

May return null if there is no meaningful dialect for this type.