com.atlassian.crowd.plugin.rest.service.controller

Class SearchController

java.lang.Object

com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

com.atlassian.crowd.plugin.rest.service.controller.SearchController

@Named
public class SearchController
extends AbstractResourceController

Controller for the Search resource.

Constructor Summary

Constructors

Constructor and Description
SearchController(ApplicationService applicationService, CqlQueryParser cqlQueryParser, AuthenticatedApplicationHolder authenticatedApplicationHolder)

Method Summary

Modifier and Type	Method and Description
GroupEntityList	searchGroups(SearchRestrictionEntity searchRestrictionEntity, int maxResults, int startIndex, boolean expandGroup, boolean expandAttributes, URI baseUri) Searches for groups satisfying the restriction.
GroupEntityList	searchGroups(String cqlSearchRestriction, int maxResults, int startIndex, boolean expandGroup, boolean expandAttributes, URI baseUri) Searches for groups satisfying the restriction.
UserEntityList	searchUsers(SearchRestrictionEntity searchRestrictionEntity, int maxResults, int startIndex, boolean expandUser, boolean expandAttributes, URI baseUri) Searches for users satisfying the restriction.
UserEntityList	searchUsers(String cqlSearchRestriction, int maxResults, int startIndex, boolean expandUser, boolean expandAttributes, URI baseUri) Searches for users satisfying the restriction.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.controller.AbstractResourceController

getAuthenticatedApplication

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchController

@Inject
public SearchController(ApplicationService applicationService,
                                CqlQueryParser cqlQueryParser,
                                AuthenticatedApplicationHolder authenticatedApplicationHolder)

Method Detail

searchGroups

public GroupEntityList searchGroups(SearchRestrictionEntity searchRestrictionEntity,
                                    int maxResults,
                                    int startIndex,
                                    boolean expandGroup,
                                    boolean expandAttributes,
                                    URI baseUri)

Searches for groups satisfying the restriction.

Parameters:

searchRestrictionEntity - criteria for a group to be returned

maxResults - maximum number of results to return

startIndex - starting index of the result

expandGroup - set to true if the group details should be expanded.

expandAttributes - set to true if the group's attributes should be expanded - requires that group details are expanded.

baseUri - Base URI of the REST service

Returns:

GroupEntityList

searchUsers

public UserEntityList searchUsers(SearchRestrictionEntity searchRestrictionEntity,
                                  int maxResults,
                                  int startIndex,
                                  boolean expandUser,
                                  boolean expandAttributes,
                                  URI baseUri)

Searches for users satisfying the restriction.

Parameters:

searchRestrictionEntity - criteria for a user to be returned

maxResults - maximum number of results to return

startIndex - starting index of the result

expandUser - set to true if the user details should be expanded.

expandAttributes - set to true if the user's attributes should be expanded - requires that user details are expanded.

baseUri - Base URI of the REST service

Returns:

UserEntityList

searchGroups

public GroupEntityList searchGroups(String cqlSearchRestriction,
                                    int maxResults,
                                    int startIndex,
                                    boolean expandGroup,
                                    boolean expandAttributes,
                                    URI baseUri)

Searches for groups satisfying the restriction.

Parameters:

cqlSearchRestriction - criteria for a group to be returned in the Crowd Query Language

maxResults - maximum number of results to return

startIndex - starting index of the result

expandGroup - set to true if the group details should be expanded.

expandAttributes - set to true if the group's attributes should be expanded - requires that group details are expanded.

baseUri - Base URI of the REST service

Returns:

GroupEntityList

searchUsers

public UserEntityList searchUsers(String cqlSearchRestriction,
                                  int maxResults,
                                  int startIndex,
                                  boolean expandUser,
                                  boolean expandAttributes,
                                  URI baseUri)

Searches for users satisfying the restriction.

Parameters:

cqlSearchRestriction - criteria for a user to be returned in the Crowd Query Language

maxResults - maximum number of results to return

startIndex - starting index of the result

expandUser - set to true if the user details should be expanded.

expandAttributes - set to true if the user's attributes should be expanded - requires that user details are expanded.

baseUri - Base URI of the REST service

Returns:

UserEntityList