com.atlassian.confluence.security.actions

Class AbstractPermissionsAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.security.actions.AbstractPermissionsAction

All Implemented Interfaces:

BootstrapAware, WebInterface, PermissionsAware, 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:

AbstractEditPermissionAction, AbstractGlobalPermissionsAction, AbstractSpacePermissionsAction, ViewGlobalPermissionsAction, ViewSpacePermissionDefaultsAction, ViewSpacePermissionsAction

public abstract class AbstractPermissionsAction
extends ConfluenceActionSupport
implements PermissionsAware, BootstrapAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PermissionRow	anonymousPermissionRow
protected Collection<PermissionRow>	groupPermissionRows Map of groupnames to DefaultPermissionsAdministrator.GroupPermissionRows.
protected PermissionsAdministratorBuilder	permissionsAdministratorBuilder
protected Collection<PermissionRow>	userPermissionRows Map of usernames to DefaultPermissionsAdministrator.UserPermissionRows.

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

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

Method Summary

Modifier and Type	Method and Description
void	bootstrap()
PermissionRow	getAnonymousPermissionRow() Retrieves the anonymous permissions row for printing in a UI.
Collection<PermissionRow>	getGroupPermissionRows() Gets the list of current DefaultPermissionsAdministrator.GroupPermissionRows for printing in a UI.
List<String>	getPermissions()
Map	getRequestParams() Returns the parameters of the request
PermissionRow	getUnlicensedAuthenticatedPermissionRow() Retrieves the unlicensed authenticated user permissions row for printing in a UI.
Collection<PermissionRow>	getUserPermissionRows() Gets the list of current DefaultPermissionsAdministrator.UserPermissionRows for printing in a UI.
boolean	isAdminUser()
boolean	isShowGlobalUnlicensedUsersUI() Show the permissions UI for unlicensed authenticated users if any global authenticated user permissions are present.
boolean	isValidAnonymousPermission(String permissionType) Check whether this space permission is allowed to be assigned to the 'anonymous' category.
boolean	isValidAuthenticatedUsersPermission(String permissionType) Check whether this space permission is allowed to be assigned to the 'authenticated users' category.
void	setPermissionsAdministratorBuilder(PermissionsAdministratorBuilder permissionsAdministratorBuilder)

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, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, 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, isPermitted, isPrintableVersion, isSharedMode, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

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

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

getGuardPermission, getPermissionsAdministrator, isSharedMode, populateAdministrator

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

validate

Field Detail

userPermissionRows

protected Collection<PermissionRow> userPermissionRows

Map of usernames to DefaultPermissionsAdministrator.UserPermissionRows.

groupPermissionRows

protected Collection<PermissionRow> groupPermissionRows

Map of groupnames to DefaultPermissionsAdministrator.GroupPermissionRows.

anonymousPermissionRow

protected PermissionRow anonymousPermissionRow

permissionsAdministratorBuilder

protected PermissionsAdministratorBuilder permissionsAdministratorBuilder

Constructor Detail

AbstractPermissionsAction

public AbstractPermissionsAction()

Method Detail

setPermissionsAdministratorBuilder

public void setPermissionsAdministratorBuilder(PermissionsAdministratorBuilder permissionsAdministratorBuilder)

getUserPermissionRows

public Collection<PermissionRow> getUserPermissionRows()

Gets the list of current DefaultPermissionsAdministrator.UserPermissionRows for printing in a UI.

Specified by:

getUserPermissionRows in interface PermissionsAware

Returns:

list of DefaultPermissionsAdministrator.UserPermissionRow

getGroupPermissionRows

public Collection<PermissionRow> getGroupPermissionRows()

Gets the list of current DefaultPermissionsAdministrator.GroupPermissionRows for printing in a UI.

Specified by:

getGroupPermissionRows in interface PermissionsAware

Returns:

list of DefaultPermissionsAdministrator.GroupPermissionRow

getUnlicensedAuthenticatedPermissionRow

public PermissionRow getUnlicensedAuthenticatedPermissionRow()

Description copied from interface: PermissionsAware

Retrieves the unlicensed authenticated user permissions row for printing in a UI.

Specified by:

getUnlicensedAuthenticatedPermissionRow in interface PermissionsAware

Returns:

the unlicensed authenticated user permissions.

getAnonymousPermissionRow

public PermissionRow getAnonymousPermissionRow()

Description copied from interface: PermissionsAware

Retrieves the anonymous permissions row for printing in a UI.

Specified by:

getAnonymousPermissionRow in interface PermissionsAware

Returns:

the anonymous permissions.

isValidAnonymousPermission

public boolean isValidAnonymousPermission(String permissionType)

Check whether this space permission is allowed to be assigned to the 'anonymous' category.

Parameters:

permissionType - a SpacePermission value

isValidAuthenticatedUsersPermission

public boolean isValidAuthenticatedUsersPermission(String permissionType)

Check whether this space permission is allowed to be assigned to the 'authenticated users' category.

Parameters:

permissionType - a SpacePermission value

getRequestParams

public Map getRequestParams()

Description copied from interface: PermissionsAware

Returns the parameters of the request

Specified by:

getRequestParams in interface PermissionsAware

Returns:

the parameters of the request

bootstrap

public void bootstrap()

Specified by:

bootstrap in interface BootstrapAware

isAdminUser

public boolean isAdminUser()

getPermissions

public List<String> getPermissions()

isShowGlobalUnlicensedUsersUI

public boolean isShowGlobalUnlicensedUsersUI()

Show the permissions UI for unlicensed authenticated users if any global authenticated user permissions are present.

Returns:

true if there are any permissions in the system for which SpacePermission.isAuthenticatedUsersPermission() returns true