Custom properties handling unified. Old methods kept for backwards compatibility, but marked deprecated.

Author: kkorotkov

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/BaseEntity.java

@@ -13,6 +13,7 @@
 package com.labs64.netlicensing.domain.entity;
 
 import java.io.Serializable;
+import java.util.Map;
 
 import javax.ws.rs.core.Form;
 
@@ -21,6 +22,8 @@
  */
 public interface BaseEntity extends Serializable {
 
+    // Methods for working with properties
+
     String getNumber();
 
     void setNumber(String number);
@@ -29,6 +32,14 @@ public interface BaseEntity extends Serializable {
 
     void setActive(Boolean active);
 
+    // Methods for working with custom properties
+
+    Map<String, String> getProperties();
+
+    void addProperty(String property, String value);
+
+    void removeProperty(final String property);
+
     /**
      * Converts properties of the entity to the body of POST request
      *

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/License.java

@@ -64,11 +64,10 @@ public interface License extends BaseEntity {
 
     void setHidden(Boolean hidden);
 
-    Map<String, String> getLicenseProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(String property);
+    @Deprecated
+    Map<String, String> getLicenseProperties();
 
     // Methods for interacting with other entities
 

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/LicenseTemplate.java

@@ -81,11 +81,10 @@ public interface LicenseTemplate extends BaseEntity {
 
     void setHideLicenses(Boolean hideLicenses);
 
-    Map<String, String> getLicenseTemplateProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(String property);
+    @Deprecated
+    Map<String, String> getLicenseTemplateProperties();
 
     // Methods for interacting with other entities
 

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/Licensee.java

@@ -33,14 +33,11 @@
  */
 public interface Licensee extends BaseEntity {
 
-    // Methods for working with properties
+    // Methods for working with custom properties
 
+    @Deprecated
     Map<String, String> getLicenseeProperties();
 
-    void addProperty(String property, String value);
-
-    void removeProperty(String property);
-
     // Methods for interacting with other entities
 
     Product getProduct();

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/PaymentMethod.java

@@ -19,12 +19,9 @@
  */
 public interface PaymentMethod extends BaseEntity {
 
-    // Methods for working with properties
+    // Methods for working with custom properties
 
+    @Deprecated
     Map<String, String> getPaymentMethodProperties();
 
-    void addProperty(String property, String value);
-
-    void removeProperty(String property);
-
 }

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/Product.java

@@ -64,11 +64,10 @@ public interface Product extends BaseEntity {
 
     void setLicensingInfo(String licensingInfo);
 
-    Map<String, String> getProductProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(String property);
+    @Deprecated
+    Map<String, String> getProductProperties();
 
     // Methods for interacting with other entities
 

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/ProductModule.java

@@ -44,11 +44,10 @@ public interface ProductModule extends BaseEntity {
 
     void setLicensingModel(String licensingModel);
 
-    Map<String, String> getProductModuleProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(String property);
+    @Deprecated
+    Map<String, String> getProductModuleProperties();
 
     // Methods for interacting with other entities
 

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/Token.java

@@ -36,10 +36,9 @@ public interface Token extends BaseEntity {
 
     void setTokenType(TokenType tokenType);
 
-    Map<String, String> getTokenProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(String property);
+    @Deprecated
+    Map<String, String> getTokenProperties();
 
 }

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/Transaction.java

@@ -73,10 +73,9 @@ public interface Transaction extends BaseEntity {
 
     void setDateClosed(Date dateClosed);
 
-    Map<String, String> getTransactionProperties();
-
-    void addProperty(String property, String value);
+    // Methods for working with custom properties
 
-    void removeProperty(final String property);
+    @Deprecated
+    Map<String, String> getTransactionProperties();
 
 }

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/impl/BaseEntityImpl.java

@@ -14,6 +14,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -35,6 +36,8 @@ public abstract class BaseEntityImpl extends Visitable implements BaseEntity {
 
     private Boolean active;
 
+    private Map<String, String> properties;
+
     /**
      * List of reserved properties is used for handling of custom properties. Property name that is included in the list
      * can not be used as custom property name. The list is extended by each derived entity class until the final
@@ -71,6 +74,24 @@ public void setActive(final Boolean active) {
         this.active = active;
     }
 
+    @Override
+    public Map<String, String> getProperties() {
+        if (properties == null) {
+            properties = new HashMap<String, String>();
+        }
+        return properties;
+    }
+
+    @Override
+    public void addProperty(final String property, final String value) {
+        getProperties().put(property, value);
+    }
+
+    @Override
+    public void removeProperty(final String property) {
+        getProperties().remove(property);
+    }
+
     @Override
     public String toString() {
         return toString(asPropertiesMap());
@@ -93,6 +114,11 @@ protected Map<String, Object> asPropertiesMap() {
         final Map<String, Object> map = new LinkedHashMap<String, Object>();
         map.put(Constants.NUMBER, getNumber());
         map.put(Constants.ACTIVE, getActive());
+        if (properties != null) {
+            for (final Map.Entry<String, String> lp : properties.entrySet()) {
+                map.put(lp.getKey(), lp.getValue());
+            }
+        }
         return map;
     }