Package org.forgerock.am.authn.backchannel

Record Class BackChannelTransactionInitializeRequestData

java.lang.Object
java.lang.Record
org.forgerock.am.authn.backchannel.BackChannelTransactionInitializeRequestData
Record Components:
type - The type of authentication that is required. Currently only "service" is supported.
value - The value of the authentication that is required, usually the name of a tree.
subject - The subject of the transaction. May be null if no subject has been set.
data - Optional data to add to the initial tree state.
trackingId - The tracking ID for the transaction. This is used to correlate the transaction with the audit event.
timeoutSeconds - The timeout in seconds for the transaction. If null, the default timeout will be used.
allowRetry - Whether to allow the user to retry the transaction if it fails.
public record BackChannelTransactionInitializeRequestData(String type, String value, BackChannelTransactionInitializeRequestData.Subject subject, Map<String,Object> data, String trackingId, Long timeoutSeconds, boolean allowRetry) extends Record
This class is a record that represents the request data for a back channel transaction initialization.

  • Constructor Details

    • BackChannelTransactionInitializeRequestData

      public BackChannelTransactionInitializeRequestData(String type, String value, BackChannelTransactionInitializeRequestData.Subject subject, Map<String,Object> data, String trackingId, Long timeoutSeconds, boolean allowRetry)
      Creates an instance of a BackChannelTransactionInitializeRequestData record class.
      Parameters:
      type - the value for the type record component
      value - the value for the value record component
      subject - the value for the subject record component
      data - the value for the data record component
      trackingId - the value for the trackingId record component
      timeoutSeconds - the value for the timeoutSeconds record component
      allowRetry - the value for the allowRetry record component

  • Method Details

    • 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 '=='.
      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.

    • type

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

    • value

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

    • subject

      public BackChannelTransactionInitializeRequestData.Subject subject()
      Returns the value of the subject record component.
      Returns:
      the value of the subject record component

    • data

      public Map<String,Object> data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • trackingId

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

    • timeoutSeconds

      public Long timeoutSeconds()
      Returns the value of the timeoutSeconds record component.
      Returns:
      the value of the timeoutSeconds record component

    • allowRetry

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