net.shibboleth.idp.spring

Class IdPPropertiesApplicationContextInitializer

java.lang.Object

net.shibboleth.idp.spring.IdPPropertiesApplicationContextInitializer

All Implemented Interfaces:

org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>

public class IdPPropertiesApplicationContextInitializer
extends Object
implements org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>

An ApplicationContextInitializer which appends properties to the application context's environment. Properties are loaded from IDP_PROPERTIES as well as additional property files specified by IDP_ADDITIONAL_PROPERTY. The IDP_PROPERTIES file is searched for in the well known locations returned by getSearchLocations(). The IDP_HOME_PROPERTY will be set to the first search location in which the IDP_PROPERTIES file is found if not already set. A ConstraintViolationException will be thrown if the property files can not be found or loaded and isFailFast(ConfigurableApplicationContext) returns true.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILFAST_PROPERTY Property controlling whether to fail fast.
static String	IDP_ADDITIONAL_PROPERTY Property that points to more property sources.
static String	IDP_HOME_PROPERTY IdP home property.
static String	IDP_PROPERTIES Target resource to be searched for.
private org.slf4j.Logger	log Class logger.
static String	SEARCH_LOCATION Well known search location.
static String[]	SEARCH_LOCATIONS Deprecated.

Constructor Summary

Constructors

Constructor and Description
IdPPropertiesApplicationContextInitializer()

Method Summary

Methods

Modifier and Type	Method and Description
void	appendPropertySource(org.springframework.context.ConfigurableApplicationContext applicationContext, String name, Properties properties) Add property source to the application context environment with lowest precedence.
String[]	getSearchLocations() Deprecated. In a future version a similar method will return one value
String	getSearchTarget() Get the target resource to be searched for.
void	initialize(org.springframework.context.ConfigurableApplicationContext applicationContext)
boolean	isFailFast(org.springframework.context.ConfigurableApplicationContext applicationContext) Whether we fail immediately if the config is bogus.
void	loadAdditionalPropertySources(org.springframework.context.ConfigurableApplicationContext applicationContext, String searchLocation, Properties properties) Load additional property sources.
Properties	loadProperties(Properties sink, org.springframework.core.io.Resource resource) Load properties from the resource.
void	logProperties(Properties properties) Log property names and values at debug level, suppressing properties whose name matches 'password'.
String	normalizePath(String path) Deprecated.
String[]	selectSearchLocations(org.springframework.context.ConfigurableApplicationContext applicationContext) Deprecated. in future versions there will only be one location returned. This method is not available yet since the code cannot coexist with the legacy. See IDP-999 and IDP-991
void	setIdPHomeProperty(String path, Properties properties) Set the IDP_HOME_PROPERTY property to the given path if not already set.

Methods inherited from class java.lang.Object

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

Field Detail

IDP_HOME_PROPERTY

@Nonnull
@NotEmpty
public static final String IDP_HOME_PROPERTY

IdP home property.

See Also:

Constant Field Values

IDP_ADDITIONAL_PROPERTY

@Nonnull
@NotEmpty
public static final String IDP_ADDITIONAL_PROPERTY

Property that points to more property sources.

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_LOCATION

@Nonnull
public static final String SEARCH_LOCATION

Well known search location.

See Also:

Constant Field Values

SEARCH_LOCATIONS

@Nonnull
@Deprecated
public static final String[] SEARCH_LOCATIONS

Deprecated.

Well known search locations.

FAILFAST_PROPERTY

@Nonnull
public static final String FAILFAST_PROPERTY

Property controlling whether to fail fast.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

IdPPropertiesApplicationContextInitializer

public IdPPropertiesApplicationContextInitializer()

Method Detail

initialize

public void initialize(@Nonnull
              org.springframework.context.ConfigurableApplicationContext applicationContext)

Specified by:

initialize in interface org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>

getSearchTarget

@Nonnull
public String getSearchTarget()

Get the target resource to be searched for. Defaults to IDP_PROPERTIES.

Returns:

the target resource to be searched for

getSearchLocations

@Nonnull
@Deprecated
public String[] getSearchLocations()

Deprecated. In a future version a similar method will return one value

Get the well known search locations. Defaults to SEARCH_LOCATIONS.

Returns:

the well known search locations

selectSearchLocations

@Nonnull
@Deprecated
public String[] selectSearchLocations(@Nonnull
                                                org.springframework.context.ConfigurableApplicationContext applicationContext)

Deprecated. in future versions there will only be one location returned. This method is not available yet since the code cannot coexist with the legacy. See IDP-999 and IDP-991

Select the locations used to search for the target. Prefers the user-defined search location defined by IDP_HOME_PROPERTY in the application context. Defaults to the well-known search locations returned from getSearchLocations().

Parameters:

applicationContext - the application context

Returns:

the search locations used to search for the target

Throws:

ConstraintViolationException - if the user-defined search location is empty or ends with '/' and isFailFast(ConfigurableApplicationContext) is true

loadProperties

@Nullable
public Properties loadProperties(@Nullable
                                 Properties sink,
                                 @Nonnull
                                 org.springframework.core.io.Resource resource)

Load properties from the resource.

Parameters:

sink - if non-null use this instance as the target

resource - the resource

Returns:

properties loaded from the resource or null if loading failed

loadAdditionalPropertySources

public void loadAdditionalPropertySources(@Nonnull
                                 org.springframework.context.ConfigurableApplicationContext applicationContext,
                                 @Nonnull
                                 String searchLocation,
                                 @Nonnull
                                 Properties properties)

Load additional property sources. File names of additional property sources are defined by IDP_ADDITIONAL_PROPERTY, and are resolved relative to the given search location.

Parameters:

applicationContext - the application context

searchLocation - the location from which additional property sources are resolved

properties - the properties to be filled with additional property sources

Throws:

ConstraintViolationException - if an error occurs loading the additional property sources and isFailFast(ConfigurableApplicationContext) is true

logProperties

public void logProperties(@Nonnull
                 Properties properties)

Log property names and values at debug level, suppressing properties whose name matches 'password'.

Parameters:

properties - the properties to log

appendPropertySource

public void appendPropertySource(@Nonnull
                        org.springframework.context.ConfigurableApplicationContext applicationContext,
                        @Nonnull
                        String name,
                        @Nonnull
                        Properties properties)

Add property source to the application context environment with lowest precedence.

Parameters:

applicationContext - the application context

name - the name of the property source to be added to the application context

properties - the properties added to the application context

normalizePath

@Deprecated
@Nonnull
public String normalizePath(@Nonnull
                                      String path)

Deprecated.

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.

Parameters:

path - the property value

properties - the properties

isFailFast

public boolean isFailFast(@Nonnull
                 org.springframework.context.ConfigurableApplicationContext applicationContext)

Whether we fail immediately if the config is bogus. Defaults to true. Controlled by the value of the FAILFAST_PROPERTY.

Parameters:

applicationContext - the application context

Returns:

whether we fail immediately if the config is bogus