AS-3092: Implement BenchmarkPerUnitEndpointsImpl.

Author: hwang-vividsolutions

farms-api/farms-api-rest-endpoints/src/main/java/ca/bc/gov/farms/api/rest/v1/endpoints/BenchmarkPerUnitEndpoints.java

@@ -8,6 +8,7 @@
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 
@@ -30,6 +31,25 @@
 @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
 public interface BenchmarkPerUnitEndpoints {
 
+    @Operation(operationId = "Get Benchmark Per Unit resource by Program Year.", summary = "Get Benchmark Per Unit resource by Program Year.", extensions = {
+            @Extension(properties = {
+                    @ExtensionProperty(name = "auth-type", value = "#{wso2.x-auth-type.app_and_app_user}"),
+                    @ExtensionProperty(name = "throttling-tier", value = "Unlimited") }) })
+    @Parameters({
+            @Parameter(name = HeaderConstants.REQUEST_ID_HEADER, description = HeaderConstants.REQUEST_ID_HEADER_DESCRIPTION, required = false, schema = @Schema(implementation = String.class), in = ParameterIn.HEADER),
+            @Parameter(name = HeaderConstants.VERSION_HEADER, description = HeaderConstants.VERSION_HEADER_DESCRIPTION, required = false, schema = @Schema(implementation = Integer.class), in = ParameterIn.HEADER),
+            @Parameter(name = HeaderConstants.CACHE_CONTROL_HEADER, description = HeaderConstants.CACHE_CONTROL_DESCRIPTION, required = false, schema = @Schema(implementation = String.class), in = ParameterIn.HEADER),
+            @Parameter(name = HeaderConstants.PRAGMA_HEADER, description = HeaderConstants.PRAGMA_HEADER_DESCRIPTION, required = false, schema = @Schema(implementation = String.class), in = ParameterIn.HEADER),
+            @Parameter(name = HeaderConstants.AUTHORIZATION_HEADER, description = HeaderConstants.AUTHORIZATION_HEADER_DESCRIPTION, required = false, schema = @Schema(implementation = String.class), in = ParameterIn.HEADER)
+    })
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = BenchmarkPerUnitRsrc.class)), headers = @Header(name = HeaderConstants.ETAG_HEADER, schema = @Schema(implementation = String.class), description = HeaderConstants.ETAG_DESCRIPTION)),
+            @ApiResponse(responseCode = "500", description = "Internal Server Error", content = @Content(schema = @Schema(implementation = MessageListRsrc.class))) })
+    @GET
+    @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+    public Response getBenchmarkPerUnitsByProgramYear(
+            @Parameter(description = "The identifier of the Benchmark Per Unit resource.") @QueryParam("programYear") Integer programYear);
+
     @Operation(operationId = "Get Benchmark Per Unit resource by Benchmark Per Unit Id.", summary = "Get Benchmark Per Unit resource by Benchmark Per Unit Id.", extensions = {
             @Extension(properties = {
                     @ExtensionProperty(name = "auth-type", value = "#{wso2.x-auth-type.app_and_app_user}"),

farms-api/farms-api-rest-endpoints/src/main/java/ca/bc/gov/farms/api/rest/v1/endpoints/impl/BenchmarkPerUnitEndpointsImpl.java

@@ -20,6 +20,28 @@ public class BenchmarkPerUnitEndpointsImpl extends BaseEndpointsImpl implements
     @Autowired
     private BenchmarkPerUnitService service;
 
+    @Override
+    public Response getBenchmarkPerUnitsByProgramYear(Integer programYear) {
+        logger.debug("<getBenchmarkPerUnitsByProgramYear");
+
+        Response response = null;
+
+        logRequest();
+
+        try {
+            BenchmarkPerUnitListRsrc result = (BenchmarkPerUnitListRsrc) service
+                    .getBenchmarkPerUnitsByProgramYear(programYear, getFactoryContext());
+            response = Response.ok(result).tag(result.getUnquotedETag()).build();
+        } catch (Throwable t) {
+            response = getInternalServerErrorResponse(t);
+        }
+
+        logResponse(response);
+
+        logger.debug(">getBenchmarkPerUnitsByProgramYear " + response);
+        return response;
+    }
+
     @Override
     public Response getBenchmarkPerUnit(Long benchmarkPerUnitId) {
         logger.debug("<getBenchmarkPerUnit");
@@ -28,15 +50,9 @@ public Response getBenchmarkPerUnit(Long benchmarkPerUnitId) {
         logRequest();
 
         try {
-            if (benchmarkPerUnitId == null) {
-                BenchmarkPerUnitListRsrc result = (BenchmarkPerUnitListRsrc) service
-                        .getBenchmarkPerUnitList(getFactoryContext());
-                response = Response.ok(result).tag(result.getUnquotedETag()).build();
-            } else {
-                BenchmarkPerUnitRsrc result = (BenchmarkPerUnitRsrc) service.getBenchmarkPerUnit(benchmarkPerUnitId,
-                        getFactoryContext());
-                response = Response.ok(result).tag(result.getUnquotedETag()).build();
-            }
+            BenchmarkPerUnitRsrc result = (BenchmarkPerUnitRsrc) service.getBenchmarkPerUnit(benchmarkPerUnitId,
+                    getFactoryContext());
+            response = Response.ok(result).tag(result.getUnquotedETag()).build();
         } catch (NotFoundException e) {
             response = Response.status(Response.Status.NOT_FOUND).build();
         } catch (Throwable t) {

farms-api/farms-persistence/src/main/java/ca/bc/gov/farms/persistence/v1/dao/BenchmarkPerUnitDao.java

@@ -11,7 +11,7 @@ public interface BenchmarkPerUnitDao extends Serializable {
 
     BenchmarkPerUnitDto fetch(Long benchmarkPerUnitId) throws DaoException;
 
-    List<BenchmarkPerUnitDto> fetchAll() throws DaoException;
+    List<BenchmarkPerUnitDto> fetchByProgramYear(Integer programYear) throws DaoException;
 
     void insert(BenchmarkPerUnitDto dto, String userId) throws DaoException;
 

farms-api/farms-persistence/src/main/java/ca/bc/gov/farms/persistence/v1/dao/mybatis/BenchmarkPerUnitDaoImpl.java

@@ -47,19 +47,20 @@ public BenchmarkPerUnitDto fetch(Long benchmarkPerUnitId) throws DaoException {
     }
 
     @Override
-    public List<BenchmarkPerUnitDto> fetchAll() throws DaoException {
-        logger.debug("<fetchAll");
+    public List<BenchmarkPerUnitDto> fetchByProgramYear(Integer programYear) throws DaoException {
+        logger.debug("<fetchByProgramYear");
 
         List<BenchmarkPerUnitDto> dtos = null;
 
         try {
             Map<String, Object> parameters = new HashMap<>();
-            dtos = this.mapper.fetchAll(parameters);
+            parameters.put("programYear", programYear);
+            dtos = this.mapper.fetchBy(parameters);
         } catch (RuntimeException e) {
             handleException(e);
         }
 
-        logger.debug(">fetchAll " + dtos);
+        logger.debug(">fetchByProgramYear " + dtos);
         return dtos;
     }
 

farms-api/farms-persistence/src/main/java/ca/bc/gov/farms/persistence/v1/dao/mybatis/mapper/BenchmarkPerUnitMapper.java

@@ -9,7 +9,7 @@ public interface BenchmarkPerUnitMapper {
 
     BenchmarkPerUnitDto fetch(Map<String, Object> parameters);
 
-    List<BenchmarkPerUnitDto> fetchAll(Map<String, Object> parameters);
+    List<BenchmarkPerUnitDto> fetchBy(Map<String, Object> parameters);
 
     int insert(Map<String, Object> parameters);
 

farms-api/farms-persistence/src/main/resources/ca/bc/gov/farms/persistence/v1/dao/mybatis/mapper/BenchmarkPerUnitMapper.xml

@@ -41,10 +41,11 @@
         where bpu.benchmark_per_unit_id = #{benchmarkPerUnitId}
     </select>
 
-    <select id="fetchAll" resultMap="BenchmarkPerUnitDtoMap">
+    <select id="fetchBy" resultMap="BenchmarkPerUnitDtoMap">
         <include refid="selectColumns"/>
         from benchmark_per_unit bpu
-        order by bpu.program_year, bpu.unit_comment
+        where bpu.program_year = #{programYear}
+        order by bpu.unit_comment
     </select>
 
     <insert id="insert">

farms-api/farms-service-api/src/main/java/ca/bc/gov/farms/service/api/v1/BenchmarkPerUnitService.java

@@ -12,7 +12,7 @@
 public interface BenchmarkPerUnitService {
 
     @Transactional(readOnly = true, rollbackFor = Exception.class)
-    BenchmarkPerUnitList<? extends BenchmarkPerUnit> getBenchmarkPerUnitList(FactoryContext factoryContext)
+    BenchmarkPerUnitList<? extends BenchmarkPerUnit> getBenchmarkPerUnitsByProgramYear(Integer programYear, FactoryContext factoryContext)
             throws ServiceException;
 
     @Transactional(readOnly = true, rollbackFor = Exception.class)

farms-api/farms-service-api/src/main/java/ca/bc/gov/farms/service/api/v1/impl/BenchmarkPerUnitServiceImpl.java

@@ -1,6 +1,5 @@
 package ca.bc.gov.farms.service.api.v1.impl;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Properties;
 
@@ -52,21 +51,21 @@ public void setBenchmarkPerUnitDao(BenchmarkPerUnitDao benchmarkPerUnitDao) {
     }
 
     @Override
-    public BenchmarkPerUnitList<? extends BenchmarkPerUnit> getBenchmarkPerUnitList(FactoryContext factoryContext)
-            throws ServiceException {
-        logger.debug("<getBenchmarkPerUnitList");
+    public BenchmarkPerUnitList<? extends BenchmarkPerUnit> getBenchmarkPerUnitsByProgramYear(Integer programYear,
+            FactoryContext factoryContext) throws ServiceException {
+        logger.debug("<getBenchmarkPerUnitsByProgramYear");
 
         BenchmarkPerUnitList<? extends BenchmarkPerUnit> result = null;
 
         try {
-            List<BenchmarkPerUnitDto> dtos = benchmarkPerUnitDao.fetchAll();
+            List<BenchmarkPerUnitDto> dtos = benchmarkPerUnitDao.fetchByProgramYear(programYear);
 
             result = benchmarkPerUnitFactory.getBenchmarkPerUnitList(dtos, factoryContext);
         } catch (DaoException e) {
             throw new ServiceException("DAO threw an exception", e);
         }
 
-        logger.debug(">getBenchmarkPerUnitList");
+        logger.debug(">getBenchmarkPerUnitsByProgramYear");
         return result;
     }