Package com.pingidentity.sdk.api.authn.model.state

Class AuthenticationFailed

java.lang.Object
com.pingidentity.sdk.api.authn.model.state.AuthenticationFailed
All Implemented Interfaces:
Serializable
public class AuthenticationFailed extends Object implements Serializable
The model for the FAILED state.
Since:
9.3
See Also:

  • Constructor Details

    • AuthenticationFailed

      public AuthenticationFailed()

  • Method Details

    • getCode

      public String getCode()
      Get the error code.

    • setCode

      public void setCode(String code)
      Set the error code.

    • getMessage

      public String getMessage()
      Get the developer-facing error message.

    • setMessage

      public void setMessage(String message)
      Set the developer-facing error message.

    • getUserMessage

      public String getUserMessage()
      Get the user-facing error message. If possible, this error message should be user-friendly and localized. A localizable message key can be provided with setUserMessageKey() or the localized error message can be directly set with setUserMessage().

    • setUserMessageKey

      public void setUserMessageKey(String userMessageKey)
      Set the user-facing error message key. In the JSON serialization this key will automatically be converted to a localized string if a corresponding message is defined in the authn-api-messages or the pingfederate-messages properties file for the user's locale.

    • getUserMessageKey

      public String getUserMessageKey()
      Get the user-facing error message key.

    • setUserMessage

      public void setUserMessage(String userMessage)
      Directly set the user-facing error message. Where possible, the message should be user-friendly and localized.

    • getAdapterId

      public String getAdapterId()
      Get the adapter ID associated with the error, if defined.

    • setAdapterId

      public void setAdapterId(String adapterId)
      Set the adapter ID associated with the error.

    • getTrackingId

      public String getTrackingId()
      Get the tracking ID associated with the error.

    • setTrackingId

      public void setTrackingId(String trackingId)
      Set the tracking ID associated with the error.