Package play.libs.openid

Interface OpenIdClient

All Known Implementing Classes:
DefaultOpenIdClient
public interface OpenIdClient
A client for performing OpenID authentication.

  • Method Details

    • redirectURL

      CompletionStage<String> redirectURL(String openID, String callbackURL)
      Retrieve the URL where the user should be redirected to start the OpenID authentication process.
      Parameters:
      openID - the open ID
      callbackURL - the callback url.
      Returns:
      A completion stage of the URL as a string.

    • redirectURL

      CompletionStage<String> redirectURL(String openID, String callbackURL, Map<String,String> axRequired)
      Retrieve the URL where the user should be redirected to start the OpenID authentication process
      Parameters:
      openID - the open ID
      callbackURL - the callback url.
      axRequired - the required ax
      Returns:
      A completion stage of the URL as a string.

    • redirectURL

      CompletionStage<String> redirectURL(String openID, String callbackURL, Map<String,String> axRequired, Map<String,String> axOptional)
      Retrieve the URL where the user should be redirected to start the OpenID authentication process.
      Parameters:
      openID - the open ID
      callbackURL - the callback url.
      axRequired - the required ax
      axOptional - the optional ax
      Returns:
      A completion stage of the URL as a string.

    • redirectURL

      CompletionStage<String> redirectURL(String openID, String callbackURL, Map<String,String> axRequired, Map<String,String> axOptional, String realm)
      Retrieve the URL where the user should be redirected to start the OpenID authentication process.
      Parameters:
      openID - the open ID
      callbackURL - the callback url.
      axRequired - the required ax
      axOptional - the optional ax
      realm - the HTTP realm
      Returns:
      A completion stage of the URL as a string.

    • verifiedId

      CompletionStage<UserInfo> verifiedId(Http.RequestHeader request)
      Check the identity of the user from the current request, that should be the callback from the OpenID server
      Parameters:
      request - the request header
      Returns:
      A completion stage of the user's identity.