Add serializable and Serial.Version annotation for all objects

This is to support Camunda Storage with Taxii Server

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>io.digitalstate.stix</groupId>
     <artifactId>stix</artifactId>
-    <version>v0.5.1</version>
+    <version>v0.5.2</version>
     <packaging>jar</packaging>
 
     <name>STIX 2</name>

src/main/java/io/digitalstate/stix/coo/CyberObservableObject.java

@@ -2,7 +2,9 @@
 
 import io.digitalstate.stix.common.StixCustomProperties;
 
-public interface CyberObservableObject extends
+import java.io.Serializable;
+
+public interface CyberObservableObject extends Serializable,
         CyberObservableObjectCommonProperties,
         StixCustomProperties {
 

src/main/java/io/digitalstate/stix/datamarkings/GranularMarkingDm.java

@@ -9,17 +9,19 @@
 import io.digitalstate.stix.json.converters.dehydrated.MarkingDefinitionConverter;
 import io.digitalstate.stix.redaction.Redactable;
 import io.digitalstate.stix.validation.SdoDefaultValidator;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Size;
+import java.io.Serializable;
 import java.util.Set;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Dm", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE)
 @JsonSerialize(as = GranularMarking.class) @JsonDeserialize(builder = GranularMarking.Builder.class)
 @Redactable
-public interface GranularMarkingDm extends SdoDefaultValidator {
+public interface GranularMarkingDm extends SdoDefaultValidator, Serializable {
 
     @NotNull
     @JsonProperty("marking_ref")

src/main/java/io/digitalstate/stix/datamarkings/MarkingDefinitionDm.java

@@ -11,6 +11,7 @@
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.contraints.markingdefinitiontype.MarkingDefinitionTypeLimit;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -23,7 +24,7 @@
  *     <li>{@link MarkingDefinition#definition}  - the Marking Object.  Two objects are currently supported: {@link Tlp} and {@link Statement}.</li>
  * </ol>
  */
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("marking-definition")
 @DefaultTypeValue(value = "marking-definition", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Dm", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/datamarkings/StatementMarkingObject.java

@@ -6,11 +6,12 @@
 import io.digitalstate.stix.redaction.Redactable;
 import io.digitalstate.stix.validation.GenericValidation;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeImmutable = "Statement", validationMethod = Value.Style.ValidationMethod.NONE)
 @JsonSerialize(as = Statement.class) @JsonDeserialize(builder = Statement.Builder.class)
 @Redactable

src/main/java/io/digitalstate/stix/datamarkings/StixMarkingObject.java

@@ -1,4 +1,6 @@
 package io.digitalstate.stix.datamarkings;
 
-public interface StixMarkingObject {
+import java.io.Serializable;
+
+public interface StixMarkingObject extends Serializable {
 }

src/main/java/io/digitalstate/stix/datamarkings/TlpMarkingObject.java

@@ -7,11 +7,12 @@
 import io.digitalstate.stix.validation.GenericValidation;
 import io.digitalstate.stix.validation.contraints.vocab.Vocab;
 import io.digitalstate.stix.vocabularies.TlpLevels;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotNull;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeImmutable = "Tlp", validationMethod = Value.Style.ValidationMethod.NONE)
 @JsonSerialize(as = Tlp.class) @JsonDeserialize(builder = Tlp.Builder.class)
 @Redactable

src/main/java/io/digitalstate/stix/sdo/DomainObject.java

@@ -5,12 +5,13 @@
 import io.digitalstate.stix.sro.objects.RelationshipSro;
 
 import javax.validation.constraints.NotNull;
+import java.io.Serializable;
 import java.util.Set;
 
 /**
  * Base interface used by Immutable STIX Domain Objects
  */
-public interface DomainObject extends
+public interface DomainObject extends Serializable,
         StixCommonProperties,
         StixCustomProperties,
         StixLabels,

src/main/java/io/digitalstate/stix/sdo/objects/CampaignSdo.java

@@ -9,6 +9,7 @@
 import io.digitalstate.stix.sdo.DomainObject;
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -19,7 +20,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("campaign")
 @DefaultTypeValue(value = "campaign", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/CourseOfActionSdo.java

@@ -10,6 +10,7 @@
 import io.digitalstate.stix.sdo.DomainObject;
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -19,7 +20,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("course-of-action")
 @DefaultTypeValue(value = "course-of-action", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/IdentitySdo.java

@@ -13,6 +13,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.IdentityClasses;
 import io.digitalstate.stix.vocabularies.IndustrySectors;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -22,7 +23,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("identity")
 @DefaultTypeValue(value = "identity", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/IndicatorSdo.java

@@ -13,6 +13,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.IndicatorLabels;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -24,7 +25,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("indicator")
 @DefaultTypeValue(value = "indicator", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/IntrusionSetSdo.java

@@ -12,6 +12,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.AttackMotivations;
 import io.digitalstate.stix.vocabularies.AttackResourceLevels;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -22,7 +23,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("intrusion-set")
 @DefaultTypeValue(value = "intrusion-set", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/MalwareSdo.java

@@ -14,6 +14,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.MalwareLabels;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -24,7 +25,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @DefaultTypeValue(value = "malware", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})
 @JsonTypeName("malware")

src/main/java/io/digitalstate/stix/sdo/objects/ObservedDataSdo.java

@@ -9,6 +9,7 @@
 import io.digitalstate.stix.sdo.DomainObject;
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotNull;
@@ -17,7 +18,7 @@
 import java.time.Instant;
 import java.util.Set;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("observed-data")
 @DefaultTypeValue(value = "observed-data", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/ReportSdo.java

@@ -14,6 +14,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.ReportLabels;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -25,7 +26,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("report")
 @DefaultTypeValue(value = "report", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/ThreatActorSdo.java

@@ -12,6 +12,7 @@
 import io.digitalstate.stix.validation.contraints.vocab.Vocab;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.*;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -22,7 +23,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})
 @JsonTypeName("threat-actor")
 @DefaultTypeValue(value = "threat-actor", groups = {DefaultValuesProcessor.class})

src/main/java/io/digitalstate/stix/sdo/objects/ToolSdo.java

@@ -14,6 +14,7 @@
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.ToolLabels;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -23,7 +24,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @JsonTypeName("tool")
 @DefaultTypeValue(value = "tool", groups = {DefaultValuesProcessor.class})
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})

src/main/java/io/digitalstate/stix/sdo/objects/VulnerabilitySdo.java

@@ -10,14 +10,15 @@
 import io.digitalstate.stix.sdo.DomainObject;
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
 import java.util.Optional;
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Sdo", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})
 @JsonTypeName("vulnerability")
 @DefaultTypeValue(value = "vulnerability", groups = {DefaultValuesProcessor.class})

src/main/java/io/digitalstate/stix/sdo/types/ExternalReferenceType.java

@@ -8,19 +8,21 @@
 import io.digitalstate.stix.validation.contraints.hashingvocab.HashingVocab;
 import io.digitalstate.stix.vocabularies.HashingAlgorithms;
 import org.hibernate.validator.constraints.Length;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
+import java.io.Serializable;
 import java.util.Map;
 import java.util.Optional;
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Type", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE)
 @JsonSerialize(as = ExternalReference.class) @JsonDeserialize(builder = ExternalReference.Builder.class)
-public interface ExternalReferenceType extends GenericValidation {
+public interface ExternalReferenceType extends GenericValidation, Serializable {
 
     @NotBlank
     @JsonProperty("source_name")

src/main/java/io/digitalstate/stix/sdo/types/KillChainPhaseType.java

@@ -4,14 +4,16 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import io.digitalstate.stix.validation.GenericValidation;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
+import java.io.Serializable;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Type", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE)
 @JsonSerialize(as = KillChainPhase.class) @JsonDeserialize(builder = KillChainPhase.Builder.class)
-public interface KillChainPhaseType extends GenericValidation {
+public interface KillChainPhaseType extends GenericValidation, Serializable {
 
     @NotBlank
     @JsonProperty("kill_chain_name")

src/main/java/io/digitalstate/stix/sro/RelationshipObject.java

@@ -2,7 +2,9 @@
 
 import io.digitalstate.stix.common.*;
 
-public interface RelationshipObject extends
+import java.io.Serializable;
+
+public interface RelationshipObject extends Serializable,
         StixCommonProperties,
         StixCustomProperties,
         StixLabels,

src/main/java/io/digitalstate/stix/sro/objects/RelationshipSro.java

@@ -14,6 +14,7 @@
 import io.digitalstate.stix.validation.contraints.vocab.Vocab;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
 import io.digitalstate.stix.vocabularies.RelationshipTypes;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotBlank;
@@ -22,7 +23,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Sro", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})
 @DefaultTypeValue(value = "relationship", groups = {DefaultValuesProcessor.class})
 @JsonTypeName("relationship")

src/main/java/io/digitalstate/stix/sro/objects/SightingSro.java

@@ -13,6 +13,7 @@
 import io.digitalstate.stix.sro.RelationshipObject;
 import io.digitalstate.stix.validation.contraints.defaulttypevalue.DefaultTypeValue;
 import io.digitalstate.stix.validation.groups.DefaultValuesProcessor;
+import org.immutables.serial.Serial;
 import org.immutables.value.Value;
 
 import javax.validation.constraints.NotNull;
@@ -22,7 +23,7 @@
 
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
 
-@Value.Immutable
+@Value.Immutable @Serial.Version(1L)
 @Value.Style(typeAbstract="*Sro", typeImmutable="*", validationMethod = Value.Style.ValidationMethod.NONE, additionalJsonAnnotations = {JsonTypeName.class})
 @DefaultTypeValue(value = "sighting", groups = {DefaultValuesProcessor.class})
 @JsonSerialize(as = Sighting.class) @JsonDeserialize(builder = Sighting.Builder.class)