Package de.hybris.platform.spring.ctx

Class TenantIgnoreXmlWebApplicationContext

  • All Implemented Interfaces:
    TenantNameAwareContext, java.io.Closeable, java.lang.AutoCloseable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactory, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.HierarchicalBeanFactory, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.ListableBeanFactory, org.springframework.context.ApplicationContext, org.springframework.context.ApplicationEventPublisher, org.springframework.context.ConfigurableApplicationContext, org.springframework.context.Lifecycle, org.springframework.context.MessageSource, org.springframework.core.env.EnvironmentCapable, org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver, org.springframework.ui.context.ThemeSource, org.springframework.web.context.ConfigurableWebApplicationContext, org.springframework.web.context.WebApplicationContext
    Direct Known Subclasses:
    BackofficeApplicationContext
    public class TenantIgnoreXmlWebApplicationContext
extends org.springframework.web.context.support.XmlWebApplicationContext
implements TenantNameAwareContext
    Custom XmlWebApplicationContext implementation which ignores any declared "tenant" scope occurrence.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

        org.springframework.core.io.DefaultResourceLoader.ClassPathContextResource

    • Field Summary

      • Fields inherited from class org.springframework.web.context.support.XmlWebApplicationContext

        DEFAULT_CONFIG_LOCATION, DEFAULT_CONFIG_LOCATION_PREFIX, DEFAULT_CONFIG_LOCATION_SUFFIX

      • Fields inherited from class org.springframework.context.support.AbstractApplicationContext

        APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME

      • Fields inherited from interface org.springframework.beans.factory.BeanFactory

        FACTORY_BEAN_PREFIX

      • Fields inherited from interface org.springframework.context.ConfigurableApplicationContext

        CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME

      • Fields inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext

        APPLICATION_CONTEXT_ID_PREFIX, SERVLET_CONFIG_BEAN_NAME

      • Fields inherited from interface org.springframework.core.io.ResourceLoader

        CLASSPATH_URL_PREFIX

      • Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

        CLASSPATH_ALL_URL_PREFIX

      • Fields inherited from interface org.springframework.web.context.WebApplicationContext

        CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()  
      java.lang.String getTenantName()  
      protected void initBeanDefinitionReader​(org.springframework.beans.factory.xml.XmlBeanDefinitionReader beanDefinitionReader)  

      • Methods inherited from class org.springframework.web.context.support.XmlWebApplicationContext

        getDefaultConfigLocations, loadBeanDefinitions, loadBeanDefinitions

      • Methods inherited from class org.springframework.web.context.support.AbstractRefreshableWebApplicationContext

        createEnvironment, getApplicationName, getConfigLocations, getNamespace, getResourceByPath, getResourcePatternResolver, getServletConfig, getServletContext, getTheme, initPropertySources, onRefresh, postProcessBeanFactory, setNamespace, setServletConfig, setServletContext

      • Methods inherited from class org.springframework.context.support.AbstractRefreshableConfigApplicationContext

        afterPropertiesSet, resolvePath, setBeanName, setConfigLocation, setConfigLocations, setId

      • Methods inherited from class org.springframework.context.support.AbstractRefreshableApplicationContext

        assertBeanFactoryActive, cancelRefresh, closeBeanFactory, createBeanFactory, customizeBeanFactory, getBeanFactory, hasBeanFactory, refreshBeanFactory, setAllowBeanDefinitionOverriding, setAllowCircularReferences

      • Methods inherited from class org.springframework.context.support.AbstractApplicationContext

        addApplicationListener, addBeanFactoryPostProcessor, close, containsBean, containsBeanDefinition, containsLocalBean, destroy, destroyBeans, doClose, findAnnotationOnBean, finishBeanFactoryInitialization, finishRefresh, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getResources, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, invokeBeanFactoryPostProcessors, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, isTypeMatch, obtainFreshBeanFactory, onClose, prepareBeanFactory, prepareRefresh, publishEvent, publishEvent, publishEvent, refresh, registerBeanPostProcessors, registerListeners, registerShutdownHook, resetCommonCaches, setDisplayName, setEnvironment, setParent, start, stop, toString

      • Methods inherited from class org.springframework.core.io.DefaultResourceLoader

        addProtocolResolver, clearResourceCaches, getClassLoader, getProtocolResolvers, getResource, getResourceCache, setClassLoader

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.springframework.context.ApplicationContext

        getAutowireCapableBeanFactory, getId, getParent, getStartupDate

      • Methods inherited from interface org.springframework.context.ApplicationEventPublisher

        publishEvent, publishEvent

      • Methods inherited from interface org.springframework.beans.factory.BeanFactory

        containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

      • Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

        addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getBeanFactory, getEnvironment, isActive, refresh, registerShutdownHook, setEnvironment, setId, setParent

      • Methods inherited from interface org.springframework.web.context.ConfigurableWebApplicationContext

        setConfigLocation, setConfigLocations

      • Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory

        containsLocalBean, getParentBeanFactory

      • Methods inherited from interface org.springframework.context.Lifecycle

        isRunning, start, stop

      • Methods inherited from interface org.springframework.beans.factory.ListableBeanFactory

        containsBeanDefinition, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation

      • Methods inherited from interface org.springframework.context.MessageSource

        getMessage, getMessage, getMessage

      • Methods inherited from interface org.springframework.core.io.ResourceLoader

        getClassLoader, getResource

      • Methods inherited from interface org.springframework.core.io.support.ResourcePatternResolver

        getResources

    • Constructor Detail

      • TenantIgnoreXmlWebApplicationContext

        public TenantIgnoreXmlWebApplicationContext​(java.lang.String tenantId,
                                            java.lang.String ctxPath)

      • TenantIgnoreXmlWebApplicationContext

        public TenantIgnoreXmlWebApplicationContext()
        Constructs a migration XmlWebApplicationContext instance. Purpose of this XmlWebApplicationContext is to filter out tenant scoped beans with minimal work effort. As soon as the spring configuration for web application is adjusted this context can be reverted to default one.

        Typical use case : 

         
 <servlet>
                <servlet-name>springmvc</servlet-name>
                <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
                <init-param>
                        <param-name>contextClass</param-name>
                        <param-value>de.hybris.platform.spring.ctx.TenantIgnoreXmlWebApplicationContext</param-value>
                </init-param>
                ...
        </servlet>

    • Method Detail

      • initBeanDefinitionReader

        protected void initBeanDefinitionReader​(org.springframework.beans.factory.xml.XmlBeanDefinitionReader beanDefinitionReader)
        Overrides:
        initBeanDefinitionReader in class org.springframework.web.context.support.XmlWebApplicationContext

      • getDisplayName

        public java.lang.String getDisplayName()
        Specified by:
        getDisplayName in interface org.springframework.context.ApplicationContext
        Overrides:
        getDisplayName in class org.springframework.context.support.AbstractApplicationContext