Class GoogleBrowserClientRequestUrl (1.35.2)

public class GoogleBrowserClientRequestUrl extends BrowserClientRequestUrl

Google-specific implementation of the 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 Using OAuth 2.0 for Client-side Applications.

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

Sample usage for a web application:


 public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
   String url = new GoogleBrowserClientRequestUrl("812741506391.apps.googleusercontent.com",
       "https://oauth2-login-demo.appspot.com/oauthcallback", Arrays.asList(
           "https://www.googleapis.com/auth/userinfo.email", "https://www.googleapis.com/auth/userinfo.profile"))
               .setState("/profile").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 > com.google.api.client.auth.oauth2.AuthorizationRequestUrl > com.google.api.client.auth.oauth2.BrowserClientRequestUrl > GoogleBrowserClientRequestUrl

Inherited Members

com.google.api.client.auth.oauth2.AuthorizationRequestUrl.getClientId()

com.google.api.client.auth.oauth2.AuthorizationRequestUrl.getRedirectUri()

com.google.api.client.auth.oauth2.AuthorizationRequestUrl.getResponseTypes()

com.google.api.client.auth.oauth2.AuthorizationRequestUrl.getScopes()

com.google.api.client.auth.oauth2.AuthorizationRequestUrl.getState()

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.clone()

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.set(java.lang.String,java.lang.Object)

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setClientId(java.lang.String)

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setRedirectUri(java.lang.String)

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setResponseTypes(java.util.Collection<java.lang.String>)

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setScopes(java.util.Collection<java.lang.String>)

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setState(java.lang.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

GoogleBrowserClientRequestUrl(GoogleClientSecrets clientSecrets, String redirectUri, Collection<String> scopes)

public GoogleBrowserClientRequestUrl(GoogleClientSecrets clientSecrets, String redirectUri, Collection<String> scopes)

Parameters

Name	Description
clientSecrets	`GoogleClientSecrets` OAuth 2.0 client secrets JSON model as specified in client_secrets.json file format
redirectUri	`String` URI that the authorization server directs the resource owner's user-agent back to the client after a successful authorization grant
scopes	`Collection<String>` scopes (see #setScopes(Collection))

GoogleBrowserClientRequestUrl(String clientId, String redirectUri, Collection<String> scopes)

public GoogleBrowserClientRequestUrl(String clientId, String redirectUri, Collection<String> scopes)

Parameters

Name	Description
clientId	`String` client identifier
redirectUri	`String` URI that the authorization server directs the resource owner's user-agent back to the client after a successful authorization grant
scopes	`Collection<String>` scopes (see #setScopes(Collection))

Methods

clone()

public GoogleBrowserClientRequestUrl clone()

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.clone()

getApprovalPrompt()

public final String getApprovalPrompt()

Returns the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior of "auto".

Returns

Type	Description
String

set(String fieldName, Object value)

public GoogleBrowserClientRequestUrl set(String fieldName, Object value)

Parameters

Name	Description
fieldName	`String`
value	`Object`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.set(java.lang.String,java.lang.Object)

setApprovalPrompt(String approvalPrompt)

public GoogleBrowserClientRequestUrl setApprovalPrompt(String approvalPrompt)

Sets the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior of "auto".

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

Parameter

Name	Description
approvalPrompt	`String`

Returns

Type	Description
GoogleBrowserClientRequestUrl

setClientId(String clientId)

public GoogleBrowserClientRequestUrl setClientId(String clientId)

Parameter

Name	Description
clientId	`String`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setClientId(java.lang.String)

setRedirectUri(String redirectUri)

public GoogleBrowserClientRequestUrl setRedirectUri(String redirectUri)

Parameter

Name	Description
redirectUri	`String`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setRedirectUri(java.lang.String)

setResponseTypes(Collection<String> responseTypes)

public GoogleBrowserClientRequestUrl setResponseTypes(Collection<String> responseTypes)

Parameter

Name	Description
responseTypes	`Collection<String>`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setResponseTypes(java.util.Collection<java.lang.String>)

setScopes(Collection<String> scopes)

public GoogleBrowserClientRequestUrl setScopes(Collection<String> scopes)

Parameter

Name	Description
scopes	`Collection<String>`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setScopes(java.util.Collection<java.lang.String>)

setState(String state)

public GoogleBrowserClientRequestUrl setState(String state)

Parameter

Name	Description
state	`String`

Returns

Type	Description
GoogleBrowserClientRequestUrl

Overrides

com.google.api.client.auth.oauth2.BrowserClientRequestUrl.setState(java.lang.String)