Class AuthorizationCodeRequestUrl (1.33.3)

Version 1.33.3

• 1.36.0 (latest)
• 1.34.1
• 1.33.3
• 1.32.1

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 #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.

Inheritance

Object > java.util.AbstractMap > com.google.api.client.util.GenericData > com.google.api.client.http.GenericUrl > AuthorizationRequestUrl > AuthorizationCodeRequestUrl

Inherited Members

AuthorizationRequestUrl.clone()

AuthorizationRequestUrl.getClientId()

AuthorizationRequestUrl.getRedirectUri()

AuthorizationRequestUrl.getResponseTypes()

AuthorizationRequestUrl.getScopes()

AuthorizationRequestUrl.getState()

AuthorizationRequestUrl.set(String,Object)

AuthorizationRequestUrl.setClientId(String)

AuthorizationRequestUrl.setRedirectUri(String)

AuthorizationRequestUrl.setResponseTypes(Collection<String>)

AuthorizationRequestUrl.setScopes(Collection<String>)

AuthorizationRequestUrl.setState(String)

com.google.api.client.http.GenericUrl.appendRawPath(java.lang.String)

com.google.api.client.http.GenericUrl.build()

com.google.api.client.http.GenericUrl.buildAuthority()

com.google.api.client.http.GenericUrl.buildRelativeUrl()

com.google.api.client.http.GenericUrl.equals(java.lang.Object)

com.google.api.client.http.GenericUrl.getAll(java.lang.String)

com.google.api.client.http.GenericUrl.getFirst(java.lang.String)

com.google.api.client.http.GenericUrl.getFragment()

com.google.api.client.http.GenericUrl.getHost()

com.google.api.client.http.GenericUrl.getPathParts()

com.google.api.client.http.GenericUrl.getPort()

com.google.api.client.http.GenericUrl.getRawPath()

com.google.api.client.http.GenericUrl.getScheme()

com.google.api.client.http.GenericUrl.getUserInfo()

com.google.api.client.http.GenericUrl.hashCode()

com.google.api.client.http.GenericUrl.setFragment(java.lang.String)

com.google.api.client.http.GenericUrl.setHost(java.lang.String)

com.google.api.client.http.GenericUrl.setPathParts(java.util.List<java.lang.String>)

com.google.api.client.http.GenericUrl.setPort(int)

com.google.api.client.http.GenericUrl.setRawPath(java.lang.String)

com.google.api.client.http.GenericUrl.setScheme(java.lang.String)

com.google.api.client.http.GenericUrl.setUserInfo(java.lang.String)

com.google.api.client.http.GenericUrl.toPathParts(java.lang.String)

com.google.api.client.http.GenericUrl.toPathParts(java.lang.String,boolean)

com.google.api.client.http.GenericUrl.toString()

com.google.api.client.http.GenericUrl.toURI()

com.google.api.client.http.GenericUrl.toURL()

com.google.api.client.http.GenericUrl.toURL(java.lang.String)

com.google.api.client.util.GenericData.entrySet()

com.google.api.client.util.GenericData.get(java.lang.Object)

com.google.api.client.util.GenericData.getClassInfo()

com.google.api.client.util.GenericData.getUnknownKeys()

com.google.api.client.util.GenericData.put(java.lang.String,java.lang.Object)

com.google.api.client.util.GenericData.putAll(java.util.Map<? extends java.lang.String,?>)

com.google.api.client.util.GenericData.remove(java.lang.Object)

com.google.api.client.util.GenericData.setUnknownKeys(java.util.Map<java.lang.String,java.lang.Object>)

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

AbstractMap.clear()

AbstractMap.containsKey(Object)

AbstractMap.containsValue(Object)

AbstractMap.isEmpty()

AbstractMap.keySet()

AbstractMap.put(K,V)

AbstractMap.putAll(Map<? extends K,? extends V>)

AbstractMap.size()

AbstractMap.values()

Constructors

AuthorizationCodeRequestUrl(String authorizationServerEncodedUrl, String clientId)

public AuthorizationCodeRequestUrl(String authorizationServerEncodedUrl, String clientId)

Parameters

Name	Description
authorizationServerEncodedUrl	String authorization server encoded URL
clientId	String client identifier

Methods

clone()

public AuthorizationCodeRequestUrl clone()

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.clone()

getCodeChallenge()

public String getCodeChallenge()

Get the code challenge (details).

Returns

Type	Description
String

getCodeChallengeMethod()

public String getCodeChallengeMethod()

Get the code challenge method (details).

Returns

Type	Description
String

set(String fieldName, Object value)

public AuthorizationCodeRequestUrl set(String fieldName, Object value)

Parameters

Name	Description
fieldName	String
value	Object

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.set(String fieldName, Object value)

setClientId(String clientId)

public AuthorizationCodeRequestUrl setClientId(String clientId)

Sets the client identifier.

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

Parameter

Name	Description
clientId	String

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.setClientId(String clientId)

setCodeChallenge(String codeChallenge)

public void setCodeChallenge(String codeChallenge)

Set the code challenge (details).

Parameter

Name	Description
codeChallenge	String the code challenge.

setCodeChallengeMethod(String codeChallengeMethod)

public void setCodeChallengeMethod(String codeChallengeMethod)

Set the code challenge method (details).

Parameter

Name	Description
codeChallengeMethod	String the code challenge method.

setRedirectUri(String redirectUri)

public 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.

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

Parameter

Name	Description
redirectUri	String

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.setRedirectUri(String redirectUri)

setResponseTypes(Collection<String> responseTypes)

public 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.

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

Parameter

Name	Description
responseTypes	Collection<String>

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.setResponseTypes(Collection<String> responseTypes)

setScopes(Collection<String> scopes)

public AuthorizationCodeRequestUrl setScopes(Collection<String> scopes)

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.

Parameter

Name	Description
scopes	Collection<String>

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.setScopes(Collection<String> scopes)

setState(String state)

public 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.

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

Parameter

Name	Description
state	String

Returns

Type	Description
AuthorizationCodeRequestUrl

Overrides

AuthorizationRequestUrl.setState(String state)