Package com.atlassian.jira.web.action.user

Class ConfigurePortalPages

java.lang.Object

webwork.action.ActionSupport

com.atlassian.jira.web.action.JiraWebActionSupport

com.atlassian.jira.web.action.user.ConfigurePortalPages

All Implemented Interfaces:

ErrorCollection, I18nHelper, SharedEntitySearchAction, HttpServletVariables, DropDownModelProvider<PortalPageDisplayBean>, AuthorizationSupport, Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.IllegalArgumentAware

Direct Known Subclasses:

ViewSharedDashboards

public class ConfigurePortalPages
extends JiraWebActionSupport
implements SharedEntitySearchAction, DropDownModelProvider<PortalPageDisplayBean>

This action is the place we manage Portal Pages, aka Dashboard pages from

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ConfigurePortalPages.PortalPageViewHelper	Class to help executing and displaying the results of PortalPage searches.

Nested classes/interfaces inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

JiraWebActionSupport.MessageType

Nested classes/interfaces inherited from interface com.atlassian.jira.util.ErrorCollection

ErrorCollection.Reason

Nested classes/interfaces inherited from interface com.atlassian.jira.util.I18nHelper

I18nHelper.BeanFactory

Nested classes/interfaces inherited from interface com.atlassian.jira.web.action.util.sharing.SharedEntitySearchAction

SharedEntitySearchAction.FieldNameMapper, SharedEntitySearchAction.QueryValidator

Field Summary

Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

ISSUE_NOT_FOUND_RESULT, log, PERMISSION_VIOLATION_RESULT, request, RETURN_URL_PARAMETER, savedFilters, SECURITY_BREACH_RESULT

Fields inherited from class webwork.action.ActionSupport

command, errorMap, errorMessages

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor

Description

ConfigurePortalPages(PortalPageService portalPageService, JiraAuthenticationContext authenticationContext, FavouritesService favouritesService, GlobalPermissionManager permissionManager, ShareTypeFactory shareTypeFactory, UserFormats userFormats, com.atlassian.webresource.api.WebResourceManager webResourceManager, UserHistoryManager userHistoryManager, ShareManager shareManager, FeatureManager featureManager, UserManager userManager)

Method Summary

Modifier and Type	Method	Description
boolean	canShowFavourite()	Can we display the favourite column? Determined by if there is a user in the current session.
String	doDefault()
protected String	doExecute()	Default method runs when displaying portal pages.
String	doMoveDown()
String	doMoveToEnd()
String	doMoveToStart()
String	doMoveUp()
Long	getCopyPageId()
PortalPage	getCurrentPortalPage()
String	getDescription()
DropDownModel	getDropDownModel(PortalPageDisplayBean displayBean, int listIndex)
int	getEndPosition()
String	getGroupShare()
String	getNextUrl()
Long	getPageId()
String	getPageName(PortalPage portalPage)
List	getPages()
Long	getPagingOffset()
String	getPortalPageName()
ConfigurePortalPages.PortalPageViewHelper	getPortalPageViewHelper()
int	getPosition()
String	getPreviousUrl()
String	getProjectShare()
String	getRoleShare()
String	getSearchName()
String	getSearchOwnerUserName()
String	getSearchShareType()
String	getSearchUnsuccessfulMessage()
String	getSortColumn()
int	getStartPosition()
int	getTotalResultCount()
String	getUserShare()
String	getView()
boolean	hasBrowseUsersPermission()
boolean	isContentOnly()
boolean	isErrorMessage()
boolean	isSearchRequested()
boolean	isSortAscending()
boolean	isUserLoggedIn()
void	setContentOnly(boolean contentOnly)
void	setCopyPageId(Long copyPageId)
void	setDescription(String description)
void	setGroupShare(String groupShare)
void	setPageId(Long pageId)
protected void	setPages(List<PortalPageDisplayBean> pages)
void	setPagingOffset(Long pagingOffset)
void	setPortalPageName(String portalPageName)
void	setPosition(int position)
void	setProjectShare(String projectShare)
void	setRoleShare(String roleShare)
void	setSearchName(String searchName)
void	setSearchOwnerUserName(String searchOwnerUserName)
protected void	setSearchResults(SharedEntitySearchViewHelper.SearchResult<PortalPage> searchResults)
void	setSearchShareType(String searchShareType)
void	setSortAscending(boolean sortAscending)
void	setSortColumn(String sortColumn)
void	setUserShare(String userShare)
void	setView(String view)
boolean	shouldShowOwnerColumn()
protected String	toUrl(PortalPageDisplayBean pageDisplayBean, String page, String idUrlVariable, boolean includeReturnUrl)
protected List<PortalPageDisplayBean>	transformToDisplayBeans(Collection<PortalPage> portalPages)

Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport

