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 32c889f7a10e29f1483a4b96d6776180a30e30da Author: juanpablo <[email protected]> AuthorDate: Wed Feb 26 19:24:16 2020 +0100 JSPWIKI-120: remove use of WikiEngine throughout the code as much as possible and use Engine instead (6) --- .../wiki/workflow/DefaultWorkflowManager.java | 4 +-- .../org/apache/wiki/workflow/WorkflowBuilder.java | 4 +-- .../org/apache/wiki/workflow/WorkflowManager.java | 2 +- .../java/org/apache/wiki/xmlrpc/RPCHandler.java | 5 +--- .../java/org/apache/wiki/xmlrpc/RPCServlet.java | 30 ++++++++++------------ .../wiki/filters/DefaultFilterManagerTest.java | 22 ++++++++-------- .../java/org/apache/wiki/filters/TestFilter.java | 8 +++--- 7 files changed, 34 insertions(+), 41 deletions(-) diff --git a/jspwiki-main/src/main/java/org/apache/wiki/workflow/DefaultWorkflowManager.java b/jspwiki-main/src/main/java/org/apache/wiki/workflow/DefaultWorkflowManager.java index 0ace9d9..5459d10 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/workflow/DefaultWorkflowManager.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/workflow/DefaultWorkflowManager.java @@ -148,13 +148,13 @@ public class DefaultWorkflowManager implements WorkflowManager { } /** - * Protected helper method that returns the associated WikiEngine + * Protected helper method that returns the associated Engine * * @return the wiki engine */ protected Engine getEngine() { if ( m_engine == null ) { - throw new IllegalStateException( "WikiEngine cannot be null; please initialize WorkflowManager first." ); + throw new IllegalStateException( "Engine cannot be null; please initialize WorkflowManager first." ); } return m_engine; } diff --git a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowBuilder.java b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowBuilder.java index c18b8b8..95afafb 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowBuilder.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowBuilder.java @@ -34,7 +34,7 @@ public final class WorkflowBuilder { private final Engine m_engine; /** - * Private constructor that creates a new WorkflowBuilder for the supplied WikiEngine. + * Private constructor that creates a new WorkflowBuilder for the supplied Engine. * @param engine the wiki engine */ private WorkflowBuilder( final Engine engine ) @@ -43,7 +43,7 @@ public final class WorkflowBuilder { } /** - * Returns the WorkflowBuilder instance for a WikiEngine. Only one WorkflowBuilder + * Returns the WorkflowBuilder instance for a Engine. Only one WorkflowBuilder * exists for a given engine. * @param engine the wiki engine * @return the workflow builder diff --git a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java index 60858db..0322a21 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/workflow/WorkflowManager.java @@ -98,7 +98,7 @@ public interface WorkflowManager extends WikiEventListener { List< Workflow > getCompletedWorkflows(); /** - * Initializes the WorkflowManager using a specfied WikiEngine and properties. Any properties that begin with + * Initializes the WorkflowManager using a specfied Engine and properties. Any properties that begin with * {@link #PROPERTY_APPROVER_PREFIX} will be assumed to be Decisions that require approval. For a given property key, everything * after the prefix denotes the Decision's message key. The property value indicates the Principal (Role, GroupPrincipal, WikiPrincipal) * that must approve the Decision. For example, if the property key/value pair is {@code jspwiki.approver.workflow.saveWikiPage=Admin}, diff --git a/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCHandler.java b/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCHandler.java index 7bf5423..f343a63 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCHandler.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCHandler.java @@ -18,7 +18,6 @@ */ package org.apache.wiki.xmlrpc; -import org.apache.log4j.Logger; import org.apache.wiki.LinkCollector; import org.apache.wiki.WikiContext; import org.apache.wiki.WikiPage; @@ -43,11 +42,9 @@ import java.util.Vector; * * @since 1.6.6 */ -// We could use WikiEngine directly, but because of introspection it would show just too many methods to be safe. +// We could use Engine directly, but because of introspection it would show just too many methods to be safe. public class RPCHandler extends AbstractRPCHandler { - private static final Logger log = Logger.getLogger( RPCHandler.class ); - /** * Converts Java string into RPC string. */ diff --git a/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCServlet.java b/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCServlet.java index 29ec933..4259acc 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCServlet.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/xmlrpc/RPCServlet.java @@ -21,6 +21,7 @@ package org.apache.wiki.xmlrpc; import org.apache.log4j.Logger; import org.apache.wiki.WikiContext; import org.apache.wiki.WikiEngine; +import org.apache.wiki.api.core.Engine; import org.apache.xmlrpc.ContextXmlRpcHandler; import org.apache.xmlrpc.Invoker; import org.apache.xmlrpc.XmlRpcContext; @@ -49,17 +50,15 @@ import java.util.Vector; * * @since 1.6.6 */ -public class RPCServlet extends HttpServlet -{ +public class RPCServlet extends HttpServlet { private static final long serialVersionUID = 3976735878410416180L; - /** This is what is appended to each command, if the handler has - not been specified. */ + /** This is what is appended to each command, if the handler has not been specified. */ // FIXME: Should this be $default? public static final String XMLRPC_PREFIX = "wiki"; - private WikiEngine m_engine; - private XmlRpcServer m_xmlrpcServer = new XmlRpcServer(); + private Engine m_engine; + private XmlRpcServer m_xmlrpcServer = new XmlRpcServer(); private static final Logger log = Logger.getLogger( RPCServlet.class ); @@ -77,7 +76,7 @@ public class RPCServlet extends HttpServlet /** * Initializes the servlet. */ - public void init( final ServletConfig config ) throws ServletException { + @Override public void init( final ServletConfig config ) throws ServletException { m_engine = WikiEngine.getInstance( config ); String handlerName = config.getInitParameter( "handler" ); @@ -93,9 +92,7 @@ public class RPCServlet extends HttpServlet try { initHandler( prefix, handlerName ); - // // FIXME: The metaweblog API should be possible to turn off. - // initHandler( "metaWeblog", "org.apache.wiki.xmlrpc.MetaWeblogHandler" ); } catch( final Exception e ) { log.fatal("Unable to start RPC interface: ", e); @@ -106,7 +103,7 @@ public class RPCServlet extends HttpServlet /** * Handle HTTP POST. This is an XML-RPC call, and we'll just forward the query to an XmlRpcServer. */ - public void doPost( final HttpServletRequest request, final HttpServletResponse response ) throws ServletException { + @Override public void doPost( final HttpServletRequest request, final HttpServletResponse response ) throws ServletException { log.debug("Received POST to RPCServlet"); try { @@ -135,7 +132,7 @@ public class RPCServlet extends HttpServlet /** * Handles HTTP GET. However, we do not respond to GET requests, other than to show an explanatory text. */ - public void doGet( final HttpServletRequest request, final HttpServletResponse response ) throws ServletException { + @Override public void doGet( final HttpServletRequest request, final HttpServletResponse response ) throws ServletException { log.debug("Received HTTP GET to RPCServlet"); try { @@ -160,7 +157,7 @@ public class RPCServlet extends HttpServlet m_clazz = clazz; } - public Object execute( final String method, final Vector params, final XmlRpcContext context ) throws Exception { + @Override public Object execute( final String method, final Vector params, final XmlRpcContext context ) throws Exception { final WikiRPCHandler rpchandler = (WikiRPCHandler) m_clazz.newInstance(); rpchandler.initialize( ((WikiXmlRpcContext)context).getWikiContext() ); @@ -179,18 +176,16 @@ public class RPCServlet extends HttpServlet m_context = ctx; } - public XmlRpcHandlerMapping getHandlerMapping() + @Override public XmlRpcHandlerMapping getHandlerMapping() { return m_mapping; } - public String getPassword() { - // TODO Auto-generated method stub + @Override public String getPassword() { return null; } - public String getUserName() { - // TODO Auto-generated method stub + @Override public String getUserName() { return null; } @@ -199,4 +194,5 @@ public class RPCServlet extends HttpServlet return m_context; } } + } 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 91b665b..3534901 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 @@ -16,8 +16,8 @@ specific language governing permissions and limitations under the License. */ - package org.apache.wiki.filters; + import org.apache.wiki.TestEngine; import org.apache.wiki.api.engine.FilterManager; import org.apache.wiki.api.filters.PageFilter; @@ -35,33 +35,33 @@ public class DefaultFilterManagerTest { @Test public void testInitFilters() throws Exception { - FilterManager m = new DefaultFilterManager( engine, props ); + final FilterManager m = new DefaultFilterManager( engine, props ); - List<PageFilter> l = m.getFilterList(); + final List<PageFilter> l = m.getFilterList(); Assertions.assertEquals( 2, l.size(), "Wrong number of filters" ); - Iterator<PageFilter> i = l.iterator(); - PageFilter f1 = i.next(); + final Iterator<PageFilter> i = l.iterator(); + final PageFilter f1 = i.next(); Assertions.assertTrue( f1 instanceof ProfanityFilter, "Not a Profanityfilter" ); - PageFilter f2 = i.next(); + final PageFilter f2 = i.next(); Assertions.assertTrue( f2 instanceof TestFilter, "Not a Testfilter" ); } @Test public void testInitParams() throws Exception { - FilterManager m = new DefaultFilterManager( engine, props ); + final FilterManager m = new DefaultFilterManager( engine, props ); - List<PageFilter> l = m.getFilterList(); + final List<PageFilter> l = m.getFilterList(); - Iterator<PageFilter> i = l.iterator(); + final Iterator<PageFilter> i = l.iterator(); i.next(); - TestFilter f2 = (TestFilter)i.next(); + final TestFilter f2 = (TestFilter)i.next(); - Properties p = f2.m_properties; + final Properties p = f2.m_properties; Assertions.assertEquals( "Zippadippadai", p.getProperty("foobar"), "no foobar" ); 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 3e7996e..044af74 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 @@ -18,17 +18,17 @@ */ package org.apache.wiki.filters; -import java.util.Properties; - -import org.apache.wiki.WikiEngine; +import org.apache.wiki.api.core.Engine; import org.apache.wiki.api.filters.BasicPageFilter; +import java.util.Properties; + public class TestFilter extends BasicPageFilter { public Properties m_properties; - public void initialize( WikiEngine engine, Properties props ) { + @Override public void initialize( final Engine engine, final Properties props ) { m_properties = props; }
