Add NetworkInfo, configuration classes and tests

Author: mziccard

gcloud-java-compute/src/main/java/com/google/gcloud/compute/NetworkConfiguration.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * 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.gcloud.compute;
+
+import com.google.api.services.compute.model.Network;
+import com.google.common.base.MoreObjects;
+import com.google.common.base.MoreObjects.ToStringHelper;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * Base class for Google Compute Engine network configuration. Use
+ * {@link StandardNetworkConfiguration} to create a standard network with associated address range.
+ * Use {@link SubnetNetworkConfiguration} to create a network that supports subnetworks, up to one
+ * per region, each with its own address range.
+ *
+ * @see <a href="https://cloud.google.com/compute/docs/networking">Using Networks and Firewalls</a>
+ */
+public abstract class NetworkConfiguration implements Serializable {
+
+  private static final long serialVersionUID = 6599798536784576564L;
+
+  private final Type type;
+
+  /**
+   * Type of a Google Compute Engine disk configuration.
+   */
+  public enum Type {
+    /**
+     * A Google Compute Engine network with no subnetworks.
+     */
+    STANDARD,
+
+    /**
+     * A Google Compute Engine network that supports the creation of subnetworks (either automatic
+     * or manual).
+     */
+    SUBNET
+  }
+
+  NetworkConfiguration(Type type) {
+    this.type = type;
+  }
+
+  /**
+   * Returns the network's type. This method returns {@link Type#STANDARD} for a standard networks
+   * with no subnetworks. This method returns {@link Type#SUBNET} for a network that supports the
+   * creation of subnetworks (either automatic or manual).
+   */
+  public Type type() {
+    return type;
+  }
+
+  ToStringHelper toStringHelper() {
+    return MoreObjects.toStringHelper(this).add("type", type);
+  }
+
+  @Override
+  public String toString() {
+    return toStringHelper().toString();
+  }
+
+  final int baseHashCode() {
+    return Objects.hash(type);
+  }
+
+  final boolean baseEquals(NetworkConfiguration networkConfiguration) {
+    return networkConfiguration != null
+        && getClass().equals(networkConfiguration.getClass())
+        && Objects.equals(toPb(), networkConfiguration.toPb());
+  }
+
+  abstract Network toPb();
+
+  @SuppressWarnings("unchecked")
+  static <T extends NetworkConfiguration> T fromPb(Network networkPb) {
+    if (networkPb.getIPv4Range() != null) {
+      return (T) StandardNetworkConfiguration.fromPb(networkPb);
+    } else {
+      return (T) SubnetNetworkConfiguration.fromPb(networkPb);
+    }
+  }
+}

gcloud-java-compute/src/main/java/com/google/gcloud/compute/NetworkInfo.java