addError, addErrorCollection, addErrorMessage, addErrorMessageByKeyIfAbsent, addErrorMessageIfAbsent, addErrorMessages, addErrorMessages, addErrors, addIllegalArgumentException, addMessageToResponse, addReason, addReasons, checkIfUrlIsAllowed, execute, forceRedirect, getActionName, getAdministratorContactLink, getApplicationProperties, getAuthorizationSupport, getComponentInstanceOfType, getConglomerateCookieValue, getConstantsManager, getDateFormat, getDateTimeFormat, getDateTimeFormatter, getDefaultResourceBundle, getDescTranslation, getDescTranslation, getDmyDateFormatter, getEmptyResponse, getErrorMessages, getErrors, getField, getFlushedErrorMessages, getGlobalPermissionManager, getHint, getHintManager, getHttpRequest, getHttpResponse, getHttpSession, getI18nHelper, getJiraContactHelper, getJiraServiceContext, getKeysForPrefix, getLanguage, getLocale, getLoggedInApplicationUser, getLoggedInUser, getNameTranslation, getNameTranslation, getOfBizDelegator, getOutboundWhitelistProvider, getOutlookDate, getPermissionManager, getProjectManager, getRandomHint, getReasons, getRedirect, getRedirect, getRedirectSanitiser, getRequestSourceType, getResourceBundle, getResult, getReturnUrl, getReturnUrlForCancelLink, getSearchSortDescriptions, getSelectedProject, getSelectedProjectObject, getServerId, getServletContext, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTimeFormat, getUnescapedText, getUntransformedRawText, getUriValidator, getUserFullName, getUserManager, getUserPreferences, getUserProjectHistoryManager, getVersionManager, getWebworkStack, getWebworkStack, getXsrfToken, hasAnyErrors, hasErrorMessage, hasErrorMessageByKey, hasGlobalPermission, hasGlobalPermission, hasIssuePermission, hasIssuePermission, hasIssuePermission, hasPermission, hasProjectPermission, hasProjectPermission, htmlEncode, insertContextPath, isAdministrator, isIndexing, isInlineDialogMode, isKeyDefined, isSystemAdministrator, isUserExists, isUserExistsByKey, isUserExistsByName, removeKeyOrAddError, returnComplete, returnComplete, returnCompleteWithInlineRedirect, returnCompleteWithInlineRedirectAndMsg, returnCompleteWithInlineRedirectAndMsg, returnMsgToUser, returnMsgToUser, setConglomerateCookieValue, setInline, setReasons, setReturnUrl, setSelectedProjectId, tagMauEventWithApplication, tagMauEventWithProject, urlEncode

Methods inherited from class webwork.action.ActionSupport

addError, addErrorMessage, doValidation, getCommandName, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, getTimezone, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface webwork.action.CommandDriven

getCommandName, setCommand

Methods inherited from interface com.atlassian.jira.util.ErrorCollection

addError, addErrorMessage, setErrorMessages

Constructor Details

ConfigurePortalPages

public ConfigurePortalPages(PortalPageService portalPageService,
 JiraAuthenticationContext authenticationContext,
 FavouritesService favouritesService,
 GlobalPermissionManager permissionManager,
 ShareTypeFactory shareTypeFactory,
 UserFormats userFormats,
 com.atlassian.webresource.api.WebResourceManager webResourceManager,
 UserHistoryManager userHistoryManager,
 ShareManager shareManager,
 FeatureManager featureManager,
 UserManager userManager)

Method Details

doDefault

public String doDefault()
                 throws Exception

Overrides:

doDefault in class webwork.action.ActionSupport

Throws:

Exception

getSearchName

public String getSearchName()

Specified by:

getSearchName in interface SharedEntitySearchAction

setSearchName

public void setSearchName(String searchName)

Specified by:

setSearchName in interface SharedEntitySearchAction

getSearchOwnerUserName

public String getSearchOwnerUserName()

Specified by:

getSearchOwnerUserName in interface SharedEntitySearchAction

setSearchOwnerUserName

public void setSearchOwnerUserName(String searchOwnerUserName)

Specified by:

setSearchOwnerUserName in interface SharedEntitySearchAction

getSearchShareType

public String getSearchShareType()

Specified by:

getSearchShareType in interface SharedEntitySearchAction

setSearchShareType

public void setSearchShareType(String searchShareType)

Specified by:

setSearchShareType in interface SharedEntitySearchAction

setUserShare

