BundleFactoryBean

java.lang.Object
- org.eclipse.gemini.blueprint.bundle.BundleFactoryBean

All Implemented Interfaces:

BundleContextAware, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<org.osgi.framework.Bundle>, org.springframework.beans.factory.InitializingBean, org.springframework.context.ResourceLoaderAware
```
public class BundleFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<org.osgi.framework.Bundle>, BundleContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.context.ResourceLoaderAware
```
Bundle installer.
This FactoryBean allows customers to use Spring to drive bundle management. Bundles states can be modified using the action (defaults to start) and destroyAction (not set by default) parameters.
For example, to automatically install and start a bundle from the local maven repository (assuming the bundle has been already retrieved), one can use the following configuration:
```
 <osgi:bundle id="aBundle" symbolic-name="org.company.bundles.a"
 location="file:${localRepository }/org/company/bundles/a/${pom.version}/a-${pom.version}.jar"
 action="start"/> 
```
Note: Pay attention when installing bundles dynamically since classes can be loaded aggressively.
See Also:

BundleAction

Field Summary

Fields
Modifier and Type	Field and Description
`private BundleActionEnum`	`action`
`private org.osgi.framework.Bundle`	`bundle` Actual bundle
`private org.osgi.framework.BundleContext`	`bundleContext`
`private java.lang.ClassLoader`	`classLoader`
`private BundleActionEnum`	`destroyAction`
`private java.lang.String`	`location` Bundle location
`private static org.apache.commons.logging.Log`	`log`
`private boolean`	`pushBundleAsContextClassLoader` unused at the moment
`private org.springframework.core.io.Resource`	`resource`
`private org.springframework.core.io.ResourceLoader`	`resourceLoader`
`private int`	`startLevel`
`private java.lang.String`	`symbolicName` Bundle symName

Constructor Summary

Constructors
Constructor and Description

BundleFactoryBean()

Constructors
Constructor and Description
`BundleFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`destroy()`
`protected void`	`executeAction(BundleActionEnum action)`
`private org.osgi.framework.Bundle`	`findBundle()` Find a bundle based on the configuration (don't apply any actions for it).
`BundleAction`	`getAction()` Deprecated. As of Spring DM 2.0, replaced by `getBundleAction()`
`org.osgi.framework.Bundle`	`getBundle()` Returns the bundle with which the class interacts.
`BundleActionEnum`	`getBundleAction()` Returns the bundle action.
`BundleActionEnum`	`getBundleDestroyAction()` Returns the bundle destroy action.
`BundleAction`	`getDestroyAction()` Deprecated. As of Spring DM 2.0, replaced by `getBundleDestroyAction()`
`java.lang.String`	`getLocation()` Return the given location.
`org.osgi.framework.Bundle`	`getObject()`
`java.lang.Class<? extends org.osgi.framework.Bundle>`	`getObjectType()`
`org.springframework.core.io.Resource`	`getResource()` Return the `Resource` object (if a `ResourceLoader` is available) from the given location (if any).
`int`	`getStartLevel()` Gets the bundle start level.
`java.lang.String`	`getSymbolicName()` Return the given bundle symbolic name.
`private org.osgi.framework.Bundle`	`installBundle()` Install bundle - the equivalent of install action.
`boolean`	`isSingleton()`
`void`	`setAction(BundleAction action)` Deprecated. As of Spring DM 2.0, replaced by `#setBundleAction(BundleAction)`
`void`	`setBundle(org.osgi.framework.Bundle bundle)` Set the backing bundle used by this class.
`void`	`setBundleAction(BundleActionEnum action)` Action to execute at startup.
`void`	`setBundleContext(org.osgi.framework.BundleContext context)` Set the `BundleContext` that this bean runs in.
`void`	`setBundleDestroyAction(BundleActionEnum action)` Action to execute at shutdown.
`void`	`setClassLoader(java.lang.ClassLoader classloader)`
`void`	`setDestroyAction(BundleAction action)` Deprecated. As of Spring DM 2.0, replaced by `setBundleDestroyAction(BundleActionEnum)`
`void`	`setLocation(java.lang.String url)` Set the bundle location (optional operation).
`void`	`setPushBundleAsContextClassLoader(boolean pushBundleAsContextClassLoader)` Determines whether invocations on the remote service should be performed in the context (thread context class loader) of the target bundle's ClassLoader.
`void`	`setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)`
`void`	`setStartLevel(int startLevel)` Sets the bundle start level.
`void`	`setSymbolicName(java.lang.String symbolicName)` Set the bundle symbolic name (optional operation).
`private void`	`updateStartLevel(int level)`

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

