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 java.util.UUID;
  31 import javax.ws.rs.Path;
  32 import javax.ws.rs.Produces;
  33 import javax.ws.rs.core.MediaType;
  34 import javax.ws.rs.core.Response.ResponseBuilder;
  35 import lombok.AccessLevel;
  36 import lombok.Getter;
  37 import org.onap.policy.clamp.controlloop.participant.simulator.simulation.SimulationHandler;
  38 import org.onap.policy.clamp.controlloop.participant.simulator.simulation.SimulationProvider;
  39
  40 /**
  41  * Common superclass to provide REST endpoints for the participant simulator.
  42  */
  43 // @formatter:off
  44 @Path("/onap/participantsim/v2")
  45 @Api(value = "Participant Simulator API")
  46 @Produces({MediaType.APPLICATION_JSON, RestController.APPLICATION_YAML})
  47 @SwaggerDefinition(
  48     info = @Info(description =
  49                     "Participant Simulator", version = "v1.0",
  50                     title = "Participant Simulator"),
  51     consumes = {MediaType.APPLICATION_JSON, RestController.APPLICATION_YAML},
  52     produces = {MediaType.APPLICATION_JSON, RestController.APPLICATION_YAML},
  53     schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
  54     tags = {@Tag(name = "participantsim", description = "Participant Simulator")},
  55     securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
  56 // @formatter:on
  57 public class RestController {
  58     public static final String APPLICATION_YAML = "application/yaml";
  59
  60     public static final String EXTENSION_NAME = "interface info";
  61
  62     public static final String API_VERSION_NAME = "api-version";
  63     public static final String API_VERSION = "1.0.0";
  64
  65     public static final String LAST_MOD_NAME = "last-mod-release";
  66     public static final String LAST_MOD_RELEASE = "Dublin";
  67
  68     public static final String VERSION_MINOR_NAME = "X-MinorVersion";
  69     public static final String VERSION_MINOR_DESCRIPTION =
  70             "Used to request or communicate a MINOR version back from the client"
  71                     + " to the server, and from the server back to the client";
  72
  73     public static final String VERSION_PATCH_NAME = "X-PatchVersion";
  74     public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for"
  75             + " troubleshooting purposes only, and will not be provided by" + " the client on request";
  76
  77     public static final String VERSION_LATEST_NAME = "X-LatestVersion";
  78     public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version";
  79
  80     public static final String REQUEST_ID_NAME = "X-ONAP-RequestID";
  81     public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose";
  82     public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction";
  83
  84     public static final String AUTHORIZATION_TYPE = "basicAuth";
  85
  86     public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED;
  87     public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN;
  88     public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR;
  89
  90     public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error";
  91     public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error";
  92     public static final String SERVER_ERROR_MESSAGE = "Internal Server Error";
  93     @Getter(AccessLevel.PROTECTED)
  94     // The provider for simulation requests
  95     private SimulationProvider simulationProvider;
  96
  97
  98     /**
  99      * create a Rest Controller.
 100      */
 101     public RestController() {
 102         simulationProvider = SimulationHandler.getInstance().getSimulationProvider();
 103     }
 104
 105     /**
 106      * Adds version headers to the response.
 107      *
 108      * @param respBuilder response builder
 109      * @return the response builder, with version headers
 110      */
 111     public ResponseBuilder addVersionControlHeaders(ResponseBuilder respBuilder) {
 112         return respBuilder.header(VERSION_MINOR_NAME, "0").header(VERSION_PATCH_NAME, "0").header(VERSION_LATEST_NAME,
 113                 API_VERSION);
 114     }
 115
 116     /**
 117      * Adds logging headers to the response.
 118      *
 119      * @param respBuilder response builder
 120      * @return the response builder, with version logging
 121      */
 122     public ResponseBuilder addLoggingHeaders(ResponseBuilder respBuilder, UUID requestId) {
 123         if (requestId == null) {
 124             // Generate a random uuid if client does not embed requestId in rest request
 125             return respBuilder.header(REQUEST_ID_NAME, UUID.randomUUID());
 126         }
 127
 128         return respBuilder.header(REQUEST_ID_NAME, requestId);
 129     }
 130 }