public void setUserShare(String userShare)

Specified by:

setUserShare in interface SharedEntitySearchAction

getUserShare

public String getUserShare()

Specified by:

getUserShare in interface SharedEntitySearchAction

setGroupShare

public void setGroupShare(String groupShare)

Specified by:

setGroupShare in interface SharedEntitySearchAction

getGroupShare

public String getGroupShare()

Specified by:

getGroupShare in interface SharedEntitySearchAction

getPagingOffset

public Long getPagingOffset()

Specified by:

getPagingOffset in interface SharedEntitySearchAction

setProjectShare

public void setProjectShare(String projectShare)

Specified by:

setProjectShare in interface SharedEntitySearchAction

getProjectShare

public String getProjectShare()

Specified by:

getProjectShare in interface SharedEntitySearchAction

setRoleShare

public void setRoleShare(String roleShare)

Specified by:

setRoleShare in interface SharedEntitySearchAction

getRoleShare

public String getRoleShare()

Specified by:

getRoleShare in interface SharedEntitySearchAction

setPagingOffset

public void setPagingOffset(Long pagingOffset)

Specified by:

setPagingOffset in interface SharedEntitySearchAction

getSortColumn

public String getSortColumn()

Specified by:

getSortColumn in interface SharedEntitySearchAction

setSortColumn

public void setSortColumn(String sortColumn)

Specified by:

setSortColumn in interface SharedEntitySearchAction

isSortAscending

public boolean isSortAscending()

Specified by:

isSortAscending in interface SharedEntitySearchAction

setSortAscending

public void setSortAscending(boolean sortAscending)

Specified by:

setSortAscending in interface SharedEntitySearchAction

setSearchResults

protected void setSearchResults(SharedEntitySearchViewHelper.SearchResult<PortalPage> searchResults)

setPageId

public void setPageId(Long pageId)

getPortalPageName

public String getPortalPageName()

setPortalPageName

public void setPortalPageName(String portalPageName)

getCopyPageId

public Long getCopyPageId()

setCopyPageId

public void setCopyPageId(Long copyPageId)

getPageId

public Long getPageId()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getView

public String getView()

setView

public void setView(String view)

getPosition

public int getPosition()

setPosition

public void setPosition(int position)

getPageName

public String getPageName(PortalPage portalPage)

isContentOnly

public boolean isContentOnly()

setContentOnly

public void setContentOnly(boolean contentOnly)

getSearchUnsuccessfulMessage

public String getSearchUnsuccessfulMessage()

isErrorMessage

public boolean isErrorMessage()

getPortalPageViewHelper

public ConfigurePortalPages.PortalPageViewHelper getPortalPageViewHelper()

isSearchRequested

public boolean isSearchRequested()

getCurrentPortalPage

public PortalPage getCurrentPortalPage()

getPages

public List getPages()

setPages

protected void setPages(List<PortalPageDisplayBean> pages)

getNextUrl

public String getNextUrl()

getPreviousUrl

public String getPreviousUrl()

getStartPosition

public int getStartPosition()

getEndPosition

public int getEndPosition()

getTotalResultCount

public int getTotalResultCount()

isUserLoggedIn

public boolean isUserLoggedIn()

hasBrowseUsersPermission

public boolean hasBrowseUsersPermission()

shouldShowOwnerColumn

public boolean shouldShowOwnerColumn()

canShowFavourite

public boolean canShowFavourite()

Can we display the favourite column? Determined by if there is a user in the current session.

Returns:

true if there is a logged-in user, else false

doExecute

protected String doExecute()

Default method runs when displaying portal pages.

Overrides:

doExecute in class webwork.action.ActionSupport

Returns:

the view to display

doMoveUp

public String doMoveUp()

doMoveDown

public String doMoveDown()

doMoveToStart

public String doMoveToStart()

doMoveToEnd

public String doMoveToEnd()

transformToDisplayBeans

protected List<PortalPageDisplayBean> transformToDisplayBeans(Collection<PortalPage> portalPages)

getDropDownModel

public DropDownModel getDropDownModel(PortalPageDisplayBean displayBean,
 int listIndex)

Specified by:

getDropDownModel in interface DropDownModelProvider<PortalPageDisplayBean>

Parameters:

displayBean - some domain object

listIndex - this parameter indicates the position in of the domain object in a list of domain objects. Often generated markup uses position in the list to generate ids and the like

Returns:

a drop down model based on the values in domainObject

toUrl

protected String toUrl(PortalPageDisplayBean pageDisplayBean,
 String page,
 String idUrlVariable,
 boolean includeReturnUrl)