com.atlassian.bamboo.rest
Class Logout

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.bamboo.ww2.BambooActionSupport
          com.atlassian.bamboo.rest.Logout

All Implemented Interfaces:

ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, RestActionAware, ReturnUrlAware, com.atlassian.core.i18n.I18nTextProvider, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class Logout
extends BambooActionSupport
implements RestActionAware

This class logs a remote user out from their session.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

BambooActionSupport.JSONStatus

Field Summary

Fields inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

administrationConfigurationManager, AGGREGATE_URL_PATTERN, bambooPermissionManager, bambooUserManager, BUILD_KEY_CONTEXT, buildDefinitionManager, CONFIRM, cookieCutter, dashboardCachingManager, PLAN_KEY_CONTEXT, planExecutionManager, planManager, projectManager, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Logout()

Method Summary

java.lang.String	doExecute() Logout the user from the session
java.lang.String	getAuth()
void	setAuth(java.lang.String auth)

Methods inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

addActionError, addError, addError, addErrorCollection, addErrorMessage, addErrorMessage, addErrorMessages, addErrors, addIllegalArgumentException, areCheckBoxesEmpty, buildJsonObject, buildWebPanelContext, checkFieldXssSafety, createFieldValidator, doDefault, doesHelpLinkHaveMatchingTitle, doesLabelKeyHaveMatchingDescription, execute, getAdministrationConfiguration, getBamboo, getBambooLicenseManager, getBambooPermissionManager, getBambooSession, getBambooUserManager, getBaseUrl, getBootstrapManager, getBreadCrumbs, getChainEquiv, getConcurrentBuildsEnabled, getConglomerateCookieValue, getCookieCutter, getCookieValue, getCurrentFormTheme, getCurrentSystemTime, getCurrentUrl, getDefaultPersister, getDescriptionFromLabelKey, getFlushedErrorMessages, getFormattedActionErrors, getFormattedActionMessages, getFormattedErrorMessages, getInstanceName, getJobEquiv, getJsonObject, getNavigationContext, getNavigationUrl, getNumberOfCurrentlyBuildingPlans, getPlan, getPlanManager, getPluginAccessor, getReturnUrl, getSecuredDomainObject, getServerLifecycleState, getSessionUser, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, getTextWithArgs, getTotalErrors, getUser, getValidatorContext, getWebFragmentsContextMap, getWebItemsForSection, getWebPanelContext, getWebSectionsForLocation, hasAdminPermission, hasAnyErrors, hasBuilds, hasGlobalAdminPermission, hasGlobalPermission, hasKey, hasPlanPermission, hasPlanPermission, hasRestrictedAdminPermission, isCheckboxSetInAction, isEnableJavascript, isEnableSignup, isInlineDialog, isRestrictedAdminEnabled, isSelectFieldAndNull, renderFreemarkerTemplate, setAdministrationConfigurationManager, setAuthenticationContext, setBambooLicenseManager, setBambooPermissionManager, setBambooUserManager, setBuildDefinitionManager, setChainEquiv, setCheckBoxFields, setCookieCutter, setCurrentFormTheme, setDashboardCachingManager, setDecorator, setEnableJavascript, setErrorMessages, setI18nBeanFactory, setJobEquiv, setNavigationContext, setPlanExecutionManager, setPlanManager, setPluginAccessor, setProfile, setProjectManager, setReturnUrl, setServerLifecycleProvider, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, pause, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.utils.error.ErrorCollection

getErrorMessages, getErrors, getFieldErrors

Constructor Detail

Logout

public Logout()

Method Detail

doExecute

public java.lang.String doExecute()
                           throws java.lang.Exception

Logout the user from the session

Overrides:

doExecute in class BambooActionSupport

Returns:

the webwork error status

Throws:

java.lang.Exception - A generic failure

getAuth

public java.lang.String getAuth()

setAuth

public void setAuth(java.lang.String auth)