com.google.api.client.auth.oauth2

Class AuthorizationCodeRequestUrl

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.http.GenericUrl

com.google.api.client.auth.oauth2.AuthorizationRequestUrl

com.google.api.client.auth.oauth2.AuthorizationCodeRequestUrl

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class AuthorizationCodeRequestUrl
extends AuthorizationRequestUrl

OAuth 2.0 URL builder for an authorization web page to allow the end user to authorize the application to access their protected resources and that returns an authorization code, as specified in Authorization Code Grant.

The default for AuthorizationRequestUrl.getResponseTypes() is "code". Use AuthorizationCodeResponseUrl to parse the redirect response after the end user grants/denies the request. Using the authorization code in this response, use AuthorizationCodeTokenRequest to request the access token.

Sample usage for a web application:

 public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
 String url =
 new AuthorizationCodeRequestUrl("https://server.example.com/authorize", "s6BhdRkqt3")
 .setState("xyz").setRedirectUri("https://client.example.com/rd").build();
 response.sendRedirect(url);
 }
 

Implementation is not thread-safe.

Since:

1.7

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeRequestUrl(String authorizationServerEncodedUrl, String clientId)

Method Summary

Modifier and Type	Method and Description
AuthorizationCodeRequestUrl	clone()
String	getCodeChallenge() Get the code challenge (details).
String	getCodeChallengeMethod() Get the code challenge method (details).
AuthorizationCodeRequestUrl	set(String fieldName, Object value)
AuthorizationCodeRequestUrl	setClientId(String clientId) Sets the client identifier.
void	setCodeChallenge(String codeChallenge) Set the code challenge (details).
void	setCodeChallengeMethod(String codeChallengeMethod) Set the code challenge method (details).
AuthorizationCodeRequestUrl	setRedirectUri(String redirectUri) Sets the URI that the authorization server directs the resource owner's user-agent back to the client after a successful authorization grant (as specified in Redirection Endpoint) or null for none.
AuthorizationCodeRequestUrl	setResponseTypes(Collection<String> responseTypes) Sets the response type, which must be "code" for requesting an authorization code, "token" for requesting an access token (implicit grant), or a list of registered extension values to join with a space.
AuthorizationCodeRequestUrl	setScopes(Collection<String> scopes) Sets the list of scopes (as specified in Access Token Scope) or null for none.
AuthorizationCodeRequestUrl	setState(String state) Sets the state (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) or null for none.

Methods inherited from class com.google.api.client.auth.oauth2.AuthorizationRequestUrl

getClientId, getRedirectUri, getResponseTypes, getScopes, getState

Methods inherited from class com.google.api.client.http.GenericUrl

appendRawPath, build, buildAuthority, buildRelativeUrl, equals, getAll, getFirst, getFragment, getHost, getPathParts, getPort, getRawPath, getScheme, getUserInfo, hashCode, setFragment, setHost, setPathParts, setPort, setRawPath, setScheme, setUserInfo, toPathParts, toPathParts, toString, toURI, toURL, toURL

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AuthorizationCodeRequestUrl

public AuthorizationCodeRequestUrl(String authorizationServerEncodedUrl,
                                   String clientId)

Parameters:

authorizationServerEncodedUrl - authorization server encoded URL

clientId - client identifier

Method Detail

getCodeChallenge

public String getCodeChallenge()

Get the code challenge (details).

Since:

1.31

getCodeChallengeMethod

public String getCodeChallengeMethod()

Get the code challenge method (details).

Since:

1.31

setCodeChallenge

public void setCodeChallenge(String codeChallenge)

Set the code challenge (details).

Parameters:

codeChallenge - the code challenge.

Since:

1.31

setCodeChallengeMethod

public void setCodeChallengeMethod(String codeChallengeMethod)

Set the code challenge method (details).

Parameters:

codeChallengeMethod - the code challenge method.

Since:

1.31

setResponseTypes

public AuthorizationCodeRequestUrl setResponseTypes(Collection<String> responseTypes)

Description copied from class: AuthorizationRequestUrl

Sets the response type, which must be "code" for requesting an authorization code, "token" for requesting an access token (implicit grant), or a list of registered extension values to join with a space.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setResponseTypes in class AuthorizationRequestUrl

setRedirectUri

public AuthorizationCodeRequestUrl setRedirectUri(String redirectUri)

Description copied from class: AuthorizationRequestUrl

Sets the URI that the authorization server directs the resource owner's user-agent back to the client after a successful authorization grant (as specified in Redirection Endpoint) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setRedirectUri in class AuthorizationRequestUrl

setScopes

public AuthorizationCodeRequestUrl setScopes(Collection<String> scopes)

Description copied from class: AuthorizationRequestUrl

Sets the list of scopes (as specified in Access Token Scope) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setScopes in class AuthorizationRequestUrl

Parameters:

scopes - collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes) or null for none

setClientId

public AuthorizationCodeRequestUrl setClientId(String clientId)

Description copied from class: AuthorizationRequestUrl

Sets the client identifier.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setClientId in class AuthorizationRequestUrl

setState

public AuthorizationCodeRequestUrl setState(String state)

Description copied from class: AuthorizationRequestUrl

Sets the state (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setState in class AuthorizationRequestUrl

set

public AuthorizationCodeRequestUrl set(String fieldName,
                                       Object value)

Overrides:

set in class AuthorizationRequestUrl

clone

public AuthorizationCodeRequestUrl clone()

Overrides:

clone in class AuthorizationRequestUrl