Merge FloatingIP support from contributor 'nanderson'. Full cinder support including volumes, volume types and volume snapshots

Author: gondor

src/main/java/org/openstack4j/api/Builders.java

@@ -2,6 +2,7 @@
 
 import org.openstack4j.model.common.builder.LinkBuilder;
 import org.openstack4j.model.compute.builder.FlavorBuilder;
+import org.openstack4j.model.compute.builder.FloatingIPBuilder;
 import org.openstack4j.model.compute.builder.ServerCreateBuilder;
 import org.openstack4j.model.identity.builder.EndpointBuilder;
 import org.openstack4j.model.identity.builder.RoleBuilder;
@@ -14,8 +15,11 @@
 import org.openstack4j.model.network.builder.PortBuilder;
 import org.openstack4j.model.network.builder.RouterBuilder;
 import org.openstack4j.model.network.builder.SubnetBuilder;
+import org.openstack4j.model.storage.block.builder.VolumeBuilder;
+import org.openstack4j.model.storage.block.builder.VolumeSnapshotBuilder;
 import org.openstack4j.openstack.common.GenericLink;
 import org.openstack4j.openstack.compute.domain.NovaFlavor;
+import org.openstack4j.openstack.compute.domain.NovaFloatingIP;
 import org.openstack4j.openstack.compute.domain.NovaServerCreate;
 import org.openstack4j.openstack.identity.domain.KeystoneEndpoint;
 import org.openstack4j.openstack.identity.domain.KeystoneRole;
@@ -28,6 +32,8 @@
 import org.openstack4j.openstack.networking.domain.NeutronPort;
 import org.openstack4j.openstack.networking.domain.NeutronRouter;
 import org.openstack4j.openstack.networking.domain.NeutronSubnet;
+import org.openstack4j.openstack.storage.block.domain.CinderVolume;
+import org.openstack4j.openstack.storage.block.domain.CinderVolumeSnapshot;
 
 /**
  * A utility class to quickly access available Builders within the OpenStack API
@@ -158,4 +164,28 @@ public static RouterBuilder router() {
 	public static ImageBuilder image() {
 		return GlanceImage.builder();
 	}
+	
+	/**
+	 * The builder to create a Block Volume
+	 * @return the volume builder
+	 */
+	public static VolumeBuilder volume() {
+		return CinderVolume.builder();
+	}
+	
+	/**
+	 * The builder to create a Block Volume Snapshot
+	 * @return the snapshot builder
+	 */
+	public static VolumeSnapshotBuilder volumeSnapshot() {
+		return CinderVolumeSnapshot.builder();
+	}
+	
+	/**
+	 * The builder to create a Compute/Nova Floating IP
+	 * @return the floating ip builder
+	 */
+	public static FloatingIPBuilder floatingIP() {
+		return NovaFloatingIP.builder();
+	}
 }

src/main/java/org/openstack4j/api/compute/ComputeFloatingIPService.java

@@ -0,0 +1,60 @@
+package org.openstack4j.api.compute;
+
+import java.util.List;
+
+import org.openstack4j.common.RestService;
+import org.openstack4j.model.compute.ActionResponse;
+import org.openstack4j.model.compute.FloatingIP;
+import org.openstack4j.model.compute.Server;
+
+/**
+ * OpenStack Compute Floating-IP Operation API.
+ *
+ * @author Nathan Anderson
+ */
+public interface ComputeFloatingIPService extends RestService {
+	
+	/**
+	 * List floating ips associated with current tenant.
+	 *
+	 * @return the list<? extends floating i p>
+	 */
+	List<? extends FloatingIP> list();
+	
+	/**
+	 * Allocate a floating ip address to tenant.
+	 *
+	 * @param pool the pool
+	 * @return the floating ip
+	 */
+	FloatingIP allocateIP(String pool);
+	
+	/**
+	 * Deallocate ip address from tenant.
+	 *
+	 * @param tenantId the tenant id
+	 * @param id the id of floating ip address
+	 * @return the action response
+	 */
+	void deallocateIP(String id);
+	
+	
+	/**
+	 * Adds floating-ip to server.
+	 *
+	 * @param server the server
+	 * @param fixedIpAddress the fixed ip address
+	 * @param ipAddress the ip address
+	 * @return the action response
+	 */
+	ActionResponse addFloatingIP(Server server, String fixedIpAddress, String ipAddress);
+	
+	/**
+	 * Remove floating-ip from server
+	 *
+	 * @param server the server
+	 * @param ipAddress the ip address
+	 */
+	ActionResponse removeFloatingIP(Server server, String ipAddress);
+	
+}

src/main/java/org/openstack4j/api/compute/ComputeService.java

@@ -18,31 +18,38 @@ public interface ComputeService extends RestService {
 	 * @return the flavor service
 	 */
 	FlavorService flavors();
-	
+
 	/**
 	 * Image Service API
 	 *
 	 * @return the image service
 	 */
 	ComputeImageService images();
-	
+
 	/**
 	 * Server Service API
 	 *
 	 * @return the server service
 	 */
 	ServerService servers();
-	
+
 	/**
 	 * Quota-Set Service API
 	 *
 	 * @return the quota set service
 	 */
 	QuotaSetService quotaSets();
-	
+
+	/**
+	 * Floating IP Service API
+	 *
+	 * @return the floating-ip service
+	 */
+	ComputeFloatingIPService floatingIps();
+
 	/**
 	 * @return a list of Extensions that have been added against the Compute service
 	 */
 	List<? extends Extension> listExtensions();
-	
+
 }

src/main/java/org/openstack4j/api/networking/FloatingIPService.java

