com.ulisesbocchio.jasyptspringboot.annotation.EnableEncryptableProperties Maven / Gradle / Ivy
package com.ulisesbocchio.jasyptspringboot.annotation;
import com.ulisesbocchio.jasyptspringboot.configuration.EnableEncryptablePropertiesConfiguration;
import com.ulisesbocchio.jasyptspringboot.configuration.EnableEncryptablePropertiesBeanFactoryPostProcessor;
import com.ulisesbocchio.jasyptspringboot.wrapper.EncryptablePropertySourceWrapper;
import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertySource;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that enables Jasypt for properties decryption by annotating {@link org.springframework.context.annotation.Configuration} classes.
* Only one occurrence of this annotation is needed.
*
*
This works well in conjunction with the {@link org.springframework.context.annotation.PropertySource} annotation.
* For instance:
*
* {@literal @SpringBootApplication}
* {@literal @EnableEncryptableProperties}
* {@literal @PropertySource(name="EncryptedProperties", "classpath:app.properties")}
* public class MySpringBootApp {
* public static void main(String[] args) {
* SpringApplication.run(MySpringBootApp.class, args);
* }
* }
*
* The above code will then enable encryptable properties within all {@link org.springframework.core.env.PropertySource}s defined in the environment,
* not only the ones defined with the {@link org.springframework.context.annotation.PropertySource} annotation, but also
* all system properties, command line properties, and those auto-magically picked up from application.properties and application.yml
* if they exist.
*
*
This Configuration class basically registers a {@link org.springframework.beans.factory.config.BeanFactoryPostProcessor} that wraps all {@link org.springframework.core.env.PropertySource} defined in the {@link org.springframework.core.env.Environment}
* with {@link com.ulisesbocchio.jasyptspringboot.wrapper.EncryptablePropertySourceWrapper} and defines a default {@link org.jasypt.encryption.StringEncryptor} for decrypting properties
* that can be configured through the same properties it wraps.
*
* For more information on how to declare encrypted properties, encrypt them, and encryption configuration go to http://jasypt.org
*
*
* @author Ulises Bocchio
* @see EnableEncryptablePropertiesConfiguration
* @see EnableEncryptablePropertiesBeanFactoryPostProcessor
* @see EncryptablePropertySourceWrapper
* @see org.springframework.context.annotation.PropertySource
* @version $Id: $Id
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import(EnableEncryptablePropertiesConfiguration.class)
public @interface EnableEncryptableProperties {
}