com.atlassian.confluence.pages.actions
Class AbstractDiffPagesAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.pages.actions.AbstractPageAction
              com.atlassian.confluence.pages.actions.ViewPageAction
                  com.atlassian.confluence.pages.actions.AbstractDiffPagesAction

All Implemented Interfaces:

PageAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

DiffPagesAction, DiffPagesByVersionAction, ViewChangesSinceLastEditAction, ViewChangesSinceLastLoginAction

public abstract class AbstractDiffPagesAction
extends ViewPageAction

See Also:

Serialized Form

Field Summary

protected DiffResult	diff
protected AbstractPage	originalPage
protected WikiStyleRenderer	wikiStyleRenderer

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

HOT_REFERRERS_COUNT, notificationManager, referralManager

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

contentPermissionManager, expertView, incomingLinks, isXHtml, linkManager, MARKUP, pageManager, postingDay, PREVIEW, RICHTEXT, spaceManager, wysiwygConverter

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, log, permissionManager, permitted, 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

AbstractDiffPagesAction()

Method Summary

String	execute()
String	getDiff()
DiffResult	getDiffResult()
AbstractPage	getLatestVersion()
abstract AbstractPage	getOriginalPage()
AbstractPage	getRevisedPage()
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() If the action requires that the user needs viewPagePermissions, then it should return true to this method.
void	setWikiStyleRenderer(WikiStyleRenderer wikiStyleRenderer)

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

getAttachmentsWebDavUrl, getAttachmentsWebDavUrlForPage, getCalendarForThisMonth, getCaptchaManager, getChildrenShowing, getCommentsShowing, getDateString, getExternalReferences, getFirstPostInNextMonth, getFocusedCommentId, getHotReferrers, getInheritedContentPermissions, getLastPostInPreviousMonth, getNotificationManager, getPageContent, getPageIdOfVersionAfter, getPageIdOfVersionBefore, getPageXHtmlContent, getPossibleAlternativesElsewhere, getPossibleAlternativesInSpace, getReplyToComment, getRootComment, getTrackbackUtils, getWysiwygContent, getXHtmlComments, hasNextVersion, hasPreviousVersion, isAttachmentsInWebDavFolder, isFavouritePage, isNavigatingVersions, isPageRequired, isShowCommentArea, isThreadComments, isUserWatchingPage, isUserWatchingSpace, renderExternalLink, renderLink, setCaptchaManager, setFocusedCommentId, setNavigatingVersions, setNotificationManager, setPageContent, setReferralManager, setReplyToComment, setRootCommentId, setShowChildren, setShowCommentArea, setShowComments

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

extractPageTitle, extractSpaceKey, generateAncestryBreadcrumbs, getAvailableSpaces, getBeanKey, getBlogPost, getCaptchaId, getExpertView, getHelper, getIncomingLinks, getMARKUP, getMode, getNextPost, getPage, getPageId, getPermissionTypes, getPermittedChildren, getPostingDate, getPostingDay, getPostingDayOfMonth, getPostingMonth, getPostingMonthNumeric, getPostingYear, getPREVIEW, getPreviousPost, getRICHTEXT, getShowMarkup, getSpace, getSpaceKey, getSpaceManager, getSubscribableName, getSuggestedLabels, getSupportWysiwyg, getTinyUrl, getTitle, getUseWysiwyg, getXhtml, hasAttachFilePermissions, hasInvalidTitleCharacters, hasPermittedChildren, hasSetPagePermissionsPermission, hasViewPagePermission, isPermitted, isSpaceAdmin, setBreadcrumbsManager, setCaptchaId, setConfluenceWysiwygConverter, setContentPermissionManager, setLinkManager, setMode, setPage, setPageManager, setSpaceManager, setXhtml

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

addActionError, addPermissionTypeTo, addToHistory, doDefault, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEditorLanguage, getEventManager, getGlobalHelper, getGlobalSettings, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleString, getNiceContentType, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, 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.pages.actions.PageAware

getPage, setPage

Field Detail

originalPage

protected AbstractPage originalPage

diff

protected DiffResult diff

wikiStyleRenderer

protected WikiStyleRenderer wikiStyleRenderer

Constructor Detail

AbstractDiffPagesAction

public AbstractDiffPagesAction()

Method Detail

setWikiStyleRenderer

public void setWikiStyleRenderer(WikiStyleRenderer wikiStyleRenderer)

Overrides:

setWikiStyleRenderer in class ViewPageAction

getOriginalPage

public abstract AbstractPage getOriginalPage()

getRevisedPage

public AbstractPage getRevisedPage()

getLatestVersion

public AbstractPage getLatestVersion()

getDiff

public String getDiff()

getDiffResult

public DiffResult getDiffResult()

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class ViewPageAction

Throws:

Exception

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

Description copied from interface: PageAware

If the action requires that the user needs viewPagePermissions, then it should return true to this method. If the action requires viewPagePermissions, but the user does not have the viewPermission, the interceptor will redirect to 'pagenotpermitted' result

Specified by:

isViewPermissionRequired in interface PageAware

Overrides:

isViewPermissionRequired in class ViewPageAction

Returns:

true if the action requires viewPagePermissions to execute