You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2020/03/06 18:04:07 UTC
[jspwiki] 05/35: JSPWIKI-303: move FilterManager back to
o.a.w.filters package
This is an automated email from the ASF dual-hosted git repository.
juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 6abfe2be1a9e54bd43e68129e5a390cd10ac5f02
Author: juanpablo <ju...@apache.org>
AuthorDate: Sun Mar 1 21:25:47 2020 +0100
JSPWIKI-303: move FilterManager back to o.a.w.filters package
public filter api is meant to develop new filters, so it doesn't make sense to have the FilterManager on the o.a.w.api.engine package
---
.../src/main/java/org/apache/wiki/WikiEngine.java | 2 +-
.../org/apache/wiki/auth/DefaultUserManager.java | 2 +-
.../java/org/apache/wiki/event/WikiPageEvent.java | 24 ++++++++++++----------
.../apache/wiki/filters/DefaultFilterManager.java | 1 -
.../{api/engine => filters}/FilterManager.java | 8 ++++----
.../wiki/render/DefaultRenderingManager.java | 2 +-
.../wiki/tasks/pages/PreSaveWikiPageTask.java | 2 +-
.../apache/wiki/tasks/pages/SaveWikiPageTask.java | 2 +-
.../wiki/ui/admin/DefaultAdminBeanManager.java | 2 +-
.../src/main/resources/ini/classmappings.xml | 2 +-
.../wiki/filters/DefaultFilterManagerTest.java | 1 -
.../apache/wiki/workflow/ApprovalWorkflowTest.java | 2 +-
12 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
index a090109..6e5316f 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java
@@ -22,7 +22,6 @@ import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.ProviderException;
import org.apache.wiki.api.exceptions.WikiException;
import org.apache.wiki.attachment.AttachmentManager;
@@ -37,6 +36,7 @@ import org.apache.wiki.event.WikiEngineEvent;
import org.apache.wiki.event.WikiEventListener;
import org.apache.wiki.event.WikiEventManager;
import org.apache.wiki.event.WikiPageEvent;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.i18n.InternationalizationManager;
import org.apache.wiki.pages.PageManager;
import org.apache.wiki.plugin.PluginManager;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java b/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
index 5037db3..1eee920 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/auth/DefaultUserManager.java
@@ -26,7 +26,6 @@ import org.apache.wiki.ajax.AjaxUtil;
import org.apache.wiki.ajax.WikiAjaxDispatcherServlet;
import org.apache.wiki.ajax.WikiAjaxServlet;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.NoRequiredPropertyException;
import org.apache.wiki.api.exceptions.WikiException;
import org.apache.wiki.api.filters.PageFilter;
@@ -39,6 +38,7 @@ import org.apache.wiki.auth.user.UserProfile;
import org.apache.wiki.event.WikiEventListener;
import org.apache.wiki.event.WikiEventManager;
import org.apache.wiki.event.WikiSecurityEvent;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.filters.SpamFilter;
import org.apache.wiki.i18n.InternationalizationManager;
import org.apache.wiki.pages.PageManager;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
index 181e3a7..3474c39 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/event/WikiPageEvent.java
@@ -19,6 +19,8 @@
package org.apache.wiki.event;
+import org.apache.wiki.filters.FilterManager;
+
/**
* WikiPageEvent indicates a change in the state or processing of a WikiPage. There are basically two types of page events:
@@ -61,7 +63,7 @@ package org.apache.wiki.event;
* <p>
* Other WikiPageEvents include both <i>phase boundary</i> and <i>in-phase</i> events for saving, pre- and post-translating content.
* These are very noisy event types, but are not fired unless a listener is available. They are generated by the
- * {@link org.apache.wiki.api.engine.FilterManager}, {@link org.apache.wiki.filters.PageEventFilter}, and potentially other
+ * {@link FilterManager}, {@link org.apache.wiki.filters.PageEventFilter}, and potentially other
* implementing classes.
* </p>
*
@@ -90,7 +92,7 @@ public class WikiPageEvent extends WikiEvent {
// PRE_TRANSLATE .........
/** Indicates the beginning of all wiki pre-translate page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int PRE_TRANSLATE_BEGIN = 12;
/** Indicates a wiki pre-translate page event. This is based on events
@@ -98,13 +100,13 @@ public class WikiPageEvent extends WikiEvent {
public static final int PRE_TRANSLATE = 13;
/** Indicates the end of all wiki pre-translate page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int PRE_TRANSLATE_END = 14;
// POST_TRANSLATE ........
/** Indicates the beginning of all wiki post-translate page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int POST_TRANSLATE_BEGIN = 15;
/** Indicates a wiki post-translate page event. This is based on events
@@ -112,33 +114,33 @@ public class WikiPageEvent extends WikiEvent {
public static final int POST_TRANSLATE = 16;
/** Indicates the end of all wiki post-translate page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int POST_TRANSLATE_END = 17;
// PRE_SAVE ..............
/** Indicates the beginning of all wiki pre-save page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int PRE_SAVE_BEGIN = 18;
/** Indicates a wiki pre-save page event. This is based on events generated by {@link org.apache.wiki.filters.PageEventFilter}. */
public static final int PRE_SAVE = 19;
/** Indicates the end of all wiki pre-save page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int PRE_SAVE_END = 20;
// POST_SAVE .............
/** Indicates the beginning of all wiki post-save page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int POST_SAVE_BEGIN = 21;
/** Indicates a wiki post-save page event. This is based on events generated by {@link org.apache.wiki.filters.PageEventFilter}. */
public static final int POST_SAVE = 22;
/** Indicates the end of all wiki post-save page events. This is based
- * on events generated by {@link org.apache.wiki.api.engine.FilterManager}. */
+ * on events generated by {@link FilterManager}. */
public static final int POST_SAVE_END = 23;
// PAGE REQUESTS .........
@@ -198,7 +200,7 @@ public class WikiPageEvent extends WikiEvent {
*
* @return a String representation of the type
*/
- public String eventName() {
+ @Override public String eventName() {
switch ( getType() ) {
case PAGE_LOCK: return "PAGE_LOCK";
case PAGE_UNLOCK: return "PAGE_UNLOCK";
@@ -234,7 +236,7 @@ public class WikiPageEvent extends WikiEvent {
*
* @return a String description of the type
*/
- public String getTypeDescription() {
+ @Override public String getTypeDescription() {
switch ( getType() ) {
case PAGE_LOCK: return "page lock event";
case PAGE_UNLOCK: return "page unlock event";
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/DefaultFilterManager.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/DefaultFilterManager.java
index 619a7e7..c88e8a4 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/filters/DefaultFilterManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/DefaultFilterManager.java
@@ -21,7 +21,6 @@ package org.apache.wiki.filters;
import org.apache.log4j.Logger;
import org.apache.wiki.WikiContext;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.FilterException;
import org.apache.wiki.api.exceptions.WikiException;
import org.apache.wiki.api.filters.PageFilter;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/api/engine/FilterManager.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/FilterManager.java
similarity index 99%
rename from jspwiki-main/src/main/java/org/apache/wiki/api/engine/FilterManager.java
rename to jspwiki-main/src/main/java/org/apache/wiki/filters/FilterManager.java
index a9a825e..d605016 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/api/engine/FilterManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/FilterManager.java
@@ -16,16 +16,16 @@
specific language governing permissions and limitations
under the License.
*/
-package org.apache.wiki.api.engine;
-
-import java.util.Collection;
-import java.util.List;
+package org.apache.wiki.filters;
import org.apache.wiki.WikiContext;
import org.apache.wiki.api.exceptions.FilterException;
import org.apache.wiki.api.filters.PageFilter;
import org.apache.wiki.modules.WikiModuleInfo;
+import java.util.Collection;
+import java.util.List;
+
public interface FilterManager
{
/** Property name for setting the filter XML property file. Value is <tt>{@value}</tt>. */
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/render/DefaultRenderingManager.java b/jspwiki-main/src/main/java/org/apache/wiki/render/DefaultRenderingManager.java
index e0e8979..26d2c67 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/render/DefaultRenderingManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/render/DefaultRenderingManager.java
@@ -27,7 +27,6 @@ import org.apache.wiki.StringTransmutator;
import org.apache.wiki.WikiContext;
import org.apache.wiki.WikiPage;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.FilterException;
import org.apache.wiki.api.exceptions.ProviderException;
import org.apache.wiki.api.exceptions.WikiException;
@@ -37,6 +36,7 @@ import org.apache.wiki.event.WikiEvent;
import org.apache.wiki.event.WikiEventListener;
import org.apache.wiki.event.WikiEventManager;
import org.apache.wiki.event.WikiPageEvent;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.pages.PageManager;
import org.apache.wiki.parser.JSPWikiMarkupParser;
import org.apache.wiki.parser.MarkupParser;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/PreSaveWikiPageTask.java b/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/PreSaveWikiPageTask.java
index 006174e..5a2c6a4 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/PreSaveWikiPageTask.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/PreSaveWikiPageTask.java
@@ -21,8 +21,8 @@ package org.apache.wiki.tasks.pages;
import org.apache.wiki.WikiContext;
import org.apache.wiki.WikiPage;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.WikiException;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.tasks.TasksManager;
import org.apache.wiki.workflow.Outcome;
import org.apache.wiki.workflow.Task;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/SaveWikiPageTask.java b/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/SaveWikiPageTask.java
index 7dcf18c..dde704c 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/SaveWikiPageTask.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tasks/pages/SaveWikiPageTask.java
@@ -21,8 +21,8 @@ package org.apache.wiki.tasks.pages;
import org.apache.wiki.WikiContext;
import org.apache.wiki.WikiPage;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.WikiException;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.pages.PageManager;
import org.apache.wiki.render.RenderingManager;
import org.apache.wiki.tasks.TasksManager;
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/DefaultAdminBeanManager.java b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/DefaultAdminBeanManager.java
index 7c131b0..f336fdb 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/DefaultAdminBeanManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/ui/admin/DefaultAdminBeanManager.java
@@ -21,10 +21,10 @@ package org.apache.wiki.ui.admin;
import org.apache.log4j.Logger;
import org.apache.wiki.Release;
import org.apache.wiki.api.core.Engine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.event.WikiEngineEvent;
import org.apache.wiki.event.WikiEvent;
import org.apache.wiki.event.WikiEventListener;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.modules.WikiModuleInfo;
import org.apache.wiki.plugin.PluginManager;
import org.apache.wiki.ui.EditorManager;
diff --git a/jspwiki-main/src/main/resources/ini/classmappings.xml b/jspwiki-main/src/main/resources/ini/classmappings.xml
index acb5601..39927df 100644
--- a/jspwiki-main/src/main/resources/ini/classmappings.xml
+++ b/jspwiki-main/src/main/resources/ini/classmappings.xml
@@ -52,7 +52,7 @@
<mappedClass>org.apache.wiki.pages.DefaultPageManager</mappedClass>
</mapping>
<mapping>
- <requestedClass>org.apache.wiki.api.engine.FilterManager</requestedClass>
+ <requestedClass>org.apache.wiki.filters.FilterManager</requestedClass>
<mappedClass>org.apache.wiki.filters.DefaultFilterManager</mappedClass>
</mapping>
<mapping>
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/filters/DefaultFilterManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/filters/DefaultFilterManagerTest.java
index 3534901..d8a3d2e 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/filters/DefaultFilterManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/filters/DefaultFilterManagerTest.java
@@ -19,7 +19,6 @@
package org.apache.wiki.filters;
import org.apache.wiki.TestEngine;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.filters.PageFilter;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/workflow/ApprovalWorkflowTest.java b/jspwiki-main/src/test/java/org/apache/wiki/workflow/ApprovalWorkflowTest.java
index a55abea..0f7defe 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/workflow/ApprovalWorkflowTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/workflow/ApprovalWorkflowTest.java
@@ -20,12 +20,12 @@ package org.apache.wiki.workflow;
import org.apache.wiki.TestEngine;
import org.apache.wiki.WikiContext;
-import org.apache.wiki.api.engine.FilterManager;
import org.apache.wiki.api.exceptions.FilterException;
import org.apache.wiki.api.exceptions.WikiException;
import org.apache.wiki.api.filters.BasicPageFilter;
import org.apache.wiki.auth.Users;
import org.apache.wiki.auth.WikiPrincipal;
+import org.apache.wiki.filters.FilterManager;
import org.apache.wiki.pages.PageManager;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;