SpringContextSingleton (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.SpringContextSingleton

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>
```
public class SpringContextSingleton
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>
```
Spring application context holder.

Author:

Sergiy Shyrkov

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Object`	`getBean(String beanId)` Returns an instance of the requested bean.
`static Object`	`getBeanInModulesContext(String beanId)`
`static <T> Map<String,T>`	`getBeansOfType(org.springframework.context.ApplicationContext applicationContext, Class<T> clazz)` Returns a map with beans of the specified type If applicationContext is root context, only look in this context Otherwise, lookup in all modules context.
`static <T> Map<String,T>`	`getBeansOfType(Class<T> type)` Returns a map with beans of the specified type, including beans in modules.
`org.springframework.context.ApplicationContext`	`getContext()` Returns the Spring application context instance.
`static SpringContextSingleton`	`getInstance()`
`org.springframework.core.io.Resource[]`	`getResources(String locationPatterns)` Searches for Spring resource locations given the specified (pattern-based) location.
`org.springframework.core.io.Resource[]`	`getResources(String locationPatterns, boolean useCache)` Searches for Spring resource locations given the specified (pattern-based) location.
`boolean`	`isInitialized()`
`void`	`onApplicationEvent(JahiaTemplateManagerService.TemplatePackageRedeployedEvent event)`
`void`	`publishEvent(org.springframework.context.ApplicationEvent event)` Publishes the specified event in the core Spring context and publishes to each module's context.
`void`	`publishEvent(org.springframework.context.ApplicationEvent event, boolean propagateToModules)` Publishes the specified event in the core Spring context and if `propagateToModules` is set to true, publishes that event to each module's context.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getBean
```
public static Object getBean(String beanId)
```
    Returns an instance of the requested bean.
    
    Parameters:
    
    beanId - the requested bean ID
    
    Returns:
    
    an instance of the requested bean
  - getBeanInModulesContext
```
public static Object getBeanInModulesContext(String beanId)
```
  - getBeansOfType
```
public static <T> Map<String,T> getBeansOfType(Class<T> type)
                                        throws org.springframework.beans.BeansException
```
    Returns a map with beans of the specified type, including beans in modules.
    
    Parameters:
    
    type - the bean type to search for
    
    Returns:
    
    a map with beans of the specified type, including beans in modules
    
    Throws:
    
    org.springframework.beans.BeansException - in case of a lookup error
  - getBeansOfType
```
public static <T> Map<String,T> getBeansOfType(org.springframework.context.ApplicationContext applicationContext,
                                               Class<T> clazz)
```
    Returns a map with beans of the specified type If applicationContext is root context, only look in this context Otherwise, lookup in all modules context.
    
    Parameters:
    
    applicationContext - the context to look for bean classes in
    
    clazz - the bean type to search for
    
    Returns:
    
    a map with beans of the specified type
    
    Throws:
    
    org.springframework.beans.BeansException - in case of a lookup error
  - getInstance
```
public static SpringContextSingleton getInstance()
```
  - getContext
```
public org.springframework.context.ApplicationContext getContext()
```
    Returns the Spring application context instance.
    
    Returns:
    
    the Spring application context instance
  - publishEvent
```
public void publishEvent(org.springframework.context.ApplicationEvent event)
```
    Publishes the specified event in the core Spring context and publishes to each module's context. When publishing the event to a module, the ApplicationEventMulticaster.multicastEvent(ApplicationEvent) method is used to skip publishing event to the module's parent context (which is our Spring core context).
    
    Parameters:
    
    event - the Spring event to be published
  - publishEvent
```
public void publishEvent(org.springframework.context.ApplicationEvent event,
                         boolean propagateToModules)
```
    Publishes the specified event in the core Spring context and if propagateToModules is set to true, publishes that event to each module's context. When publishing the event to a module, the ApplicationEventMulticaster.multicastEvent(ApplicationEvent) method is used to skip publishing event to the module's parent context (which is our Spring core context).
    
    Parameters:
    
    event - the Spring event to be published
    
    propagateToModules - whether to propagate the event to all modules
  - isInitialized
```
public boolean isInitialized()
```
  - onApplicationEvent
```
public void onApplicationEvent(JahiaTemplateManagerService.TemplatePackageRedeployedEvent event)
```
    Specified by:
    
    onApplicationEvent in interface org.springframework.context.ApplicationListener<JahiaTemplateManagerService.TemplatePackageRedeployedEvent>
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - getResources
```
public org.springframework.core.io.Resource[] getResources(String locationPatterns)
                                                    throws IOException
```
    Searches for Spring resource locations given the specified (pattern-based) location. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS ).
    
    Parameters:
    
    locationPatterns - (pattern-based) location to search for resources. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS )
    
    Returns:
    
    an array of Resource objects found
    
    Throws:
    
    IOException - in case of a lookup error
  - getResources
```
public org.springframework.core.io.Resource[] getResources(String locationPatterns,
                                                           boolean useCache)
                                                    throws IOException
```
    Searches for Spring resource locations given the specified (pattern-based) location. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS ).
    
    Parameters:
    
    locationPatterns - (pattern-based) location to search for resources. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS )
    
    useCache - can we use lookup caches?
    
    Returns:
    
    an array of Resource objects found
    
    Throws:
    
    IOException - in case of a lookup error

Class SpringContextSingleton

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getBean

getBeanInModulesContext

getBeansOfType

getBeansOfType

getInstance

getContext

publishEvent

publishEvent

isInitialized

onApplicationEvent

setApplicationContext

getResources

getResources