Package com.atlassian.confluence.security.actions

Class EditSpacePermissionsAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.security.actions.AbstractPermissionsAction

com.atlassian.confluence.security.actions.AbstractEditPermissionAction

com.atlassian.confluence.security.actions.EditSpacePermissionsAction

All Implemented Interfaces:

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

public class EditSpacePermissionsAction
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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
EditSpacePermissionsAction()

Method Summary

Modifier and Type	Method	Description
String	doAddBrowseSpacePermission()	Space action specfic
String	doDisableAnyUserViewSpacePermission()
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()
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	populateAdministrator()
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, setGroupListToAdd, setGroupsToAdd, setSelectedGroup, setSelectedUsername, setUsersToAdd, validate

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

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

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, useSkipAccessCheck, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

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

getAnonymousPermissionRow, getGroupPermissionRows, getPermissionsAdministrator, getRequestParams, getUnlicensedAuthenticatedPermissionRow, getUserPermissionRows

Constructor Detail

EditSpacePermissionsAction

public EditSpacePermissionsAction()

Method Detail

doAddBrowseSpacePermission

public String doAddBrowseSpacePermission()

Space action specfic

doDisableAnyUserViewSpacePermission

public String doDisableAnyUserViewSpacePermission()

populateAdministrator

public void populateAdministrator()

Specified by:

populateAdministrator in interface PermissionsAware

execute

public String execute()
               throws Exception

Description copied from interface: EditPermissionsAware

Add and remove the permissions

Specified by:

execute in interface com.opensymphony.xwork2.Action

Specified by:

execute in interface EditPermissionsAware

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Returns:

SUCCESS if completed

Throws:

Exception

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.

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

getGuardPermission

public 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 Space getSpace()

Specified by:

getSpace in interface Spaced

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface SpaceAware

Returns:

true if the action requires view space permission

isSpaceRequired

public 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 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 String getKey()

setKey

public void setKey(String key)

setThemeManager

public void setThemeManager(ThemeManager themeManager)

getThemeManager

public ThemeManager getThemeManager()

hasSpaceSideBar

public boolean hasSpaceSideBar()

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

Returns:

true if the space bar is present.