UniversalVesAdapter/src/main/java/org/onap/dcaegen2/ves/domain/ves70/SyslogFields.java

   1 /*\r
   2 * ============LICENSE_START=======================================================\r
   3 * ONAP : DCAE\r
   4 * ================================================================================\r
   5 * Copyright 2019 TechMahindra\r
   6 *=================================================================================\r
   7 * Licensed under the Apache License, Version 2.0 (the "License");\r
   8 * you may not use this file except in compliance with the License.\r
   9 * You may obtain a copy of the License at\r
  10 *\r
  11 *     http://www.apache.org/licenses/LICENSE-2.0\r
  12 *\r
  13 * Unless required by applicable law or agreed to in writing, software\r
  14 * distributed under the License is distributed on an "AS IS" BASIS,\r
  15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16 * See the License for the specific language governing permissions and\r
  17 * limitations under the License.\r
  18 * ============LICENSE_END=========================================================\r
  19 */\r
  20 package org.onap.dcaegen2.ves.domain.ves70;\r
  21 \r
  22 import java.util.HashMap;\r
  23 import java.util.Map;\r
  24 import com.fasterxml.jackson.annotation.JsonCreator;\r
  25 import com.fasterxml.jackson.annotation.JsonInclude;\r
  26 import com.fasterxml.jackson.annotation.JsonProperty;\r
  27 import com.fasterxml.jackson.annotation.JsonPropertyDescription;\r
  28 import com.fasterxml.jackson.annotation.JsonPropertyOrder;\r
  29 import com.fasterxml.jackson.annotation.JsonValue;\r
  30 import org.apache.commons.lang.builder.EqualsBuilder;\r
  31 import org.apache.commons.lang.builder.HashCodeBuilder;\r
  32 import org.apache.commons.lang.builder.ToStringBuilder;\r
  33 \r
  34 \r
  35 /**\r
  36  * sysLog fields\r
  37  * \r
  38  */\r
  39 @JsonInclude(JsonInclude.Include.NON_NULL)\r
  40 @JsonPropertyOrder({\r
  41     "additionalFields",\r
  42     "eventSourceHost",\r
  43     "eventSourceType",\r
  44     "syslogFacility",\r
  45     "syslogFieldsVersion",\r
  46     "syslogMsg",\r
  47     "syslogMsgHost",\r
  48     "syslogPri",\r
  49     "syslogProc",\r
  50     "syslogProcId",\r
  51     "syslogSData",\r
  52     "syslogSdId",\r
  53     "syslogSev",\r
  54     "syslogTag",\r
  55     "syslogTs",\r
  56     "syslogVer"\r
  57 })\r
  58 public class SyslogFields {\r
  59 \r
  60     /**\r
  61      * an associative array which is an array of key:value pairs\r
  62      * \r
  63      */\r
  64     @JsonProperty("additionalFields")\r
  65     @JsonPropertyDescription("an associative array which is an array of key:value pairs")\r
  66     private AlarmAdditionalInformation additionalFields;\r
  67     /**\r
  68      * hostname of the device\r
  69      * \r
  70      */\r
  71     @JsonProperty("eventSourceHost")\r
  72     @JsonPropertyDescription("hostname of the device")\r
  73     private String eventSourceHost;\r
  74     /**\r
  75      * type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction\r
  76      * (Required)\r
  77      * \r
  78      */\r
  79     @JsonProperty("eventSourceType")\r
  80     @JsonPropertyDescription("type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction")\r
  81     private String eventSourceType;\r
  82     /**\r
  83      * numeric code from 0 to 23 for facility--see table in documentation\r
  84      * \r
  85      */\r
  86     @JsonProperty("syslogFacility")\r
  87     @JsonPropertyDescription("numeric code from 0 to 23 for facility--see table in documentation")\r
  88     private Integer syslogFacility;\r
  89     /**\r
  90      * version of the syslogFields block\r
  91      * (Required)\r
  92      * \r
  93      */\r
  94     @JsonProperty("syslogFieldsVersion")\r
  95     @JsonPropertyDescription("version of the syslogFields block")\r
  96     private SyslogFields.SyslogFieldsVersion syslogFieldsVersion;\r
  97     /**\r
  98      * syslog message\r
  99      * (Required)\r
 100      * \r
 101      */\r
 102     @JsonProperty("syslogMsg")\r
 103     @JsonPropertyDescription("syslog message")\r
 104     private String syslogMsg;\r
 105     /**\r
 106      * hostname parsed from non-VES syslog message\r
 107      * \r
 108      */\r
 109     @JsonProperty("syslogMsgHost")\r
 110     @JsonPropertyDescription("hostname parsed from non-VES syslog message")\r
 111     private String syslogMsgHost;\r
 112     /**\r
 113      *  0-192 combined severity and facility\r
 114      * \r
 115      */\r
 116     @JsonProperty("syslogPri")\r
 117     @JsonPropertyDescription("0-192 combined severity and facility")\r
 118     private Integer syslogPri;\r
 119     /**\r
 120      * identifies the application that originated the message\r
 121      * \r
 122      */\r
 123     @JsonProperty("syslogProc")\r
 124     @JsonPropertyDescription("identifies the application that originated the message")\r
 125     private String syslogProc;\r
 126     /**\r
 127      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 128      * \r
 129      */\r
 130     @JsonProperty("syslogProcId")\r
 131     @JsonPropertyDescription("a change in the value of this field indicates a discontinuity in syslog reporting")\r
 132     private Double syslogProcId;\r
 133     /**\r
 134      * syslog structured data consisting of a structured data Id followed by a set of key value pairs\r
 135      * \r
 136      */\r
 137     @JsonProperty("syslogSData")\r
 138     @JsonPropertyDescription("syslog structured data consisting of a structured data Id followed by a set of key value pairs")\r
 139     private String syslogSData;\r
 140     /**\r
 141      *  0-32 char in format name@number for example ourSDID@32473\r
 142      * \r
 143      */\r
 144     @JsonProperty("syslogSdId")\r
 145     @JsonPropertyDescription("0-32 char in format name@number for example ourSDID@32473")\r
 146     private String syslogSdId;\r
 147     /**\r
 148      * numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8\r
 149      * \r
 150      */\r
 151     @JsonProperty("syslogSev")\r
 152     @JsonPropertyDescription("numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8")\r
 153     private SyslogFields.SyslogSev syslogSev;\r
 154     /**\r
 155      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided\r
 156      * (Required)\r
 157      * \r
 158      */\r
 159     @JsonProperty("syslogTag")\r
 160     @JsonPropertyDescription("msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided")\r
 161     private String syslogTag;\r
 162     /**\r
 163      * timestamp parsed from non-VES syslog message\r
 164      * \r
 165      */\r
 166     @JsonProperty("syslogTs")\r
 167     @JsonPropertyDescription("timestamp parsed from non-VES syslog message")\r
 168     private String syslogTs;\r
 169     /**\r
 170      * IANA assigned version of the syslog protocol specification - typically 1\r
 171      * \r
 172      */\r
 173     @JsonProperty("syslogVer")\r
 174     @JsonPropertyDescription("IANA assigned version of the syslog protocol specification - typically 1")\r
 175     private Double syslogVer;\r
 176 \r
 177     /**\r
 178      * an associative array which is an array of key:value pairs\r
 179      * \r
 180      */\r
 181     @JsonProperty("additionalFields")\r
 182     public AlarmAdditionalInformation getAdditionalFields() {\r
 183         return additionalFields;\r
 184     }\r
 185 \r
 186     /**\r
 187      * an associative array which is an array of key:value pairs\r
 188      * \r
 189      */\r
 190     @JsonProperty("additionalFields")\r
 191     public void setAdditionalFields(AlarmAdditionalInformation additionalFields) {\r
 192         this.additionalFields = additionalFields;\r
 193     }\r
 194 \r
 195     /**\r
 196      * hostname of the device\r
 197      * \r
 198      */\r
 199     @JsonProperty("eventSourceHost")\r
 200     public String getEventSourceHost() {\r
 201         return eventSourceHost;\r
 202     }\r
 203 \r
 204     /**\r
 205      * hostname of the device\r
 206      * \r
 207      */\r
 208     @JsonProperty("eventSourceHost")\r
 209     public void setEventSourceHost(String eventSourceHost) {\r
 210         this.eventSourceHost = eventSourceHost;\r
 211     }\r
 212 \r
 213     /**\r
 214      * type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction\r
 215      * (Required)\r
 216      * \r
 217      */\r
 218     @JsonProperty("eventSourceType")\r
 219     public String getEventSourceType() {\r
 220         return eventSourceType;\r
 221     }\r
 222 \r
 223     /**\r
 224      * type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction\r
 225      * (Required)\r
 226      * \r
 227      */\r
 228     @JsonProperty("eventSourceType")\r
 229     public void setEventSourceType(String eventSourceType) {\r
 230         this.eventSourceType = eventSourceType;\r
 231     }\r
 232 \r
 233     /**\r
 234      * numeric code from 0 to 23 for facility--see table in documentation\r
 235      * \r
 236      */\r
 237     @JsonProperty("syslogFacility")\r
 238     public Integer getSyslogFacility() {\r
 239         return syslogFacility;\r
 240     }\r
 241 \r
 242     /**\r
 243      * numeric code from 0 to 23 for facility--see table in documentation\r
 244      * \r
 245      */\r
 246     @JsonProperty("syslogFacility")\r
 247     public void setSyslogFacility(Integer syslogFacility) {\r
 248         this.syslogFacility = syslogFacility;\r
 249     }\r
 250 \r
 251     /**\r
 252      * version of the syslogFields block\r
 253      * (Required)\r
 254      * \r
 255      */\r
 256     @JsonProperty("syslogFieldsVersion")\r
 257     public SyslogFields.SyslogFieldsVersion getSyslogFieldsVersion() {\r
 258         return syslogFieldsVersion;\r
 259     }\r
 260 \r
 261     /**\r
 262      * version of the syslogFields block\r
 263      * (Required)\r
 264      * \r
 265      */\r
 266     @JsonProperty("syslogFieldsVersion")\r
 267     public void setSyslogFieldsVersion(SyslogFields.SyslogFieldsVersion syslogFieldsVersion) {\r
 268         this.syslogFieldsVersion = syslogFieldsVersion;\r
 269     }\r
 270 \r
 271     /**\r
 272      * syslog message\r
 273      * (Required)\r
 274      * \r
 275      */\r
 276     @JsonProperty("syslogMsg")\r
 277     public String getSyslogMsg() {\r
 278         return syslogMsg;\r
 279     }\r
 280 \r
 281     /**\r
 282      * syslog message\r
 283      * (Required)\r
 284      * \r
 285      */\r
 286     @JsonProperty("syslogMsg")\r
 287     public void setSyslogMsg(String syslogMsg) {\r
 288         this.syslogMsg = syslogMsg;\r
 289     }\r
 290 \r
 291     /**\r
 292      * hostname parsed from non-VES syslog message\r
 293      * \r
 294      */\r
 295     @JsonProperty("syslogMsgHost")\r
 296     public String getSyslogMsgHost() {\r
 297         return syslogMsgHost;\r
 298     }\r
 299 \r
 300     /**\r
 301      * hostname parsed from non-VES syslog message\r
 302      * \r
 303      */\r
 304     @JsonProperty("syslogMsgHost")\r
 305     public void setSyslogMsgHost(String syslogMsgHost) {\r
 306         this.syslogMsgHost = syslogMsgHost;\r
 307     }\r
 308 \r
 309     /**\r
 310      *  0-192 combined severity and facility\r
 311      * \r
 312      */\r
 313     @JsonProperty("syslogPri")\r
 314     public Integer getSyslogPri() {\r
 315         return syslogPri;\r
 316     }\r
 317 \r
 318     /**\r
 319      *  0-192 combined severity and facility\r
 320      * \r
 321      */\r
 322     @JsonProperty("syslogPri")\r
 323     public void setSyslogPri(Integer syslogPri) {\r
 324         this.syslogPri = syslogPri;\r
 325     }\r
 326 \r
 327     /**\r
 328      * identifies the application that originated the message\r
 329      * \r
 330      */\r
 331     @JsonProperty("syslogProc")\r
 332     public String getSyslogProc() {\r
 333         return syslogProc;\r
 334     }\r
 335 \r
 336     /**\r
 337      * identifies the application that originated the message\r
 338      * \r
 339      */\r
 340     @JsonProperty("syslogProc")\r
 341     public void setSyslogProc(String syslogProc) {\r
 342         this.syslogProc = syslogProc;\r
 343     }\r
 344 \r
 345     /**\r
 346      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 347      * \r
 348      */\r
 349     @JsonProperty("syslogProcId")\r
 350     public Double getSyslogProcId() {\r
 351         return syslogProcId;\r
 352     }\r
 353 \r
 354     /**\r
 355      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 356      * \r
 357      */\r
 358     @JsonProperty("syslogProcId")\r
 359     public void setSyslogProcId(Double syslogProcId) {\r
 360         this.syslogProcId = syslogProcId;\r
 361     }\r
 362 \r
 363     /**\r
 364      * syslog structured data consisting of a structured data Id followed by a set of key value pairs\r
 365      * \r
 366      */\r
 367     @JsonProperty("syslogSData")\r
 368     public String getSyslogSData() {\r
 369         return syslogSData;\r
 370     }\r
 371 \r
 372     /**\r
 373      * syslog structured data consisting of a structured data Id followed by a set of key value pairs\r
 374      * \r
 375      */\r
 376     @JsonProperty("syslogSData")\r
 377     public void setSyslogSData(String syslogSData) {\r
 378         this.syslogSData = syslogSData;\r
 379     }\r
 380 \r
 381     /**\r
 382      *  0-32 char in format name@number for example ourSDID@32473\r
 383      * \r
 384      */\r
 385     @JsonProperty("syslogSdId")\r
 386     public String getSyslogSdId() {\r
 387         return syslogSdId;\r
 388     }\r
 389 \r
 390     /**\r
 391      *  0-32 char in format name@number for example ourSDID@32473\r
 392      * \r
 393      */\r
 394     @JsonProperty("syslogSdId")\r
 395     public void setSyslogSdId(String syslogSdId) {\r
 396         this.syslogSdId = syslogSdId;\r
 397     }\r
 398 \r
 399     /**\r
 400      * numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8\r
 401      * \r
 402      */\r
 403     @JsonProperty("syslogSev")\r
 404     public SyslogFields.SyslogSev getSyslogSev() {\r
 405         return syslogSev;\r
 406     }\r
 407 \r
 408     /**\r
 409      * numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8\r
 410      * \r
 411      */\r
 412     @JsonProperty("syslogSev")\r
 413     public void setSyslogSev(SyslogFields.SyslogSev syslogSev) {\r
 414         this.syslogSev = syslogSev;\r
 415     }\r
 416 \r
 417     /**\r
 418      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided\r
 419      * (Required)\r
 420      * \r
 421      */\r
 422     @JsonProperty("syslogTag")\r
 423     public String getSyslogTag() {\r
 424         return syslogTag;\r
 425     }\r
 426 \r
 427     /**\r
 428      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided\r
 429      * (Required)\r
 430      * \r
 431      */\r
 432     @JsonProperty("syslogTag")\r
 433     public void setSyslogTag(String syslogTag) {\r
 434         this.syslogTag = syslogTag;\r
 435     }\r
 436 \r
 437     /**\r
 438      * timestamp parsed from non-VES syslog message\r
 439      * \r
 440      */\r
 441     @JsonProperty("syslogTs")\r
 442     public String getSyslogTs() {\r
 443         return syslogTs;\r
 444     }\r
 445 \r
 446     /**\r
 447      * timestamp parsed from non-VES syslog message\r
 448      * \r
 449      */\r
 450     @JsonProperty("syslogTs")\r
 451     public void setSyslogTs(String syslogTs) {\r
 452         this.syslogTs = syslogTs;\r
 453     }\r
 454 \r
 455     /**\r
 456      * IANA assigned version of the syslog protocol specification - typically 1\r
 457      * \r
 458      */\r
 459     @JsonProperty("syslogVer")\r
 460     public Double getSyslogVer() {\r
 461         return syslogVer;\r
 462     }\r
 463 \r
 464     /**\r
 465      * IANA assigned version of the syslog protocol specification - typically 1\r
 466      * \r
 467      */\r
 468     @JsonProperty("syslogVer")\r
 469     public void setSyslogVer(Double syslogVer) {\r
 470         this.syslogVer = syslogVer;\r
 471     }\r
 472 \r
 473     @Override\r
 474     public String toString() {\r
 475         return ToStringBuilder.reflectionToString(this);\r
 476     }\r
 477 \r
 478     @Override\r
 479     public int hashCode() {\r
 480         return new HashCodeBuilder().append(additionalFields).append(eventSourceHost).append(eventSourceType).append(syslogFacility).append(syslogFieldsVersion).append(syslogMsg).append(syslogMsgHost).append(syslogPri).append(syslogProc).append(syslogProcId).append(syslogSData).append(syslogSdId).append(syslogSev).append(syslogTag).append(syslogTs).append(syslogVer).toHashCode();\r
 481     }\r
 482 \r
 483     @Override\r
 484     public boolean equals(Object other) {\r
 485         if (other == this) {\r
 486             return true;\r
 487         }\r
 488         if ((other instanceof SyslogFields) == false) {\r
 489             return false;\r
 490         }\r
 491         SyslogFields rhs = ((SyslogFields) other);\r
 492         return new EqualsBuilder().append(additionalFields, rhs.additionalFields).append(eventSourceHost, rhs.eventSourceHost).append(eventSourceType, rhs.eventSourceType).append(syslogFacility, rhs.syslogFacility).append(syslogFieldsVersion, rhs.syslogFieldsVersion).append(syslogMsg, rhs.syslogMsg).append(syslogMsgHost, rhs.syslogMsgHost).append(syslogPri, rhs.syslogPri).append(syslogProc, rhs.syslogProc).append(syslogProcId, rhs.syslogProcId).append(syslogSData, rhs.syslogSData).append(syslogSdId, rhs.syslogSdId).append(syslogSev, rhs.syslogSev).append(syslogTag, rhs.syslogTag).append(syslogTs, rhs.syslogTs).append(syslogVer, rhs.syslogVer).isEquals();\r
 493     }\r
 494 \r
 495     public enum SyslogFieldsVersion {\r
 496 \r
 497         _4_0("4.0");\r
 498         private final String value;\r
 499         private final static Map<String, SyslogFields.SyslogFieldsVersion> CONSTANTS = new HashMap<String, SyslogFields.SyslogFieldsVersion>();\r
 500 \r
 501         static {\r
 502             for (SyslogFields.SyslogFieldsVersion c: values()) {\r
 503                 CONSTANTS.put(c.value, c);\r
 504             }\r
 505         }\r
 506 \r
 507         private SyslogFieldsVersion(String value) {\r
 508             this.value = value;\r
 509         }\r
 510 \r
 511         @Override\r
 512         public String toString() {\r
 513             return this.value;\r
 514         }\r
 515 \r
 516         @JsonValue\r
 517         public String value() {\r
 518             return this.value;\r
 519         }\r
 520 \r
 521         @JsonCreator\r
 522         public static SyslogFields.SyslogFieldsVersion fromValue(String value) {\r
 523             SyslogFields.SyslogFieldsVersion constant = CONSTANTS.get(value);\r
 524             if (constant == null) {\r
 525                 throw new IllegalArgumentException(value);\r
 526             } else {\r
 527                 return constant;\r
 528             }\r
 529         }\r
 530 \r
 531     }\r
 532 \r
 533     public enum SyslogSev {\r
 534 \r
 535         ALERT("Alert"),\r
 536         CRITICAL("Critical"),\r
 537         DEBUG("Debug"),\r
 538         EMERGENCY("Emergency"),\r
 539         ERROR("Error"),\r
 540         INFO("Info"),\r
 541         NOTICE("Notice"),\r
 542         WARNING("Warning");\r
 543         private final String value;\r
 544         private final static Map<String, SyslogFields.SyslogSev> CONSTANTS = new HashMap<String, SyslogFields.SyslogSev>();\r
 545 \r
 546         static {\r
 547             for (SyslogFields.SyslogSev c: values()) {\r
 548                 CONSTANTS.put(c.value, c);\r
 549             }\r
 550         }\r
 551 \r
 552         private SyslogSev(String value) {\r
 553             this.value = value;\r
 554         }\r
 555 \r
 556         @Override\r
 557         public String toString() {\r
 558             return this.value;\r
 559         }\r
 560 \r
 561         @JsonValue\r
 562         public String value() {\r
 563             return this.value;\r
 564         }\r
 565 \r
 566         @JsonCreator\r
 567         public static SyslogFields.SyslogSev fromValue(String value) {\r
 568             SyslogFields.SyslogSev constant = CONSTANTS.get(value);\r
 569             if (constant == null) {\r
 570                 throw new IllegalArgumentException(value);\r
 571             } else {\r
 572                 return constant;\r
 573             }\r
 574         }\r
 575 \r
 576     }\r
 577 \r
 578 }\r