Class AuthorizationRequestUrl (1.33.3)

public class AuthorizationRequestUrl extends GenericUrl

OAuth 2.0 URL builder for an authorization web page to allow the end user to authorize the application to access their protected resources, as specified in Authorization Endpoint.

Sample usage for a web application:

public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { String url = new AuthorizationRequestUrl( "https://server.example.com/authorize", "s6BhdRkqt3", Arrays.asList("code")).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

Inherited Members

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.clone()

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.set(java.lang.String,java.lang.Object)

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

AuthorizationRequestUrl(String authorizationServerEncodedUrl, String clientId, Collection<String> responseTypes)

public AuthorizationRequestUrl(String authorizationServerEncodedUrl, String clientId, Collection<String> responseTypes)

Parameters

Name	Description
authorizationServerEncodedUrl	`String` authorization server encoded URL
clientId	`String` client identifier
responseTypes	`Collection<String>` 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

Methods

clone()

public AuthorizationRequestUrl clone()

Returns

Type	Description
AuthorizationRequestUrl

Overrides

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

getClientId()

public final String getClientId()

Returns the client identifier.

Returns

Type	Description
String

getRedirectUri()

public final String getRedirectUri()

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

Returns

Type	Description
String

getResponseTypes()

public final String getResponseTypes()

Returns the Response type, which must be "code" for requesting an authorization code, "token" for requesting an access token (implicit grant), or space-separated registered extension values.

Returns

Type	Description
String

getScopes()

public final String getScopes()

Returns the space-separated list of scopes (as specified in Access Token Scope) or null for none.

Returns

Type	Description
String

getState()

public final String getState()

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

Returns

Type	Description
String

set(String fieldName, Object value)

public AuthorizationRequestUrl set(String fieldName, Object value)

Parameters

Name	Description
fieldName	`String`
value	`Object`

Returns

Type	Description
AuthorizationRequestUrl

Overrides

com.google.api.client.http.GenericUrl.set(java.lang.String,java.lang.Object)

setClientId(String clientId)

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

setRedirectUri(String redirectUri)

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

setResponseTypes(Collection<String> responseTypes)

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

setScopes(Collection<String> scopes)

public AuthorizationRequestUrl 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>` collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes) or `null` for none

Returns

Type	Description
AuthorizationRequestUrl

setState(String state)

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