Package play.libs.openid

Class DefaultOpenIdClient

java.lang.Object

play.libs.openid.DefaultOpenIdClient

All Implemented Interfaces:

OpenIdClient

public class DefaultOpenIdClient
extends Object
implements OpenIdClient

Constructor Summary

Constructors

Constructor	Description
DefaultOpenIdClient(play.api.libs.openid.OpenIdClient client, scala.concurrent.ExecutionContext executionContext)

Method Summary

Modifier and Type	Method	Description
CompletionStage<String>	redirectURL(String openID, String callbackURL)	Retrieve the URL where the user should be redirected to start the OpenID authentication process.
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
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.
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.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultOpenIdClient

@Inject
public DefaultOpenIdClient(play.api.libs.openid.OpenIdClient client,
 scala.concurrent.ExecutionContext executionContext)

Method Details

redirectURL

public CompletionStage<String> redirectURL(String openID,
 String callbackURL)

Description copied from interface: OpenIdClient

Retrieve the URL where the user should be redirected to start the OpenID authentication process.

Specified by:

redirectURL in interface OpenIdClient

Parameters:

openID - the open ID

callbackURL - the callback url.

Returns:

A completion stage of the URL as a string.

redirectURL

public CompletionStage<String> redirectURL(String openID,
 String callbackURL,
 Map<String,String> axRequired)

Description copied from interface: OpenIdClient

Retrieve the URL where the user should be redirected to start the OpenID authentication process

Specified by:

redirectURL in interface OpenIdClient

Parameters:

openID - the open ID

callbackURL - the callback url.

axRequired - the required ax

Returns:

A completion stage of the URL as a string.

redirectURL

public CompletionStage<String> redirectURL(String openID,
 String callbackURL,
 Map<String,String> axRequired,
 Map<String,String> axOptional)

Description copied from interface: OpenIdClient

Retrieve the URL where the user should be redirected to start the OpenID authentication process.

Specified by:

redirectURL in interface OpenIdClient

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

public CompletionStage<String> redirectURL(String openID,
 String callbackURL,
 Map<String,String> axRequired,
 Map<String,String> axOptional,
 String realm)

Description copied from interface: OpenIdClient

Retrieve the URL where the user should be redirected to start the OpenID authentication process.

Specified by:

redirectURL in interface OpenIdClient

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

public CompletionStage<UserInfo> verifiedId(Http.RequestHeader request)

Description copied from interface: OpenIdClient

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

Specified by:

verifiedId in interface OpenIdClient

Parameters:

request - the request header

Returns:

A completion stage of the user's identity.