- Field Detail
  - log
```
private static org.apache.commons.logging.Log log
```
  - location
```
private java.lang.String location
```
    Bundle location
  - resource
```
private org.springframework.core.io.Resource resource
```
  - resourceLoader
```
private org.springframework.core.io.ResourceLoader resourceLoader
```
  - symbolicName
```
private java.lang.String symbolicName
```
    Bundle symName
  - bundle
```
private org.osgi.framework.Bundle bundle
```
    Actual bundle
  - bundleContext
```
private org.osgi.framework.BundleContext bundleContext
```
  - action
```
private BundleActionEnum action
```
  - destroyAction
```
private BundleActionEnum destroyAction
```
  - startLevel
```
private int startLevel
```
  - classLoader
```
private java.lang.ClassLoader classLoader
```
  - pushBundleAsContextClassLoader
```
private boolean pushBundleAsContextClassLoader
```
    unused at the moment
- Constructor Detail
  - BundleFactoryBean
```
public BundleFactoryBean()
```
- Method Detail
  - getObjectType
```
public java.lang.Class<? extends org.osgi.framework.Bundle> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.Bundle>
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.Bundle>
  - getObject
```
public org.osgi.framework.Bundle getObject()
                                    throws java.lang.Exception
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<org.osgi.framework.Bundle>
    
    Throws:
    
    java.lang.Exception
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    java.lang.Exception
  - destroy
```
public void destroy()
             throws java.lang.Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    java.lang.Exception
  - executeAction
```
protected void executeAction(BundleActionEnum action)
```
  - installBundle
```
private org.osgi.framework.Bundle installBundle()
                                         throws org.osgi.framework.BundleException
