Class SearchSiteAction
- java.lang.Object
-
- com.opensymphony.xwork2.ActionSupport
-
- com.atlassian.confluence.core.ConfluenceActionSupport
-
- com.atlassian.confluence.impl.search.actions.SearchSiteAction
-
- All Implemented Interfaces:
Beanable
,WebInterface
,MessageHolderAware
,com.opensymphony.xwork2.Action
,com.opensymphony.xwork2.interceptor.ValidationAware
,com.opensymphony.xwork2.LocaleProvider
,com.opensymphony.xwork2.TextProvider
,com.opensymphony.xwork2.Validateable
,Serializable
@Deprecated public class SearchSiteAction extends ConfluenceActionSupport implements Beanable
Deprecated.since 5.9This action is overridden in the confluence-search plugin, it remains here in case someone is extending this action class, it is not wired up in xwork and it's template has been deleted.Do not use it, it will be deleted as soon as possible.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
SearchSiteAction.BackwardsCompatibility
Deprecated.A class used to preserve compatibility with old style search URL's where search parameters were entered in the format:searchQuery.spaceKey=conf_all&searchQuery.queryString=hello
.static class
SearchSiteAction.CriteriaParameters
Deprecated.A Class used to represent the different criteria restriction links that are displayed along with the search results.static class
SearchSiteAction.UserDetails
Deprecated.
-
Field Summary
-
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, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager
-
-
Constructor Summary
Constructors Constructor Description SearchSiteAction()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
doDefault()
Deprecated.Convenient Action execution method which defaults to returning INPUTString
execute()
Deprecated.List<com.atlassian.core.util.PairType>
getAggregateOptions()
Deprecated.List<SpacePickerHelper.SpaceDTO>
getAvailableGlobalSpaces()
Deprecated.Find all global spaces that user has permission to view, but that aren't favouritesObject
getBean()
Deprecated.List
getContentLabels(ContentEntityObject content, int amount)
Deprecated.ContentTypeEnum
getContentType()
Deprecated.ContentTypesDisplayMapper
getContentTypesDisplayMapper()
Deprecated.String
getContributor()
Deprecated.String
getContributorUsername()
Deprecated.SearchSiteAction.CriteriaParameters
getCurrentSearch()
Deprecated.List<com.atlassian.core.util.PairType>
getDateRanges()
Deprecated.int
getEndIndex()
Deprecated.List<SpacePickerHelper.SpaceDTO>
getFavouriteSpaces()
Deprecated.String
getKey()
Deprecated.String
getLabelNames(Labelable obj)
Deprecated.Retrieve a comma separated string of label names.Summary
getLabelsSummaryForResult(SearchResult result)
Deprecated.DateRangeEnum
getLastModified()
Deprecated.PaginationSupport
getPaginationSupport()
Deprecated.String
getQueryString()
Deprecated.List<Label>
getRelatedLabels()
Deprecated.Returns a list of related labels to the labels matching the search resultList<SearchResult>
getResults()
Deprecated.SearchSiteAction.BackwardsCompatibility
getSearchQuery()
Deprecated.String
getSearchUuid()
Deprecated.List<String>
getSearchWords()
Deprecated.Space
getSpace(String spaceKey)
Deprecated.int
getStartIndex()
Deprecated.String
getSummaryForResult(SearchResult result)
Deprecated.Timer
getTimer()
Deprecated.String
getTitleForResult(SearchResult result)
Deprecated.int
getTotalSearchResults()
Deprecated.String
getType()
Deprecated.String
getTypeName(String type)
Deprecated.List<com.atlassian.core.util.PairType>
getTypeOptions()
Deprecated.WebInterfaceContext
getWebInterfaceContext(SearchResult result)
Deprecated.String
getWhere()
Deprecated.boolean
isIncludeArchivedSpaces()
Deprecated.boolean
isSuggestArchivedSpaces()
Deprecated.String
newSearchResult(SearchResult searchResult, String showExcerpts, String queryString)
Deprecated.void
setContentTypesDisplayMapper(ContentTypesDisplayMapper contentTypesDisplayMapper)
Deprecated.void
setContributor(String who)
Deprecated.void
setContributorUsername(String contributorUsername)
Deprecated.void
setDelegatedSearchResultRenderer(DelegatedSearchResultRenderer defaultRenderer)
Deprecated.void
setHitHighlighterFactory(HitHighlighterFactory hitHighlighterFactory)
Deprecated.void
setIncludeArchivedSpaces(boolean includeArchivedSpaces)
Deprecated.void
setKey(String key)
Deprecated.void
setLastModified(DateRangeEnum lastModified)
Deprecated.void
setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
Deprecated.void
setPredefinedSearchBuilder(PredefinedSearchBuilder predefinedSearchBuilder)
Deprecated.void
setQueryAnalyzer(org.apache.lucene.analysis.Analyzer queryAnalyzer)
Deprecated.void
setQueryString(String queryString)
Deprecated.void
setSearchManager(SearchManager searchManager)
Deprecated.void
setSearchMapper(LuceneSearchMapper searchMapper)
Deprecated.void
setSpaceManager(SpaceManager spaceManager)
Deprecated.void
setStartIndex(int startIndex)
Deprecated.void
setType(String type)
Deprecated.void
setTypes(String[] types)
Deprecated.void
setUserAccessor(UserAccessor userAccessor)
Deprecated.void
setWhere(String where)
Deprecated.void
validate()
Deprecated.-
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport
addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, 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, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, 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, isPermitted, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiContentUiSupport, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setWebInterfaceManager, withServletRequestSupplier
-
Methods inherited from class com.opensymphony.xwork2.ActionSupport
addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors
-
-
-
-
Method Detail
-
validate
public void validate()
Deprecated.- Specified by:
validate
in interfaceMessageHolderAware
- Specified by:
validate
in interfacecom.opensymphony.xwork2.Validateable
- Overrides:
validate
in classcom.opensymphony.xwork2.ActionSupport
-
doDefault
public String doDefault() throws Exception
Deprecated.Description copied from class:ConfluenceActionSupport
Convenient Action execution method which defaults to returning INPUT- Overrides:
doDefault
in classConfluenceActionSupport
- Throws:
Exception
-
execute
@XsrfProtectionExcluded public String execute() throws Exception
Deprecated.- Specified by:
execute
in interfacecom.opensymphony.xwork2.Action
- Overrides:
execute
in classcom.opensymphony.xwork2.ActionSupport
- Throws:
Exception
-
newSearchResult
public String newSearchResult(SearchResult searchResult, String showExcerpts, String queryString)
Deprecated.
-
getWebInterfaceContext
public WebInterfaceContext getWebInterfaceContext(SearchResult result)
Deprecated.
-
getSummaryForResult
public String getSummaryForResult(SearchResult result)
Deprecated.
-
getTitleForResult
public String getTitleForResult(SearchResult result)
Deprecated.
-
getResults
public List<SearchResult> getResults()
Deprecated.
-
getAvailableGlobalSpaces
public List<SpacePickerHelper.SpaceDTO> getAvailableGlobalSpaces()
Deprecated.Find all global spaces that user has permission to view, but that aren't favourites- Returns:
- List
-
getAggregateOptions
public List<com.atlassian.core.util.PairType> getAggregateOptions()
Deprecated.
-
getFavouriteSpaces
public List<SpacePickerHelper.SpaceDTO> getFavouriteSpaces()
Deprecated.
-
setSpaceManager
public void setSpaceManager(SpaceManager spaceManager)
Deprecated.
-
getRelatedLabels
public List<Label> getRelatedLabels()
Deprecated.Returns a list of related labels to the labels matching the search result- Returns:
- List of related lables
-
getLabelNames
public String getLabelNames(Labelable obj)
Deprecated.Retrieve a comma separated string of label names.- Returns:
- a comma separated string
-
getContentLabels
public List getContentLabels(ContentEntityObject content, int amount)
Deprecated.
-
getTypeOptions
public List<com.atlassian.core.util.PairType> getTypeOptions()
Deprecated.- Returns:
- a list of the type criteria that should be presented on the GUI.
-
getDateRanges
public List<com.atlassian.core.util.PairType> getDateRanges()
Deprecated.- Returns:
- a list of the date range criteria that should be presented on the GUI.
-
setUserAccessor
public void setUserAccessor(UserAccessor userAccessor)
Deprecated.- Overrides:
setUserAccessor
in classConfluenceActionSupport
-
getCurrentSearch
public SearchSiteAction.CriteriaParameters getCurrentSearch()
Deprecated.- Returns:
- a criteria link that represents the current search state
-
setStartIndex
public void setStartIndex(int startIndex)
Deprecated.
-
getStartIndex
public int getStartIndex()
Deprecated.
-
getEndIndex
public int getEndIndex()
Deprecated.
-
getTimer
public Timer getTimer()
Deprecated.
-
getLabelsSummaryForResult
public Summary getLabelsSummaryForResult(SearchResult result)
Deprecated.
-
getQueryString
public String getQueryString()
Deprecated.
-
setQueryString
public void setQueryString(String queryString)
Deprecated.
-
getWhere
public String getWhere()
Deprecated.
-
setWhere
public void setWhere(String where)
Deprecated.
-
getKey
public String getKey()
Deprecated.
-
setKey
public void setKey(String key)
Deprecated.
-
getType
public String getType()
Deprecated.
-
getContentType
public ContentTypeEnum getContentType()
Deprecated.
-
setType
public void setType(String type)
Deprecated.
-
setTypes
public void setTypes(String[] types)
Deprecated.
-
getLastModified
public DateRangeEnum getLastModified()
Deprecated.
-
setLastModified
public void setLastModified(DateRangeEnum lastModified)
Deprecated.
-
getTotalSearchResults
public int getTotalSearchResults()
Deprecated.
-
getPaginationSupport
public PaginationSupport getPaginationSupport()
Deprecated.
-
setSearchMapper
public void setSearchMapper(LuceneSearchMapper searchMapper)
Deprecated.
-
getContentTypesDisplayMapper
public ContentTypesDisplayMapper getContentTypesDisplayMapper()
Deprecated.
-
setPluginAccessor
public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
Deprecated.- Overrides:
setPluginAccessor
in classConfluenceActionSupport
-
setContentTypesDisplayMapper
public void setContentTypesDisplayMapper(ContentTypesDisplayMapper contentTypesDisplayMapper)
Deprecated.
-
setQueryAnalyzer
public void setQueryAnalyzer(org.apache.lucene.analysis.Analyzer queryAnalyzer)
Deprecated.
-
setSearchManager
public void setSearchManager(SearchManager searchManager)
Deprecated.
-
getSearchQuery
public SearchSiteAction.BackwardsCompatibility getSearchQuery()
Deprecated.
-
setContributor
public void setContributor(String who)
Deprecated.
-
getContributor
public String getContributor()
Deprecated.
-
getContributorUsername
public String getContributorUsername()
Deprecated.
-
setContributorUsername
public void setContributorUsername(String contributorUsername)
Deprecated.
-
setPredefinedSearchBuilder
public void setPredefinedSearchBuilder(PredefinedSearchBuilder predefinedSearchBuilder)
Deprecated.
-
isIncludeArchivedSpaces
public boolean isIncludeArchivedSpaces()
Deprecated.
-
setIncludeArchivedSpaces
public void setIncludeArchivedSpaces(boolean includeArchivedSpaces)
Deprecated.
-
isSuggestArchivedSpaces
public boolean isSuggestArchivedSpaces()
Deprecated.
-
getSearchUuid
public String getSearchUuid()
Deprecated.
-
setDelegatedSearchResultRenderer
public void setDelegatedSearchResultRenderer(DelegatedSearchResultRenderer defaultRenderer)
Deprecated.- Parameters:
defaultRenderer
- the defaultRenderer to set
-
setHitHighlighterFactory
public void setHitHighlighterFactory(HitHighlighterFactory hitHighlighterFactory)
Deprecated.
-
-