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/02/27 15:10:34 UTC
[jspwiki] 09/20: JSPWIKI-120: remove use of WikiEngine throughout
the code as much as possible and use Engine instead (4)
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 d6c25ea2523e499eb70ea7d60a9c3ee5cac98023
Author: juanpablo <ju...@apache.org>
AuthorDate: Wed Feb 26 19:23:31 2020 +0100
JSPWIKI-120: remove use of WikiEngine throughout the code as much as possible and use Engine instead (4)
---
.../apache/wiki/search/LuceneSearchProvider.java | 2 +-
.../java/org/apache/wiki/search/SearchManager.java | 11 ++++++-----
.../main/java/org/apache/wiki/tags/IncludeTag.java | 17 +++++++---------
.../main/java/org/apache/wiki/tags/LinkTag.java | 23 ++++++++++++----------
.../org/apache/wiki/variables/VariableManager.java | 2 +-
5 files changed, 28 insertions(+), 27 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/search/LuceneSearchProvider.java b/jspwiki-main/src/main/java/org/apache/wiki/search/LuceneSearchProvider.java
index 30fbed8..6a7555b 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/search/LuceneSearchProvider.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/search/LuceneSearchProvider.java
@@ -175,7 +175,7 @@ public class LuceneSearchProvider implements SearchProvider {
/**
* Returns the handling engine.
*
- * @return Current WikiEngine
+ * @return Current Engine
*/
protected Engine getEngine()
{
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java b/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
index 53e1c5d..dcc0eae 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/search/SearchManager.java
@@ -22,11 +22,11 @@ import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.time.StopWatch;
import org.apache.log4j.Logger;
import org.apache.wiki.WikiContext;
-import org.apache.wiki.WikiEngine;
import org.apache.wiki.WikiPage;
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.exceptions.FilterException;
import org.apache.wiki.api.exceptions.NoRequiredPropertyException;
import org.apache.wiki.api.exceptions.ProviderException;
@@ -38,6 +38,7 @@ import org.apache.wiki.event.WikiPageEvent;
import org.apache.wiki.modules.InternalModule;
import org.apache.wiki.pages.PageManager;
import org.apache.wiki.parser.MarkupParser;
+import org.apache.wiki.references.ReferenceManager;
import org.apache.wiki.util.ClassUtil;
import javax.servlet.ServletException;
@@ -75,11 +76,11 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
/**
* Creates a new SearchManager.
*
- * @param engine The WikiEngine that owns this SearchManager.
+ * @param engine The Engine that owns this SearchManager.
* @param properties The list of Properties.
* @throws FilterException If it cannot be instantiated.
*/
- public SearchManager( final WikiEngine engine, final Properties properties ) throws FilterException {
+ public SearchManager( final Engine engine, final Properties properties ) throws FilterException {
initialize( engine, properties );
WikiEventManager.getInstance().addWikiEventListener( m_engine.getManager( PageManager.class ), this );
@@ -163,7 +164,7 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
final String cleanWikiName = MarkupParser.cleanLink(wikiName).toLowerCase() + filename;
final String oldStyleName = MarkupParser.wikifyLink(wikiName).toLowerCase() + filename;
- final Set< String > allPages = m_engine.getReferenceManager().findCreated();
+ final Set< String > allPages = m_engine.getManager( ReferenceManager.class ).findCreated();
int counter = 0;
for( final Iterator< String > i = allPages.iterator(); i.hasNext() && counter < maxLength; ) {
@@ -236,7 +237,7 @@ public class SearchManager extends BasicPageFilter implements InternalModule, Wi
* @throws FilterException if the search provider failed to initialize
*/
@Override
- public void initialize( final WikiEngine engine, final Properties properties ) throws FilterException {
+ public void initialize( final Engine engine, final Properties properties ) throws FilterException {
m_engine = engine;
loadSearchProvider(properties);
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tags/IncludeTag.java b/jspwiki-main/src/main/java/org/apache/wiki/tags/IncludeTag.java
index 8332c63..9d1d67e 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tags/IncludeTag.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tags/IncludeTag.java
@@ -28,8 +28,7 @@ import javax.servlet.jsp.JspException;
import java.io.IOException;
/**
- * Includes an another JSP page, making sure that we actually pass
- * the WikiContext correctly.
+ * Includes an another JSP page, making sure that we actually pass the WikiContext correctly.
*
* @since 2.0
*/
@@ -41,7 +40,8 @@ public class IncludeTag extends WikiTagBase {
protected String m_page;
- @Override public void initTag() {
+ @Override
+ public void initTag() {
super.initTag();
m_page = null;
}
@@ -56,16 +56,13 @@ public class IncludeTag extends WikiTagBase {
return m_page;
}
- @Override public final int doWikiStartTag()
- throws IOException,
- ProviderException
- {
- // WikiEngine engine = m_wikiContext.getEngine();
-
+ @Override
+ public final int doWikiStartTag() throws IOException, ProviderException {
return SKIP_BODY;
}
- @Override public final int doEndTag() throws JspException {
+ @Override
+ public final int doEndTag() throws JspException {
try {
final String page = m_wikiContext.getEngine().getManager( TemplateManager.class ).findJSP( pageContext,
m_wikiContext.getTemplate(),
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/tags/LinkTag.java b/jspwiki-main/src/main/java/org/apache/wiki/tags/LinkTag.java
index c4609ed..b5badf2 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/tags/LinkTag.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/tags/LinkTag.java
@@ -41,7 +41,7 @@ import java.util.Map;
/**
* Provides a generic link tag for all kinds of linking purposes.
* <p>
- * If parameter <i>jsp</i> is defined, constructs a URL pointing to the specified JSP page, under the baseURL known by the WikiEngine.
+ * If parameter <i>jsp</i> is defined, constructs a URL pointing to the specified JSP page, under the baseURL known by the Engine.
* Any ParamTag name-value pairs contained in the body are added to this URL to provide support for arbitrary JSP calls.
* <p>
* @since 2.3.50
@@ -69,7 +69,8 @@ public class LinkTag extends WikiLinkTag implements ParamHandler, BodyTag {
private BodyContent m_bodyContent;
- @Override public void initTag() {
+ @Override
+ public void initTag() {
super.initTag();
m_version = m_cssClass = m_style = m_title = m_target = m_compareToVersion = m_rel = m_jsp = m_ref = m_accesskey = m_templatefile = null;
m_context = WikiContext.VIEW;
@@ -149,7 +150,8 @@ public class LinkTag extends WikiLinkTag implements ParamHandler, BodyTag {
/**
* Support for ParamTag supplied parameters in body.
*/
- @Override public void setContainedParameter( final String name, final String value ) {
+ @Override
+ public void setContainedParameter( final String name, final String value ) {
if( name != null ) {
if( m_containedParams == null ) {
m_containedParams = new HashMap<>();
@@ -205,11 +207,8 @@ public class LinkTag extends WikiLinkTag implements ParamHandler, BodyTag {
final String parms = (m_version != null) ? "version="+getVersion() : null;
- //
// Internal wiki link, but is it an attachment link?
- //
final WikiPage p = engine.getManager( PageManager.class ).getPage( m_pageName );
-
if( p instanceof Attachment ) {
url = m_wikiContext.getURL( WikiContext.ATTACH, m_pageName );
} else if( (hashMark = m_ref.indexOf('#')) != -1 ) {
@@ -326,11 +325,13 @@ public class LinkTag extends WikiLinkTag implements ParamHandler, BodyTag {
return engine.getURL( m_context, m_pageName, parms );
}
- @Override public int doWikiStartTag() throws Exception {
+ @Override
+ public int doWikiStartTag() throws Exception {
return EVAL_BODY_BUFFERED;
}
- @Override public int doEndTag() {
+ @Override
+ public int doEndTag() {
try {
final Engine engine = m_wikiContext.getEngine();
final JspWriter out = pageContext.getOut();
@@ -376,12 +377,14 @@ public class LinkTag extends WikiLinkTag implements ParamHandler, BodyTag {
return EVAL_PAGE;
}
- @Override public void setBodyContent( final BodyContent bc )
+ @Override
+ public void setBodyContent( final BodyContent bc )
{
m_bodyContent = bc;
}
- @Override public void doInitBody() {
+ @Override
+ public void doInitBody() {
}
}
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/variables/VariableManager.java b/jspwiki-main/src/main/java/org/apache/wiki/variables/VariableManager.java
index bb94598..8387902 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/variables/VariableManager.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/variables/VariableManager.java
@@ -79,7 +79,7 @@ public interface VariableManager {
* @param context WikiContext to look the variable in
* @param name Name of the variable to look for
* @return Variable value, or null, if there is no such variable.
- * @since 2.2 on WikiEngine, moved to VariableManager on 2.11.0
+ * @since 2.2 on Engine, moved to VariableManager on 2.11.0
*/
String getVariable( WikiContext context, String name );