Package org.forgerock.openam.auth.node.api

Interface TreeFailureResponse

@Supported public interface TreeFailureResponse
A response object that contains details of the tree failure.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFailureDetail(String key, Object value)
    Adds a new entry to the failure details.
    String
    getDefaultMessage()
    Returns the framework provided default failure message.
    int
    getStatusCode()
    Returns the HTTP response code that will be sent back to the client.
    void
    setCustomFailureMessage(String failureMessage)
    Sets the failure message that will be displayed to the user to a custom value.

  • Method Details

    • addFailureDetail

      @Supported void addFailureDetail(String key, Object value)
      Adds a new entry to the failure details.
      Parameters:
      key - The key to add.
      value - The value to add.

    • setCustomFailureMessage

      @Supported void setCustomFailureMessage(String failureMessage)
      Sets the failure message that will be displayed to the user to a custom value.
      Parameters:
      failureMessage - The failure message to set.

    • getStatusCode

      @Supported int getStatusCode()
      Returns the HTTP response code that will be sent back to the client.
      Returns:
      The HTTP response code.

    • getDefaultMessage

      @Supported String getDefaultMessage()
      Returns the framework provided default failure message.
      Returns:
      The default message.