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

java.lang.Object
  extended by webwork.action.ActionSupport
      extended by com.atlassian.jira.action.JiraActionSupport
          extended by com.atlassian.jira.web.action.JiraWebActionSupport
              extended by com.atlassian.jira.web.action.user.Logout
All Implemented Interfaces:
ErrorCollection, I18nHelper, java.io.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 interface com.atlassian.jira.util.I18nHelper
I18nHelper.BeanFactory
 
Field Summary
 
Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters
 
Fields inherited from class com.atlassian.jira.action.JiraActionSupport
log
 
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
 
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
Logout(LoginManager loginManager, XsrfInvocationChecker xsrfInvocationChecker, com.atlassian.seraph.service.rememberme.RememberMeService rememberMeService, JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 java.lang.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.
 java.lang.String doExecute()
          Logs the user out of JIRA and shows the log-out page.
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addErrorCollection, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, forceRedirect, getApplicationProperties, getAssignableUsers, getAssignableUsers, getCachedGroups, getComponentManager, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDescTranslation, getExternalLinkUtils, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getJiraServiceContext, getLanguage, getNameTranslation, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRandomHint, getRedirect, getRemoteUser, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getText, getTimeFormat, getUriValidator, getUserFullName, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasErrorMessage, hasErrorMessageByKey, htmlEncode, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, isInlineDialogMode, isSystemAdministrator, isUserExists, returnComplete, returnComplete, returnCompleteWithInlineRedirect, setConglomerateCookieValue, setInline, setReturnUrl, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, execute, getActionName, getDefaultResourceBundle, getDelegator, getKeysForPrefix, getLocale, getResult, getText, getText, getText, getText, getText, getText, getText, getText, getText0, getUnescapedText, getUserPreferences, getWatcherManager, hasAnyErrors, isEnterprise, isIndexing, isProfessional, isProfessionalOrEnterprise, isStandard, removeKeyOrAddError
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, doValidation, getCommandName, getErrorMessages, getErrors, 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 com.atlassian.jira.util.ErrorCollection
addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors, setErrorMessages
 
Methods inherited from interface webwork.action.CommandDriven
getCommandName, setCommand
 

Constructor Detail

Logout

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

doExecute

public java.lang.String doExecute()
Logs the user out of JIRA and shows the log-out page. For details of the logic behind the XSRF check see, JiraLogoutServlet.service(javax.servlet.http.HttpServletRequest, javax.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.

doDefault

public java.lang.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, JiraLogoutServlet.service(javax.servlet.http.HttpServletRequest, javax.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.


Copyright © 2002-2010 Atlassian. All Rights Reserved.