Class AuthorizationCodeResponseUrl

  • All Implemented Interfaces:
    Cloneable, Map<String,​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
    Author:
    Yaniv Inbar
    • Constructor Detail

      • AuthorizationCodeResponseUrl

        public AuthorizationCodeResponseUrl​(String encodedResponseUrl)
        Parameters:
        encodedResponseUrl - encoded authorization code response URL
    • Method Detail

      • getCode

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

        public AuthorizationCodeResponseUrl setCode​(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 String getState()
        Returns the state parameter matching the state parameter in the authorization request or null for none.
      • setState

        public AuthorizationCodeResponseUrl setState​(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 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​(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 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​(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 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​(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.