com.atlassian.jira.plugin.webwork
Class WebworkModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<Void>
          extended by com.atlassian.jira.plugin.webwork.WebworkModuleDescriptor
All Implemented Interfaces:
JiraResourcedModuleDescriptor<Void>, com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, webwork.config.ConfigurationInterface

public class WebworkModuleDescriptor
extends AbstractJiraModuleDescriptor<Void>
implements webwork.config.ConfigurationInterface

This module descriptor allows for plugins to include webwork actions inside plugins. The XML looks something like this:

  <webwork key="webwork-test" name="Test webwork plugin" >
      <actions>
          <action name="PluginActionClassName" alias="PluginAction">
              <view name="success">/views/administrators.vm</view>
          </action>
      </actions>
  </webwork>
 


Field Summary
static org.apache.log4j.Logger log
           
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton
 
Constructor Summary
WebworkModuleDescriptor(JiraAuthenticationContext authenticationContext, AutowireCapableWebworkActionRegistry autowireCapabaleWebworkActionRegistry, com.atlassian.plugin.module.ModuleFactory moduleFactory)
           
 
Method Summary
 void disabled()
           
 void enabled()
           
 Object getImpl(String aName)
           
 Void getModule()
           
 electric.xml.Document getWebworkDocument()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 Iterator listImpl()
           
 void setImpl(String aName, Object aValue)
           
 
Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getName, getText, getText, isResourceExist, writeHtml
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, 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
 
Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion
 
Methods inherited from interface com.atlassian.plugin.Resourced
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation
 

Field Detail

log

public static final org.apache.log4j.Logger log
Constructor Detail

WebworkModuleDescriptor

public WebworkModuleDescriptor(JiraAuthenticationContext authenticationContext,
                               AutowireCapableWebworkActionRegistry autowireCapabaleWebworkActionRegistry,
                               com.atlassian.plugin.module.ModuleFactory moduleFactory)
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<Void>
Overrides:
init in class AbstractJiraModuleDescriptor<Void>
Throws:
com.atlassian.plugin.PluginParseException

disabled

public void disabled()
Specified by:
disabled in interface com.atlassian.plugin.StateAware
Overrides:
disabled in class AbstractJiraModuleDescriptor<Void>

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class AbstractJiraModuleDescriptor<Void>

getModule

public Void getModule()
Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>
Overrides:
getModule in class AbstractJiraModuleDescriptor<Void>

getImpl

public Object getImpl(String aName)
               throws IllegalArgumentException
Specified by:
getImpl in interface webwork.config.ConfigurationInterface
Throws:
IllegalArgumentException

setImpl

public void setImpl(String aName,
                    Object aValue)
             throws IllegalArgumentException,
                    UnsupportedOperationException
Specified by:
setImpl in interface webwork.config.ConfigurationInterface
Throws:
IllegalArgumentException
UnsupportedOperationException

listImpl

public Iterator listImpl()
Specified by:
listImpl in interface webwork.config.ConfigurationInterface

getWebworkDocument

public electric.xml.Document getWebworkDocument()


Copyright © 2002-2013 Atlassian. All Rights Reserved.