com.contrastsecurity.sarif.Notification Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sarif Show documentation
Show all versions of java-sarif Show documentation
POJOs generated from the JSON schema for Static Analysis Results Interchange Format (SARIF)
package com.contrastsecurity.sarif;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
/**
* Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"locations",
"message",
"level",
"threadId",
"timeUtc",
"exception",
"descriptor",
"associatedRule",
"properties"
})
public class Notification {
/**
* The locations relevant to this notification.
*
*/
@JsonProperty("locations")
@JsonDeserialize(as = java.util.LinkedHashSet.class)
@JsonPropertyDescription("The locations relevant to this notification.")
private Set locations = new LinkedHashSet();
/**
* Encapsulates a message intended to be read by the end user.
* (Required)
*
*/
@JsonProperty("message")
@JsonPropertyDescription("Encapsulates a message intended to be read by the end user.")
private Message message;
/**
* A value specifying the severity level of the notification.
*
*/
@JsonProperty("level")
@JsonPropertyDescription("A value specifying the severity level of the notification.")
private Notification.Level level = Notification.Level.fromValue("warning");
/**
* The thread identifier of the code that generated the notification.
*
*/
@JsonProperty("threadId")
@JsonPropertyDescription("The thread identifier of the code that generated the notification.")
private Integer threadId;
/**
* The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
*
*/
@JsonProperty("timeUtc")
@JsonPropertyDescription("The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.")
private Date timeUtc;
/**
* Describes a runtime exception encountered during the execution of an analysis tool.
*
*/
@JsonProperty("exception")
@JsonPropertyDescription("Describes a runtime exception encountered during the execution of an analysis tool.")
private Exception exception;
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("descriptor")
@JsonPropertyDescription("Information about how to locate a relevant reporting descriptor.")
private ReportingDescriptorReference descriptor;
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("associatedRule")
@JsonPropertyDescription("Information about how to locate a relevant reporting descriptor.")
private ReportingDescriptorReference associatedRule;
/**
* Key/value pairs that provide additional information about the object.
*
*/
@JsonProperty("properties")
@JsonPropertyDescription("Key/value pairs that provide additional information about the object.")
private PropertyBag properties;
/**
* The locations relevant to this notification.
*
*/
@JsonProperty("locations")
public Set getLocations() {
return locations;
}
/**
* The locations relevant to this notification.
*
*/
@JsonProperty("locations")
public void setLocations(Set locations) {
this.locations = locations;
}
public Notification withLocations(Set locations) {
this.locations = locations;
return this;
}
/**
* Encapsulates a message intended to be read by the end user.
* (Required)
*
*/
@JsonProperty("message")
public Message getMessage() {
return message;
}
/**
* Encapsulates a message intended to be read by the end user.
* (Required)
*
*/
@JsonProperty("message")
public void setMessage(Message message) {
this.message = message;
}
public Notification withMessage(Message message) {
this.message = message;
return this;
}
/**
* A value specifying the severity level of the notification.
*
*/
@JsonProperty("level")
public Notification.Level getLevel() {
return level;
}
/**
* A value specifying the severity level of the notification.
*
*/
@JsonProperty("level")
public void setLevel(Notification.Level level) {
this.level = level;
}
public Notification withLevel(Notification.Level level) {
this.level = level;
return this;
}
/**
* The thread identifier of the code that generated the notification.
*
*/
@JsonProperty("threadId")
public Integer getThreadId() {
return threadId;
}
/**
* The thread identifier of the code that generated the notification.
*
*/
@JsonProperty("threadId")
public void setThreadId(Integer threadId) {
this.threadId = threadId;
}
public Notification withThreadId(Integer threadId) {
this.threadId = threadId;
return this;
}
/**
* The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
*
*/
@JsonProperty("timeUtc")
public Date getTimeUtc() {
return timeUtc;
}
/**
* The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
*
*/
@JsonProperty("timeUtc")
public void setTimeUtc(Date timeUtc) {
this.timeUtc = timeUtc;
}
public Notification withTimeUtc(Date timeUtc) {
this.timeUtc = timeUtc;
return this;
}
/**
* Describes a runtime exception encountered during the execution of an analysis tool.
*
*/
@JsonProperty("exception")
public Exception getException() {
return exception;
}
/**
* Describes a runtime exception encountered during the execution of an analysis tool.
*
*/
@JsonProperty("exception")
public void setException(Exception exception) {
this.exception = exception;
}
public Notification withException(Exception exception) {
this.exception = exception;
return this;
}
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("descriptor")
public ReportingDescriptorReference getDescriptor() {
return descriptor;
}
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("descriptor")
public void setDescriptor(ReportingDescriptorReference descriptor) {
this.descriptor = descriptor;
}
public Notification withDescriptor(ReportingDescriptorReference descriptor) {
this.descriptor = descriptor;
return this;
}
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("associatedRule")
public ReportingDescriptorReference getAssociatedRule() {
return associatedRule;
}
/**
* Information about how to locate a relevant reporting descriptor.
*
*/
@JsonProperty("associatedRule")
public void setAssociatedRule(ReportingDescriptorReference associatedRule) {
this.associatedRule = associatedRule;
}
public Notification withAssociatedRule(ReportingDescriptorReference associatedRule) {
this.associatedRule = associatedRule;
return this;
}
/**
* Key/value pairs that provide additional information about the object.
*
*/
@JsonProperty("properties")
public PropertyBag getProperties() {
return properties;
}
/**
* Key/value pairs that provide additional information about the object.
*
*/
@JsonProperty("properties")
public void setProperties(PropertyBag properties) {
this.properties = properties;
}
public Notification withProperties(PropertyBag properties) {
this.properties = properties;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(Notification.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).append('[');
sb.append("locations");
sb.append('=');
sb.append(((this.locations == null)?"":this.locations));
sb.append(',');
sb.append("message");
sb.append('=');
sb.append(((this.message == null)?"":this.message));
sb.append(',');
sb.append("level");
sb.append('=');
sb.append(((this.level == null)?"":this.level));
sb.append(',');
sb.append("threadId");
sb.append('=');
sb.append(((this.threadId == null)?"":this.threadId));
sb.append(',');
sb.append("timeUtc");
sb.append('=');
sb.append(((this.timeUtc == null)?"":this.timeUtc));
sb.append(',');
sb.append("exception");
sb.append('=');
sb.append(((this.exception == null)?"":this.exception));
sb.append(',');
sb.append("descriptor");
sb.append('=');
sb.append(((this.descriptor == null)?"":this.descriptor));
sb.append(',');
sb.append("associatedRule");
sb.append('=');
sb.append(((this.associatedRule == null)?"":this.associatedRule));
sb.append(',');
sb.append("properties");
sb.append('=');
sb.append(((this.properties == null)?"":this.properties));
sb.append(',');
if (sb.charAt((sb.length()- 1)) == ',') {
sb.setCharAt((sb.length()- 1), ']');
} else {
sb.append(']');
}
return sb.toString();
}
@Override
public int hashCode() {
int result = 1;
result = ((result* 31)+((this.threadId == null)? 0 :this.threadId.hashCode()));
result = ((result* 31)+((this.exception == null)? 0 :this.exception.hashCode()));
result = ((result* 31)+((this.level == null)? 0 :this.level.hashCode()));
result = ((result* 31)+((this.associatedRule == null)? 0 :this.associatedRule.hashCode()));
result = ((result* 31)+((this.timeUtc == null)? 0 :this.timeUtc.hashCode()));
result = ((result* 31)+((this.locations == null)? 0 :this.locations.hashCode()));
result = ((result* 31)+((this.descriptor == null)? 0 :this.descriptor.hashCode()));
result = ((result* 31)+((this.message == null)? 0 :this.message.hashCode()));
result = ((result* 31)+((this.properties == null)? 0 :this.properties.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof Notification) == false) {
return false;
}
Notification rhs = ((Notification) other);
return ((((((((((this.threadId == rhs.threadId)||((this.threadId!= null)&&this.threadId.equals(rhs.threadId)))&&((this.exception == rhs.exception)||((this.exception!= null)&&this.exception.equals(rhs.exception))))&&((this.level == rhs.level)||((this.level!= null)&&this.level.equals(rhs.level))))&&((this.associatedRule == rhs.associatedRule)||((this.associatedRule!= null)&&this.associatedRule.equals(rhs.associatedRule))))&&((this.timeUtc == rhs.timeUtc)||((this.timeUtc!= null)&&this.timeUtc.equals(rhs.timeUtc))))&&((this.locations == rhs.locations)||((this.locations!= null)&&this.locations.equals(rhs.locations))))&&((this.descriptor == rhs.descriptor)||((this.descriptor!= null)&&this.descriptor.equals(rhs.descriptor))))&&((this.message == rhs.message)||((this.message!= null)&&this.message.equals(rhs.message))))&&((this.properties == rhs.properties)||((this.properties!= null)&&this.properties.equals(rhs.properties))));
}
/**
* A value specifying the severity level of the notification.
*
*/
public enum Level {
NONE("none"),
NOTE("note"),
WARNING("warning"),
ERROR("error");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (Notification.Level c: values()) {
CONSTANTS.put(c.value, c);
}
}
private Level(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static Notification.Level fromValue(String value) {
Notification.Level constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
}