Package org.forgerock.am.authn.backchannel

Record Class BackChannelTransactionInformationResponseData

java.lang.Object

java.lang.Record

org.forgerock.am.authn.backchannel.BackChannelTransactionInformationResponseData

Record Components:

state - The state of the transaction, see TransactionState

result - The result of the transaction, see TransactionResult

auditTrackingIds - The audit tracking IDs of the transaction

type - The type of authentication that is required, currently only "service" is supported

value - The value of the authentication that is required, will usually be the name of a tree

subject - The subject of the transaction, may be null if no subject has been set

sessionProperties - The session properties of the transaction, will be null until the transaction has completed successfully

updateData - The data associated with the transaction, will be null until the transaction has had something written to its `additionalData` map

public record BackChannelTransactionInformationResponseData(String state, String result, List<String> auditTrackingIds, String type, String value, BackChannelTransactionInformationResponseData.Subject subject, Map<String,Object> sessionProperties, Map<String,Object> updateData)
extends Record

This class is a public record that represents the response data for back channel transaction information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BackChannelTransactionInformationResponseData.Subject	Represents the subject of the transaction.

Constructor Summary

Constructors

Constructor	Description
BackChannelTransactionInformationResponseData(String state, String result, List<String> auditTrackingIds, String type, String value, BackChannelTransactionInformationResponseData.Subject subject, Map<String,Object> sessionProperties, Map<String,Object> updateData)	Creates an instance of a BackChannelTransactionInformationResponseData record class.

Method Summary

Modifier and Type	Method	Description
List<String>	auditTrackingIds()	Returns the value of the auditTrackingIds record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	result()	Returns the value of the result record component.
Map<String,Object>	sessionProperties()	Returns the value of the sessionProperties record component.
String	state()	Returns the value of the state record component.
BackChannelTransactionInformationResponseData.Subject	subject()	Returns the value of the subject record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
Map<String,Object>	updateData()	Returns the value of the updateData record component.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BackChannelTransactionInformationResponseData

public BackChannelTransactionInformationResponseData(String state,
 String result,
 List<String> auditTrackingIds,
 String type,
 String value,
 BackChannelTransactionInformationResponseData.Subject subject,
 Map<String,Object> sessionProperties,
 Map<String,Object> updateData)

Creates an instance of a BackChannelTransactionInformationResponseData record class.

Parameters:

state - the value for the state record component

result - the value for the result record component

auditTrackingIds - the value for the auditTrackingIds record component

type - the value for the type record component

value - the value for the value record component

subject - the value for the subject record component

sessionProperties - the value for the sessionProperties record component

updateData - the value for the updateData 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. 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.

state

public String state()

Returns the value of the state record component.

Returns:

the value of the state record component

result

public String result()

Returns the value of the result record component.

Returns:

the value of the result record component

auditTrackingIds

public List<String> auditTrackingIds()

Returns the value of the auditTrackingIds record component.

Returns:

the value of the auditTrackingIds record component

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 BackChannelTransactionInformationResponseData.Subject subject()

Returns the value of the subject record component.

Returns:

the value of the subject record component

sessionProperties

public Map<String,Object> sessionProperties()

Returns the value of the sessionProperties record component.

Returns:

the value of the sessionProperties record component

updateData

public Map<String,Object> updateData()

Returns the value of the updateData record component.

Returns:

the value of the updateData record component