@@ -0,0 +1,288 @@
+/*
+ * Copyright 2016 Google Inc. All Rights Reserved.
+ *
+ * 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.gcloud.compute;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.google.api.services.compute.model.Network;
+import com.google.common.base.Function;
+import com.google.common.base.MoreObjects;
+
+import org.joda.time.format.DateTimeFormatter;
+import org.joda.time.format.ISODateTimeFormat;
+
+import java.io.Serializable;
+import java.math.BigInteger;
+import java.util.Objects;
+
+/**
+ * A Google Compute Engine Network. Every virtual machine instance is created as a member of a
+ * network. Networks connect instances to each other and to the Internet. You can segment your
+ * networks, use firewall rules to restrict access to instances, and create static routes to forward
+ * traffic to specific destinations.
+ *
+ * @see <a href="https://cloud.google.com/compute/docs/networking">Using Networks and Firewalls</a>
+ */
+public class NetworkInfo implements Serializable {
+
+  static final Function<Network, NetworkInfo> FROM_PB_FUNCTION =
+      new Function<Network, NetworkInfo>() {
+        @Override
+        public NetworkInfo apply(Network pb) {
+          return NetworkInfo.fromPb(pb);
+        }
+      };
+  static final Function<NetworkInfo, Network> TO_PB_FUNCTION =
+      new Function<NetworkInfo, Network>() {
+        @Override
+        public Network apply(NetworkInfo network) {
+          return network.toPb();
+        }
+      };
+
+  private static final long serialVersionUID = 4336912581538114026L;
+  private static final DateTimeFormatter TIMESTAMP_FORMATTER = ISODateTimeFormat.dateTime();
+
+  private final String id;
+  private final NetworkId networkId;
+  private final Long creationTimestamp;
+  private final String description;
+  private final NetworkConfiguration configuration;
+
+  /**
+   * A builder for {@code NetworkInfo} objects.
+   */
+  public abstract static class Builder {
+
+    abstract Builder id(String id);
+
+    abstract Builder creationTimestamp(Long creationTimestamp);
+
+    /**
+     * Sets the identity of the network.
+     */
+    public abstract Builder networkId(NetworkId networkId);
+
+    /**
+     * Sets an optional textual description of the network.
+     */
+    public abstract Builder description(String description);
+
+    /**
+     * Sets the network configuration. Use {@link StandardNetworkConfiguration} to create a standard
+     * network with associated IPv4 range. Use {@link SubnetNetworkConfiguration} to create a
+     * network that could be divided into subnetworks, up to one per region, each with its own
+     * address range.
+     */
+    public abstract Builder configuration(NetworkConfiguration configuration);
+
+    /**
+     * Creates a {@code NetworkInfo} object.
+     */
+    public abstract NetworkInfo build();
+  }
+
+  static final class BuilderImpl extends Builder {
+
+    private String id;
+    private NetworkId networkId;
+    private Long creationTimestamp;
+    private String description;
+    private NetworkConfiguration configuration;
+
+    BuilderImpl(NetworkId networkId, NetworkConfiguration configuration) {
+      this.networkId = checkNotNull(networkId);
+      this.configuration = checkNotNull(configuration);
+    }
+
+    BuilderImpl(NetworkInfo networkInfo) {
+      this.id = networkInfo.id;
+      this.creationTimestamp = networkInfo.creationTimestamp;
+      this.networkId = networkInfo.networkId;
+      this.description = networkInfo.description;
+      this.configuration = networkInfo.configuration;
+    }
+
+    BuilderImpl(Network networkPb) {
+      if (networkPb.getId() != null) {
+        this.id = networkPb.getId().toString();
+      }
+      if (networkPb.getCreationTimestamp() != null) {
+        this.creationTimestamp = TIMESTAMP_FORMATTER.parseMillis(networkPb.getCreationTimestamp());
+      }
+      this.networkId = NetworkId.fromUrl(networkPb.getSelfLink());
+      this.description = networkPb.getDescription();
+      this.configuration = NetworkConfiguration.fromPb(networkPb);
+    }
+
+    @Override
+    BuilderImpl id(String id) {
+      this.id = id;
+      return this;
+    }
+
+    @Override
+    BuilderImpl creationTimestamp(Long creationTimestamp) {
+      this.creationTimestamp = creationTimestamp;
+      return this;
+    }
+
+    @Override
+    public BuilderImpl networkId(NetworkId networkId) {
+      this.networkId = checkNotNull(networkId);
+      return this;
+    }
+
+    @Override
+    public BuilderImpl description(String description) {
+      this.description = description;
+      return this;
+    }
+
+    @Override
+    public BuilderImpl configuration(NetworkConfiguration configuration) {
+      this.configuration = checkNotNull(configuration);
+      return this;
+    }
+
+    @Override
+    public NetworkInfo build() {
+      return new NetworkInfo(this);
+    }
+  }
+
+  NetworkInfo(BuilderImpl builder) {
+    this.id = builder.id;
+    this.creationTimestamp = builder.creationTimestamp;
+    this.networkId = builder.networkId;
+    this.description = builder.description;
+    this.configuration = builder.configuration;
+  }
+
+  /**
+   * Returns the unique identifier for the subnetwork; defined by the service.
+   */
+  public String id() {
+    return id;
+  }
+
+  /**
+   * Returns the creation timestamp in milliseconds since epoch.
+   */
+  public Long creationTimestamp() {
+    return creationTimestamp;
+  }
+
+  /**
+   * Returns the network identity.
+   */
+  public NetworkId networkId() {
+    return networkId;
+  }
+
+  /**
+   * Returns a textual description of the network.
+   */
+  public String description() {
+    return description;
+  }
+
+  /**
+   * Returns the network configuration. Returns a {@link StandardNetworkConfiguration} for standard
+   * networks with associated IPv4 range. Returns {@link SubnetNetworkConfiguration} for networks
+   * that could be divided into subnetworks, up to one per region, each with its own address range.
+   */
+  @SuppressWarnings("unchecked")
+  public <T extends NetworkConfiguration> T configuration() {
+    return (T) configuration;
+  }
+
+  /**
+   * Returns a builder for the current network.
+   */
+  public Builder toBuilder() {
+    return new BuilderImpl(this);
+  }
+
+  @Override
+  public String toString() {
+    return MoreObjects.toStringHelper(this)
+        .add("id", id)
+        .add("creationTimestamp", creationTimestamp)
+        .add("networkId", networkId)
+        .add("description", description)
+        .add("configuration", configuration)
+        .toString();
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(id, networkId, creationTimestamp, description, configuration);
+  }
+
+  @Override
+  public boolean equals(Object obj) {
+    return obj == this
+        || obj != null
+        && obj.getClass().equals(NetworkInfo.class)
+        && Objects.equals(toPb(), ((NetworkInfo) obj).toPb());
+  }
+
+  NetworkInfo setProjectId(String projectId) {
+    return toBuilder()
+        .networkId(networkId.setProjectId(projectId))
+        .build();
+  }
+
+  Network toPb() {
+    Network networkPb = configuration.toPb();
+    if (id != null) {
+      networkPb.setId(new BigInteger(id));
+    }
+    if (creationTimestamp != null) {
+      networkPb.setCreationTimestamp(TIMESTAMP_FORMATTER.print(creationTimestamp));
+    }
+    networkPb.setName(networkId.network());
+    networkPb.setDescription(description);
+    networkPb.setSelfLink(networkId.selfLink());
+    return networkPb;
+  }
+
+  /**
+   * Returns a builder for a {@code NetworkInfo} object given the network identity and its
+   * configuration. Use {@link StandardNetworkConfiguration} to create a standard network with
+   * associated address range. Use {@link SubnetNetworkConfiguration} to create a network that
+   * supports subnetworks, up to one per region, each with its own address range.
+   */
+  public static Builder builder(NetworkId networkId, NetworkConfiguration configuration) {
+    return new BuilderImpl(networkId, configuration);
+  }
+
+  /**
+   * Returns a {@code NetworkInfo} object given the network identity. Use
+   * {@link StandardNetworkConfiguration} to create a standard network with associated address
+   * range. Use {@link SubnetNetworkConfiguration} to create a network that supports subnetworks, up
+   * to one per region, each with its own address range.
+   */
+  public static NetworkInfo of(NetworkId networkId, NetworkConfiguration configuration) {
+    return builder(networkId, configuration).build();
+  }
+
+  static NetworkInfo fromPb(Network networkPb) {
+    return new BuilderImpl(networkPb).build();
+  }
+}