org.springframework.data.gemfire.config.annotation

Annotation Type EnableSecurity

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value={ApacheShiroSecurityConfiguration.class,AuthenticationBeanConfiguration.class,AutoConfiguredAuthenticationConfiguration.class,GeodeIntegratedSecurityConfiguration.class})
 @UsesGemFireProperties
public @interface EnableSecurity

The EnableSecurity annotation marks a Spring @Configuration annotated Class to configure and enable Pivotal GemFire/Apache Geode's Security features for authentication, authorization and post processing.

Since:

1.0.0

Author:

John Blum

See Also:

Annotation, AuthInitialize, SecurityManager, PostProcessor, Import, ApacheShiroSecurityConfiguration, AuthenticationBeanConfiguration, AutoConfiguredAuthenticationConfiguration, GeodeIntegratedSecurityConfiguration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	clientAuthenticationInitializer Used for authentication.
String	peerAuthenticationInitializer Used with authentication.
Class<?>	securityManagerClass Specifies the application Class type implementing the Apache Geode SecurityManager interface to enable security in Apache Geode.
String	securityManagerClassName Specifies the fully-qualified class name of the application Class implementing the Apache Geode SecurityManager interface to enable security in Apache Geode.
String	securityPassword The security-password used by a GemFire cache client application required to authenticate.
Class<?>	securityPostProcessorClass Specifies the application Class type implementing the Apache Geode PostProcessor interface, which used to transform sensitive data returned from secure data access operations.
String	securityPostProcessorClassName Specifies the fully-qualified class name of the application Class implementing the Apache Geode PostProcessor interface, which used to transform sensitive data returned from secure data access operations.
String	securityUsername The security-username used by a GemFire cache client application required to authenticate.
String	shiroIniResourcePath Sets the Geode System Property referring to the location of an Apache Shiro INI file used to configure the Apache Shiro Security Framework to secure Apache Geode.

Element Detail

clientAuthenticationInitializer

public abstract String clientAuthenticationInitializer

Used for authentication. Static creation method returning an AuthInitialize object, which obtains credentials for clients. Defaults to unset. Use the spring.data.gemfire.security.client.authentication-initializer property in application.properties.

Default:

""

peerAuthenticationInitializer

public abstract String peerAuthenticationInitializer

Used with authentication. Static creation method returning an AuthInitialize object, which obtains credentials for peers in a distributed system. Defaults to unset. Use the spring.data.gemfire.security.peer.authentication-initializer property in application.properties.

Default:

""

securityManagerClass

public abstract Class<?> securityManagerClass

Specifies the application Class type implementing the Apache Geode SecurityManager interface to enable security in Apache Geode. Defaults to Void.

Default:

java.lang.Void.class

securityManagerClassName

public abstract String securityManagerClassName

Specifies the fully-qualified class name of the application Class implementing the Apache Geode SecurityManager interface to enable security in Apache Geode. Use this Annotation attribute if you are uncertain whether the application class is on the classpath or not. Default is unset. Use the spring.data.gemfire.security.manager.class-name property in application.properties.

Default:

""

securityPostProcessorClass

public abstract Class<?> securityPostProcessorClass

Specifies the application Class type implementing the Apache Geode PostProcessor interface, which used to transform sensitive data returned from secure data access operations. Defaults to Void.

Default:

java.lang.Void.class

securityPostProcessorClassName

public abstract String securityPostProcessorClassName

Specifies the fully-qualified class name of the application Class implementing the Apache Geode PostProcessor interface, which used to transform sensitive data returned from secure data access operations. Use this Annotation attribute if you are uncertain whether the application class is on the classpath or not. Default is unset. Use the spring.data.gemfire.security.postprocessor.class-name property in application.properties.

Default:

""

securityUsername

public abstract String securityUsername

The security-username used by a GemFire cache client application required to authenticate. Defaults to unset. Use the spring.data.gemfire.security.username in application.properties.

Default:

""

securityPassword

public abstract String securityPassword

The security-password used by a GemFire cache client application required to authenticate. Defaults to unset. Use the spring.data.gemfire.security.password in application.properties.

Default:

""

shiroIniResourcePath

public abstract String shiroIniResourcePath

Sets the Geode System Property referring to the location of an Apache Shiro INI file used to configure the Apache Shiro Security Framework to secure Apache Geode. Default is unset. Use the spring.data.gemfire.security.shiro.ini-resource-path property in application.properties.

Default:

""