Add restrictions field to metadata (#312)

adimiz1 · web-flow · commit 923594a12484 · 2024-03-06T13:04:20.000+02:00
diff --git a/cloudinary-core/src/main/java/com/cloudinary/metadata/MetadataField.java b/cloudinary-core/src/main/java/com/cloudinary/metadata/MetadataField.java
@@ -16,6 +16,7 @@ public class MetadataField<T> extends JSONObject {
     public static final String MANDATORY = "mandatory";
     public static final String TYPE = "type";
     public static final String VALIDATION = "validation";
+    public static final String RESTRICTIONS = "restrictions";
 
     public MetadataField(MetadataFieldType type) {
         put(TYPE, type.toString());
@@ -130,4 +131,12 @@ public MetadataDataSource getDataSource() {
     public void setDataSource(MetadataDataSource dataSource) {
         put("datasource", dataSource);
     }
+
+    /**
+     * Set the restrictions rules of this field.
+     * @param restrictions The rules to set.
+     */
+    public void setRestrictions(Restrictions restrictions) {
+        put(RESTRICTIONS, restrictions.toHash());
+    }
 }
diff --git a/cloudinary-core/src/main/java/com/cloudinary/metadata/Restrictions.java b/cloudinary-core/src/main/java/com/cloudinary/metadata/Restrictions.java
@@ -0,0 +1,40 @@
+package com.cloudinary.metadata;
+
+import java.util.HashMap;
+
+/**
+ * Represents the restrictions metadata field.
+ */
+public class Restrictions {
+
+    private final HashMap restrictions = new HashMap();
+
+    /**
+     * Set the custom field into restrictions.
+     * @param key The key of the field.
+     * @param value The value of the field.
+     */
+    public Restrictions setRestriction(String key, Object value) {
+        restrictions.put(key, value);
+        return this;
+    }
+
+    /**
+     * Set the read only ui field.
+     * @param value The read only ui value.
+     */
+    public Restrictions setReadOnlyUI(Boolean value) {
+        return setRestriction("readonly_ui", value);
+    }
+
+    /**
+     * Set the read only ui field to true.
+     */
+    public Restrictions setReadOnlyUI() {
+        return this.setReadOnlyUI(true);
+    }
+
+    public HashMap toHash() {
+        return restrictions;
+    }
+}
diff --git a/cloudinary-test-common/src/main/java/com/cloudinary/test/AbstractStructuredMetadataTest.java b/cloudinary-test-common/src/main/java/com/cloudinary/test/AbstractStructuredMetadataTest.java
@@ -72,6 +72,18 @@ public void testCreateMetadata() throws Exception {
         assertEquals(setField.getLabel(), result.get("label"));
     }
 
+    @Test
+    public void testFieldRestrictions() throws Exception {
+        StringMetadataField stringField = newFieldInstance("testCreateMetadata_3");
+        stringField.setRestrictions(new Restrictions().setReadOnlyUI());
+
+        ApiResponse result = api.addMetadataField(stringField);
+        assertNotNull(result);
+        Map<String, Object> restrictions = (Map<String, Object>) result.get("restrictions");
+        assertNotNull(restrictions);
+        assertTrue((Boolean) restrictions.get("readonly_ui"));
+    }
+
     @Test
     public void testDateFieldDefaultValueValidation() throws Exception {
         // now minus 3 days hours.
@@ -130,13 +142,17 @@ public void testGetMetadata() throws Exception {
 
     @Test
     public void testUpdateField() throws Exception {
-        ApiResponse fieldResult = addFieldToAccount(newFieldInstance("testUpdateField"));
+        StringMetadataField metadataField = newFieldInstance("testUpdateField");
+        ApiResponse fieldResult = addFieldToAccount(metadataField);
         assertNotEquals("new_def", fieldResult.get("default_value"));
-        StringMetadataField field = new StringMetadataField();
-        field.setDefaultValue("new_def");
-        ApiResponse result = api.updateMetadataField(fieldResult.get("external_id").toString(), field);
+        metadataField.setDefaultValue("new_def");
+        metadataField.setRestrictions(new Restrictions().setReadOnlyUI());
+        ApiResponse result = api.updateMetadataField(fieldResult.get("external_id").toString(), metadataField);
         assertNotNull(result);
         assertEquals("new_def", result.get("default_value"));
+        Map<String, Object> restrictions = (Map<String, Object>) result.get("restrictions");
+        assertNotNull(restrictions);
+        assertTrue((Boolean)restrictions.get("readonly_ui"));
     }
 
     @Test
