com.atlassian.bamboo.plugins.rest.resource

Class SearchResource

java.lang.Object

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

@Singleton
public class SearchResource
extends Object

Constructor Summary

Constructors

Constructor and Description

SearchResource(AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooUserManager bambooUserManager, CachedPlanManager cachedPlanManager, CustomVariableContext customVariableContext, DeploymentVersionService deploymentVersionService, DeploymentProjectService deploymentProjectService, GravatarService gravatarService, ExtendedAuthorManager authorManager, PlanRestService planRestService, ProjectsRestService projectsRestService, com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Summary

Modifier and Type	Method and Description
protected Predicate<ImmutablePlan>	filterPlans(String searchTerm, boolean fuzzySearch)
SearchResultsList	searchAuthors(String searchTerm, boolean unlinkedOnly, javax.ws.rs.core.UriInfo uriInfo) A starts-with search of authors based on their authorname,
SearchResultsList	searchBranches(String masterPlanKey, boolean includeMasterBranch, Integer releasedInDeployment, String searchTerm, boolean fuzzySearch, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a "starts with" search against full plan branch name and full plan branch key.
SearchResultsList	searchDeployments(String searchTerm, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a contains search against deployment project name.
SearchResultsList	searchJobs(String planKey, String searchTerm, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a "starts with" search against full job name and full job key.
SearchResultsList	searchPlans(String searchTerm, boolean fuzzySearch, String planType, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a "starts with" search against full plan name and full plan key.
SearchResultsList	searchProjects(String searchTerm, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a contains search against project name.
SearchResultsList	searchStages(String planKey, String stageId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a "starts with" search against full job name and full job key.
SearchResultsList	searchUsers(String searchTerm, boolean includeAvatars, javax.ws.rs.core.UriInfo uriInfo) A starts-with search of users based on their username, full-name and if allowed email address.
SearchResultsList	searchVersions(String searchTerm, long deploymentProjectId, String branchKey, boolean chronologicalOrder, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Performs a contains search against a version name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResource

public SearchResource(AdministrationConfigurationAccessor administrationConfigurationAccessor,
                      BambooUserManager bambooUserManager,
                      CachedPlanManager cachedPlanManager,
                      CustomVariableContext customVariableContext,
                      DeploymentVersionService deploymentVersionService,
                      DeploymentProjectService deploymentProjectService,
                      GravatarService gravatarService,
                      ExtendedAuthorManager authorManager,
                      PlanRestService planRestService,
                      ProjectsRestService projectsRestService,
                      com.atlassian.sal.api.message.I18nResolver i18nResolver)

Method Detail

searchUsers

public SearchResultsList searchUsers(String searchTerm,
                                     boolean includeAvatars,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)
                              throws 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 -

Returns:

SearchResultsList of UserSearchResult

Throws:

Exception

searchAuthors

public SearchResultsList searchAuthors(String searchTerm,
                                       boolean unlinkedOnly,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo)
                                throws 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 -

Returns:

SearchResultsList of AuthorSearchResult

Throws:

Exception

searchPlans

public SearchResultsList searchPlans(String searchTerm,
                                     boolean fuzzySearch,
                                     String planType,
                                     String requiredPermission,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo,
                                     @Context
                                     javax.ws.rs.core.HttpHeaders httpHeaders,
                                     @Context
                                     com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a "starts with" search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans

Parameters:

searchTerm - to search for. Optional

fuzzySearch - whether the search should be more relaxed when matching results. Default is false.

planType - type of the plan to return (PlanType. Optional

requiredPermission - only return those plans that querying user has permission to (BambooPermission. Default is READ.

uriInfo -

httpHeaders -

authenticationContext -

Returns:

SearchResultsList of PlanSearchResult

searchJobs

public SearchResultsList searchJobs(String planKey,
                                    String searchTerm,
                                    @Context
                                    javax.ws.rs.core.UriInfo uriInfo,
                                    @Context
                                    javax.ws.rs.core.HttpHeaders httpHeaders,
                                    @Context
                                    com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a "starts with" search against full job name and full job key. Use "type" argument to filter by plan type by default will return TopLevelPlans

Parameters:

planKey - planKey for plan where jobs will be searched for

searchTerm - to search for. Optional

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of PlanSearchResult

searchStages

public SearchResultsList searchStages(String planKey,
                                      String stageId,
                                      String searchTerm,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      @Context
                                      javax.ws.rs.core.HttpHeaders httpHeaders,
                                      @Context
                                      com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a "starts with" search against full job name and full job key. Use "type" argument to filter by plan type by default will return TopLevelPlans

Parameters:

planKey - planKey for plan where jobs will be searched for

searchTerm - to search for. Optional

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of PlanSearchResult

searchBranches

public SearchResultsList searchBranches(String masterPlanKey,
                                        boolean includeMasterBranch,
                                        Integer releasedInDeployment,
                                        String searchTerm,
                                        boolean fuzzySearch,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders httpHeaders,
                                        @Context
                                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a "starts with" search against full plan branch name and full plan branch key. Branches are restricted to "masterPlanKey" plan.

Parameters:

searchTerm - to search for. Optional

fuzzySearch - whether the search should be more relaxed when matching results. Default is false.

includeMasterBranch - should master branch be included into result. Optional

releasedInDeployment - id of deployment project - will return only branches that are released in this deployment. Optional

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of PlanSearchResult

searchProjects

public SearchResultsList searchProjects(String searchTerm,
                                        String requiredPermission,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders httpHeaders,
                                        @Context
                                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a contains search against project name.

Parameters:

searchTerm - to search for. Optional

requiredPermission - only return those projects that querying user has permission to (BambooPermission. Default is READ.

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of ProjectSearchResult

searchDeployments

public SearchResultsList searchDeployments(String searchTerm,
                                           String requiredPermission,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           @Context
                                           javax.ws.rs.core.HttpHeaders httpHeaders,
                                           @Context
                                           com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a contains search against deployment project name.

Parameters:

searchTerm - to search for. Optional

requiredPermission - only return those deployment projects that querying user has permission to (BambooPermission. Default is READ.

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of ProjectSearchResult

searchVersions

public SearchResultsList searchVersions(String searchTerm,
                                        long deploymentProjectId,
                                        String branchKey,
                                        boolean chronologicalOrder,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders httpHeaders,
                                        @Context
                                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Performs a contains search against a version name.

Parameters:

searchTerm - to search for. Optional

deploymentProjectId - The deployment project to search under.

branchKey - narrow the search to releases created out of the branch. Optional

uriInfo -

httpHeaders -

authenticationContext -

Returns:

@return SearchResultsList of DeploymentVersionSearchResult

filterPlans

protected Predicate<ImmutablePlan> filterPlans(String searchTerm,
                                               boolean fuzzySearch)