org.springframework.data.gemfire.config.annotation

Class ApacheShiroSecurityConfiguration

java.lang.Object

org.springframework.data.gemfire.config.annotation.ApacheShiroSecurityConfiguration

All Implemented Interfaces:

Aware, BeanFactoryAware

@Configuration
 @Conditional(value=ApacheShiroSecurityConfiguration.ApacheShiroPresentCondition.class)
public class ApacheShiroSecurityConfiguration
extends Object
implements BeanFactoryAware

The ApacheShiroSecurityConfiguration class is a Spring @Configuration component responsible for configuring and initializing the Apache Shiro security framework in order to secure Apache Geode administrative and data access operations.

Since:

1.9.0

Author:

John Blum

See Also:

GemFireCache, SecurityService, DefaultSecurityManager, Realm, LifecycleBeanPostProcessor, BeanFactoryAware, ListableBeanFactory, Bean, Condition, Conditional, Configuration, ApacheShiroSecurityConfiguration.ApacheShiroPresentCondition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApacheShiroSecurityConfiguration.ApacheShiroPresentCondition A Spring Condition to determine whether the user has included (declared) the 'shiro-spring' dependency on their application's classpath, which is necessary for configuring Apache Shiro to secure Apache Geode in a Spring context.

Constructor Summary

Constructors

Constructor and Description
ApacheShiroSecurityConfiguration()

Method Summary

Modifier and Type	Method and Description
protected boolean	enableApacheGeodeSecurity() Sets the Apache Geode, Integrated Security SecurityService property isIntegratedSecurity to true to indicate that Apache Geode security is enabled.
protected ListableBeanFactory	getBeanFactory() Returns a reference to the Spring BeanFactory.
protected org.apache.shiro.mgt.SecurityManager	registerSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager) Registers the given Apache Shiro SecurityManager with the Apache Shiro security framework.
protected List<org.apache.shiro.realm.Realm>	resolveRealms() Resolves all the Apache Shiro Realms declared and configured as Spring managed beans in the Spring ApplicationContext.
void	setBeanFactory(BeanFactory beanFactory)
BeanPostProcessor	shiroLifecycleBeanPostProcessor() Bean definition to define, configure and register an Apache Shiro Spring LifecycleBeanPostProcessor to automatically call lifecycle callback methods on Shiro security components during Spring container initialization and destruction phases.
org.apache.shiro.mgt.SecurityManager	shiroSecurityManager(org.apache.geode.cache.GemFireCache gemfireCache) Bean definition to define, configure and register an Apache Shiro SecurityManager implementation to secure Apache Geode.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheShiroSecurityConfiguration

public ApacheShiroSecurityConfiguration()

Method Detail

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

getBeanFactory

protected ListableBeanFactory getBeanFactory()

Returns a reference to the Spring BeanFactory.

Returns:

a reference to the Spring BeanFactory.

Throws:

IllegalStateException - if the Spring BeanFactory was not properly initialized.

See Also:

BeanFactory

shiroLifecycleBeanPostProcessor

@Bean
public BeanPostProcessor shiroLifecycleBeanPostProcessor()

Bean definition to define, configure and register an Apache Shiro Spring LifecycleBeanPostProcessor to automatically call lifecycle callback methods on Shiro security components during Spring container initialization and destruction phases.

Returns:

an instance of the Apache Shiro Spring LifecycleBeanPostProcessor to handle the lifecycle of Apache Shiro security framework components.

See Also:

LifecycleBeanPostProcessor

shiroSecurityManager

@Bean
public org.apache.shiro.mgt.SecurityManager shiroSecurityManager(org.apache.geode.cache.GemFireCache gemfireCache)

Bean definition to define, configure and register an Apache Shiro SecurityManager implementation to secure Apache Geode. The registration of this Bean definition is dependent upon whether the user is using Apache Shiro to secure Apache Geode, which is determined by the presence of Apache Shiro Realms declared in the Spring ApplicationContext. This Bean definition declares a dependency on the Apache Geode GemFireCache instance in order to ensure the Geode cache is created and initialized first. This ensures that any internal Geode security configuration logic is evaluated and processed before SDG attempts to configure Apache Shiro as Apache Geode's security provider. Additionally, this Bean definition will register the Apache Shiro SecurityManager with the Apache Shiro security framework Finally, this method proceeds to enable Apache Geode security.

Returns:

an Apache Shiro SecurityManager implementation used to secure Apache Geode.

Throws:

IllegalStateException - if an Apache Shiro SecurityManager was registered with the Apache Shiro security framework but Apache Geode security could not be enabled.

See Also:

SecurityManager, registerSecurityManager(org.apache.shiro.mgt.SecurityManager), enableApacheGeodeSecurity(), resolveRealms(), registerSecurityManager(org.apache.shiro.mgt.SecurityManager), enableApacheGeodeSecurity()

resolveRealms

protected List<org.apache.shiro.realm.Realm> resolveRealms()

Resolves all the Apache Shiro Realms declared and configured as Spring managed beans in the Spring ApplicationContext. This method will order the Realms according to priority order to ensure that the Apache Shiro Realms are applied in the correct sequence, as declared/configured.

Returns:

a List of all Apache Shiro Realms declared and configured as Spring managed beans in the Spring ApplicationContext.

See Also:

ListableBeanFactory.getBeansOfType(Class, boolean, boolean), OrderComparator, Realm

registerSecurityManager

protected org.apache.shiro.mgt.SecurityManager registerSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager)

Registers the given Apache Shiro SecurityManager with the Apache Shiro security framework.

Parameters:

securityManager - SecurityManager to register.

Returns:

the given SecurityManager reference.

Throws:

IllegalArgumentException - if SecurityManager is null.

See Also:

SecurityUtils.setSecurityManager(org.apache.shiro.mgt.SecurityManager), SecurityManager

enableApacheGeodeSecurity

protected boolean enableApacheGeodeSecurity()

Sets the Apache Geode, Integrated Security SecurityService property isIntegratedSecurity to true to indicate that Apache Geode security is enabled.

Returns:

a boolean value indicating whether Apache Geode's Integrated Security framework services were successfully enabled.

See Also:

SecurityService.getSecurityService()