CAMEL-10844: Component docs - Remove .html generated files in components
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/340fcabc Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/340fcabc Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/340fcabc Branch: refs/heads/master Commit: 340fcabcf6da9f90e48e7604242ee3508f71f1c9 Parents: 6769dd2 Author: Claus Ibsen <davscl...@apache.org> Authored: Thu Feb 16 10:07:21 2017 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Feb 16 11:08:26 2017 +0100 ---------------------------------------------------------------------- .../java/org/apache/camel/CamelContext.java | 2 + .../mbean/ManagedCamelContextMBean.java | 2 + .../apache/camel/impl/DefaultCamelContext.java | 46 +----- .../management/mbean/ManagedCamelContext.java | 2 +- .../camel/component/ComponentDiscoveryTest.java | 8 - .../camel/blueprint/BlueprintCamelContext.java | 5 - .../src/test/resources/log4j2.properties | 28 ++++ .../core/osgi/OsgiDefaultCamelContext.java | 5 - .../core/osgi/utils/BundleContextUtils.java | 18 --- .../component/twitter/UriConfigurationTest.java | 29 +--- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 7 - ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 7 - ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- ...ponentConfigurationAndDocumentationTest.java | 9 -- .../tools/apt/EndpointAnnotationProcessor.java | 162 +------------------ .../tools/apt/ModelAnnotationProcessor.java | 4 +- .../tools/apt/helper/JsonSchemaHelper.java | 2 +- .../camel/tools/apt/model/ComponentOption.java | 10 -- .../camel/tools/apt/model/EndpointOption.java | 10 -- .../camel/tools/apt/model/EndpointPath.java | 10 -- 32 files changed, 44 insertions(+), 439 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/camel-core/src/main/java/org/apache/camel/CamelContext.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/CamelContext.java b/camel-core/src/main/java/org/apache/camel/CamelContext.java index b0ea66b..84269a3 100644 --- a/camel-core/src/main/java/org/apache/camel/CamelContext.java +++ b/camel-core/src/main/java/org/apache/camel/CamelContext.java @@ -1730,7 +1730,9 @@ public interface CamelContext extends SuspendableService, RuntimeConfiguration { * Returns the HTML documentation for the given Camel component * * @return the HTML or <tt>null</tt> if the component is <b>not</b> built with HTML document included. + * @deprecated use camel-catalog instead */ + @Deprecated String getComponentDocumentation(String componentName) throws IOException; /** http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java index b30e73e..c8767fc 100644 --- a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java +++ b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java @@ -381,8 +381,10 @@ public interface ManagedCamelContextMBean extends ManagedPerformanceCounterMBean * Returns the HTML documentation for the given camel component * * @param componentName the component name + * @deprecated use camel-catalog instead */ @ManagedOperation(description = "Returns the HTML documentation for the given camel component") + @Deprecated String getComponentDocumentation(String componentName) throws IOException; @ManagedOperation(description = "Returns the JSON representation of all the static and dynamic endpoints defined in all the routes") http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java index 707366d..6a2db9e 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java @@ -1414,51 +1414,7 @@ public class DefaultCamelContext extends ServiceSupport implements ModelCamelCon } public String getComponentDocumentation(String componentName) throws IOException { - // use the component factory finder to find the package name of the component class, which is the location - // where the documentation exists as well - FactoryFinder finder = getFactoryFinder(DefaultComponentResolver.RESOURCE_PATH); - try { - Class<?> clazz = null; - try { - clazz = finder.findClass(componentName); - } catch (NoFactoryAvailableException e) { - // ignore, i.e. if a component is an auto-configured spring-boot - // components - } - - if (clazz == null) { - // fallback and find existing component - Component existing = hasComponent(componentName); - if (existing != null) { - clazz = existing.getClass(); - } else { - return null; - } - } - - String packageName = clazz.getPackage().getName(); - packageName = packageName.replace('.', '/'); - String path = packageName + "/" + componentName + ".html"; - - ClassResolver resolver = getClassResolver(); - InputStream inputStream = resolver.loadResourceAsStream(path); - log.debug("Loading component documentation for: {} using class resolver: {} -> {}", new Object[]{componentName, resolver, inputStream}); - if (inputStream != null) { - try { - return IOHelper.loadText(inputStream); - } finally { - IOHelper.close(inputStream); - } - } - // special for ActiveMQ as it is really just JMS - if ("ActiveMQComponent".equals(clazz.getSimpleName())) { - return getComponentDocumentation("jms"); - } else { - return null; - } - } catch (ClassNotFoundException e) { - return null; - } + return null; } public String getComponentParameterJsonSchema(String componentName) throws IOException { http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java index b419ea3..0ea16a0 100644 --- a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java +++ b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedCamelContext.java @@ -648,7 +648,7 @@ public class ManagedCamelContext extends ManagedPerformanceCounter implements Ti } public String getComponentDocumentation(String componentName) throws IOException { - return context.getComponentDocumentation(componentName); + return null; } public String createRouteStaticEndpointJson() { http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/camel-core/src/test/java/org/apache/camel/component/ComponentDiscoveryTest.java ---------------------------------------------------------------------- diff --git a/camel-core/src/test/java/org/apache/camel/component/ComponentDiscoveryTest.java b/camel-core/src/test/java/org/apache/camel/component/ComponentDiscoveryTest.java index 81708ab..6138bcb 100644 --- a/camel-core/src/test/java/org/apache/camel/component/ComponentDiscoveryTest.java +++ b/camel-core/src/test/java/org/apache/camel/component/ComponentDiscoveryTest.java @@ -57,12 +57,4 @@ public class ComponentDiscoveryTest { } } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("bean"); - assertNotNull("Should have found some auto-generated HTML", html); - LOG.info("HTML: " + html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/components/camel-blueprint/src/main/java/org/apache/camel/blueprint/BlueprintCamelContext.java ---------------------------------------------------------------------- diff --git a/components/camel-blueprint/src/main/java/org/apache/camel/blueprint/BlueprintCamelContext.java b/components/camel-blueprint/src/main/java/org/apache/camel/blueprint/BlueprintCamelContext.java index 9b2a861..35155bf 100644 --- a/components/camel-blueprint/src/main/java/org/apache/camel/blueprint/BlueprintCamelContext.java +++ b/components/camel-blueprint/src/main/java/org/apache/camel/blueprint/BlueprintCamelContext.java @@ -137,11 +137,6 @@ public class BlueprintCamelContext extends DefaultCamelContext implements Servic } @Override - public String getComponentDocumentation(String componentName) throws IOException { - return BundleContextUtils.getComponentDocumentation(bundleContext, this, componentName); - } - - @Override public void blueprintEvent(BlueprintEvent event) { if (LOG.isDebugEnabled()) { String eventTypeString; http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/components/camel-blueprint/src/test/resources/log4j2.properties ---------------------------------------------------------------------- diff --git a/components/camel-blueprint/src/test/resources/log4j2.properties b/components/camel-blueprint/src/test/resources/log4j2.properties new file mode 100644 index 0000000..82424b6 --- /dev/null +++ b/components/camel-blueprint/src/test/resources/log4j2.properties @@ -0,0 +1,28 @@ +## --------------------------------------------------------------------------- +## 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. +## --------------------------------------------------------------------------- + +appender.file.type = File +appender.file.name = file +appender.file.fileName = target/camel-blueprint-test.log +appender.file.layout.type = PatternLayout +appender.file.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +appender.out.type = Console +appender.out.name = out +appender.out.layout.type = PatternLayout +appender.out.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +rootLogger.level = INFO +rootLogger.appenderRef.file.ref = file http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/OsgiDefaultCamelContext.java ---------------------------------------------------------------------- diff --git a/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/OsgiDefaultCamelContext.java b/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/OsgiDefaultCamelContext.java index a4c13cd..20e3a21 100644 --- a/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/OsgiDefaultCamelContext.java +++ b/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/OsgiDefaultCamelContext.java @@ -53,11 +53,6 @@ public class OsgiDefaultCamelContext extends DefaultCamelContext { } @Override - public String getComponentDocumentation(String componentName) throws IOException { - return BundleContextUtils.getComponentDocumentation(bundleContext, this, componentName); - } - - @Override protected Registry createRegistry() { if (registry != null) { return OsgiCamelContextHelper.wrapRegistry(this, registry, bundleContext); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/utils/BundleContextUtils.java ---------------------------------------------------------------------- diff --git a/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/utils/BundleContextUtils.java b/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/utils/BundleContextUtils.java index f4750f7..ce7af15 100644 --- a/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/utils/BundleContextUtils.java +++ b/components/camel-core-osgi/src/main/java/org/apache/camel/core/osgi/utils/BundleContextUtils.java @@ -17,7 +17,6 @@ package org.apache.camel.core.osgi.utils; import java.io.IOException; -import java.io.InputStream; import java.lang.reflect.Method; import java.net.URL; import java.util.Enumeration; @@ -28,7 +27,6 @@ import java.util.TreeMap; import org.apache.camel.CamelContext; import org.apache.camel.util.CamelContextHelper; -import org.apache.camel.util.IOHelper; import org.apache.camel.util.LoadPropertiesException; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; @@ -92,20 +90,4 @@ public final class BundleContextUtils { return answer; } - public static String getComponentDocumentation(BundleContext bundleContext, - CamelContext camelContext, - String componentName) throws IOException { - String path = CamelContextHelper.COMPONENT_DOCUMENTATION_PREFIX + componentName + ".html"; - Bundle[] bundles = bundleContext.getBundles(); - for (Bundle bundle : bundles) { - URL resource = bundle.getResource(path); - if (resource != null) { - InputStream inputStream = resource.openStream(); - if (inputStream != null) { - return IOHelper.loadText(inputStream); - } - } - } - return null; - } } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/components/camel-twitter/src/test/java/org/apache/camel/component/twitter/UriConfigurationTest.java ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/test/java/org/apache/camel/component/twitter/UriConfigurationTest.java b/components/camel-twitter/src/test/java/org/apache/camel/component/twitter/UriConfigurationTest.java index c4bcd9b..a660dd8 100644 --- a/components/camel-twitter/src/test/java/org/apache/camel/component/twitter/UriConfigurationTest.java +++ b/components/camel-twitter/src/test/java/org/apache/camel/component/twitter/UriConfigurationTest.java @@ -17,21 +17,19 @@ package org.apache.camel.component.twitter; import org.apache.camel.CamelContext; -import org.apache.camel.ComponentConfiguration; import org.apache.camel.Endpoint; -import org.apache.camel.EndpointConfiguration; import org.apache.camel.impl.DefaultCamelContext; import org.junit.Assert; import org.junit.Test; public class UriConfigurationTest extends Assert { - private CamelContext context = new DefaultCamelContext(); + private CamelContext context = new DefaultCamelContext(); private CamelTwitterTestSupport support = new CamelTwitterTestSupport(); @Test public void testBasicAuthentication() throws Exception { - Endpoint endpoint = context.getEndpoint("twitter:todo/todo?" + support.getUriTokens()); + Endpoint endpoint = context.getEndpoint("twitter:search?" + support.getUriTokens()); assertTrue("Endpoint not a TwitterEndpoint: " + endpoint, endpoint instanceof TwitterEndpoint); TwitterEndpoint twitterEndpoint = (TwitterEndpoint) endpoint; @@ -43,7 +41,7 @@ public class UriConfigurationTest extends Assert { @Test public void testPageSetting() throws Exception { - Endpoint endpoint = context.getEndpoint("twitter:todo/page?count=50&numberOfPages=2"); + Endpoint endpoint = context.getEndpoint("twitter:search?count=50&numberOfPages=2"); assertTrue("Endpoint not a TwitterEndpoint: " + endpoint, endpoint instanceof TwitterEndpoint); TwitterEndpoint twitterEndpoint = (TwitterEndpoint) endpoint; @@ -53,7 +51,7 @@ public class UriConfigurationTest extends Assert { @Test public void testHttpProxySetting() throws Exception { - Endpoint endpoint = context.getEndpoint("twitter:todo/todo?httpProxyHost=example.com&httpProxyPort=3338&httpProxyUser=test&httpProxyPassword=pwd"); + Endpoint endpoint = context.getEndpoint("twitter:search?httpProxyHost=example.com&httpProxyPort=3338&httpProxyUser=test&httpProxyPassword=pwd"); assertTrue("Endpoint not a TwitterEndpoint: " + endpoint, endpoint instanceof TwitterEndpoint); TwitterEndpoint twitterEndpoint = (TwitterEndpoint) endpoint; @@ -62,24 +60,5 @@ public class UriConfigurationTest extends Assert { assertEquals("test", twitterEndpoint.getProperties().getHttpProxyUser()); assertEquals("pwd", twitterEndpoint.getProperties().getHttpProxyPassword()); } - - @Test - public void testComponentConfiguration() throws Exception { - TwitterComponent comp = context.getComponent("twitter", TwitterComponent.class); - EndpointConfiguration conf = comp.createConfiguration("twitter:search?keywords=camel"); - - assertEquals("camel", conf.getParameter("keywords")); - - ComponentConfiguration compConf = comp.createComponentConfiguration(); - String json = compConf.createParameterJsonSchema(); - assertNotNull(json); - } - - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("twitter"); - assertNotNull("Should have found some auto-generated HTML", html); - } } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BeanComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BeanComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BeanComponentConfigurationAndDocumentationTest.java index f9be799..e8c5cfb 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BeanComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BeanComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.bean.BeanComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class BeanComponentConfigurationAndDocumentationTest extends CamelTestSup assertTrue(json.contains("\"cache\": { \"kind\": \"parameter\", \"group\": \"advanced\", \"label\": \"advanced\", \"type\": \"boolean\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("bean"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BrowseComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BrowseComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BrowseComponentConfigurationAndDocumentationTest.java index 3b607cc..5e93898 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BrowseComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/BrowseComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.browse.BrowseComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class BrowseComponentConfigurationAndDocumentationTest extends CamelTestS assertTrue(json.contains("\"synchronous\": { \"kind\": \"parameter\", \"group\": \"advanced\", \"label\": \"advanced\", \"type\": \"boolean\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("browse"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/ControlBusComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/ControlBusComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/ControlBusComponentConfigurationAndDocumentationTest.java index 344f20a..f876b61 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/ControlBusComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/ControlBusComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.controlbus.ControlBusComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -47,11 +45,4 @@ public class ControlBusComponentConfigurationAndDocumentationTest extends CamelT assertTrue(json.contains("\"async\": { \"kind\": \"parameter\", \"group\": \"producer\", \"type\": \"boolean\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("controlbus"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataFormatComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataFormatComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataFormatComponentConfigurationAndDocumentationTest.java index 33f732b..2dc0f58 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataFormatComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataFormatComponentConfigurationAndDocumentationTest.java @@ -53,13 +53,6 @@ public class DataFormatComponentConfigurationAndDocumentationTest extends CamelT } @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("dataformat"); - assertNotNull("Should have found some auto-generated HTML", html); - } - - @Test public void testFlatpackDefaultValue() throws Exception { CamelContext context = new DefaultCamelContext(); String json = context.getEipParameterJsonSchema("flatpack"); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataSetComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataSetComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataSetComponentConfigurationAndDocumentationTest.java index 5a41c1f..0c324fa 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataSetComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DataSetComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.dataset.DataSetComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -52,11 +50,4 @@ public class DataSetComponentConfigurationAndDocumentationTest extends CamelTest assertTrue(json.contains("\"retainFirst\": { \"kind\": \"parameter\", \"group\": \"producer\", \"label\": \"producer\", \"type\": \"integer")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("dataset"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectComponentConfigurationAndDocumentationTest.java index 40ea1b8..bd23882 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectComponentConfigurationAndDocumentationTest.java @@ -47,13 +47,6 @@ public class DirectComponentConfigurationAndDocumentationTest extends CamelTestS } @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("direct"); - assertNotNull("Should have found some auto-generated HTML", html); - } - - @Test public void testComponentJsonSchema() throws Exception { CamelContext context = new DefaultCamelContext(); String json = context.getComponentParameterJsonSchema("direct"); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectVmComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectVmComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectVmComponentConfigurationAndDocumentationTest.java index c43e20c..57d7fff 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectVmComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/DirectVmComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.directvm.DirectVmComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class DirectVmComponentConfigurationAndDocumentationTest extends CamelTes assertTrue(json.contains("\"timeout\": { \"kind\": \"parameter\", \"group\": \"producer\", \"label\": \"producer\", \"type\": \"integer\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("direct-vm"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FileComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FileComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FileComponentConfigurationAndDocumentationTest.java index 0794e54..e221a1b 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FileComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FileComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.file.FileComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -47,11 +45,4 @@ public class FileComponentConfigurationAndDocumentationTest extends CamelTestSup assertTrue(json.contains("\"readLockMinAge\": { \"kind\": \"parameter\", \"group\": \"lock\", \"label\": \"consumer,lock\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("file"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FtpComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FtpComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FtpComponentConfigurationAndDocumentationTest.java index 7765360..3ef70c3 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FtpComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/FtpComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.file.remote.FtpComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -48,11 +46,4 @@ public class FtpComponentConfigurationAndDocumentationTest extends CamelTestSupp assertTrue(json.contains("\"username\": { \"kind\": \"parameter\", \"group\": \"security\", \"label\": \"security\", \"type\": \"string\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("ftp"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LanguageComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LanguageComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LanguageComponentConfigurationAndDocumentationTest.java index 75acaef..dc33117 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LanguageComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LanguageComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.language.LanguageComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class LanguageComponentConfigurationAndDocumentationTest extends CamelTes assertTrue(json.contains("\"script\": { \"kind\": \"parameter\", \"group\": \"producer\", \"type\": \"string\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("language"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LogComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LogComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LogComponentConfigurationAndDocumentationTest.java index adbea39..f569eb6 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LogComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/LogComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.log.LogComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -47,11 +45,4 @@ public class LogComponentConfigurationAndDocumentationTest extends CamelTestSupp assertTrue(json.contains("\"showBody\": { \"kind\": \"parameter\", \"group\": \"formatting\", \"label\": \"formatting\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("log"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/MockComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/MockComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/MockComponentConfigurationAndDocumentationTest.java index f38fc1f..1058bbc 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/MockComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/MockComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.mock.MockComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -56,11 +54,4 @@ public class MockComponentConfigurationAndDocumentationTest extends CamelTestSup + " \"javaType\": \"int\", \"deprecated\": \"false\", \"secret\": \"false\", \"value\": \"10\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("mock"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/SedaComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/SedaComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/SedaComponentConfigurationAndDocumentationTest.java index fa94ed7..aa061a8 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/SedaComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/SedaComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.seda.SedaComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class SedaComponentConfigurationAndDocumentationTest extends CamelTestSup assertTrue(json.contains("\"timeout\": { \"kind\": \"parameter\", \"group\": \"producer\", \"label\": \"producer\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("seda"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TestComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TestComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TestComponentConfigurationAndDocumentationTest.java index 53394f7..a6cf07a 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TestComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TestComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.test.TestComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -46,11 +44,4 @@ public class TestComponentConfigurationAndDocumentationTest extends CamelTestSup assertTrue(json.contains("\"retainFirst\": { \"kind\": \"parameter\", \"group\": \"producer\", \"label\": \"producer\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("test"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TimerComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TimerComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TimerComponentConfigurationAndDocumentationTest.java index e9f0647..193ab07 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TimerComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/TimerComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.timer.TimerComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -47,11 +45,4 @@ public class TimerComponentConfigurationAndDocumentationTest extends CamelTestSu assertTrue(json.contains("\"timer\": { \"kind\": \"parameter\", \"group\": \"advanced\", \"label\": \"advanced\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("timer"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/XsltComponentConfigurationAndDocumentationTest.java ---------------------------------------------------------------------- diff --git a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/XsltComponentConfigurationAndDocumentationTest.java b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/XsltComponentConfigurationAndDocumentationTest.java index babc415..f286ea5 100644 --- a/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/XsltComponentConfigurationAndDocumentationTest.java +++ b/tests/camel-itest/src/test/java/org/apache/camel/itest/doc/XsltComponentConfigurationAndDocumentationTest.java @@ -16,11 +16,9 @@ */ package org.apache.camel.itest.doc; -import org.apache.camel.CamelContext; import org.apache.camel.ComponentConfiguration; import org.apache.camel.EndpointConfiguration; import org.apache.camel.component.xslt.XsltComponent; -import org.apache.camel.impl.DefaultCamelContext; import org.apache.camel.test.junit4.CamelTestSupport; import org.junit.Test; @@ -47,11 +45,4 @@ public class XsltComponentConfigurationAndDocumentationTest extends CamelTestSup assertTrue(json.contains("\"transformerFactoryClass\": { \"kind\": \"parameter\", \"group\": \"advanced\", \"label\": \"advanced\"")); } - @Test - public void testComponentDocumentation() throws Exception { - CamelContext context = new DefaultCamelContext(); - String html = context.getComponentDocumentation("xslt"); - assertNotNull("Should have found some auto-generated HTML", html); - } - } http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java index 2d88f78..29dc640 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java @@ -34,7 +34,6 @@ import javax.lang.model.element.ElementKind; import javax.lang.model.element.ExecutableElement; import javax.lang.model.element.TypeElement; import javax.lang.model.element.VariableElement; -import javax.lang.model.type.MirroredTypeException; import javax.lang.model.type.TypeKind; import javax.lang.model.type.TypeMirror; import javax.lang.model.util.ElementFilter; @@ -61,15 +60,13 @@ import static org.apache.camel.tools.apt.AnnotationProcessorHelper.findTypeEleme import static org.apache.camel.tools.apt.AnnotationProcessorHelper.implementsInterface; import static org.apache.camel.tools.apt.AnnotationProcessorHelper.loadResource; import static org.apache.camel.tools.apt.AnnotationProcessorHelper.processFile; -import static org.apache.camel.tools.apt.AnnotationProcessorHelper.warning; import static org.apache.camel.tools.apt.helper.JsonSchemaHelper.sanitizeDescription; import static org.apache.camel.tools.apt.helper.Strings.canonicalClassName; import static org.apache.camel.tools.apt.helper.Strings.getOrElse; import static org.apache.camel.tools.apt.helper.Strings.isNullOrEmpty; -import static org.apache.camel.tools.apt.helper.Strings.safeNull; /** - * Processes all Camel {@link UriEndpoint}s and generate json schema and html documentation for the endpoint/component. + * Processes all Camel {@link UriEndpoint}s and generate json schema documentation for the endpoint/component. */ @SupportedAnnotationTypes({"org.apache.camel.spi.*"}) @SupportedSourceVersion(SourceVersion.RELEASE_8) @@ -120,24 +117,13 @@ public class EndpointAnnotationProcessor extends AbstractProcessor { } final String aliasTitle = aTitle; - // write html documentation + // write json schema String name = canonicalClassName(classElement.getQualifiedName().toString()); String packageName = name.substring(0, name.lastIndexOf(".")); - String fileName = alias + ".html"; + String fileName = alias + ".json"; Func1<PrintWriter, Void> handler = new Func1<PrintWriter, Void>() { @Override public Void call(PrintWriter writer) { - writeHtmlDocumentation(writer, roundEnv, classElement, uriEndpoint, aliasTitle, alias, extendsAlias, label, schemes); - return null; - } - }; - processFile(processingEnv, packageName, fileName, handler); - - // write json schema - fileName = alias + ".json"; - handler = new Func1<PrintWriter, Void>() { - @Override - public Void call(PrintWriter writer) { writeJSonSchemeDocumentation(writer, roundEnv, classElement, uriEndpoint, aliasTitle, alias, extendsAlias, label, schemes); return null; } @@ -148,82 +134,6 @@ public class EndpointAnnotationProcessor extends AbstractProcessor { } } - protected void writeHtmlDocumentation(PrintWriter writer, RoundEnvironment roundEnv, TypeElement classElement, UriEndpoint uriEndpoint, - String title, String scheme, String extendsScheme, String label, String[] schemes) { - // gather component information - ComponentModel componentModel = findComponentProperties(roundEnv, uriEndpoint, classElement, title, scheme, extendsScheme, label); - - String syntax = componentModel.getSyntax(); - String alternativeSyntax = componentModel.getAlternativeSyntax(); - String description = componentModel.getDescription(); - String firstVersion = componentModel.getFirstVersion(); - - writer.println("<html>"); - writer.println("<header>"); - writer.println("<title>" + title + "</title>"); - writer.println("</header>"); - writer.println("<body>"); - writer.println("<h1>" + title + "</h1>"); - if (!Strings.isNullOrEmpty(firstVersion)) { - writer.println("<b>Available from version:</b> " + firstVersion + "<br/>"); - } - writer.println("<b>Scheme:</b> " + scheme + "<br/>"); - writer.println("<b>Syntax:</b> " + syntax + "<br/>"); - if (alternativeSyntax != null) { - writer.println("<b>Alternative Syntax:</b> " + alternativeSyntax + "<br/>"); - } - // the first scheme is the regular so only output if there is alternatives - if (schemes != null && schemes.length > 1) { - CollectionStringBuffer csb = new CollectionStringBuffer(","); - for (String altScheme : schemes) { - csb.append(altScheme); - } - writer.println("<b>Alternative Schemes:</b> " + csb.toString() + "<br/>"); - } - writer.println("<b>Description:</b> " + description + "<br/>"); - writer.println("<b>Deprecated:</b>" + componentModel.isDeprecated() + "<br/>"); - if (componentModel.isConsumerOnly()) { - writer.println("<b>ConsumerOnly:</b>" + "true" + "<br/>"); - } - if (componentModel.isProducerOnly()) { - writer.println("<b>ProducerOnly:</b>" + "true" + "<br/>"); - } - writer.println("<b>Async:</b>" + componentModel.isAsync() + "<br/>"); - writer.println("<b>Maven:</b> " + componentModel.getGroupId() + "/" + componentModel.getArtifactId() + "/" + componentModel.getVersionId() + "<br/>"); - - writeHtmlDocumentationAndFieldInjections(writer, roundEnv, componentModel, classElement, "", uriEndpoint.excludeProperties()); - - // only if its a consumer capable component - if (uriEndpoint.consumerOnly() || !uriEndpoint.producerOnly()) { - // This code is not my fault, it seems to honestly be the hacky way to find a class name in APT :) - TypeMirror consumerType = null; - try { - uriEndpoint.consumerClass(); - } catch (MirroredTypeException mte) { - consumerType = mte.getTypeMirror(); - } - - boolean found = false; - String consumerClassName = null; - String consumerPrefix = getOrElse(uriEndpoint.consumerPrefix(), ""); - if (consumerType != null) { - consumerClassName = consumerType.toString(); - TypeElement consumerElement = findTypeElement(processingEnv, roundEnv, consumerClassName); - if (consumerElement != null) { - writer.println("<h2>" + scheme + " consumer" + "</h2>"); - writeHtmlDocumentationAndFieldInjections(writer, roundEnv, componentModel, consumerElement, consumerPrefix, uriEndpoint.excludeProperties()); - found = true; - } - } - if (!found && consumerClassName != null) { - warning(processingEnv, "APT cannot find consumer class " + consumerClassName); - } - } - - writer.println("</body>"); - writer.println("</html>"); - } - protected void writeJSonSchemeDocumentation(PrintWriter writer, RoundEnvironment roundEnv, TypeElement classElement, UriEndpoint uriEndpoint, String title, String scheme, String extendsScheme, String label, String[] schemes) { // gather component information @@ -427,72 +337,6 @@ public class EndpointAnnotationProcessor extends AbstractProcessor { return buffer.toString(); } - protected void writeHtmlDocumentationAndFieldInjections(PrintWriter writer, RoundEnvironment roundEnv, ComponentModel componentModel, - TypeElement classElement, String prefix, String excludeProperties) { - String classDoc = processingEnv.getElementUtils().getDocComment(classElement); - if (!isNullOrEmpty(classDoc)) { - // remove dodgy @version that we may have in class javadoc - classDoc = classDoc.replaceFirst("\\@version", ""); - classDoc = classDoc.trim(); - writer.println("<p>" + classDoc + "</p>"); - } - - Set<EndpointPath> endpointPaths = new LinkedHashSet<EndpointPath>(); - Set<EndpointOption> endpointOptions = new LinkedHashSet<EndpointOption>(); - findClassProperties(writer, roundEnv, componentModel, endpointPaths, endpointOptions, classElement, prefix, excludeProperties); - - // sort the endpoint options in the standard order we prefer - List<EndpointPath> paths = new ArrayList<EndpointPath>(); - paths.addAll(endpointPaths); - Collections.sort(paths, EndpointHelper.createPathComparator(componentModel.getSyntax())); - - // sort the endpoint options in the standard order we prefer - List<EndpointOption> options = new ArrayList<EndpointOption>(); - options.addAll(endpointOptions); - Collections.sort(options, EndpointHelper.createGroupAndLabelComparator()); - - if (!options.isEmpty() || !paths.isEmpty()) { - writer.println("<table class='table'>"); - writer.println(" <tr>"); - writer.println(" <th align=\"left\">Name</th>"); - writer.println(" <th align=\"left\">Kind</th>"); - writer.println(" <th align=\"left\">Group</th>"); - writer.println(" <th align=\"left\">Required</th>"); - writer.println(" <th align=\"left\">Default</th>"); - writer.println(" <th align=\"left\">Type</th>"); - writer.println(" <th align=\"left\">Enum</th>"); - writer.println(" <th align=\"left\">Description</th>"); - writer.println(" </tr>"); - // include paths in the top - for (EndpointPath path : paths) { - writer.println(" <tr>"); - writer.println(" <td>" + path.getName() + "</td>"); - writer.println(" <td>" + "path" + "</td>"); - writer.println(" <td>" + path.getGroup() + "</td>"); - writer.println(" <td>" + safeNull(path.getRequired()) + "</td>"); - writer.println(" <td>" + path.getDefaultValue() + "</td>"); - writer.println(" <td>" + path.getType() + "</td>"); - writer.println(" <td>" + path.getEnumValuesAsHtml() + "</td>"); - writer.println(" <td>" + path.getDocumentation() + "</td>"); - writer.println(" </tr>"); - } - // and then regular parameter options - for (EndpointOption option : options) { - writer.println(" <tr>"); - writer.println(" <td>" + option.getName() + "</td>"); - writer.println(" <td>" + "parameter" + "</td>"); - writer.println(" <td>" + option.getGroup() + "</td>"); - writer.println(" <td>" + safeNull(option.getRequired()) + "</td>"); - writer.println(" <td>" + option.getDefaultValue() + "</td>"); - writer.println(" <td>" + option.getType() + "</td>"); - writer.println(" <td>" + option.getEnumValuesAsHtml() + "</td>"); - writer.println(" <td>" + option.getDocumentationWithNotes() + "</td>"); - writer.println(" </tr>"); - } - writer.println("</table>"); - } - } - protected ComponentModel findComponentProperties(RoundEnvironment roundEnv, UriEndpoint uriEndpoint, TypeElement endpointClassElement, String title, String scheme, String extendsScheme, String label) { ComponentModel model = new ComponentModel(scheme); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/ModelAnnotationProcessor.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/ModelAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/ModelAnnotationProcessor.java index c56fafc..c226b2e 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/ModelAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/ModelAnnotationProcessor.java @@ -36,8 +36,8 @@ import static org.apache.camel.tools.apt.helper.Strings.canonicalClassName; @SupportedSourceVersion(SourceVersion.RELEASE_8) public class ModelAnnotationProcessor extends AbstractProcessor { - CoreEipAnnotationProcessor coreProcessor = new CoreEipAnnotationProcessor(); - SpringAnnotationProcessor springProcessor = new SpringAnnotationProcessor(); + private CoreEipAnnotationProcessor coreProcessor = new CoreEipAnnotationProcessor(); + private SpringAnnotationProcessor springProcessor = new SpringAnnotationProcessor(); @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/helper/JsonSchemaHelper.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/helper/JsonSchemaHelper.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/helper/JsonSchemaHelper.java index 3cea5a0..5b96033 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/helper/JsonSchemaHelper.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/helper/JsonSchemaHelper.java @@ -253,7 +253,7 @@ public final class JsonSchemaHelper { continue; } - // remove all HTML tags + // remove all XML tags line = line.replaceAll("<.*?>", ""); // remove all inlined javadoc links, eg such as {@link org.apache.camel.spi.Registry} http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/ComponentOption.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/ComponentOption.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/ComponentOption.java index 5c3e5a5..51b72dc 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/ComponentOption.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/ComponentOption.java @@ -82,16 +82,6 @@ public final class ComponentOption { return secret; } - public String getEnumValuesAsHtml() { - CollectionStringBuffer csb = new CollectionStringBuffer("<br/>"); - if (enums != null && enums.size() > 0) { - for (String e : enums) { - csb.append(e); - } - } - return csb.toString(); - } - public String getDocumentationWithNotes() { StringBuilder sb = new StringBuilder(); sb.append(documentation); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointOption.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointOption.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointOption.java index af4f4a8..aaeb2bd 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointOption.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointOption.java @@ -101,16 +101,6 @@ public final class EndpointOption { return secret; } - public String getEnumValuesAsHtml() { - CollectionStringBuffer csb = new CollectionStringBuffer("<br/>"); - if (enums != null && enums.size() > 0) { - for (String e : enums) { - csb.append(e); - } - } - return csb.toString(); - } - public String getDocumentationWithNotes() { StringBuilder sb = new StringBuilder(); sb.append(documentation); http://git-wip-us.apache.org/repos/asf/camel/blob/340fcabc/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointPath.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointPath.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointPath.java index dc7ddc0..0c5fdef 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointPath.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/model/EndpointPath.java @@ -78,16 +78,6 @@ public final class EndpointPath { return secret; } - public String getEnumValuesAsHtml() { - CollectionStringBuffer csb = new CollectionStringBuffer("<br/>"); - if (enums != null && enums.size() > 0) { - for (String e : enums) { - csb.append(e); - } - } - return csb.toString(); - } - public boolean isEnumType() { return enumType; }
