Class ConfigurationDigester

java.lang.Object

org.frankframework.configuration.digester.ConfigurationDigester

All Implemented Interfaces:

ConfigurationAware, org.springframework.beans.factory.Aware

public class ConfigurationDigester
extends Object
implements ConfigurationAware

The configurationDigester reads the configuration.xml and the digester rules in XML format and factors a Configuration.

The configuration.xml is first resolved using the resolver, with tries to resolve ${variable} with the AppConstants, so that both the values from the property files as the environment setting are available.

The configuration.xml is parsed with an EntityResolver that uses the configuration's classpath, which means that you may specify entities that will be resolved during parsing.

Example:

<?xml version="1.0"?>
<!DOCTYPE configuration [
<!ENTITY HelloWorld SYSTEM "./ConfigurationHelloWorld.xml">
]>

<configuration name="HelloWorld">

&HelloWorld;

</configuration>

See Also:

• Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MIGRATION_REWRITE_LEGACY_CLASS_NAMES_KEY

Constructor Summary

Constructors

Constructor	Description
ConfigurationDigester()

Method Summary

Modifier and Type	Method	Description
void	digest()	Digest the Configuration.xml using the configuration as the 'TOP' bean.
void	digest(Resource configurationResource)	Digest the provided configurationResource using the configuration as the 'TOP' bean.
void	digest(org.springframework.context.ApplicationContext applicationContext, Resource configurationResource, PropertyLoader properties)	Digest the provided configurationResource using the provided ApplicationContext as the 'TOP' bean.
protected ContentHandler	getConfigurationCanonicalizer(ContentHandler handler, String frankConfigXSD, ErrorHandler errorHandler)
protected @Nullable Resource	getConfigurationResource(Configuration configuration)	Determine what the default ConfigurationFile is, typically "Configuration.xml".
protected @NonNull Digester	getDigester(org.springframework.context.ApplicationContext applicationContext)
protected ContentHandler	getStub4TesttoolContentHandler(ContentHandler handler, IScopeProvider scope, PropertyLoader properties)	Get the ContentHandler to stub configurations If stubbing is disabled, the input ContentHandler is returned as-is.
protected void	parseAndResolveEntitiesAndProperties(ContentHandler digester, org.springframework.context.ApplicationContext applicationContext, Resource resource, PropertyLoader properties)	Performs an Identity-transform, which resolves entities with content from files found on the ClassPath.

Methods inherited from class Object

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

Methods inherited from interface ConfigurationAware

setConfiguration

Field Details

MIGRATION_REWRITE_LEGACY_CLASS_NAMES_KEY

public static final String MIGRATION_REWRITE_LEGACY_CLASS_NAMES_KEY

See Also:

• Constant Field Values

Constructor Details

ConfigurationDigester

public ConfigurationDigester()

Method Details

digest

public void digest()
            throws ConfigurationException

Digest the Configuration.xml using the configuration as the 'TOP' bean. This means each bean will be created/wired using the ConfigurationContext this class was made with. Each newly created bean will be 'injected' into it's parent using the

invalid reference

DigesterRuleFile

.

Throws:

ConfigurationException

digest

public void digest(Resource configurationResource)
            throws ConfigurationException

Digest the provided configurationResource using the configuration as the 'TOP' bean. This means each bean will be created/wired using the ConfigurationContext this class was made with. Each newly created bean will be 'injected' into it's parent using the

invalid reference

DigesterRuleFile

.

Throws:

ConfigurationException

digest

public void digest(org.springframework.context.ApplicationContext applicationContext,
 Resource configurationResource,
 PropertyLoader properties)
            throws ConfigurationException

Digest the provided configurationResource using the provided ApplicationContext as the 'TOP' bean. This means each bean will be created/wired using the ApplicationContext this class was made with. Each newly created bean will be 'injected' into it's parent using the

invalid reference

DigesterRuleFile

.

Throws:

ConfigurationException

getDigester

protected @NonNull Digester getDigester(org.springframework.context.ApplicationContext applicationContext)
                                 throws ConfigurationException

Throws:

ConfigurationException

parseAndResolveEntitiesAndProperties

protected void parseAndResolveEntitiesAndProperties(ContentHandler digester,
 org.springframework.context.ApplicationContext applicationContext,
 Resource resource,
 PropertyLoader properties)
                                             throws IOException,
SAXException,
TransformerConfigurationException

Performs an Identity-transform, which resolves entities with content from files found on the ClassPath. Resolve all non-attribute properties

Throws:

IOException

SAXException

TransformerConfigurationException

getConfigurationResource

protected @Nullable Resource getConfigurationResource(Configuration configuration)
                                               throws ConfigurationException

Determine what the default ConfigurationFile is, typically "Configuration.xml". If the file cannot be found, see if it's optional, see ConfigurationUtils.isConfigurationXmlOptional(Configuration). If it is not optional, throw an ConfigurationException, else return NULL.

Throws:

ConfigurationException

getConfigurationCanonicalizer

protected ContentHandler getConfigurationCanonicalizer(ContentHandler handler,
 String frankConfigXSD,
 ErrorHandler errorHandler)
                                                throws IOException

Throws:

IOException

getStub4TesttoolContentHandler

protected ContentHandler getStub4TesttoolContentHandler(ContentHandler handler,
 IScopeProvider scope,
 PropertyLoader properties)
                                                 throws IOException,
TransformerConfigurationException

Get the ContentHandler to stub configurations If stubbing is disabled, the input ContentHandler is returned as-is.

Throws:

IOException

TransformerConfigurationException