UserSearchAction

This class is deprecated.
since 3.3. Use REST user search API instead.

Class Overview

An action that will try to find a Confluence user based on parts of the user's name or username as supplied in the query. The name part must be the beginning of the users details. e.g. supplying a query of 'ga gl' will match 'garry glitter'. It would not match 'olga nugleva' since the ga and gl parts are not at the start of those name components.

The output of the action can be retrieved via the getJSONString method which will return a JSON representation of any matching users.

Summary

[Expand] Inherited Constants
From class com.atlassian.confluence.core.ConfluenceActionSupport String CANCEL String DEVMODE String LICENSE_EXPIRED String LICENSE_USERS_EXCEEDED String PREVIEW
From interface com.opensymphony.xwork.Action String ERROR String INPUT String LOGIN String NONE String SUCCESS

[Expand] Inherited Fields
From class com.atlassian.confluence.core.ConfluenceActionSupport protected EventManager eventManager protected I18NBeanFactory i18NBeanFactory protected LabelManager labelManager protected LanguageManager languageManager protected Logger log This field is deprecated. since 2.6.1 create a private static logger in your action class protected PermissionManager permissionManager protected boolean permitted protected PluginAccessor pluginAccessor protected SettingsManager settingsManager protected SpacePermissionManager spacePermissionManager protected UserAccessor userAccessor protected WebInterfaceManager webInterfaceManager
From class com.opensymphony.xwork.ActionSupport protected static final Log LOG

