rename classes

Author: destan

src/main/java/com/kodgemisi/cigdem/databasebasedmessagesource/BundleEntity.java

@@ -0,0 +1,134 @@
+package com.kodgemisi.cigdem.databasebasedmessagesource;
+
+import java.io.Serializable;
+import java.util.Comparator;
+
+/**
+ * <p>You should provide an implementation of this interface as an {@link javax.persistence.Entity} when using {@link JpaBundleContentLoaderStrategy}.</p>
+ *
+ * <p>The implementation class should satisfy following conditions:</p>
+ *
+ * <ul>
+ *   <li>Should have {@link javax.persistence.Entity} annotation.</li>
+ *   <li>
+ *     Should have unique key constraint for {@code "baseName", "key", "language", "country", "variant"} columns.
+ *     <ul>
+ *       <li>You can achieve that by using: {@code @Table(uniqueConstraints = { @UniqueConstraint(columnNames = { "baseName", "key", "language", "country", "variant" }) })}</li>
+ *     </ul>
+ *   </li>
+ *   <li>You should not enable second level JPA cache for this entity.</li>
+ * </ul>
+ *
+ * <p>
+ *     You can optionally use {@link com.kodgemisi.cigdem.databaseresourcbundle.BundleContentLoaderStrategy#DEFAULT_TABLE_NAME} as table name.
+ * 	In which case the database setup would be compatible with {@link com.kodgemisi.cigdem.databaseresourcbundle.DefaultBundleContentLoaderStrategy} as well.
+ * </p>
+ *
+ * Created on January, 2018
+ *
+ * @author destans
+ */
+public interface BundleItem extends Comparable<BundleItem> {
+
+	Comparator<String> keyComparator = (s1, s2) -> {
+		final int s1DotCount = StringUtil.countMatches(s1, '.');
+		final int s2DotCount = StringUtil.countMatches(s2, '.');
+
+		if (s1DotCount == s2DotCount) {
+			return s1.compareTo(s2);
+		}
+		return Integer.compare(s1DotCount, s2DotCount);
+	};
+
+	String getKey();
+
+	String getValue();
+
+	String getBaseName();
+
+	String getLanguage();
+
+	String getCountry();
+
+	String getVariant();
+
+	// This returns a boxed long because this interface is supposed to be implemented by a JPA entity among other things.
+	Long getLastModified();
+
+	default String getName() {
+		final String baseName = getBaseName();
+		final String language = StringUtil.getNamePart(getLanguage());
+		final String country = StringUtil.getNamePart(getCountry());
+		final String variant = StringUtil.getNamePart(getVariant());
+		return baseName + language + country + variant;
+	}
+
+	default int compareTo(BundleItem bundleItem) {
+
+		if (bundleItem == null) {
+			return -1;
+		}
+
+		if (this.equals(bundleItem)) {
+			return 0;
+		}
+
+		//FIXME objects with empty lang, country or variant should have lesser index
+		return this.getKey().compareTo(bundleItem.getKey());
+	}
+
+	/**
+	 * This class is indented to be used in a JPA entity as a composite id with {@code @IdClass(BundleItem.CompositeId.class)}
+	 *
+	 * <blockquote><pre>
+	 * &#64;IdClass(BundleItem.CompositeId.class)
+	 * &#64;Table(name = BundleContentLoaderStrategy.DEFAULT_TABLE_NAME)
+	 * public class BundleEntity implements BundleItem, Comparable<BundleEntity> {
+	 *
+	 *     &#64;Id
+	 *     &#64;NotBlank
+	 *     private String key;
+	 *
+	 *     &#64;NotNull
+	 *     &#64;Type(type = "text")
+	 *     private String value;
+	 *
+	 *     &#64;Id
+	 *     &#64;NotBlank
+	 *     private String baseName;
+	 *
+	 *     &#64;Id
+	 *     &#64;NotNull
+	 *     private String language = "";
+	 *
+	 *     &#64;Id
+	 *     &#64;NotNull
+	 *     private String country = "";
+	 *
+	 *     &#64;Id
+	 *     &#64;NotNull
+	 *     private String variant = "";
+	 *
+	 *     &#64;NotNull
+	 *     private Long lastModified;
+	 *
+	 *     // getters, setters and other methods...
+	 * }
+	 *
+	 * </pre></blockquote>
+	 *
+	 */
+	class CompositeId implements Serializable {
+
+		private String key;
+
+		private String baseName;
+
+		private String language;
+
+		private String country;
+
+		private String variant;
+	}
+
+}

