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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2019, 2022 Nordix Foundation.
* Modifications Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
* Modifications Copyright (C) 2021 Bell Canada.
* ================================================================================
* 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.distribution.forwarding.lifecycle.api;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.http.client.HttpClientConfigException;
import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.distribution.forwarding.PolicyForwarder;
import org.onap.policy.distribution.forwarding.PolicyForwardingException;
import org.onap.policy.models.pap.concepts.PdpDeployPolicies;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class provides an implementation of {@link PolicyForwarder} interface for forwarding the given policies & policy
* types to the life cycle api's of policy framework.
*
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
public class LifecycleApiPolicyForwarder implements PolicyForwarder {
private static final String DEPLOY_POLICY_URI = "/policy/pap/v1/pdps/policies";
private static final String CREATE_POLICY_TYPE_URI = "/policy/api/v1/policytypes";
private static final String CREATE_POLICY_URI = "/policy/api/v1/policies";
private static final Logger LOGGER = LoggerFactory.getLogger(LifecycleApiPolicyForwarder.class);
private LifecycleApiForwarderParameters forwarderParameters;
private HttpClient apiClient;
private HttpClient papClient;
/**
* {@inheritDoc}.
*/
@Override
public void configure(final String parameterGroupName) throws HttpClientConfigException {
forwarderParameters = ParameterService.get(parameterGroupName);
apiClient = HttpClientFactoryInstance.getClientFactory().build(forwarderParameters.getApiParameters());
papClient = HttpClientFactoryInstance.getClientFactory().build(forwarderParameters.getPapParameters());
}
/**
* {@inheritDoc}.
*/
@Override
public void forward(final Collection<ToscaEntity> entities) throws PolicyForwardingException {
final List<ToscaEntity> failedEntities = new ArrayList<>();
for (final ToscaEntity entity : entities) {
forwardSingleEntity(failedEntities, entity);
}
if (!failedEntities.isEmpty()) {
throw new PolicyForwardingException(
"Failed forwarding the following entities: " + Arrays.toString(failedEntities.toArray()));
}
}
private void forwardSingleEntity(final List<ToscaEntity> failedEntities, final ToscaEntity entity) {
Response policyCreated = null;
try {
if (entity instanceof ToscaServiceTemplate) {
final var toscaServiceTemplate = (ToscaServiceTemplate) entity;
if (null != toscaServiceTemplate.getPolicyTypes() && !toscaServiceTemplate.getPolicyTypes().isEmpty()) {
createPolicyType(toscaServiceTemplate);
}
if (null != toscaServiceTemplate.getToscaTopologyTemplate()
&& null != toscaServiceTemplate.getToscaTopologyTemplate().getPolicies()
&& !toscaServiceTemplate.getToscaTopologyTemplate().getPolicies().isEmpty()
&& !toscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).entrySet().isEmpty()) {
policyCreated = createPolicy(toscaServiceTemplate);
}
if (forwarderParameters.isDeployPolicies() && policyCreated != null) {
deployPolicy(policyCreated.readEntity(ToscaServiceTemplate.class));
}
} else {
throw new PolicyForwardingException("The entity is not of type ToscaServiceTemplate - " + entity);
}
} catch (final Exception exp) {
LOGGER.error(exp.getMessage(), exp);
failedEntities.add(entity);
}
}
private void createPolicyType(final ToscaServiceTemplate toscaServiceTemplate)
throws PolicyForwardingException {
invokeHttpClient(Entity.entity(toscaServiceTemplate, MediaType.APPLICATION_JSON), CREATE_POLICY_TYPE_URI,
true);
}
private Response createPolicy(final ToscaServiceTemplate toscaServiceTemplate) throws PolicyForwardingException {
return invokeHttpClient(Entity.entity(toscaServiceTemplate, MediaType.APPLICATION_JSON),
CREATE_POLICY_URI, true);
}
private void deployPolicy(final ToscaServiceTemplate toscaServiceTemplate) throws PolicyForwardingException {
final var pdpPolicies = new PdpDeployPolicies();
final List<ToscaConceptIdentifierOptVersion> policyIdentifierList = new ArrayList<>();
for (final Map<String, ToscaPolicy> policyMap : toscaServiceTemplate.getToscaTopologyTemplate().getPolicies()) {
final String policyId =
String.valueOf(policyMap.entrySet().iterator().next().getValue().getMetadata().get("policy-id"));
final String policyVersion =
String.valueOf(policyMap.entrySet().iterator().next().getValue().getMetadata()
.get("policy-version"));
final var toscaPolicyIdentifier =
new ToscaConceptIdentifierOptVersion(policyId, policyVersion);
policyIdentifierList.add(toscaPolicyIdentifier);
}
pdpPolicies.setPolicies(policyIdentifierList);
invokeHttpClient(Entity.entity(pdpPolicies, MediaType.APPLICATION_JSON), DEPLOY_POLICY_URI, false);
}
private Response invokeHttpClient(final Entity<?> entity, final String path, final boolean wantApi)
throws PolicyForwardingException {
var response = getHttpClient(wantApi).post(path, entity, Map.of(HttpHeaders.ACCEPT,
MediaType.APPLICATION_JSON, HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON));
if (response.getStatus() / 100 != 2) {
LOGGER.error(
"Invocation of path {} failed for entity {}. Response status: {}, Response status info: {}",
path, entity, response.getStatus(), response.getStatusInfo());
throw new PolicyForwardingException("Failed creating the entity - " + entity);
}
return response;
}
private HttpClient getHttpClient(final boolean wantApi) {
return (wantApi ? apiClient : papClient);
}
}
|
