net.shibboleth.ext.spring.util

Class SpringSupport

java.lang.Object

net.shibboleth.ext.spring.util.SpringSupport

public final class SpringSupport
extends Object

Helper class for performing some common Spring-related functions.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static Logger	LOG Logger.
static QName	SPRING_BEANS_ELEMENT_NAME Spring beans element name.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SpringSupport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static BeanFactory	createBeanFactory(Element springBeans) Creates a Spring bean factory from the supplied Spring beans element.
static ManagedList<String>	getAttributeValueAsManagedList(Attr attribute) Gets the value of a list-type attribute as a ManagedList.
static <T> T	getBean(BeanFactory beanFactory, Class<T> clazz) Retrieves the bean of the supplied type from the supplied bean factory.
static ManagedList<String>	getElementTextContentAsManagedList(Collection<Element> elements) Gets the text content of a list of Elements as a ManagedList.
static GenericApplicationContext	newContext(String name, List<Resource> configurationResources, List<BeanFactoryPostProcessor> factoryPostProcessors, List<BeanPostProcessor> postProcessors, List<ApplicationContextInitializer> initializers, ApplicationContext parentContext) Creates a new, started, application context from the given configuration resources.
static BeanDefinition	parseCustomElement(Element element, ParserContext parserContext) Parse an element into a bean definition.
static ManagedList<BeanDefinition>	parseCustomElements(Collection<Element> elements, ParserContext parserContext) Parse list of elements into bean definitions.
static void	parseNativeElement(Element springBeans, BeanDefinitionRegistry registry) Parse the provided Element into the provided registry.

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_BEANS_ELEMENT_NAME

@Nonnull
public static final QName SPRING_BEANS_ELEMENT_NAME

Spring beans element name.

LOG

@Nonnull
static final Logger LOG

Logger.

Constructor Detail

SpringSupport

private SpringSupport()

Constructor.

Method Detail

newContext

@Nonnull
public static GenericApplicationContext newContext(@Nonnull@NotEmpty
                                           String name,
                                           @Nonnull@NonnullElements
                                           List<Resource> configurationResources,
                                           @Nonnull@NonnullElements
                                           List<BeanFactoryPostProcessor> factoryPostProcessors,
                                           @Nonnull@NonnullElements
                                           List<BeanPostProcessor> postProcessors,
                                           @Nonnull@NonnullElements
                                           List<ApplicationContextInitializer> initializers,
                                           @Nullable
                                           ApplicationContext parentContext)

Creates a new, started, application context from the given configuration resources.

Parameters:

name - name of the application context

configurationResources - configuration resources

factoryPostProcessors - post processors to inject

postProcessors - post processors to inject

initializers - application context initializers

parentContext - parent context, or null if there is no parent

Returns:

the created context

parseCustomElements

@Nullable
public static ManagedList<BeanDefinition> parseCustomElements(@Nullable@NonnullElements
                                                       Collection<Element> elements,
                                                       @Nonnull
                                                       ParserContext parserContext)

Parse list of elements into bean definitions.

Parameters:

elements - list of elements to parse

parserContext - current parsing context

Returns:

list of bean definitions

parseCustomElement

@Nullable
public static BeanDefinition parseCustomElement(@Nullable
                                         Element element,
                                         @Nonnull
                                         ParserContext parserContext)

Parse an element into a bean definition.

Parameters:

element - the element to parse

parserContext - current parsing context

Returns:

the parsed bean definition

parseNativeElement

public static void parseNativeElement(@Nonnull
                      Element springBeans,
                      @Nullable
                      BeanDefinitionRegistry registry)

Parse the provided Element into the provided registry.

Parameters:

springBeans - the element to parse

registry - the registry to populate

createBeanFactory

@Nonnull
public static BeanFactory createBeanFactory(@Nonnull
                                    Element springBeans)

Creates a Spring bean factory from the supplied Spring beans element.

Parameters:

springBeans - to create bean factory from

Returns:

bean factory

getBean

@Nullable
public static <T> T getBean(@Nonnull
                     BeanFactory beanFactory,
                     @Nonnull
                     Class<T> clazz)

Retrieves the bean of the supplied type from the supplied bean factory. Returns null if no bean definition is found.

Type Parameters:

T - type of bean to return

Parameters:

beanFactory - to get the bean from

clazz - type of the bean to retrieve

Returns:

spring bean

getAttributeValueAsManagedList

@Nonnull
public static ManagedList<String> getAttributeValueAsManagedList(@Nullable
                                                         Attr attribute)

Gets the value of a list-type attribute as a ManagedList.

Parameters:

attribute - attribute whose value will be turned into a list

Returns:

list of values, never null

getElementTextContentAsManagedList

@Nonnull
public static ManagedList<String> getElementTextContentAsManagedList(@Nullable
                                                             Collection<Element> elements)

Gets the text content of a list of Elements as a ManagedList.

Parameters:

elements - the elements whose values will be turned into a list

Returns:

list of values, never null