com.atlassian.confluence.pages.actions

Class AbstractDiffPagesAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.AbstractPageAwareAction

com.atlassian.confluence.pages.actions.AbstractDiffPagesAction

All Implemented Interfaces:

PageAware, TinyUrlAware, WebInterface, 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:

DiffPagesAction, DiffPagesByVersionAction, ViewChangesSinceLastEditAction, ViewChangesSinceLastLoginAction

public abstract class AbstractDiffPagesAction
extends AbstractPageAwareAction
implements TinyUrlAware

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	diff
protected AbstractPage	originalPage
protected PageManager	pageManager

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

contentPermissionManager, spaceManager

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

Method Summary

Modifier and Type	Method and Description
String	execute()
String	getDiff()
AbstractPage	getLatestVersion()
abstract AbstractPage	getOriginalPage()
long	getPageIdOfVersionAfter(AbstractPage page)
long	getPageIdOfVersionBefore(AbstractPage page)
List<VersionHistorySummary>	getPreviousVersions() Required when an error occurs.
AbstractPage	getRevisedPage()
String	getTinyUrl()
boolean	hasNextVersion(AbstractPage page)
boolean	hasPreviousVersion(AbstractPage page)
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	isPermitted()
boolean	isRevertPermitted() Required when an error occurs.
boolean	isViewPermissionRequired()
void	setHtmlDiffer(Differ differ)
void	setPageManager(PageManager pageManager)

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

getFriendlyDateFormatterHelper, getPage, getPageId, getSpace, getSpaceKey, getTitle, hasViewPagePermission, isPageRequired, setContentPermissionManager, setPage, setSpaceManager

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, 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, 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, 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.validation.MessageHolderAware

validate

Field Detail

originalPage

protected AbstractPage originalPage

diff

protected String diff

pageManager

protected PageManager pageManager

Constructor Detail

AbstractDiffPagesAction

public AbstractDiffPagesAction()

Method Detail

setPageManager

public void setPageManager(PageManager pageManager)

getPreviousVersions

public List<VersionHistorySummary> getPreviousVersions()

Required when an error occurs.

isRevertPermitted

public boolean isRevertPermitted()

Required when an error occurs.

getOriginalPage

public abstract AbstractPage getOriginalPage()

getRevisedPage

public AbstractPage getRevisedPage()

getLatestVersion

public AbstractPage getLatestVersion()

getDiff

public String getDiff()

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

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 AbstractPageAwareAction

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 AbstractPageAwareAction

Returns:

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

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class AbstractPageAwareAction

getPageIdOfVersionAfter

public long getPageIdOfVersionAfter(AbstractPage page)

getPageIdOfVersionBefore

public long getPageIdOfVersionBefore(AbstractPage page)

hasPreviousVersion

public boolean hasPreviousVersion(AbstractPage page)

hasNextVersion

public boolean hasNextVersion(AbstractPage page)

getTinyUrl

public String getTinyUrl()

Specified by:

getTinyUrl in interface TinyUrlAware

setHtmlDiffer

public void setHtmlDiffer(Differ differ)