JiraWebActionSupport. This class is subject of removal.@PublicSpi @Deprecated public abstract class JiraActionSupport extends webwork.action.ActionSupport implements webwork.action.CommandDriven, I18nHelper
ActionSupport class and provides JIRA specific code to all our
actions.
Its main capabilities are extra error handling and I18n support
I18nHelper.BeanFactory| Modifier and Type | Field and Description |
|---|---|
protected org.apache.log4j.Logger |
log
Deprecated.
|
| Modifier | Constructor and Description |
|---|---|
protected |
JiraActionSupport()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addErrorMessages(webwork.dispatcher.ActionResult aResult)
Deprecated.
|
void |
addErrorMessages(Collection<String> errorMessages)
Deprecated.
|
void |
addErrors(Map<String,String> errors)
Deprecated.
|
void |
addIllegalArgumentException(String fieldName,
IllegalArgumentException e)
Deprecated.
Override this method from ActionSupport.
|
String |
execute()
Deprecated.
|
String |
getActionName()
Deprecated.
|
ApplicationProperties |
getApplicationProperties()
Deprecated.
|
protected <T> T |
getComponentInstanceOfType(Class<T> clazz)
Deprecated.
This can be called to get a component from the
ComponentAccessor. |
ResourceBundle |
getDefaultResourceBundle()
Deprecated.
Returns the default
ResourceBundle within JIRA, which does not include translations provided by plugins. |
protected I18nHelper |
getI18nHelper()
Deprecated.
|
Set<String> |
getKeysForPrefix(String prefix)
Deprecated.
Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.
|
Locale |
getLocale()
Deprecated.
|
OfBizDelegator |
getOfBizDelegator()
Deprecated.
|
ResourceBundle |
getResourceBundle()
Deprecated.
Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins.
|
String |
getResult()
Deprecated.
Get a definitive result.
|
String |
getText(String key)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object parameters)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found.
|
String |
getText(String key,
Object value1,
Object value2,
Object value3)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6,
Object value7)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6,
Object value7,
Object value8)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4,
String value5,
String value6,
String value7)
Deprecated.
Called to return the formatted text of the specified i18n key
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4,
String value5,
String value6,
String value7,
String value8,
String value9)
Deprecated.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getUnescapedText(String key)
Deprecated.
Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getUntransformedRawText(String key)
Deprecated.
Same as
I18nHelper.getUnescapedText(String) but does not apply any TranslationTransforms. |
com.atlassian.core.user.preferences.Preferences |
getUserPreferences()
Deprecated.
|
boolean |
hasAnyErrors()
Deprecated.
|
boolean |
isIndexing()
Deprecated.
|
boolean |
isKeyDefined(String key)
Deprecated.
For the given key, checks whether such a key is defined in the locale context represented by this helper
instance.
|
protected void |
removeKeyOrAddError(Map params,
String key,
String messageKey)
Deprecated.
Checks if descriptorParams contains key and removes it, otherwise adds the error message with the given message
key.
|
addError, addErrorMessage, doDefault, doExecute, doValidation, getCommandName, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validateprotected <T> T getComponentInstanceOfType(Class<T> clazz)
ComponentAccessor. Override this if you
wish to change this behaviour say in unit tests.clazz - the component class in questionpublic String execute() throws Exception
execute in interface webwork.action.Actionexecute in class webwork.action.ActionSupportExceptionpublic OfBizDelegator getOfBizDelegator()
public ApplicationProperties getApplicationProperties()
public final String getActionName()
getActionName in class webwork.action.ActionSupportpublic String getResult()
Action.ERROR if there are error messages, otherwise
Action.SUCCESS.Action.ERROR or Action.SUCCESSpublic void addErrorMessages(Collection<String> errorMessages)
public boolean hasAnyErrors()
public void addErrorMessages(webwork.dispatcher.ActionResult aResult)
public boolean isIndexing()
public void addIllegalArgumentException(String fieldName, IllegalArgumentException e)
addIllegalArgumentException in interface webwork.action.IllegalArgumentAwareaddIllegalArgumentException in class webwork.action.ActionSupportpublic com.atlassian.core.user.preferences.Preferences getUserPreferences()
protected void removeKeyOrAddError(Map params, String key, String messageKey)
params - the map of parameterskey - the param key to remove.messageKey - the error.protected I18nHelper getI18nHelper()
I18nHelper associated with this actionpublic Set<String> getKeysForPrefix(String prefix)
I18nHelpergetKeysForPrefix in interface I18nHelperprefix - The prefix for i18n keys. May not be nullpublic ResourceBundle getDefaultResourceBundle()
I18nHelperResourceBundle within JIRA, which does not include translations provided by plugins.
For use cases where non-English translations are required, call I18nHelper.getResourceBundle() instead.getDefaultResourceBundle in interface I18nHelperI18nHelper.getResourceBundle()public ResourceBundle getResourceBundle()
I18nHelpergetResourceBundle in interface I18nHelperI18nHelper.getDefaultResourceBundle()public Locale getLocale()
getLocale in interface I18nHelpergetLocale in class webwork.action.ActionSupportLocale that is associated with this I18nHelperpublic String getUnescapedText(String key)
I18nHelpergetUnescapedText in interface I18nHelperkey - the key of the i18n messagepublic String getUntransformedRawText(String key)
I18nHelperI18nHelper.getUnescapedText(String) but does not apply any TranslationTransforms.getUntransformedRawText in interface I18nHelperkey - the key of the i18n messagepublic boolean isKeyDefined(String key)
I18nHelperFor the given key, checks whether such a key is defined in the locale context represented by this helper instance. Note that the actual translation may be in the 'fallback' default locale rather than the current locale.
The contract of this is method is correlated with I18nHelper.getUntransformedRawText(String), whereby if this
method returns false, I18nHelper.getUntransformedRawText(String) will return the key provided as an
argument, and if this method returns true, I18nHelper.getUntransformedRawText(String) will generally
return the translation, which in some very unlikely cases may be equal to the key.
isKeyDefined in interface I18nHelperkey - translation keytrue, if any translation for such key exists, false otherwisepublic String getText(String key)
I18nHelpergetText in interface I18nHelpergetText in class webwork.action.ActionSupportkey - the key of the i18n messagepublic String getText(String key, String value1)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7, Object value8)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagevalue8 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7, String value8, String value9)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagevalue8 - a value to be substituted into the messagevalue9 - a value to be substituted into the messagepublic String getText(String key, Object parameters)
I18nHelper
The object passed in can be an array, a List} or a single parameter object. It will be then
used as substitution parameters within the message.
getText in interface I18nHelperkey - the key of the i18n messageparameters - This can be an Array, a List and Array or a single object parameterCopyright © 2002-2018 Atlassian. All Rights Reserved.