gerrit.onap Code Review - ccsdk/cds.git/blob

   1 /*
   2  * Copyright © 2019 Bell Canada
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.db
  18
  19 import com.fasterxml.jackson.annotation.JsonFormat
  20 import io.swagger.annotations.ApiModelProperty
  21 import org.hibernate.annotations.Proxy
  22 import org.springframework.data.annotation.LastModifiedDate
  23 import org.springframework.data.jpa.domain.support.AuditingEntityListener
  24 import java.io.Serializable
  25 import java.util.Date
  26 import javax.persistence.Column
  27 import javax.persistence.Entity
  28 import javax.persistence.EntityListeners
  29 import javax.persistence.Id
  30 import javax.persistence.Index
  31 import javax.persistence.Lob
  32 import javax.persistence.Table
  33 import javax.persistence.Temporal
  34 import javax.persistence.TemporalType
  35
  36 @EntityListeners(AuditingEntityListener::class)
  37 @Entity
  38 @Table(name = "RESOURCE_RESOLUTION",
  39 indexes = [Index(name = "idx_rr_bpnameversion", columnList = "blueprint_name, blueprint_version"),
  40     Index(name = "idx_rr_resolution_key", columnList = "resolution_key"),
  41     Index(name = "idx_rr_name", columnList = "name"),
  42     Index(name = "idx_rr_artifact_name", columnList = "artifact_name"),
  43     Index(name = "idx_rr_resource_idtype", columnList = "resource_id, resource_type")
  44 ])
  45 @Proxy(lazy = false)
  46 class ResourceResolution : Serializable {
  47
  48     @get:ApiModelProperty(value = "Name of the CBA.", required = true)
  49     @Column(name = "blueprint_name", nullable = false)
  50     var blueprintName: String? = null
  51
  52     @get:ApiModelProperty(value = "Version of the CBA.", required = true)
  53     @Column(name = "blueprint_version", nullable = false)
  54     var blueprintVersion: String? = null
  55
  56     @get:ApiModelProperty(value = "Artifact name for which to retrieve a resolved resource.", required = true)
  57     @Column(name = "artifact_name", nullable = false)
  58     var artifactName: String? = null
  59
  60     @get:ApiModelProperty(value = "Name of the resource.", required = true)
  61     @Column(name = "name", nullable = false)
  62     var name: String? = null
  63
  64     @get:ApiModelProperty(value = "Value of the resolution.", required = true)
  65     @Lob
  66     @Column(name = "value", nullable = false)
  67     var value: String? = null
  68
  69     @get:ApiModelProperty(value = "Whether success of failure.", required = true)
  70     @Column(name = "status", nullable = false)
  71     var status: String? = null
  72
  73     @get:ApiModelProperty(
  74         value = "Resolution Key uniquely identifying the resolution of a given artifact within a CBA.",
  75         required = true
  76     )
  77     @Column(name = "resolution_key", nullable = false)
  78     var resolutionKey: String? = null
  79
  80     @get:ApiModelProperty(value = "Resolution type.", required = true, example = "\"ServiceInstance\"")
  81     @Column(name = "resource_type", nullable = false)
  82     var resourceType: String? = null
  83
  84     @get:ApiModelProperty(value = "ID associated with the resolution type in the inventory system.", required = true)
  85     @Column(name = "resource_id", nullable = false)
  86     var resourceId: String? = null
  87
  88     @get:ApiModelProperty(
  89         value = "If resolution occurred multiple time, this field provides the index.",
  90         required = true
  91     )
  92     @Column(name = "occurrence", nullable = false)
  93     var occurrence: Int = 0
  94
  95     @get:ApiModelProperty(value = "Name of the data dictionary used for the resolution.", required = true)
  96     @Column(name = "dictionary_name", nullable = false)
  97     var dictionaryName: String? = null
  98
  99     @get:ApiModelProperty(
 100         value = "Source associated with the data dictionary used for the resolution.",
 101         required = true
 102     )
 103     @Column(name = "dictionary_status", nullable = false)
 104     var dictionarySource: String? = null
 105
 106     @get:ApiModelProperty(value = "Version of the data dictionary used for the resolution.", required = true)
 107     @Column(name = "dictionary_version", nullable = false)
 108     var dictionaryVersion: Int = 0
 109
 110     @Id
 111     @Column(name = "resource_resolution_id")
 112     var id: String? = null
 113
 114     @get:ApiModelProperty(value = "Creation date of the resolution.", required = true)
 115     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
 116     @LastModifiedDate
 117     @Temporal(TemporalType.TIMESTAMP)
 118     @Column(name = "creation_date")
 119     var createdDate = Date()
 120
 121     companion object {
 122
 123         private const val serialVersionUID = 1L
 124     }
 125 }