Package com.atlassian.confluence.user.actions

Class RemoveUserAction

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.RemoveUserAction

All Implemented Interfaces:

WebInterface, ExternalUserManagementAware, 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

public class RemoveUserAction
extends AbstractUsersAction
implements ExternalUserManagementAware

Action for removing a user. This gets quite complicated as we have to make sure the user really is able to be removed.

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.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
RemoveUserAction()

Method Summary

Modifier and Type	Method	Description
String	doDefault()	Convenient Action execution method which defaults to returning INPUT
String	execute()
@Nullable String	getPersonalSpaceKey()	Returns the key of the user's personal space if that space exists.
String	getTaskId()
List	getUserCommentedSpaces()	Deprecated. since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getSpacesContainingCommentsBy(String) instead.
List<String>	getUserContentCleanupInformation()	A human-readable list of content that will be removed or modified by the deletion of this user.
List	getUserEditedSpaces()	Deprecated. since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getSpacesContainingPagesEditedBy(String) instead.
List	getUserOwnedSpaces()	Deprecated. since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getAuthoredSpacesByUser(String) instead.
boolean	hasPersonalSpace()
boolean	isUserRemovable()
void	setSpaceManager(SpaceManager spaceManager)

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

getRemoteUsername, getUrlEncodeUsername, getUser, getUserKey, getUsername, isLicensedToAddMoreUsers, isPermitted, 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, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

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

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

Constructor Details

RemoveUserAction

public RemoveUserAction()

Method Details

doDefault

public String doDefault()
                 throws Exception

Description copied from class: ConfluenceActionSupport

Convenient Action execution method which defaults to returning INPUT

Overrides:

doDefault in class ConfluenceActionSupport

Throws:

Exception

execute

public String execute()
               throws Exception

Specified by:

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

Overrides:

execute in class org.apache.struts2.ActionSupport

Throws:

Exception

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

isUserRemovable

public boolean isUserRemovable()

hasPersonalSpace

public boolean hasPersonalSpace()

getPersonalSpaceKey

public @Nullable String getPersonalSpaceKey()

Returns the key of the user's personal space if that space exists. Returns null if the user has no personal space.

getUserOwnedSpaces

@Deprecated
public List getUserOwnedSpaces()

Deprecated.

since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getAuthoredSpacesByUser(String) instead.

Returns:

list of spaces that the user to be removed has edited content in, excluding the user's personal space, if one exists

getUserEditedSpaces

@Deprecated
public List getUserEditedSpaces()

Deprecated.

since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getSpacesContainingPagesEditedBy(String) instead.

getUserCommentedSpaces

@Deprecated
public List getUserCommentedSpaces()

Deprecated.

since 6.13.0 Use com.atlassian.confluence.spaces.SpaceManager#getSpacesContainingCommentsBy(String) instead.

getTaskId

public String getTaskId()

getUserContentCleanupInformation

public List<String> getUserContentCleanupInformation()

A human-readable list of content that will be removed or modified by the deletion of this user.

Returns:

a list of i18n'd strings listing the consequences of removing this user.