main/src/main/java/org/onap/policy/pap/main/rest/PapRestControllerV1.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   5  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.pap.main.rest;
  24
  25 import io.swagger.annotations.BasicAuthDefinition;
  26 import io.swagger.annotations.Info;
  27 import io.swagger.annotations.SecurityDefinition;
  28 import io.swagger.annotations.SwaggerDefinition;
  29 import io.swagger.annotations.Tag;
  30 import java.net.HttpURLConnection;
  31 import java.util.UUID;
  32 import javax.ws.rs.core.MediaType;
  33 import org.onap.policy.models.base.PfModelException;
  34 import org.springframework.http.ResponseEntity.BodyBuilder;
  35 import org.springframework.security.core.Authentication;
  36 import org.springframework.security.core.context.SecurityContextHolder;
  37
  38 /**
  39  * Version v1 common superclass to provide REST endpoints for PAP component.
  40  *
  41  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  42  */
  43 // @formatter:off
  44 @SwaggerDefinition(
  45     info = @Info(description =
  46                     "Policy Administration is responsible for the deployment life cycle of policies as well as "
  47                     + "interworking with the mechanisms required to orchestrate the nodes and containers on which "
  48                     + "policies run. It is also responsible for the administration of policies at run time;"
  49                     + " ensuring that policies are available to users, that policies are executing correctly,"
  50                     + " and that the state and status of policies is monitored", version = "v1.0",
  51                     title = "Policy Administration"),
  52     consumes = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
  53     produces = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
  54     schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
  55     tags = {@Tag(name = "policy-administration", description = "Policy Administration Service Operations")},
  56     securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
  57 // @formatter:on
  58 public class PapRestControllerV1 {
  59     public static final String APPLICATION_YAML = "application/yaml";
  60
  61     public static final String EXTENSION_NAME = "interface info";
  62
  63     public static final String API_VERSION_NAME = "api-version";
  64     public static final String API_VERSION = "1.0.0";
  65
  66     public static final String LAST_MOD_NAME = "last-mod-release";
  67     public static final String LAST_MOD_RELEASE = "Dublin";
  68
  69     public static final String VERSION_MINOR_NAME = "X-MinorVersion";
  70     public static final String VERSION_MINOR_DESCRIPTION =
  71             "Used to request or communicate a MINOR version back from the client"
  72                     + " to the server, and from the server back to the client";
  73
  74     public static final String VERSION_PATCH_NAME = "X-PatchVersion";
  75     public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for"
  76             + " troubleshooting purposes only, and will not be provided by" + " the client on request";
  77
  78     public static final String VERSION_LATEST_NAME = "X-LatestVersion";
  79     public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version";
  80
  81     public static final String REQUEST_ID_NAME = "X-ONAP-RequestID";
  82     public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose";
  83     public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction";
  84
  85     public static final String AUTHORIZATION_TYPE = "basicAuth";
  86
  87     public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED;
  88     public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN;
  89     public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR;
  90
  91     public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error";
  92     public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error";
  93     public static final String SERVER_ERROR_MESSAGE = "Internal Server Error";
  94
  95     /**
  96      * Adds version headers to the response.
  97      *
  98      * @param respBuilder response builder
  99      * @return the response builder, with version headers
 100      */
 101     public static BodyBuilder addVersionControlHeaders(BodyBuilder respBuilder) {
 102         return respBuilder.header(VERSION_MINOR_NAME, "0").header(VERSION_PATCH_NAME, "0").header(VERSION_LATEST_NAME,
 103                 API_VERSION);
 104     }
 105
 106     /**
 107      * Adds logging headers to the response.
 108      *
 109      * @param respBuilder response builder
 110      * @return the response builder, with version logging
 111      */
 112     public static BodyBuilder addLoggingHeaders(BodyBuilder respBuilder, UUID requestId) {
 113         if (requestId == null) {
 114             // Generate a random uuid if client does not embed requestId in rest request
 115             return respBuilder.header(REQUEST_ID_NAME, UUID.randomUUID().toString());
 116         }
 117
 118         return respBuilder.header(REQUEST_ID_NAME, requestId.toString());
 119     }
 120
 121     /**
 122      * Get the user principal name from security context.
 123      * @return username as {@link String}
 124      */
 125     public String getPrincipal() {
 126         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
 127         if (authentication != null) {
 128             return authentication.getName();
 129         }
 130         return "";
 131     }
 132
 133     /**
 134      * Functions that throw {@link PfModelException}.
 135      */
 136     @FunctionalInterface
 137     public static interface RunnableWithPfEx {
 138         public void run() throws PfModelException;
 139     }
 140 }