Package com.atlassian.confluence.pages.actions

Class PageNotFoundAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.pages.actions.PageNotFoundAction

All Implemented Interfaces:

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

public class PageNotFoundAction
extends ConfluenceActionSupport
implements Spaced

Redirect to this action if you ever find yourself in a "page not found" situation, it deals with possible alternative pages, and so on.

See Also:

• Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
String	execute()	Tries to find a potential match for the missing page, and if found sets status to 404 and return SUCCESS to show the possible pages.
List<AbstractPage>	getPossibleAlternativesElsewhere()
List<AbstractPage>	getPossibleAlternativesInSpace()
List<AbstractPage>	getPossibleAlternativesInSpaceSearch()
List<AbstractPage>	getPossibleAlternativesInTrash()
Space	getSpace()
String	getSpaceKey()
ThemeManager	getThemeManager()
String	getTitle()
boolean	isSpaceAdminUser()
void	setPageManager(PageManager pageManager)
void	setSpaceKey(String spaceKey)
void	setSpaceManager(SpaceManager spaceManager)
void	setThemeManager(ThemeManager themeManager)
void	setTitle(String title)
void	setXhtmlSummariser(Summariser xhtmlSummariser)
String	stripToPlainText(String html)	Strip a supplied String of HTML, removing tags and making it suitable for display as a summary.

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

Constructor Details

PageNotFoundAction

public PageNotFoundAction()

Method Details

getSpaceKey

public String getSpaceKey()

setSpaceKey

public void setSpaceKey(String spaceKey)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setPageManager

public void setPageManager(PageManager pageManager)

setThemeManager

public void setThemeManager(ThemeManager themeManager)

getThemeManager

public ThemeManager getThemeManager()

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

execute

@XsrfProtectionExcluded
public String execute()
               throws IOException

Tries to find a potential match for the missing page, and if found sets status to 404 and return SUCCESS to show the possible pages. Otherwise, return ERROR to delegate to FourOhFourAction.

Specified by:

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

Overrides:

execute in class org.apache.struts2.ActionSupport

Throws:

IOException

getPossibleAlternativesElsewhere

public List<AbstractPage> getPossibleAlternativesElsewhere()

getPossibleAlternativesInSpace

public List<AbstractPage> getPossibleAlternativesInSpace()

getPossibleAlternativesInTrash

public List<AbstractPage> getPossibleAlternativesInTrash()

getPossibleAlternativesInSpaceSearch

public List<AbstractPage> getPossibleAlternativesInSpaceSearch()

isSpaceAdminUser

public boolean isSpaceAdminUser()

stripToPlainText

public String stripToPlainText(String html)

Strip a supplied String of HTML, removing tags and making it suitable for display as a summary. The string will be truncated to a maximum of 255 characters.

Parameters:

html -

Returns:

a summary of the supplied html parameter

setXhtmlSummariser

public void setXhtmlSummariser(Summariser xhtmlSummariser)