net.shibboleth.ext.spring.util

Class ApplicationContextBuilder

java.lang.Object

net.shibboleth.ext.spring.util.ApplicationContextBuilder

public class ApplicationContextBuilder
extends Object

Fluent builder for a FilesystemGenericApplicationContext equipped with various standard features, behavior, converters, etc.

Since:

5.4.0

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<String>	beanProfiles Bean profiles to enable.
private List<org.springframework.core.io.Resource>	configurationResources List of configuration resources for this service.
private List<org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext>>	contextInitializers List of context initializers.
private String	contextName Context name.
private org.springframework.core.convert.ConversionService	conversionService Conversion service to use.
private List<org.springframework.beans.factory.config.BeanFactoryPostProcessor>	factoryPostProcessors List of bean factory post processors for this service's content.
private Logger	log Class logger.
private org.springframework.context.ApplicationContext	parentContext Application context owning this engine.
private List<org.springframework.beans.factory.config.BeanPostProcessor>	postProcessors List of bean post processors for this service's content.

Constructor Summary

Constructors

Constructor and Description
ApplicationContextBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.context.support.GenericApplicationContext	build() Build the context.
ApplicationContextBuilder	setBeanFactoryPostProcessor(org.springframework.beans.factory.config.BeanFactoryPostProcessor processor) Set a single bean factory post processor for this context.
ApplicationContextBuilder	setBeanFactoryPostProcessors(List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> processors) Set the list of bean factory post processors for this context.
ApplicationContextBuilder	setBeanPostProcessor(org.springframework.beans.factory.config.BeanPostProcessor processor) Set a single bean post processor for this context.
ApplicationContextBuilder	setBeanPostProcessors(List<org.springframework.beans.factory.config.BeanPostProcessor> processors) Set the list of bean post processors for this context.
ApplicationContextBuilder	setBeanProfiles(Collection<String> profiles) Set the bean profiles for this context.
ApplicationContextBuilder	setContextInitializer(org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext> initializer) Set a single context initializer for this context.
ApplicationContextBuilder	setContextInitializers(List<org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext>> initializers) Set the list of context initializers for this context.
ApplicationContextBuilder	setConversionService(org.springframework.core.convert.ConversionService service) Set a conversion service to use.
ApplicationContextBuilder	setName(String name) Set the name of the context.
ApplicationContextBuilder	setParentContext(org.springframework.context.ApplicationContext context) Set a custom ConversionService to use.
ApplicationContextBuilder	setServiceConfiguration(org.springframework.core.io.Resource config) Set a single configuration resource for this context.
ApplicationContextBuilder	setServiceConfigurations(List<org.springframework.core.io.Resource> configs) Set the list of configurations for this context.

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

contextName

@Nullable
@NotEmpty
private String contextName

Context name.

configurationResources

@Nullable
@NonnullElements
private List<org.springframework.core.io.Resource> configurationResources

List of configuration resources for this service.

conversionService

@Nullable
private org.springframework.core.convert.ConversionService conversionService

Conversion service to use.

contextInitializers

@Nullable
@NonnullElements
private List<org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext>> contextInitializers

List of context initializers.

factoryPostProcessors

@Nullable
@NonnullElements
private List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> factoryPostProcessors

List of bean factory post processors for this service's content.

postProcessors

@Nullable
@NonnullElements
private List<org.springframework.beans.factory.config.BeanPostProcessor> postProcessors

List of bean post processors for this service's content.

beanProfiles

@Nullable
@NonnullElements
private Collection<String> beanProfiles

Bean profiles to enable.

parentContext

@Nullable
private org.springframework.context.ApplicationContext parentContext

Application context owning this engine.

Constructor Detail

ApplicationContextBuilder

public ApplicationContextBuilder()

Method Detail

setName

@Nonnull
public ApplicationContextBuilder setName(@Nullable@NotEmpty
                                        String name)

Set the name of the context.

Parameters:

name - name

Returns:

this builder

setConversionService

@Nonnull
public ApplicationContextBuilder setConversionService(@Nullable
                                                     org.springframework.core.convert.ConversionService service)

Set a conversion service to use.

Parameters:

service - conversion service

Returns:

this builder

setServiceConfiguration

@Nonnull
public ApplicationContextBuilder setServiceConfiguration(@Nonnull
                                                        org.springframework.core.io.Resource config)

Set a single configuration resource for this context.

Parameters:

config - configuration for this context

Returns:

this builder

setServiceConfigurations

@Nonnull
public ApplicationContextBuilder setServiceConfigurations(@Nonnull@NonnullElements
                                                         List<org.springframework.core.io.Resource> configs)

Set the list of configurations for this context.

Parameters:

configs - list of configurations for this context

Returns:

this builder

setContextInitializer

@Nonnull
public ApplicationContextBuilder setContextInitializer(@Nonnull
                                                      org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext> initializer)

Set a single context initializer for this context.

Parameters:

initializer - initializer to apply

Returns:

this builder

setContextInitializers

@Nonnull
public ApplicationContextBuilder setContextInitializers(@Nonnull@NonnullElements
                                                       List<org.springframework.context.ApplicationContextInitializer<? super FilesystemGenericApplicationContext>> initializers)

Set the list of context initializers for this context.

Parameters:

initializers - initializers to apply

Returns:

this builder

setBeanFactoryPostProcessor

@Nonnull
public ApplicationContextBuilder setBeanFactoryPostProcessor(@Nonnull
                                                            org.springframework.beans.factory.config.BeanFactoryPostProcessor processor)

Set a single bean factory post processor for this context.

Parameters:

processor - bean factory post processor to apply

Returns:

this builder

setBeanFactoryPostProcessors

@Nonnull
public ApplicationContextBuilder setBeanFactoryPostProcessors(@Nonnull@NonnullElements
                                                             List<org.springframework.beans.factory.config.BeanFactoryPostProcessor> processors)

Set the list of bean factory post processors for this context.

Parameters:

processors - bean factory post processors to apply

Returns:

this builder

setBeanPostProcessor

@Nonnull
public ApplicationContextBuilder setBeanPostProcessor(@Nonnull
                                                     org.springframework.beans.factory.config.BeanPostProcessor processor)

Set a single bean post processor for this context.

Parameters:

processor - bean post processor to apply

Returns:

this builder

setBeanPostProcessors

@Nonnull
public ApplicationContextBuilder setBeanPostProcessors(@Nonnull@NonnullElements
                                                      List<org.springframework.beans.factory.config.BeanPostProcessor> processors)

Set the list of bean post processors for this context.

Parameters:

processors - bean post processors to apply

Returns:

this builder

setBeanProfiles

@Nonnull
public ApplicationContextBuilder setBeanProfiles(@Nonnull@NonnullElements
                                                Collection<String> profiles)

Set the bean profiles for this context.

Parameters:

profiles - bean profiles to apply

Returns:

this builder

setParentContext

@Nonnull
public ApplicationContextBuilder setParentContext(@Nullable
                                                 org.springframework.context.ApplicationContext context)

Set a custom ConversionService to use.

Parameters:

context - parent context

Returns:

this builder

build

@Nonnull
public org.springframework.context.support.GenericApplicationContext build()

Build the context.

Returns:

the built context, initialized and loaded