Package com.atlassian.confluence.pages.actions

Class PageInfoAction

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

com.atlassian.confluence.pages.actions.ViewPageAction

com.atlassian.confluence.pages.actions.PageInfoAction

All Implemented Interfaces:

Evented<ConfluenceEvent>, CommentAware, PageAware, TinyUrlAware, WebInterface, ContentDetailAction, 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 PageInfoAction
extends ViewPageAction
implements Evented<ConfluenceEvent>, ContentDetailAction

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 inherited from class com.atlassian.confluence.pages.actions.ViewPageAction

commentManager, DARK_FEATURE_CONFLUENCE_READABLE_URL, DARKFEATUE_CONFLUENCE_PAGE_READTIME, editRenderer, notificationManager, REQUEST_KEY_HELPER

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

incomingLinks, linkManager, pageManager, PREVIEW, RICHTEXT, viewRenderer, wysiwygConverter

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

Method Summary

Modifier and Type	Method	Description
String	execute()
PageChangesBean	getChangesSinceLastEdit()
PageChangesBean	getChangesSinceLastLogin()
ContentEntityObject	getDestinationContentEntity(OutgoingLink link)
ConfluenceEvent	getEventToPublish(String result)	Gets the event to publish.
Collection<OutgoingLink>	getExternalLinks()
Map<Space,Collection<SpaceContentEntityObject>>	getIncomingLinksBySpace()
com.google.common.collect.Multimap<Space,SpaceContentEntityObject>	getIncomingLinksMap()	Deprecated. since 7.0.1.
int	getInitialVisibleChildCount()
List<VersionHistorySummary>	getLatestChanges()	returns the last five versions/revisions of this current page (if they exist)
com.google.common.collect.Multimap<Space,SpaceContentEntityObject>	getOutgoingLinks()	Deprecated. since 7.0.1.
Map<Space,Collection<SpaceContentEntityObject>>	getOutgoingLinksBySpace()
boolean	isLatestVersionRequired()	If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.
boolean	isViewPermissionRequired()
String	renderUrlLink(OutgoingLink link)
void	setLinkResolver(com.atlassian.renderer.links.LinkResolver linkResolver)

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

getChildrenShowing, getCollaborativeEditingHelper, getComment, getCommentAsXHtmlForWysiwyg, getCommentId, getDateString, getEditingUser, getExternalReferences, getForwardLocation, getInheritedContentPermissions, getNotificationManager, getPageIdOfVersionAfter, getPageIdOfVersionBefore, getPageXHtmlContent, getParentPage, getReadTime, getRedirectLocation, getReplyToComment, getThisPagePermissions, getViewInheritedContentPermissionSets, getWebInterfaceContext, getWebInterfaceContext, getXHtmlComments, hasAnyPermissions, hasNextVersion, hasPreviousVersion, isChildrenNotShown, isEditComment, isNavigatingVersions, isPageRequired, isPermitted, isShowCommentArea, isThreadComments, isUserWatchingPage, isUserWatchingSpace, pageIsLatestVersionAndDoesNotHaveSpace, renderExternalLink, setCollaborativeEditingHelper, setComment, setCommentManager, setDarkFeaturesManager, setEditComment, setEditRenderer, setEstimatedReadTimeService, setNavigatingVersions, setNotificationManager, setReplyToComment, setShowChildren, setShowCommentArea, setThemeManager, setViewPageActionPathConverter, setXhtmlContent

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

displayDatePath, getAttachmentSourceContent, getAvailableSpaces, getBeanKey, getBlogPost, getEditorVersion, getHelper, getIncomingLinks, getLabels, getMode, getNextPost, getNumberOfAttachmentsAsString, getNumberOfLabelsAsString, getPermissionTypes, getPermittedChildren, getPostingDateAsDate, getPostingDay, getPostingTimeAsTime, getPreviousPost, getPreviousVersion, getSpaceManager, getSuggestedLabels, getTinyUrl, hasAttachFilePermissions, hasPermittedChildren, isSpaceAdmin, isSuperUser, isUserWatchingOwnContent, setConfluenceWysiwygConverter, setEditorManager, setLinkManager, setMode, setPageManager, setPostingDate, setPostingTime, setViewRenderer, validate

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

getCustomPageUrl, getPage, getPageId, getPageUrl, getSpace, getSpaceKey, getTitle, isCollaborativeContent, 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, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, 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, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale

Methods inherited from class java.lang.Object

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

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

Constructor Details

PageInfoAction

public PageInfoAction()

Method Details

execute

public String execute()
               throws Exception

Specified by:

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

Overrides:

execute in class ViewPageAction

Throws:

Exception

getEventToPublish

public ConfluenceEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<ConfluenceEvent>

Overrides:

getEventToPublish in class ViewPageAction

Parameters:

result - the result of the action executing.

Returns:

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

setLinkResolver

public void setLinkResolver(com.atlassian.renderer.links.LinkResolver linkResolver)

getIncomingLinksMap

@Deprecated
public com.google.common.collect.Multimap<Space,SpaceContentEntityObject> getIncomingLinksMap()

Deprecated.

since 7.0.1. Use getIncomingLinksBySpace()

getIncomingLinksBySpace

public Map<Space,Collection<SpaceContentEntityObject>> getIncomingLinksBySpace()

Since:

7.0.1

getOutgoingLinks

@Deprecated
public com.google.common.collect.Multimap<Space,SpaceContentEntityObject> getOutgoingLinks()

Deprecated.

since 7.0.1. Use getOutgoingLinksBySpace()

getOutgoingLinksBySpace

public Map<Space,Collection<SpaceContentEntityObject>> getOutgoingLinksBySpace()

Since:

7.0.1

getExternalLinks

public Collection<OutgoingLink> getExternalLinks()

renderUrlLink

public String renderUrlLink(OutgoingLink link)

getDestinationContentEntity

public ContentEntityObject getDestinationContentEntity(OutgoingLink link)

isLatestVersionRequired

public boolean isLatestVersionRequired()

Description copied from interface: PageAware

If the action can only work on the most recent version of a page, this will cause the interceptor to silently replace the version that it looks up with the most recent version, if necessary.

Specified by:

isLatestVersionRequired in interface PageAware

Overrides:

isLatestVersionRequired in class ViewPageAction

Returns:

true if the action requires the most recent version of a page

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface PageAware

Overrides:

isViewPermissionRequired in class ViewPageAction

Returns:

true if the action requires a check on the view page level permissions on this page

getChangesSinceLastEdit

public PageChangesBean getChangesSinceLastEdit()

getChangesSinceLastLogin

public PageChangesBean getChangesSinceLastLogin()

getLatestChanges

public List<VersionHistorySummary> getLatestChanges()

returns the last five versions/revisions of this current page (if they exist)

getInitialVisibleChildCount

public int getInitialVisibleChildCount()