org.archive.spring

Class ConfigPathConfigurer

java.lang.Object

org.archive.spring.ConfigPathConfigurer

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.core.Ordered

public class ConfigPathConfigurer
extends Object
implements org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered

Bean to fixup all configuration-relative ConfigPath instances, and maintain an inventory of referenced paths. For each bean, at BeanPostProcessor time, the bean is remembered for later fixup. Then, at ApplicationListener ContextRefreshedEvent time, fixup occurs at the latest possible time. This allows other intervening Spring post-processors -- most notably, PropertyOverrideConfigurer -- to replace values before fixup, and fixup will still affect the right final values.

Contributor:

gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	allBeans
protected Map<String,ConfigPath>	allConfigPaths
protected PathSharingContext	appCtx
protected ConfigPath	path 'home' directory for all other paths to be resolved relative to; defaults to directory of primary XML config file

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigPathConfigurer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fixupConfigPath(ConfigPath cp, String patchName)
protected Object	fixupPaths(Object bean, String beanName) Find any ConfigPath properties in the passed bean; ensure that if they have a null 'base', that is replaced with the job home directory.
Map<String,ConfigPath>	getAllConfigPaths()
int	getOrder() Act as late as possible.
ConfigPath	getPath()
protected String	interpolate(String rawPath)
void	onApplicationEvent(org.springframework.context.ApplicationEvent event) Fix all beans with ConfigPath properties that lack a base path or a name, to use a job-implied base path and name.
Object	postProcessAfterInitialization(Object bean, String beanName) Remember all beans for later fixup.
Object	postProcessBeforeInitialization(Object bean, String beanName)
protected void	remember(String key, ConfigPath cp)
void	setApplicationContext(org.springframework.context.ApplicationContext appCtx) Remember ApplicationContext, and if possible primary configuration file's home directory.
void	snapshotToLaunchDir(File readFile)

Methods inherited from class java.lang.Object

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

Field Detail

allBeans

protected Map<String,Object> allBeans

path

protected ConfigPath path

'home' directory for all other paths to be resolved relative to; defaults to directory of primary XML config file

appCtx

protected PathSharingContext appCtx

allConfigPaths

protected Map<String,ConfigPath> allConfigPaths

Constructor Detail

ConfigPathConfigurer

public ConfigPathConfigurer()

Method Detail

getPath

public ConfigPath getPath()

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
                                    String beanName)
                                      throws org.springframework.beans.BeansException

Remember all beans for later fixup.

Specified by:

postProcessAfterInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

Throws:

org.springframework.beans.BeansException

See Also:

BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String)

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Fix all beans with ConfigPath properties that lack a base path or a name, to use a job-implied base path and name.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

fixupPaths

protected Object fixupPaths(Object bean,
                String beanName)

Find any ConfigPath properties in the passed bean; ensure that if they have a null 'base', that is replaced with the job home directory. Also, remember all ConfigPaths so fixed-up for later reference.

Parameters:

bean -

beanName -

Returns:

Same bean as passed in, fixed as necessary

fixupConfigPath

protected void fixupConfigPath(ConfigPath cp,
                   String patchName)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext appCtx)
                           throws org.springframework.beans.BeansException

Remember ApplicationContext, and if possible primary configuration file's home directory. Requires appCtx be a PathSharingContext

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

See Also:

ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

remember

protected void remember(String key,
            ConfigPath cp)

getAllConfigPaths

public Map<String,ConfigPath> getAllConfigPaths()

postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean,
                                     String beanName)
                                       throws org.springframework.beans.BeansException

Specified by:

postProcessBeforeInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

Throws:

org.springframework.beans.BeansException

getOrder

public int getOrder()

Act as late as possible.

Specified by:

getOrder in interface org.springframework.core.Ordered

See Also:

Ordered.getOrder()

snapshotToLaunchDir

public void snapshotToLaunchDir(File readFile)
                         throws IOException

Throws:

IOException

interpolate

protected String interpolate(String rawPath)