com.atlassian.confluence.pages.actions

Class ListUndefinedPagesAction

java.lang.Object

com.opensymphony.xwork.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.pages.actions.AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>

com.atlassian.confluence.pages.actions.ListUndefinedPagesAction

All Implemented Interfaces:

Evented<PageListViewEvent>, PaginationServiceSupportActionAware, WebInterface, SpaceAware, Spaced, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

public class ListUndefinedPagesAction
extends AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>
implements Evented<PageListViewEvent>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListUndefinedPagesAction.CacheableUndefinedLinksResult
static class	ListUndefinedPagesAction.UndefinedPage

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cachingEnablingItemNumber
protected int	cachingEnablingTimeout

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

ITEMS_PER_PAGE, paginationSupport

Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

key, notificationManager, space, spaceManager, themeManager, wikiStyleRenderer

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

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, 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
ListUndefinedPagesAction()

Method Summary

Modifier and Type	Method and Description
protected List<ListUndefinedPagesAction.UndefinedPage>	cacheResult(long cachingEnablingTimeout, int cachingEnablingItemNumber, long currentTime, Supplier<List<ListUndefinedPagesAction.UndefinedPage>> resultSupplier, Map cacheStorage) Return cached result if available or getting new data
String	execute()
PageListViewEvent	getEventToPublish(String result) Gets the event to publish.
List	getItems()
int	getMaxReferencesPerUndefinedPage()
List	getUndefinedPages()
protected List<ListUndefinedPagesAction.UndefinedPage>	prepareNewCache(int cachingEnablingItemNumber, long currentTime, Supplier<List<ListUndefinedPagesAction.UndefinedPage>> resultSupplier, Map cacheStorage) Clean previous cache, call supplier to get new data then put it into the cache if cache condition is match
void	setCacheTimeout(int cacheTimeout)
void	setDisableCaching(boolean disableCaching)
void	setPageManager(PageManager pageManager)

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

getPaginationSupport, isSpaceRequired, isViewPermissionRequired, setStartIndex

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

getKey, getPermissionTypes, getSpace, getSpaceKey, getSubscribableName, getThemeManager, hasSpaceIA, isPermitted, isPersonalSpace, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getConfluenceAccessManager, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

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.spaces.actions.SpaceAware

setSpace

Methods inherited from interface com.atlassian.confluence.spaces.Spaced

getSpace

Methods inherited from interface com.atlassian.confluence.pages.actions.PaginationServiceSupportActionAware

getItemsCount, getPageResponse, isSupportPaginationService

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

Field Detail

cachingEnablingItemNumber

protected int cachingEnablingItemNumber

cachingEnablingTimeout

protected int cachingEnablingTimeout

Constructor Detail

ListUndefinedPagesAction

public ListUndefinedPagesAction()

Method Detail

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>

Throws:

Exception

setDisableCaching

public void setDisableCaching(boolean disableCaching)

setCacheTimeout

public void setCacheTimeout(int cacheTimeout)

setPageManager

public void setPageManager(PageManager pageManager)

getUndefinedPages

public List getUndefinedPages()

getEventToPublish

public PageListViewEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<PageListViewEvent>

Parameters:

result - the result of the action executing.

Returns:

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

getItems

public List getItems()

Specified by:

getItems in class AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>

cacheResult

protected List<ListUndefinedPagesAction.UndefinedPage> cacheResult(long cachingEnablingTimeout,
                                                                   int cachingEnablingItemNumber,
                                                                   long currentTime,
                                                                   Supplier<List<ListUndefinedPagesAction.UndefinedPage>> resultSupplier,
                                                                   Map cacheStorage)

Return cached result if available or getting new data

Parameters:

cachingEnablingTimeout - living time of the cache

cachingEnablingItemNumber - total number of item which will be put in cache

currentTime - current time in milliseconds

resultSupplier - result supplier

cacheStorage - where we should store our cache

Returns:

prepareNewCache

protected List<ListUndefinedPagesAction.UndefinedPage> prepareNewCache(int cachingEnablingItemNumber,
                                                                       long currentTime,
                                                                       Supplier<List<ListUndefinedPagesAction.UndefinedPage>> resultSupplier,
                                                                       Map cacheStorage)

Clean previous cache, call supplier to get new data then put it into the cache if cache condition is match

Parameters:

cachingEnablingItemNumber -

currentTime -

resultSupplier -

cacheStorage -

Returns:

getMaxReferencesPerUndefinedPage

public int getMaxReferencesPerUndefinedPage()