org.eclipse.gemini.blueprint.context.support

Class OsgiBundleXmlApplicationContext

java.lang.Object

org.springframework.core.io.DefaultResourceLoader

org.springframework.context.support.AbstractApplicationContext

org.springframework.context.support.AbstractRefreshableApplicationContext

org.eclipse.gemini.blueprint.context.support.AbstractOsgiBundleApplicationContext

org.eclipse.gemini.blueprint.context.support.AbstractDelegatedExecutionApplicationContext

org.eclipse.gemini.blueprint.context.support.OsgiBundleXmlApplicationContext

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ConfigurableOsgiBundleApplicationContext, DelegatedExecutionOsgiBundleApplicationContext, org.springframework.beans.factory.BeanFactory, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.HierarchicalBeanFactory, 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

public class OsgiBundleXmlApplicationContext
extends AbstractDelegatedExecutionApplicationContext

Stand-alone XML application context, backed by an OSGi bundle.

The configuration location defaults can be overridden via getDefaultConfigLocations(). Note that locations can either denote concrete files like /myfiles/context.xml or Ant-style patterns like /myfiles/*-context.xml (see the AntPathMatcher javadoc for pattern details).

Note: In case of multiple configuration locations, later bean definitions will override ones defined in earlier loaded files. This can be leveraged to deliberately override certain bean definitions via an extra XML file.

This is the main ApplicationContext class for OSGi environments.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONFIG_LOCATION Default config location for the root context(s)

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.eclipse.gemini.blueprint.context.ConfigurableOsgiBundleApplicationContext

APPLICATION_CONTEXT_SERVICE_PROPERTY_NAME, BUNDLE_BEAN_NAME, BUNDLE_CONTEXT_BEAN_NAME, SPRING_DM_APPLICATION_CONTEXT_SERVICE_PROPERTY_NAME

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.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

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

CLASSPATH_ALL_URL_PREFIX

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

CLASSPATH_URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
OsgiBundleXmlApplicationContext() Creates a new OsgiBundleXmlApplicationContext with no parent.
OsgiBundleXmlApplicationContext(org.springframework.context.ApplicationContext parent) Creates a new OsgiBundleXmlApplicationContext with the given parent context.
OsgiBundleXmlApplicationContext(java.lang.String[] configLocations) Creates a new OsgiBundleXmlApplicationContext with the given configLocations.
OsgiBundleXmlApplicationContext(java.lang.String[] configLocations, org.springframework.context.ApplicationContext parent) Creates a new OsgiBundleXmlApplicationContext with the given configLocations and parent context.

Method Summary

Modifier and Type	Method and Description
private org.xml.sax.EntityResolver	createEntityResolver(org.osgi.framework.BundleContext bundleContext, java.lang.String filter, java.lang.ClassLoader bundleClassLoader) Similar to #createNamespaceHandlerResolver(BundleContext, ClassLoader, ClassLoader) , this method creates a special OSGi entity resolver that considers the bundle class path first, falling back to the entity resolver service provided by the Spring DM extender.
private org.springframework.beans.factory.xml.NamespaceHandlerResolver	createNamespaceHandlerResolver(org.osgi.framework.BundleContext bundleContext, java.lang.String filter, java.lang.ClassLoader bundleClassLoader) Creates a special OSGi namespace handler resolver that first searches the bundle class path falling back to the namespace service published by Spring-DM.
private java.lang.String[]	expandLocations(java.lang.String[] configLocations) Expands any folder entries supplied as configuration location.
java.lang.String[]	getConfigLocations() Returns this application context configuration locations.
protected java.lang.String[]	getDefaultConfigLocations() Provide default locations for XML files.
protected void	initBeanDefinitionReader(org.springframework.beans.factory.xml.XmlBeanDefinitionReader beanDefinitionReader) Allows subclasses to do custom initialisation here.
protected void	loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory beanFactory) Loads the bean definitions via an XmlBeanDefinitionReader.
protected void	loadBeanDefinitions(org.springframework.beans.factory.xml.XmlBeanDefinitionReader reader) Loads the bean definitions with the given XmlBeanDefinitionReader.
private org.xml.sax.EntityResolver	lookupEntityResolver(org.osgi.framework.BundleContext bundleContext, java.lang.String filter, java.lang.Object fallbackObject)
private org.springframework.beans.factory.xml.NamespaceHandlerResolver	lookupNamespaceHandlerResolver(org.osgi.framework.BundleContext bundleContext, java.lang.String filter, java.lang.Object fallbackObject)

Methods inherited from class org.eclipse.gemini.blueprint.context.support.AbstractDelegatedExecutionApplicationContext

completeRefresh, doClose, getDelegatedEventMulticaster, invokeBeanFactoryPostProcessors, normalClose, normalRefresh, refresh, registerBeanPostProcessors, registerBeanPostProcessors, setContextClassLoaderProvider, setDelegatedEventMulticaster, setDelegatedEventMulticaster, setExecutor, startRefresh

Methods inherited from class org.eclipse.gemini.blueprint.context.support.AbstractOsgiBundleApplicationContext

createResourcePatternResolver, customizeApplicationContextServiceProperties, destroyBeans, finishRefresh, getBundle, getBundleContext, getClassLoader, getResource, getResourceByPath, getResourcePatternResolver, getResources, postProcessBeanFactory, prepareRefresh, setBundleContext, setClassLoader, setConfigLocations, setPublishContextAsService

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

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

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

addApplicationListener, addBeanFactoryPostProcessor, addListener, close, containsBean, containsBeanDefinition, containsLocalBean, createEnvironment, destroy, findAnnotationOnBean, finishBeanFactoryInitialization, getAliases, getApplicationListeners, getApplicationName, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getEnvironment, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, initPropertySources, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, prepareBeanFactory, publishEvent, registerListeners, registerShutdownHook, setDisplayName, setEnvironment, setId, setParent, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gemini.blueprint.context.ConfigurableOsgiBundleApplicationContext

getBundle, getBundleContext, setBundleContext, setConfigLocations, setPublishContextAsService

Methods inherited from interface org.springframework.context.ConfigurableApplicationContext

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

Methods inherited from interface org.springframework.context.ApplicationContext

getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

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

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

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

containsLocalBean, getParentBeanFactory

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

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

Methods inherited from interface org.springframework.context.MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface org.springframework.context.ApplicationEventPublisher

publishEvent

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

getResources

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

getClassLoader, getResource

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Field Detail

DEFAULT_CONFIG_LOCATION

public static final java.lang.String DEFAULT_CONFIG_LOCATION

Default config location for the root context(s)

See Also:

Constant Field Values

Constructor Detail

OsgiBundleXmlApplicationContext

public OsgiBundleXmlApplicationContext()

Creates a new OsgiBundleXmlApplicationContext with no parent.

OsgiBundleXmlApplicationContext

public OsgiBundleXmlApplicationContext(org.springframework.context.ApplicationContext parent)

Creates a new OsgiBundleXmlApplicationContext with the given parent context.

Parameters:

parent - the parent context

OsgiBundleXmlApplicationContext

public OsgiBundleXmlApplicationContext(java.lang.String[] configLocations)

Creates a new OsgiBundleXmlApplicationContext with the given configLocations.

Parameters:

configLocations - array of configuration resources

OsgiBundleXmlApplicationContext

public OsgiBundleXmlApplicationContext(java.lang.String[] configLocations,
                                       org.springframework.context.ApplicationContext parent)

Creates a new OsgiBundleXmlApplicationContext with the given configLocations and parent context.

Parameters:

configLocations - array of configuration resources

parent - the parent context

Method Detail

loadBeanDefinitions

protected void loadBeanDefinitions(org.springframework.beans.factory.support.DefaultListableBeanFactory beanFactory)
                            throws java.io.IOException

Loads the bean definitions via an XmlBeanDefinitionReader.

Overrides:

loadBeanDefinitions in class AbstractDelegatedExecutionApplicationContext

Throws:

java.io.IOException

initBeanDefinitionReader

protected void initBeanDefinitionReader(org.springframework.beans.factory.xml.XmlBeanDefinitionReader beanDefinitionReader)

Allows subclasses to do custom initialisation here.

Parameters:

beanDefinitionReader -

loadBeanDefinitions

protected void loadBeanDefinitions(org.springframework.beans.factory.xml.XmlBeanDefinitionReader reader)
                            throws org.springframework.beans.BeansException,
                                   java.io.IOException

Loads the bean definitions with the given XmlBeanDefinitionReader.

The lifecycle of the bean factory is handled by the refreshBeanFactory method; therefore this method is just supposed to load and/or register bean definitions.

Delegates to a ResourcePatternResolver for resolving location patterns into Resource instances.

Throws:

org.springframework.beans.BeansException - in case of bean registration errors

java.io.IOException - if the required XML document isn't found

See Also:

AbstractRefreshableApplicationContext.refreshBeanFactory(), getConfigLocations(), AbstractOsgiBundleApplicationContext.getResources(java.lang.String), AbstractOsgiBundleApplicationContext.getResourcePatternResolver()

expandLocations

private java.lang.String[] expandLocations(java.lang.String[] configLocations)

Expands any folder entries supplied as configuration location. I.e. config/ becomes config/*.xml.

Parameters:

configLocations -

Returns:

getDefaultConfigLocations

protected java.lang.String[] getDefaultConfigLocations()

Provide default locations for XML files. This implementation returns META-INF/spring/*.xml relying on the default resource environment for actual localisation. By default, the bundle space will be used for locating the resources.

Note: Instead of overriding this method, consider using the Spring-DM specific header inside your manifest bundle.

Overrides:

getDefaultConfigLocations in class AbstractOsgiBundleApplicationContext

Returns:

default XML configuration locations

See Also:

AbstractOsgiBundleApplicationContext.setConfigLocations(java.lang.String[])

createNamespaceHandlerResolver

private org.springframework.beans.factory.xml.NamespaceHandlerResolver createNamespaceHandlerResolver(org.osgi.framework.BundleContext bundleContext,
                                                                                                      java.lang.String filter,
                                                                                                      java.lang.ClassLoader bundleClassLoader)

Creates a special OSGi namespace handler resolver that first searches the bundle class path falling back to the namespace service published by Spring-DM. This allows embedded libraries that provide namespace handlers take priority over namespace provided by other bundles.

Parameters:

bundleContext - the OSGi context of which the resolver should be aware of

filter - OSGi service filter

bundleClassLoader - classloader for creating the OSGi namespace resolver proxy

Returns:

a OSGi aware namespace handler resolver

createEntityResolver

private org.xml.sax.EntityResolver createEntityResolver(org.osgi.framework.BundleContext bundleContext,
                                                        java.lang.String filter,
                                                        java.lang.ClassLoader bundleClassLoader)

Similar to #createNamespaceHandlerResolver(BundleContext, ClassLoader, ClassLoader) , this method creates a special OSGi entity resolver that considers the bundle class path first, falling back to the entity resolver service provided by the Spring DM extender.

Parameters:

bundleContext - the OSGi context of which the resolver should be aware of

filter - OSGi service filter

bundleClassLoader - classloader for creating the OSGi namespace resolver proxy

Returns:

a OSGi aware entity resolver

lookupNamespaceHandlerResolver

private org.springframework.beans.factory.xml.NamespaceHandlerResolver lookupNamespaceHandlerResolver(org.osgi.framework.BundleContext bundleContext,
                                                                                                      java.lang.String filter,
                                                                                                      java.lang.Object fallbackObject)

lookupEntityResolver

private org.xml.sax.EntityResolver lookupEntityResolver(org.osgi.framework.BundleContext bundleContext,
                                                        java.lang.String filter,
                                                        java.lang.Object fallbackObject)

getConfigLocations

public java.lang.String[] getConfigLocations()

Description copied from class: AbstractOsgiBundleApplicationContext

Returns this application context configuration locations. The default implementation will check whether there are any locations configured and, if not, will return the default locations.

Overrides:

getConfigLocations in class AbstractOsgiBundleApplicationContext

Returns:

application context configuration locations.

See Also:

AbstractOsgiBundleApplicationContext.getDefaultConfigLocations()