Package security.whisper.javastix.coo.objects

Class Artifact

java.lang.Object
security.whisper.javastix.coo.objects.Artifact
All Implemented Interfaces:
Serializable, BundleableObject, Stix, StixCustomProperties, CyberObservableObject, CyberObservableObjectCommonProperties, ArtifactCoo, GenericValidation, SdoDefaultValidator
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class Artifact extends Object implements ArtifactCoo
Immutable implementation of ArtifactCoo.

Use the builder to create immutable instances: Artifact.builder().

See Also:

  • Method Details

    • getMimeType

      @JsonPropertyDescription("The value of this property MUST be a valid MIME type as specified in the IANA Media Types registry.") public Optional<String> getMimeType()
      Specified by:
      getMimeType in interface ArtifactCoo
      Returns:
      The value of the mimeType attribute

    • getPayloadBin

      @JsonPropertyDescription("Specifies the binary data contained in the artifact as a base64-encoded string.") public Optional<String> getPayloadBin()
      Specified by:
      getPayloadBin in interface ArtifactCoo
      Returns:
      The value of the payloadBin attribute

    • getUrl

      @JsonPropertyDescription("The value of this property MUST be a valid URL that resolves to the unencoded content.") public Optional<String> getUrl()
      Specified by:
      getUrl in interface ArtifactCoo
      Returns:
      The value of the url attribute

    • getHashes

      @JsonPropertyDescription("Specifies a dictionary of hashes for the contents of the url or the payload_bin.") public com.google.common.collect.ImmutableMap<String,String> getHashes()
      hashes

      This MUST be provided when the url property is present. Optional if payload_bin is present.

      Specified by:
      getHashes in interface ArtifactCoo

    • getId

      public String getId()
      Deterministically generates the ID for this artifact based on its payload_bin, url, or hashes.
      Specified by:
      getId in interface ArtifactCoo
      Specified by:
      getId in interface BundleableObject
      Specified by:
      getId in interface CyberObservableObjectCommonProperties

    • getType

      public String getType()
      Specified by:
      getType in interface BundleableObject
      Specified by:
      getType in interface CyberObservableObjectCommonProperties
      Returns:
      The value of the type attribute

    • getExtensions

      @JsonPropertyDescription("Specifies any extensions of the object, as a dictionary.") public com.google.common.collect.ImmutableSet<CyberObservableExtension> getExtensions()
      Multiple extensions can be added, but only 1 instance of a specific extension can be added.
      Specified by:
      getExtensions in interface CyberObservableObjectCommonProperties

    • getObservableObjectKey

      public String getObservableObjectKey()
      Used for generation of Map Keys by
      invalid reference 
      ObservedDataSdo#getObjects()
      Manually set this value if you want to control key names. Otherwise UUIDs will be used.
      Specified by:
      getObservableObjectKey in interface CyberObservableObjectCommonProperties

    • getDefanged

      @JsonPropertyDescription("Indicates whether the data contained in the SCO has been defanged.") public Optional<Boolean> getDefanged()
      Indicates whether the data contained in the SCO has been defanged. Defanging refers to the process of modifying data to make it safe to handle (e.g., changing an IP address from 192.168.1.1 to 192[.]168[.]1[.]1).
      Specified by:
      getDefanged in interface CyberObservableObjectCommonProperties

    • getCustomProperties

      public com.google.common.collect.ImmutableMap<String,Object> getCustomProperties()
      Custom Properties for STIX Objects. Any object that supports custom properties will have a validation of the custom property prefix (typically "x_"). If the additional property in the JSON does not meet the StartsWith condition, then the JSON will be rejected.
      Specified by:
      getCustomProperties in interface StixCustomProperties
      Returns:
      Map of custom properties Map<String, Object>

    • getObjectMarkingRefs

      public com.google.common.collect.ImmutableSet<MarkingDefinitionDm> getObjectMarkingRefs()
      Specified by:
      getObjectMarkingRefs in interface BundleableObject
      Returns:
      The value of the objectMarkingRefs attribute

    • getGranularMarkings

      public com.google.common.collect.ImmutableSet<GranularMarkingDm> getGranularMarkings()
      Specified by:
      getGranularMarkings in interface BundleableObject
      Returns:
      The value of the granularMarkings attribute

    • getHydrated

      public boolean getHydrated()
      Specified by:
      getHydrated in interface BundleableObject
      Returns:
      The value of the hydrated attribute

    • toJsonString

      public String toJsonString()
      Specified by:
      toJsonString in interface BundleableObject
      Returns:
      The value of the toJsonString attribute

    • withMimeType

      public final Artifact withMimeType(String value)
      Copy the current immutable object by setting a present value for the optional mimeType attribute.
      Parameters:
      value - The value for mimeType
      Returns:
      A modified copy of this object

    • withMimeType

      public final Artifact withMimeType(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the mimeType attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for mimeType
      Returns:
      A modified copy of this object

    • withPayloadBin

      public final Artifact withPayloadBin(String value)
      Copy the current immutable object by setting a present value for the optional payloadBin attribute.
      Parameters:
      value - The value for payloadBin
      Returns:
      A modified copy of this object

    • withPayloadBin

      public final Artifact withPayloadBin(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the payloadBin attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for payloadBin
      Returns:
      A modified copy of this object

    • withUrl

      public final Artifact withUrl(String value)
      Copy the current immutable object by setting a present value for the optional url attribute.
      Parameters:
      value - The value for url
      Returns:
      A modified copy of this object

    • withUrl

      public final Artifact withUrl(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the url attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for url
      Returns:
      A modified copy of this object

    • withHashes

      public final Artifact withHashes(Map<String,? extends String> entries)
      Copy the current immutable object by replacing the hashes map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      entries - The entries to be added to the hashes map
      Returns:
      A modified copy of this object

    • withType

      public final Artifact withType(String value)
      Copy the current immutable object by setting a value for the type attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for type (can be null)
      Returns:
      A modified copy of the this object

    • withExtensions

      public final Artifact withExtensions(CyberObservableExtension... elements)
      Copy the current immutable object with elements that replace the content of extensions.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withExtensions

      public final Artifact withExtensions(Iterable<? extends CyberObservableExtension> elements)
      Copy the current immutable object with elements that replace the content of extensions. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of extensions elements to set
      Returns:
      A modified copy of this object

    • withObservableObjectKey

      public final Artifact withObservableObjectKey(String value)
      Copy the current immutable object by setting a value for the observableObjectKey attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for observableObjectKey
      Returns:
      A modified copy of the this object

    • withDefanged

      public final Artifact withDefanged(boolean value)
      Copy the current immutable object by setting a present value for the optional defanged attribute.
      Parameters:
      value - The value for defanged
      Returns:
      A modified copy of this object

    • withDefanged

      public final Artifact withDefanged(Optional<Boolean> optional)
      Copy the current immutable object by setting an optional value for the defanged attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for defanged
      Returns:
      A modified copy of this object

    • withCustomProperties

      public final Artifact withCustomProperties(Map<String,? extends Object> entries)
      Copy the current immutable object by replacing the customProperties map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      entries - The entries to be added to the customProperties map
      Returns:
      A modified copy of this object

    • withObjectMarkingRefs

      public final Artifact withObjectMarkingRefs(MarkingDefinitionDm... elements)
      Copy the current immutable object with elements that replace the content of objectMarkingRefs.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withObjectMarkingRefs

      public final Artifact withObjectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Copy the current immutable object with elements that replace the content of objectMarkingRefs. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of objectMarkingRefs elements to set
      Returns:
      A modified copy of this object

    • withGranularMarkings

      public final Artifact withGranularMarkings(GranularMarkingDm... elements)
      Copy the current immutable object with elements that replace the content of granularMarkings.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withGranularMarkings

      public final Artifact withGranularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Copy the current immutable object with elements that replace the content of granularMarkings. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of granularMarkings elements to set
      Returns:
      A modified copy of this object

    • withHydrated

      public final Artifact withHydrated(boolean value)
      Copy the current immutable object by setting a value for the hydrated attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for hydrated
      Returns:
      A modified copy of the this object

    • withToJsonString

      public final Artifact withToJsonString(String value)
      Copy the current immutable object by setting a value for the toJsonString attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for toJsonString (can be null)
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of Artifact that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: mimeType, payloadBin, url, hashes, id, type, extensions, observableObjectKey, defanged, customProperties, objectMarkingRefs, granularMarkings, hydrated, toJsonString.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value Artifact with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static Artifact copyOf(ArtifactCoo instance)
      Creates an immutable copy of a ArtifactCoo value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable Artifact instance

    • builder

      public static Artifact.Builder builder()
      Creates a builder for Artifact.
      Returns:
      A new Artifact builder