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 1a4307215a0c5c451a6d218fa4eadf9cc9b6201f Author: juanpablo <[email protected]> AuthorDate: Fri Mar 13 14:54:22 2020 +0100 JSPWIKI-303: rename BasicPageFilter to BasePageFilter in order to be able to reuse the latter to ensure backwards compatibility with custom page filters which extend that class --- .../api/filters/{BasicPageFilter.java => BasePageFilter.java} | 8 +++++++- .../src/main/java/org/apache/wiki/filters/CreoleFilter.java | 4 ++-- .../src/main/java/org/apache/wiki/filters/PageEventFilter.java | 4 ++-- .../main/java/org/apache/wiki/filters/PingWeblogsComFilter.java | 4 ++-- .../src/main/java/org/apache/wiki/filters/ProfanityFilter.java | 4 ++-- .../src/main/java/org/apache/wiki/filters/SpamFilter.java | 4 ++-- .../java/org/apache/wiki/references/DefaultReferenceManager.java | 4 ++-- .../main/java/org/apache/wiki/search/DefaultSearchManager.java | 4 ++-- .../src/test/java/org/apache/wiki/filters/TestFilter.java | 4 ++-- .../test/java/org/apache/wiki/workflow/ApprovalWorkflowTest.java | 4 ++-- 10 files changed, 25 insertions(+), 19 deletions(-) diff --git a/jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasicPageFilter.java b/jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasePageFilter.java similarity index 76% rename from jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasicPageFilter.java rename to jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasePageFilter.java index 1462067..352d587 100644 --- a/jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasicPageFilter.java +++ b/jspwiki-api/src/main/java/org/apache/wiki/api/filters/BasePageFilter.java @@ -21,14 +21,18 @@ package org.apache.wiki.api.filters; import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.FilterException; +import java.lang.reflect.Method; import java.util.Properties; +import static org.apache.wiki.api.filters.FilterSupportOperations.executePageFilterPhase; +import static org.apache.wiki.api.filters.FilterSupportOperations.methodOfNonPublicAPI; + /** * Provides a base implementation of a PageFilter. None of the callbacks do anything, so it is a good idea for you to extend from this * class and implement only methods that you need. */ -public class BasicPageFilter implements PageFilter { +public class BasePageFilter implements PageFilter { protected Engine m_engine; @@ -40,6 +44,8 @@ public class BasicPageFilter implements PageFilter { @Override public void initialize( final Engine engine, final Properties properties ) throws FilterException { m_engine = engine; + final Method m = methodOfNonPublicAPI( this, "initialize", "org.apache.wiki.WikiEngine", "java.util.Properties" ); + executePageFilterPhase( () -> null, m, this, engine, properties ); } } diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/CreoleFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/CreoleFilter.java index 96962e4..566959f 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/filters/CreoleFilter.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/CreoleFilter.java @@ -22,7 +22,7 @@ import org.apache.log4j.Logger; import org.apache.wiki.api.core.Context; import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.FilterException; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.parser.CreoleToJSPWikiTranslator; import java.util.Properties; @@ -41,7 +41,7 @@ import java.util.Properties; * * @see <a href="http://www.wikicreole.org/wiki/MixedMode";>[[WikiCreole:MixedMode]]</a> */ -public class CreoleFilter extends BasicPageFilter { +public class CreoleFilter extends BasePageFilter { private static final Logger log = Logger.getLogger(CreoleFilter.class); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/PageEventFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/PageEventFilter.java index 336f282..299e25b 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/filters/PageEventFilter.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/PageEventFilter.java @@ -22,7 +22,7 @@ package org.apache.wiki.filters; import org.apache.wiki.api.core.Context; import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.FilterException; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.event.WikiEventListener; import org.apache.wiki.event.WikiEventManager; import org.apache.wiki.event.WikiPageEvent; @@ -48,7 +48,7 @@ import java.util.Properties; * * @see org.apache.wiki.event.WikiEventManager */ -public class PageEventFilter extends BasicPageFilter { +public class PageEventFilter extends BasePageFilter { /** * Called whenever a new PageFilter is instantiated and reset. diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/PingWeblogsComFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/PingWeblogsComFilter.java index 35e5297..dff8d2c 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/filters/PingWeblogsComFilter.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/PingWeblogsComFilter.java @@ -22,7 +22,7 @@ import org.apache.log4j.Logger; import org.apache.wiki.WikiContext; import org.apache.wiki.api.core.Context; import org.apache.wiki.api.core.Engine; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.xmlrpc.AsyncCallback; import org.apache.xmlrpc.XmlRpcClient; @@ -39,7 +39,7 @@ import java.util.Vector; // FIXME: rpc endpoint must be configurable // FIXME: Should really be settable per-page. // FIXME: Weblog name has been set to stone -public class PingWeblogsComFilter extends BasicPageFilter { +public class PingWeblogsComFilter extends BasePageFilter { private static final Logger log = Logger.getLogger( PingWeblogsComFilter.class ); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/ProfanityFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/ProfanityFilter.java index b3ef1db..1070fd3 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/filters/ProfanityFilter.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/ProfanityFilter.java @@ -20,7 +20,7 @@ package org.apache.wiki.filters; import org.apache.log4j.Logger; import org.apache.wiki.api.core.Context; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.util.TextUtil; import java.io.BufferedReader; @@ -37,7 +37,7 @@ import java.util.List; * is case unsensitive. * */ -public class ProfanityFilter extends BasicPageFilter { +public class ProfanityFilter extends BasePageFilter { private static final Logger log = Logger.getLogger( ProfanityFilter.class ); diff --git a/jspwiki-main/src/main/java/org/apache/wiki/filters/SpamFilter.java b/jspwiki-main/src/main/java/org/apache/wiki/filters/SpamFilter.java index 0287f09..01f4adb 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/filters/SpamFilter.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/filters/SpamFilter.java @@ -37,7 +37,7 @@ import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.core.Page; import org.apache.wiki.api.exceptions.ProviderException; import org.apache.wiki.api.exceptions.RedirectException; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.attachment.Attachment; import org.apache.wiki.attachment.AttachmentManager; import org.apache.wiki.auth.user.UserProfile; @@ -108,7 +108,7 @@ import java.util.concurrent.ThreadLocalRandom; * * @since 2.1.112 */ -public class SpamFilter extends BasicPageFilter { +public class SpamFilter extends BasePageFilter { private static final String ATTR_SPAMFILTER_SCORE = "spamfilter.score"; private static final String REASON_REGEXP = "Regexp"; diff --git a/jspwiki-main/src/main/java/org/apache/wiki/references/DefaultReferenceManager.java b/jspwiki-main/src/main/java/org/apache/wiki/references/DefaultReferenceManager.java index 9853821..524364b 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/references/DefaultReferenceManager.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/references/DefaultReferenceManager.java @@ -28,7 +28,7 @@ import org.apache.wiki.WikiProvider; import org.apache.wiki.api.core.Context; import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.ProviderException; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.attachment.Attachment; import org.apache.wiki.attachment.AttachmentManager; import org.apache.wiki.event.WikiEvent; @@ -120,7 +120,7 @@ import java.util.TreeSet; // FIXME: The way that we save attributes is now a major booboo, and must be // replace forthwith. However, this is a workaround for the great deal // of problems that occur here... -public class DefaultReferenceManager extends BasicPageFilter implements ReferenceManager { +public class DefaultReferenceManager extends BasePageFilter implements ReferenceManager { /** * Maps page wikiname to a Collection of pages it refers to. The Collection must contain Strings. The Collection may contain diff --git a/jspwiki-main/src/main/java/org/apache/wiki/search/DefaultSearchManager.java b/jspwiki-main/src/main/java/org/apache/wiki/search/DefaultSearchManager.java index 1831d92..7172221 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/search/DefaultSearchManager.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/search/DefaultSearchManager.java @@ -29,7 +29,7 @@ import org.apache.wiki.ajax.WikiAjaxServlet; import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.exceptions.FilterException; import org.apache.wiki.api.exceptions.NoRequiredPropertyException; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import org.apache.wiki.event.WikiEvent; import org.apache.wiki.event.WikiEventManager; import org.apache.wiki.event.WikiPageEvent; @@ -56,7 +56,7 @@ import java.util.Set; * * @since 2.2.21. */ -public class DefaultSearchManager extends BasicPageFilter implements SearchManager { +public class DefaultSearchManager extends BasePageFilter implements SearchManager { private static final Logger log = Logger.getLogger( DefaultSearchManager.class ); diff --git a/jspwiki-main/src/test/java/org/apache/wiki/filters/TestFilter.java b/jspwiki-main/src/test/java/org/apache/wiki/filters/TestFilter.java index a342ca4..0c443f1 100644 --- a/jspwiki-main/src/test/java/org/apache/wiki/filters/TestFilter.java +++ b/jspwiki-main/src/test/java/org/apache/wiki/filters/TestFilter.java @@ -19,12 +19,12 @@ package org.apache.wiki.filters; import org.apache.wiki.api.core.Engine; -import org.apache.wiki.api.filters.BasicPageFilter; +import org.apache.wiki.api.filters.BasePageFilter; import java.util.Properties; -public class TestFilter extends BasicPageFilter { +public class TestFilter extends BasePageFilter { public Properties m_properties; 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 7bc2859..5bbdd5d 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 @@ -22,7 +22,7 @@ import org.apache.wiki.TestEngine; import org.apache.wiki.api.core.Context; 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.api.filters.BasePageFilter; import org.apache.wiki.auth.Users; import org.apache.wiki.auth.WikiPrincipal; import org.apache.wiki.filters.FilterManager; @@ -286,7 +286,7 @@ public class ApprovalWorkflowTest { /** * Dummy PageFilter that always throws a FilterException during preSave operations. */ - public static class AbortFilter extends BasicPageFilter { + public static class AbortFilter extends BasePageFilter { @Override public String preSave( final Context wikiContext, final String content ) throws FilterException { throw new FilterException( "Page save aborted." );
