Class AuthorizationRequestUrl
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
- Direct Known Subclasses:
AuthorizationCodeRequestUrl
,BrowserClientRequestUrl
public class AuthorizationRequestUrl
extends com.google.api.client.http.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.
- Since:
- 1.7
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,
V>, AbstractMap.SimpleImmutableEntry<K, V> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Client identifier.private String
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) ornull
for none.private String
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.private String
Space-separated list of scopes (as specified in Access Token Scope) ornull
for none.private String
State (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) ornull
for none. -
Constructor Summary
ConstructorsConstructorDescriptionAuthorizationRequestUrl
(String authorizationServerEncodedUrl, String clientId, Collection<String> responseTypes) -
Method Summary
Modifier and TypeMethodDescriptionclone()
final String
Returns the client identifier.final String
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) ornull
for none.final String
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.final String
Returns the space-separated list of scopes (as specified in Access Token Scope) ornull
for none.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) ornull
for none.setClientId
(String clientId) Sets the client identifier.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) ornull
for none.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.setScopes
(Collection<String> scopes) Sets the list of scopes (as specified in Access Token Scope) ornull
for none.Sets the state (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) ornull
for none.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, 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
-
Field Details
-
responseTypes
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. -
redirectUri
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) ornull
for none. -
scopes
Space-separated list of scopes (as specified in Access Token Scope) ornull
for none. -
clientId
Client identifier. -
state
State (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) ornull
for none.
-
-
Constructor Details
-
AuthorizationRequestUrl
public AuthorizationRequestUrl(String authorizationServerEncodedUrl, String clientId, Collection<String> responseTypes) - Parameters:
authorizationServerEncodedUrl
- authorization server encoded URLclientId
- client identifierresponseTypes
- 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- Since:
- 1.15
-
-
Method Details
-
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. -
setResponseTypes
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.
- Since:
- 1.15
-
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) ornull
for none. -
setRedirectUri
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) ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
getScopes
Returns the space-separated list of scopes (as specified in Access Token Scope) ornull
for none. -
setScopes
Sets the list of scopes (as specified in Access Token Scope) ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Parameters:
scopes
- collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes) ornull
for none- Since:
- 1.15
-
getClientId
Returns the client identifier. -
setClientId
Sets the client identifier.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
getState
Returns the state (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) ornull
for none. -
setState
Sets the state (an opaque value used by the client to maintain state between the request and callback, as mentioned in Registration Requirements) ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
set
- Overrides:
set
in classcom.google.api.client.http.GenericUrl
-
clone
- Overrides:
clone
in classcom.google.api.client.http.GenericUrl
-