src/main/java/org/onap/clamp/loop/log/LoopLog.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP CLAMP
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights
   6  *                             reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END============================================
  20  * ===================================================================
  21  *
  22  */
  23
  24 package org.onap.clamp.loop.log;
  25
  26 import com.google.gson.annotations.Expose;
  27
  28 import java.io.Serializable;
  29 import java.time.Instant;
  30 import java.time.temporal.ChronoUnit;
  31
  32 import javax.persistence.Column;
  33 import javax.persistence.Entity;
  34 import javax.persistence.EnumType;
  35 import javax.persistence.Enumerated;
  36 import javax.persistence.FetchType;
  37 import javax.persistence.GeneratedValue;
  38 import javax.persistence.GenerationType;
  39 import javax.persistence.Id;
  40 import javax.persistence.JoinColumn;
  41 import javax.persistence.ManyToOne;
  42 import javax.persistence.Table;
  43
  44 import org.onap.clamp.loop.Loop;
  45
  46 /**
  47  * This class holds the logs created by the Clamp Backend. The Instant is always
  48  * rounded to the nearest second as the nano seconds can't be stored in the
  49  * database. The logs can be therefore exposed to the UI or the client doing
  50  * some GET Loop on the backend.
  51  *
  52  */
  53 @Entity
  54 @Table(name = "loop_logs")
  55 public class LoopLog implements Serializable, Comparable<LoopLog> {
  56     /**
  57      * The serial version ID.
  58      */
  59     private static final long serialVersionUID = 1988276670074437631L;
  60
  61     @Expose
  62     @Id
  63     @GeneratedValue(strategy = GenerationType.AUTO)
  64     private Long id;
  65
  66     @Expose
  67     @Column(name = "log_type", nullable = false)
  68     @Enumerated(EnumType.STRING)
  69     private LogType logType;
  70
  71     @Expose
  72     @Column(name = "log_component", nullable = false)
  73     private String logComponent;
  74
  75     @Expose
  76     @Column(name = "message", columnDefinition = "MEDIUMTEXT", nullable = false)
  77     private String message;
  78
  79     @ManyToOne(fetch = FetchType.LAZY)
  80     @JoinColumn(name = "loop_id", nullable = false)
  81     private Loop loop;
  82
  83     @Expose
  84     @Column(name = "log_instant", nullable = false)
  85     private Instant logInstant = Instant.now().truncatedTo(ChronoUnit.SECONDS);
  86
  87     public LoopLog() {
  88     }
  89
  90     public LoopLog(String message, LogType logType, String logComponent, Loop loop) {
  91         this.message = message;
  92         this.logType = logType;
  93         this.loop = loop;
  94         this.logComponent = logComponent;
  95     }
  96
  97     public Long getId() {
  98         return id;
  99     }
 100
 101     public void setId(Long id) {
 102         this.id = id;
 103     }
 104
 105     public LogType getLogType() {
 106         return logType;
 107     }
 108
 109     public void setLogType(LogType logType) {
 110         this.logType = logType;
 111     }
 112
 113     public String getMessage() {
 114         return message;
 115     }
 116
 117     public void setMessage(String message) {
 118         this.message = message;
 119     }
 120
 121     public Loop getLoop() {
 122         return loop;
 123     }
 124
 125     public void setLoop(Loop loop) {
 126         this.loop = loop;
 127     }
 128
 129     public Instant getLogInstant() {
 130         return logInstant;
 131     }
 132
 133     public void setLogInstant(Instant logInstant) {
 134         this.logInstant = logInstant.truncatedTo(ChronoUnit.SECONDS);
 135     }
 136
 137     public String getLogComponent() {
 138         return logComponent;
 139     }
 140
 141     public void setLogComponent(String logComponent) {
 142         this.logComponent = logComponent;
 143     }
 144
 145     @Override
 146     public int hashCode() {
 147         final int prime = 31;
 148         int result = 1;
 149         result = prime * result + ((id == null) ? 0 : id.hashCode());
 150         return result;
 151     }
 152
 153     @Override
 154     public boolean equals(Object obj) {
 155         if (this == obj) {
 156             return true;
 157         }
 158         if (obj == null) {
 159             return false;
 160         }
 161         if (getClass() != obj.getClass()) {
 162             return false;
 163         }
 164         LoopLog other = (LoopLog) obj;
 165         if (id == null) {
 166             if (other.id != null) {
 167                 return false;
 168             }
 169         } else if (!id.equals(other.id)) {
 170             return false;
 171         }
 172         return true;
 173     }
 174
 175     @Override
 176     public int compareTo(LoopLog arg0) {
 177         // Reverse it, so that by default we have the latest
 178         if (getId() == null) {
 179             return 1;
 180         }
 181         if (arg0.getId() == null) {
 182             return -1;
 183         }
 184
 185         return arg0.getId().compareTo(this.getId());
 186
 187     }
 188
 189 }