Record Class BootstrapConfiguration

java.lang.Object
java.lang.Record
com.svenruppert.jsentinel.bootstrap.BootstrapConfiguration
Record Components:
mode - mode of operation
tokenFilePath - token file path (required for BootstrapMode.PERSISTENT_FILE)
tokenValidity - how long a generated token stays valid before it is regenerated on startup and rejected by the service
public record BootstrapConfiguration(BootstrapMode mode, Path tokenFilePath, Duration tokenValidity) extends Record
Bootstrap configuration record.

  • Field Details

    • DEFAULT_VALIDITY

      public static final Duration DEFAULT_VALIDITY
      Default token lifetime — 24 hours.

  • Constructor Details

    • BootstrapConfiguration

      public BootstrapConfiguration(BootstrapMode mode, Path tokenFilePath, Duration tokenValidity)
      Creates an instance of a BootstrapConfiguration record class.
      Parameters:
      mode - the value for the mode record component
      tokenFilePath - the value for the tokenFilePath record component
      tokenValidity - the value for the tokenValidity record component

  • Method Details

    • disabled

      public static BootstrapConfiguration disabled()

    • persistent

      public static BootstrapConfiguration persistent(Path tokenFilePath)

    • persistent

      public static BootstrapConfiguration persistent(Path tokenFilePath, Duration tokenValidity)

    • transientConsole

      public static BootstrapConfiguration transientConsole()

    • transientConsole

      public static BootstrapConfiguration transientConsole(Duration tokenValidity)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • mode

      public BootstrapMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • tokenFilePath

      public Path tokenFilePath()
      Returns the value of the tokenFilePath record component.
      Returns:
      the value of the tokenFilePath record component

    • tokenValidity

      public Duration tokenValidity()
      Returns the value of the tokenValidity record component.
      Returns:
      the value of the tokenValidity record component