com.capitalone.dashboard.rest.ScopeController Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Hygieia Rest API Layer
There is a newer version: 3.4.53
package com.capitalone.dashboard.rest;


import com.capitalone.dashboard.model.DataResponse;
import com.capitalone.dashboard.model.Scope;
import com.capitalone.dashboard.service.ScopeService;
import com.capitalone.dashboard.util.PaginationHeaderUtility;
import org.bson.types.ObjectId;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
import static org.springframework.web.bind.annotation.RequestMethod.GET;

/**
 * REST service managing all requests to the feature repository.
 *
 * @author KFK884
 *
 */
@RestController
public class ScopeController {
	private final ScopeService scopeService;
	private PaginationHeaderUtility paginationHeaderUtility;

	@Autowired
	public ScopeController(ScopeService scopeService,PaginationHeaderUtility paginationHeaderUtility) {
		this.scopeService = scopeService;
		this.paginationHeaderUtility = paginationHeaderUtility;
	}

	/**
	 * REST endpoint for retrieving all features for a given sprint and team
	 * (the sprint is derived) A given scope-owner's source-system ID
	 *
	 * @param cId
	 * @param scopeId
	 * @return A data response list of type Feature containing all features for
	 *         the given team and current sprint
	 */
	@RequestMapping(value = "/scope/{scopeId}", method = GET, produces = APPLICATION_JSON_VALUE)
	public DataResponse> scope(
			@RequestParam(value = "component", required = true) String cId,
			@PathVariable String scopeId) {
		ObjectId componentId = new ObjectId(cId);
		return this.scopeService.getScope(componentId, scopeId);
	}

	/**
	 * Return list of Teams
	 *
	 * @param collectorId
	 *
	 * @return projects
	 */
	@RequestMapping(value = "/scopecollector/{collectorId}", method = GET, produces = APPLICATION_JSON_VALUE)
	public List teamsByCollector(
			@PathVariable String collectorId) {
		return this.scopeService.getScopesByCollector(new ObjectId(collectorId));
	}


	/**
	 * REST endpoint for retrieving all features for a given sprint and team
	 * (the sprint is derived)
	 *
	 * @return scopes
	 */
	@RequestMapping(value = "/scope", method = GET, produces = APPLICATION_JSON_VALUE)
	public List allScopes() {
		return this.scopeService.getAllScopes();
	}

	/**
	 * Return list of teams with pagination
	 *
	 * @param collectorId
	 * @param descriptionFilter
	 * @param pageable
	 *
	 * @return List of scope
	 */
	@RequestMapping(value = "/scopecollector/page/{collectorId}", method = GET, produces = APPLICATION_JSON_VALUE)
	public ResponseEntity> teamsByCollectorPage(
			@PathVariable String collectorId,@RequestParam(value = "search", required = false, defaultValue = "") String descriptionFilter, @PageableDefault(size = Integer.MAX_VALUE) Pageable pageable) {
		Page pageOfScopeItems = scopeService.getScopeByCollectorWithFilter(new ObjectId(collectorId),descriptionFilter,pageable);
		return ResponseEntity
				.ok()
				.headers(paginationHeaderUtility.buildPaginationHeaders(pageOfScopeItems))
				.body(pageOfScopeItems.getContent());
	}

}