gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2021 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.clamp.controlloop.participant.simulator.main.rest;
  22
  23 import io.swagger.annotations.Api;
  24 import io.swagger.annotations.BasicAuthDefinition;
  25 import io.swagger.annotations.Info;
  26 import io.swagger.annotations.SecurityDefinition;
  27 import io.swagger.annotations.SwaggerDefinition;
  28 import io.swagger.annotations.Tag;
  29 import java.net.HttpURLConnection;
  30 import javax.ws.rs.core.MediaType;
  31 import lombok.AccessLevel;
  32 import lombok.Getter;
  33 import org.onap.policy.clamp.controlloop.participant.simulator.simulation.SimulationProvider;
  34 import org.springframework.web.bind.annotation.RequestMapping;
  35
  36 /**
  37  * Common superclass to provide REST endpoints for the participant simulator.
  38  */
  39 // @formatter:off
  40 @RequestMapping(value = "/v2", produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML})
  41 @Api(value = "Participant Simulator API")
  42 @SwaggerDefinition(
  43     info = @Info(description =
  44                     "Participant Simulator", version = "v1.0",
  45                     title = "Participant Simulator"),
  46     consumes = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML},
  47     produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML},
  48     schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
  49     tags = {@Tag(name = "participantsim", description = "Participant Simulator")},
  50     securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
  51 // @formatter:on
  52 public abstract class AbstractRestController {
  53     public static final String APPLICATION_YAML = "application/yaml";
  54
  55     public static final String EXTENSION_NAME = "interface info";
  56
  57     public static final String API_VERSION_NAME = "api-version";
  58     public static final String API_VERSION = "1.0.0";
  59
  60     public static final String LAST_MOD_NAME = "last-mod-release";
  61     public static final String LAST_MOD_RELEASE = "Dublin";
  62
  63     public static final String VERSION_MINOR_NAME = "X-MinorVersion";
  64     public static final String VERSION_MINOR_DESCRIPTION =
  65             "Used to request or communicate a MINOR version back from the client"
  66                     + " to the server, and from the server back to the client";
  67
  68     public static final String VERSION_PATCH_NAME = "X-PatchVersion";
  69     public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for"
  70             + " troubleshooting purposes only, and will not be provided by" + " the client on request";
  71
  72     public static final String VERSION_LATEST_NAME = "X-LatestVersion";
  73     public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version";
  74
  75     public static final String REQUEST_ID_NAME = "X-ONAP-RequestID";
  76     public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose";
  77     public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction";
  78
  79     public static final String AUTHORIZATION_TYPE = "basicAuth";
  80
  81     public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED;
  82     public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN;
  83     public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR;
  84
  85     public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error";
  86     public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error";
  87     public static final String SERVER_ERROR_MESSAGE = "Internal Server Error";
  88
  89     @Getter(AccessLevel.PROTECTED)
  90     // The provider for simulation requests
  91     private SimulationProvider simulationProvider;
  92
  93     /**
  94      * create a Rest Controller.
  95      *
  96      * @param simulationProvider the provider for the simulation participant
  97      */
  98     protected AbstractRestController(SimulationProvider simulationProvider) {
  99         this.simulationProvider = simulationProvider;
 100     }
 101
 102 }