com.atlassian.confluence.pages.actions
Class PageNotPermittedAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.pages.actions.PageNotPermittedAction

All Implemented Interfaces:

PageAware, WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, java.io.Serializable

public class PageNotPermittedAction
extends ConfluenceActionSupport
implements PageAware

See Also:

Serialized Form

Field Summary

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

PageNotPermittedAction()

Method Summary

java.lang.String	execute()
java.lang.String	getLoginUrl()
java.lang.String	getOriginalurl() Deprecated. since 5.2.1. No longer required for getLoginUrl to be expanded correctly.
AbstractPage	getPage()
long	getPageId()
PageManager	getPageManager()
java.lang.String	getSpaceKey()
java.lang.String	getTitle()
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	isPageRequired() If the action requires that the page be set before being run, then it should return true to this method.
boolean	isPermitted()
boolean	isPermittedToViewCurrentPage()
boolean	isRequestAccessPluginEnabled()
boolean	isViewPermissionRequired()
void	setPage(AbstractPage page) IOC method for setting the page on the action.
void	setPageId(long pageId)
void	setPageManager(PageManager pageManager)
void	setSpaceKey(java.lang.String spaceKey)
void	setTitle(java.lang.String pageTitle)

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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

Constructor Detail

PageNotPermittedAction

public PageNotPermittedAction()

Method Detail

execute

public java.lang.String execute()
                         throws java.io.IOException

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

java.io.IOException

getPageId

public long getPageId()

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class ConfluenceActionSupport

setPageId

public void setPageId(long pageId)

getPage

public AbstractPage getPage()

Specified by:

getPage in interface PageAware

Returns:

page the page that the action worked on

setPage

public void setPage(AbstractPage page)

Description copied from interface: PageAware

IOC method for setting the page on the action. This is called from the interceptor

Specified by:

setPage in interface PageAware

Parameters:

page - the page that the action will be working on.

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

Returns:

true if the action requires a page in order to execute

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

Returns:

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

isViewPermissionRequired

public boolean isViewPermissionRequired()

Specified by:

isViewPermissionRequired in interface PageAware

Returns:

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

isPermittedToViewCurrentPage

public boolean isPermittedToViewCurrentPage()

Returns:

true if the content permissions that are set on the current page allow the logged in user to view the page. This also returns true if there are no view content permissions set on the page.

isRequestAccessPluginEnabled

public boolean isRequestAccessPluginEnabled()

getOriginalurl

@Deprecated
public java.lang.String getOriginalurl()

Deprecated. since 5.2.1. No longer required for getLoginUrl to be expanded correctly.

getLoginUrl

public java.lang.String getLoginUrl()

getPageManager

public PageManager getPageManager()

setPageManager

public void setPageManager(PageManager pageManager)

getSpaceKey

public java.lang.String getSpaceKey()

setSpaceKey

public void setSpaceKey(java.lang.String spaceKey)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String pageTitle)