Package com.atlassian.confluence.pages.actions

Class SetPagePermissionsAction

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

com.atlassian.confluence.pages.actions.SetPagePermissionsAction

All Implemented Interfaces:

Beanable, PageAware, WebInterface, 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 SetPagePermissionsAction
extends AbstractPageAwareAction
implements Beanable

Called for a existing Page via AJAX, sets new ContentPermissions for the Page, overwriting any existing ones.

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

Modifier and Type	Field	Description
protected Map<String,Object>	bean

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

contentPermissionManager, spaceManager

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

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getBean()
List<String>	getEditPermissionsGroupList()
List<String>	getEditPermissionsUserList()
List<String>	getViewPermissionsGroupList()
List<String>	getViewPermissionsUserList()
boolean	isPageRequired()	If the action requires that the page be set before being run, then it should return true to this method.
void	setContentEntityManager(ContentEntityManager contentEntityManager)
void	setContentId(long contentId)
String	setContentPermissions()
void	setContentPermissionTester(ContentPermissionTester contentPermissionTester)
void	setEditPermissionsGroupList(List<String> editPermissionsGroupList)
void	setEditPermissionsGroups(String editPermissionsGroups)
void	setEditPermissionsUserList(List<String> editPermissionsUserList)
void	setEditPermissionsUsers(String editPermissionsUsers)
String	setPagePermissions()
void	setViewPermissionsGroupList(List<String> viewPermissionsGroupList)
void	setViewPermissionsGroups(String viewPermissionsGroups)
void	setViewPermissionsUserList(List<String> viewPermissionsUserList)
void	setViewPermissionsUsers(String viewPermissionsUsers)

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPageAwareAction

getCustomPageUrl, getPage, getPageId, getPageUrl, getSpace, getSpaceKey, getTitle, isCollaborativeContent, isLatestVersionRequired, isPermitted, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, 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, 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 org.apache.struts2.action.Action

execute

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

validate

Methods inherited from interface com.atlassian.confluence.pages.actions.PageAware

isEditPermissionRequired

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

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

Field Details

bean

protected Map<String,Object> bean

Constructor Details

SetPagePermissionsAction

public SetPagePermissionsAction()

Method Details

setPagePermissions

public String setPagePermissions()
                          throws Exception

Throws:

Exception

setContentPermissions

public String setContentPermissions()
                             throws Exception

Throws:

Exception

getBean

public Map<String,Object> getBean()

Specified by:

getBean in interface Beanable

isPageRequired

public boolean isPageRequired()

Description copied from interface: PageAware

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

Specified by:

isPageRequired in interface PageAware

Overrides:

isPageRequired in class AbstractPageAwareAction

Returns:

true if the action requires a page in order to execute

setViewPermissionsGroups

public void setViewPermissionsGroups(String viewPermissionsGroups)

setViewPermissionsUsers

public void setViewPermissionsUsers(String viewPermissionsUsers)

setEditPermissionsGroups

public void setEditPermissionsGroups(String editPermissionsGroups)

setEditPermissionsUsers

public void setEditPermissionsUsers(String editPermissionsUsers)

setContentEntityManager

public void setContentEntityManager(ContentEntityManager contentEntityManager)

setContentId

public void setContentId(long contentId)

getViewPermissionsGroupList

public List<String> getViewPermissionsGroupList()

setViewPermissionsGroupList

public void setViewPermissionsGroupList(List<String> viewPermissionsGroupList)

getEditPermissionsGroupList

public List<String> getEditPermissionsGroupList()

setEditPermissionsGroupList

public void setEditPermissionsGroupList(List<String> editPermissionsGroupList)

getViewPermissionsUserList

public List<String> getViewPermissionsUserList()

setViewPermissionsUserList

public void setViewPermissionsUserList(List<String> viewPermissionsUserList)

getEditPermissionsUserList

public List<String> getEditPermissionsUserList()

setEditPermissionsUserList

public void setEditPermissionsUserList(List<String> editPermissionsUserList)

setContentPermissionTester

public void setContentPermissionTester(ContentPermissionTester contentPermissionTester)

Since:

9.2.6