base class for module-based JSPWiki AdminBeans
Project: http://git-wip-us.apache.org/repos/asf/jspwiki/repo Commit: http://git-wip-us.apache.org/repos/asf/jspwiki/commit/6c2b1065 Tree: http://git-wip-us.apache.org/repos/asf/jspwiki/tree/6c2b1065 Diff: http://git-wip-us.apache.org/repos/asf/jspwiki/diff/6c2b1065 Branch: refs/heads/master Commit: 6c2b1065cfb0a29944eb23d0b49d2b281b37f10a Parents: 4621e46 Author: juanpablo <juanpa...@apache.org> Authored: Tue Aug 22 20:01:37 2017 +0200 Committer: juanpablo <juanpa...@apache.org> Committed: Tue Aug 22 20:01:37 2017 +0200 ---------------------------------------------------------------------- .../apache/wiki/ui/admin/beans/ModuleBean.java | 118 +++++++++++++++++++ 1 file changed, 118 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/jspwiki/blob/6c2b1065/jspwiki-war/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java ---------------------------------------------------------------------- diff --git a/jspwiki-war/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java b/jspwiki-war/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java new file mode 100755 index 0000000..35d0308 --- /dev/null +++ b/jspwiki-war/src/main/java/org/apache/wiki/ui/admin/beans/ModuleBean.java @@ -0,0 +1,118 @@ +/* + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +*/ +package org.apache.wiki.ui.admin.beans; + +import java.util.Collection; + +import javax.management.NotCompliantMBeanException; + +import org.apache.commons.lang.StringUtils; +import org.apache.wiki.Release; +import org.apache.wiki.WikiContext; +import org.apache.wiki.WikiEngine; +import org.apache.wiki.modules.WikiModuleInfo; +import org.apache.wiki.ui.admin.SimpleAdminBean; +import org.apache.wiki.util.XHTML; +import org.apache.wiki.util.XhtmlUtil; +import org.jdom2.Element; + +public abstract class ModuleBean< T extends WikiModuleInfo > extends SimpleAdminBean { + + protected WikiEngine m_engine; + + private static final String VER_WARNING = "<span class='warning'>This module is not compatible with this version of JSPWiki.</span>"; + + public ModuleBean( WikiEngine engine ) throws NotCompliantMBeanException { + m_engine = engine; + } + + /** + * {@inheritDoc} + */ + public String[] getAttributeNames() { + return new String[0]; + } + + /** + * {@inheritDoc} + */ + public String[] getMethodNames() { + return new String[0]; + } + + /** + * {@inheritDoc} + */ + public String doGet( WikiContext context ) { + Collection< T > filters = modules(); + Element root = title(); + Element tb = containerForModuleDetail( root ); + + Element trHead = heading(); + tb.addContent( trHead ); + + for( T info : filters ) { + Element tr = rowBody( info ); + tb.addContent( tr ); + } + + return XhtmlUtil.serialize( root, XhtmlUtil.EXPAND_EMPTY_NODES ); + } + + protected Element title() { + Element root = XhtmlUtil.element( XHTML.div ); + root.addContent( XhtmlUtil.element( XHTML.h4 ).addContent( getTitle() ) ); + return root; + } + + protected Element containerForModuleDetail( Element root ) { + Element tb = XhtmlUtil.element( XHTML.table ).setAttribute( "border", "1" ); + root.addContent( tb ); + return tb; + } + + /** + * Obtains the collection of modules which is going to be inspected at {@link #doGet(WikiContext)}. + * + * @return a collection of {@link WikiModuleInfo} + */ + protected abstract Collection< T > modules(); + + /** + * html blob describing the values of each {@link WikiModuleInfo} inspected. + * + * @return {@link Element} describing the values of each {@link WikiModuleInfo} inspected. + */ + protected abstract Element heading(); + + /** + * html blob describing{@link Element} describing attributes + * + * @param module {@link WikiModuleInfo} inspected. + * @return {@link Element} describing the {@link Element} inspected. + */ + protected abstract Element rowBody( T module ); + + protected String validModuleVersion( T info ) { + return Release.isNewerOrEqual( info.getMinVersion() ) && Release.isOlderOrEqual( info.getMaxVersion() ) + ? StringUtils.EMPTY + : VER_WARNING; + } + +}
