2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021 Nordix Foundation.
4 * Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
5 * Modifications Copyright (C) 2021 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.pap.persistence.provider;
25 import java.time.Instant;
26 import java.util.HashMap;
27 import java.util.List;
29 import java.util.stream.Collectors;
30 import javax.ws.rs.core.Response;
31 import lombok.Builder;
33 import lombok.NonNull;
34 import org.apache.commons.lang3.StringUtils;
35 import org.onap.policy.common.parameters.BeanValidationResult;
36 import org.onap.policy.models.base.PfModelRuntimeException;
37 import org.onap.policy.models.dao.PfDao;
38 import org.onap.policy.models.dao.PfFilterParametersIntfc;
39 import org.onap.policy.models.pap.concepts.PolicyAudit;
40 import org.onap.policy.models.pap.concepts.PolicyAudit.AuditAction;
41 import org.onap.policy.models.pap.persistence.concepts.JpaPolicyAudit;
44 * Provider for Policy Audit.
46 * @author Adheli Tavares (adheli.tavares@est.tech)
49 public class PolicyAuditProvider {
51 private static final Integer DEFAULT_MAX_RECORDS = 100;
52 private static final Integer DEFAULT_MIN_RECORDS = 10;
55 * Create audit records.
57 * @param audits list of policy audit
59 public void createAuditRecords(@NonNull PfDao dao, @NonNull final List<PolicyAudit> audits) {
60 List<JpaPolicyAudit> jpaAudits = audits.stream().map(JpaPolicyAudit::new).collect(Collectors.toList());
62 var result = new BeanValidationResult("createAuditRecords", jpaAudits);
65 for (JpaPolicyAudit jpaAudit : jpaAudits) {
66 result.addResult(jpaAudit.validate(String.valueOf(count++)));
69 if (!result.isValid()) {
70 throw new PfModelRuntimeException(Response.Status.BAD_REQUEST, result.getResult());
73 dao.createCollection(jpaAudits);
77 * Collect audit records based on filters at {@link AuditFilter}.
79 * @param auditFilter {@link AuditFilter} object with filters for search
80 * @return list of {@link PolicyAudit} records
82 public List<PolicyAudit> getAuditRecords(@NonNull PfDao dao, @NonNull AuditFilter auditFilter) {
83 if (auditFilter.getRecordNum() < 1) {
84 auditFilter.setRecordNum(DEFAULT_MIN_RECORDS);
85 } else if (auditFilter.getRecordNum() > DEFAULT_MAX_RECORDS) {
86 auditFilter.setRecordNum(DEFAULT_MAX_RECORDS);
89 return dao.getFiltered(JpaPolicyAudit.class, auditFilter).stream().map(JpaPolicyAudit::toAuthorative)
90 .collect(Collectors.toList());
94 * Create a filter for looking for audit records.
96 * version - policy version
97 * pdpGroup - PDP group that policy might be related
98 * action - type of action/operation realized on policy
99 * fromDate - start of period in case of time interval search
103 public static class AuditFilter implements PfFilterParametersIntfc {
105 private String version;
106 private AuditAction action;
107 private String pdpGroup;
108 private Instant fromDate;
109 private Instant toDate;
110 private int recordNum;
112 private String sortOrder = "DESC";
114 // initialized lazily, if not set via the builder
115 private Map<String, Object> filterMap;
118 public Instant getStartTime() {
123 public Instant getEndTime() {
128 public Map<String, Object> getFilterMap() {
129 if (filterMap != null) {
133 filterMap = new HashMap<>();
135 if (StringUtils.isNotBlank(pdpGroup)) {
136 filterMap.put("pdpGroup", pdpGroup);
139 if (action != null) {
140 filterMap.put("action", action);