aboutsummaryrefslogtreecommitdiffstats
path: root/ONAP-REST/src/main/java/org/onap/policy/rest/jpa/PolicyEntity.java
blob: 8fa80e635f9a0c59bae73ff45393576d9d8d54f1 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP-REST
 * ================================================================================
 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * 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.rest.jpa;

/*
 */
import com.fasterxml.jackson.annotation.JsonBackReference;
import com.fasterxml.jackson.annotation.JsonManagedReference;

import java.io.Serializable;
import java.util.Date;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Version;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;

/**
 * The Entity class to persist a policy object and its configuration data.
 */
// @formatter:off
@Entity
// Add a non-unique index and a constraint that says the combo of policyName and scopeId must be unique
@Table(name = "PolicyEntity")
@NamedQueries(
    {
        @NamedQuery(
            name = "PolicyEntity.findAll",
            query = "SELECT e FROM PolicyEntity e "
        ),
        @NamedQuery(
            name = "PolicyEntity.findAllByDeletedFlag",
            query = "SELECT e FROM PolicyEntity e WHERE e.deleted = :deleted"
        ),
        @NamedQuery(
            name = "PolicyEntity.FindById",
            query = "SELECT e FROM PolicyEntity e WHERE e.policyId = :id"
        ),
        @NamedQuery(
            name = "PolicyEntity.deleteAll",
            query = "DELETE FROM PolicyEntity WHERE 1=1"
        ),
        @NamedQuery(
            name = "PolicyEntity.findByNameAndScope",
            query = "SELECT e FROM PolicyEntity e WHERE e.policyName = :name AND e.scope = :scope"
        )
    }
)
@Getter
@Setter
@EqualsAndHashCode
// @formatter:on
public class PolicyEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "policyId")
    @JsonBackReference
    private long policyId;

    @Column(name = "policyName", nullable = false, unique = false, length = 255)
    private String policyName;

    // The scope is the directory structure in dot notation. For example: org.onap.myproject
    @Column(name = "scope", nullable = false, unique = false, length = 255)
    private String scope;

    @Version
    @Column(name = "version")
    private int version;

    // not going to be used
    @Column(name = "policyVersion")
    private int policyVersion = 0;

    @Lob
    @Column(name = "policyData", nullable = false, columnDefinition = "TEXT")
    private String policyData = "NoData";

    @OneToOne(optional = true, orphanRemoval = true)
    @JoinColumn(name = "configurationDataId")
    @JsonManagedReference
    private ConfigurationDataEntity configurationDataEntity;

    @OneToOne(optional = true, orphanRemoval = true)
    @JoinColumn(name = "actionBodyId")
    @JsonManagedReference
    private ActionBodyEntity actionBodyEntity;

    @Column(name = "created_by", nullable = false, length = 255)
    private String createdBy = "guest";

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "created_date", updatable = false)
    private Date createdDate;

    @Column(name = "description", nullable = false, length = 2048)
    private String description = "NoDescription";

    @Column(name = "modified_by", nullable = false, length = 255)
    private String modifiedBy = "guest";

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "modified_date", nullable = false)
    private Date modifiedDate;

    @Column(name = "deleted", nullable = false)
    private boolean deleted = false;

    @Column(name = "delete_reason_code", nullable = true, length = 100)
    private String deleteReasonCode;

    @Column(name = "deleted_by", nullable = true, length = 45)
    private String deletedBy;

    public PolicyEntity() {
        super();
    }

    /**
     * Set default values.
     */
    @PrePersist
    public void prePersist() {
        Date date = new Date();
        this.createdDate = date;
        this.modifiedDate = date;
    }

    @PreUpdate
    public void preUpdate() {
        this.modifiedDate = new Date();
    }

    /**
     * Returns configurationDataEntity.
     *
     * @return the configurationDataEntity
     */
    public ConfigurationDataEntity getConfigurationData() {
        return configurationDataEntity;
    }

    /**
     * Set configurationDataEntity.
     *
     * @param configurationDataEntity the configurationDataEntity to set
     */
    public void setConfigurationData(ConfigurationDataEntity configurationDataEntity) {
        this.configurationDataEntity = configurationDataEntity;
    }
}