Package com.atlassian.confluence.user.actions

Class AbstractSearchCrowdUsersAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.user.actions.AbstractUsersAction

com.atlassian.confluence.user.actions.AbstractSearchCrowdUsersAction

All Implemented Interfaces:

Tabbed, WebInterface, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

Direct Known Subclasses:

SearchUsersAction, UserPickerAction

public class AbstractSearchCrowdUsersAction
extends AbstractUsersAction
implements Tabbed

Searches for users using the CrowdService and Query

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SHOW_ALL_SEARCH_TERM

Fields inherited from class com.atlassian.confluence.user.actions.AbstractUsersAction

personService, user, userKey, username

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
AbstractSearchCrowdUsersAction()

Method Summary

Modifier and Type	Method	Description
String	doUserSearch()
String	getEmailTerm()
String	getFullnameTerm()
String	getLicenseErrorHtml()
String	getOperator()
List<String>	getOperators()
PageRequest	getPageRequest()
PageResponse<ConfluenceUser>	getPageResponse()
int	getResultsPerPage()
List<com.atlassian.core.util.PairType>	getResultsPerPageOptions()
String	getSearchTerm()
String	getSelectedTab()	Returns the key of the tab that should be selected when rendering.
String	getUsernameTerm()
UserSearchServiceInternal	getUserSearchService()
boolean	isPermitted()	Consulted by PermissionCheckInterceptor.
boolean	isShowAll()
boolean	isShowUnlicensedUsers()
boolean	isSupportsSimpleSearch()
void	setEmailTerm(String emailTerm)
void	setFullnameTerm(String fullnameTerm)
void	setLicenseService(LicenseService licenseService)
void	setOperator(String operator)
void	setPageResponse(PageResponse<ConfluenceUser> result)
void	setResultsPerPage(int resultsPerPage)
void	setSearchTerm(String searchTerm)
void	setSelectedTab(String selectedTab)
void	setShowUnlicensedUsers(boolean showUnlicensedUsers)
void	setStartIndex(int startIndex)
void	setUserChecker(UserChecker userChecker)
void	setUsernameTerm(String usernameTerm)
void	setUserSearchService(UserSearchServiceInternal userSearchService)
void	validate()

Methods inherited from class com.atlassian.confluence.user.actions.AbstractUsersAction

getRemoteUsername, getUrlEncodeUsername, getUser, getUserKey, getUsername, isLicensedToAddMoreUsers, setApiPersonService, setUserKey, setUsername

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

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, execute, getContainer, getFormatted, getLocaleProvider, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale

Methods inherited from class java.lang.Object

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

Field Details

SHOW_ALL_SEARCH_TERM

public static final String SHOW_ALL_SEARCH_TERM

See Also:

• Constant Field Values

Constructor Details

AbstractSearchCrowdUsersAction

public AbstractSearchCrowdUsersAction()

Method Details

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface org.apache.struts2.Validateable

Overrides:

validate in class org.apache.struts2.ActionSupport

isSupportsSimpleSearch

public boolean isSupportsSimpleSearch()

getOperators

public List<String> getOperators()

getSelectedTab

public String getSelectedTab()

Description copied from interface: Tabbed

Returns the key of the tab that should be selected when rendering.

e.g. "search" or "create" for the browseusers.vm

Specified by:

getSelectedTab in interface Tabbed

setSelectedTab

public void setSelectedTab(String selectedTab)

doUserSearch

@XsrfProtectionExcluded
public String doUserSearch()

getPageRequest

public PageRequest getPageRequest()

isShowAll

public boolean isShowAll()

getResultsPerPage

public int getResultsPerPage()

getSearchTerm

public String getSearchTerm()

setSearchTerm

public void setSearchTerm(String searchTerm)

getUsernameTerm

public String getUsernameTerm()

setUsernameTerm

public void setUsernameTerm(String usernameTerm)

getFullnameTerm

public String getFullnameTerm()

setFullnameTerm

public void setFullnameTerm(String fullnameTerm)

getEmailTerm

public String getEmailTerm()

setEmailTerm

public void setEmailTerm(String emailTerm)

getOperator

public String getOperator()

setOperator

public void setOperator(String operator)

isShowUnlicensedUsers

public boolean isShowUnlicensedUsers()

setShowUnlicensedUsers

public void setShowUnlicensedUsers(boolean showUnlicensedUsers)

getLicenseErrorHtml

public String getLicenseErrorHtml()

setResultsPerPage

public void setResultsPerPage(int resultsPerPage)

getResultsPerPageOptions

public List<com.atlassian.core.util.PairType> getResultsPerPageOptions()

setLicenseService

public void setLicenseService(LicenseService licenseService)

setUserChecker

public void setUserChecker(UserChecker userChecker)

setStartIndex

public void setStartIndex(int startIndex)

setPageResponse

public void setPageResponse(PageResponse<ConfluenceUser> result)

getPageResponse

public PageResponse<ConfluenceUser> getPageResponse()

getUserSearchService

public UserSearchServiceInternal getUserSearchService()

setUserSearchService

public void setUserSearchService(UserSearchServiceInternal userSearchService)

isPermitted

public boolean isPermitted()

Description copied from class: ConfluenceActionSupport

Consulted by PermissionCheckInterceptor.

Overrides:

isPermitted in class AbstractUsersAction