Package security.whisper.javastix.coo.extension.types

Class TcpExtension

java.lang.Object
security.whisper.javastix.coo.extension.types.TcpExtension
All Implemented Interfaces:
Serializable, StixCustomProperties, CyberObservableExtension, CyberObservableExtensionCommonProperties, TcpExtensionExt, GenericValidation, SdoDefaultValidator
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue @AllowedParents(NetworkTrafficCoo.class) public final class TcpExtension extends Object implements TcpExtensionExt, Serializable
tcp-ext

The TCP extension specifies a default extension for capturing network traffic properties specific to TCP.

See Also:

  • Method Details

    • getSrcFlagsHex

      @JsonPropertyDescription("Specifies the source TCP flags, as the union of all TCP flags observed between the start of the traffic (as defined by the start property) and the end of the traffic (as defined by the end property). ") public Optional<String> getSrcFlagsHex()
      Specifies the source TCP flags, as the union of all TCP flags observed between the start of the traffic (as defined by the start property) and the end of the traffic (as defined by the end property).
      Specified by:
      getSrcFlagsHex in interface TcpExtensionExt

    • getDstFlagsHex

      @JsonPropertyDescription("Specifies the destination TCP flags, as the union of all TCP flags observed between the start of the traffic (as defined by the start property) and the end of the traffic (as defined by the end property).") public Optional<String> getDstFlagsHex()
      Specifies the destination TCP flags, as the union of all TCP flags observed between the start of the traffic (as defined by the start property) and the end of the traffic (as defined by the end property).
      Specified by:
      getDstFlagsHex in interface TcpExtensionExt

    • getType

      public String getType()
      This property is used for generation of the dictionary during serialization, and used as the "Type" mapping value for polymorphic when deserializing.
      Specified by:
      getType in interface CyberObservableExtensionCommonProperties

    • 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>

    • withSrcFlagsHex

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

    • withSrcFlagsHex

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

    • withDstFlagsHex

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

    • withDstFlagsHex

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

    • withType

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

    • withCustomProperties

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

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of TcpExtension 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: srcFlagsHex, dstFlagsHex, type, customProperties.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

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