play.libs.openid

Interface OpenIdClient

All Known Implementing Classes:

DefaultOpenIdClient

public interface OpenIdClient

A client for performing OpenID authentication.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<java.lang.String>	redirectURL(java.lang.String openID, java.lang.String callbackURL) Retrieve the URL where the user should be redirected to start the OpenID authentication process.
java.util.concurrent.CompletionStage<java.lang.String>	redirectURL(java.lang.String openID, java.lang.String callbackURL, java.util.Map<java.lang.String,java.lang.String> axRequired) Retrieve the URL where the user should be redirected to start the OpenID authentication process
java.util.concurrent.CompletionStage<java.lang.String>	redirectURL(java.lang.String openID, java.lang.String callbackURL, java.util.Map<java.lang.String,java.lang.String> axRequired, java.util.Map<java.lang.String,java.lang.String> axOptional) Retrieve the URL where the user should be redirected to start the OpenID authentication process.
java.util.concurrent.CompletionStage<java.lang.String>	redirectURL(java.lang.String openID, java.lang.String callbackURL, java.util.Map<java.lang.String,java.lang.String> axRequired, java.util.Map<java.lang.String,java.lang.String> axOptional, java.lang.String realm) Retrieve the URL where the user should be redirected to start the OpenID authentication process.
java.util.concurrent.CompletionStage<UserInfo>	verifiedId() Deprecated. Deprecated as of 2.7.0. Use verifiedId(Http.RequestHeader) instead.
java.util.concurrent.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

Method Detail

redirectURL

java.util.concurrent.CompletionStage<java.lang.String> redirectURL(java.lang.String openID,
                                                                   java.lang.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

java.util.concurrent.CompletionStage<java.lang.String> redirectURL(java.lang.String openID,
                                                                   java.lang.String callbackURL,
                                                                   java.util.Map<java.lang.String,java.lang.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

java.util.concurrent.CompletionStage<java.lang.String> redirectURL(java.lang.String openID,
                                                                   java.lang.String callbackURL,
                                                                   java.util.Map<java.lang.String,java.lang.String> axRequired,
                                                                   java.util.Map<java.lang.String,java.lang.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

java.util.concurrent.CompletionStage<java.lang.String> redirectURL(java.lang.String openID,
                                                                   java.lang.String callbackURL,
                                                                   java.util.Map<java.lang.String,java.lang.String> axRequired,
                                                                   java.util.Map<java.lang.String,java.lang.String> axOptional,
                                                                   java.lang.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

java.util.concurrent.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.

verifiedId

@Deprecated
java.util.concurrent.CompletionStage<UserInfo> verifiedId()

Deprecated. Deprecated as of 2.7.0. Use verifiedId(Http.RequestHeader) instead.

Check the identity of the user from the current request, that should be the callback from the OpenID server

Returns:

a completion stage of the user information using the current HTTP request.