com.atlassian.confluence.plugin.descriptor
Class XWorkModuleDescriptor
java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor
com.atlassian.confluence.plugin.descriptor.XWorkModuleDescriptor
- All Implemented Interfaces:
- com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, com.opensymphony.xwork.config.ConfigurationProvider
public class XWorkModuleDescriptor
- extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor
- implements com.opensymphony.xwork.config.ConfigurationProvider
An XWork-WebWork plugin, which can provide actions and results to add to Confluence's web UI
layer. Actions will normally want to extend ConfluenceActionSupport
.
- See Also:
ConfluenceActionSupport
,
XWork
plugin documentation
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor |
key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton |
Constructor Summary |
XWorkModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
com.atlassian.event.EventManager eventManager)
|
Method Summary |
protected void |
addAction(org.dom4j.Element actionElement,
com.opensymphony.xwork.config.entities.PackageConfig packageContext)
|
protected void |
addResultTypes(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element element)
|
protected java.util.List |
buildExternalRefs(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
|
protected java.util.List |
buildInterceptorList(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
|
protected com.opensymphony.xwork.config.entities.PackageConfig |
buildPackageContext(org.dom4j.Element packageElement,
com.opensymphony.xwork.config.Configuration configuration)
|
protected java.util.Map |
buildResults(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig packageContext)
|
void |
destroy()
|
void |
disabled()
|
void |
enabled()
|
java.lang.Object |
getModule()
|
static java.util.HashMap |
getParams(org.dom4j.Element paramsElement)
|
void |
init(com.opensymphony.xwork.config.Configuration configuration)
|
void |
init(com.atlassian.plugin.Plugin plugin,
org.dom4j.Element element)
|
boolean |
isEnabled()
|
protected void |
loadDefaultInterceptorRef(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element element)
|
protected void |
loadGlobalResults(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element packageElement)
|
protected void |
loadInterceptors(com.opensymphony.xwork.config.entities.PackageConfig context,
org.dom4j.Element element)
|
protected com.opensymphony.xwork.config.entities.InterceptorStackConfig |
loadInterceptorStack(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
|
protected void |
loadInterceptorStacks(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
|
boolean |
needsReload()
|
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 |
XWorkModuleDescriptor
public XWorkModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
com.atlassian.event.EventManager eventManager)
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
- Overrides:
init
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
- 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
disabled
public void disabled()
- Specified by:
disabled
in interface com.atlassian.plugin.StateAware
- Overrides:
disabled
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
isEnabled
public boolean isEnabled()
loadInterceptors
protected void loadInterceptors(com.opensymphony.xwork.config.entities.PackageConfig context,
org.dom4j.Element element)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
loadDefaultInterceptorRef
protected void loadDefaultInterceptorRef(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element element)
loadGlobalResults
protected void loadGlobalResults(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element packageElement)
buildResults
protected java.util.Map buildResults(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig packageContext)
loadInterceptorStack
protected com.opensymphony.xwork.config.entities.InterceptorStackConfig loadInterceptorStack(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
loadInterceptorStacks
protected void loadInterceptorStacks(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
addAction
protected void addAction(org.dom4j.Element actionElement,
com.opensymphony.xwork.config.entities.PackageConfig packageContext)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
buildExternalRefs
protected java.util.List buildExternalRefs(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
addResultTypes
protected void addResultTypes(com.opensymphony.xwork.config.entities.PackageConfig packageContext,
org.dom4j.Element element)
getModule
public java.lang.Object getModule()
- Specified by:
getModule
in interface com.atlassian.plugin.ModuleDescriptor
- Specified by:
getModule
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
buildPackageContext
protected com.opensymphony.xwork.config.entities.PackageConfig buildPackageContext(org.dom4j.Element packageElement,
com.opensymphony.xwork.config.Configuration configuration)
buildInterceptorList
protected java.util.List buildInterceptorList(org.dom4j.Element element,
com.opensymphony.xwork.config.entities.PackageConfig context)
throws com.opensymphony.xwork.config.ConfigurationException
- Throws:
com.opensymphony.xwork.config.ConfigurationException
getParams
public static java.util.HashMap getParams(org.dom4j.Element paramsElement)
destroy
public void destroy()
- Specified by:
destroy
in interface com.atlassian.plugin.ModuleDescriptor
- Specified by:
destroy
in interface com.opensymphony.xwork.config.ConfigurationProvider
- Overrides:
destroy
in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
init
public void init(com.opensymphony.xwork.config.Configuration configuration)
throws com.opensymphony.xwork.config.ConfigurationException
- Specified by:
init
in interface com.opensymphony.xwork.config.ConfigurationProvider
- Throws:
com.opensymphony.xwork.config.ConfigurationException
needsReload
public boolean needsReload()
- Specified by:
needsReload
in interface com.opensymphony.xwork.config.ConfigurationProvider
Copyright © 2003-2014 Atlassian. All Rights Reserved.