com.atlassian.crowd.plugin.descriptors

Class XWorkModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

com.atlassian.crowd.plugin.descriptors.XWorkModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, com.opensymphony.xwork2.config.ConfigurationProvider, com.opensymphony.xwork2.config.ContainerProvider, com.opensymphony.xwork2.config.PackageProvider

public class XWorkModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>
implements com.atlassian.plugin.StateAware, com.opensymphony.xwork2.config.ConfigurationProvider

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
XWorkModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAction(org.dom4j.Element actionElement, com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext)
protected static void	addResultTypes(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext, org.dom4j.Element element)
protected List<com.opensymphony.xwork2.config.entities.InterceptorMapping>	buildInterceptorList(org.dom4j.Element element, com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
protected com.opensymphony.xwork2.config.entities.PackageConfig.Builder	buildPackageContext(org.dom4j.Element packageElement, com.opensymphony.xwork2.config.Configuration configuration)
protected Map<String,com.opensymphony.xwork2.config.entities.ResultConfig>	buildResults(org.dom4j.Element element, com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext)
void	destroy()
void	disabled()
void	enabled()
Void	getModule()
static Map<String,String>	getParams(org.dom4j.Element paramsElement)
void	init(com.opensymphony.xwork2.config.Configuration configuration)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isEnabled()
protected void	loadDefaultInterceptorRef(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext, org.dom4j.Element element)
protected void	loadGlobalResults(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext, org.dom4j.Element packageElement)
protected void	loadInterceptors(com.opensymphony.xwork2.config.entities.PackageConfig.Builder context, org.dom4j.Element element)
protected com.opensymphony.xwork2.config.entities.InterceptorStackConfig	loadInterceptorStack(org.dom4j.Element element, com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
protected void	loadInterceptorStacks(org.dom4j.Element element, com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
void	loadPackages()
boolean	needsReload()
void	register(com.opensymphony.xwork2.inject.ContainerBuilder builder, com.opensymphony.xwork2.util.location.LocatableProperties props)
void	setConfigurationManager(com.opensymphony.xwork2.config.ConfigurationManager configurationManager)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, 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

XWorkModuleDescriptor

public XWorkModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                     com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

setConfigurationManager

public void setConfigurationManager(com.opensymphony.xwork2.config.ConfigurationManager configurationManager)

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<Void>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

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<Void>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

isEnabled

public boolean isEnabled()

loadInterceptors

protected void loadInterceptors(com.opensymphony.xwork2.config.entities.PackageConfig.Builder context,
                    org.dom4j.Element element)
                         throws com.opensymphony.xwork2.config.ConfigurationException

Throws:

com.opensymphony.xwork2.config.ConfigurationException

loadDefaultInterceptorRef

protected void loadDefaultInterceptorRef(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext,
                             org.dom4j.Element element)

loadGlobalResults

protected void loadGlobalResults(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext,
                     org.dom4j.Element packageElement)
                          throws ClassNotFoundException

Throws:

ClassNotFoundException

buildResults

protected Map<String,com.opensymphony.xwork2.config.entities.ResultConfig> buildResults(org.dom4j.Element element,
                                                                            com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext)
                                                                                 throws ClassNotFoundException

Throws:

ClassNotFoundException

loadInterceptorStack

protected com.opensymphony.xwork2.config.entities.InterceptorStackConfig loadInterceptorStack(org.dom4j.Element element,
                                                                                  com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
                                                                                       throws com.opensymphony.xwork2.config.ConfigurationException

Throws:

com.opensymphony.xwork2.config.ConfigurationException

loadInterceptorStacks

protected void loadInterceptorStacks(org.dom4j.Element element,
                         com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
                              throws com.opensymphony.xwork2.config.ConfigurationException

Throws:

com.opensymphony.xwork2.config.ConfigurationException

addAction

protected void addAction(org.dom4j.Element actionElement,
             com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext)
                  throws com.opensymphony.xwork2.config.ConfigurationException,
                         ClassNotFoundException

Throws:

com.opensymphony.xwork2.config.ConfigurationException

ClassNotFoundException

addResultTypes

protected static void addResultTypes(com.opensymphony.xwork2.config.entities.PackageConfig.Builder packageContext,
                  org.dom4j.Element element)

getModule

public Void getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

buildPackageContext

protected com.opensymphony.xwork2.config.entities.PackageConfig.Builder buildPackageContext(org.dom4j.Element packageElement,
                                                                                com.opensymphony.xwork2.config.Configuration configuration)

buildInterceptorList

protected List<com.opensymphony.xwork2.config.entities.InterceptorMapping> buildInterceptorList(org.dom4j.Element element,
                                                                                    com.opensymphony.xwork2.config.entities.PackageConfig.Builder context)
                                                                                         throws com.opensymphony.xwork2.config.ConfigurationException

Throws:

com.opensymphony.xwork2.config.ConfigurationException

getParams

public static Map<String,String> getParams(org.dom4j.Element paramsElement)

destroy

public void destroy()

Specified by:

destroy in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

destroy in interface com.opensymphony.xwork2.config.ContainerProvider

Overrides:

destroy in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

init

public void init(com.opensymphony.xwork2.config.Configuration configuration)
          throws com.opensymphony.xwork2.config.ConfigurationException

Specified by:

init in interface com.opensymphony.xwork2.config.ContainerProvider

Specified by:

init in interface com.opensymphony.xwork2.config.PackageProvider

Throws:

com.opensymphony.xwork2.config.ConfigurationException

needsReload

public boolean needsReload()

Specified by:

needsReload in interface com.opensymphony.xwork2.config.ContainerProvider

Specified by:

needsReload in interface com.opensymphony.xwork2.config.PackageProvider

loadPackages

public void loadPackages()
                  throws com.opensymphony.xwork2.config.ConfigurationException

Specified by:

loadPackages in interface com.opensymphony.xwork2.config.PackageProvider

Throws:

com.opensymphony.xwork2.config.ConfigurationException

register

public void register(com.opensymphony.xwork2.inject.ContainerBuilder builder,
            com.opensymphony.xwork2.util.location.LocatableProperties props)
              throws com.opensymphony.xwork2.config.ConfigurationException

Specified by:

register in interface com.opensymphony.xwork2.config.ContainerProvider

Throws:

com.opensymphony.xwork2.config.ConfigurationException