public class

Logout

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

Summary

[Expand]
Inherited Constants
From class com.atlassian.jira.web.action.JiraWebActionSupport
From interface webwork.action.Action
[Expand]
Inherited Fields
From class com.atlassian.jira.web.action.JiraWebActionSupport
From class com.atlassian.jira.action.JiraActionSupport
From class webwork.action.ActionSupport
Public Constructors
Logout(LoginManager loginManager, XsrfInvocationChecker xsrfInvocationChecker, RememberMeService rememberMeService, JiraAuthenticationContext authenticationContext)
Public Methods
String doDefault()

Checks the JIRA application properties to see whether log-out confirmation is enabled, logs the user out if necessary, and renders the view accordingly.

Protected Methods
String doExecute()
Logs the user out of JIRA and shows the log-out page.
[Expand]
Inherited Methods
From class com.atlassian.jira.web.action.JiraWebActionSupport
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
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

Public Constructors

public Logout (LoginManager loginManager, XsrfInvocationChecker xsrfInvocationChecker, RememberMeService rememberMeService, JiraAuthenticationContext authenticationContext)

Public Methods

public String doDefault ()

Checks the JIRA application properties to see whether log-out confirmation is enabled, logs the user out if necessary, and renders the view accordingly.

If the log-out confirmation property is enabled, it will take the user to a log-out confirmation page.

Otherwise, it will log the user out and show the log-out page.

The log-out confirmation page executes the doExecute() command.

For details of the logic behind the XSRF check see, service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

Returns
  • When there's a valid XSRF token, #CONFIRM if the application properties indicate that log-out s hould be confirmed for all users, if the user has remember turned on and the application property is set to "cookie" we return also return #CONFIRM; Otherwise, #LOGOUT is returned.

    If the XSRF token is not valid, we return #CONFIRM when there is an authenticated user; Otherwise, #ALREADY_LOGGED_OUT is returned.

Protected Methods

protected String doExecute ()

Logs the user out of JIRA and shows the log-out page. For details of the logic behind the XSRF check see, service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

Returns
  • #LOGOUT if the user presents a valid xsrf token (his / her session hasn't expired).

    If the XSRF token is not valid, we return #CONFIRM when there is an authenticated user; Otherwise, #ALREADY_LOGGED_OUT is returned.