1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*-
* ============LICENSE_START=======================================================
* 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.pap.main.rest;
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.core.MediaType;
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.
*
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
// @formatter:off
@SwaggerDefinition(
info = @Info(description =
"Policy Administration is responsible for the deployment life cycle of policies as well as "
+ "interworking with the mechanisms required to orchestrate the nodes and containers on which "
+ "policies run. It is also responsible for the administration of policies at run time;"
+ " 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, 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";
public static final String API_VERSION = "1.0.0";
public static final String LAST_MOD_NAME = "last-mod-release";
public static final String LAST_MOD_RELEASE = "Dublin";
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";
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";
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";
public static final String REQUEST_ID_NAME = "X-ONAP-RequestID";
public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose";
public static final String REQUEST_ID_PARAM_DESCRIPTION = "RequestID for http transaction";
public static final String AUTHORIZATION_TYPE = "basicAuth";
public static final int AUTHENTICATION_ERROR_CODE = HttpURLConnection.HTTP_UNAUTHORIZED;
public static final int AUTHORIZATION_ERROR_CODE = HttpURLConnection.HTTP_FORBIDDEN;
public static final int SERVER_ERROR_CODE = HttpURLConnection.HTTP_INTERNAL_ERROR;
public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error";
public static final String AUTHORIZATION_ERROR_MESSAGE = "Authorization Error";
public static final String SERVER_ERROR_MESSAGE = "Internal Server Error";
/**
* Adds version headers to the response.
*
* @param respBuilder response builder
* @return the response builder, with version headers
*/
public static BodyBuilder addVersionControlHeaders(BodyBuilder respBuilder) {
return respBuilder.header(VERSION_MINOR_NAME, "0").header(VERSION_PATCH_NAME, "0").header(VERSION_LATEST_NAME,
API_VERSION);
}
/**
* Adds logging headers to the response.
*
* @param respBuilder response builder
* @return the response builder, with version logging
*/
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 "";
}
/**
* Functions that throw {@link PfModelException}.
*/
@FunctionalInterface
public interface RunnableWithPfEx {
void run() throws PfModelException;
}
}
|