```
    Install bundle - the equivalent of install action.
    
    Returns:
    
    Throws:
    
    org.osgi.framework.BundleException
  - findBundle
```
private org.osgi.framework.Bundle findBundle()
```
    Find a bundle based on the configuration (don't apply any actions for it).
    
    Returns:
    
    a Bundle instance based on the configuration.
  - getResource
```
public org.springframework.core.io.Resource getResource()
```
    Return the Resource object (if a ResourceLoader is available) from the given location (if any).
    
    Returns:
    
    Resource object for the given location
  - getLocation
```
public java.lang.String getLocation()
```
    Return the given location.
    
    Returns:
    
    bundle location
  - setLocation
```
public void setLocation(java.lang.String url)
```
    Set the bundle location (optional operation).
    
    Parameters:
    
    url - bundle location (normally an URL or a Spring Resource)
  - getSymbolicName
```
public java.lang.String getSymbolicName()
```
    Return the given bundle symbolic name.
    
    Returns:
    
    bundle symbolic name
  - setSymbolicName
```
public void setSymbolicName(java.lang.String symbolicName)
```
    Set the bundle symbolic name (optional operation).
    
    Parameters:
    
    symbolicName - bundle symbolic name
  - setBundleContext
```
public void setBundleContext(org.osgi.framework.BundleContext context)
```
    Description copied from interface: BundleContextAware
    
    Set the BundleContext that this bean runs in. Normally this can be used to initialize an object.
    
    Specified by:
    
    setBundleContext in interface BundleContextAware
    
    Parameters:
    
    context - the BundleContext object to be used by this object
  - getAction
```
public BundleAction getAction()
```
    Deprecated. As of Spring DM 2.0, replaced by getBundleAction()
    
    Returns the action.
    
    Returns:
    
    Returns the action
  - getBundleAction
```
public BundleActionEnum getBundleAction()
```
    Returns the bundle action.
    
    Returns:
    
    the bundle action.
  - setAction
```
public void setAction(BundleAction action)
```
    Deprecated. As of Spring DM 2.0, replaced by #setBundleAction(BundleAction)
    
    Action to execute at startup.
    
    Parameters:
    
    action - action to execute at startup
  - setBundleAction
```
public void setBundleAction(BundleActionEnum action)
```
    Action to execute at startup.
    
    Parameters:
    
    action - action to execute at startup
  - getDestroyAction
```
public BundleAction getDestroyAction()
```
    Deprecated. As of Spring DM 2.0, replaced by getBundleDestroyAction()
    
    Returns the destroyAction.
    
    Returns:
    
    Returns the destroyAction
  - getBundleDestroyAction
```
public BundleActionEnum getBundleDestroyAction()
```
    Returns the bundle destroy action.
    
    Returns:
  - setDestroyAction
```
public void setDestroyAction(BundleAction action)
```
    Deprecated. As of Spring DM 2.0, replaced by setBundleDestroyAction(BundleActionEnum)
    
    Action to execute at shutdown.
    
    Parameters:
    
    action - action to execute at shutdown
  - setBundleDestroyAction
```
public void setBundleDestroyAction(BundleActionEnum action)
```
    Action to execute at shutdown.
    
    Parameters:
    
    action - action to execute at shutdown
  - getStartLevel
```
public int getStartLevel()
```
    Gets the bundle start level.
    
    Returns:
    
    bundle start level
  - setStartLevel
```
public void setStartLevel(int startLevel)
```
    Sets the bundle start level.
    
    Parameters:
    
    startLevel - bundle start level.
  - setPushBundleAsContextClassLoader
```
public void setPushBundleAsContextClassLoader(boolean pushBundleAsContextClassLoader)
```
    Determines whether invocations on the remote service should be performed in the context (thread context class loader) of the target bundle's ClassLoader. The default is false.
    
    Parameters:
    
    pushBundleAsContextClassLoader - true if the thread context class loader will be set to the target bundle or false otherwise
  - setClassLoader
```
public void setClassLoader(java.lang.ClassLoader classloader)
```
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface org.springframework.context.ResourceLoaderAware
  - updateStartLevel
```
private void updateStartLevel(int level)
```
  - getBundle
```
public org.osgi.framework.Bundle getBundle()
```
    Returns the bundle with which the class interacts.
    
    Returns:
    
    Returns this factory backing bundle
  - setBundle
```
public void setBundle(org.osgi.framework.Bundle bundle)
```
    Set the backing bundle used by this class. Allows programmatic configuration of already retrieved/created bundle.
    
    Parameters:
    
    bundle - The bundle to set

Class BundleFactoryBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

location

resource

resourceLoader

symbolicName

bundle

bundleContext

action

destroyAction

startLevel

classLoader

pushBundleAsContextClassLoader

Constructor Detail

BundleFactoryBean

Method Detail

getObjectType

isSingleton

getObject

afterPropertiesSet

destroy

executeAction

installBundle

findBundle

getResource

getLocation

setLocation

getSymbolicName

setSymbolicName

setBundleContext

getAction

getBundleAction

setAction

setBundleAction

getDestroyAction

getBundleDestroyAction

setDestroyAction

setBundleDestroyAction

getStartLevel

setStartLevel

setPushBundleAsContextClassLoader

setClassLoader

setResourceLoader

updateStartLevel

getBundle

setBundle