org.springframework.xd.dirt.container.decryptor

Class PropertiesDecryptor

java.lang.Object

org.springframework.xd.dirt.container.decryptor.PropertiesDecryptor

All Implemented Interfaces:

java.util.EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.boot.context.event.ApplicationPreparedEvent>, org.springframework.core.Ordered, OrderedContextInitializer

public class PropertiesDecryptor
extends java.lang.Object
implements OrderedContextInitializer, org.springframework.context.ApplicationContextAware

Decrypt properties from the environment and insert them with high priority so they override the encrypted values. This class is injected as an ApplicationListener in each application context in the XD hierarchy to be invoked before the context is refreshed. This class is loosely based on spring-cloud-commons org.springframework.cloud.bootstrap.encrypt.EnvironmentDecryptApplicationInitializer, adopting the same conventions used to identify and process encrypted property values in Spring Cloud applications.

Since:

1.3.1

Author:

David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DECRYPTED_PROPERTY_SOURCE_NAME
static java.lang.String	DECRYPTOR_BEAN_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
PropertiesDecryptor(org.springframework.security.crypto.encrypt.TextEncryptor decryptor)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	decrypt(org.springframework.core.env.PropertySources propertySources)
int	getOrder()
void	onApplicationEvent(org.springframework.boot.context.event.ApplicationPreparedEvent event)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setFailOnError(boolean failOnError) Strategy to determine how to handle exceptions during decryption.
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Field Detail

DECRYPTED_PROPERTY_SOURCE_NAME

public static final java.lang.String DECRYPTED_PROPERTY_SOURCE_NAME

See Also:

Constant Field Values

DECRYPTOR_BEAN_NAME

public static final java.lang.String DECRYPTOR_BEAN_NAME

See Also:

Constant Field Values

Constructor Detail

PropertiesDecryptor

public PropertiesDecryptor(org.springframework.security.crypto.encrypt.TextEncryptor decryptor)

Parameters:

decryptor - the TextEncryptor used to decrypt properties. A null is ok here but properties will not be decrypted.

Method Detail

setFailOnError

public void setFailOnError(boolean failOnError)

Strategy to determine how to handle exceptions during decryption.

Parameters:

failOnError - the flag value (default true)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

onApplicationEvent

public void onApplicationEvent(org.springframework.boot.context.event.ApplicationPreparedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.boot.context.event.ApplicationPreparedEvent>

decrypt

public java.util.Map<java.lang.String,java.lang.Object> decrypt(org.springframework.core.env.PropertySources propertySources)