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