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