Package com.atlassian.jira.web.action.user

Class Logout

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.user.Logout

All Implemented Interfaces:

ErrorCollection, I18nHelper, HttpServletVariables, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

public class Logout
extends JiraWebActionSupport

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
Logout(LoginManager loginManager, XsrfInvocationChecker xsrfInvocationChecker, com.atlassian.seraph.service.rememberme.RememberMeService rememberMeService, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method	Description
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 String	doExecute()	Logs the user out of JIRA and shows the log-out page.

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getActionNameJspa, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, setErrorMessages

Constructor Details

Logout

public Logout(LoginManager loginManager,
 XsrfInvocationChecker xsrfInvocationChecker,
 com.atlassian.seraph.service.rememberme.RememberMeService rememberMeService,
 JiraAuthenticationContext authenticationContext)

Method Details

doExecute

protected String doExecute()
                    throws Exception

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

Overrides:

doExecute in class webwork.action.ActionSupport

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.

Throws:

Exception

doDefault

public String doDefault()
                 throws Exception

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, JiraLogoutServlet.service(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)

Overrides:

doDefault in class webwork.action.ActionSupport

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.

Throws:

Exception