Package security.whisper.javastix.sro.objects

Class Sighting

java.lang.Object
security.whisper.javastix.sro.objects.Sighting
All Implemented Interfaces:
Serializable, BundleableObject, Stix, StixCommonProperties, StixCustomProperties, StixLabels, StixModified, StixRevoked, StixSpecVersion, SightingSro, RelationshipObject, SdoDefaultValidator
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public final class Sighting extends Object implements SightingSro
sighting

A Sighting denotes the belief that something in CTI (e.g., an indicator, malware, tool, threat actor, etc.) was seen.

See Also:

  • Method Details

    • getFirstSeen

      @JsonPropertyDescription("The beginning of the time window during which the SDO referenced by the sighting_of_ref property was sighted.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public Optional<StixInstant> getFirstSeen()
      Specified by:
      getFirstSeen in interface SightingSro
      Returns:
      The value of the firstSeen attribute

    • getLastSeen

      @JsonPropertyDescription("The end of the time window during which the SDO referenced by the sighting_of_ref property was sighted.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public Optional<StixInstant> getLastSeen()
      Specified by:
      getLastSeen in interface SightingSro
      Returns:
      The value of the lastSeen attribute

    • getCount

      @JsonPropertyDescription("This is an integer between 0 and 999,999,999 inclusive and represents the number of times the object was sighted.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public Optional<Integer> getCount()
      Specified by:
      getCount in interface SightingSro
      Returns:
      The value of the count attribute

    • getSightingOfRef

      @JsonPropertyDescription("An ID reference to the object that has been sighted.") @Redactable(useMask=true, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public DomainObject getSightingOfRef()
      Specified by:
      getSightingOfRef in interface SightingSro
      Returns:
      The value of the sightingOfRef attribute

    • getObservedDataRefs

      @JsonPropertyDescription("A list of ID references to the Observed Data objects that contain the raw cyber data for this Sighting.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<ObservedDataSdo> getObservedDataRefs()
      Specified by:
      getObservedDataRefs in interface SightingSro
      Returns:
      The value of the observedDataRefs attribute

    • getWhereSightedRefs

      @JsonPropertyDescription("The ID of the Victim Target objects of the entities that saw the sighting.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<IdentitySdo> getWhereSightedRefs()
      Specified by:
      getWhereSightedRefs in interface SightingSro
      Returns:
      The value of the whereSightedRefs attribute

    • isSummary

      @JsonPropertyDescription("The summary property indicates whether the Sighting should be considered summary data.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public StixBoolean isSummary()
      Specified by:
      isSummary in interface SightingSro
      Returns:
      The value of the isSummary attribute

    • getHydrated

      @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public boolean getHydrated()
      Dictates if the object is hydrated. Hydration is defined as if the Object has only a "ID" or has been properly hydrated with the expected required fields
      Specified by:
      getHydrated in interface BundleableObject
      Specified by:
      getHydrated in interface StixCommonProperties
      Returns:
      boolean

    • getType

      @JsonPropertyDescription("The type property identifies the type of STIX Object (SDO, Relationship Object, etc). The value of the type field MUST be one of the types defined by a STIX Object (e.g., indicator).") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public String getType()
      Specified by:
      getType in interface BundleableObject
      Specified by:
      getType in interface StixCommonProperties
      Returns:
      The value of the type attribute

    • getId

      @JsonPropertyDescription("Represents identifiers across the CTI specifications. The format consists of the name of the top-level object being identified, followed by two dashes (--), followed by a UUIDv4.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public String getId()
      Specified by:
      getId in interface BundleableObject
      Specified by:
      getId in interface StixCommonProperties
      Returns:
      The value of the id attribute

    • getCreatedByRef

      @JsonPropertyDescription("Represents identifiers across the CTI specifications. The format consists of the name of the top-level object being identified, followed by two dashes (--), followed by a UUIDv4.") @Redactable(useMask=true, redactionMask="identity--__REDACTED__") public Optional<IdentitySdo> getCreatedByRef()
      Specified by:
      getCreatedByRef in interface StixCommonProperties
      Returns:
      The value of the createdByRef attribute

    • getCreated

      @JsonPropertyDescription("The created property represents the time at which the first version of this object was created. The timstamp value MUST be precise to the nearest millisecond.") @Redactable(useMask=true, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public StixInstant getCreated()
      Specified by:
      getCreated in interface StixCommonProperties
      Returns:
      The value of the created attribute

    • getLang

      @JsonPropertyDescription("Identifies the language of the text content in this object using ISO 639-2 language codes.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public Optional<String> getLang()
      Specified by:
      getLang in interface StixCommonProperties
      Returns:
      The value of the lang attribute

    • getExternalReferences

      @JsonPropertyDescription("A list of external references which refers to non-STIX information.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<ExternalReferenceType> getExternalReferences()
      Specified by:
      getExternalReferences in interface StixCommonProperties
      Returns:
      The value of the externalReferences attribute

    • getObjectMarkingRefs

      @JsonPropertyDescription("The list of marking-definition objects to be applied to this object.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<MarkingDefinitionDm> getObjectMarkingRefs()
      Specified by:
      getObjectMarkingRefs in interface BundleableObject
      Specified by:
      getObjectMarkingRefs in interface StixCommonProperties
      Returns:
      The value of the objectMarkingRefs attribute

    • getGranularMarkings

      @JsonPropertyDescription("The set of granular markings that apply to this object.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<GranularMarkingDm> getGranularMarkings()
      Specified by:
      getGranularMarkings in interface BundleableObject
      Specified by:
      getGranularMarkings in interface StixCommonProperties
      Returns:
      The value of the granularMarkings attribute

    • getCustomProperties

      @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") 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>

    • getLabels

      @JsonPropertyDescription("The labels property specifies a set of classifications.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public com.google.common.collect.ImmutableSet<String> getLabels()
      Specified by:
      getLabels in interface StixLabels
      Returns:
      The value of the labels attribute

    • getModified

      @JsonPropertyDescription("The modified property represents the time that this particular version of the object was created. The timstamp value MUST be precise to the nearest millisecond.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public StixInstant getModified()
      Specified by:
      getModified in interface StixModified
      Returns:
      The value of the modified attribute

    • getRevoked

      @JsonPropertyDescription("The revoked property indicates whether the object has been revoked.") @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public StixBoolean getRevoked()
      Specified by:
      getRevoked in interface StixRevoked
      Returns:
      The value of the revoked attribute

    • withFirstSeen

      public final Sighting withFirstSeen(StixInstant value)
      Copy the current immutable object by setting a present value for the optional firstSeen attribute.
      Parameters:
      value - The value for firstSeen
      Returns:
      A modified copy of this object

    • withFirstSeen

      public final Sighting withFirstSeen(Optional<? extends StixInstant> optional)
      Copy the current immutable object by setting an optional value for the firstSeen attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for firstSeen
      Returns:
      A modified copy of this object

    • withLastSeen

      public final Sighting withLastSeen(StixInstant value)
      Copy the current immutable object by setting a present value for the optional lastSeen attribute.
      Parameters:
      value - The value for lastSeen
      Returns:
      A modified copy of this object

    • withLastSeen

      public final Sighting withLastSeen(Optional<? extends StixInstant> optional)
      Copy the current immutable object by setting an optional value for the lastSeen attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for lastSeen
      Returns:
      A modified copy of this object

    • withCount

      public final Sighting withCount(int value)
      Copy the current immutable object by setting a present value for the optional count attribute.
      Parameters:
      value - The value for count
      Returns:
      A modified copy of this object

    • withCount

      public final Sighting withCount(Optional<Integer> optional)
      Copy the current immutable object by setting an optional value for the count 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 count
      Returns:
      A modified copy of this object

    • withSightingOfRef

      public final Sighting withSightingOfRef(DomainObject value)
      Copy the current immutable object by setting a value for the sightingOfRef attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for sightingOfRef (can be null)
      Returns:
      A modified copy of the this object

    • withObservedDataRefs

      public final Sighting withObservedDataRefs(ObservedDataSdo... elements)
      Copy the current immutable object with elements that replace the content of observedDataRefs.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withObservedDataRefs

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

    • withWhereSightedRefs

      public final Sighting withWhereSightedRefs(IdentitySdo... elements)
      Copy the current immutable object with elements that replace the content of whereSightedRefs.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withWhereSightedRefs

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

    • withIsSummary

      public final Sighting withIsSummary(StixBoolean value)
      Copy the current immutable object by setting a value for the isSummary attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for isSummary
      Returns:
      A modified copy of the this object

    • withHydrated

      public final Sighting 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

    • withType

      public final Sighting 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

    • withId

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

    • withCreatedByRef

      public final Sighting withCreatedByRef(IdentitySdo value)
      Copy the current immutable object by setting a present value for the optional createdByRef attribute.
      Parameters:
      value - The value for createdByRef
      Returns:
      A modified copy of this object

    • withCreatedByRef

      public final Sighting withCreatedByRef(Optional<? extends IdentitySdo> optional)
      Copy the current immutable object by setting an optional value for the createdByRef attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for createdByRef
      Returns:
      A modified copy of this object

    • withCreated

      public final Sighting withCreated(StixInstant value)
      Copy the current immutable object by setting a value for the created attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for created
      Returns:
      A modified copy of the this object

    • withLang

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

    • withLang

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

    • withExternalReferences

      public final Sighting withExternalReferences(ExternalReferenceType... elements)
      Copy the current immutable object with elements that replace the content of externalReferences.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withExternalReferences

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

    • withObjectMarkingRefs

      public final Sighting 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 Sighting 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 Sighting 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 Sighting 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

    • withCustomProperties

      public final Sighting 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

    • withLabels

      public final Sighting withLabels(String... elements)
      Copy the current immutable object with elements that replace the content of labels.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withLabels

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

    • withModified

      public final Sighting withModified(StixInstant value)
      Copy the current immutable object by setting a value for the modified attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for modified
      Returns:
      A modified copy of the this object

    • withRevoked

      public final Sighting withRevoked(StixBoolean value)
      Copy the current immutable object by setting a value for the revoked attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for revoked
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of Sighting 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: firstSeen, lastSeen, count, sightingOfRef, observedDataRefs, whereSightedRefs, isSummary, hydrated, type, id, createdByRef, created, lang, externalReferences, objectMarkingRefs, granularMarkings, customProperties, labels, modified, revoked.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • toJsonString

      @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public String toJsonString()

      Returns a lazily initialized value of the toJsonString attribute. Initialized once and only once and stored for subsequent access with proper synchronization.

      Specified by:
      toJsonString in interface BundleableObject
      Specified by:
      toJsonString in interface StixCommonProperties
      Returns:
      A lazily initialized value of the toJsonString attribute

    • getSpecVersion

      @Redactable(useMask=false, redactionMask="\u2588\u2588REDACTED\u2588\u2588") public String getSpecVersion()
      Helper attribute to track the STIX Spec Version that was used for this object.

      Returns a lazily initialized value of the specVersion attribute. Initialized once and only once and stored for subsequent access with proper synchronization.

      Specified by:
      getSpecVersion in interface StixSpecVersion
      Returns:
      A lazily initialized value of the specVersion attribute

    • copyOf

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

    • builder

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