UniversalVesAdapter/src/main/java/org/onap/dcaegen2/ves/domain/ves54/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 \r
  21 package org.onap.dcaegen2.ves.domain.ves54;\r
  22 \r
  23 import java.util.HashMap;\r
  24 import java.util.Map;\r
  25 \r
  26 import org.apache.commons.lang.builder.HashCodeBuilder;\r
  27 import org.apache.commons.lang.builder.ToStringBuilder;\r
  28 \r
  29 import com.fasterxml.jackson.annotation.JsonAnyGetter;\r
  30 import com.fasterxml.jackson.annotation.JsonAnySetter;\r
  31 import com.fasterxml.jackson.annotation.JsonCreator;\r
  32 import com.fasterxml.jackson.annotation.JsonIgnore;\r
  33 import com.fasterxml.jackson.annotation.JsonInclude;\r
  34 import com.fasterxml.jackson.annotation.JsonProperty;\r
  35 import com.fasterxml.jackson.annotation.JsonPropertyDescription;\r
  36 import com.fasterxml.jackson.annotation.JsonPropertyOrder;\r
  37 import com.fasterxml.jackson.annotation.JsonValue;\r
  38 \r
  39 \r
  40 /**\r
  41  * sysLog fields\r
  42  * \r
  43  */\r
  44 @JsonInclude(JsonInclude.Include.NON_NULL)\r
  45 @JsonPropertyOrder({"additionalFields", "eventSourceHost", "eventSourceType", "syslogFacility",\r
  46         "syslogFieldsVersion", "syslogMsg", "syslogPri", "syslogProc", "syslogProcId",\r
  47         "syslogSData", "syslogSdId", "syslogSev", "syslogTag", "syslogVer"})\r
  48 public class SyslogFields {\r
  49     \r
  50     /**\r
  51      * additional syslog fields if needed provided as name=value delimited by a pipe ‘|’ symbol, for\r
  52      * example: 'name1=value1|name2=value2|…'\r
  53      * \r
  54      */\r
  55     @JsonProperty("additionalFields")\r
  56     @JsonPropertyDescription("additional syslog fields if needed provided as name=value delimited by a pipe \u2018|\u2019 symbol, for example: 'name1=value1|name2=value2|\u2026'")\r
  57     private String additionalFields;\r
  58     /**\r
  59      * hostname of the device\r
  60      * \r
  61      */\r
  62     @JsonProperty("eventSourceHost")\r
  63     @JsonPropertyDescription("hostname of the device")\r
  64     private String eventSourceHost;\r
  65     /**\r
  66      * type of event source; examples: other, router, switch, host, card, port, slotThreshold,\r
  67      * portThreshold, virtualMachine, virtualNetworkFunction (Required)\r
  68      * \r
  69      */\r
  70     @JsonProperty("eventSourceType")\r
  71     @JsonPropertyDescription("type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction")\r
  72     private String eventSourceType;\r
  73     /**\r
  74      * numeric code from 0 to 23 for facility--see table in documentation\r
  75      * \r
  76      */\r
  77     @JsonProperty("syslogFacility")\r
  78     @JsonPropertyDescription("numeric code from 0 to 23 for facility--see table in documentation")\r
  79     private Integer syslogFacility;\r
  80     /**\r
  81      * version of the syslogFields block (Required)\r
  82      * \r
  83      */\r
  84     @JsonProperty("syslogFieldsVersion")\r
  85     @JsonPropertyDescription("version of the syslogFields block")\r
  86     private Double syslogFieldsVersion;\r
  87     /**\r
  88      * syslog message (Required)\r
  89      * \r
  90      */\r
  91     @JsonProperty("syslogMsg")\r
  92     @JsonPropertyDescription("syslog message")\r
  93     private String syslogMsg;\r
  94     /**\r
  95      * 0-192 combined severity and facility\r
  96      * \r
  97      */\r
  98     @JsonProperty("syslogPri")\r
  99     @JsonPropertyDescription("0-192 combined severity and facility")\r
 100     private Integer syslogPri;\r
 101     /**\r
 102      * identifies the application that originated the message\r
 103      * \r
 104      */\r
 105     @JsonProperty("syslogProc")\r
 106     @JsonPropertyDescription("identifies the application that originated the message")\r
 107     private String syslogProc;\r
 108     /**\r
 109      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 110      * \r
 111      */\r
 112     @JsonProperty("syslogProcId")\r
 113     @JsonPropertyDescription("a change in the value of this field indicates a discontinuity in syslog reporting")\r
 114     private Double syslogProcId;\r
 115     /**\r
 116      * syslog structured data consisting of a structured data Id followed by a set of key value\r
 117      * pairs\r
 118      * \r
 119      */\r
 120     @JsonProperty("syslogSData")\r
 121     @JsonPropertyDescription("syslog structured data consisting of a structured data Id followed by a set of key value pairs")\r
 122     private String syslogSData;\r
 123     /**\r
 124      * 0-32 char in format name@number for example ourSDID@32473\r
 125      * \r
 126      */\r
 127     @JsonProperty("syslogSdId")\r
 128     @JsonPropertyDescription("0-32 char in format name@number for example ourSDID@32473")\r
 129     private String syslogSdId;\r
 130     /**\r
 131      * numerical Code for severity derived from syslogPri as remaider of syslogPri / 8\r
 132      * \r
 133      */\r
 134     @JsonProperty("syslogSev")\r
 135     @JsonPropertyDescription("numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8")\r
 136     private SyslogFields.SyslogSev syslogSev;\r
 137     /**\r
 138      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no\r
 139      * other value can be provided (Required)\r
 140      * \r
 141      */\r
 142     @JsonProperty("syslogTag")\r
 143     @JsonPropertyDescription("msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided")\r
 144     private String syslogTag;\r
 145     /**\r
 146      * IANA assigned version of the syslog protocol specification - typically 1\r
 147      * \r
 148      */\r
 149     @JsonProperty("syslogVer")\r
 150     @JsonPropertyDescription("IANA assigned version of the syslog protocol specification - typically 1")\r
 151     private Double syslogVer;\r
 152     @JsonIgnore\r
 153     private Map<String, Object> additionalProperties = new HashMap<String, Object>();\r
 154     \r
 155     /**\r
 156      * additional syslog fields if needed provided as name=value delimited by a pipe ‘|’ symbol, for\r
 157      * example: 'name1=value1|name2=value2|…'\r
 158      * \r
 159      */\r
 160     @JsonProperty("additionalFields")\r
 161     public String getAdditionalFields() {\r
 162         return additionalFields;\r
 163     }\r
 164     \r
 165     /**\r
 166      * additional syslog fields if needed provided as name=value delimited by a pipe ‘|’ symbol, for\r
 167      * example: 'name1=value1|name2=value2|…'\r
 168      * \r
 169      */\r
 170     @JsonProperty("additionalFields")\r
 171     public void setAdditionalFields(String additionalFields) {\r
 172         this.additionalFields = additionalFields;\r
 173     }\r
 174     \r
 175     /**\r
 176      * hostname of the device\r
 177      * \r
 178      */\r
 179     @JsonProperty("eventSourceHost")\r
 180     public String getEventSourceHost() {\r
 181         return eventSourceHost;\r
 182     }\r
 183     \r
 184     /**\r
 185      * hostname of the device\r
 186      * \r
 187      */\r
 188     @JsonProperty("eventSourceHost")\r
 189     public void setEventSourceHost(String eventSourceHost) {\r
 190         this.eventSourceHost = eventSourceHost;\r
 191     }\r
 192     \r
 193     /**\r
 194      * type of event source; examples: other, router, switch, host, card, port, slotThreshold,\r
 195      * portThreshold, virtualMachine, virtualNetworkFunction (Required)\r
 196      * \r
 197      */\r
 198     @JsonProperty("eventSourceType")\r
 199     public String getEventSourceType() {\r
 200         return eventSourceType;\r
 201     }\r
 202     \r
 203     /**\r
 204      * type of event source; examples: other, router, switch, host, card, port, slotThreshold,\r
 205      * portThreshold, virtualMachine, virtualNetworkFunction (Required)\r
 206      * \r
 207      */\r
 208     @JsonProperty("eventSourceType")\r
 209     public void setEventSourceType(String eventSourceType) {\r
 210         this.eventSourceType = eventSourceType;\r
 211     }\r
 212     \r
 213     /**\r
 214      * numeric code from 0 to 23 for facility--see table in documentation\r
 215      * \r
 216      */\r
 217     @JsonProperty("syslogFacility")\r
 218     public Integer getSyslogFacility() {\r
 219         return syslogFacility;\r
 220     }\r
 221     \r
 222     /**\r
 223      * numeric code from 0 to 23 for facility--see table in documentation\r
 224      * \r
 225      */\r
 226     @JsonProperty("syslogFacility")\r
 227     public void setSyslogFacility(Integer syslogFacility) {\r
 228         this.syslogFacility = syslogFacility;\r
 229     }\r
 230     \r
 231     /**\r
 232      * version of the syslogFields block (Required)\r
 233      * \r
 234      */\r
 235     @JsonProperty("syslogFieldsVersion")\r
 236     public Double getSyslogFieldsVersion() {\r
 237         return syslogFieldsVersion;\r
 238     }\r
 239     \r
 240     /**\r
 241      * version of the syslogFields block (Required)\r
 242      * \r
 243      */\r
 244     @JsonProperty("syslogFieldsVersion")\r
 245     public void setSyslogFieldsVersion(Double syslogFieldsVersion) {\r
 246         this.syslogFieldsVersion = syslogFieldsVersion;\r
 247     }\r
 248     \r
 249     /**\r
 250      * syslog message (Required)\r
 251      * \r
 252      */\r
 253     @JsonProperty("syslogMsg")\r
 254     public String getSyslogMsg() {\r
 255         return syslogMsg;\r
 256     }\r
 257     \r
 258     /**\r
 259      * syslog message (Required)\r
 260      * \r
 261      */\r
 262     @JsonProperty("syslogMsg")\r
 263     public void setSyslogMsg(String syslogMsg) {\r
 264         this.syslogMsg = syslogMsg;\r
 265     }\r
 266     \r
 267     /**\r
 268      * 0-192 combined severity and facility\r
 269      * \r
 270      */\r
 271     @JsonProperty("syslogPri")\r
 272     public Integer getSyslogPri() {\r
 273         return syslogPri;\r
 274     }\r
 275     \r
 276     /**\r
 277      * 0-192 combined severity and facility\r
 278      * \r
 279      */\r
 280     @JsonProperty("syslogPri")\r
 281     public void setSyslogPri(Integer syslogPri) {\r
 282         this.syslogPri = syslogPri;\r
 283     }\r
 284     \r
 285     /**\r
 286      * identifies the application that originated the message\r
 287      * \r
 288      */\r
 289     @JsonProperty("syslogProc")\r
 290     public String getSyslogProc() {\r
 291         return syslogProc;\r
 292     }\r
 293     \r
 294     /**\r
 295      * identifies the application that originated the message\r
 296      * \r
 297      */\r
 298     @JsonProperty("syslogProc")\r
 299     public void setSyslogProc(String syslogProc) {\r
 300         this.syslogProc = syslogProc;\r
 301     }\r
 302     \r
 303     /**\r
 304      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 305      * \r
 306      */\r
 307     @JsonProperty("syslogProcId")\r
 308     public Double getSyslogProcId() {\r
 309         return syslogProcId;\r
 310     }\r
 311     \r
 312     /**\r
 313      * a change in the value of this field indicates a discontinuity in syslog reporting\r
 314      * \r
 315      */\r
 316     @JsonProperty("syslogProcId")\r
 317     public void setSyslogProcId(Double syslogProcId) {\r
 318         this.syslogProcId = syslogProcId;\r
 319     }\r
 320     \r
 321     /**\r
 322      * syslog structured data consisting of a structured data Id followed by a set of key value\r
 323      * pairs\r
 324      * \r
 325      */\r
 326     @JsonProperty("syslogSData")\r
 327     public String getSyslogSData() {\r
 328         return syslogSData;\r
 329     }\r
 330     \r
 331     /**\r
 332      * syslog structured data consisting of a structured data Id followed by a set of key value\r
 333      * pairs\r
 334      * \r
 335      */\r
 336     @JsonProperty("syslogSData")\r
 337     public void setSyslogSData(String syslogSData) {\r
 338         this.syslogSData = syslogSData;\r
 339     }\r
 340     \r
 341     /**\r
 342      * 0-32 char in format name@number for example ourSDID@32473\r
 343      * \r
 344      */\r
 345     @JsonProperty("syslogSdId")\r
 346     public String getSyslogSdId() {\r
 347         return syslogSdId;\r
 348     }\r
 349     \r
 350     /**\r
 351      * 0-32 char in format name@number for example ourSDID@32473\r
 352      * \r
 353      */\r
 354     @JsonProperty("syslogSdId")\r
 355     public void setSyslogSdId(String syslogSdId) {\r
 356         this.syslogSdId = syslogSdId;\r
 357     }\r
 358     \r
 359     /**\r
 360      * numerical Code for severity derived from syslogPri as remaider of syslogPri / 8\r
 361      * \r
 362      */\r
 363     @JsonProperty("syslogSev")\r
 364     public SyslogFields.SyslogSev getSyslogSev() {\r
 365         return syslogSev;\r
 366     }\r
 367     \r
 368     /**\r
 369      * numerical Code for severity derived from syslogPri as remaider of syslogPri / 8\r
 370      * \r
 371      */\r
 372     @JsonProperty("syslogSev")\r
 373     public void setSyslogSev(SyslogFields.SyslogSev syslogSev) {\r
 374         this.syslogSev = syslogSev;\r
 375     }\r
 376     \r
 377     /**\r
 378      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no\r
 379      * other value can be provided (Required)\r
 380      * \r
 381      */\r
 382     @JsonProperty("syslogTag")\r
 383     public String getSyslogTag() {\r
 384         return syslogTag;\r
 385     }\r
 386     \r
 387     /**\r
 388      * msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no\r
 389      * other value can be provided (Required)\r
 390      * \r
 391      */\r
 392     @JsonProperty("syslogTag")\r
 393     public void setSyslogTag(String syslogTag) {\r
 394         this.syslogTag = syslogTag;\r
 395     }\r
 396     \r
 397     /**\r
 398      * IANA assigned version of the syslog protocol specification - typically 1\r
 399      * \r
 400      */\r
 401     @JsonProperty("syslogVer")\r
 402     public Double getSyslogVer() {\r
 403         return syslogVer;\r
 404     }\r
 405     \r
 406     /**\r
 407      * IANA assigned version of the syslog protocol specification - typically 1\r
 408      * \r
 409      */\r
 410     @JsonProperty("syslogVer")\r
 411     public void setSyslogVer(Double syslogVer) {\r
 412         this.syslogVer = syslogVer;\r
 413     }\r
 414     \r
 415     @Override\r
 416     public String toString() {\r
 417         return ToStringBuilder.reflectionToString(this);\r
 418     }\r
 419     \r
 420     @JsonAnyGetter\r
 421     public Map<String, Object> getAdditionalProperties() {\r
 422         return this.additionalProperties;\r
 423     }\r
 424     \r
 425     @JsonAnySetter\r
 426     public void setAdditionalProperty(String name, Object value) {\r
 427         this.additionalProperties.put(name, value);\r
 428     }\r
 429     \r
 430     @Override\r
 431     public int hashCode() {\r
 432         return new HashCodeBuilder().append(additionalFields).append(eventSourceHost)\r
 433                 .append(eventSourceType).append(syslogFacility).append(syslogFieldsVersion)\r
 434                 .append(syslogMsg).append(syslogPri).append(syslogProc).append(syslogProcId)\r
 435                 .append(syslogSData).append(syslogSdId).append(syslogSev).append(syslogTag)\r
 436                 .append(syslogVer).append(additionalProperties).toHashCode();\r
 437     }\r
 438     \r
 439     \r
 440     \r
 441     public enum SyslogSev {\r
 442         \r
 443         ALERT("Alert"), CRITICAL("Critical"), DEBUG("Debug"), EMERGENCY("Emergency"), ERROR(\r
 444                 "Error"), INFO("Info"), NOTICE("Notice"), WARNING("Warning");\r
 445         private final String value;\r
 446         private final static Map<String, SyslogFields.SyslogSev> CONSTANTS =\r
 447                 new HashMap<String, SyslogFields.SyslogSev>();\r
 448         \r
 449         static {\r
 450             for (SyslogFields.SyslogSev c : values()) {\r
 451                 CONSTANTS.put(c.value, c);\r
 452             }\r
 453         }\r
 454         \r
 455         private SyslogSev(String value) {\r
 456             this.value = value;\r
 457         }\r
 458         \r
 459         @Override\r
 460         public String toString() {\r
 461             return this.value;\r
 462         }\r
 463         \r
 464         @JsonValue\r
 465         public String value() {\r
 466             return this.value;\r
 467         }\r
 468         \r
 469         @JsonCreator\r
 470         public static SyslogFields.SyslogSev fromValue(String value) {\r
 471             SyslogFields.SyslogSev constant = CONSTANTS.get(value);\r
 472             if (constant == null) {\r
 473                 throw new IllegalArgumentException(value);\r
 474             } else {\r
 475                 return constant;\r
 476             }\r
 477         }\r
 478         \r
 479     }\r
 480     \r
 481 }\r