[Expand] Inherited Methods
From class com.atlassian.confluence.core.ConfluenceActionSupport void addActionError(String textKey, Object... args) Adds an error to the current action which will be displayed to the user. void addFieldError(String fieldName, String textKey, Object[] args) Adds an error to the current action which will be displayed next to the specified field. void addPermissionTypeTo(String permissionType, List<String> permissionTypes) void addToHistory(ContentEntityObject content) String doDefault() Default webwork action execution method. String formatFriendlyDate(Date date) String getActionName() Returns the internationalised name of the current action. String getActionName(String fullClassName) BootstrapManager getBootstrapManager() String getCancelResult() Map<String, Object> getContext() String getDateFormatSetting() DateFormatter getDateFormatter() ResourceBundle getDefaultResourceBundle() String getDocLink(String page) Creates a version specific documentation link for the provided page. EventManager getEventManager() FriendlyDateFormatter getFriendlyDateFormatter() Settings getGlobalSettings() ThemeHelper getHelper() I18NBean getI18n() List<Language> getInstalledLanguages() LabelManager getLabelManager() LanguageManager getLanguageManager() String getLanguageUserFriendly(String locale) Locale getLocale() LocaleManager getLocaleManager() String getLocaleString() String getNiceContentType(ContentEntityObject entityObject) This method is deprecated. since 4.2 - use ContentUiSupport directly List<String> getPermissionTypes() List getPermittedEntitiesOf(Iterator entities, int maxCount) List getPermittedEntitiesOf(List entities) List getPermittedEntitiesOf(Iterator entities, int maxCount, List criteria) Date getPreviousLoginDate() @Deprecated int getRandom() This method is deprecated. since 2.9. Random number generation does not belong here. Please introduce your own random number generation in your own actions. User getRemoteUser() Return the user from getRequest(), or if that is not found, the user returned from getUser(). Map getSession() SystemInformationService getSystemInformationService() String getText(String key, Object[] args) String getText(String key) String getText(String key, List list) String getText(String key, String defaultValue) This can be used for internationalisation where a non-internationalised default string exists. static String getTextStatic(String key) static String getTextStatic(String key, Object[] list) String getTextStrict(String key) TimeZone getTimeZone() User getUser(String username) UserAccessor getUserAccessor() String getUserFullName(String username) UserInterfaceState getUserInterfaceState() WebInterfaceContext getWebInterfaceContext() Returns a context which can be passed to web items when rendering them. WebInterfaceManager getWebInterfaceManager() boolean hasPermissionForSpace(List permissionTypes, Space space) boolean isAnonymousUser() boolean isCanceled() Has this action been cancelled? Used by CancellingInterceptor to determine if the action should be executed. boolean isDevMode() Returns true if the system property confluence.devmode is set and has the value "true". boolean isEmailVisible() boolean isExternalUserManagementEnabled() boolean isLabelable(Object object) boolean isPermissionCheck() boolean isPermitted() String isPermittedAsString() boolean isPrintableVersion() boolean isSharedMode() boolean isUserStatusPluginEnabled() Temporary method until we have plugin points to require i18n keys. boolean isUsingHSQL() Placing this method in ConfluenceActionSupport is a bit of a hack, but it is suprisingly difficult to have a generic piece of logic that can be used in decorators. void setBootstrapManager(BootstrapManager bootstrapManager) void setCancel(String cancel) Set by the "cancel" button on forms. void setContentUiSupport(ContentUiSupport contentUiSupport) void setEventManager(EventManager eventManager) void setFormatSettingsManager(FormatSettingsManager formatSettingsManager) void setI18NBean(I18NBean i18NBean) void setI18NBeanFactory(I18NBeanFactory i18NBeanFactory) void setLabelManager(LabelManager labelManager) void setLanguageManager(LanguageManager languageManager) void setLocaleManager(LocaleManager localeManager) void setLoginManager(LoginManager loginManager) void setPermissionCheck(boolean permissionCheck) void setPermissionManager(PermissionManager permissionManager) void setPluginAccessor(PluginAccessor pluginAccessor) void setPreviousLoginDate(Date previousLoginDate) void setSettingsManager(SettingsManager settingsManager) void setSpacePermissionManager(SpacePermissionManager spacePermissionManager) void setSystemInformationService(SystemInformationService systemInformationService) void setUserAccessor(UserAccessor userAccessor) void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)
From class com.opensymphony.xwork.ActionSupport void addActionError(String arg0) void addActionMessage(String arg0) void addFieldError(String arg0, String arg1) String doDefault() String execute() Collection getActionErrors() Collection getActionMessages() Collection getErrorMessages() Map getErrors() Map getFieldErrors() Locale getLocale() String getText(String arg0, String arg1, List arg2) String getText(String arg0) String getText(String arg0, List arg1) String getText(String arg0, String arg1) ResourceBundle getTexts() ResourceBundle getTexts(String arg0) boolean hasActionErrors() boolean hasActionMessages() boolean hasErrors() boolean hasFieldErrors() void setActionErrors(Collection arg0) void setActionMessages(Collection arg0) void setFieldErrors(Map arg0) void validate()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.atlassian.confluence.json.JSONAction String getJSONString()
From interface com.atlassian.confluence.plugin.descriptor.web.WebInterface WebInterfaceContext getWebInterfaceContext() Returns a context which can be passed to web items when rendering them.
From interface com.opensymphony.xwork.Action String execute()
From interface com.opensymphony.xwork.LocaleProvider Locale getLocale()
From interface com.opensymphony.xwork.TextProvider String getText(String arg0, String arg1, List arg2) String getText(String arg0) String getText(String arg0, String arg1) String getText(String arg0, List arg1) ResourceBundle getTexts() ResourceBundle getTexts(String arg0)
From interface com.opensymphony.xwork.Validateable void validate()
From interface com.opensymphony.xwork.ValidationAware void addActionError(String arg0) void addActionMessage(String arg0) void addFieldError(String arg0, String arg1) Collection getActionErrors() Collection getActionMessages() Map getFieldErrors() boolean hasActionErrors() boolean hasActionMessages() boolean hasErrors() boolean hasFieldErrors() void setActionErrors(Collection arg0) void setActionMessages(Collection arg0) void setFieldErrors(Map arg0)