rename LdapMetadataProperty: to something more meaningful

Author: dcrissman

lightblue-ldap-common/src/main/java/com/redhat/lightblue/common/ldap/LdapMetadataProperty.java renamed to lightblue-ldap-common/src/main/java/com/redhat/lightblue/common/ldap/LdapFieldNameTranslator.java

@@ -19,11 +19,11 @@
 package com.redhat.lightblue.common.ldap;
 
 /**
- * Represents a class that can provide information about the LDAP metadata property.
+ * Represents a class that can translate back and forth between a fieldName and an LDAP attributeName.
  *
  * @author dcrissman
  */
-public interface LdapMetadataProperty {
+public interface LdapFieldNameTranslator {
 
     /**
      * Returns the attributeName with the given fieldName.

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

@@ -24,7 +24,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.redhat.lightblue.common.ldap.LdapConstant;
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 import com.redhat.lightblue.common.ldap.LightblueUtil;
 import com.redhat.lightblue.metadata.ArrayElement;
 import com.redhat.lightblue.metadata.ArrayField;
@@ -47,11 +47,12 @@
  */
 public class EntryBuilder extends TranslatorFromJson<Entry>{
 
-    private final LdapMetadataProperty property;
+    private final LdapFieldNameTranslator fieldNameTranslator
+    ;
 
-    public EntryBuilder(EntityMetadata md, LdapMetadataProperty property){
+    public EntryBuilder(EntityMetadata md, LdapFieldNameTranslator fieldNameTranslator){
         super(md);
-        this.property = property;
+        this.fieldNameTranslator = fieldNameTranslator;
     }
 
     public Entry build(String dn, JsonDoc document){
@@ -75,7 +76,7 @@ else if(type instanceof BinaryType){
 
     @Override
     protected void translate(SimpleField field, Path path, JsonNode node, Entry target) {
-        String attributeName = property.translateFieldName(field.getName());
+        String attributeName = fieldNameTranslator.translateFieldName(field.getName());
 
         if(LdapConstant.ATTRIBUTE_DN.equalsIgnoreCase(attributeName)){
             throw new IllegalArgumentException(
@@ -110,7 +111,7 @@ protected void translate(ObjectField field, Path path, JsonNode node, Entry targ
     protected void translateSimpleArray(ArrayField field, Path path, List<Object> items, Entry target) {
         ArrayElement arrayElement = field.getElement();
         Type arrayElementType = arrayElement.getType();
-        String attributeName = property.translateFieldName(field.getName());
+        String attributeName = fieldNameTranslator.translateFieldName(field.getName());
 
         if(arrayElementType instanceof BinaryType){
             List<byte[]> bytes = new ArrayList<byte[]>();

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

@@ -33,7 +33,7 @@
 import com.redhat.lightblue.common.ldap.DBResolver;
 import com.redhat.lightblue.common.ldap.LdapConstant;
 import com.redhat.lightblue.common.ldap.LdapDataStore;
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 import com.redhat.lightblue.common.ldap.LightblueUtil;
 import com.redhat.lightblue.crud.CRUDController;
 import com.redhat.lightblue.crud.CRUDDeleteResponse;
@@ -44,7 +44,7 @@
 import com.redhat.lightblue.crud.CRUDUpdateResponse;
 import com.redhat.lightblue.crud.CrudConstants;
 import com.redhat.lightblue.crud.DocCtx;
-import com.redhat.lightblue.crud.ldap.model.NullLdapMetadataPropertyImpl;
+import com.redhat.lightblue.crud.ldap.model.NullLdapFieldNameTranslator;
 import com.redhat.lightblue.crud.ldap.translator.FilterTranslator;
 import com.redhat.lightblue.crud.ldap.translator.ResultTranslator;
 import com.redhat.lightblue.crud.ldap.translator.SortTranslator;
@@ -107,7 +107,7 @@ public CRUDInsertionResponse insert(CRUDOperationContext ctx,
 
         EntityMetadata md = ctx.getEntityMetadata(ctx.getEntityName());
         LdapDataStore store = getLdapDataStore(md);
-        LdapMetadataProperty property = getLdapMetadataProperty(md);
+        LdapFieldNameTranslator property = getLdapFieldNameTranslator(md);
 
         FieldAccessRoleEvaluator roles = new FieldAccessRoleEvaluator(md, ctx.getCallerRoles());
         EntryBuilder entryBuilder = new EntryBuilder(md, property);
@@ -208,7 +208,7 @@ public CRUDFindResponse find(CRUDOperationContext ctx,
 
         LDAPConnection connection = getNewLdapConnection(store);
 
-        LdapMetadataProperty property = getLdapMetadataProperty(md);
+        LdapFieldNameTranslator property = getLdapFieldNameTranslator(md);
 
         try {
             //TODO: Support scopes other than SUB
@@ -281,7 +281,7 @@ public void beforeUpdateEntityInfo(Metadata m, EntityInfo ei, boolean newEntity)
              */
             @Override
             public void beforeCreateNewSchema(Metadata m, EntityMetadata md) {
-                LdapMetadataProperty property = getLdapMetadataProperty(md);
+                LdapFieldNameTranslator property = getLdapFieldNameTranslator(md);
 
                 Fields fields = md.getEntitySchema().getFields();
                 String dnFieldName = property.translateAttributeName(LdapConstant.ATTRIBUTE_DN);
@@ -325,23 +325,23 @@ private LdapDataStore getLdapDataStore(EntityMetadata md){
     }
 
     /**
-     * Shortcut method to get and return the {@link LdapMetadataProperty} on the passed
+     * Shortcut method to get and return the {@link LdapFieldNameTranslator} on the passed
      * in {@link EntityMetadata}.
      * @param md - {@link EntityMetadata}.
-     * @return {@link LdapMetadataProperty}
+     * @return {@link LdapFieldNameTranslator}
      * @throws IllegalArgumentException if an invalid object is found.
      */
-    private LdapMetadataProperty getLdapMetadataProperty(EntityMetadata md){
+    private LdapFieldNameTranslator getLdapFieldNameTranslator(EntityMetadata md){
         Object o = md.getEntityInfo().getProperties().get(LdapConstant.BACKEND);
 
         if(o == null){
-            return new NullLdapMetadataPropertyImpl();
+            return new NullLdapFieldNameTranslator();
         }
 
-        if(!(o instanceof LdapMetadataProperty)){
+        if(!(o instanceof LdapFieldNameTranslator)){
             throw new IllegalArgumentException("Object of type " + o.getClass() + " is not supported.");
         }
-        return (LdapMetadataProperty) o;
+        return (LdapFieldNameTranslator) o;
     }
 
     /**
@@ -395,11 +395,11 @@ private Set<String> gatherRequiredFields(EntityMetadata md,
     /**
      * Translates a <code>Collection</code> of fieldNames into a <code>Set</code> of
      * attributeNames
-     * @param property - {@link LdapMetadataProperty}.
+     * @param property - {@link LdapFieldNameTranslator}.
      * @param fieldNames - <code>Collection</code> of fieldNames to translated
      * @return <code>Set</code> of translated attributeNames.
      */
-    private Set<String> translateFieldNames(LdapMetadataProperty property, Collection<String> fieldNames){
+    private Set<String> translateFieldNames(LdapFieldNameTranslator property, Collection<String> fieldNames){
         Set<String> attributes = new HashSet<String>();
         for(String fieldName : fieldNames){
             attributes.add(property.translateFieldName(fieldName));
@@ -422,7 +422,7 @@ private void projectChanges(Projection projection, CRUDOperationContext ctx, Map
 
         EntityMetadata md = ctx.getEntityMetadata(ctx.getEntityName());
         JsonNodeFactory factory = ctx.getFactory().getNodeFactory();
-        LdapMetadataProperty property = getLdapMetadataProperty(md);
+        LdapFieldNameTranslator property = getLdapFieldNameTranslator(md);
 
         Set<String> requiredAttributeNames = translateFieldNames(property, gatherRequiredFields(md, projection, null, null));
         Projector projector = Projector.getInstance(

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/model/NullLdapMetadataPropertyImpl.java renamed to lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/model/NullLdapFieldNameTranslator.java

@@ -18,15 +18,15 @@
  */
 package com.redhat.lightblue.crud.ldap.model;
 
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 
 /**
- * An implementation of {@link LdapMetadataProperty} used by crud when
+ * An implementation of {@link LdapFieldNameTranslator} used by crud when
  * no other implementation can be found.
  *
  * @author dcrissman
  */
-public class NullLdapMetadataPropertyImpl implements LdapMetadataProperty{
+public class NullLdapFieldNameTranslator implements LdapFieldNameTranslator{
 
     @Override
     public String translateFieldName(String fieldName) {

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/translator/FilterTranslator.java

@@ -21,7 +21,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 import com.redhat.lightblue.query.ArrayContainsExpression;
 import com.redhat.lightblue.query.ArrayMatchExpression;
 import com.redhat.lightblue.query.FieldComparisonExpression;
@@ -41,10 +41,10 @@
  */
 public class FilterTranslator {
 
-    private final LdapMetadataProperty property;
+    private final LdapFieldNameTranslator fieldNameTranslator;
 
-    public FilterTranslator(LdapMetadataProperty property){
-        this.property = property;
+    public FilterTranslator(LdapFieldNameTranslator fieldNameTranslator){
+        this.fieldNameTranslator = fieldNameTranslator;
     }
 
     /**
@@ -86,7 +86,7 @@ else if (query instanceof ValueComparisonExpression){
     }
 
     private Filter translate(ArrayContainsExpression query){
-        String attributeName = property.translateFieldName(query.getArray().toString());
+        String attributeName = fieldNameTranslator.translateFieldName(query.getArray().toString());
 
         List<Filter> filters = new ArrayList<Filter>();
         for(Value value : query.getValues()){
@@ -131,7 +131,7 @@ private Filter translate(NaryLogicalExpression query){
     }
 
     private Filter translate(NaryRelationalExpression query){
-        String attributeName = property.translateFieldName(query.getField().toString());
+        String attributeName = fieldNameTranslator.translateFieldName(query.getField().toString());
         List<Filter> filters = new ArrayList<Filter>();
         for(Value value : query.getValues()){
             filters.add(Filter.createEqualityFilter(attributeName, value.getValue().toString()));
@@ -162,7 +162,7 @@ private Filter translate(UnaryLogicalExpression query){
     }
 
     private Filter translate(ValueComparisonExpression query){
-        String attributeName = property.translateFieldName(query.getField().toString());
+        String attributeName = fieldNameTranslator.translateFieldName(query.getField().toString());
         String rValue = query.getRvalue().getValue().toString();
 
         switch(query.getOp()){

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/translator/ResultTranslator.java

@@ -23,7 +23,7 @@
 import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.redhat.lightblue.common.ldap.LdapConstant;
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 import com.redhat.lightblue.common.ldap.LightblueUtil;
 import com.redhat.lightblue.crud.DocCtx;
 import com.redhat.lightblue.metadata.ArrayField;
@@ -53,12 +53,12 @@ public class ResultTranslator {
 
     private final JsonNodeFactory factory;
     private final EntityMetadata md;
-    private final LdapMetadataProperty property;
+    private final LdapFieldNameTranslator fieldNameTranslator;
 
-    public ResultTranslator(JsonNodeFactory factory, EntityMetadata md, LdapMetadataProperty property){
+    public ResultTranslator(JsonNodeFactory factory, EntityMetadata md, LdapFieldNameTranslator fieldNameTranslator){
         this.factory = factory;
         this.md = md;
-        this.property = property;
+        this.fieldNameTranslator = fieldNameTranslator;
     }
 
     public DocCtx translate(SearchResultEntry entry){
@@ -75,7 +75,7 @@ public DocCtx translate(SearchResultEntry entry){
 
     private JsonNode toJson(SearchResultEntry entry, FieldCursor fieldCursor, String entityName, Fields fields){
         ObjectNode node = factory.objectNode();
-        String dnFieldName = property.translateAttributeName(LdapConstant.ATTRIBUTE_DN);
+        String dnFieldName = fieldNameTranslator.translateAttributeName(LdapConstant.ATTRIBUTE_DN);
 
         do {
             FieldTreeNode field = fieldCursor.getCurrentNode();
@@ -92,7 +92,7 @@ else if(dnFieldName.equalsIgnoreCase(fieldName)){
                 continue;
             }
 
-            String attributeName = property.translateFieldName(fieldName);
+            String attributeName = fieldNameTranslator.translateFieldName(fieldName);
             Attribute attr = entry.getAttribute(attributeName);
 
             JsonNode value = null;

lightblue-ldap-crud/src/main/java/com/redhat/lightblue/crud/ldap/translator/SortTranslator.java

@@ -21,7 +21,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import com.redhat.lightblue.common.ldap.LdapMetadataProperty;
+import com.redhat.lightblue.common.ldap.LdapFieldNameTranslator;
 import com.redhat.lightblue.query.CompositeSortKey;
 import com.redhat.lightblue.query.Sort;
 import com.redhat.lightblue.query.SortKey;
@@ -34,10 +34,10 @@
  */
 public class SortTranslator {
 
-    private final LdapMetadataProperty property;
+    private final LdapFieldNameTranslator fieldNameTranslator;
 
-    public SortTranslator(LdapMetadataProperty property){
-        this.property = property;
+    public SortTranslator(LdapFieldNameTranslator fieldNameTranslator){
+        this.fieldNameTranslator = fieldNameTranslator;
     }
 
     public com.unboundid.ldap.sdk.controls.SortKey[] translate(Sort sort){
@@ -58,7 +58,7 @@ private void doTranslate(Sort sort, List<com.unboundid.ldap.sdk.controls.SortKey
         }
         else if(sort instanceof SortKey){
             SortKey key = (SortKey) sort;
-            results.add(new com.unboundid.ldap.sdk.controls.SortKey(property.translateFieldName(key.getField().getLast()), key.isDesc()));
+            results.add(new com.unboundid.ldap.sdk.controls.SortKey(fieldNameTranslator.translateFieldName(key.getField().getLast()), key.isDesc()));
         }
         else{
             throw new IllegalArgumentException("Unsupported Sort type: " + sort.getClass().getName());

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

@@ -43,7 +43,7 @@
 import com.redhat.lightblue.common.ldap.LightblueUtil;
 import com.redhat.lightblue.crud.ldap.EntryBuilderTest.ParameterizedTests;
 import com.redhat.lightblue.crud.ldap.EntryBuilderTest.SpecializedTests;
-import com.redhat.lightblue.crud.ldap.model.NullLdapMetadataPropertyImpl;
+import com.redhat.lightblue.crud.ldap.model.NullLdapFieldNameTranslator;
 import com.redhat.lightblue.metadata.EntityMetadata;
 import com.redhat.lightblue.metadata.types.DateType;
 import com.redhat.lightblue.test.MetadataUtil;
@@ -64,7 +64,7 @@ protected static Entry buildEntry(String fieldName, String metadataType, String
                 .replaceFirst("#value", crudValue);
 
         EntityMetadata md = MetadataUtil.createEntityMetadata(LdapConstant.BACKEND, json(metadata), null, null);
-        EntryBuilder builder = new EntryBuilder(md, new NullLdapMetadataPropertyImpl());
+        EntryBuilder builder = new EntryBuilder(md, new NullLdapFieldNameTranslator());
 
         return builder.build("uid=someuid,dc=example,dc=com",
                 new JsonDoc(json(crud).get("data")));

lightblue-ldap-crud/src/test/java/com/redhat/lightblue/crud/ldap/model/NullLdapMetadataPropertyImplTest.java renamed to lightblue-ldap-crud/src/test/java/com/redhat/lightblue/crud/ldap/model/NullLdapFieldNameTranslatorTest.java

@@ -22,18 +22,18 @@
 
 import org.junit.Test;
 
-public class NullLdapMetadataPropertyImplTest {
+public class NullLdapFieldNameTranslatorTest {
 
     @Test
     public void testTranslateFieldName(){
         String fieldName = "fakeFieldName";
-        assertEquals(fieldName, new NullLdapMetadataPropertyImpl().translateFieldName(fieldName));
+        assertEquals(fieldName, new NullLdapFieldNameTranslator().translateFieldName(fieldName));
     }
 
     @Test
     public void testTranslateAttributeName(){
         String attributeName = "fakeAttributeName";
-        assertEquals(attributeName, new NullLdapMetadataPropertyImpl().translateAttributeName(attributeName));
+        assertEquals(attributeName, new NullLdapFieldNameTranslator().translateAttributeName(attributeName));
     }
 
 }