Option to remove AGPL log message

DEVSIX-6378

Author: Evgeniy Prudnikov

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

@@ -22,6 +22,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.commons.actions;
 
+import com.itextpdf.commons.actions.processors.UnderAgplProductProcessorFactory;
 import com.itextpdf.commons.exceptions.AggregatedException;
 
 import java.util.ArrayList;
@@ -51,6 +52,16 @@ public static EventManager getInstance() {
         return INSTANCE;
     }
 
+    /**
+     * Deliberately turns off the warning message about AGPL usage.
+     *
+     * <p>
+     * <b> Important note. Calling of this method means that the terms of AGPL license are met. </b>
+     */
+    public static void acknowledgeAgplUsageDisableWarningMessage() {
+        ProductProcessorFactoryKeeper.setProductProcessorFactory(new UnderAgplProductProcessorFactory());
+    }
+
     /**
      * Handles the event.
      *

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

@@ -25,7 +25,6 @@ This file is part of the iText (R) project.
 import com.itextpdf.commons.actions.confirmations.ConfirmEvent;
 import com.itextpdf.commons.actions.confirmations.ConfirmedEventWrapper;
 import com.itextpdf.commons.actions.contexts.UnknownContext;
-import com.itextpdf.commons.actions.processors.DefaultITextProductEventProcessor;
 import com.itextpdf.commons.actions.processors.ITextProductEventProcessor;
 import com.itextpdf.commons.actions.sequence.SequenceId;
 import com.itextpdf.commons.exceptions.ProductEventHandlerRepeatException;
@@ -97,7 +96,7 @@ ITextProductEventProcessor getActiveProcessor(String productName) {
         }
 
         if (ProductNameConstant.PRODUCT_NAMES.contains(productName)) {
-            processor = new DefaultITextProductEventProcessor(productName);
+            processor = ProductProcessorFactoryKeeper.getProductProcessorFactory().createProcessor(productName);
             processors.put(productName, processor);
             return processor;
         } else {

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

@@ -0,0 +1,63 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2022 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.commons.actions;
+
+import com.itextpdf.commons.actions.processors.DefaultProductProcessorFactory;
+import com.itextpdf.commons.actions.processors.IProductProcessorFactory;
+
+/**
+ * Helper class which allow to change used product processor factory instance.
+ */
+final class ProductProcessorFactoryKeeper {
+    private static final IProductProcessorFactory DEFAULT_FACTORY = new DefaultProductProcessorFactory();
+    private static IProductProcessorFactory productProcessorFactory = DEFAULT_FACTORY;
+
+    private ProductProcessorFactoryKeeper() {
+        // do nothing
+    }
+
+    /**
+     * Sets product processor factory instance.
+     *
+     * @param productProcessorFactory the instance to be set
+     */
+    static void setProductProcessorFactory(IProductProcessorFactory productProcessorFactory) {
+        ProductProcessorFactoryKeeper.productProcessorFactory = productProcessorFactory;
+    }
+
+    /**
+     * Restores default factory.
+     */
+    static void restoreDefaultProductProcessorFactory() {
+        ProductProcessorFactoryKeeper.productProcessorFactory = DEFAULT_FACTORY;
+    }
+
+    /**
+     * Gets reporting product processor factory instance.
+     *
+     * @return the product processor factory instance
+     */
+    static IProductProcessorFactory getProductProcessorFactory() {
+        return productProcessorFactory;
+    }
+}

commons/src/main/java/com/itextpdf/commons/actions/processors/DefaultProductProcessorFactory.java

@@ -0,0 +1,41 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2022 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.commons.actions.processors;
+
+/**
+ * Default factory class to construct {@link ITextProductEventProcessor} instance.
+ */
+public class DefaultProductProcessorFactory implements IProductProcessorFactory {
+
+    /**
+     * Creates default product processor using a product name.
+     *
+     * @param productName the product which will be handled by this processor
+     *
+     * @return current {@link ITextProductEventProcessor} instance
+     */
+    @Override
+    public ITextProductEventProcessor createProcessor(String productName) {
+        return new DefaultITextProductEventProcessor(productName);
+    }
+}