src/main/java/com/kodgemisi/cigdem/databasebasedmessagesource/BundleItem.java

@@ -2,30 +2,22 @@
 
 import com.kodgemisi.cigdem.databaseresourcbundle.BundleContentLoaderStrategy;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration;
 import org.springframework.boot.autoconfigure.context.MessageSourceProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.MessageSource;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.support.ResourceBundleMessageSource;
-import org.springframework.core.type.filter.AnnotationTypeFilter;
-import org.springframework.core.type.filter.AssignableTypeFilter;
-import org.springframework.util.StopWatch;
 import org.springframework.util.StringUtils;
 
-import javax.persistence.Entity;
 import javax.persistence.EntityManager;
-import javax.persistence.Query;
 import javax.persistence.metamodel.EntityType;
 import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Set;
 
 /**
  * Created on May, 2018
@@ -84,18 +76,18 @@ private MessageSource createMessageSource(MessageSourceProperties properties, Bu
 	}
 
 	@SuppressWarnings("unchecked")
-	private Class<? extends BundleEntity> findBundleEntityConcreteClass(EntityManager entityManager) throws ClassNotFoundException {
+	private Class<? extends BundleItem> findBundleEntityConcreteClass(EntityManager entityManager) throws ClassNotFoundException {
 
 		final List<Class<?>> entities = new ArrayList<>();
 
 		for (EntityType<?> entity : entityManager.getMetamodel().getEntities()) {
-			if (BundleEntity.class.isAssignableFrom(entity.getJavaType())) {
+			if (BundleItem.class.isAssignableFrom(entity.getJavaType())) {
 				entities.add(entity.getJavaType());
 			}
 		}
 
 		if (entities.size() == 1) {
-			return (Class<? extends BundleEntity>) entities.get(0);
+			return (Class<? extends BundleItem>) entities.get(0);
 		}
 
 		if (entities.size() > 1) {

src/main/java/com/kodgemisi/cigdem/databasebasedmessagesource/DatabaseResourceBundleAutoconfiguration.java

@@ -28,16 +28,16 @@ protected ResourceBundle doGetBundle(String basename, Locale locale) throws Miss
 		// As we won't be using it in any way, to reduce complexity we use this class' classloader.
 		final ClassLoader classLoader = this.getClass().getClassLoader();
 
-		// As we can observe here: org.springframework.context.support.ResourceBundleMessageSource.MessageSourceControl#getTimeToLive
+		// As we can observe here: org.springframework.context.support.ResourceBundleMessageSource.MessageSourceControl.getTimeToLive
 		// MessageSourceControl's getTimeToLive method should return the same value with the ResourceBundleMessageSource#cacheMillis
-		// Since we don't put DatabaseResourceBundleControl class as an inner class and since we cannot use
+		// Since we don't put DatabaseResourceBundleControl class as an inner class as Spring does and since we cannot use
 		// ResourceBundleMessageSource#getCacheMillis in our DatabaseResourceBundleControl class we have to sync the value by
 		// explicitly setting TTL in the constructor of DatabaseResourceBundleControl
 
 		// Also note that when `spring.messages.cache-duration` is not set, bundles are cached forever.
 		// Default value of org.springframework.context.support.AbstractResourceBasedMessageSource.cacheMillis is -1 which is equal to
 		// ResourceBundle.Control.TTL_DONT_CACHE so that's consistent and we don't need to do anything about default value.
-		// See org.springframework.context.support.AbstractResourceBasedMessageSource.setCacheMillis
+		// See org.springframework.context.support.AbstractResourceBasedMessageSource#setCacheMillis
 		return ResourceBundle.getBundle(basename, locale, classLoader, new DatabaseResourceBundleControl(bundleContentLoaderStrategy, getCacheMillis()));
 		//FIXME DatabaseResourceBundleControl could be a field. However what about using setCacheMillis in runtime?
 	}

src/main/java/com/kodgemisi/cigdem/databasebasedmessagesource/DatabaseResourceBundleMessageSource.java

@@ -1,7 +1,6 @@
 package com.kodgemisi.cigdem.databasebasedmessagesource;
 
 import com.kodgemisi.cigdem.databaseresourcbundle.BundleContentLoaderStrategy;
-import lombok.AllArgsConstructor;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 
@@ -16,17 +15,17 @@
 import java.util.stream.Collectors;
 
 /**
- * You should provide an entity which implements {@link BundleEntity} when using this class as
+ * You should provide an entity which implements {@link BundleItem} when using this class as
  * {@link com.kodgemisi.cigdem.databaseresourcbundle.BundleContentLoaderStrategy} for {@link com.kodgemisi.cigdem.databaseresourcbundle.DatabaseResourceBundle}.
  *
  * Created on June, 2018
  *
- * @see BundleEntity
+ * @see BundleItem
  * @author destan
  */
 @Slf4j
 @RequiredArgsConstructor
