Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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:
  ConfigurableOsgiBundleApplicationContext, DelegatedExecutionOsgiBundleApplicationContext, BeanFactory, DisposableBean, HierarchicalBeanFactory, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, ConfigurableApplicationContext, Lifecycle, MessageSource, ResourceLoader, 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.

Author:
  Adrian Colyer, Costin Leau, Andy Piper, Hal Hildebrand

Field Summary
`static 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`

Fields inherited from interface org.springframework.context.ConfigurableApplicationContext
`CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_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.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
`OsgiBundleXmlApplicationContext()` Creates a new `OsgiBundleXmlApplicationContext` with no parent.
`OsgiBundleXmlApplicationContext(ApplicationContext parent)` Creates a new `OsgiBundleXmlApplicationContext` with the given parent context.
`OsgiBundleXmlApplicationContext(String[] configLocations)` Creates a new `OsgiBundleXmlApplicationContext` with the given configLocations.
`OsgiBundleXmlApplicationContext(String[] configLocations, ApplicationContext parent)` Creates a new `OsgiBundleXmlApplicationContext` with the given configLocations and parent context.

Method Summary
`String[]` | `getConfigLocations()` Returns this application context configuration locations.
`protected String[]` | `getDefaultConfigLocations()` Provide default locations for XML files.
`protected void` | `initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader)` Allows subclasses to do custom initialisation here.
`protected void` | `loadBeanDefinitions(DefaultListableBeanFactory beanFactory)` Loads the bean definitions via an `XmlBeanDefinitionReader`.
`protected void` | `loadBeanDefinitions(XmlBeanDefinitionReader reader)` Loads the bean definitions with the given `XmlBeanDefinitionReader`.

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, destroy, findAnnotationOnBean, finishBeanFactoryInitialization, getAliases, getApplicationListeners, getAutowireCapableBeanFactory, getBean, getBean, getBean, getBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanFactoryPostProcessors, getBeanNamesForType, getBeanNamesForType, getBeansOfType, getBeansOfType, getBeansWithAnnotation, getDisplayName, getId, getInternalParentBeanFactory, getInternalParentMessageSource, getMessage, getMessage, getMessage, getParent, getParentBeanFactory, getStartupDate, getType, initApplicationEventMulticaster, initLifecycleProcessor, initMessageSource, isActive, isPrototype, isRunning, isSingleton, isTypeMatch, obtainFreshBeanFactory, onClose, onRefresh, prepareBeanFactory, publishEvent, registerListeners, registerShutdownHook, setDisplayName, 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, isActive, registerShutdownHook, setId, setParent`

Methods inherited from interface org.springframework.context.ApplicationContext
`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.BeanFactory
`containsBean, getAliases, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch`

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 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(ApplicationContext parent)

  Creates a new `OsgiBundleXmlApplicationContext` with the given parent context.

  Parameters:
    `parent` - the parent context

### OsgiBundleXmlApplicationContext

    public OsgiBundleXmlApplicationContext(String[] configLocations)

  Creates a new `OsgiBundleXmlApplicationContext` with the given configLocations.

  Parameters:
    `configLocations` - array of configuration resources

### OsgiBundleXmlApplicationContext

    public OsgiBundleXmlApplicationContext(String[] configLocations,
                                           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(DefaultListableBeanFactory beanFactory)
                                throws IOException

  Loads the bean definitions via an `XmlBeanDefinitionReader`.

  Overrides:
    `loadBeanDefinitions` in class `AbstractDelegatedExecutionApplicationContext`
  Throws:
    `IOException`

### initBeanDefinitionReader

    protected void initBeanDefinitionReader(XmlBeanDefinitionReader beanDefinitionReader)

  Allows subclasses to do custom initialisation here.

  Parameters:
    `beanDefinitionReader` -

### loadBeanDefinitions

    protected void loadBeanDefinitions(XmlBeanDefinitionReader reader)
                                throws BeansException,
                                       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:
    `BeansException` - in case of bean registration errors
    `IOException` - if the required XML document isn't found
  See Also:
    `AbstractRefreshableApplicationContext.refreshBeanFactory()`, `getConfigLocations()`, `AbstractOsgiBundleApplicationContext.getResources(java.lang.String)`, `AbstractOsgiBundleApplicationContext.getResourcePatternResolver()`

### getDefaultConfigLocations

    protected 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[])`

### getConfigLocations

    public 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()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006-2010 Spring Framework. All Rights Reserved.