2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
5 * Modifications Copyright (C) 2020 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.models.provider.impl;
25 import java.util.Collection;
26 import java.util.Date;
27 import java.util.List;
28 import javax.ws.rs.core.Response;
29 import lombok.NonNull;
30 import org.onap.policy.models.base.PfModelException;
31 import org.onap.policy.models.base.PfModelRuntimeException;
32 import org.onap.policy.models.pdp.concepts.Pdp;
33 import org.onap.policy.models.pdp.concepts.PdpGroup;
34 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
35 import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
36 import org.onap.policy.models.pdp.concepts.PdpStatistics;
37 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
38 import org.onap.policy.models.pdp.persistence.provider.PdpProvider;
39 import org.onap.policy.models.pdp.persistence.provider.PdpStatisticsProvider;
40 import org.onap.policy.models.provider.PolicyModelsProvider;
41 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
42 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
43 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
44 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
45 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
46 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
47 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeFilter;
48 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplateFilter;
50 import org.onap.policy.models.tosca.authorative.provider.AuthorativeToscaProvider;
53 * This class provides an implementation of the Policy Models Provider for the ONAP Policy Framework that works towards
54 * a relational database.
56 * @author Liam Fallon (liam.fallon@est.tech)
58 public class DatabasePolicyModelsProviderImpl extends AbstractModelsProvider implements PolicyModelsProvider {
60 * Constructor that takes the parameters.
62 * @param parameters the parameters for the provider
64 public DatabasePolicyModelsProviderImpl(@NonNull final PolicyModelsProviderParameters parameters) {
69 public List<ToscaServiceTemplate> getServiceTemplateList(final String name, final String version)
70 throws PfModelException {
72 return new AuthorativeToscaProvider().getServiceTemplateList(getPfDao(), name, version);
77 public List<ToscaServiceTemplate> getFilteredServiceTemplateList(@NonNull ToscaServiceTemplateFilter filter)
78 throws PfModelException {
80 return new AuthorativeToscaProvider().getFilteredServiceTemplateList(getPfDao(), filter);
84 public ToscaServiceTemplate createServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
85 throws PfModelException {
87 return new AuthorativeToscaProvider().createServiceTemplate(getPfDao(), serviceTemplate);
91 public ToscaServiceTemplate updateServiceTemplate(@NonNull final ToscaServiceTemplate serviceTemplate)
92 throws PfModelException {
94 return new AuthorativeToscaProvider().updateServiceTemplate(getPfDao(), serviceTemplate);
98 public ToscaServiceTemplate deleteServiceTemplate(@NonNull final String name, @NonNull final String version)
99 throws PfModelException {
102 return new AuthorativeToscaProvider().deleteServiceTemplate(getPfDao(), name, version);
106 public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
108 return new AuthorativeToscaProvider().getPolicyTypes(getPfDao(), name, version);
112 public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
114 return new AuthorativeToscaProvider().getPolicyTypeList(getPfDao(), name, version);
118 public ToscaServiceTemplate getFilteredPolicyTypes(@NonNull ToscaPolicyTypeFilter filter) throws PfModelException {
120 return new AuthorativeToscaProvider().getFilteredPolicyTypes(getPfDao(), filter);
124 public List<ToscaPolicyType> getFilteredPolicyTypeList(@NonNull ToscaPolicyTypeFilter filter)
125 throws PfModelException {
127 return new AuthorativeToscaProvider().getFilteredPolicyTypeList(getPfDao(), filter);
131 public ToscaServiceTemplate createPolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
132 throws PfModelException {
134 return new AuthorativeToscaProvider().createPolicyTypes(getPfDao(), serviceTemplate);
138 public ToscaServiceTemplate updatePolicyTypes(@NonNull final ToscaServiceTemplate serviceTemplate)
139 throws PfModelException {
141 return new AuthorativeToscaProvider().updatePolicyTypes(getPfDao(), serviceTemplate);
145 public ToscaServiceTemplate deletePolicyType(@NonNull final String name, @NonNull final String version)
146 throws PfModelException {
149 ToscaConceptIdentifier policyTypeIdentifier = new ToscaConceptIdentifier(name, version);
150 assertPolicyTypeNotSupportedInPdpGroup(policyTypeIdentifier);
152 return new AuthorativeToscaProvider().deletePolicyType(getPfDao(), name, version);
156 public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
158 return new AuthorativeToscaProvider().getPolicies(getPfDao(), name, version);
162 public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
164 return new AuthorativeToscaProvider().getPolicyList(getPfDao(), name, version);
168 public ToscaServiceTemplate getFilteredPolicies(@NonNull ToscaPolicyFilter filter) throws PfModelException {
170 return new AuthorativeToscaProvider().getFilteredPolicies(getPfDao(), filter);
174 public List<ToscaPolicy> getFilteredPolicyList(@NonNull ToscaPolicyFilter filter) throws PfModelException {
176 return new AuthorativeToscaProvider().getFilteredPolicyList(getPfDao(), filter);
180 public ToscaServiceTemplate createPolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
181 throws PfModelException {
183 return new AuthorativeToscaProvider().createPolicies(getPfDao(), serviceTemplate);
187 public ToscaServiceTemplate updatePolicies(@NonNull final ToscaServiceTemplate serviceTemplate)
188 throws PfModelException {
190 return new AuthorativeToscaProvider().updatePolicies(getPfDao(), serviceTemplate);
194 public ToscaServiceTemplate deletePolicy(@NonNull final String name, @NonNull final String version)
195 throws PfModelException {
198 ToscaConceptIdentifier policyIdentifier = new ToscaConceptIdentifier(name, version);
199 assertPolicyNotDeployedInPdpGroup(policyIdentifier);
201 return new AuthorativeToscaProvider().deletePolicy(getPfDao(), name, version);
205 public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
207 return new PdpProvider().getPdpGroups(getPfDao(), name);
211 public List<PdpGroup> getFilteredPdpGroups(@NonNull PdpGroupFilter filter) throws PfModelException {
213 return new PdpProvider().getFilteredPdpGroups(getPfDao(), filter);
217 public List<PdpGroup> createPdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
219 return new PdpProvider().createPdpGroups(getPfDao(), pdpGroups);
223 public List<PdpGroup> updatePdpGroups(@NonNull final List<PdpGroup> pdpGroups) throws PfModelException {
225 return new PdpProvider().updatePdpGroups(getPfDao(), pdpGroups);
229 public void updatePdpSubGroup(@NonNull final String pdpGroupName, @NonNull final PdpSubGroup pdpSubGroup)
230 throws PfModelException {
232 new PdpProvider().updatePdpSubGroup(getPfDao(), pdpGroupName, pdpSubGroup);
236 public void updatePdp(@NonNull String pdpGroupName, @NonNull String pdpSubGroup, @NonNull Pdp pdp)
237 throws PfModelException {
238 new PdpProvider().updatePdp(getPfDao(), pdpGroupName, pdpSubGroup, pdp);
242 public PdpGroup deletePdpGroup(@NonNull final String name) throws PfModelException {
244 return new PdpProvider().deletePdpGroup(getPfDao(), name);
248 public List<PdpStatistics> getPdpStatistics(final String name, final Date timestamp) throws PfModelException {
250 return new PdpStatisticsProvider().getPdpStatistics(getPfDao(), name, timestamp);
254 public List<PdpStatistics> getFilteredPdpStatistics(final String name, @NonNull final String pdpGroupName,
255 final String pdpSubGroup, final Date startTimeStamp, final Date endTimeStamp, final String sortOrder,
256 final int getRecordNum) throws PfModelException {
258 return new PdpStatisticsProvider().getFilteredPdpStatistics(getPfDao(), name, pdpGroupName, pdpSubGroup,
259 startTimeStamp, endTimeStamp, sortOrder, getRecordNum);
263 public List<PdpStatistics> createPdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
264 throws PfModelException {
266 return new PdpStatisticsProvider().createPdpStatistics(getPfDao(), pdpStatisticsList);
270 public List<PdpStatistics> updatePdpStatistics(@NonNull final List<PdpStatistics> pdpStatisticsList)
271 throws PfModelException {
273 return new PdpStatisticsProvider().updatePdpStatistics(getPfDao(), pdpStatisticsList);
277 public List<PdpStatistics> deletePdpStatistics(@NonNull final String name, final Date timestamp)
278 throws PfModelException {
280 return new PdpStatisticsProvider().deletePdpStatistics(getPfDao(), name, timestamp);
284 public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
286 return new PdpProvider().getAllPolicyStatus(getPfDao());
290 public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
291 throws PfModelException {
293 return new PdpProvider().getAllPolicyStatus(getPfDao(), policy);
297 public List<PdpPolicyStatus> getGroupPolicyStatus(@NonNull String groupName)
298 throws PfModelException {
300 return new PdpProvider().getGroupPolicyStatus(getPfDao(), groupName);
304 public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs,
305 Collection<PdpPolicyStatus> updateObjs, Collection<PdpPolicyStatus> deleteObjs) {
307 new PdpProvider().cudPolicyStatus(getPfDao(), createObjs, updateObjs, deleteObjs);
311 * Check if the model provider is initialized.
313 private void assertInitialized() {
314 if (getPfDao() == null) {
315 String errorMessage = "policy models provider is not initilaized";
316 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, errorMessage);
321 * Assert that the policy type is not supported in any PDP group.
323 * @param policyTypeIdentifier the policy type identifier
324 * @throws PfModelException if the policy type is supported in a PDP group
326 private void assertPolicyTypeNotSupportedInPdpGroup(ToscaConceptIdentifier policyTypeIdentifier)
327 throws PfModelException {
328 for (PdpGroup pdpGroup : getPdpGroups(null)) {
329 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
330 if (pdpSubGroup.getSupportedPolicyTypes().contains(policyTypeIdentifier)) {
331 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
332 "policy type is in use, it is referenced in PDP group " + pdpGroup.getName() + " subgroup "
333 + pdpSubGroup.getPdpType());
340 * Assert that the policy is not deployed in a PDP group.
342 * @param policyIdentifier the identifier of the policy
343 * @throws PfModelException thrown if the policy is deployed in a PDP group
345 private void assertPolicyNotDeployedInPdpGroup(final ToscaConceptIdentifier policyIdentifier)
346 throws PfModelException {
347 for (PdpGroup pdpGroup : getPdpGroups(null)) {
348 for (PdpSubGroup pdpSubGroup : pdpGroup.getPdpSubgroups()) {
349 if (pdpSubGroup.getPolicies().contains(policyIdentifier)) {
350 throw new PfModelRuntimeException(Response.Status.NOT_ACCEPTABLE,
351 "policy is in use, it is deployed in PDP group " + pdpGroup.getName() + " subgroup "
352 + pdpSubGroup.getPdpType());