Package security.whisper.javastix.coo.objects

Class Software

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

The Software Object represents high-level properties associated with software, including software products.

See Also:

  • Method Details

    • getName

      @JsonPropertyDescription("Specifies the name of the software.") public String getName()
      Specified by:
      getName in interface SoftwareCoo
      Returns:
      The value of the name attribute

    • getCpe

      @JsonPropertyDescription("Specifies the Common Platform Enumeration (CPE) entry for the software, if available.") public Optional<String> getCpe()
      TODO The value for this property MUST be a CPE v2.3 entry from the official NVD CPE Dictionary. regex pattern = "^cpe:2\\.3:[aho](?::(?:[a-zA-Z0-9!\"#$%invalid input: '&''()*+,\\\\-_.\/();invalid input: '<'=>?@\\[\\]^`{|}~]|\\:)+){10}$" Is not valid for the @Pattern annotation (invalid escape chars) Remove @Pattern(regexp="^cpe:2\\.3:[aho]") until working solution is provided
      Specified by:
      getCpe in interface SoftwareCoo

    • getVendor

      @JsonPropertyDescription("Specifies the name of the vendor of the software.") public Optional<String> getVendor()
      Specified by:
      getVendor in interface SoftwareCoo
      Returns:
      The value of the vendor attribute

    • getVersion

      @JsonPropertyDescription("Specifies the version of the software.") public Optional<String> getVersion()
      Specified by:
      getVersion in interface SoftwareCoo
      Returns:
      The value of the version attribute

    • getId

      public String getId()
      Deterministically generates the ID for this software based on its name.
      Specified by:
      getId in interface BundleableObject
      Specified by:
      getId in interface CyberObservableObjectCommonProperties
      Specified by:
      getId in interface SoftwareCoo

    • 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

    • withName

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

    • withCpe

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

    • withCpe

      public final Software withCpe(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the cpe 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 cpe
      Returns:
      A modified copy of this object

    • withVendor

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

    • withVendor

      public final Software withVendor(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the vendor 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 vendor
      Returns:
      A modified copy of this object

    • withVersion

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

    • withVersion

      public final Software withVersion(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the version 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 version
      Returns:
      A modified copy of this object

    • withType

      public final Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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 Software 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: name, cpe, vendor, version, 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 Software with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static Software copyOf(SoftwareCoo instance)
      Creates an immutable copy of a SoftwareCoo 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 Software instance

    • builder

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