Package com.atlassian.confluence.security.actions

Class ViewSpacePermissionsAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.security.actions.AbstractPermissionsAction

com.atlassian.confluence.security.actions.ViewSpacePermissionsAction

All Implemented Interfaces:

Evented<SpacePermissionsViewEvent>, BootstrapAware, WebInterface, PermissionsAware, SpaceAdministrative, SpaceAware, Spaced, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

public class ViewSpacePermissionsAction
extends AbstractPermissionsAction
implements SpaceAware, SpaceAdministrative, Spaced, Evented<SpacePermissionsViewEvent>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ThemeManager	themeManager

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, 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
ViewSpacePermissionsAction()

Method Summary

Modifier and Type	Method	Description
SpacePermissionsViewEvent	getEventToPublish(String result)	Gets the event to publish.
String	getGuardPermission()	Obtains the relevant guard permission for the action
String	getKey()
PermissionsAdministrator	getPermissionsAdministrator()
Space	getSpace()
ThemeManager	getThemeManager()
boolean	isAnonymousSpacePermissionWithoutGlobalPermission()
boolean	isAnyUserViewSpacePermissionEnabled()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
boolean	isSpaceRequired()	If the action requires that the space be set before being run, then it should return true to this method.
boolean	isUnlicensedGlobalPermissionEnabled()
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.AbstractPermissionsAction

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

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, 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, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

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, execute, 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

Field Details

themeManager

protected ThemeManager themeManager

Constructor Details

ViewSpacePermissionsAction

public ViewSpacePermissionsAction()

Method Details

getEventToPublish

public SpacePermissionsViewEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<SpacePermissionsViewEvent>

Parameters:

result - the result of the action executing.

Returns:

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

getPermissionsAdministrator

public PermissionsAdministrator getPermissionsAdministrator()

Specified by:

getPermissionsAdministrator in interface PermissionsAware

populateAdministrator

public void populateAdministrator()

Specified by:

populateAdministrator in interface PermissionsAware

isAnonymousSpacePermissionWithoutGlobalPermission

public boolean isAnonymousSpacePermissionWithoutGlobalPermission()

isAnyUserViewSpacePermissionEnabled

public boolean isAnyUserViewSpacePermissionEnabled()

isUnlicensedGlobalPermissionEnabled

public boolean isUnlicensedGlobalPermissionEnabled()

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

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