Package com.atlassian.bamboo.plugins.rest.resource

Class SearchResource

java.lang.Object

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

@Path("search")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
@Singleton
public class SearchResource
extends Object

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

Modifier and Type	Method	Description
protected Predicate<ImmutablePlan>	filterPlans(String searchTerm, boolean fuzzySearch, boolean searchAtShortPlanNameOnly)
SearchResultsList	searchAuthors(String searchTerm, boolean unlinkedOnly, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchBranches(String masterPlanKeyStr, boolean includeMasterBranch, Long releasedInDeployment, String searchTerm, boolean fuzzySearch, boolean searchByBranchNameOnly, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchDeployments(String searchTerm, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchJobs(String planKey, String searchTerm, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchPlans(String searchTerm, boolean fuzzySearch, String planType, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchProjects(String searchTerm, String requiredPermission, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchStages(String planKey, String stageId, String searchTerm, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchUsers(String searchTerm, javax.ws.rs.core.UriInfo uriInfo)
SearchResultsList	searchVersions(String searchTerm, long deploymentProjectId, String branchKey, boolean chronologicalOrder, javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResource

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

Method Details

searchUsers

@GET
@Path("users")
public SearchResultsList searchUsers(@QueryParam("searchTerm")
 String searchTerm,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                              throws Exception

Throws:

Exception

searchAuthors

@GET
@Path("authors")
public SearchResultsList searchAuthors(@QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("unlinkedOnly")
 boolean unlinkedOnly,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchPlans

@GET
@Path("plans")
public SearchResultsList searchPlans(@QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("fuzzy")
 boolean fuzzySearch,
 @QueryParam("type")
 String planType,
 @QueryParam("permission")
 String requiredPermission,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchJobs

@GET
@Path("jobs/{planKey}")
public SearchResultsList searchJobs(@PathParam("planKey")
 String planKey,
 @QueryParam("searchTerm")
 String searchTerm,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchStages

@GET
@Path("stages/{planKey}")
public SearchResultsList searchStages(@PathParam("planKey")
 String planKey,
 @QueryParam("stageId")
 String stageId,
 @QueryParam("searchTerm")
 String searchTerm,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchBranches

@GET
@Path("branches")
public SearchResultsList searchBranches(@QueryParam("masterPlanKey")
 String masterPlanKeyStr,
 @QueryParam("includeMasterBranch")
 boolean includeMasterBranch,
 @QueryParam("releasedInDeployment")
 Long releasedInDeployment,
 @QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("fuzzy")
 boolean fuzzySearch,
 @QueryParam("branchNameOnly")
 boolean searchByBranchNameOnly,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchProjects

@GET
@Path("projects")
public SearchResultsList searchProjects(@QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("permission")
 String requiredPermission,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchDeployments

@GET
@Path("deployments")
public SearchResultsList searchDeployments(@QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("permission")
 String requiredPermission,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

searchVersions

@GET
@Path("versions")
public SearchResultsList searchVersions(@QueryParam("searchTerm")
 String searchTerm,
 @QueryParam("deploymentProjectId")
 long deploymentProjectId,
 @QueryParam("branchKey")
 String branchKey,
 @QueryParam("chronologicalOrder")
 boolean chronologicalOrder,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)

filterPlans

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