Package com.google.api.client.auth.oauth2

Class AuthorizationCodeResponseUrl

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public class AuthorizationCodeResponseUrl
extends com.google.api.client.http.GenericUrl
    OAuth 2.0 URL parser for the redirect URL after end user grants or denies authorization as specified in Authorization Response.

    Check if getError() is null to check if the end-user granted authorization.

    Sample usage: 

      public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
    StringBuffer fullUrlBuf = request.getRequestURL();
    if (request.getQueryString() != null) {
      fullUrlBuf.append('?').append(request.getQueryString());
    }
    AuthorizationCodeResponseUrl authResponse =
        new AuthorizationCodeResponseUrl(fullUrlBuf.toString());
    // check for user-denied error
    if (authResponse.getError() != null) {
      // authorization denied...
    } else {
      // request access token using authResponse.getCode()...
    }
  }

    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

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String code
      Authorization code generated by the authorization server or null for none.
      private java.lang.String error
      Error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.
      private java.lang.String errorDescription
      Human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.
      private java.lang.String errorUri
      URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error or null for none.
      private java.lang.String state
      State parameter matching the state parameter in the authorization request or null for none.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AuthorizationCodeResponseUrl clone()  
      java.lang.String getCode()
      Returns the authorization code generated by the authorization server or null for none.
      java.lang.String getError()
      Returns the error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.
      java.lang.String getErrorDescription()
      Returns the human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.
      java.lang.String getErrorUri()
      Returns the URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error or null for none.
      java.lang.String getState()
      Returns the state parameter matching the state parameter in the authorization request or null for none.
      AuthorizationCodeResponseUrl set​(java.lang.String fieldName, java.lang.Object value)  
      AuthorizationCodeResponseUrl setCode​(java.lang.String code)
      Sets the authorization code generated by the authorization server or null for none.
      AuthorizationCodeResponseUrl setError​(java.lang.String error)
      Sets the error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.
      AuthorizationCodeResponseUrl setErrorDescription​(java.lang.String errorDescription)
      Sets the human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.
      AuthorizationCodeResponseUrl setErrorUri​(java.lang.String errorUri)
      Sets the URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error or null for none.
      AuthorizationCodeResponseUrl setState​(java.lang.String state)
      Sets the state parameter matching the state parameter in the authorization request or null 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 Detail

      • code

        private java.lang.String code
        Authorization code generated by the authorization server or null for none.

      • state

        private java.lang.String state
        State parameter matching the state parameter in the authorization request or null for none.

      • error

        private java.lang.String error
        Error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.

      • errorDescription

        private java.lang.String errorDescription
        Human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.

      • errorUri

        private java.lang.String errorUri
        URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error or null for none.

    • Constructor Detail

      • AuthorizationCodeResponseUrl

        public AuthorizationCodeResponseUrl​(java.lang.String encodedResponseUrl)
        Parameters:
        encodedResponseUrl - encoded authorization code response URL

    • Method Detail

      • getCode

        public final java.lang.String getCode()
        Returns the authorization code generated by the authorization server or null for none.

      • setCode

        public AuthorizationCodeResponseUrl setCode​(java.lang.String code)
        Sets the authorization code generated by the authorization server or null for none.

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

      • getState

        public final java.lang.String getState()
        Returns the state parameter matching the state parameter in the authorization request or null for none.

      • setState

        public AuthorizationCodeResponseUrl setState​(java.lang.String state)
        Sets the state parameter matching the state parameter in the authorization request or null for none.

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

      • getError

        public final java.lang.String getError()
        Returns the error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.

      • setError

        public AuthorizationCodeResponseUrl setError​(java.lang.String error)
        Sets the error code ("invalid_request", "unauthorized_client", "access_denied", "unsupported_response_type", "invalid_scope", "server_error", "temporarily_unavailable", or an extension error code as specified in Defining Additional Error Codes) or null for none.

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

      • getErrorDescription

        public final java.lang.String getErrorDescription()
        Returns the human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.

      • setErrorDescription

        public AuthorizationCodeResponseUrl setErrorDescription​(java.lang.String errorDescription)
        Sets the human-readable text providing additional information used to assist the client developer in understanding the error that occurred or null for none.

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

      • getErrorUri

        public final java.lang.String getErrorUri()
        Returns the URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error or null for none.

      • setErrorUri

        public AuthorizationCodeResponseUrl setErrorUri​(java.lang.String errorUri)
        Sets the URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error 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 AuthorizationCodeResponseUrl set​(java.lang.String fieldName,
                                        java.lang.Object value)
        Overrides:
        set in class com.google.api.client.http.GenericUrl