Package org.forgerock.am.authn.backchannel

Interface BackChannelTransactionService

public interface BackChannelTransactionService

A service for managing back channel transactions.

Method Summary

Modifier and Type	Method	Description
BackChannelTransactionInformationResponseData	checkStatus(String transactionId)	Checks the status of a back-channel transaction.
BackChannelTransactionInitializeResponseData	initialize(BackChannelTransactionInitializeRequestData request, Realm realm, URI baseUri)	Initializes a back-channel transaction.
void	updateTransactionData(String transactionId, Map<String,Object> updateData)	Updates the additional data associated with a transaction, this is not the same as the initial tree state data - which cannot be modified after creation.

Method Details

initialize

BackChannelTransactionInitializeResponseData initialize(BackChannelTransactionInitializeRequestData request,
 Realm realm,
 URI baseUri)
                                                 throws BackChannelAuthException

Initializes a back-channel transaction.

Parameters:

request - The request data for the transaction.

realm - The realm in which the transaction is being initialized.

baseUri - The base URI for the transaction redirect.

Returns:

The response data for the transaction initialization.

Throws:

BackChannelAuthException - If the transaction cannot be initialized.

checkStatus

BackChannelTransactionInformationResponseData checkStatus(String transactionId)
                                                   throws BackChannelAuthException

Checks the status of a back-channel transaction.

Parameters:

transactionId - The ID of the transaction to check.

Returns:

The response data for the transaction status.

Throws:

BackChannelAuthException - If the transaction cannot be found or if there is an error.

updateTransactionData

void updateTransactionData(String transactionId,
 Map<String,Object> updateData)
                    throws BackChannelAuthException

Updates the additional data associated with a transaction, this is not the same as the initial tree state data - which cannot be modified after creation.

Parameters:

transactionId - The ID of the transaction.

updateData - The data to add/update.

Throws:

BackChannelAuthException - If the transaction cannot be updated.