commons/src/main/java/com/itextpdf/commons/actions/processors/IProductProcessorFactory.java

@@ -0,0 +1,37 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2022 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.commons.actions.processors;
+
+/**
+ * Class represents a factory for {@link ITextProductEventProcessor} objects.
+ */
+public interface IProductProcessorFactory {
+    /**
+     * Creates product processor using a product name.
+     *
+     * @param productName the product which will be handled by this processor
+     *
+     * @return the processor instance
+     */
+    ITextProductEventProcessor createProcessor(String productName);
+}

commons/src/main/java/com/itextpdf/commons/actions/processors/UnderAgplITextProductEventProcessor.java

@@ -0,0 +1,49 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2022 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.commons.actions.processors;
+
+import com.itextpdf.commons.actions.AbstractProductProcessITextEvent;
+
+/**
+ * The class defines an under APGL strategy of product event processing.
+ */
+public class UnderAgplITextProductEventProcessor extends AbstractITextProductEventProcessor{
+    /**
+     * Creates a new instance of under AGPL processor for the provided product.
+     *
+     * @param productName the product which will be handled by this processor
+     */
+    public UnderAgplITextProductEventProcessor(String productName) {
+        super(productName);
+    }
+
+    @Override
+    public void onEvent(AbstractProductProcessITextEvent event) {
+        // do nothing
+    }
+
+    @Override
+    public String getUsageType() {
+        return "AGPL";
+    }
+}

commons/src/main/java/com/itextpdf/commons/actions/processors/UnderAgplProductProcessorFactory.java

@@ -0,0 +1,41 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2022 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.commons.actions.processors;
+
+/**
+ * Factory class to construct {@link ITextProductEventProcessor} instance under AGPL license.
+ */
+public class UnderAgplProductProcessorFactory implements IProductProcessorFactory {
+
+    /**
+     * Creates under AGPL product processor using a product name.
+     *
+     * @param productName the product which will be handled by this processor
+     *
+     * @return current {@link ITextProductEventProcessor} instance
+     */
+    @Override
+    public ITextProductEventProcessor createProcessor(String productName) {
+        return new UnderAgplITextProductEventProcessor(productName);
+    }
+}

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

@@ -22,6 +22,9 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.commons.actions;
 
+import com.itextpdf.commons.actions.processors.DefaultProductProcessorFactory;
+import com.itextpdf.commons.actions.processors.IProductProcessorFactory;
+import com.itextpdf.commons.actions.processors.UnderAgplProductProcessorFactory;
 import com.itextpdf.commons.actions.sequence.SequenceId;
 import com.itextpdf.commons.ecosystem.ITextTestEvent;
 import com.itextpdf.commons.ecosystem.TestConfigurationEvent;
@@ -33,13 +36,19 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.annotations.type.UnitTest;
 
 import java.util.List;
+import org.junit.After;
 import org.junit.Assert;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
 @Category(UnitTest.class)
 public class EventManagerTest extends ExtendedITextTest {
 
+    @After
+    public void afterEach() {
+        ProductProcessorFactoryKeeper.restoreDefaultProductProcessorFactory();
+    }
+
     @Test
     @LogMessages(messages = {
             @LogMessage(messageTemplate = TestConfigurationEvent.MESSAGE)
@@ -106,7 +115,15 @@ public void configureHandlersTest() {
         Assert.assertFalse(eventManager.isRegistered(handler));
 
         Assert.assertFalse(eventManager.unregister(handler));
+    }
 
+    @Test
+    public void turningOffAgplTest() {
+        IProductProcessorFactory defaultProductProcessorFactory = ProductProcessorFactoryKeeper.getProductProcessorFactory();
+        Assert.assertTrue(defaultProductProcessorFactory instanceof DefaultProductProcessorFactory);
+        EventManager.acknowledgeAgplUsageDisableWarningMessage();
+        IProductProcessorFactory underAgplProductProcessorFactory1 = ProductProcessorFactoryKeeper.getProductProcessorFactory();
+        Assert.assertTrue(underAgplProductProcessorFactory1 instanceof UnderAgplProductProcessorFactory);
     }
 
     private static class ThrowArithmeticExpHandler implements IEventHandler {