com.atlassian.bamboo.plugins.rest.resource
Class SearchResource

java.lang.Object
  com.atlassian.bamboo.plugins.rest.resource.SearchResource

@Singleton
public class SearchResource
extends java.lang.Object

Constructor Summary

SearchResource(AdministrationConfigurationManager administrationConfigurationManager, BambooUserManager bambooUserManager, GravatarService gravatarService, ExtendedAuthorManager authorManager)

Method Summary

SearchResultsList	searchAuthors(java.lang.String searchTerm, boolean unlinkedOnly, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders) A starts-with search of authors based on their authorname,
SearchResultsList	searchUsers(java.lang.String searchTerm, boolean includeAvatars, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders) A starts-with search of users based on their username, full-name and if allowed email address.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResource

public SearchResource(AdministrationConfigurationManager administrationConfigurationManager,
                      BambooUserManager bambooUserManager,
                      GravatarService gravatarService,
                      ExtendedAuthorManager authorManager)

Method Detail

searchUsers

public SearchResultsList searchUsers(java.lang.String searchTerm,
                                     boolean includeAvatars,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo,
                                     @Context
                                     javax.ws.rs.core.HttpHeaders httpHeaders)
                              throws java.lang.Exception

A starts-with search of users based on their username, full-name and if allowed email address.

Parameters:

searchTerm - Mandatory. The term to search for in users.

includeAvatars - if true will include avatar urls in the response. If gravatar is not enabled, no urls will be returned

uriInfo -

httpHeaders -

Returns:

SearchResultsList of UserSearchResult

Throws:

java.lang.Exception

searchAuthors

public SearchResultsList searchAuthors(java.lang.String searchTerm,
                                       boolean unlinkedOnly,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.ws.rs.core.HttpHeaders httpHeaders)
                                throws java.lang.Exception

A starts-with search of authors based on their authorname,

Parameters:

searchTerm - Mandatory. The term to search for in authors.

unlinkedOnly - if true will only include authors which are not currently linked to a user.

uriInfo -

httpHeaders -

Returns:

SearchResultsList of AuthorSearchResult

Throws:

java.lang.Exception