Package com.pingidentity.sdk.oobauth

Class OOBAuthTransactionContext

java.lang.Object
com.pingidentity.sdk.oobauth.OOBAuthTransactionContext
public class OOBAuthTransactionContext extends Object
Information about an out-of-band authentication/authorization transaction returned from OOBAuthPlugin.initiate(OOBAuthRequestContext, Map).
Since:
9.3

  • Constructor Details

    • OOBAuthTransactionContext

      public OOBAuthTransactionContext()

  • Method Details

    • getTransactionIdentifier

      public String getTransactionIdentifier()
      Gets the unique identifier of the transaction.
      Returns:
      the unique identifier of the transaction

    • setTransactionIdentifier

      public void setTransactionIdentifier(String transactionIdentifier)
      Sets the unique identifier for the transaction, which will be used to identify the given transaction in calls to OOBAuthPlugin.check(String, Map) and OOBAuthPlugin.finished(String).
      Parameters:
      transactionIdentifier - the unique identifier for the transaction

    • getAuxiliaryParams

      public Map<String,Object> getAuxiliaryParams()
      Gets auxiliary parameters.
      Returns:
      the auxiliary parameters

    • setAuxiliaryParams

      public void setAuxiliaryParams(Map<String,Object> auxiliaryParams)
      Sets auxiliary parameters for this transaction context, which will be returned in the protocol response (if applicable to the outer protocol). Typical implementations will not use this.
      Parameters:
      auxiliaryParams - the auxiliary parameters

    • isStatusChangeCallbackCapable

      public boolean isStatusChangeCallbackCapable()
      Indicates if the given transaction for the given plugin is capable of making a callback to notify the PingFederate server that the status has changed via OOBAuthStatusChangeReceiver.statusChange(String)
      Returns:
      a boolean indicates if the given transaction is capable of making a status change callback

    • setStatusChangeCallbackCapable

      public void setStatusChangeCallbackCapable(boolean statusChangeCallbackCapable)
      Indicates if the given transaction for the given plugin is capable of making a callback to notify the PingFederate server that the status has changed via OOBAuthStatusChangeReceiver.statusChange(String)
      Parameters:
      statusChangeCallbackCapable - is the given transaction is capable of making a status change callback

    • toString

      public String toString()
      Overrides:
      toString in class Object