SAK-52031 EntityBroker Remove reflectutils library from codebase

content-review/impl/turnitin/pom.xml

@@ -44,11 +44,6 @@
 			<groupId>org.sakaiproject.common</groupId>
 			<artifactId>sakai-common-api</artifactId>
 		</dependency>
-		<dependency>
-		  <groupId>org.sakaiproject</groupId>
-		  <artifactId>reflectutils</artifactId>
-		  <version>${reflectutils.version}</version>
-		</dependency>
 		<!-- Apache commons dependencies -->
 		<dependency>
 			<groupId>org.apache.poi</groupId>

content-review/impl/turnitin/src/main/java/org/sakaiproject/contentreview/turnitin/util/TurnitinAPIUtil.java

@@ -34,12 +34,13 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Iterator;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Random;
 import java.util.Set;
 import java.util.TimeZone;
-import java.util.Map.Entry;
 
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.HttpsURLConnection;
@@ -50,11 +51,10 @@
 
 import lombok.extern.slf4j.Slf4j;
 
-import org.apache.commons.io.IOUtils;
-
-import org.azeckoski.reflectutils.transcoders.XMLTranscoder;
-
 import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
 
 import org.sakaiproject.content.api.ContentResource;
 import org.sakaiproject.contentreview.exception.SubmissionException;
@@ -177,24 +177,12 @@ public static String getMD5(String md5_string) throws NoSuchAlgorithmException {
 		return md5;
 	}
 
