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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021,2023 Nordix Foundation.
* Modifications Copyright (C) 2021-2022 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.models.pap.persistence.concepts;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.Table;
import javax.persistence.TableGenerator;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.validation.constraints.NotNull;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.apache.commons.lang3.builder.CompareToBuilder;
import org.onap.policy.common.parameters.BeanValidationResult;
import org.onap.policy.common.parameters.ValidationStatus;
import org.onap.policy.common.parameters.annotations.Pattern;
import org.onap.policy.common.utils.validation.Assertions;
import org.onap.policy.models.base.PfAuthorative;
import org.onap.policy.models.base.PfConcept;
import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfKey;
import org.onap.policy.models.base.PfReferenceKey;
import org.onap.policy.models.base.Validated;
import org.onap.policy.models.pap.concepts.PolicyAudit;
import org.onap.policy.models.pap.concepts.PolicyAudit.AuditAction;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* Entity to keep the records on policy actions for audit.
*
* @author Adheli Tavares (adheli.tavares@est.tech)
*
*/
@Entity
@Table(name = "JpaPolicyAudit", indexes = {
@Index(name = "JpaPolicyAuditIndex_timestamp", columnList = "timeStamp")
})
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@Data
@EqualsAndHashCode(callSuper = false)
public class JpaPolicyAudit extends PfConcept implements PfAuthorative<PolicyAudit> {
private static final long serialVersionUID = -2935734300607322191L;
@Id
@Column(name = "ID")
@GeneratedValue(strategy = GenerationType.TABLE, generator = "auditIdGen")
@TableGenerator(
name = "auditIdGen",
table = "audit_sequence",
pkColumnName = "SEQ_NAME",
valueColumnName = "SEQ_COUNT",
pkColumnValue = "SEQ_GEN")
private Long generatedId;
@Column(name = "name", length = 120)
@Pattern(regexp = PfKey.NAME_REGEXP)
private String name;
@Column(name = "version", length = 20)
@Pattern(regexp = PfKey.VERSION_REGEXP)
private String version;
@Column
private String pdpGroup;
@Column
private String pdpType;
@Column
@NotNull
private AuditAction action;
@Column
@Temporal(TemporalType.TIMESTAMP)
@NotNull
private Date timeStamp;
@Column
private String userName;
/**
* Default constructor.
*/
public JpaPolicyAudit() {
this.setName(PfKey.NULL_KEY_NAME);
this.setVersion(PfKey.NULL_KEY_VERSION);
}
/**
* Constructor from an authorative.
*
* @param audit authorative model
*/
public JpaPolicyAudit(PolicyAudit audit) {
fromAuthorative(audit);
}
/**
* Constructor as a copy.
*
* @param copyConcept original entity to be copied
*/
public JpaPolicyAudit(JpaPolicyAudit copyConcept) {
this.name = copyConcept.name;
this.version = copyConcept.version;
this.generatedId = copyConcept.generatedId;
this.pdpGroup = copyConcept.getPdpGroup();
this.pdpType = copyConcept.getPdpType();
this.action = copyConcept.getAction();
this.timeStamp = copyConcept.getTimeStamp();
this.userName = copyConcept.getUserName();
}
@Override
public int compareTo(PfConcept o) {
if (o == null) {
return -1;
}
if (this == o) {
return 0;
}
if (getClass() != o.getClass()) {
return getClass().getName().compareTo(o.getClass().getName());
}
final JpaPolicyAudit other = (JpaPolicyAudit) o;
// @formatter:off
return new CompareToBuilder()
.append(name, other.name)
.append(version, other.version)
.append(generatedId, other.generatedId)
.append(pdpGroup, other.pdpGroup)
.append(pdpType, other.pdpType)
.append(action, other.action)
.append(timeStamp, other.timeStamp)
.append(userName, other.userName)
.toComparison();
// @formatter:on
}
@Override
public PolicyAudit toAuthorative() {
var policyIdent = new ToscaConceptIdentifier(name, version);
// @formatter:off
return PolicyAudit.builder()
.auditId(generatedId)
.pdpGroup(pdpGroup)
.pdpType(pdpType)
.policy(policyIdent)
.action(action)
.timestamp(timeStamp == null ? null : timeStamp.toInstant())
.user(userName)
.build();
// @formatter:on
}
@Override
public void fromAuthorative(PolicyAudit authorativeConcept) {
if (authorativeConcept.getPolicy() != null) {
final ToscaConceptIdentifier policy = authorativeConcept.getPolicy();
this.setName(policy.getName());
this.setVersion(policy.getVersion());
} else {
this.setName(PfKey.NULL_KEY_NAME);
this.setVersion(PfKey.NULL_KEY_VERSION);
}
this.setGeneratedId(authorativeConcept.getAuditId());
pdpGroup = authorativeConcept.getPdpGroup();
pdpType = authorativeConcept.getPdpType();
action = authorativeConcept.getAction();
timeStamp = authorativeConcept.getTimestamp() == null ? Date.from(Instant.now())
: Date.from(authorativeConcept.getTimestamp());
userName = authorativeConcept.getUser();
}
@Override
public List<PfKey> getKeys() {
final List<PfKey> keyList = new ArrayList<>();
keyList.add(getKey());
return keyList;
}
@Override
public PfKey getKey() {
return new PfConceptKey(name, version);
}
@Override
public void clean() {
pdpGroup = Assertions.validateStringParameter("pdpGroup", pdpGroup, PfReferenceKey.LOCAL_NAME_REGEXP);
pdpType = Assertions.validateStringParameter("pdpType", pdpType, PfReferenceKey.LOCAL_NAME_REGEXP);
userName = Assertions.validateStringParameter("user", userName, PfReferenceKey.LOCAL_NAME_REGEXP);
}
@Override
public BeanValidationResult validate(@NonNull String fieldName) {
BeanValidationResult result = super.validate(fieldName);
if (PfKey.NULL_KEY_NAME.equals(name)) {
result.addResult("name", name, ValidationStatus.INVALID, Validated.IS_NULL);
}
return result;
}
}
|
