com.acc.filter.FilterSpringUtil.java Source code

Introduction

Here is the source code for com.acc.filter.FilterSpringUtil.java

Source

/*
 * [y] hybris Platform
 *
 * Copyright (c) 2000-2013 hybris AG
 * All rights reserved.
 *
 * This software is the confidential and proprietary information of hybris
 * ("Confidential Information"). You shall not disclose such Confidential
 * Information and shall use it only in accordance with the terms of the
 * license agreement you entered into with hybris.
 * 
 *  
 */
package com.acc.filter;

import java.util.Map;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

/**
 * Util class for retrieving spring beans.
 */
public class FilterSpringUtil {
    protected static final Logger LOG = Logger.getLogger(FilterSpringUtil.class);

    /**
     * Returns the Spring bean with name <code>beanName</code> and of type <code>beanClass</code>. If no bean could be
     * resolved for the specified name, the bean is looked up using type.
     * 
     * @param <T>
     *           type of the bean
     * @param httpRequest
     *           the http request
     * @param beanName
     *           name of the bean or <code>null</code> if it should be automatically resolved using type
     * @param beanClass
     *           expected type of the bean
     * @return the bean matching the given arguments or <code>null</code> if no bean could be resolved
     * 
     */
    public static <T> T getSpringBean(final HttpServletRequest httpRequest, final String beanName,
            final Class<T> beanClass) {
        final HttpSession session = httpRequest.getSession();
        final ServletContext servletContext = session.getServletContext();
        return getSpringBean(servletContext, beanName, beanClass);
    }

    /**
     * The same as {@link #getSpringBean(HttpServletRequest, String, Class)} but uses ServletContext as the first
     * parameter. It might be used in places, where HttpServletRequest is not available, but ServletContext is.
     */
    public static <T> T getSpringBean(final ServletContext servletContext, final String beanName,
            final Class<T> beanClass) {
        T ret = null;
        final WebApplicationContext appContext = WebApplicationContextUtils
                .getRequiredWebApplicationContext(servletContext);

        if (StringUtils.isNotBlank(beanName)) {
            try {
                ret = (T) appContext.getBean(beanName);
            } catch (final NoSuchBeanDefinitionException nsbde) {
                LOG.warn("No bean found with the specified name. Trying to resolve bean using type...");
            }
        }
        if (ret == null) {
            if (beanClass == null) {
                LOG.warn("No bean could be resolved. Reason: No type specified.");
            } else {
                final Map<String, T> beansOfType = appContext.getBeansOfType(beanClass);
                if (beansOfType != null && !beansOfType.isEmpty()) {
                    if (beansOfType.size() > 1) {
                        LOG.warn("More than one matching bean found of type " + beanClass.getSimpleName()
                                + ". Returning the first one found.");
                    }
                    ret = beansOfType.values().iterator().next();
                }
            }
        }
        return ret;
    }

}