ServiceLevelAgreementRestController.java

package com.thinkbiganalytics.feedmgr.rest.controller;

/*-
 * #%L
 * thinkbig-feed-manager-controller
 * %%
 * Copyright (C) 2017 ThinkBig Analytics
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.thinkbiganalytics.feedmgr.InvalidOperationException;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementActionUiConfigurationItem;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementGroup;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementMetricTransformerHelper;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementModelTransform;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementRule;
import com.thinkbiganalytics.feedmgr.sla.ServiceLevelAgreementService;
import com.thinkbiganalytics.metadata.api.MetadataAccess;
import com.thinkbiganalytics.metadata.api.sla.FeedServiceLevelAgreementProvider;
import com.thinkbiganalytics.metadata.modeshape.JcrMetadataAccess;
import com.thinkbiganalytics.metadata.rest.model.sla.FeedServiceLevelAgreement;
import com.thinkbiganalytics.metadata.rest.model.sla.ServiceLevelAgreement;
import com.thinkbiganalytics.metadata.rest.model.sla.ServiceLevelAssessment;
import com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreementActionValidation;
import com.thinkbiganalytics.metadata.sla.spi.ServiceLevelAgreementProvider;
import com.thinkbiganalytics.metadata.sla.spi.ServiceLevelAssessor;
import com.thinkbiganalytics.rest.model.RestResponseStatus;
import com.thinkbiganalytics.rest.model.beanvalidation.UUID;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

import javax.inject.Inject;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.SwaggerDefinition;
import io.swagger.annotations.Tag;

@Api(tags = "Feed Manager - SLA", produces = "application/json")
@Path("/v1/feedmgr/sla")
@Component
@SwaggerDefinition(tags = @Tag(name = "Feed Manager - SLA", description = "service level agreements"))
public class ServiceLevelAgreementRestController {

    private static final Logger log = LoggerFactory.getLogger(ServiceLevelAgreementRestController.class);

    @Inject
    ServiceLevelAgreementService serviceLevelAgreementService;
    @Inject
    ServiceLevelAssessor assessor;
    @Inject
    private ServiceLevelAgreementProvider provider;
    @Inject
    private FeedServiceLevelAgreementProvider feedSlaProvider;
    @Inject
    private JcrMetadataAccess metadata;
    @Inject
    private MetadataAccess metadataAccess;
    @Inject
    private ServiceLevelAgreementModelTransform serviceLevelAgreementTransform;

    @GET
    @Path("/available-metrics")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets the list of available metrics.")
    @ApiResponses(
        @ApiResponse(code = 200, message = "Returns the metrics.", response = ServiceLevelAgreementRule.class, responseContainer = "List")
    )
    public Response getAvailableSLAMetrics() {
        return Response.ok(serviceLevelAgreementService.discoverSlaMetrics()).build();
    }

    @GET
    @Path("/available-responders")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets the list of available responders.")
    @ApiResponses(
        @ApiResponse(code = 200, message = "Returns the responders.", response = ServiceLevelAgreementActionUiConfigurationItem.class, responseContainer = "List")
    )
    public Response getAvailableSLAResponders() {
        return Response.ok(serviceLevelAgreementService.discoverActionConfigurations()).build();
    }

    /**
     * Save the General SLA coming in from the UI that is not related to a Feed
     */
    @POST
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Saves the specified SLA.")
    @ApiResponses({
                      @ApiResponse(code = 200, message = "Returns the SLA.", response = ServiceLevelAgreementGroup.class),
                      @ApiResponse(code = 500, message = "The SLA could not be saved.", response = RestResponseStatus.class)
                  })
    public Response saveSla(ServiceLevelAgreementGroup sla) {
        ServiceLevelAgreement serviceLevelAgreement = serviceLevelAgreementService.saveAndScheduleSla(sla);
        ServiceLevelAgreementMetricTransformerHelper helper = new ServiceLevelAgreementMetricTransformerHelper();
        ServiceLevelAgreementGroup serviceLevelAgreementGroup = helper.toServiceLevelAgreementGroup(serviceLevelAgreement);
        return Response.ok(serviceLevelAgreementGroup).build();
    }

    /**
     * Save an SLA and attach the ref to the Feed
     */
    @POST
    @Path("/feed/{feedId}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Saves the SLA and attaches it to the specified feed.")
    @ApiResponses({
                      @ApiResponse(code = 200, message = "Returns the SLA.", response = ServiceLevelAgreementGroup.class),
                      @ApiResponse(code = 400, message = "The feedId is not a valid UUID.", response = RestResponseStatus.class),
                      @ApiResponse(code = 500, message = "The SLA could not be saved.", response = RestResponseStatus.class)
                  })
    public Response saveAndScheduleFeedSla(@UUID @PathParam("feedId") String feedId, ServiceLevelAgreementGroup sla) {
        ServiceLevelAgreement serviceLevelAgreement = serviceLevelAgreementService.saveAndScheduleFeedSla(sla, feedId);
        ServiceLevelAgreementMetricTransformerHelper helper = new ServiceLevelAgreementMetricTransformerHelper();
        ServiceLevelAgreementGroup serviceLevelAgreementGroup = helper.toServiceLevelAgreementGroup(serviceLevelAgreement);
        return Response.ok(serviceLevelAgreementGroup).build();
    }


    /**
     * Delete an SLA
     */
    @DELETE
    @Path("/{slaId}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Deletes the specified SLA.")
    @ApiResponses({
                      @ApiResponse(code = 204, message = "The SLA has been deleted."),
                      @ApiResponse(code = 400, message = "The slaId is not a valid UUID.", response = RestResponseStatus.class),
                      @ApiResponse(code = 500, message = "The SLA could not be deleted.", response = RestResponseStatus.class)
                  })
    public Response deleteSla(@UUID @PathParam("slaId") String slaId) throws InvalidOperationException {
        serviceLevelAgreementService.removeAndUnscheduleAgreement(slaId);

        return Response.ok().build();
    }


    @GET
    @Path("/feed")
    @Produces({MediaType.APPLICATION_JSON})
    @ApiOperation("Gets all SLAs related to any feed.")
    @ApiResponses(
        @ApiResponse(code = 200, message = "Returns the SLAs.", response = FeedServiceLevelAgreement.class, responseContainer = "List")
    )
    public Response getAllSlas() {
        List<FeedServiceLevelAgreement> agreementList = serviceLevelAgreementService.getServiceLevelAgreements();
        if (agreementList == null) {
            agreementList = new ArrayList<>();
        }
        return Response.ok(agreementList).build();
    }

    @GET
    @Path("/{slaId}/form-object")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets the form for editing the specified SLA.")
    @ApiResponses({
                      @ApiResponse(code = 200, message = "Returns the SLA form.", response = ServiceLevelAgreementGroup.class),
                      @ApiResponse(code = 400, message = "The slaId is not a valid UUID.", response = RestResponseStatus.class)
                  })
    public Response getSlaAsForm(@UUID @PathParam("slaId") String slaId) {
        ServiceLevelAgreementGroup agreement = serviceLevelAgreementService.getServiceLevelAgreementAsFormObject(slaId);

        return Response.ok(agreement).build();
    }


    @GET
    @Path("/action/validate")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Validates the specified action configuration.")
    @ApiResponses(
        @ApiResponse(code = 200, message = "Returns the validation.", response = ServiceLevelAgreementActionValidation.class)
    )
    public Response validateAction(@QueryParam("actionConfigClass") String actionConfigClass) {

        List<ServiceLevelAgreementActionValidation> validation = serviceLevelAgreementService.validateAction(actionConfigClass);
        return Response.ok(validation).build();
    }

