Class BrowserClientRequestUrl (1.36.0)

public class BrowserClientRequestUrl 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 the access token to a browser client using a scripting language such as JavaScript, as specified in Implicit Grant.

The default for #getResponseTypes() is "token".

Sample usage for a web application:

public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { String url = new BrowserClientRequestUrl( "https://server.example.com/authorize", "s6BhdRkqt3").setState("xyz") .setRedirectUri("https://client.example.com/cb").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 > BrowserClientRequestUrl

Constructors

BrowserClientRequestUrl(String encodedAuthorizationServerUrl, String clientId)

public BrowserClientRequestUrl(String encodedAuthorizationServerUrl, String clientId)
Parameters
Name Description
encodedAuthorizationServerUrl String

encoded authorization server URL
clientId String

client identifier

Methods

clone()

public BrowserClientRequestUrl clone()
Returns
Type Description
BrowserClientRequestUrl
Overrides

set(String fieldName, Object value)

public BrowserClientRequestUrl set(String fieldName, Object value)
Parameters
Name Description
fieldName String
value Object
Returns
Type Description
BrowserClientRequestUrl
Overrides

setClientId(String clientId)

public BrowserClientRequestUrl 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
BrowserClientRequestUrl
Overrides

setRedirectUri(String redirectUri)

public BrowserClientRequestUrl 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
BrowserClientRequestUrl
Overrides

setResponseTypes(Collection<String> responseTypes)

public BrowserClientRequestUrl 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
BrowserClientRequestUrl
Overrides

setScopes(Collection<String> scopes)

public BrowserClientRequestUrl 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
BrowserClientRequestUrl
Overrides

setState(String state)

public BrowserClientRequestUrl 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
BrowserClientRequestUrl
Overrides