com.atlassian.confluence.security.actions

Class AbstractEditSpacePermissionsAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.security.actions.AbstractPermissionsAction

com.atlassian.confluence.security.actions.AbstractEditPermissionAction

com.atlassian.confluence.security.actions.AbstractEditSpacePermissionsAction

All Implemented Interfaces:

Evented<SpacePermissionsUpdateEvent>, BootstrapAware, WebInterface, EditPermissionsAware, PermissionsAware, SpaceAdministrative, SpaceAware, Spaced, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

EditAddOnSpacePermissionsAction, EditSpacePermissionsAction

public abstract class AbstractEditSpacePermissionsAction
extends AbstractEditPermissionAction
implements EditPermissionsAware, SpaceAware, SpaceAdministrative, Spaced, Evented<SpacePermissionsUpdateEvent>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.security.actions.AbstractEditPermissionAction

permissionsAdministrator, selectedGroup, selectedUsername

Fields inherited from class com.atlassian.confluence.security.actions.AbstractPermissionsAction

anonymousPermissionRow, groupPermissionRows, permissionsAdministratorBuilder, userPermissionRows

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

CANCEL, contentUiSupport, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, userHistoryManager, 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

Constructors

Constructor and Description
AbstractEditSpacePermissionsAction()

Method Summary

Modifier and Type	Method and Description
String	execute() Add and remove the permissions
SpacePermissionsUpdateEvent	getEventToPublish(String result) Gets the event to publish.
String	getGuardPermission() Obtains the relevant guard permission for the action
String	getKey()
String	getSelectedSpaceToolsTab()
Space	getSpace()
ThemeManager	getThemeManager()
boolean	hasSpaceSideBar() Tells whether the page has a Space IA bar on the left.
boolean	isPermitted()
boolean	isSpaceRequired() If the action requires that the space be set before being run, then it should return true to this method.
boolean	isViewPermissionRequired()
void	setKey(String key)
void	setSpace(Space space) IOC method for setting the space on the action.
void	setSpaceManager(SpaceManager spaceManager)
void	setThemeManager(ThemeManager themeManager)

Methods inherited from class com.atlassian.confluence.security.actions.AbstractEditPermissionAction

executeAction, getGroupsToAddAsList, getPermissionsAdministrator, getSelectedGroup, getSelectedUsername, getUsersToAddAsList, setGroupsToAdd, setSelectedGroup, setSelectedUsername, setUsersToAdd, validate

Methods inherited from class com.atlassian.confluence.security.actions.AbstractPermissionsAction

bootstrap, getAnonymousPermissionRow, getGroupPermissionRows, getPermissions, getRequestParams, getSpacePermissionHeaders, getUnlicensedAuthenticatedPermissionRow, getUserPermissionRows, isAdminUser, isAllowPerUserGlobalPermissionCreation, isLicensingPermissionManagedByUM, isShowGlobalUnlicensedUsersUI, isValidAnonymousPermission, isValidAuthenticatedUsersPermission, setPermissionsAdministratorBuilder

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendAssetsManager, getFrontEndDarkFeatureHelper, getFrontendFragment, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSpaCacheManager, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, isVertigo, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setFrontendAssetsManager, setFrontEndDarkFeatureHelper, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSkipAccessCheck, setSpaCacheManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setUserHistoryManager, setWebInterfaceManager, useSpaCreatePage, useSpaCreatePage

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.security.actions.EditPermissionsAware

getGroupsToAddAsList, getSelectedGroup, getSelectedUsername, getUsersToAddAsList, setGroupsToAdd, setSelectedGroup, setSelectedUsername, setUsersToAdd, validate

Methods inherited from interface com.atlassian.confluence.security.actions.PermissionsAware

getAnonymousPermissionRow, getGroupPermissionRows, getPermissionsAdministrator, getRequestParams, getUnlicensedAuthenticatedPermissionRow, getUserPermissionRows, isSharedMode, populateAdministrator

Constructor Detail

AbstractEditSpacePermissionsAction

public AbstractEditSpacePermissionsAction()

Method Detail

execute

public final String execute()
                     throws Exception

Description copied from interface: EditPermissionsAware

Add and remove the permissions

Specified by:

execute in interface EditPermissionsAware

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Returns:

SUCCESS if completed

Throws:

Exception

setSpaceManager

public final void setSpaceManager(SpaceManager spaceManager)

isPermitted

public final boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

getGuardPermission

public final String getGuardPermission()

Description copied from interface: PermissionsAware

Obtains the relevant guard permission for the action

Specified by:

getGuardPermission in interface PermissionsAware

Returns:

the relevant guard permission for the action

getSpace

public final Space getSpace()

Specified by:

getSpace in interface Spaced

isViewPermissionRequired

public final boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface SpaceAware

Returns:

true if the action requires view space permission

isSpaceRequired

public final boolean isSpaceRequired()

Description copied from interface: SpaceAware

If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isSpaceRequired in interface SpaceAware

Returns:

true if the action requires a space in order to execute

setSpace

public final void setSpace(Space space)

Description copied from interface: SpaceAware

IOC method for setting the space on the action. This is called from the interceptor

Specified by:

setSpace in interface SpaceAware

Parameters:

space - the space that the action will be working on.

getKey

public final String getKey()

setKey

public final void setKey(String key)

setThemeManager

public final void setThemeManager(ThemeManager themeManager)

getThemeManager

public final ThemeManager getThemeManager()

hasSpaceSideBar

public final boolean hasSpaceSideBar()

Tells whether the page has a Space IA bar on the left.

Returns:

true if the space bar is present.

getEventToPublish

public SpacePermissionsUpdateEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<SpacePermissionsUpdateEvent>

Parameters:

result - the result of the action executing.

Returns:

the event. Can be null, in which case no event will be published.

getSelectedSpaceToolsTab

public String getSelectedSpaceToolsTab()