Package com.atlassian.confluence.pages.actions

Class ChildrenAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

com.atlassian.confluence.pages.actions.ChildrenAction

All Implemented Interfaces:

JSONAction, PageAware, WebInterface, 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

Direct Known Subclasses:

PageChildrenAction

public class ChildrenAction
extends AbstractPageAwareAction
implements SpaceAware, JSONAction

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PageManager	pageManager

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

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

Method Summary

Modifier and Type	Method	Description
String	execute()
String	getJSONString()
List<Page>	getPermittedChildren()
Space	getSpace()
boolean	hasPermittedChildren(Page page)
protected boolean	isEditingPermitted()
boolean	isPageRequired()	If the action requires that the page be set before being run, then it should return true to this method.
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.
void	setContentPermissionManager(ContentPermissionManagerInternal contentPermissionManager)
void	setNode(String node)
void	setPageManager(PageManager pageManager)
void	setPermissionCheckExemptions(PermissionCheckExemptions permissionCheckExemptions)
void	setSpace(Space space)	IOC method for setting the space on the action.

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

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

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

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

isEditPermissionRequired

Methods inherited from interface com.atlassian.confluence.spaces.actions.SpaceAware

isViewPermissionRequired

Field Details

pageManager

protected PageManager pageManager

Constructor Details

ChildrenAction

public ChildrenAction()

Method Details

setPageManager

public void setPageManager(PageManager pageManager)

getPermittedChildren

public List<Page> getPermittedChildren()

hasPermittedChildren

public boolean hasPermittedChildren(Page page)

setPermissionCheckExemptions

public void setPermissionCheckExemptions(PermissionCheckExemptions permissionCheckExemptions)

execute

public String execute()

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class org.apache.struts2.ActionSupport

setNode

public void setNode(String node)

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

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

Overrides:

getSpace in class AbstractPageAwareAction

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.

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

getJSONString

public String getJSONString()

Specified by:

getJSONString in interface JSONAction

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class AbstractPageAwareAction

isEditingPermitted

protected boolean isEditingPermitted()

setContentPermissionManager

public void setContentPermissionManager(ContentPermissionManagerInternal contentPermissionManager)