use Error push/pop and throw Errors over Exceptions

Author: dcrissman

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/EntryBuilder.java

@@ -79,9 +79,10 @@ protected void translate(SimpleField field, JsonNode node, Entry target) {
         String attributeName = fieldNameTranslator.translateFieldName(field.getFullPath());
 
         if(LdapConstant.ATTRIBUTE_DN.equalsIgnoreCase(attributeName)){
-            throw new IllegalArgumentException(
-                    "'dn' should not be included as it's value will be derived from the metadata.basedn and" +
-                    " the metadata.uniqueattr. Including the 'dn' as an insert attribute is confusing.");
+            throw Error.get("Invalid Field Definition", "'" + LdapConstant.ATTRIBUTE_DN + "' should not be included as its value will be"
+                    + " derived from the metadata.basedn and"
+                    + " the metadata.uniqueattr. Including the '" + LdapConstant.ATTRIBUTE_DN
+                    + "' as an insert attribute is confusing.");
         }
         else if(LightblueUtil.isFieldObjectType(attributeName)
                 || LightblueUtil.isFieldAnArrayCount(attributeName, getEntityMetadata().getFields())){

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/LdapCRUDController.java

@@ -128,7 +128,7 @@ public CRUDInsertionResponse insert(CRUDOperationContext ctx,
             Path uniqueFieldPath = fieldNameTranslator.translateAttributeName(store.getUniqueAttribute());
             JsonNode uniqueNode = document.get(uniqueFieldPath);
             if(uniqueNode == null){
-                throw new IllegalArgumentException(store.getUniqueAttribute() + " is a required field");
+                throw Error.get("Required Field", store.getUniqueAttribute());
             }
 
             String dn = createDN(store, uniqueNode.asText());

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/TranslatorFromJson.java

@@ -36,7 +36,6 @@
 import com.redhat.lightblue.util.Error;
 import com.redhat.lightblue.util.JsonDoc;
 import com.redhat.lightblue.util.JsonNodeCursor;
-import com.redhat.lightblue.util.Path;
 
 /**
  * Defines a class that translates lightblue json nodes into
@@ -95,12 +94,11 @@ public void translate(JsonDoc document, T target){
      * @param target - T
      */
     protected void translate(JsonNodeCursor cursor, T target){
-        Path path = cursor.getCurrentPath();
         JsonNode node = cursor.getCurrentNode();
-        FieldTreeNode fieldNode = md.resolve(path);
+        FieldTreeNode fieldNode = md.resolve(cursor.getCurrentPath());
 
         if (fieldNode == null) {
-            throw new NullPointerException("No Metadata field found for: " + path.toString());
+            throw Error.get("Metadata Not Found", cursor.getCurrentPath().toString());
         }
 
         Error.push(fieldNode.getFullPath().getLast());
@@ -118,7 +116,7 @@ else if (fieldNode instanceof ReferenceField) {
             translate((ReferenceField) fieldNode, node, target);
         }
         else{
-            throw new UnsupportedOperationException("Field type is not supported: " + fieldNode.getClass().getName());
+            throw Error.get("Unsupported Feature: " + fieldNode.getClass().getName(), fieldNode.getFullPath().toString());
         }
 
         Error.pop();
@@ -143,7 +141,7 @@ else if(arrayElement instanceof ObjectArrayElement){
             translateObjectArray(field, cursor, target);
         }
         else{
-            throw new UnsupportedOperationException("ArrayElement type is not supported: " + arrayElement.getClass().getName());
+            throw Error.get("Unsupported Feature: " + arrayElement.getClass().getName(), field.getFullPath().toString());
         }
 
         cursor.parent();

lightblue-ldap-crud/src/test/java/com/redhat/lightblue/crud/ldap/EntryBuilderTest.java

@@ -32,6 +32,7 @@
 
 import javax.xml.bind.DatatypeConverter;
 
+import org.junit.After;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -49,6 +50,7 @@
 import com.redhat.lightblue.metadata.EntityMetadata;
 import com.redhat.lightblue.metadata.types.DateType;
 import com.redhat.lightblue.test.MetadataUtil;
+import com.redhat.lightblue.util.Error;
 import com.redhat.lightblue.util.JsonDoc;
 import com.unboundid.ldap.sdk.Entry;
 import com.unboundid.util.StaticUtils;
@@ -81,6 +83,11 @@ public static class SpecializedTests {
         @Rule
         public ExpectedException expectedEx = ExpectedException.none();
 
+        @After
+        public void after(){
+            Error.reset();
+        }
+
         @Test
         public void testFieldIsObjectType() throws Exception{
             Entry entry = buildEntry(LightblueUtil.FIELD_OBJECT_TYPE, "{\"type\": \"string\"}", quote("someEntity"));
@@ -134,8 +141,14 @@ public void testObjectArrayField_ThrowsException() throws Exception{
                     "1," + quote(arrayFieldName) + ":[{\"someField\":\"hello\"}]");
         }
 
-        @Test(expected = IllegalArgumentException.class)
+        /**
+         * DN fields should never be defined as they are technically not attributes.
+         */
+        @Test
         public void testFieldIsDN() throws Exception{
+            expectedEx.expect(com.redhat.lightblue.util.Error.class);
+            expectedEx.expectMessage("{\"objectType\":\"error\",\"context\":\"dn=uid=someuid,dc=example,dc=com/dn\",\"errorCode\":\"Invalid Field Definition\",\"msg\":\"'dn' should not be included as its value will be derived from the metadata.basedn and the metadata.uniqueattr. Including the 'dn' as an insert attribute is confusing.\"}");
+
             buildEntry(LdapConstant.ATTRIBUTE_DN, "{\"type\": \"string\"}", quote("uid=someuid,dc=example,dc=com"));
         }
 
@@ -167,6 +180,11 @@ public static Collection<Object[]> data() {
             });
         }
 
+        @After
+        public void after(){
+            Error.reset();
+        }
+
         private final String fieldName = "testfield";
         private final String metadataType;
         private final String crudValue;