com.google.api.client.googleapis.auth.oauth2.GoogleTokenResponse Maven / Gradle / Ivy
/*
* Copyright 2012 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.googleapis.auth.oauth2;
import com.google.api.client.auth.oauth2.TokenResponse;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.util.Beta;
import com.google.api.client.util.Key;
import com.google.api.client.util.Preconditions;
import java.io.IOException;
/**
* Google OAuth 2.0 JSON model for a successful access token response as specified in Successful Response, including an ID
* token as specified in OpenID
* Connect Session Management 1.0.
*
* This response object is the result of {@link GoogleAuthorizationCodeTokenRequest#execute()}
* and {@link GoogleRefreshTokenRequest#execute()}. Use {@link #parseIdToken()} to parse the {@link
* GoogleIdToken} and then call {@link GoogleIdTokenVerifier#verify(GoogleIdToken)}.
*
*
Implementation is not thread-safe.
*
* @since 1.7
* @author Yaniv Inbar
*/
public class GoogleTokenResponse extends TokenResponse {
/** ID token. */
@Key("id_token")
private String idToken;
@Override
public GoogleTokenResponse setAccessToken(String accessToken) {
return (GoogleTokenResponse) super.setAccessToken(accessToken);
}
@Override
public GoogleTokenResponse setTokenType(String tokenType) {
return (GoogleTokenResponse) super.setTokenType(tokenType);
}
@Override
public GoogleTokenResponse setExpiresInSeconds(Long expiresIn) {
return (GoogleTokenResponse) super.setExpiresInSeconds(expiresIn);
}
@Override
public GoogleTokenResponse setRefreshToken(String refreshToken) {
return (GoogleTokenResponse) super.setRefreshToken(refreshToken);
}
@Override
public GoogleTokenResponse setScope(String scope) {
return (GoogleTokenResponse) super.setScope(scope);
}
/**
* {@link Beta}
* Returns the ID token.
*/
@Beta
public final String getIdToken() {
return idToken;
}
/**
* {@link Beta}
* Sets the ID token.
*
*
Overriding is only supported for the purpose of calling the super implementation and
* changing the return type, but nothing else.
*/
@Beta
public GoogleTokenResponse setIdToken(String idToken) {
this.idToken = Preconditions.checkNotNull(idToken);
return this;
}
/**
* {@link Beta}
* Parses using {@link GoogleIdToken#parse(JsonFactory, String)} based on the {@link #getFactory()
* JSON factory} and {@link #getIdToken() ID token}.
*/
@Beta
public GoogleIdToken parseIdToken() throws IOException {
return GoogleIdToken.parse(getFactory(), getIdToken());
}
@Override
public GoogleTokenResponse set(String fieldName, Object value) {
return (GoogleTokenResponse) super.set(fieldName, value);
}
@Override
public GoogleTokenResponse clone() {
return (GoogleTokenResponse) super.clone();
}
}