Returns the Application Default Credentials which are credentials that identify and
* authorize the whole application. This is the built-in service account if running on Google
* Compute Engine or the credentials file from the path in the environment variable
- * GOOGLE_APPLICATION_CREDENTIALS.
+ * GOOGLE_APPLICATION_CREDENTIALS. If the credentials have been cached, the cached credential will
+ * be returned.
*
* @param transport the transport for Http calls.
* @param jsonFactory the factory for Json parsing and formatting.
@@ -90,8 +91,29 @@ private static enum Environment {
*/
final GoogleCredential getDefaultCredential(HttpTransport transport, JsonFactory jsonFactory)
throws IOException {
+ return getDefaultCredential(transport, jsonFactory, false);
+ }
+
+ /**
+ * {@link Beta}
+ * Returns the Application Default Credentials.
+ *
+ *
Returns the Application Default Credentials which are credentials that identify and
+ * authorize the whole application. This is the built-in service account if running on Google
+ * Compute Engine or the credentials file from the path in the environment variable
+ * GOOGLE_APPLICATION_CREDENTIALS.
+ *
+ * @param transport the transport for Http calls.
+ * @param jsonFactory the factory for Json parsing and formatting.
+ * @param resetCachedCredentials if true, the cached credential will be reset.
+ * @return the credential instance.
+ * @throws IOException if the credential cannot be created in the current environment.
+ */
+ final GoogleCredential getDefaultCredential(
+ HttpTransport transport, JsonFactory jsonFactory, boolean resetCachedCredentials)
+ throws IOException {
synchronized (this) {
- if (cachedCredential == null) {
+ if (cachedCredential == null || resetCachedCredentials) {
cachedCredential = getDefaultCredentialUnsynchronized(transport, jsonFactory);
}
if (cachedCredential != null) {
diff --git a/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java b/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java
index 590a422e2..0b6c39ee8 100644
--- a/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java
+++ b/google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java
@@ -140,8 +140,8 @@
* response handler, take a look at the sample usage for {@link HttpExecuteInterceptor} and {@link
* HttpUnsuccessfulResponseHandler}, which are interfaces that this class also implements.
*
- * @since 1.7
* @author Yaniv Inbar
+ * @since 1.7
* @deprecated Please use
* google-auth-library for handling Application Default Credentials and other non-OAuth2
* based authentication.
@@ -153,7 +153,7 @@ public class GoogleCredential extends Credential {
static final String SERVICE_ACCOUNT_FILE_TYPE = "service_account";
@Beta
- private static DefaultCredentialProvider defaultCredentialProvider =
+ private static final DefaultCredentialProvider defaultCredentialProvider =
new DefaultCredentialProvider();
/**
@@ -170,7 +170,7 @@ public class GoogleCredential extends Credential {
*/
@Beta
public static GoogleCredential getApplicationDefault() throws IOException {
- return getApplicationDefault(Utils.getDefaultTransport(), Utils.getDefaultJsonFactory());
+ return getApplicationDefault(Utils.getDefaultTransport(), Utils.getDefaultJsonFactory(), false);
}
/**
@@ -182,6 +182,27 @@ public static GoogleCredential getApplicationDefault() throws IOException {
* Compute Engine or the credentials file from the path in the environment variable
* GOOGLE_APPLICATION_CREDENTIALS.
*
+ * @param resetCachedCredentials whether to reset the cached credentials
+ * @return the credential instance.
+ * @throws IOException if the credential cannot be created in the current environment.
+ */
+ @Beta
+ public static GoogleCredential getApplicationDefault(boolean resetCachedCredentials)
+ throws IOException {
+ return getApplicationDefault(
+ Utils.getDefaultTransport(), Utils.getDefaultJsonFactory(), resetCachedCredentials);
+ }
+
+ /**
+ * {@link Beta}
+ * Returns the Application Default Credentials.
+ *
+ *
Returns the Application Default Credentials which are credentials that identify and
+ * authorize the whole application. This is the built-in service account if running on Google
+ * Compute Engine or the credentials file from the path in the environment variable
+ * GOOGLE_APPLICATION_CREDENTIALS.
+ *
+ * @param resetCachedCredentials whether to reset the cached credentials.
* @param transport the transport for Http calls.
* @param jsonFactory the factory for Json parsing and formatting.
* @return the credential instance.
@@ -189,10 +210,32 @@ public static GoogleCredential getApplicationDefault() throws IOException {
*/
@Beta
public static GoogleCredential getApplicationDefault(
- HttpTransport transport, JsonFactory jsonFactory) throws IOException {
+ HttpTransport transport, JsonFactory jsonFactory, boolean resetCachedCredentials)
+ throws IOException {
Preconditions.checkNotNull(transport);
Preconditions.checkNotNull(jsonFactory);
- return defaultCredentialProvider.getDefaultCredential(transport, jsonFactory);
+ return defaultCredentialProvider.getDefaultCredential(
+ transport, jsonFactory, resetCachedCredentials);
+ }
+
+ /**
+ * {@link Beta}
+ * Returns the Application Default Credentials.
+ *
+ *
Returns the Application Default Credentials which are credentials that identify and + * authorize the whole application. This is the built-in service account if running on Google + * Compute Engine or the credentials file from the path in the environment variable + * GOOGLE_APPLICATION_CREDENTIALS. + * + * @param transport the transport for Http calls. + * @param jsonFactory the factory for Json parsing and formatting. + * @return the credential instance. + * @throws IOException if the credential cannot be created in the current environment. + */ + @Beta + public static GoogleCredential getApplicationDefault( + HttpTransport transport, JsonFactory jsonFactory) throws IOException { + return getApplicationDefault(transport, jsonFactory, false); } /** @@ -569,7 +612,9 @@ public Builder setJsonFactory(JsonFactory jsonFactory) { return (Builder) super.setJsonFactory(jsonFactory); } - /** @since 1.9 */ + /** + * @since 1.9 + */ @Override public Builder setClock(Clock clock) { return (Builder) super.setClock(clock); diff --git a/google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java b/google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java index d3ea60ccc..b68d5940a 100644 --- a/google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java +++ b/google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java @@ -87,6 +87,19 @@ public void testDefaultCredentialAppEngineDeployed() throws IOException { assertSame(JSON_FACTORY, defaultCredential.getJsonFactory()); } + public void testGetApplicationDefaultResetCacheTrueReturnsNewCredentials() throws IOException { + TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider(); + HttpTransport transport = new MockHttpTransport(); + testProvider.addType( + DefaultCredentialProvider.APP_ENGINE_CREDENTIAL_CLASS, MockAppEngineCredential.class); + testProvider.addType(GAE_SIGNAL_CLASS, MockAppEngineSystemProperty.class); + Credential credential1 = testProvider.getDefaultCredential(transport, JSON_FACTORY, false); + Credential credential2 = testProvider.getDefaultCredential(transport, JSON_FACTORY, false); + Credential credential3 = testProvider.getDefaultCredential(transport, JSON_FACTORY, true); + assertSame(credential1, credential2); + assertNotSame(credential2, credential3); + } + public void testDefaultCredentialAppEngineComponentOffAppEngineGivesNotFoundError() { HttpTransport transport = new MockHttpTransport(); TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();