com.atlassian.jira.plugin
Class JiraResourcedModuleDescriptor

java.lang.Object
  extended bycom.atlassian.plugin.descriptors.AbstractModuleDescriptor
      extended bycom.atlassian.jira.plugin.JiraResourcedModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced
Direct Known Subclasses:
AbstractWorkflowModuleDescriptor, ConfigurableModuleDescriptor, CustomFieldSearcherModuleDescriptor, CustomFieldTypeModuleDescriptor, IssueOperationModuleDescriptor, IssueTabPanelModuleDescriptor, JiraRendererModuleDescriptor, MacroModuleDescriptor, ProjectTabPanelModuleDescriptor, WebworkModuleDescriptor

public abstract class JiraResourcedModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor


Field Summary
static String RESOURCE_TYPE_I18N
           
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
plugin, singleton
 
Constructor Summary
protected JiraResourcedModuleDescriptor(JiraAuthenticationContext authenticationContext)
           
 
Method Summary
protected  void assertResourceExists(String type, String name)
           
protected  Map createVelocityParams(Map startingParams)
           
protected  JiraAuthenticationContext getAuthenticationContext()
           
static Map getDefaultVelocityParams(Map startingParams, JiraAuthenticationContext authenticationContext)
           
 String getDescription()
           
 String getHtml(String resourceName)
           
 String getHtml(String resourceName, Map startingParams)
           
static javax.servlet.http.HttpServletRequest getHttpRequest()
          Return the HttpRequest, but overriding the getRequestURI() method to call back to webwork if needed.
 I18nBean getI18nBean()
           
protected  List getI18nLocations()
           
 String getName()
           
 String getText(String key)
          Deprecated. Please use i18nBean.getText() instead
 String getText(String key, Object params)
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
protected  boolean isResourceExist(String resourceName)
           
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, getCompleteKey, getKey, getMinJavaVersion, getModule, getModuleClass, getParams, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, satisfiesMinJavaVersion, setPlugin
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE_TYPE_I18N

public static final String RESOURCE_TYPE_I18N
See Also:
Constant Field Values
Constructor Detail

JiraResourcedModuleDescriptor

protected JiraResourcedModuleDescriptor(JiraAuthenticationContext authenticationContext)
Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException
Throws:
com.atlassian.plugin.PluginParseException

assertResourceExists

protected void assertResourceExists(String type,
                                    String name)
                             throws com.atlassian.plugin.PluginParseException
Throws:
com.atlassian.plugin.PluginParseException

getHtml

public String getHtml(String resourceName)

getHtml

public String getHtml(String resourceName,
                      Map startingParams)

getDescription

public String getDescription()

getName

public String getName()

getAuthenticationContext

protected JiraAuthenticationContext getAuthenticationContext()

getText

public String getText(String key)
Deprecated. Please use i18nBean.getText() instead


getText

public String getText(String key,
                      Object params)

getI18nLocations

protected List getI18nLocations()

getI18nBean

public I18nBean getI18nBean()

createVelocityParams

protected Map createVelocityParams(Map startingParams)

getDefaultVelocityParams

public static Map getDefaultVelocityParams(Map startingParams,
                                           JiraAuthenticationContext authenticationContext)

getHttpRequest

public static javax.servlet.http.HttpServletRequest getHttpRequest()
Return the HttpRequest, but overriding the getRequestURI() method to call back to webwork if needed. This is because in some application servers, getRequestURI() returns the 'view' page, which is almost always not what we need.


isResourceExist

protected boolean isResourceExist(String resourceName)


Copyright © 2002-2006 Atlassian. All Rights Reserved.