Package com.atlassian.confluence.user.actions

Class LoginAction

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.AbstractUsersAction

com.atlassian.confluence.user.actions.AbstractLoginSignupAction

com.atlassian.confluence.user.actions.LoginAction

All Implemented Interfaces:

WebInterface, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.Validateable

Direct Known Subclasses:

NotPermittedAction

public class LoginAction
extends AbstractLoginSignupAction

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter

Field Summary

Fields inherited from class com.atlassian.confluence.user.actions.AbstractLoginSignupAction

loginPageFunctionalityService, os_destination, signupManager, token, upgradeManager

Fields inherited from class com.atlassian.confluence.user.actions.AbstractUsersAction

personService, user, userKey, username

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
LoginAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	execute()	On successful login, redirection will be handled by the LoginFilter based on os_destination or the original URL stored in the session
Map<String,Object>	getLoginActionViewDataMappings()
org.apache.velocity.app.FieldMethodizer	getLoginFilter()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.4, no replacement.
String	getOs_username()
boolean	isElevatedSecurityCheckRequired()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
boolean	isShowForgottenPasswordHelp()
void	setHttpContext(HttpContext httpContext)
void	setOs_username(String os_username)
void	validate()

Methods inherited from class com.atlassian.confluence.user.actions.AbstractLoginSignupAction

commonActionViewDataMappings, getCaptchaManager, getClusterManager, getCurrentYearAsString, getLanguage, getLanguages, getOs_destination, getSignupManager, getSignupURL, getToken, getUpgradeManager, isBrowserLanguageEnabled, isFromNotPermitted, isLogout, isMobileAppWebView, isShowSignUp, refineOsDestination, setCaptchaManager, setClusterManager, setDarkFeaturesManager, setFromNotPermitted, setLanguage, setLoginPageFunctionalityService, setLogout, setOs_destination, setSignupManager, setToken, setUpgradeManager, setWritableDirectoryExistsCriteria, shouldRememberMeCheckboxBeOmitted, shouldShowMobileBanner

Methods inherited from class com.atlassian.confluence.user.actions.AbstractUsersAction

getRemoteUsername, getUrlEncodeUsername, getUser, getUserKey, getUsername, isLicensedToAddMoreUsers, setApiPersonService, setUserKey, setUsername

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getCurrentRequest, getCurrentResponse, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSkipIsPermitted, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermitted

Methods inherited from class com.atlassian.confluence.core.AbstractI18nActionSupport

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

LoginAction

public LoginAction()

Method Details

getLoginActionViewDataMappings

public Map<String,Object> getLoginActionViewDataMappings()

doDefault

@XsrfProtectionExcluded
public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class AbstractLoginSignupAction

Throws:

Exception

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface org.apache.struts2.Validateable

Overrides:

validate in class org.apache.struts2.ActionSupport

execute

@XsrfProtectionExcluded
public String execute()
               throws Exception

On successful login, redirection will be handled by the LoginFilter based on os_destination or the original URL stored in the session

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class org.apache.struts2.ActionSupport

Throws:

Exception

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class AbstractUsersAction

getLoginFilter

@Deprecated(forRemoval=true)
public org.apache.velocity.app.FieldMethodizer getLoginFilter()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.4, no replacement.

getOs_username

public String getOs_username()

setOs_username

public void setOs_username(String os_username)

isShowForgottenPasswordHelp

public boolean isShowForgottenPasswordHelp()

setHttpContext

public void setHttpContext(HttpContext httpContext)

isElevatedSecurityCheckRequired

public boolean isElevatedSecurityCheckRequired()