org.springframework.test.context.support.AnnotationConfigWebContextLoader.java Source code

Introduction

Here is the source code for org.springframework.test.context.support.AnnotationConfigWebContextLoader.java

Source

/*
 * Copyright 2002-2012 the original author or authors.
 *
 * Licensed 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 org.springframework.test.context.support;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
import org.springframework.test.context.ContextConfigurationAttributes;
import org.springframework.test.context.web.WebMergedContextConfiguration;
import org.springframework.util.ObjectUtils;
import org.springframework.web.context.support.GenericWebApplicationContext;

/**
 * TODO [SPR-9864] Document AnnotationConfigWebContextLoader.
 *
 * @author Sam Brannen
 * @since 3.2
 */
public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextLoader {

    private static final Log logger = LogFactory.getLog(AnnotationConfigWebContextLoader.class);

    // --- SmartContextLoader -----------------------------------------------

    /**
     * Process <em>annotated classes</em> in the supplied {@link ContextConfigurationAttributes}.
     *
     * <p>If the <em>annotated classes</em> are <code>null</code> or empty and
     * {@link #isGenerateDefaultLocations()} returns <code>true</code>, this
     * <code>SmartContextLoader</code> will attempt to {@link
     * #detectDefaultConfigurationClasses detect default configuration classes}.
     * If defaults are detected they will be
     * {@link ContextConfigurationAttributes#setClasses(Class[]) set} in the
     * supplied configuration attributes. Otherwise, properties in the supplied
     * configuration attributes will not be modified.
     * 
     * @param configAttributes the context configuration attributes to process
     * @see org.springframework.test.context.SmartContextLoader#processContextConfiguration(ContextConfigurationAttributes)
     * @see #isGenerateDefaultLocations()
     * @see #detectDefaultConfigurationClasses(Class)
     */
    public void processContextConfiguration(ContextConfigurationAttributes configAttributes) {
        if (ObjectUtils.isEmpty(configAttributes.getClasses()) && isGenerateDefaultLocations()) {
            Class<?>[] defaultConfigClasses = detectDefaultConfigurationClasses(
                    configAttributes.getDeclaringClass());
            configAttributes.setClasses(defaultConfigClasses);
        }
    }

    /**
     * Detect the default configuration classes for the supplied test class.
     *
     * <p>The default implementation simply delegates to
     * {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses(Class)}.
     *
     * @param declaringClass the test class that declared {@code @ContextConfiguration}
     * @return an array of default configuration classes, potentially empty but
     * never <code>null</code>
     * @see AnnotationConfigContextLoaderUtils
     */
    protected Class<?>[] detectDefaultConfigurationClasses(Class<?> declaringClass) {
        return AnnotationConfigContextLoaderUtils.detectDefaultConfigurationClasses(declaringClass);
    }

    // --- AbstractContextLoader -----------------------------------------------

    /**
     * {@code AnnotationConfigWebContextLoader} should be used as a
     * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader},
     * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}.
     * Consequently, this method is not supported.
     *
     * @see AbstractContextLoader#modifyLocations
     * @throws UnsupportedOperationException
     */
    @Override
    protected String[] modifyLocations(Class<?> clazz, String... locations) {
        throw new UnsupportedOperationException(
                "AnnotationConfigWebContextLoader does not support the modifyLocations(Class, String...) method");
    }

    /**
     * {@code AnnotationConfigWebContextLoader} should be used as a
     * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader},
     * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}.
     * Consequently, this method is not supported.
     *
     * @see AbstractContextLoader#generateDefaultLocations
     * @throws UnsupportedOperationException
     */
    @Override
    protected String[] generateDefaultLocations(Class<?> clazz) {
        throw new UnsupportedOperationException(
                "AnnotationConfigWebContextLoader does not support the generateDefaultLocations(Class) method");
    }

    /**
     * {@code AnnotationConfigWebContextLoader} should be used as a
     * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader},
     * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}.
     * Consequently, this method is not supported.
     *
     * @see AbstractContextLoader#getResourceSuffix
     * @throws UnsupportedOperationException
     */
    @Override
    protected String getResourceSuffix() {
        throw new UnsupportedOperationException(
                "AnnotationConfigWebContextLoader does not support the getResourceSuffix() method");
    }

    // --- AbstractGenericWebContextLoader -------------------------------------

    /**
     * Register classes in the supplied {@link GenericWebApplicationContext context}
     * from the classes in the supplied {@link WebMergedContextConfiguration}.
     *
     * <p>Each class must represent an <em>annotated class</em>. An
     * {@link AnnotatedBeanDefinitionReader} is used to register the appropriate
     * bean definitions.
     *
     * @param context the context in which the annotated classes should be registered
     * @param webMergedConfig the merged configuration from which the classes should be retrieved
     *
     * @see AbstractGenericWebContextLoader#loadBeanDefinitions
     */
    @Override
    protected void loadBeanDefinitions(GenericWebApplicationContext context,
            WebMergedContextConfiguration webMergedConfig) {
        Class<?>[] annotatedClasses = webMergedConfig.getClasses();
        if (logger.isDebugEnabled()) {
            logger.debug("Registering annotated classes: " + ObjectUtils.nullSafeToString(annotatedClasses));
        }
        new AnnotatedBeanDefinitionReader(context).register(annotatedClasses);
    }

}