com.atlassian.bamboo.plugin.descriptor
Class SpringComponentModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<java.lang.Object>
          extended by com.atlassian.bamboo.plugin.descriptor.SpringComponentModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<java.lang.Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, org.springframework.beans.factory.BeanFactoryAware

public class SpringComponentModuleDescriptor
extends AbstractBambooModuleDescriptor<java.lang.Object>
implements org.springframework.beans.factory.BeanFactoryAware

This module descriptor is responsible for injecting plugins1 components into the host Bamboo container.

Plugins2 components live in OSGi and are handled by the com.atlassian.plugin.osgi.factory.descriptor.ComponentModuleDescriptor in the plugins framework.


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton
 
Constructor Summary
SpringComponentModuleDescriptor()
           
SpringComponentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
           
 
Method Summary
 void enabled()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
protected  boolean isMutable()
           Whether modules of this descriptor are supposed to be mutated by external components.
 void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
           
 
Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor
disabled, getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, postInit, preInit
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpringComponentModuleDescriptor

public SpringComponentModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

SpringComponentModuleDescriptor

public SpringComponentModuleDescriptor()
Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException
Specified by:
init in interface com.atlassian.plugin.ModuleDescriptor<java.lang.Object>
Overrides:
init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>
Throws:
com.atlassian.plugin.PluginParseException

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

isMutable

protected boolean isMutable()
Description copied from class: AbstractBambooModuleDescriptor

Whether modules of this descriptor are supposed to be mutated by external components. By default this returns true, which means a fresh module instance will be created each time AbstractBambooModuleDescriptor.getModule() is called.

Subclasses that are safe to cache a singleton instance of module throughout the life span of this descriptor can override this method and return false.

Overrides:
isMutable in class AbstractBambooModuleDescriptor<java.lang.Object>
Returns:
true if modules of this descriptor are mutable

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException
Specified by:
setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware
Throws:
org.springframework.beans.BeansException


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.