com.google.api.client.auth.oauth.OAuthGetAccessToken Maven / Gradle / Ivy
Show all versions of google-api-client Show documentation
/*
* Copyright (c) 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.client.auth.oauth;
import com.google.api.client.http.HttpTransport;
/**
* Generic OAuth 1.0a URL to request to exchange the temporary credentials token (or "request
* token") for a long-lived credentials token (or "access token") from an authorization server.
*
* Use {@link #execute()} to execute the request. The long-lived access token acquired with this
* request is found in {@link OAuthCredentialsResponse#token} . This token must be stored. It may
* then be used to authorize HTTP requests to protected resources by setting the
* {@link OAuthParameters#token}, and invoking
* {@link OAuthParameters#signRequestsUsingAuthorizationHeader(HttpTransport)}.
*
* @since 1.0
* @author Yaniv Inbar
*/
public class OAuthGetAccessToken extends AbstractOAuthGetToken {
/**
* Required temporary token. It is retrieved from the {@link OAuthCredentialsResponse#token}
* returned from {@link OAuthGetTemporaryToken#execute()}.
*/
public String temporaryToken;
/**
* Required verifier code received from the server when the temporary token was authorized. It is
* retrieved from {@link OAuthCallbackUrl#verifier}.
*/
public String verifier;
/**
* @param authorizationServerUrl encoded authorization server URL
*/
public OAuthGetAccessToken(String authorizationServerUrl) {
super(authorizationServerUrl);
}
@Override
public OAuthParameters createParameters() {
OAuthParameters result = super.createParameters();
result.token = temporaryToken;
result.verifier = verifier;
return result;
}
}