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 org.slf4j.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

Modifier and Type	Method and Description
static org.springframework.beans.factory.BeanFactory	createBeanFactory(Element springBeans) Creates a Spring bean factory from the supplied Spring beans element.
static org.springframework.beans.factory.support.AbstractBeanDefinition	getAttributeValueAsList(Attr attribute) Gets the value of a list-type attribute as a BeanDefinitionBuilder.
static org.springframework.beans.factory.support.ManagedList<String>	getAttributeValueAsManagedList(Attr attribute) Deprecated. - use getAttributeValueAsList(Attr)
static <T> T	getBean(org.springframework.beans.factory.BeanFactory beanFactory, Class<T> clazz) Retrieves the bean of the supplied type from the supplied bean factory.
static org.springframework.beans.factory.support.ManagedList<String>	getElementTextContentAsManagedList(Collection<Element> elements) Gets the text content of a list of Elements as a ManagedList.
static org.springframework.context.support.GenericApplicationContext	newContext(String name, List<org.springframework.core.io.Resource> configurationResources, List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> factoryPostProcessors, List<org.springframework.beans.factory.config.BeanPostProcessor> postProcessors, List<org.springframework.context.ApplicationContextInitializer> initializers, org.springframework.context.ApplicationContext parentContext) Deprecated. - use ApplicationContextBuilder
static org.springframework.beans.factory.config.BeanDefinition	parseCustomElement(Element element, org.springframework.beans.factory.xml.ParserContext parserContext) Parse an element into a bean definition.
static org.springframework.beans.factory.support.ManagedList<org.springframework.beans.factory.config.BeanDefinition>	parseCustomElements(Collection<Element> elements, org.springframework.beans.factory.xml.ParserContext parserContext) Parse list of elements into bean definitions.
static void	parseNativeElement(Element springBeans, org.springframework.beans.factory.support.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 org.slf4j.Logger LOG

Logger.

Constructor Detail

SpringSupport

private SpringSupport()

Constructor.

Method Detail

newContext

@Deprecated
 @Nonnull
public static org.springframework.context.support.GenericApplicationContext newContext(@Nonnull @NotEmpty
                                                                                                             String name,
                                                                                                             @Nonnull @NonnullElements
                                                                                                             List<org.springframework.core.io.Resource> configurationResources,
                                                                                                             @Nonnull @NonnullElements
                                                                                                             List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> factoryPostProcessors,
                                                                                                             @Nonnull @NonnullElements
                                                                                                             List<org.springframework.beans.factory.config.BeanPostProcessor> postProcessors,
                                                                                                             @Nonnull @NonnullElements
                                                                                                             List<org.springframework.context.ApplicationContextInitializer> initializers,
                                                                                                             @Nullable
                                                                                                             org.springframework.context.ApplicationContext parentContext)

Deprecated. - use ApplicationContextBuilder

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 TODO: The signature here needs to constrain the ApplicationContextInitializers supplied to be safe for use with a FilesystemGenericApplicationContext. The raw types are masking the bug.

parseCustomElements

@Nullable
public static org.springframework.beans.factory.support.ManagedList<org.springframework.beans.factory.config.BeanDefinition> parseCustomElements(@Nullable @NonnullElements
                                                                                                                                                           Collection<Element> elements,
                                                                                                                                                           @Nonnull
                                                                                                                                                           org.springframework.beans.factory.xml.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 org.springframework.beans.factory.config.BeanDefinition parseCustomElement(@Nullable
                                                                                                   Element element,
                                                                                                   @Nonnull
                                                                                                   org.springframework.beans.factory.xml.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
                                      org.springframework.beans.factory.support.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 org.springframework.beans.factory.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
                                      org.springframework.beans.factory.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
 @Deprecated
public static org.springframework.beans.factory.support.ManagedList<String> getAttributeValueAsManagedList(@Nullable
                                                                                                                                 Attr attribute)

Deprecated. - use getAttributeValueAsList(Attr)

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

getAttributeValueAsList

@Nonnull
public static org.springframework.beans.factory.support.AbstractBeanDefinition getAttributeValueAsList(@Nullable
                                                                                                                Attr attribute)

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

Parameters:

attribute - attribute whose value will be turned into a list

Returns:

a bean which will generate a list of the values.

getElementTextContentAsManagedList

@Nonnull
public static org.springframework.beans.factory.support.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