@NotThreadSafe @PublicSpi public class

JiraWebActionSupport

extends JiraActionSupport
implements ErrorCollection HttpServletVariables AuthorizationSupport

java.lang.Object
↳	webwork.action.ActionSupport
	↳	com.atlassian.jira.action.JiraActionSupport
		↳	com.atlassian.jira.web.action.JiraWebActionSupport

Known Direct Subclasses

AboutPage, AbstractConfigureFieldLayout, AbstractConstantAction, AbstractConvertIssue, AbstractDashboardAdministration, AbstractEditConfigurationItemAction, AbstractEditFieldLayoutItem, AbstractEditFieldLayoutSchemeAction, AbstractFieldLayoutAction, AbstractFieldScreenAction, AbstractFieldScreenSchemeAction, AbstractManageIssueTypeOptionsAction, AbstractProjectImportProgress<V extends Serializable>, AbstractProjectImportUsersMissing, AbstractProjectRole, and 139 others.

Known Indirect Subclasses

AbstractAddScheme, AbstractAddWorkflowTransitionDescriptor, AbstractAddWorkflowTransitionDescriptorParams, AbstractAdministerFilter, AbstractBrowser, AbstractBulkOperationAction, AbstractBulkOperationDetailsAction, AbstractBulkWatchOperationAction, AbstractCommentableAssignableIssue, AbstractCommentableIssue, AbstractCopyScheme, AbstractDeleteConstant, AbstractDeleteScheme, AbstractDeleteWorkflowTransitionDescriptor, AbstractEditConstant, and 282 others.

@PublicSpi

This class is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

All web actions should extend this class - it provides basic common functionality for all web actions.

When adding to this class, be sure that what you are adding is used by a large number of actions - otherwise add it to a sub class of this.

Summary

Nested Classes
enum	JiraWebActionSupport.MessageType	Represents a type of message that the browser will display after the next page load.

Constants
String	ISSUE_NOT_FOUND_RESULT
String	PERMISSION_VIOLATION_RESULT
String	RETURN_URL_PARAMETER

[Expand]

Inherited Constants

From interface webwork.action.Action

Fields
protected HttpServletRequest	request	This field is deprecated. since 6.0 - use `getHttpRequest()` instead.
protected Collection	savedFilters

[Expand]

Inherited Fields

From class com.atlassian.jira.action.JiraActionSupport

From class webwork.action.ActionSupport

Public Constructors
	JiraWebActionSupport()

Public Methods
void	addError(String field, String message, ErrorCollection.Reason reason) Add a field-specific error message.
void	addErrorCollection(ErrorCollection errors) Populate this ErrorCollection with general and field-specific errors.
void	addErrorMessage(String message, ErrorCollection.Reason reason) Add error message relating to system state (not field-specific), and a reason.
void	addReason(ErrorCollection.Reason reason) Add a reason why the function has not been performed.
void	addReasons(Set<ErrorCollection.Reason> reasons) Add reasons why the function has not been performed.
String	getAdministratorContactLink() Get the link, with Internationalised text for contacting the administrators of JIRA.
ApplicationProperties	getApplicationProperties()
String	getConglomerateCookieValue(String cookieName, String key) Retrieve the value from a conglomerate Cookie from the request.
ConstantsManager	getConstantsManager()
String	getDateFormat()
String	getDateTimeFormat()
DateTimeFormatter	getDateTimeFormatter() Returns a DateTimeFormatter that can be used to format times and dates in the user's time zone using `RELATIVE`.
String	getDescTranslation(GenericValue issueConstantGV) This method is deprecated. Use `ConstantsManager` instead. Since v6.0.
DateTimeFormatter	getDmyDateFormatter() Returns a DateTimeFormatter that can be used to format dates in the user's time zone using `DATE`.
String	getEmptyResponse() Returns an empty response code (204)
Collection<String>	getErrorMessages()
Map<String, String>	getErrors()
Field	getField(String id)
Collection<String>	getFlushedErrorMessages() Get error messages, then get rid of them.
final Hint	getHint(String context)
HttpServletRequest	getHttpRequest()
HttpServletResponse	getHttpResponse()
HttpSession	getHttpSession()
JiraContactHelper	getJiraContactHelper()
JiraServiceContext	getJiraServiceContext() Provides a service context with the current user which contains this action as its `ErrorCollection`.
String	getLanguage()
ApplicationUser	getLoggedInApplicationUser()
@Deprecated User	getLoggedInUser() This method is deprecated. since 6.1 use `getLoggedInApplicationUser()` instead.
String	getNameTranslation(GenericValue issueConstantGV) This method is deprecated. Use `ConstantsManager` instead. Since v6.0.
@Deprecated OutlookDate	getOutlookDate() This method is deprecated. Use `getDateTimeFormatter()` instead. Since v5.0.
ProjectManager	getProjectManager()
final Hint	getRandomHint()
Set<ErrorCollection.Reason>	getReasons() A set of well known reasons why the function has not been performed.
String	getRedirect(String defaultUrl, boolean allowUnsafeRedirect) Redirects to the value of `getReturnUrl()`, falling back to `defaultUrl` if the `returnUrl` is not set.
String	getRedirect(String defaultUrl) Redirects to the value of `getReturnUrl()`, falling back to `defaultUrl` if the `returnUrl` is not set.
String	getReturnUrl()
String	getReturnUrlForCancelLink() The cancel links should not included the selectedIssueId, otherwise when returning to the issue navigator an issue updated notification will be shown.
List<String>	getSearchSortDescriptions(SearchRequest searchRequest)
Project	getSelectedProject() Gets the last viewed project that the user visited and still has permission to see.
Project	getSelectedProjectObject() Gets the last viewed project that the user visited and still has permission to see.
String	getServerId()
ServletContext	getServletContext()
String	getTimeFormat()
UriValidator	getUriValidator()
String	getUserFullName(String username)
UserManager	getUserManager()
VersionManager	getVersionManager()
String	getWebworkStack() For debugging JSPs; prints the webwork stack.
String	getWebworkStack(String selected) For debugging JSPs; prints the webwork stack, highlighting the specified node.
String	getXsrfToken()
boolean	hasIssuePermission(int permissionsId, Issue issue) Returns true if the logged in user has the given permission type on the given Issue.
boolean	hasPermission(int permissionsId) Returns true if the logged in user has the given permission type.
boolean	hasProjectPermission(int permissionsId, Project project) Returns true if the logged in user has the given permission type on the given Project.
String	htmlEncode(String encodeMe) Convenience instance method to call static utility from webwork EL.
boolean	isHasIssuePermission(int permissionsId, GenericValue issue) Returns true if the logged in user has the given permission type on the given Issue.
boolean	isHasIssuePermission(String permName, GenericValue issue) Returns true if the logged in user has the given permission type on the given Issue.
boolean	isHasPermission(int permissionsId) This method is deprecated. Use `hasPermission(int)` instead. Since v6.0.
boolean	isHasPermission(String permName) This method is deprecated. Use `hasPermission(int)` instead. Since v6.0.
@Deprecated boolean	isHasPermission(String permName, GenericValue entity) Returns true if remote user has permission over given entity, false otherwise.
boolean	isHasProjectPermission(String permName, GenericValue project) This method is deprecated. Use `hasProjectPermission(int, com.atlassian.jira.project.Project)` instead. Since v6.0.
boolean	isHasProjectPermission(int permissionsId, GenericValue project) This method is deprecated. Use `hasProjectPermission(int, com.atlassian.jira.project.Project)` instead. Since v6.0.
boolean	isInlineDialogMode() This returns true if the action has been invoked as an inline dialog.
boolean	isSystemAdministrator()
@Deprecated boolean	isUserExists(String username) This method is deprecated. Use `isUserExistsByName(String)` or `isUserExistsByKey(String)` instead, as appropriate. Since v6.0.
boolean	isUserExistsByKey(String userkey)
boolean	isUserExistsByName(String username)
String	returnComplete(String url)
String	returnComplete()
void	setConglomerateCookieValue(String cookieName, String key, String value) Set the value key/value pair in a conglomerate Cookie.
void	setInline(boolean inline) This is the web parameter setter for invoking an action as an inline dialog
void	setReasons(Set<ErrorCollection.Reason> reasons) Set reasons why the function has not been performed.
void	setReturnUrl(String returnUrl)
void	setSelectedProjectId(Long id)
String	urlEncode(String encode) Encodes the given string into `application/x-www-form-urlencoded` format, using the JIRA encoding scheme to obtain the bytes for unsafe characters.

Protected Methods
final void	addErrorMessageByKeyIfAbsent(String errorMsgKey)
final void	addErrorMessageIfAbsent(String errorMsg)
void	addMessageToResponse(String msg, String type, boolean closeable, String target) This will populate the the custom Atlassian header with the details of a pop-up message.
String	forceRedirect(String redirect) This method will force a server redirect, with no security checks.
AuthorizationSupport	getAuthorizationSupport()
GlobalPermissionManager	getGlobalPermissionManager()
final HintManager	getHintManager()
PermissionManager	getPermissionManager()
@Nonnull final RedirectSanitiser	getRedirectSanitiser() Returns a RedirectSanitiser implementation.
UserProjectHistoryManager	getUserProjectHistoryManager()
final boolean	hasErrorMessage(String errorMsg)
final boolean	hasErrorMessageByKey(String errorMsgKey)
String	insertContextPath(String url) Prepends the context path to the URL if it begins with a forward slash (this is commonly used for redirects within a JIRA instance).
final String	returnCompleteWithInlineRedirect(String url) This will return success response with body containing url to redirect.
String	returnCompleteWithInlineRedirectAndMsg(String url, String msg, String type, boolean closeable, String target) This method is deprecated. since 5.1. Use `returnCompleteWithInlineRedirectAndMsg(String, String, MessageType, boolean, String)` instead.
String	returnCompleteWithInlineRedirectAndMsg(String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target) This will redirect like `returnCompleteWithInlineRedirect(String)`, and will also populate the response with the details of a pop-up message to be displayed on the redirected page.
String	returnMsgToUser(String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target) This will redirect like `returnComplete()`, and will also populate the response with the details of a pop-up message to be displayed on the redirected page.
@Deprecated String	returnMsgToUser(String url, String msg, String type, boolean closeable, String target) This method is deprecated. since 5.1. Use `returnMsgToUser(String, String, MessageType, boolean, String)` instead.

[Expand]

Inherited Methods

From class com.atlassian.jira.action.JiraActionSupport

From class webwork.action.ActionSupport

From class java.lang.Object

From interface com.atlassian.jira.util.ErrorCollection

From interface com.atlassian.jira.util.I18nHelper

ResourceBundle	getDefaultResourceBundle() Returns the default `ResourceBundle` within JIRA, which does not include translations provided by plugins.
Set<String>	getKeysForPrefix(String prefix) Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.
Locale	getLocale()
ResourceBundle	getResourceBundle() Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins.
String	getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7) 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) 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) 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) 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, String value8, String value9) 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) 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) 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) 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) 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) 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) 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) Called to return the formatted text of the specified i18n key
String	getText(String key, Object value1, Object value2, Object value3) 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) 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) 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) Same as `getUnescapedText(String)` but does not apply any `TranslationTransform`s.
boolean	isKeyDefined(String key) For the given `key`, checks whether such a key is defined in the locale context represented by this helper instance.

From interface com.atlassian.jira.web.HttpServletVariables

From interface com.atlassian.jira.web.util.AuthorizationSupport

From interface webwork.action.Action

From interface webwork.action.CommandDriven

From interface webwork.action.IllegalArgumentAware

Constants

public static final String ISSUE_NOT_FOUND_RESULT

Constant Value: "issuenotfound"

public static final String PERMISSION_VIOLATION_RESULT

Constant Value: "permissionviolation"

public static final String RETURN_URL_PARAMETER

Constant Value: "returnUrl"

Fields

protected HttpServletRequest request

This field is deprecated.
since 6.0 - use getHttpRequest() instead.

protected Collection savedFilters

Public Constructors

public JiraWebActionSupport ()

Public Methods

public void addError (String field, String message, ErrorCollection.Reason reason)

Add a field-specific error message.

Parameters

field	Field name, eg. "assignee"
message	Error message.
reason	Reason for the error.

public void addErrorCollection (ErrorCollection errors)

Populate this ErrorCollection with general and field-specific errors.

Parameters

errors	ErrorCollection whose errors/messages we obtain.

public void addErrorMessage (String message, ErrorCollection.Reason reason)

Add error message relating to system state (not field-specific), and a reason.

Parameters

message	Error message.
reason	Reason for the error.

public void addReason (ErrorCollection.Reason reason)

Add a reason why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Parameters

reason	a well known reasons why the function has not been performed.

public void addReasons (Set<ErrorCollection.Reason> reasons)

Add reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Parameters

reasons	a set of well known reasons why the function has not been performed.

public String getAdministratorContactLink ()

Get the link, with Internationalised text for contacting the administrators of JIRA. This link is present on many pages across the bredth of JIRA and so centralised here.

Returns

html String of the contact administrators link.

public ApplicationProperties getApplicationProperties ()

public String getConglomerateCookieValue (String cookieName, String key)

Retrieve the value from a conglomerate Cookie from the request.

Parameters

cookieName	The name of the conglomerate cookie
key	The key of the value

Returns

the value (or the empty-string if it did not exist)

public ConstantsManager getConstantsManager ()

public String getDateFormat ()

public String getDateTimeFormat ()

public DateTimeFormatter getDateTimeFormatter ()

Returns a DateTimeFormatter that can be used to format times and dates in the user's time zone using RELATIVE.

Returns

a DateTimeFormatter

public String getDescTranslation (GenericValue issueConstantGV)

This method is deprecated.
Use ConstantsManager instead. Since v6.0.

public DateTimeFormatter getDmyDateFormatter ()

Returns a DateTimeFormatter that can be used to format dates in the user's time zone using DATE.

Returns

a DateTimeFormatter

public String getEmptyResponse ()

Returns an empty response code (204)

public Collection<String> getErrorMessages ()

public Map<String, String> getErrors ()

public Field getField (String id)

public Collection<String> getFlushedErrorMessages ()

Get error messages, then get rid of them.

Returns

The (now cleared) error messages.

public final Hint getHint (String context)

public HttpServletRequest getHttpRequest ()

public HttpServletResponse getHttpResponse ()

public HttpSession getHttpSession ()

public JiraContactHelper getJiraContactHelper ()

public JiraServiceContext getJiraServiceContext ()

Provides a service context with the current user which contains this action as its ErrorCollection.

Returns

the JiraServiceContext.

public String getLanguage ()

Throws

IOException

public ApplicationUser getLoggedInApplicationUser ()

Returns

The logged in user.

@Deprecated public User getLoggedInUser ()

This method is deprecated.
since 6.1 use getLoggedInApplicationUser() instead.

Returns

The logged in user.

public String getNameTranslation (GenericValue issueConstantGV)

This method is deprecated.
Use ConstantsManager instead. Since v6.0.

@Deprecated public OutlookDate getOutlookDate ()

This method is deprecated.
Use getDateTimeFormatter() instead. Since v5.0.

public ProjectManager getProjectManager ()

public final Hint getRandomHint ()

public Set<ErrorCollection.Reason> getReasons ()

A set of well known reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Returns

a set of well known reasons why the function has not been performed.

public String getRedirect (String defaultUrl, boolean allowUnsafeRedirect)

Redirects to the value of getReturnUrl(), falling back to defaultUrl if the returnUrl is not set. This method clears the returnUrl. If there are errors, this method returns "ERROR". If the URL starts with '/' it is interpreted as context-relative.

If allowUnsafeRedirect is true, this method will not perform validation on the value of returnUrl or defaultUrl. This can introduce serious security problems, so use with care. In particular, you should only use use this method if defaultUrl has already been sanitised (via whitelisting).

Parameters

defaultUrl	default URL to redirect to
allowUnsafeRedirect	whether to allow unsafe redirects (e.g. `javascript:` or off-site URLs).

Returns

URL to redirect to

public String getRedirect (String defaultUrl)

Redirects to the value of getReturnUrl(), falling back to defaultUrl if the returnUrl is not set. This method clears the returnUrl. If there are errors, this method returns "ERROR".

If the URL starts with '/' it is interpreted as context-relative.

Off-site redirects

Starting from JIRA 6.0, this method will not redirect to a URL that is considered "unsafe" as per makeSafeRedirectUrl(String). Use getRedirect(String, boolean) to allow unsafe redirects for URLs that do not contain possibly malicious user input.

Parameters

defaultUrl	default URL to redirect to

Returns

URL to redirect to

public String getReturnUrl ()

public String getReturnUrlForCancelLink ()

The cancel links should not included the selectedIssueId, otherwise when returning to the issue navigator an issue updated notification will be shown.

Returns

the returnUrl with selectedIssueId parameter stripped out.

public List<String> getSearchSortDescriptions (SearchRequest searchRequest)

public Project getSelectedProject ()

Gets the last viewed project that the user visited and still has permission to see.

Returns

the last project the user visited.

public Project getSelectedProjectObject ()

Gets the last viewed project that the user visited and still has permission to see. This is a legacy synonym for getSelectedProject()

Returns

the last project the user visited.

public String getServerId ()

public ServletContext getServletContext ()

public String getTimeFormat ()

public UriValidator getUriValidator ()

public String getUserFullName (String username)

public UserManager getUserManager ()

public VersionManager getVersionManager ()

public String getWebworkStack ()

For debugging JSPs; prints the webwork stack. Eg. called with:

Returns

HTML string of the webwork stack

public String getWebworkStack (String selected)

For debugging JSPs; prints the webwork stack, highlighting the specified node. Eg. called with:

Parameters

selected	selected value in the webwork stack

Returns

HTML string of the webwork stack

public String getXsrfToken ()

public boolean hasIssuePermission (int permissionsId, Issue issue)

Returns true if the logged in user has the given permission type on the given Issue.

Parameters

permissionsId	the permission type
issue	the Issue

Returns

true if the logged in user has the given permission type on the given Issue.

public boolean hasPermission (int permissionsId)

Returns true if the logged in user has the given permission type.

Parameters

permissionsId	the permission type

Returns

true if the logged in user has the given permission type.

public boolean hasProjectPermission (int permissionsId, Project project)

Returns true if the logged in user has the given permission type on the given Project.

Parameters

permissionsId	the permission type
project	the Project

Returns

true if the logged in user has the given permission type on the given Project.

public String htmlEncode (String encodeMe)

Convenience instance method to call static utility from webwork EL.

Parameters

encodeMe	a String to be HTML encoded.

Returns

the HTML encoded string.

public boolean isHasIssuePermission (int permissionsId, GenericValue issue)

Returns true if the logged in user has the given permission type on the given Issue.

Parameters

permissionsId	the permission type
issue	the Issue

Returns

true if the logged in user has the given permission type on the given Issue.

public boolean isHasIssuePermission (String permName, GenericValue issue)

Returns true if the logged in user has the given permission type on the given Issue.

Parameters

permName	the permission type
issue	the Issue

Returns

true if the logged in user has the given permission type on the given Issue.

public boolean isHasPermission (int permissionsId)

This method is deprecated.
Use hasPermission(int) instead. Since v6.0.

Returns true if the logged in user has the given permission type.

Parameters

permissionsId	the permission type

Returns

true if the logged in user has the given permission type.

public boolean isHasPermission (String permName)

This method is deprecated.
Use hasPermission(int) instead. Since v6.0.

Returns true if the logged in user has the given permission type.

Parameters

permName	the permission type

Returns

true if the logged in user has the given permission type.

@Deprecated public boolean isHasPermission (String permName, GenericValue entity)

Returns true if remote user has permission over given entity, false otherwise.

Parameters

permName	permission type
entity	entity to check the permission for, e.g. project, issue

Returns

true if remote user has permission over given entity, false otherwise

public boolean isHasProjectPermission (String permName, GenericValue project)

This method is deprecated.
Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0.

Returns true if the logged in user has the given permission type on the given Project.

Parameters

permName	the permission type
project	the Project

Returns

true if the logged in user has the given permission type on the given Project.

public boolean isHasProjectPermission (int permissionsId, GenericValue project)

This method is deprecated.
Use hasProjectPermission(int, com.atlassian.jira.project.Project) instead. Since v6.0.

Returns true if the logged in user has the given permission type on the given Project.

Parameters

permissionsId	the permission type
project	the Project

Returns

true if the logged in user has the given permission type on the given Project.

public boolean isInlineDialogMode ()

This returns true if the action has been invoked as an inline dialog. This changes the way that the action sends back its responses, namely when the action is submitted and completed

Returns

true if the action was invoked as an inline dialog

public boolean isSystemAdministrator ()

@Deprecated public boolean isUserExists (String username)

This method is deprecated.
Use isUserExistsByName(String) or isUserExistsByKey(String) instead, as appropriate. Since v6.0.

Old name for isUserExistsByName(String)

Parameters

username	the username to check

Returns

true if the username is associated with an existing user; false otherwise

public boolean isUserExistsByKey (String userkey)

public boolean isUserExistsByName (String username)

public String returnComplete (String url)

public String returnComplete ()

public void setConglomerateCookieValue (String cookieName, String key, String value)

Set the value key/value pair in a conglomerate Cookie.

Parameters

cookieName	The name of the conglomerate cookie
key	The key of the value
value	The value

public void setInline (boolean inline)

This is the web parameter setter for invoking an action as an inline dialog

Parameters

inline	true if the action should act as an inline dialog

public void setReasons (Set<ErrorCollection.Reason> reasons)

Set reasons why the function has not been performed. The reasons may be used by callers of services to set return codes etc. for example in REST services.

Parameters

reasons	a set of well known reasons why the function has not been performed.

public void setReturnUrl (String returnUrl)

public void setSelectedProjectId (Long id)

public String urlEncode (String encode)

Encodes the given string into application/x-www-form-urlencoded format, using the JIRA encoding scheme to obtain the bytes for unsafe characters.

Parameters

encode	the String to encode

Returns

a URL-encoded String

Protected Methods

protected final void addErrorMessageByKeyIfAbsent (String errorMsgKey)

protected final void addErrorMessageIfAbsent (String errorMsg)

protected void addMessageToResponse (String msg, String type, boolean closeable, String target)

This will populate the the custom Atlassian header with the details of a pop-up message.

Parameters

msg	message HTML
type	type of message, see JIRA.Messages.Types
closeable	if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically
target	the target to prepend the message pop-up to. If null, the message is shown in a global spot.

protected String forceRedirect (String redirect)

This method will force a server redirect, with no security checks. It doesn't clear the return URL and will always go to the redirect URL. For security reasons, prefer getRedirect(String), which checks that the redirect URL is safe.

Parameters

redirect	redirect URL

Returns

NONE. It'll just redirect to where you've specified

protected AuthorizationSupport getAuthorizationSupport ()

protected GlobalPermissionManager getGlobalPermissionManager ()

protected final HintManager getHintManager ()

protected PermissionManager getPermissionManager ()

@Nonnull protected final RedirectSanitiser getRedirectSanitiser ()

Returns a RedirectSanitiser implementation.

Returns

a RedirectSanitiser

protected UserProjectHistoryManager getUserProjectHistoryManager ()

protected final boolean hasErrorMessage (String errorMsg)

protected final boolean hasErrorMessageByKey (String errorMsgKey)

protected String insertContextPath (String url)

Prepends the context path to the URL if it begins with a forward slash (this is commonly used for redirects within a JIRA instance).

Parameters

url	a String containing a URL

Returns

a String with the context path prepended

protected final String returnCompleteWithInlineRedirect (String url)

This will return success response with body containing url to redirect. An appropriately configured client side control should perform redirect to the desired url.

Parameters

url	URL to redirect to

Returns

action mapping string

protected String returnCompleteWithInlineRedirectAndMsg (String url, String msg, String type, boolean closeable, String target)

This method is deprecated.
since 5.1. Use returnCompleteWithInlineRedirectAndMsg(String, String, MessageType, boolean, String) instead.

This will redirect like returnCompleteWithInlineRedirect(String), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters

url	URL to redirect to
msg	message HTML
type	type of message, see JIRA.Messages.Types
closeable	if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically
target	the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns

action mapping string

protected String returnCompleteWithInlineRedirectAndMsg (String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target)

This will redirect like returnCompleteWithInlineRedirect(String), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters

url	URL to redirect to
msg	message HTML
type	type of message.
closeable	if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically
target	the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns

action mapping string

protected String returnMsgToUser (String url, String msg, JiraWebActionSupport.MessageType type, boolean closeable, String target)

This will redirect like returnComplete(), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters

url	URL to redirect to. Not used in dialogs
msg	message HTML
type	type of message
closeable	if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically
target	the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns

action mapping string

@Deprecated protected String returnMsgToUser (String url, String msg, String type, boolean closeable, String target)

This method is deprecated.
since 5.1. Use returnMsgToUser(String, String, MessageType, boolean, String) instead.

This will redirect like returnComplete(), and will also populate the response with the details of a pop-up message to be displayed on the redirected page. An appropriately configured client side control should perform the displaying of the message.

Parameters

url	URL to redirect to. Not used in dialogs
msg	message HTML
type	type of message, see JIRA.Messages.Types
closeable	if true, message pop-up has an 'X' button, otherwise pop-up fades away automatically
target	the target to prepend the message pop-up to. If null, the message is shown in a global spot

Returns

action mapping string

Interfaces

Classes

Annotations

Enums

JiraWebActionSupport

@PublicSpi

Class Overview

Summary

Constants

public static final String ISSUE_NOT_FOUND_RESULT

public static final String PERMISSION_VIOLATION_RESULT

public static final String RETURN_URL_PARAMETER

Fields

protected HttpServletRequest request

See Also

protected Collection savedFilters

Public Constructors

public JiraWebActionSupport ()

Public Methods

public void addError (String field, String message, ErrorCollection.Reason reason)

Parameters

public void addErrorCollection (ErrorCollection errors)

Parameters

public void addErrorMessage (String message, ErrorCollection.Reason reason)

Parameters

public void addReason (ErrorCollection.Reason reason)

Parameters

public void addReasons (Set<ErrorCollection.Reason> reasons)

Parameters

public String getAdministratorContactLink ()

Returns

See Also

public ApplicationProperties getApplicationProperties ()

public String getConglomerateCookieValue (String cookieName, String key)

Parameters

Returns

public ConstantsManager getConstantsManager ()

public String getDateFormat ()

public String getDateTimeFormat ()

public DateTimeFormatter getDateTimeFormatter ()

Returns

public String getDescTranslation (GenericValue issueConstantGV)

public DateTimeFormatter getDmyDateFormatter ()

Returns

public String getEmptyResponse ()

public Collection<String> getErrorMessages ()

public Map<String, String> getErrors ()

public Field getField (String id)

public Collection<String> getFlushedErrorMessages ()

Returns

public final Hint getHint (String context)

public HttpServletRequest getHttpRequest ()

See Also

public HttpServletResponse getHttpResponse ()

See Also

public HttpSession getHttpSession ()

See Also

public JiraContactHelper getJiraContactHelper ()

public JiraServiceContext getJiraServiceContext ()

Returns

public String getLanguage ()

Throws

public ApplicationUser getLoggedInApplicationUser ()

Returns

@Deprecated public User getLoggedInUser ()

Returns

public String getNameTranslation (GenericValue issueConstantGV)

@Deprecated public OutlookDate getOutlookDate ()

public ProjectManager getProjectManager ()

public final Hint getRandomHint ()

public Set<ErrorCollection.Reason> getReasons ()

Returns

public String getRedirect (String defaultUrl, boolean allowUnsafeRedirect)

Parameters

Returns

See Also

public String getRedirect (String defaultUrl)

Off-site redirects

Parameters

Returns