-	public static Map callTurnitinReturnMap(String apiURL, Map<String,Object> parameters, 
-			String secretKey, int timeout, Proxy proxy) throws TransientSubmissionException, SubmissionException 
-	{
-		XMLTranscoder xmlt = new XMLTranscoder();
-
-		try (InputStream inputStream = callTurnitinReturnInputStream(apiURL, parameters, secretKey, timeout, proxy, false)) {
-			Map togo = xmlt.decode(IOUtils.toString(inputStream));
-			log.debug("Turnitin Result Payload: " + togo);
-			return togo;
-		} catch (Exception t) {
-			// Could be 'java.lang.IllegalArgumentException: xml cannot be null or empty' from IO errors
-			throw new TransientSubmissionException ("Cannot parse Turnitin response. Assuming call was unsuccessful", t);
-		}
-	}
-
-	public static Document callTurnitinReturnDocument(String apiURL, Map<String,Object> parameters, 
+	public static Map<String, Object>  callTurnitinReturnMap(String apiURL, Map<String,Object> parameters,
 			String secretKey, int timeout, Proxy proxy) throws TransientSubmissionException, SubmissionException {
-		return callTurnitinReturnDocument(apiURL, parameters, secretKey, timeout, proxy, false);
+		Document document = callTurnitinReturnDocument(apiURL, parameters, secretKey, timeout, proxy, false);
+		Map<String, Object> togo = flattenResponse(document);
+		log.debug("Turnitin Result Payload: {}", togo);
+		return togo;
 	}
 
 	public static String buildTurnitinURL(String apiURL, Map<String,Object> parameters, String secretKey) {
@@ -257,35 +245,89 @@ public static String buildTurnitinURL(String apiURL, Map<String,Object> paramete
 		return sb.toString();
 	}
 
-	public static Document callTurnitinReturnDocument(String apiURL, Map<String,Object> parameters, 
-			String secretKey, int timeout, Proxy proxy, boolean isMultipart) throws TransientSubmissionException, SubmissionException {
-		InputStream inputStream = callTurnitinReturnInputStream(apiURL, parameters, secretKey, timeout, proxy, isMultipart);
+        public static Document callTurnitinReturnDocument(String apiURL, Map<String,Object> parameters,
+                        String secretKey, int timeout, Proxy proxy, boolean isMultipart) throws TransientSubmissionException, SubmissionException {
+                InputStream inputStream = callTurnitinReturnInputStream(apiURL, parameters, secretKey, timeout, proxy, isMultipart);
 
-		BufferedReader in;
-		in = new BufferedReader(new InputStreamReader(inputStream));
 		Document document = null;
-		try {   
+		try (BufferedReader in = new BufferedReader(new InputStreamReader(inputStream))) {
 			DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
-			DocumentBuilder  parser = documentBuilderFactory.newDocumentBuilder();
+			DocumentBuilder parser = documentBuilderFactory.newDocumentBuilder();
 			document = parser.parse(new org.xml.sax.InputSource(in));
-		}
-		catch (ParserConfigurationException pce){
+		} catch (ParserConfigurationException pce) {
 			log.error("parser configuration error: " + pce.getMessage());
-			throw new TransientSubmissionException ("Parser configuration error", pce);
+			throw new TransientSubmissionException("Parser configuration error", pce);
 		} catch (Exception t) {
-			throw new TransientSubmissionException ("Cannot parse Turnitin response. Assuming call was unsuccessful", t);
+			throw new TransientSubmissionException("Cannot parse Turnitin response. Assuming call was unsuccessful", t);
 		}
 
-		if (log.isDebugEnabled()) {
-			log.debug(" Result from call: " + Xml.writeDocumentToString(document));
+			log.debug("Result from call: {}", Xml.writeDocumentToString(document));
+
+			return document;
 		}
 
-		return document;
-	}
+		private static Map<String, Object> flattenResponse(Document document) {
+				Map<String, Object> response = new LinkedHashMap<>();
+				if (document == null) {
+						return response;
+				}
+				Element root = document.getDocumentElement();
+				if (root == null) {
+						return response;
+				}
+				NodeList children = root.getChildNodes();
+				for (int i = 0; i < children.getLength(); i++) {
+						Node node = children.item(i);
+						if (node.getNodeType() != Node.ELEMENT_NODE) {
+								continue;
+						}
+						Element element = (Element) node;
+						mergeValue(response, element.getNodeName(), extractValue(element));
+				}
+				return response;
+		}
+
+		private static Object extractValue(Element element) {
+				NodeList childNodes = element.getChildNodes();
+				List<Element> elementChildren = new ArrayList<>();
+				for (int i = 0; i < childNodes.getLength(); i++) {
+						Node node = childNodes.item(i);
+						if (node.getNodeType() == Node.ELEMENT_NODE) {
+								elementChildren.add((Element) node);
+						}
+				}
+				if (elementChildren.isEmpty()) {
+						String text = element.getTextContent();
+						return text == null ? "" : text.trim();
+				}
+				Map<String, Object> nested = new LinkedHashMap<>();
+				for (Element child : elementChildren) {
+						mergeValue(nested, child.getNodeName(), extractValue(child));
+				}
+				return nested;
+		}
+
+		private static void mergeValue(Map<String, Object> target, String key, Object value) {
+				if (target.containsKey(key)) {
+						Object existing = target.get(key);
+						if (existing instanceof List) {
+								@SuppressWarnings("unchecked")
+								List<Object> list = (List<Object>) existing;
+								list.add(value);
+						} else {
+								List<Object> list = new ArrayList<>();
+								list.add(existing);
+								list.add(value);
+								target.put(key, list);
+						}
+				} else {
+						target.put(key, value);
+				}
+		}
 
-	public static InputStream callTurnitinReturnInputStream(String apiURL, Map<String,Object> parameters, 
-			String secretKey, int timeout, Proxy proxy, boolean isMultipart) throws TransientSubmissionException, SubmissionException {
-		InputStream togo = null;
+		public static InputStream callTurnitinReturnInputStream(String apiURL, Map<String,Object> parameters,
+						String secretKey, int timeout, Proxy proxy, boolean isMultipart) throws TransientSubmissionException, SubmissionException {
+				InputStream togo = null;
 
 		StringBuilder apiDebugSB = new StringBuilder();
 

docker/tomcat/conf/catalina.properties

@@ -564,7 +564,6 @@ reactive-streams-*.jar,\
 reactor-core-*.jar,\
 recaptcha4j-*.jar,\
 recordrtc-*.jar,\
-reflectutils-*.jar,\
 regenerator-runtime-*.jar,\
 rhino-*.jar,\
 rome-*.jar,\

entitybroker/api/src/java/org/sakaiproject/entitybroker/entityprovider/extension/EntityData.java

@@ -225,11 +225,18 @@ public boolean isDataOnly() {
         return dataOnly;
     }
 
+    /**
+     * No-arg constructor required for serialization
+     */
+    public EntityData() {
+        // Default constructor for serialization frameworks
+    }
+
     /**
      * Minimal constructor - used for most basic cases<br/>
      * Use the setters to add in properties or the entity if desired
-     * 
-     * @param reference a globally unique reference to an entity, 
+     *
+     * @param reference a globally unique reference to an entity,
      * consists of the entity prefix and id (e.g. /prefix/id)
      * @param entityDisplayTitle a string which is suitable for display and provides a short summary of the entity,
      * typically 100 chars or less, this may be the name or title of the entity represented by an entity

entitybroker/core-providers/pom.xml

@@ -34,10 +34,6 @@
             <groupId>org.sakaiproject.profile2</groupId>
             <artifactId>profile2-api</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.sakaiproject</groupId>
-            <artifactId>reflectutils</artifactId>
-        </dependency>
         <dependency>
             <groupId>org.sakaiproject.edu-services.course-management</groupId>
             <artifactId>coursemanagement-api</artifactId>

entitybroker/core-providers/src/java/org/sakaiproject/entitybroker/providers/SiteEntityProvider.java

@@ -15,6 +15,7 @@
  */
 package org.sakaiproject.entitybroker.providers;
 
+import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -34,8 +35,6 @@
 
 import org.apache.commons.lang3.StringUtils;
 
-import org.azeckoski.reflectutils.ReflectUtils;
-
 import org.sakaiproject.authz.api.AuthzGroup;
 import org.sakaiproject.authz.api.AuthzGroupService;
 import org.sakaiproject.authz.api.AuthzPermissionException;
@@ -90,6 +89,7 @@
 import org.sakaiproject.tool.api.Tool;
 import org.sakaiproject.util.api.FormattedText;
 import org.sakaiproject.util.comparator.AlphaNumericComparator;
+import org.springframework.util.ReflectionUtils;
 
 
 /**
@@ -121,6 +121,19 @@ public String getEntityPrefix() {
         return PREFIX;
     }
 
+    private void setCreatedUserId(Site site, String ownerId) {
+        Field field = ReflectionUtils.findField(site.getClass(), "m_createdUserId");
+        if (field == null) {
+            throw new IllegalStateException("Unable to locate the site owner field");
+        }
+        ReflectionUtils.makeAccessible(field);
+        try {
+            ReflectionUtils.setField(field, site, ownerId);
+        } catch (IllegalArgumentException e) {
+            throw new IllegalStateException("Unable to set the site owner field", e);
+        }
+    }
+
     private static final String GROUP_PROP_WSETUP_CREATED = "group_prop_wsetup_created";
 
     /** Property to set the default page size for lists of entities. */
@@ -855,7 +868,7 @@ public String createEntity(EntityReference ref, Object entity, Map<String, Objec
                 if (ownerID == null) {
                     throw new IllegalArgumentException("Invalid userId supplied for owner of site: " + ownerID);
                 }
-                ReflectUtils.getInstance().setFieldValue(s, "m_createdUserId", ownerID);
+                setCreatedUserId(s, ownerID);
             }
 
             // attempt to set provider ID as requested. rules are:
@@ -1093,7 +1106,7 @@ public void updateEntity(EntityReference ref, Object entity, Map<String, Object>
                     throw new IllegalArgumentException(
                             "Invalid userId supplied for owner of site: " + site.getOwner());
                 }
-                ReflectUtils.getInstance().setFieldValue(s, "m_createdUserId", ownerUserId);
+                setCreatedUserId(s, ownerUserId);
             }
 
             // new publish status

entitybroker/core-providers/src/java/org/sakaiproject/entitybroker/providers/UserEntityProvider.java

@@ -15,6 +15,7 @@
  */
 package org.sakaiproject.entitybroker.providers;
 
+import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -24,9 +25,6 @@
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
 
-import org.azeckoski.reflectutils.FieldUtils;
-import org.azeckoski.reflectutils.ReflectUtils;
-
 import org.sakaiproject.component.api.ServerConfigurationService;
 import org.sakaiproject.entity.api.ResourcePropertiesEdit;
 import org.sakaiproject.entitybroker.DeveloperHelperService;
@@ -52,6 +50,7 @@
 import org.sakaiproject.user.api.UserLockedException;
 import org.sakaiproject.user.api.UserNotDefinedException;
 import org.sakaiproject.user.api.UserPermissionException;
+import org.springframework.util.ReflectionUtils;
 
 /**
  * Entity Provider for users
@@ -383,16 +382,16 @@ private boolean isUsingSameIdEid() {
             String config = developerHelperService.getConfigurationSetting("[email protected]", (String)null);
             if (config != null) {
                 try {
-                    usesSeparateIdEid = ReflectUtils.getInstance().convert(config, Boolean.class);
-                } catch (UnsupportedOperationException e) {
+                    usesSeparateIdEid = parseBoolean(config);
+                } catch (IllegalArgumentException e) {
                     // oh well
                     usesSeparateIdEid = null;
                 }
             }
             if (usesSeparateIdEid == null) {
                 // could not get the stupid setting so attempt to check the service itself
                 try {
-                    usesSeparateIdEid = FieldUtils.getInstance().getFieldValue(userDirectoryService, "m_separateIdEid", Boolean.class);
+                    usesSeparateIdEid = readBooleanField(userDirectoryService, "m_separateIdEid");
                 } catch (RuntimeException e) {
                     // no luck here
                     usesSeparateIdEid = null;
@@ -403,6 +402,43 @@ private boolean isUsingSameIdEid() {
         return ! usesSeparateIdEid.booleanValue();
     }
 
+    private Boolean readBooleanField(Object target, String fieldName) {
+        Field field = ReflectionUtils.findField(target.getClass(), fieldName);
+        if (field == null) {
+            return null;
+        }
+        ReflectionUtils.makeAccessible(field);
+        try {
+            Object value = ReflectionUtils.getField(field, target);
+            if (value instanceof Boolean) {
+                return (Boolean) value;
+            }
+            if (value instanceof String) {
+                return parseBoolean((String) value);
+            }
+            return (value != null) ? Boolean.valueOf(value.toString()) : null;
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+
+    private Boolean parseBoolean(String value) {
+        if (value == null) {
+            return null;
+        }
+        String normalized = value.trim();
+        if (normalized.isEmpty()) {
+            return null;
+        }
+        if ("true".equalsIgnoreCase(normalized)) {
+            return Boolean.TRUE;
+        }
+        if ("false".equalsIgnoreCase(normalized)) {
+            return Boolean.FALSE;
+        }
+        throw new IllegalArgumentException("Value is not a boolean: " + value);
+    }
+
     /**
      * Will check that a userId/eid is valid and will produce a valid userId from the check
      *