Clean up context manager mechanism

Rename some classes related to DEVSIX-5311

DEVSIX-5659

Author: Egor Martsynkovsky

commons/src/main/java/com/itextpdf/commons/actions/AbstractContextBasedEventHandler.java

@@ -28,7 +28,7 @@ This file is part of the iText (R) project.
 /**
  * Base class for events handling depending on the context.
  */
-public abstract class AbstractContextBasedEventHandler implements IBaseEventHandler {
+public abstract class AbstractContextBasedEventHandler implements IEventHandler {
     private final IContext defaultContext;
 
     /**
@@ -48,7 +48,7 @@ protected AbstractContextBasedEventHandler(IContext onUnknownContext) {
      *
      * @param event to handle
      */
-    public final void onEvent(IBaseEvent event) {
+    public final void onEvent(IEvent event) {
         if (!(event instanceof AbstractContextBasedITextEvent)) {
             return;
         }

commons/src/main/java/com/itextpdf/commons/actions/AbstractITextEvent.java

@@ -28,7 +28,7 @@ This file is part of the iText (R) project.
 /**
  * Abstract class which defines events only for internal usage.
  */
-public abstract class AbstractITextEvent implements IBaseEvent {
+public abstract class AbstractITextEvent implements IEvent {
     private static final String ONLY_FOR_INTERNAL_USE = "AbstractITextEvent is only for internal usage.";
 
     private static final Map<String, Object> INTERNAL_PACKAGES = new ConcurrentHashMap<>();

commons/src/main/java/com/itextpdf/commons/actions/EventManager.java

@@ -36,7 +36,7 @@ This file is part of the iText (R) project.
 public final class EventManager {
     private static final EventManager INSTANCE = new EventManager();
 
-    private final Set<IBaseEventHandler> handlers = new LinkedHashSet<>();
+    private final Set<IEventHandler> handlers = new LinkedHashSet<>();
 
     private EventManager() {
         handlers.add(ProductEventHandler.INSTANCE);
@@ -56,9 +56,9 @@ public static EventManager getInstance() {
      *
      * @param event to handle
      */
-    public void onEvent(IBaseEvent event) {
+    public void onEvent(IEvent event) {
         final List<RuntimeException> caughtExceptions = new ArrayList<>();
-        for (final IBaseEventHandler handler : handlers) {
+        for (final IEventHandler handler : handlers) {
             try {
                 handler.onEvent(event);
             } catch (RuntimeException ex) {
@@ -83,11 +83,11 @@ public void onEvent(IBaseEvent event) {
     }
 
     /**
-     * Add new {@link IBaseEventHandler} to the event handling process.
+     * Add new {@link IEventHandler} to the event handling process.
      *
      * @param handler is a handler to add
      */
-    public void register(IBaseEventHandler handler) {
+    public void register(IEventHandler handler) {
         if (handler != null) {
             handlers.add(handler);
         }
@@ -99,7 +99,7 @@ public void register(IBaseEventHandler handler) {
      * @param handler is a handler to check
      * @return true if handler has been already registered and false otherwise
      */
-    public boolean isRegistered(IBaseEventHandler handler) {
+    public boolean isRegistered(IEventHandler handler) {
         if (handler != null) {
             return handlers.contains(handler);
         }
@@ -113,7 +113,7 @@ public boolean isRegistered(IBaseEventHandler handler) {
      * @return true if the handler had been registered previously and was removed. False if the
      * handler was not found among registered handlers
      */
-    public boolean unregister(IBaseEventHandler handler) {
+    public boolean unregister(IEventHandler handler) {
         if (handler != null) {
             return handlers.remove(handler);
         }

commons/src/main/java/com/itextpdf/commons/actions/IBaseEvent.java renamed to commons/src/main/java/com/itextpdf/commons/actions/IEvent.java

@@ -25,7 +25,6 @@ This file is part of the iText (R) project.
 /**
  * Base marker interface for any generated event of any source.
  *
- * <p>TODO: DEVSIX-5311 rename it IEvent when the oldest mechanism is deleted
  */
-public interface IBaseEvent {
+public interface IEvent {
 }

commons/src/main/java/com/itextpdf/commons/actions/IBaseEventHandler.java renamed to commons/src/main/java/com/itextpdf/commons/actions/IEventHandler.java

@@ -25,13 +25,12 @@ This file is part of the iText (R) project.
 /**
  * The interface for an event handler.
  *
- * <p>TODO: DEVSIX-5311 rename it IEventHandler when the oldest mechanism is deleted
  */
-public interface IBaseEventHandler {
+public interface IEventHandler {
     /**
      * Handles the event.
      *
      * @param event to handle
      */
-    void onEvent(IBaseEvent event);
+    void onEvent(IEvent event);
 }

commons/src/main/java/com/itextpdf/commons/actions/NamespaceConstant.java

@@ -64,9 +64,7 @@ public final class NamespaceConstant {
     public static final String CORE_SVG = ITEXT + ".svg";
 
     //Addons
-    public static final String PDF_DEBUG = ITEXT + ".pdfdebug";
     public static final String PDF_HTML = ITEXT + ".html2pdf";
-    public static final String PDF_INVOICE = ITEXT + ".zugferd";
     public static final String PDF_SWEEP = ITEXT + ".pdfcleanup";
     public static final String PDF_OCR = ITEXT + ".pdfocr";
     public static final String PDF_OCR_TESSERACT4 = PDF_OCR + ".tesseract4";

commons/src/main/java/com/itextpdf/commons/actions/confirmations/EventConfirmationType.java

@@ -24,15 +24,15 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.commons.actions.AbstractProductProcessITextEvent;
 import com.itextpdf.commons.actions.EventManager;
-import com.itextpdf.commons.actions.IBaseEvent;
+import com.itextpdf.commons.actions.IEvent;
 
 /**
  * Defines the strategy of {@link AbstractProductProcessITextEvent} confirming.
  */
 public enum EventConfirmationType {
     /**
      * The successful execution of the process associated with the event should be confirmed by the
-     * second invocation of the {@link EventManager#onEvent(IBaseEvent)} method.
+     * second invocation of the {@link EventManager#onEvent(IEvent)} method.
      */
     ON_DEMAND,
     /**

commons/src/main/java/com/itextpdf/commons/actions/contexts/AbstractContextManagerConfigurationEvent.java

@@ -38,10 +38,10 @@ protected AbstractContextManagerConfigurationEvent() {
     }
 
     protected void registerGenericContext(Collection<String> namespaces, Collection<String> products) {
-        ContextManager.getInstance().registerGenericContextForProducts(namespaces, products);
+        ContextManager.getInstance().registerGenericContext(namespaces, products);
     }
 
-    protected void unregisterGenericContext(Collection<String> namespaces) {
-        ContextManager.getInstance().unregisterGenericContextForProducts(namespaces);
+    protected void unregisterContext(Collection<String> namespaces) {
+        ContextManager.getInstance().unregisterContext(namespaces);
     }
 }

commons/src/main/java/com/itextpdf/commons/actions/contexts/ContextManager.java

@@ -62,28 +62,16 @@ public class ContextManager {
 
     static {
         ContextManager local = new ContextManager();
-        local.registerGenericContextForProducts(NamespaceConstant.ITEXT_CORE_NAMESPACES,
-                Collections.singletonList(NamespaceConstant.ITEXT),
+        local.registerGenericContext(NamespaceConstant.ITEXT_CORE_NAMESPACES,
                 Collections.singleton(ProductNameConstant.ITEXT_CORE));
 
-        local.registerGenericContextForProducts(Collections.singletonList(NamespaceConstant.PDF_DEBUG),
-                Collections.singletonList(NamespaceConstant.PDF_DEBUG),
-                Collections.<String>emptyList());
-
-        local.registerGenericContextForProducts(Collections.singletonList(NamespaceConstant.PDF_HTML),
-                Collections.singletonList(NamespaceConstant.PDF_HTML),
+        local.registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_HTML),
                 Collections.singleton(ProductNameConstant.PDF_HTML));
 
-        local.registerGenericContextForProducts(Collections.singletonList(NamespaceConstant.PDF_INVOICE),
-                Collections.singletonList(NamespaceConstant.PDF_INVOICE),
-                Collections.<String>emptyList());
-
-        local.registerGenericContextForProducts(Collections.singletonList(NamespaceConstant.PDF_SWEEP),
-                Collections.singletonList(NamespaceConstant.PDF_SWEEP),
+        local.registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_SWEEP),
                 Collections.singleton(ProductNameConstant.PDF_SWEEP));
 
-        local.registerGenericContextForProducts(Collections.singletonList(NamespaceConstant.PDF_OCR_TESSERACT4),
-                Collections.singletonList(NamespaceConstant.PDF_OCR_TESSERACT4),
+        local.registerGenericContext(Collections.singletonList(NamespaceConstant.PDF_OCR_TESSERACT4),
                 Collections.singleton(ProductNameConstant.PDF_OCR_TESSERACT4));
 
         INSTANCE = local;
@@ -139,27 +127,9 @@ String getRecognisedNamespace(String className) {
         return null;
     }
 
-    // TODO DEVSIX-5311 consider renaming to be in sync with renamed registerGenericContextForProducts
-    void unregisterGenericContextForProducts(Collection<String> namespaces) {
-        for (String namespace : namespaces) {
-            unregisterContext(namespace);
-        }
-    }
-
-    // TODO DEVSIX-5311 rename into registerGenericContext (currently we cann't rename it as
-    //  the old method with the same arguments but different logic is used for old mechanism)
-    void registerGenericContextForProducts(Collection<String> namespaces, Collection<String> products) {
-        registerGenericContextForProducts(namespaces, Collections.<String>emptyList(), products);
-    }
-
-    // TODO DEVSIX-5311 This method is needed for similar working of new and old license mechanism,
-    //  should be moved to single properly method
-    private void registerGenericContextForProducts(Collection<String> namespaces, Collection<String> eventIds,
-                                                   Collection<String> products) {
-        final GenericContext context = new GenericContext(products);
+    void unregisterContext(Collection<String> namespaces) {
         for (String namespace : namespaces) {
-            //Conversion to lowercase is done to be compatible with possible changes in case of packages/namespaces
-            registerContext(namespace.toLowerCase(), context);
+            contextMappings.remove(namespace);
         }
     }
 
@@ -170,17 +140,12 @@ private IContext getNamespaceMapping(String namespace) {
         return null;
     }
 
-    // TODO DEVSIX-5311 This method is used for old logic of license mechanism, will be removed
-    private void registerGenericContext(Collection<String> namespaces, Collection<String> eventIds) {
-        registerGenericContextForProducts(namespaces, eventIds, Collections.<String>emptyList());
-    }
-
-    private void registerContext(String namespace, IContext context) {
-        contextMappings.put(namespace, context);
-    }
-
-    private void unregisterContext(String namespace) {
-        contextMappings.remove(namespace);
+    void registerGenericContext(Collection<String> namespaces, Collection<String> products) {
+        final GenericContext context = new GenericContext(products);
+        for (String namespace : namespaces) {
+            //Conversion to lowercase is done to be compatible with possible changes in case of packages/namespaces
+            contextMappings.put(namespace.toLowerCase(), context);
+        }
     }
 
     private static class LengthComparator implements Comparator<String> {

commons/src/test/java/com/itextpdf/commons/actions/AbstractContextBasedEventHandlerTest.java

@@ -87,7 +87,7 @@ public boolean wasInvoked() {
         }
     }
 
-    private static class UnknownEvent implements IBaseEvent {
+    private static class UnknownEvent implements IEvent {
 
     }
 }