net.shibboleth.idp.spring

Class IdPPropertiesApplicationContextInitializer

java.lang.Object

net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer

All Implemented Interfaces:

ApplicationContextInitializer<ConfigurableWebApplicationContext>

public class IdPPropertiesApplicationContextInitializer
extends Object
implements ApplicationContextInitializer<ConfigurableWebApplicationContext>

An ApplicationContextInitializer which attempts to add a properties file property source to the application context environment. The 'conf/idp.properties' file is searched for in well known locations. The 'idp.home' property will be set to the normalized search location if the properties file is found and the property is not already set.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDP_HOME_PROPERTY IdP home property.
static String	IDP_PROPERTIES Target resource to be searched for.
private Logger	log Class logger.
static String[]	SEARCH_LOCATIONS Well known search locations.

Constructor Summary

Constructors

Constructor and Description
IdPPropertiesApplicationContextInitializer()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getSearchLocations() Get the well known search locations SEARCH_LOCATIONS.
String	getSearchTarget() Get the target resource to be searched for IDP_PROPERTIES.
void	initialize(ConfigurableWebApplicationContext applicationContext)
Properties	loadProperties(Resource resource) Load properties from the resource and log property names and values at debug level, suppressing properties whose name matches 'password'.
String	normalizePath(String path) Normalize the path by calling StringUtils.cleanPath(String).
void	setIdPHomeProperty(String path, Properties properties) Set the IDP_HOME_PROPERTY property to the given path if not already set and if not set as a system property.

Methods inherited from class java.lang.Object

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

Field Detail

IDP_HOME_PROPERTY

@Nonnull
public static final String IDP_HOME_PROPERTY

IdP home property.

See Also:

Constant Field Values

IDP_PROPERTIES

@Nonnull
public static final String IDP_PROPERTIES

Target resource to be searched for.

See Also:

Constant Field Values

SEARCH_LOCATIONS

@Nonnull
public static final String[] SEARCH_LOCATIONS

Well known search locations.

log

@Nonnull
private final Logger log

Class logger.

Constructor Detail

IdPPropertiesApplicationContextInitializer

public IdPPropertiesApplicationContextInitializer()

Method Detail

initialize

public void initialize(@Nonnull
              ConfigurableWebApplicationContext applicationContext)

Specified by:

initialize in interface ApplicationContextInitializer<ConfigurableWebApplicationContext>

getSearchTarget

@Nonnull
public String getSearchTarget()

Get the target resource to be searched for IDP_PROPERTIES.

Returns:

the target resource to be searched for IDP_PROPERTIES

getSearchLocations

@Nonnull
public String[] getSearchLocations()

Get the well known search locations SEARCH_LOCATIONS.

Returns:

the well known search locations SEARCH_LOCATIONS

loadProperties

@Nullable
public Properties loadProperties(@Nonnull
                                 Resource resource)

Load properties from the resource and log property names and values at debug level, suppressing properties whose name matches 'password'.

Parameters:

resource - the resource

Returns:

properties loaded from the resource or null if loading failed

normalizePath

@Nonnull
public String normalizePath(@Nonnull
                           String path)

Normalize the path by calling StringUtils.cleanPath(String).

Parameters:

path - the input path

Returns:

the normalized path.

setIdPHomeProperty

public void setIdPHomeProperty(@Nonnull
                      String path,
                      @Nonnull
                      Properties properties)

Set the IDP_HOME_PROPERTY property to the given path if not already set and if not set as a system property. The property value will be normalized by calling normalizePath(String).

Parameters:

path - the property value

properties - the properties