Package com.atlassian.confluence.impl.search.actions

Class ContentNameSearchAction

java.lang.Object

org.apache.struts2.ActionSupport

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.impl.search.actions.ContentNameSearchAction

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, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.Validateable

@Deprecated
public class ContentNameSearchAction
extends ConfluenceActionSupport
implements Beanable

Deprecated.

since 5.2. Instead please use the REST endpoint that is provided by the 'Confluence QuickNav' Bundled Plugin. Please use /rest/quicknav/1/search instead. It accepts the exact same arguments and is thus API compatible with this class. You should be able to swap them out directly.

An action that will take a query String from the front end and apply it as a search across the 'universal title' field within the Confluence search index.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

com.opensymphony.xwork2.interceptor.ValidationAware.LegacyAdapter

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
ContentNameSearchAction()	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	execute()	Deprecated. Perform the search and create the ContentNameSearchResult.
Object	getBean()	Deprecated.
ContentNameSearchResult	getResult()	Deprecated.
void	setContentNameSearchService(ContentNameSearchService contentNameSearchService)	Deprecated.
void	setLimit(int limit)	Deprecated.
void	setMaxPerCategory(int maxPerCategory)	Deprecated.
void	setQuery(String query)	Deprecated.
void	setSpaceKey(String spaceKey)	Deprecated.
void	setType(String[] types)	Deprecated.
void	withServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.1, no replacement.

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getCurrentRequest, getCurrentResponse, 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, setSkipIsPermitted, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, shouldSkipIsPermitted

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

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

addActionError, addActionMessage, addFieldError, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

ContentNameSearchAction

public ContentNameSearchAction()

Deprecated.

Method Details

execute

public String execute()
               throws Exception

Deprecated.

Perform the search and create the ContentNameSearchResult. The individual ContentNameMatch objects within the result will be ordered and grouped, so you can count on getting results ordered like -

• all page matches
• all blog matches
• all attachment matches
• all user matches
• all space matches

If a particular category has no matches then it will not be included in the result.

Specified by:

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

Overrides:

execute in class org.apache.struts2.ActionSupport

Throws:

Exception

setQuery

public void setQuery(String query)

Deprecated.

setType

public void setType(String[] types)

Deprecated.

setSpaceKey

public void setSpaceKey(String spaceKey)

Deprecated.

setMaxPerCategory

public void setMaxPerCategory(int maxPerCategory)

Deprecated.

setLimit

public void setLimit(int limit)

Deprecated.

getResult

public ContentNameSearchResult getResult()

Deprecated.

getBean

public Object getBean()

Deprecated.

Specified by:

getBean in interface Beanable

Returns:

the result bean (ContentNameSearchResult) on successful execution of this action. If the action has not executed then the return value will be null.

withServletRequest

@Deprecated(forRemoval=true)
public void withServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.1, no replacement.

setContentNameSearchService

public void setContentNameSearchService(ContentNameSearchService contentNameSearchService)

Deprecated.