Merge pull request #123 from google/shinfan-dev

Switch OAuth2 HTTP surface to use builder pattern

Author: shinfan

oauth2_http/java/com/google/auth/oauth2/ClientId.java

@@ -123,6 +123,7 @@ public static ClientId fromStream(InputStream stream) throws IOException {
    * @param clientId Text identifier of the Client ID.
    * @param clientSecret Secret to associated with the Client ID.
    */
+  @Deprecated
   public ClientId(String clientId, String clientSecret) {
     this.clientId = Preconditions.checkNotNull(clientId);
     this.clientSecret = clientSecret;
@@ -141,4 +142,44 @@ public final String getClientId() {
   public final String getClientSecret() {
     return clientSecret;
   }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  public static class Builder {
+
+    private String clientId;
+
+    private String clientSecret;
+
+    protected Builder() {}
+
+    protected Builder(ClientId clientId) {
+      this.clientId = clientId.getClientId();
+      this.clientSecret = clientId.getClientSecret();
+    }
+
+    public Builder setClientId(String clientId) {
+      this.clientId = clientId;
+      return this;
+    }
+
+    public Builder setClientSecret(String clientSecret) {
+      this.clientSecret = clientSecret;
+      return this;
+    }
+
+    public String getClientSecret() {
+      return clientSecret;
+    }
+
+    public ClientId build() {
+      return new ClientId(clientId, clientSecret);
+    }
+  }
 }

oauth2_http/java/com/google/auth/oauth2/CloudShellCredentials.java

@@ -63,6 +63,11 @@ public class CloudShellCredentials extends GoogleCredentials {
 
   private final int authPort;
 
+  public static CloudShellCredentials of(int authPort) {
+    return CloudShellCredentials.newBuilder().setAuthPort(authPort).build();
+  }
+
+  @Deprecated
   public CloudShellCredentials(int authPort) {
     this.authPort = authPort;
   }
@@ -112,4 +117,35 @@ public boolean equals(Object obj) {
     CloudShellCredentials other = (CloudShellCredentials) obj;
     return this.authPort == other.authPort;
   }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public static class Builder extends GoogleCredentials.Builder {
+    private int authPort;
+
+    protected Builder() {}
+
+    protected Builder(CloudShellCredentials credentials) {
+      this.authPort = credentials.authPort;
+    }
+
+    public Builder setAuthPort(int authPort) {
+      this.authPort = authPort;
+      return this;
+    }
+
+    public int getAuthPort() {
+      return authPort;
+    }
+
+    public CloudShellCredentials build() {
+      return new CloudShellCredentials(authPort);
+    }
+  }
 }

oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java

@@ -82,9 +82,20 @@ public class ComputeEngineCredentials extends GoogleCredentials {
 
   private transient HttpTransportFactory transportFactory;
 
+  /**
+   * Returns a credentials instance from the given transport factory
+   *
+   * @param transportFactory The Http transport factory
+   * @return the credential instance
+   */
+  public static ComputeEngineCredentials of(HttpTransportFactory transportFactory) {
+    return ComputeEngineCredentials.newBuilder().setHttpTransportFactory(transportFactory).build();
+  }
+
   /**
    * Constructor with minimum information and default behavior.
    */
+  @Deprecated
   public ComputeEngineCredentials() {
     this(null);
   }
@@ -95,6 +106,7 @@ public ComputeEngineCredentials() {
    * @param transportFactory HTTP transport factory, creates the transport used to get access
    *        tokens.
    */
+  @Deprecated
   public ComputeEngineCredentials(HttpTransportFactory transportFactory) {
     this.transportFactory = firstNonNull(transportFactory,
         getFromServiceLoader(HttpTransportFactory.class, OAuth2Utils.HTTP_TRANSPORT_FACTORY));
@@ -225,4 +237,35 @@ private void readObject(ObjectInputStream input) throws IOException, ClassNotFou
     input.defaultReadObject();
     transportFactory = newInstance(transportFactoryClassName);
   }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public static class Builder extends GoogleCredentials.Builder {
+    private HttpTransportFactory transportFactory;
+
+    protected Builder() {}
+
+    protected Builder(ComputeEngineCredentials credentials) {
+      this.transportFactory = credentials.transportFactory;
+    }
+
+    public Builder setHttpTransportFactory(HttpTransportFactory transportFactory) {
+      this.transportFactory = transportFactory;
+      return this;
+    }
+
+    public HttpTransportFactory getHttpTransportFactory() {
+      return transportFactory;
+    }
+
+    public ComputeEngineCredentials build() {
+      return new ComputeEngineCredentials(transportFactory);
+    }
+  }
 }

oauth2_http/java/com/google/auth/oauth2/GoogleCredentials.java

@@ -53,6 +53,16 @@ public class GoogleCredentials extends OAuth2Credentials {
   private static final DefaultCredentialsProvider defaultCredentialsProvider =
       new DefaultCredentialsProvider();
 
+  /**
+   * Returns the credentials instance from the given access token.
+   *
+   * @param accessToken the access token
+   * @return the credentials instance
+   */
+  public static GoogleCredentials of(AccessToken accessToken) {
+    return GoogleCredentials.newBuilder().setAccessToken(accessToken).build();
+  }
+
   /**
    * Returns the Application Default Credentials.
    *
@@ -167,10 +177,19 @@ protected GoogleCredentials() {
    *
    * @param accessToken Initial or temporary access token.
    **/
+  @Deprecated
   public GoogleCredentials(AccessToken accessToken) {
     super(accessToken);
   }
 
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
   /**
    * Indicates whether the credentials require scopes to be specified via a call to
    * {link GoogleCredentials#createScoped} before use.
@@ -195,4 +214,22 @@ public GoogleCredentials createScoped(Collection<String> scopes) {
   public GoogleCredentials createDelegated(String user) {
     return this;
   }
+
+  public static class Builder extends OAuth2Credentials.Builder {
+    protected Builder() {}
+
+    protected Builder(GoogleCredentials credentials) {
+      setAccessToken(credentials.getAccessToken());
+    }
+
+    public GoogleCredentials build() {
+      return new GoogleCredentials(getAccessToken());
+    }
+
+    @Override
+    public Builder setAccessToken(AccessToken token) {
+      super.setAccessToken(token);
+      return this;
+    }
+  }
 }

oauth2_http/java/com/google/auth/oauth2/OAuth2Credentials.java

@@ -72,6 +72,16 @@ public class OAuth2Credentials extends Credentials {
   @VisibleForTesting
   transient Clock clock = Clock.SYSTEM;
 
+  /**
+   * Returns the credentials instance from the given access token.
+   *
+   * @param accessToken the access token
+   * @return the credentials instance
+   */
+  public static OAuth2Credentials of(AccessToken accessToken) {
+    return OAuth2Credentials.newBuilder().setAccessToken(accessToken).build();
+  }
+
   /**
    * Default constructor.
    **/
@@ -84,6 +94,7 @@ protected OAuth2Credentials() {
    *
    * @param accessToken Initial or temporary access token.
    **/
+  @Deprecated
   public OAuth2Credentials(AccessToken accessToken) {
     if (accessToken != null) {
       useAccessToken(accessToken);
@@ -279,4 +290,36 @@ protected static <T> T newInstance(String className) throws IOException, ClassNo
   protected static <T> T getFromServiceLoader(Class<? extends T> clazz, T defaultInstance) {
     return Iterables.getFirst(ServiceLoader.load(clazz), defaultInstance);
   }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  public static class Builder {
+
+    private AccessToken accessToken;
+
+    protected Builder() {}
+
+    protected Builder(OAuth2Credentials credentials) {
+      this.accessToken = credentials.getAccessToken();
+    }
+
+    public Builder setAccessToken(AccessToken token) {
+      this.accessToken = token;
+      return this;
+    }
+
+    public AccessToken getAccessToken() {
+      return accessToken;
+    }
+
+    public OAuth2Credentials build() {
+      return new OAuth2Credentials(accessToken);
+    }
+  }
 }