// TODO: this method was conflicting with saveSla()
//    @POST
//    @Consumes(MediaType.APPLICATION_JSON)
//    @Produces(MediaType.APPLICATION_JSON)
//    public ServiceLevelAgreement createAgreement(ServiceLevelAgreement agreement) {
//        log.debug("POST Create SLA {}", agreement);
//
//        return this.metadata.commit(() -> {
//            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreement domainSla
//                = ServiceLevelAgreementModelTransform.generateDomain(agreement, this.provider);
//
//            return ServiceLevelAgreementModelTransform.DOMAIN_TO_SLA.apply(domainSla);
//        });
//    }

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets all SLAs.")
    @ApiResponses(
        @ApiResponse(code = 200, message = "Returns the SLAs.", response = FeedServiceLevelAgreement.class, responseContainer = "List")
    )
    public List<FeedServiceLevelAgreement> getAgreements() {
        log.debug("GET all SLA's");

        return this.metadata.commit(() -> {
            List<com.thinkbiganalytics.metadata.api.sla.FeedServiceLevelAgreement> agreements = feedSlaProvider.findAllAgreements();
            if (agreements != null) {
                return serviceLevelAgreementTransform.transformFeedServiceLevelAgreements(agreements);
            }

            return new ArrayList<>(0);
        });
    }

    @GET
    @Path("{id}")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets the specified SLA.")
    @ApiResponses({
                      @ApiResponse(code = 200, message = "Returns the SLA.", response = ServiceLevelAgreement.class),
                      @ApiResponse(code = 404, message = "The SLA could not be found.", response = RestResponseStatus.class)
                  })
    public ServiceLevelAgreement getAgreement(@PathParam("id") String idValue) {
        log.debug("GET SLA by ID: {}", idValue);

        return this.metadata.commit(() -> {
            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreement.ID id = this.provider.resolve(idValue);
            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreement sla = this.provider.getAgreement(id);

            if (sla != null) {
                return ServiceLevelAgreementModelTransform.DOMAIN_TO_SLA.apply(sla);
            } else {
                throw new WebApplicationException("No SLA with the given ID was found", Response.Status.NOT_FOUND);
            }
        });
    }

    @GET
    @Path("{id}/assessment")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiOperation("Gets the specified assessment.")
    @ApiResponses({
                      @ApiResponse(code = 200, message = "Returns the assessment.", response = ServiceLevelAgreement.class),
                      @ApiResponse(code = 400, message = "The assessment could not be found.", response = RestResponseStatus.class)
                  })
    public ServiceLevelAssessment assessAgreement(@PathParam("id") String idValue) {
        log.debug("GET SLA by ID: {}", idValue);

        return this.metadata.read(() -> {
            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreement.ID id = this.provider.resolve(idValue);
            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAgreement sla = this.provider.getAgreement(id);
            com.thinkbiganalytics.metadata.sla.api.ServiceLevelAssessment assessment = this.assessor.assess(sla);

            return ServiceLevelAgreementModelTransform.DOMAIN_TO_SLA_ASSMT.apply(assessment);
        });
    }
}