ar.com.zauber.commons.spring.mock.TestFriendlyContextLoader.java Source code

Introduction

Here is the source code for ar.com.zauber.commons.spring.mock.TestFriendlyContextLoader.java

Source

/**
 * Copyright (c) 2005-2012 Zauber S.A. <http://www.zaubersoftware.com/>
 *
 * 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 ar.com.zauber.commons.spring.mock;

import javax.servlet.ServletContext;

import junit.framework.TestCase;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.web.context.ContextLoader;
import org.springframework.web.context.WebApplicationContext;

/**
 * {@link ContextLoader} subclass that lets {@link TestCase}s to initialize
 * {@link WebApplicationContext} and query for a bean.
 * 
 * For example:
 * <pre>
 * final MockServletContext servletCtx = new MockServletContext("/home");
 * servletCtx.addInitParameter("contextConfigLocation", 
 *                             "classpath:/spring-test-switch-regex.xml");
 * final TestFriendlyContextLoaderListener listener = 
 *          new TestFriendlyContextLoaderListener();
 * listener.contextInitialized(new ServletContextEvent(servletCtx));
 *      
 * final WebApplicationContext ctx = 
 *           ((TestFriendlyContextLoader)listener.getContextLoader()).getCtx();
 *       
 * assertEquals("home", ctx.getBean("test1"));
 * </pre>
 * 
 * @author Juan F. Codagnone
 * @since Nov 13, 2007
 */
public class TestFriendlyContextLoader extends ContextLoader {
    private WebApplicationContext ctx;

    /** @see ContextLoader#createWebApplicationContext(ServletContext, 
     *          ApplicationContext) */
    @Override
    protected final WebApplicationContext createWebApplicationContext(final ServletContext servletContext,
            final ApplicationContext parent) throws BeansException {
        ctx = super.createWebApplicationContext(servletContext, parent);
        return ctx;
    }

    /**
     * Returns the ctx.
     * 
     * @return <code>WebApplicationContext</code> with the ctx.
     */
    public final WebApplicationContext getCtx() {
        return ctx;
    }
}