Package net.shibboleth.idp.spring

Class DeprecatedPropertyBean

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.spring.DeprecatedPropertyBean

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, Aware, ApplicationContextAware

public class DeprecatedPropertyBean
extends AbstractInitializableComponent
implements ApplicationContextAware

A bean that emits deprecation warnings if a configurable set of properties are set.

Field Summary

Fields

Modifier and Type	Field	Description
private ApplicationContext	applicationContext	Spring context.
private Collection<String>	deadProperties	Dead properties.
private Map<String,String>	deprecatedProperties	Deprecated properties.
private org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
DeprecatedPropertyBean()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
void	setApplicationContext(ApplicationContext context)
void	setDeadProperties(Collection<String> properties)	Set the property names to treat as defunct.
void	setDeprecatedProperties(Map<String,String> map)	Set the property names to deprecate, along with an optional replacement.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

applicationContext

@Nonnull
private ApplicationContext applicationContext

Spring context.

deprecatedProperties

@Nonnull
private Map<String,String> deprecatedProperties

Deprecated properties.

deadProperties

@Nonnull
@NonnullElements
private Collection<String> deadProperties

Dead properties.

Constructor Detail

DeprecatedPropertyBean

public DeprecatedPropertyBean()

Constructor.

Method Detail

setDeprecatedProperties

public void setDeprecatedProperties(@Nonnull
                                    Map<String,String> map)

Set the property names to deprecate, along with an optional replacement.

Parameters:

map - deprecated property names and replacements

setDeadProperties

public void setDeadProperties(@Nonnull @NonnullElements
                              Collection<String> properties)

Set the property names to treat as defunct.

Parameters:

properties - defunct property names

setApplicationContext

public void setApplicationContext(ApplicationContext context)

Specified by:

setApplicationContext in interface ApplicationContextAware

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException