Package com.nimbusds.openid.connect.sdk

Interface AuthenticationResponse

All Superinterfaces:
Message, Response
All Known Implementing Classes:
AuthenticationErrorResponse, AuthenticationSuccessResponse
public interface AuthenticationResponse extends Response
OpenID Connect authentication response.

Related specifications:

  • OpenID Connect Core 1.0

  • Method Details

    • getRedirectionURI

      URI getRedirectionURI()
      Returns the base redirection URI.
      Returns:
      The base redirection URI.

    • getState

      State getState()
      Returns the optional state.
      Returns:
      The state, null if not requested or if the response is JWT-secured in which case the state parameter may be included as a JWT claim.

    • getIssuer

      Issuer getIssuer()
      Returns the optional issuer.
      Returns:
      The issuer, null if not specified.

    • getJWTResponse

      com.nimbusds.jwt.JWT getJWTResponse()
      Returns the JSON Web Token (JWT) secured response.
      Returns:
      The JWT-secured response, null for a regular authorisation response.

    • getResponseMode

      ResponseMode getResponseMode()
      Returns the optional explicit response mode.
      Returns:
      The response mode, null if not specified.

    • impliedResponseMode

      ResponseMode impliedResponseMode()
      Determines the implied response mode.
      Returns:
      The implied response mode.

    • toSuccessResponse

      AuthenticationSuccessResponse toSuccessResponse()
      Casts this response to an authentication success response.
      Returns:
      The authentication success response.

    • toErrorResponse

      AuthenticationErrorResponse toErrorResponse()
      Casts this response to an authentication error response.
      Returns:
      The authentication error response.