-public class JpaBundleContentLoaderStrategy<E extends BundleEntity> implements BundleContentLoaderStrategy {
+public class JpaBundleContentLoaderStrategy<E extends BundleItem> implements BundleContentLoaderStrategy {
 
 	private final EntityManager entityManager;
 
@@ -45,7 +44,7 @@ public Map<String, Object> loadFromDatabase(String bundleName) {
 
 			Predicate predicate = builder.equal(root.get("language"), bundleMetaData.language);
 			predicate = builder.and(predicate, builder.equal(root.get("country"), bundleMetaData.country));
-			predicate = builder.and(predicate, builder.equal(root.get("name"), bundleMetaData.basename));
+			predicate = builder.and(predicate, builder.equal(root.get("baseName"), bundleMetaData.basename));
 			predicate = builder.and(predicate, builder.equal(root.get("variant"), bundleMetaData.variant));
 
 			query.distinct(true);
@@ -66,17 +65,17 @@ public Map<String, Object> loadFromDatabase(String bundleName) {
 
 	@Override
 	public boolean needsReload(String baseName, Locale locale, String format, ResourceBundle bundle, long loadTime) {
+		// Note that this method is only called for expired bundles
 		try {
 			final CriteriaBuilder builder = entityManager.getCriteriaBuilder();
 			final CriteriaQuery<Long> query = builder.createQuery(Long.class);
 			final Root<E> root = query.from(clazz);
 
-			query.select(root.get("lastModified"));
+			query.select(builder.count(root.get("lastModified")));
 			query.where(builder.greaterThan(root.get("lastModified"), loadTime));
 
-			final List<Long> results = entityManager.createQuery(query).getResultList();
-
-			return !results.isEmpty();
+			final long count = entityManager.createQuery(query).getSingleResult();
+			return count > 0;
 		}
 		catch (Exception e) {
 			// don't let host application crash just because of a database error while getting messages, that would be very unpleasant!

src/main/java/com/kodgemisi/cigdem/databasebasedmessagesource/JpaBundleContentLoaderStrategy.java

@@ -0,0 +1,54 @@
+package com.kodgemisi.cigdem.databasebasedmessagesource;
+
+class StringUtil {
+
+    private StringUtil() {
+        throw new UnsupportedOperationException("Cannot be instantiated!");
+    }
+
+    static String getNamePart(String namePart) {
+        // Intentionally not using isBlank in order to not mask/shadow any data inconsistency in the db.
+        // Name parts are never supposed to be blank. They are either empty or valid strings.
+        return isEmpty(namePart) ? "" : '_' + namePart;
+    }
+
+    static boolean isEmpty(CharSequence cs) {
+        return cs == null || cs.length() == 0;
+    }
+
+    /**
+     * <p>Copied from {@link org.apache.commons.lang3.StringUtils#countMatches(java.lang.CharSequence, char)}</p>
+     *
+     * <p>Counts how many times the char appears in the given string.</p>
+     *
+     * <p>A {@code null} or empty ("") String input returns {@code 0}.</p>
+     *
+     * <pre>
+     * StringUtils.countMatches(null, *)       = 0
+     * StringUtils.countMatches("", *)         = 0
+     * StringUtils.countMatches("abba", 0)  = 0
+     * StringUtils.countMatches("abba", 'a')   = 2
+     * StringUtils.countMatches("abba", 'b')  = 2
+     * StringUtils.countMatches("abba", 'x') = 0
+     * </pre>
+     *
+     * @param str  the CharSequence to check, may be null
+     * @param ch  the char to count
+     * @return the number of occurrences, 0 if the CharSequence is {@code null}
+     */
+    static int countMatches(CharSequence str, char ch) {
+        if (isEmpty(str)) {
+            return 0;
+        } else {
+            int count = 0;
+
+            for(int i = 0; i < str.length(); ++i) {
+                if (ch == str.charAt(i)) {
+                    ++count;
+                }
+            }
+
+            return count;
+        }
+    }
+}