SLAs for async methods

[policy/pap.git] / main / src / main / java / org / onap / policy / pap / main / rest / PapRestControllerV1.java

diff --git a/main/src/main/java/org/onap/policy/pap/main/rest/PapRestControllerV1.java b/main/src/main/java/org/onap/policy/pap/main/rest/PapRestControllerV1.java
index ccdebc3..01b539e 100644 (file)
--- a/main/src/main/java/org/onap/policy/pap/main/rest/PapRestControllerV1.java
+++ b/main/src/main/java/org/onap/policy/pap/main/rest/PapRestControllerV1.java
@@ -1,7 +1,8 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2019-2022 Nordix Foundation.
  *  Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,18 +22,19 @@
 
 package org.onap.policy.pap.main.rest;
 
-import io.swagger.annotations.Api;
 import io.swagger.annotations.BasicAuthDefinition;
 import io.swagger.annotations.Info;
 import io.swagger.annotations.SecurityDefinition;
 import io.swagger.annotations.SwaggerDefinition;
 import io.swagger.annotations.Tag;
 import java.net.HttpURLConnection;
+import java.util.Objects;
 import java.util.UUID;
-import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response.ResponseBuilder;
+import org.onap.policy.models.base.PfModelException;
+import org.springframework.http.ResponseEntity.BodyBuilder;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
 
 /**
  * Version v1 common superclass to provide REST endpoints for PAP component.
@@ -40,9 +42,6 @@ import javax.ws.rs.core.Response.ResponseBuilder;
  * @author Ram Krishna Verma (ram.krishna.verma@est.tech)
  */
 // @formatter:off
-@Path("/policy/pap/v1")
-@Api(value = "Policy Administration (PAP) API")
-@Produces(MediaType.APPLICATION_JSON)
 @SwaggerDefinition(
     info = @Info(description =
                     "Policy Administration is responsible for the deployment life cycle of policies as well as "
@@ -51,13 +50,15 @@ import javax.ws.rs.core.Response.ResponseBuilder;
                     + " ensuring that policies are available to users, that policies are executing correctly,"
                     + " and that the state and status of policies is monitored", version = "v1.0",
                     title = "Policy Administration"),
-    consumes = {MediaType.APPLICATION_JSON},
-    produces = {MediaType.APPLICATION_JSON},
+    consumes = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
+    produces = {MediaType.APPLICATION_JSON, PapRestControllerV1.APPLICATION_YAML},
     schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
     tags = {@Tag(name = "policy-administration", description = "Policy Administration Service Operations")},
     securityDefinition = @SecurityDefinition(basicAuthDefinitions = {@BasicAuthDefinition(key = "basicAuth")}))
 // @formatter:on
 public class PapRestControllerV1 {
+    public static final String APPLICATION_YAML = "application/yaml";
+
     public static final String EXTENSION_NAME = "interface info";
 
     public static final String API_VERSION_NAME = "api-version";
@@ -68,12 +69,12 @@ public class PapRestControllerV1 {
 
     public static final String VERSION_MINOR_NAME = "X-MinorVersion";
     public static final String VERSION_MINOR_DESCRIPTION =
-                    "Used to request or communicate a MINOR version back from the client"
-                                    + " to the server, and from the server back to the client";
+            "Used to request or communicate a MINOR version back from the client"
+                    + " to the server, and from the server back to the client";
 
     public static final String VERSION_PATCH_NAME = "X-PatchVersion";
     public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for"
-                    + " troubleshooting purposes only, and will not be provided by" + " the client on request";
+            + " troubleshooting purposes only, and will not be provided by" + " the client on request";
 
     public static final String VERSION_LATEST_NAME = "X-LatestVersion";
     public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version";
@@ -98,9 +99,9 @@ public class PapRestControllerV1 {
      * @param respBuilder response builder
      * @return the response builder, with version headers
      */
-    public ResponseBuilder addVersionControlHeaders(ResponseBuilder respBuilder) {
+    public static BodyBuilder addVersionControlHeaders(BodyBuilder respBuilder) {
         return respBuilder.header(VERSION_MINOR_NAME, "0").header(VERSION_PATCH_NAME, "0").header(VERSION_LATEST_NAME,
-                        API_VERSION);
+                API_VERSION);
     }
 
     /**
@@ -109,12 +110,29 @@ public class PapRestControllerV1 {
      * @param respBuilder response builder
      * @return the response builder, with version logging
      */
-    public ResponseBuilder addLoggingHeaders(ResponseBuilder respBuilder, UUID requestId) {
-        if (requestId == null) {
-            // Generate a random uuid if client does not embed requestId in rest request
-            return respBuilder.header(REQUEST_ID_NAME, UUID.randomUUID());
+    public static BodyBuilder addLoggingHeaders(BodyBuilder respBuilder, UUID requestId) {
+        // Generate a random uuid if client does not embed requestId in rest request
+        return respBuilder.header(REQUEST_ID_NAME,
+            Objects.requireNonNullElseGet(requestId, UUID::randomUUID).toString());
+    }
+
+    /**
+     * Get the user principal name from security context.
+     * @return username as {@link String}
+     */
+    public String getPrincipal() {
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        if (authentication != null) {
+            return authentication.getName();
         }
+        return "";
+    }
 
-        return respBuilder.header(REQUEST_ID_NAME, requestId);
+    /**
+     * Functions that throw {@link PfModelException}.
+     */
+    @FunctionalInterface
+    public interface RunnableWithPfEx {
+        void run() throws PfModelException;
     }
 }