Module org.glassfish.jersey.security.oauth2.client

Package org.glassfish.jersey.client.oauth2

Class OAuth2FlowGoogleBuilder

java.lang.Object

org.glassfish.jersey.client.oauth2.OAuth2FlowGoogleBuilder

All Implemented Interfaces:

OAuth2CodeGrantFlow.Builder<OAuth2FlowGoogleBuilder>

public class OAuth2FlowGoogleBuilder
extends Object

Class that provides methods to build OAuth2CodeGrantFlow pre-configured for usage with Google provider.

Since:

2.3

Author:

Miroslav Fuksa

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OAuth2FlowGoogleBuilder.AccessType	Enum that defines values for "access_type" parameter used in Google OAuth flow.
static enum	OAuth2FlowGoogleBuilder.Display	Enum that defines values for "display" parameter used in Google OAuth flow.
static enum	OAuth2FlowGoogleBuilder.Prompt	Enum that defines values for "prompt" parameter used in Google OAuth flow.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOGIN_HINT	Property key that defines values for "login_hint" parameter used in Google OAuth flow.

Method Summary

Modifier and Type	Method	Description
OAuth2FlowGoogleBuilder	accessTokenUri(String accessTokenUri)	Set the access token URI on which the access token can be requested.
OAuth2FlowGoogleBuilder	accessType(OAuth2FlowGoogleBuilder.AccessType accessType)	Set access type parameter used in Authorization Request.
OAuth2FlowGoogleBuilder	authorizationUri(String authorizationUri)	Set the URI to which the user should be redirected to authorize our application.
OAuth2CodeGrantFlow	build()	Build the OAuth2CodeGrantFlow instance.
OAuth2FlowGoogleBuilder	client(Client client)	Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server.
OAuth2FlowGoogleBuilder	clientIdentifier(ClientIdentifier consumerCredentials)	Set client identifier of the application that should be authorized.
OAuth2FlowGoogleBuilder	display(OAuth2FlowGoogleBuilder.Display display)	Set display parameter used in Authorization Request.
OAuth2FlowGoogleBuilder	loginHint(String loginHint)	Set login hint parameter used in Authorization Request.
OAuth2FlowGoogleBuilder	prompt(OAuth2FlowGoogleBuilder.Prompt prompt)	Set prompt parameter used in Authorization Request.
OAuth2FlowGoogleBuilder	property(OAuth2CodeGrantFlow.Phase phase, String key, String value)	Set property (parameter) that will be added to requests or URIs as a query parameters during the Authorization Flow.
OAuth2FlowGoogleBuilder	redirectUri(String redirectUri)	Set the redirect URI to which the user (resource owner) should be redirected after he/she grants access to our application.
OAuth2FlowGoogleBuilder	refreshTokenUri(String refreshTokenUri)	Set the refresh token URI on which the access token can be refreshed using a refresh token.
OAuth2FlowGoogleBuilder	scope(String scope)	Set a scope to which the application will get authorization grant.

Methods inherited from class java.lang.Object

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

Field Details

LOGIN_HINT

public static final String LOGIN_HINT

Property key that defines values for "login_hint" parameter used in Google OAuth flow.

See Also:

• Constant Field Values

Method Details

accessType

public OAuth2FlowGoogleBuilder accessType(OAuth2FlowGoogleBuilder.AccessType accessType)

Set access type parameter used in Authorization Request.

Parameters:

accessType - access type value.

Returns:

a google authorization flow builder.

prompt

public OAuth2FlowGoogleBuilder prompt(OAuth2FlowGoogleBuilder.Prompt prompt)

Set prompt parameter used in Authorization Request.

Parameters:

prompt - Prompt value.

Returns:

a google authorization flow builder.

display

public OAuth2FlowGoogleBuilder display(OAuth2FlowGoogleBuilder.Display display)

Set display parameter used in Authorization Request.

Parameters:

display - display value.

Returns:

a google authorization flow builder.

loginHint

public OAuth2FlowGoogleBuilder loginHint(String loginHint)

Set login hint parameter used in Authorization Request.

Parameters:

loginHint - login hint value.

Returns:

a google authorization flow builder.

accessTokenUri

public OAuth2FlowGoogleBuilder accessTokenUri(String accessTokenUri)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set the access token URI on which the access token can be requested. The URI points to the authorization server and is defined by the Service Provider.

Specified by:

accessTokenUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

accessTokenUri - Access token URI.

Returns:

Builder instance.

authorizationUri

public OAuth2FlowGoogleBuilder authorizationUri(String authorizationUri)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set the URI to which the user should be redirected to authorize our application. The URI points to the authorization server and is defined by the Service Provider.

Specified by:

authorizationUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

authorizationUri - Authorization URI.

Returns:

Builder instance.

redirectUri

public OAuth2FlowGoogleBuilder redirectUri(String redirectUri)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set the redirect URI to which the user (resource owner) should be redirected after he/she grants access to our application. In most cases, the URI is under control of this application and request done on this URI will be used to extract query parameter code and state that will be used in OAuth2CodeGrantFlow.finish(String, String) method.

If URI is not defined by this method, the default value urn:ietf:wg:oauth:2.0:oob will be used in the Authorization Flow which should cause that code will be passed to application in other way than request redirection (for example shown to the user using html page).

Specified by:

redirectUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

redirectUri - URI that should receive authorization response from the Service Provider.

Returns:

Builder instance.

clientIdentifier

public OAuth2FlowGoogleBuilder clientIdentifier(ClientIdentifier consumerCredentials)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set client identifier of the application that should be authorized.

Specified by:

clientIdentifier in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

consumerCredentials - Client identifier.

Returns:

Builder instance.

scope

public OAuth2FlowGoogleBuilder scope(String scope)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set a scope to which the application will get authorization grant. Values of this parameter are defined by the Service Provider and defines usually subset of resource and operations available in the Service Provider.

The parameter is optional but ServiceProvider might require it.

Specified by:

scope in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

scope - Scope string.

Returns:

Builder instance.

client

public OAuth2FlowGoogleBuilder client(Client client)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server. If this method is not called, it is up to the implementation to create or get any private client instance to perform these requests. This method could be used mainly for performance reasons to avoid creation of new client instances and have control about created client instances used in the application.

Specified by:

client in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

client - Client instance.

Returns:

Builder instance.

refreshTokenUri

public OAuth2FlowGoogleBuilder refreshTokenUri(String refreshTokenUri)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set the refresh token URI on which the access token can be refreshed using a refresh token. The URI points to the authorization server and is defined by the Service Provider. If the URI is not defined by this method it will be the same as URI defined in OAuth2CodeGrantFlow.Builder.accessTokenUri(String) (which is the default value defined by the OAuth2 spec). Some providers do not support refreshing access tokens at all.

Specified by:

refreshTokenUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

refreshTokenUri - Refresh token URI.

Returns:

Builder instance.

property

public OAuth2FlowGoogleBuilder property(OAuth2CodeGrantFlow.Phase phase,
 String key,
 String value)

Description copied from interface: OAuth2CodeGrantFlow.Builder

Set property (parameter) that will be added to requests or URIs as a query parameters during the Authorization Flow. Default parameters used during the Authorization Flow can be also overridden by this method.

Specified by:

property in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Parameters:

phase - Phase of the flow in which the properties (parameters) should be used. For example by using a OAuth2CodeGrantFlow.Phase.ACCESS_TOKEN_REQUEST, the parameter will be added only to the http request for access token.

key - Property key.

value - Property value.

Returns:

Builder instance.

build

public OAuth2CodeGrantFlow build()

Description copied from interface: OAuth2CodeGrantFlow.Builder

Build the OAuth2CodeGrantFlow instance.

Specified by:

build in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>

Returns:

New instance of OAuth2CodeGrantFlow.