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.runtime.main.web;
  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 org.springframework.web.bind.annotation.RequestMapping;
  32
  33 /**
  34  * Common superclass to provide REST endpoints for the participant simulator.
  35  */
  36 // @formatter:off
  37 @RequestMapping(value = "/v2", produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML})
  38 @Api(value = "Control Loop Commissioning API")
  39 @SwaggerDefinition(
  40         info = @Info(description =
  41                         "Control Loop Service", version = "v1.0",
  42                         title = "Control Loop"),
  43         consumes = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML},
  44         produces = {MediaType.APPLICATION_JSON, AbstractRestController.APPLICATION_YAML},
  45         schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
  46         tags = {@Tag(name = "controlloop", description = "Control Loop Service")},
  47         securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
  48 // @formatter:on
  49 public abstract class AbstractRestController {
  50     public static final String APPLICATION_YAML = "application/yaml";
  51
  52     public static final String EXTENSION_NAME = "interface info";
  53
  54     public static final String API_VERSION_NAME = "api-version";
  55     public static final String API_VERSION = "1.0.0";
  56
  57     public static final String LAST_MOD_NAME = "last-mod-release";
  58     public static final String LAST_MOD_RELEASE = "Dublin";
  59
  60     public static final String VERSION_MINOR_NAME = "X-MinorVersion";
  61     public static final String VERSION_MINOR_DESCRIPTION =
  62             "Used to request or communicate a MINOR version back from the client"
  63                     + " to the server, and from the server back to the client";
  64
  65     public static final String VERSION_PATCH_NAME = "X-PatchVersion";
  66     public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for"
  67             + " troubleshooting purposes only, and will not be provided by" + " the client on request";
  68
  69     public static final String VERSION_LATEST_NAME = "X-LatestVersion";
  70     public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version";
  71
  72     public static final String REQUEST_ID_NAME = "X-ONAP-RequestID";
  73     public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose";
  74     public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction";
  75
  76     public static final String AUTHORIZATION_TYPE = "basicAuth";
  77
  78     public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED;
  79     public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN;
  80     public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR;
  81
  82     public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error";
  83     public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error";
  84     public static final String SERVER_ERROR_MESSAGE = "Internal Server Error";
  85
  86     /**
  87      * Constructor.
  88      */
  89     protected AbstractRestController() {
  90     }
  91 }