Merge pull request ContainX#17 from olivergondza/declare-api-deprecated

Deprecate domain objects and builders for deprecated services

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

@@ -2,7 +2,6 @@
 
 import org.openstack4j.model.artifact.builder.ArtifactUpdateBuilder;
 import org.openstack4j.model.artifact.builder.ToscaTemplatesArtifactBuilder;
-import org.openstack4j.model.barbican.Secret;
 import org.openstack4j.model.barbican.builder.ContainerCreateBuilder;
 import org.openstack4j.model.barbican.builder.ContainerSecretBuilder;
 import org.openstack4j.model.barbican.builder.SecretCreateBuilder;
@@ -182,7 +181,7 @@ public static NetworkBuilder network() {
     /**
      * The builder to create a Flow Classifier
      *
-     * @return the Flow Classifier builder
+     * @return the Flow Classifier builder
      */
     public static FlowClassifierBuilder flowClassifier() {
         return NeutronFlowClassifier.builder();
@@ -290,7 +289,9 @@ public static VolumeBackupCreateBuilder volumeBackupCreate(){
      * The builder to create a Compute/Nova Floating IP
      *
      * @return the floating ip builder
+     * @deprecated @deprecated Since these APIs are only implemented for nova-network, they are deprecated. These will fail with a 404 starting from microversion 2.36. They were removed in the 18.0.0 Rocky release.
      */
+    @Deprecated
     public static FloatingIPBuilder floatingIP() {
         return NovaFloatingIP.builder();
     }
@@ -378,7 +379,6 @@ public static StackUpdateBuilder stackUpdate() {
 
     /**
      * The builder to create a {@link ResourceHealth}
-     * @return
      */
     public static ResourceHealthBuilder resourceHealth() {
         return HeatResourceHealth.builder();
@@ -853,10 +853,7 @@ public static NatPoolBuilder natPool() {
     }
 
     /**
-     * The builder which creates network service policy for gbp
-     *
-     *
-     * @return
+     * The builder which creates network service policy for gbp.
      */
     public static NetworkServicePolicyBuilder networkServicePolicy() {
         return GbpNetworkServicePolicy.builder();

core/src/main/java/org/openstack4j/api/networking/NetFloatingIPService.java

@@ -7,7 +7,6 @@
 import org.openstack4j.model.common.ActionResponse;
 import org.openstack4j.model.network.NetFloatingIP;
 
-
 /**
  * Provides Neutron-based FloatingIP services.
  *
@@ -26,7 +25,6 @@ public interface NetFloatingIPService extends RestService {
    * Returns list of floating IPs filtered by parameters.
    * 
    * @param filteringParams map (name, value) of filtering parameters
-   * @return 
    */
   List<? extends NetFloatingIP> list(Map<String, String> filteringParams);
 
@@ -37,41 +35,35 @@ public interface NetFloatingIPService extends RestService {
    * @return the NetFloatingIP
    */
   NetFloatingIP get(String id);
-
-
+
   /**
    * Deletes NetFloatingIP by id.
    *
    * @param id the id
    * @return the action response
    */
   ActionResponse delete(String id);
-
-
+
   /**
    * Creates a new Floating IP
    *
    * @param floatingIp the floating ip
    * @return the net floating ip
    */
   NetFloatingIP create(NetFloatingIP floatingIp);
-
-
+
   /**
    * Associates a Floating IP to a Port.
    *
-   * @param floatingIp the floating ip
    * @return the net floating ip
    */
   NetFloatingIP associateToPort(String id, String portId);
 
 
   /**
-   * Deassociate's from port.
+   * Disassociate from port.
    *
-   * @param floatingIp the floating ip
    * @return the net floating ip
    */
   NetFloatingIP disassociateFromPort(String id);
-
 }

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

@@ -6,10 +6,11 @@
 
 /**
  * The Interface FloatingIP.
- * 
+ *
  *
  * @author nanderson
  */
+@Deprecated
 public interface FloatingIP extends ModelEntity, Buildable<FloatingIPBuilder> {
 
   /**
@@ -46,4 +47,4 @@ public interface FloatingIP extends ModelEntity, Buildable<FloatingIPBuilder> {
    * @return the pool name
    */
   String getPool();
-}
+}

core/src/main/java/org/openstack4j/model/compute/HostResource.java

@@ -7,6 +7,7 @@
  * 
  * @author Qin An
  */
+@Deprecated
 public interface HostResource extends ModelEntity {
     /**
      * @return the number of CPUs of the compute host

core/src/main/java/org/openstack4j/model/compute/Image.java

@@ -15,12 +15,14 @@
  * 
  * @author Jeremy Unruh
  */
+@Deprecated
 public interface Image extends ModelEntity {
 
 	/**
 	 * Status can be used while an image is being saved.  It provides state of the progress indicator.  Images with ACTIVE status
 	 * are available for install.
 	 */
+	@Deprecated
 	enum Status {
 		UNRECOGNIZED, UNKNOWN, ACTIVE, SAVING, ERROR, DELETED;
 

core/src/main/java/org/openstack4j/model/compute/SecGroupExtension.java

@@ -12,11 +12,13 @@
  * 
  * @author Jeremy Unruh
  */
+@Deprecated
 public interface SecGroupExtension extends ModelEntity{
 
 	/**
 	 * Security Group Rule
 	 */
+	@Deprecated
 	public interface Rule extends ModelEntity, Buildable<SecurityGroupRuleBuilder> 
 	{
 
@@ -66,6 +68,7 @@ public interface Rule extends ModelEntity, Buildable<SecurityGroupRuleBuilder>
 		 * Rule Group
 		 * 
 		 */
+		@Deprecated
 		public interface Group 
 		{
 
@@ -85,6 +88,7 @@ public interface Group
 		/**
 		 * Rule IP Range
 		 */
+		@Deprecated
 		public interface IpRange {
 
 			/**

core/src/main/java/org/openstack4j/model/compute/builder/ComputeBuilders.java

@@ -1,7 +1,5 @@
 package org.openstack4j.model.compute.builder;
 
-import org.openstack4j.openstack.compute.domain.*;
-
 /**
  * The Compute Builders
  */
@@ -32,7 +30,9 @@ public interface ComputeBuilders {
      * The builder to create a Compute/Nova Floating IP
      *
      * @return the floating ip builder
+     * @deprecated Since these APIs are only implemented for nova-network, they are deprecated. These will fail with a 404 starting from microversion 2.36. They were removed in the 18.0.0 Rocky release.
      */
+    @Deprecated
     public FloatingIPBuilder floatingIP();
 
     /**
@@ -41,5 +41,4 @@ public interface ComputeBuilders {
      * @return the QuotaSet update builder
      */
     public QuotaSetUpdateBuilder quotaSet();
-
 }

core/src/main/java/org/openstack4j/model/compute/builder/FloatingIPBuilder.java

@@ -8,6 +8,7 @@
  * 
  * @author Nathan Anderson
  */
+@Deprecated
 public interface FloatingIPBuilder extends Builder<FloatingIPBuilder, FloatingIP> {
 
 	/**

core/src/main/java/org/openstack4j/model/compute/builder/SecurityGroupRuleBuilder.java

@@ -9,6 +9,7 @@
  * 
  * @author Jeremy Unruh
  */
+@Deprecated
 public interface SecurityGroupRuleBuilder extends Builder<SecurityGroupRuleBuilder, Rule> {
 
 	/**

core/src/main/java/org/openstack4j/model/compute/ext/DNSEntry.java

@@ -7,6 +7,7 @@
  * 
  * @author Jeremy Unruh
  */
+@Deprecated
 public interface DNSEntry extends ModelEntity {
 
     /**

core/src/main/java/org/openstack4j/model/compute/ext/DomainEntry.java

@@ -10,8 +10,10 @@
  * 
  * @author Jeremy Unruh
  */
+@Deprecated
 public interface DomainEntry extends ModelEntity {
-
+
+    @Deprecated
     public enum Scope {
         PUBLIC,
         PRIVATE

core/src/main/java/org/openstack4j/openstack/compute/domain/NovaFloatingIP.java

@@ -17,6 +17,7 @@
  * @author Nathan Anderson
  */
 @JsonRootName("floating_ip")
+@Deprecated
 public class NovaFloatingIP implements FloatingIP {
 
   private static final long serialVersionUID = -4441740897994315920L;
@@ -109,6 +110,7 @@ public String toString() {
    *
    * @author Nathan Anderson
    */
+  @Deprecated
   public static class NovaFloatingIPs extends ListResult<NovaFloatingIP> {
 
     private static final long serialVersionUID = 1L;
@@ -131,6 +133,7 @@ protected List<NovaFloatingIP> value() {
    *
    * @author Nathan Anderson
    */
+  @Deprecated
   public static class FloatingIPConcreteBuilder implements FloatingIPBuilder {
 
     NovaFloatingIP m = null;

core/src/main/java/org/openstack4j/openstack/compute/domain/NovaHostResource.java

@@ -16,6 +16,7 @@
  * @author Elina Meier
  */
 @JsonRootName("resource")
+@Deprecated
 public class NovaHostResource implements HostResource {
 
     public static final long serialVersionUID = 1L;
@@ -76,7 +77,6 @@ public String getProject() {
 	 * <p>Author:Wang Ting/王婷</p>
 	 * @Title: getService
 	 * @return
-	 * @see org.openstack4j.model.compute.Host#getService()
 	 */
 	@Override
 	public String getService() {
@@ -87,7 +87,6 @@ public String getService() {
 	 * <p>Author:Wang Ting/王婷</p>
 	 * @Title: getZone
 	 * @return
-	 * @see org.openstack4j.model.compute.Host#getZone()
 	 */
 	@Override
 	public String getZone() {
@@ -98,7 +97,6 @@ public String getZone() {
 	 * <p>Author:Wang Ting/王婷</p>
 	 * @Title: getHostName
 	 * @return
-	 * @see org.openstack4j.model.compute.Host#getHostName()
 	 */
 	@Override
 	public String getHostName() {
@@ -123,6 +121,7 @@ public String toString() {
 	 * @author Wang Ting/王婷
 	 *
 	 */
+	@Deprecated
 	public static class NovaHostResources extends ListResult<NovaHostResource> {
 
 		private static final long serialVersionUID = 1L;

core/src/main/java/org/openstack4j/openstack/compute/domain/NovaImage.java

@@ -21,6 +21,7 @@
  * @author Jeremy Unruh
  */
 @JsonRootName("image")
+@Deprecated
 public class NovaImage implements Image {
 
 	private static final long serialVersionUID = 1L;
@@ -160,6 +161,7 @@ public String toString() {
 						.toString();
 	}
 
+	@Deprecated
 	public static class NovaImages extends ListResult<NovaImage> {
 
 		private static final long serialVersionUID = 1L;

core/src/main/java/org/openstack4j/openstack/compute/domain/NovaSecGroupExtension.java

@@ -19,6 +19,7 @@
  * @author Jeremy Unruh
  */
 @JsonRootName("security_group")
+@Deprecated
 public class NovaSecGroupExtension implements SecGroupExtension {
 
 	private static final long serialVersionUID = 1L;
@@ -105,7 +106,7 @@ public String toString() {
 				.toString();
 	}
 
-
+	@Deprecated
 	public static class SecurityGroups extends ListResult<NovaSecGroupExtension> {
 
 		private static final long serialVersionUID = 1L;
@@ -123,6 +124,7 @@ protected List<NovaSecGroupExtension> value() {
 	 * Security Group Rule
 	 */
 	@JsonRootName("security_group_rule")
+	@Deprecated
 	public static class SecurityGroupRule implements SecGroupExtension.Rule {
 
 		private static final long serialVersionUID = 1L;
@@ -238,6 +240,7 @@ public static SecurityGroupRuleBuilder builder() {
 			return new RuleConcreteBuilder();
 		}
 
+		@Deprecated
 		public static class RuleConcreteBuilder implements SecurityGroupRuleBuilder
 		{
 
@@ -298,6 +301,7 @@ public SecurityGroupRuleBuilder from(Rule in) {
 		/**
 		 * Security Group Rule -> Group
 		 */
+		@Deprecated
 		public static class RuleGroup implements Group {
 
 			private String name;
@@ -334,6 +338,7 @@ public String toString() {
 		/**
 		 * Security Group Rule -> IP Range
 		 */
+		@Deprecated
 		public static class RuleIpRange implements IpRange {
 
 			private String cidr;

core/src/main/java/org/openstack4j/openstack/compute/domain/ext/ExtDNSEntry.java

@@ -17,6 +17,7 @@
  * @author Jeremy Unruh
  */
 @JsonRootName("dns_entry")
+@Deprecated
 public class ExtDNSEntry implements DNSEntry {
 
     private static final long serialVersionUID = 1L;
@@ -77,6 +78,7 @@ public String toString() {
                  .toString();
     }
 
+    @Deprecated
     public static class DNSEntries extends ListResult<ExtDNSEntry> {
 
         private static final long serialVersionUID = 1L;