aboutsummaryrefslogtreecommitdiffstats
path: root/models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/concepts/JpaPdpPolicyStatus.java
blob: 536bb76a22566b04eb34166c0190c76239746c18 (plain)
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
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2021 AT&T Intellectual Property. 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.models.pdp.persistence.concepts;

import java.util.List;
import javax.persistence.Column;
import javax.persistence.EmbeddedId;
import javax.persistence.Entity;
import javax.persistence.Index;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.Table;
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.annotations.NotNull;
import org.onap.policy.common.parameters.annotations.Pattern;
import org.onap.policy.common.parameters.annotations.Valid;
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.base.validation.annotations.VerifyKey;
import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
import org.onap.policy.models.pdp.concepts.PdpPolicyStatus.State;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;

/**
 * Class to represent PDP-Policy deployment status in the database.
 */
@Entity
@Table(name = "PdpPolicyStatus", indexes = {@Index(name = "PdpPolicyStatus_PdpGroup", columnList = "pdpGroup")})
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@Data
@EqualsAndHashCode(callSuper = false)
public class JpaPdpPolicyStatus extends PfConcept implements PfAuthorative<PdpPolicyStatus> {
    private static final long serialVersionUID = -357224425637789775L;

    /**
     * Parent key & version identifies the policy, while localName identifies the pdpId.
     */
    @EmbeddedId
    @NotNull
    @Valid
    private PfReferenceKey key;

    @Column
    @NotNull
    @Pattern(regexp = PfReferenceKey.LOCAL_NAME_REGEXP)
    private String pdpGroup;

    @Column
    @NotNull
    @Pattern(regexp = PfReferenceKey.LOCAL_NAME_REGEXP)
    private String pdpType;

    @Column
    @NotNull
    @VerifyKey(versionNotNull = true)
    private PfConceptKey policyType;

    @Column
    private boolean deploy;

    @Column
    @NotNull
    private State state;


    /**
     * Constructs an empty object.
     */
    public JpaPdpPolicyStatus() {
        key = new PfReferenceKey();
        pdpGroup = PfKey.NULL_KEY_NAME;
        pdpType = PfKey.NULL_KEY_NAME;
        policyType = new PfConceptKey();
        deploy = false;
        state = State.WAITING;
    }

    /**
     * Copy constructor.
     *
     * @param source object from which to copy
     */
    public JpaPdpPolicyStatus(JpaPdpPolicyStatus source) {
        key = new PfReferenceKey(source.getKey());
        pdpGroup = source.getPdpGroup();
        pdpType = source.getPdpType();
        policyType = new PfConceptKey(source.getPolicyType());
        deploy = source.isDeploy();
        state = source.getState();
    }

    /**
     * Authorative constructor.
     *
     * @param source authorative object from which to copy
     */
    public JpaPdpPolicyStatus(PdpPolicyStatus source) {
        fromAuthorative(source);
    }

    @Override
    public int compareTo(PfConcept otherConcept) {
        if (otherConcept == null) {
            return -1;
        }
        if (this == otherConcept) {
            return 0;
        }
        if (getClass() != otherConcept.getClass()) {
            return getClass().getName().compareTo(otherConcept.getClass().getName());
        }

        final JpaPdpPolicyStatus other = (JpaPdpPolicyStatus) otherConcept;

        // @formatter:off
        return new CompareToBuilder()
                        .append(key, other.key)
                        .append(pdpGroup, other.pdpGroup)
                        .append(pdpType, other.pdpType)
                        .append(policyType, other.policyType)
                        .append(deploy, other.deploy)
                        .append(state, other.state)
                        .toComparison();
        // @formatter:on
    }

    @Override
    public PdpPolicyStatus toAuthorative() {
        PfConceptKey policyKey = key.getParentConceptKey();
        var policyIdent = new ToscaConceptIdentifier(policyKey.getName(), policyKey.getVersion());
        var policyTypeIdent = new ToscaConceptIdentifier(policyType.getName(), policyType.getVersion());

        // @formatter:off
        return PdpPolicyStatus.builder()
                        .pdpGroup(pdpGroup)
                        .pdpId(key.getLocalName())
                        .pdpType(pdpType)
                        .policyType(policyTypeIdent)
                        .policy(policyIdent)
                        .deploy(deploy)
                        .state(state)
                        .build();
        // @formatter:on
    }

    @Override
    public void fromAuthorative(PdpPolicyStatus source) {
        final ToscaConceptIdentifier policyIdent = source.getPolicy();
        final ToscaConceptIdentifier policyTypeIdent = source.getPolicyType();

        key = new PfReferenceKey(policyIdent.getName(), policyIdent.getVersion(), source.getPdpId());
        pdpGroup = source.getPdpGroup();
        pdpType = source.getPdpType();
        policyType = new PfConceptKey(policyTypeIdent.getName(), policyTypeIdent.getVersion());
        deploy = source.isDeploy();
        state = source.getState();
    }

    @Override
    public List<PfKey> getKeys() {
        return getKey().getKeys();
    }

    @Override
    public void clean() {
        key.clean();

        pdpGroup = Assertions.validateStringParameter("pdpGroup", pdpGroup, PfReferenceKey.LOCAL_NAME_REGEXP);
        pdpType = Assertions.validateStringParameter("pdpType", pdpType, PfReferenceKey.LOCAL_NAME_REGEXP);
        policyType.clean();
    }

    @Override
    public BeanValidationResult validate(@NonNull String fieldName) {
        BeanValidationResult result = super.validate(fieldName);

        if (PfKey.NULL_KEY_NAME.equals(key.getParentKeyName())) {
            addResult(result, "policy name (parent key name of key)", key.getParentKeyName(), Validated.IS_NULL);
        }

        if (PfKey.NULL_KEY_VERSION.equals(key.getParentKeyVersion())) {
            addResult(result, "policy version (parent key version of key)", key.getParentKeyVersion(),
                            Validated.IS_NULL);
        }

        if (!PfKey.NULL_KEY_NAME.equals(key.getParentLocalName())) {
            addResult(result, "parent local name of key", key.getParentLocalName(), "must be " + PfKey.NULL_KEY_NAME);
        }

        if (PfKey.NULL_KEY_NAME.equals(key.getLocalName())) {
            addResult(result, "pdpId (local name of key)", key.getLocalName(), Validated.IS_NULL);
        }

        return result;
    }
}