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
All Implemented Interfaces:
Cloneable, Map<String,Object>
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

  • Field Details

    • responseTypes

      private String 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

      private String 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) or null for none.

    • scopes

      private String scopes
      Space-separated list of scopes (as specified in Access Token Scope) or null for none.

    • clientId

      private String clientId
      Client identifier.

    • state

      private String state
      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.

  • Constructor Details

    • AuthorizationRequestUrl

      public AuthorizationRequestUrl(String authorizationServerEncodedUrl, String clientId, Collection<String> responseTypes)
      Parameters:
      authorizationServerEncodedUrl - authorization server encoded URL
      clientId - client identifier
      responseTypes - 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

      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.

    • setResponseTypes

      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.

      Since:
      1.15

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

    • setRedirectUri

      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.

    • getScopes

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

    • setScopes

      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.

      Parameters:
      scopes - collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes) or null for none
      Since:
      1.15

    • getClientId

      public final String getClientId()
      Returns the client identifier.

    • setClientId

      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.

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

    • setState

      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.

    • set

      public AuthorizationRequestUrl set(String fieldName, Object value)
      Overrides:
      set in class com.google.api.client.http.GenericUrl

    • clone

      public AuthorizationRequestUrl clone()
      Overrides:
      clone in class com.google.api.client.http.GenericUrl