@@ -0,0 +1,59 @@
+package org.openstack4j.api.networking;
+
+import java.util.List;
+
+import org.openstack4j.common.RestService;
+
+import org.openstack4j.model.network.FloatingIP;
+
+
+/**
+ * Provides Neutron-based FloatingIP services
+ * 
+ *
+ * @author nanderson
+ */
+public interface FloatingIPService extends RestService {
+
+  /**
+   * Returns list of floating IPs 
+   *
+   * @return List of FloatingIPs or empty 
+   */
+  List<? extends FloatingIP> list();
+  
+  /**
+   * Gets a FloatingIP by id 
+   *
+   * @param id the floating-ip identifier
+   * @return the FloatingIP
+   */
+  FloatingIP get(String id);
+  
+  /**
+   * Deletes FloatingIP by id
+   *
+   * @param id floating-ip identifier id
+   */
+  void delete(String id);
+  
+  /**
+   * Creates the.
+   *
+   * @param floatingIp floating ip
+   */
+  FloatingIP create(FloatingIP floatingIp);
+  
+  /**
+   * Update.
+   *
+   * @param floatingIp the floating ip
+   */
+  //FloatingIP update(FloatingIP floatingIp);
+  
+  
+  //FloatingIP associateToPort();
+  
+  //FloatingIP disassociateFromPort();
+  
+}

src/main/java/org/openstack4j/api/networking/NetworkingService.java

@@ -28,4 +28,9 @@ public interface NetworkingService extends RestService {
 	 * @return the Router Service API
 	 */
 	RouterService router();
+	
+	/**
+	 * @return the FloatingIP Service API
+	 */
+	FloatingIPService floatingip();
 }

src/main/java/org/openstack4j/api/storage/BlockStorageService.java

@@ -14,4 +14,9 @@ public interface BlockStorageService extends RestService {
 	 */
 	BlockVolumeService volumes();
 
+	/**
+	 * @return the Volume Snapshot Service API
+	 */
+	BlockVolumeSnapshotService snapshots();
+	
 }

src/main/java/org/openstack4j/api/storage/BlockVolumeService.java

@@ -33,4 +33,27 @@ public interface BlockVolumeService extends RestService {
 	 * @return the volume or null if not found
 	 */
 	Volume get(String volumeId);
+	
+	/**
+	 * Deletes the specified volume
+	 * 
+	 * @param volumeId the volume identifier
+	 */
+	void delete(String volumeId);
+	
+	/**
+	 * Creates a new Block Storage Volume
+	 * @param volume the volume for create
+	 * @return the created volume
+	 */
+	Volume create(Volume volume);
+	
+	/**
+	 * OpenStack only allows name or description to be updated. This call enforces that based on the API docs.
+	 * 
+	 * @param volumeId the volume id
+	 * @param name the name to update (null indicates no name update)
+	 * @param description the description to update (null indicates no description update)
+	 */
+	void update(String volumeId, String name, String description);
 }

src/main/java/org/openstack4j/api/storage/BlockVolumeSnapshotService.java

@@ -0,0 +1,56 @@
+package org.openstack4j.api.storage;
+
+import java.util.List;
+
+import org.openstack4j.common.RestService;
+import org.openstack4j.model.storage.block.VolumeSnapshot;
+
+/**
+ * OpenStack (Cinder) Volume Snapshot Operations API.
+ *
+ * @author Jeremy Unruh
+ */
+public interface BlockVolumeSnapshotService extends RestService {
+
+	/**
+	 * Lists detailed information for all Block Storage snapshots that the tenant who submits the request can access.
+	 *
+	 * @return List of VolumeSnapshot
+	 */
+	List<? extends VolumeSnapshot> list();
+	
+	/**
+	 * Shows information for a specified snapshot.
+	 *
+	 * @param snapshotId the snapshot identifier
+	 * @return the volume snapshot or null
+	 */
+	VolumeSnapshot get(String snapshotId);
+	
+	/**
+	 * Deletes a specified snapshot
+	 *
+	 * @param snapshotId the snapshot identifier
+	 */
+	void delete(String snapshotId);
+	
+	/**
+	 * Updates the Name and/or Description for the specified snapshot
+	 *
+	 * @param snapshotId the snapshot identifier
+	 * @param name the new name
+	 * @param description the new description
+	 */
+	void update(String snapshotId, String name, String description);
+	
+	/**
+	 * Creates a snapshot, which is a point-in-time copy of a volume. You can create a volume from the snapshot.
+	 * 
+	 * NOTE: the volume ID within the snapshot must be set or an NullPointerException will be thrown
+	 *
+	 * @param snapshot the snapshot to create
+	 * @return the newly created snapshot
+	 */
+	VolumeSnapshot create(VolumeSnapshot snapshot);
+	
+}

src/main/java/org/openstack4j/model/compute/FloatingIP.java

@@ -0,0 +1,49 @@
+package org.openstack4j.model.compute;
+
+import org.openstack4j.common.Buildable;
+import org.openstack4j.model.ModelEntity;
+import org.openstack4j.model.compute.builder.FloatingIPBuilder;
+
+/**
+ * The Interface FloatingIP.
+ * 
+ *
+ * @author nanderson
+ */
+public interface FloatingIP extends ModelEntity, Buildable<FloatingIPBuilder> {
+
+  /**
+   * Gets the id.
+   *
+   * @return the id
+   */
+  String getId();
+
+  /**
+   * Gets the instance id.
+   *
+   * @return the instance id
+   */
+  String getInstanceId();
+
+  /**
+   * Gets the floating ip address.
+   *
+   * @return the floating ip address
+   */
+  String getFloatingIpAddress();
+
+  /**
+   * Gets the fixed ip address.
+   *
+   * @return the fixed ip address
+   */
+  String getFixedIpAddress();
+  
+  /**
+   * Gets the pool.
+   *
+   * @return the pool name
+   */
+  String getPool();
+}