net.shibboleth.ext.spring.util.ApplicationContextBuilder Maven / Gradle / Ivy
/*
* Licensed to the University Corporation for Advanced Internet Development,
* Inc. (UCAID) under one or more contributor license agreements. See the
* NOTICE file distributed with this work for additional information regarding
* copyright ownership. The UCAID licenses this file to You under the Apache
* License, Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.shibboleth.ext.spring.util;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import net.shibboleth.ext.spring.config.BooleanToPredicateConverter;
import net.shibboleth.ext.spring.config.FunctionToFunctionConverter;
import net.shibboleth.ext.spring.config.PredicateToPredicateConverter;
import net.shibboleth.ext.spring.config.StringBooleanToPredicateConverter;
import net.shibboleth.ext.spring.config.StringToDurationConverter;
import net.shibboleth.ext.spring.config.StringToIPRangeConverter;
import net.shibboleth.ext.spring.config.StringToResourceConverter;
import net.shibboleth.ext.spring.context.FilesystemGenericApplicationContext;
import net.shibboleth.ext.spring.resource.PreferFileSystemResourceLoader;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.support.ConversionServiceFactoryBean;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.Resource;
/**
* Fluent builder for a {@link FilesystemGenericApplicationContext} equipped with various standard features,
* behavior, converters, etc. that are applicable to the Shibboleth software components.
*
* @since 5.4.0
*/
public class ApplicationContextBuilder {
/** Class logger. */
@Nonnull private final Logger log = LoggerFactory.getLogger(ApplicationContextBuilder.class);
/** Context name. */
@Nullable @NotEmpty private String contextName;
/** Configuration resources for this service. */
@Nullable @NonnullElements private Collection configurationResources;
/** Conversion service to use. */
@Nullable private ConversionService conversionService;
/** List of context initializers. */
@Nullable @NonnullElements private List>
contextInitializers;
/** List of bean factory post processors for this service's content. */
@Nullable @NonnullElements private List factoryPostProcessors;
/** List of bean post processors for this service's content. */
@Nullable @NonnullElements private List postProcessors;
/** List of property sources to add. */
@Nullable @NonnullElements private List> propertySources;
/** Bean profiles to enable. */
@Nullable @NonnullElements private Collection beanProfiles;
/** Application context owning this engine. */
@Nullable private ApplicationContext parentContext;
/**
* Set the name of the context.
*
* @param name name
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setName(@Nullable @NotEmpty final String name) {
contextName = StringSupport.trimOrNull(name);
return this;
}
/**
* Set a conversion service to use.
*
* @param service conversion service
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setConversionService(@Nullable final ConversionService service) {
conversionService = service;
return this;
}
/**
* Set a single configuration resource for this context.
*
* @param config configuration for this context
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setServiceConfiguration(@Nonnull final Resource config) {
configurationResources = Collections.singletonList(Constraint.isNotNull(config, "Resource cannot be null"));
return this;
}
/**
* Set the configurations for this context.
*
* @param configs configurations for this context
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setServiceConfigurations(
@Nonnull @NonnullElements final Collection configs) {
configurationResources = List.copyOf(Constraint.isNotNull(configs, "Service configurations cannot be null"));
return this;
}
/**
* Set additional property sources for this context.
*
* @param sources property sources to add
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setPropertySources(
@Nonnull @NonnullElements final List> sources) {
propertySources = List.copyOf(Constraint.isNotNull(sources, "Property sources cannot be null"));
return this;
}
/**
* Set a single context initializer for this context.
*
* @param initializer initializer to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setContextInitializer(
@Nonnull final ApplicationContextInitializer initializer) {
Constraint.isNotNull(initializer, "ApplicationContextInitializer cannot be null");
contextInitializers =
Collections.>singletonList(
initializer);
return this;
}
/**
* Set the list of context initializers for this context.
*
* @param initializers initializers to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setContextInitializers(
@Nonnull @NonnullElements
final List> initializers) {
contextInitializers = List.copyOf(Constraint.isNotNull(initializers, "Context initializers cannot be null"));
return this;
}
/**
* Set a single bean factory post processor for this context.
*
* @param processor bean factory post processor to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setBeanFactoryPostProcessor(
@Nonnull final BeanFactoryPostProcessor processor) {
Constraint.isNotNull(processor, "BeanFactoryPostProcessor cannot be null");
factoryPostProcessors = Collections.singletonList(processor);
return this;
}
/**
* Set the list of bean factory post processors for this context.
*
* @param processors bean factory post processors to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setBeanFactoryPostProcessors(
@Nonnull @NonnullElements final List processors) {
Constraint.isNotNull(processors, "BeanFactoryPostProcessor collection cannot be null");
factoryPostProcessors = List.copyOf(processors);
return this;
}
/**
* Set a single bean post processor for this context.
*
* @param processor bean post processor to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setBeanPostProcessor(@Nonnull final BeanPostProcessor processor) {
Constraint.isNotNull(processor, "BeanPostProcessor cannot be null");
postProcessors = Collections.singletonList(processor);
return this;
}
/**
* Set the list of bean post processors for this context.
*
* @param processors bean post processors to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setBeanPostProcessors(
@Nonnull @NonnullElements final List processors) {
Constraint.isNotNull(processors, "BeanPostProcessor collection cannot be null");
postProcessors = List.copyOf(processors);
return this;
}
/**
* Set the bean profiles for this context.
*
* @param profiles bean profiles to apply
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setBeanProfiles(
@Nonnull @NonnullElements final Collection profiles) {
beanProfiles = StringSupport.normalizeStringCollection(profiles);
return this;
}
/**
* Set a custom {@link ConversionService} to use.
*
* @param context parent context
*
* @return this builder
*/
@Nonnull public ApplicationContextBuilder setParentContext(@Nullable final ApplicationContext context) {
parentContext = context;
return this;
}
// Checkstyle: CyclomaticComplexity OFF
/**
* Build the context.
*
* @return the built context, initialized and loaded
*/
@Nonnull public GenericApplicationContext build() {
final FilesystemGenericApplicationContext context = new FilesystemGenericApplicationContext(parentContext);
context.setDisplayName("ApplicationContext:" + (contextName != null ? contextName : "anonymous"));
context.setResourceLoader(new PreferFileSystemResourceLoader());
if (conversionService != null) {
context.getBeanFactory().setConversionService(conversionService);
} else {
final ConversionServiceFactoryBean service = new ConversionServiceFactoryBean();
service.setConverters(new HashSet<>(Arrays.asList(
new StringToIPRangeConverter(),
new BooleanToPredicateConverter(),
new StringBooleanToPredicateConverter(),
new StringToResourceConverter(),
new StringToDurationConverter(),
new PredicateToPredicateConverter<>(),
new FunctionToFunctionConverter<>())));
service.afterPropertiesSet();
context.getBeanFactory().setConversionService(service.getObject());
}
if (factoryPostProcessors != null) {
factoryPostProcessors.forEach(bfpp -> context.addBeanFactoryPostProcessor(bfpp));
}
if (postProcessors != null) {
postProcessors.forEach(bpp -> context.getBeanFactory().addBeanPostProcessor(bpp));
}
if (beanProfiles != null) {
context.getEnvironment().setActiveProfiles(beanProfiles.toArray(new String[0]));
}
if (propertySources != null) {
propertySources.forEach(p -> context.getEnvironment().getPropertySources().addLast(p));
context.getEnvironment().setPlaceholderPrefix("%{");
context.getEnvironment().setPlaceholderSuffix("}");
}
final SchemaTypeAwareXMLBeanDefinitionReader beanDefinitionReader =
new SchemaTypeAwareXMLBeanDefinitionReader(context);
if (configurationResources != null) {
beanDefinitionReader.loadBeanDefinitions(configurationResources.toArray(new Resource[] {}));
}
if (contextInitializers != null) {
contextInitializers.forEach(i -> i.initialize(context));
}
context.refresh();
return context;
}
// Checkstyle: CyclomaticComplexity ON
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy