com.atlassian.jira.web.action.message

Class MessageResponder

java.lang.Object

com.atlassian.jira.web.action.message.MessageResponder

public final class MessageResponder
extends Object

Prepares a response to an action. The response will contain messages and redirection.

Since:

v6.4

Constructor Summary

Constructors

Constructor and Description
MessageResponder(SoyTemplateRendererProvider rendererProvider, com.atlassian.adapter.jackson.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
String	respond(Iterable<PopUpMessage> messages, URI redirect, JiraWebActionSupport action, String title) Guarantees that given messages will be shown to the user and user will be be able to follow the redirect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageResponder

public MessageResponder(SoyTemplateRendererProvider rendererProvider,
                        com.atlassian.adapter.jackson.ObjectMapper objectMapper)

Method Detail

respond

public final String respond(Iterable<PopUpMessage> messages,
                            URI redirect,
                            JiraWebActionSupport action,
                            String title)

Guarantees that given messages will be shown to the user and user will be be able to follow the redirect. It might modify the response headers and start sending the response body.

Parameters:

messages - information for the user about the outcome of the action

redirect - redirects to the next page the user should see; SHOULD NOT contain personal information

action - performed action

title - human-readable, short description of the action

Returns:

one of the standard Action view names