Record Class OdysseyRequestManager.TokenAcquisitionResult

java.lang.Object
java.lang.Record
io.confluent.kafka.odyssey.OdysseyRequestManager.TokenAcquisitionResult
Record Components:
token - The LAT token if acquisition succeeded, empty otherwise
errorMessage - Human-readable error message if acquisition failed, null on success
isPermanent - True if failure will not resolve without external intervention (not retryable)
isNotConfigured - True when Token Platform is not configured (Confluent Platform mode)
Enclosing interface:
OdysseyRequestManager
public static record OdysseyRequestManager.TokenAcquisitionResult(Optional<String> token, String errorMessage, boolean isPermanent, boolean isNotConfigured) extends Record
Result of token acquisition from Token Platform.

Errors are classified into two categories:

  • Permanent (isPermanent=true): Will not succeed on retry without external intervention (e.g., missing config, permission denied, invalid credentials)
  • Transient (isPermanent=false): May succeed on retry (e.g., network timeout, service temporarily unavailable)

  • Constructor Details

    • TokenAcquisitionResult

      public TokenAcquisitionResult(Optional<String> token, String errorMessage, boolean isPermanent, boolean isNotConfigured)
      Creates an instance of a TokenAcquisitionResult record class.
      Parameters:
      token - the value for the token record component
      errorMessage - the value for the errorMessage record component
      isPermanent - the value for the isPermanent record component
      isNotConfigured - the value for the isNotConfigured record component

  • Method Details

    • success

      public static OdysseyRequestManager.TokenAcquisitionResult success(String token)

    • notConfigured

      public static OdysseyRequestManager.TokenAcquisitionResult notConfigured()

    • permanentError

      public static OdysseyRequestManager.TokenAcquisitionResult permanentError(String message)

    • transientError

      public static OdysseyRequestManager.TokenAcquisitionResult transientError(String message)

    • isSuccess

      public boolean isSuccess()

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • token

      public Optional<String> token()
      Returns the value of the token record component.
      Returns:
      the value of the token record component

    • errorMessage

      public String errorMessage()
      Returns the value of the errorMessage record component.
      Returns:
      the value of the errorMessage record component

    • isPermanent

      public boolean isPermanent()
      Returns the value of the isPermanent record component.
      Returns:
      the value of the isPermanent record component

    • isNotConfigured

      public boolean isNotConfigured()
      Returns the value of the isNotConfigured record component.
      Returns:
      the value of the isNotConfigured record component