You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flume.apache.org by rg...@apache.org on 2023/03/17 00:06:25 UTC
[flume-site] branch asf-staging updated: Update Spring Boot documentations
This is an automated email from the ASF dual-hosted git repository.
rgoers pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/flume-site.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new db687043 Update Spring Boot documentations
db687043 is described below
commit db6870438e9045a4fa0bb1c5e5024ee9ee4f25a4
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Thu Mar 16 17:06:13 2023 -0700
Update Spring Boot documentations
---
content/.buildinfo | 2 +-
content/.doctrees/FlumeUserGuide.doctree | Bin 2997565 -> 2997298 bytes
content/.doctrees/environment.pickle | Bin 201989 -> 202057 bytes
content/FlumeDeveloperGuide.html | 2 +-
content/FlumeUserGuide.html | 47 +++++++++++----------
content/_sources/FlumeUserGuide.txt | 42 +++++++++---------
content/documentation.html | 2 +-
content/download.html | 2 +-
content/getinvolved.html | 2 +-
content/index.html | 2 +-
content/license.html | 2 +-
content/mailinglists.html | 2 +-
content/releases/1.0.0.html | 2 +-
content/releases/1.1.0.html | 2 +-
content/releases/1.10.0.html | 2 +-
content/releases/1.10.1.html | 2 +-
content/releases/1.11.0.html | 2 +-
content/releases/1.2.0.html | 2 +-
content/releases/1.3.0.html | 2 +-
content/releases/1.3.1.html | 2 +-
content/releases/1.4.0.html | 2 +-
content/releases/1.5.0.1.html | 2 +-
content/releases/1.5.0.html | 2 +-
content/releases/1.5.2.html | 2 +-
content/releases/1.6.0.html | 2 +-
content/releases/1.7.0.html | 2 +-
content/releases/1.8.0.html | 2 +-
content/releases/1.9.0.html | 2 +-
.../releases/content/1.11.0/FlumeUserGuide.html | 47 +++++++++++----------
content/releases/index.html | 2 +-
content/search.html | 2 +-
content/searchindex.js | 2 +-
content/security.html | 2 +-
content/source.html | 2 +-
content/team.html | 2 +-
content/testing.html | 2 +-
source/sphinx/FlumeUserGuide.rst | 42 +++++++++---------
37 files changed, 127 insertions(+), 113 deletions(-)
diff --git a/content/.buildinfo b/content/.buildinfo
index b33361eb..6fef5adf 100644
--- a/content/.buildinfo
+++ b/content/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8746fea04d37df13408ef9431b76a021
+config: c11c2986b7f9411c820cb79c937d6d7f
tags: fbb0d17656682115ca4d033fb2f83ba1
diff --git a/content/.doctrees/FlumeUserGuide.doctree b/content/.doctrees/FlumeUserGuide.doctree
index c3925df6..5848f59d 100644
Binary files a/content/.doctrees/FlumeUserGuide.doctree and b/content/.doctrees/FlumeUserGuide.doctree differ
diff --git a/content/.doctrees/environment.pickle b/content/.doctrees/environment.pickle
index 7dcb13fa..362b7b85 100644
Binary files a/content/.doctrees/environment.pickle and b/content/.doctrees/environment.pickle differ
diff --git a/content/FlumeDeveloperGuide.html b/content/FlumeDeveloperGuide.html
index 58849df2..c5674600 100644
--- a/content/FlumeDeveloperGuide.html
+++ b/content/FlumeDeveloperGuide.html
@@ -1074,7 +1074,7 @@ sent to the Source, presumably after the event has be modified in some way.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/FlumeUserGuide.html b/content/FlumeUserGuide.html
index 51afd17d..ff66b402 100644
--- a/content/FlumeUserGuide.html
+++ b/content/FlumeUserGuide.html
@@ -516,7 +516,9 @@ channel3. The mapping can be set in the agent’s configuration file.</p>
</div>
<div class="section" id="spring-boot-setup">
<h2>Spring Boot Setup<a class="headerlink" href="#spring-boot-setup" title="Permalink to this headline">¶</a></h2>
-<p>As of version 1.11.0 Flume supports being packaged as a Spring Boot application.</p>
+<p>Apache Flume provides the flume-spring-boot module to provide support for packaging and
+configuring an application using Spring Boot. Version 2.0.0 or greater of flume-spring-boot
+should be used.</p>
<p>Flume “normally” follows a paradigm where each component implements the Configurable
interface and must implement the configure method to configure itself by retrieving
the configuration attributes from its Context’s properties. In contrast,
@@ -550,31 +552,31 @@ Boot should configure the Spring Boot Maven plugin with that as the main class a
<h3>Component Scanning<a class="headerlink" href="#component-scanning" title="Permalink to this headline">¶</a></h3>
<p>Spring Boot will automatically locate all the Spring components provided by Flume.
However, in order for the Flume application to be configured Spring needs the
-base Java package name used by the application in order for Spring to locate
-these components.This is accomplished in the application by creating a class
-that implements <cite>org.apache.flume.spring.boot.config.PackageProvider</cite> that is
-registered as a Java service. For example:</p>
-<div class="highlight-none"><div class="highlight"><pre>public class WylieCouotePackageProvider implements PackageProvider {
- private static final String[] PACKAGES = {"org.acme.coyote.wylie"};
-
- @Override
- public List<String> getPackages() {
- return Arrays.asList(PACKAGES);
- }
-}
+configuration and package names used by the application in order for Spring to locate
+these components.This is accomplished in the application by providing a META-INF/spring.factories
+file that enables auto configuration for one class that will then provide the component
+scanning information for the rest of the application. For example:</p>
+<p>META-INF/spring.factories:</p>
+<div class="highlight-none"><div class="highlight"><pre>org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sample.myapp.config.AppConfig
</pre></div>
</div>
-<p>would then be registered in a file with a fully qualified name of
-<cite>src/main/resources/META-INF/services/org.apache.flume.spring.boot.config.PackageProvider</cite>
-which would contain:</p>
-<div class="highlight-none"><div class="highlight"><pre>org.acme.coyote.wylie.config.WylieCoyotePackageProvider
+<p>com.sample.config.AppConfig.java:</p>
+<div class="highlight-none"><div class="highlight"><pre>package com.sample.myapp.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ComponentScan(basePackages="com.sample.myapp")
+public class MyConfiguration {
+
+}
</pre></div>
</div>
-<p>This would result in all classes in the <cite>org.acme.coyote.wylie</cite> package and
+<p>This will result in all classes in the <cite>com.sample.myapp</cite> package and
it`s sub-packages being scanned by Spring for components to be included. Note
that classes found there may also use Spring’s <cite>@Import</cite> annotation to include
-classes in other packages. In addition, since the getPackages method returns
-a List more than one package can be specified.</p>
+classes in other packages.</p>
</div>
<div class="section" id="component-wiring">
<h3>Component Wiring<a class="headerlink" href="#component-wiring" title="Permalink to this headline">¶</a></h3>
@@ -588,6 +590,7 @@ creates these Flume components. An example configuration that generates
sequence numbers, writes them to a MemoryChannel and then consumes these events
without publishing them anywhere would look like:</p>
<div class="highlight-none"><div class="highlight"><pre>@Configuration
+@ComponentScan(basePackages="com.sample.myapp")
public class AppConfig extends AbstractFlumeConfiguration {
@Bean
@@ -7942,7 +7945,7 @@ source code of the components.</p>
<div class="section" id="sinks-1">
<h4>Sinks 1<a class="headerlink" href="#sinks-1" title="Permalink to this headline">¶</a></h4>
<div class="system-message">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/rgoers/projects/apache/flume/flume-site/source/sphinx/FlumeUserGuide.rst</tt>, line 5327)</p>
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/rgoers/projects/apache/flume/flume-site/source/sphinx/FlumeUserGuide.rst</tt>, line 5331)</p>
<p>Malformed table.</p>
<div class="highlight-none"><div class="highlight"><pre>+------------------------+-------------+------------+-------+--------+
| | Avro/Thrift | AsyncHBase | HBase | HBase2 |
@@ -9207,7 +9210,7 @@ can be leveraged to move the Flume agent to another host.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/_sources/FlumeUserGuide.txt b/content/_sources/FlumeUserGuide.txt
index cb4c132b..ea420a6b 100644
--- a/content/_sources/FlumeUserGuide.txt
+++ b/content/_sources/FlumeUserGuide.txt
@@ -510,7 +510,9 @@ channel3. The mapping can be set in the agent's configuration file.
Spring Boot Setup
=================
-As of version 1.11.0 Flume supports being packaged as a Spring Boot application.
+Apache Flume provides the flume-spring-boot module to provide support for packaging and
+configuring an application using Spring Boot. Version 2.0.0 or greater of flume-spring-boot
+should be used.
Flume "normally" follows a paradigm where each component implements the Configurable
interface and must implement the configure method to configure itself by retrieving
@@ -546,31 +548,32 @@ Component Scanning
------------------
Spring Boot will automatically locate all the Spring components provided by Flume.
However, in order for the Flume application to be configured Spring needs the
-base Java package name used by the application in order for Spring to locate
-these components.This is accomplished in the application by creating a class
-that implements `org.apache.flume.spring.boot.config.PackageProvider` that is
-registered as a Java service. For example::
+configuration and package names used by the application in order for Spring to locate
+these components.This is accomplished in the application by providing a META-INF/spring.factories
+file that enables auto configuration for one class that will then provide the component
+scanning information for the rest of the application. For example:
- public class WylieCouotePackageProvider implements PackageProvider {
- private static final String[] PACKAGES = {"org.acme.coyote.wylie"};
+META-INF/spring.factories::
- @Override
- public List<String> getPackages() {
- return Arrays.asList(PACKAGES);
- }
- }
+ org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sample.myapp.config.AppConfig
+
+com.sample.config.AppConfig.java::
-would then be registered in a file with a fully qualified name of
-`src/main/resources/META-INF/services/org.apache.flume.spring.boot.config.PackageProvider`
-which would contain::
+ package com.sample.myapp.config;
- org.acme.coyote.wylie.config.WylieCoyotePackageProvider
+ import org.springframework.context.annotation.ComponentScan;
+ import org.springframework.context.annotation.Configuration;
+
+ @Configuration
+ @ComponentScan(basePackages="com.sample.myapp")
+ public class MyConfiguration {
+
+ }
-This would result in all classes in the `org.acme.coyote.wylie` package and
+This will result in all classes in the `com.sample.myapp` package and
it`s sub-packages being scanned by Spring for components to be included. Note
that classes found there may also use Spring's `@Import` annotation to include
-classes in other packages. In addition, since the getPackages method returns
-a List more than one package can be specified.
+classes in other packages.
Component Wiring
----------------
@@ -586,6 +589,7 @@ sequence numbers, writes them to a MemoryChannel and then consumes these events
without publishing them anywhere would look like::
@Configuration
+ @ComponentScan(basePackages="com.sample.myapp")
public class AppConfig extends AbstractFlumeConfiguration {
@Bean
diff --git a/content/documentation.html b/content/documentation.html
index 40779d40..ce5a2b5b 100644
--- a/content/documentation.html
+++ b/content/documentation.html
@@ -122,7 +122,7 @@ been released.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/download.html b/content/download.html
index 32a22535..25805539 100644
--- a/content/download.html
+++ b/content/download.html
@@ -148,7 +148,7 @@ many Unix distributions. Note that verifying the checksum is unnecessary if the
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/getinvolved.html b/content/getinvolved.html
index f8b2caea..4ffd829e 100644
--- a/content/getinvolved.html
+++ b/content/getinvolved.html
@@ -117,7 +117,7 @@ you find at: <a class="reference external" href="https://issues.apache.org/jira/
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/index.html b/content/index.html
index 1e2e4739..51d5adf3 100644
--- a/content/index.html
+++ b/content/index.html
@@ -560,7 +560,7 @@ Feel free to post to the User’s mailing list with any questions.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/license.html b/content/license.html
index cdf785da..3886eeef 100644
--- a/content/license.html
+++ b/content/license.html
@@ -200,7 +200,7 @@ accepting any such warranty or additional liability.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/mailinglists.html b/content/mailinglists.html
index 262e5355..f5d7e428 100644
--- a/content/mailinglists.html
+++ b/content/mailinglists.html
@@ -146,7 +146,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.0.0.html b/content/releases/1.0.0.html
index c2cf4dea..d5ffd17c 100644
--- a/content/releases/1.0.0.html
+++ b/content/releases/1.0.0.html
@@ -315,7 +315,7 @@ Incubator, and is labelled and should be considered as a beta version.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.1.0.html b/content/releases/1.1.0.html
index ec42fc92..0d43be0e 100644
--- a/content/releases/1.1.0.html
+++ b/content/releases/1.1.0.html
@@ -201,7 +201,7 @@ it is likely to change until a stable release version.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.10.0.html b/content/releases/1.10.0.html
index 0009fb98..5075d3f9 100644
--- a/content/releases/1.10.0.html
+++ b/content/releases/1.10.0.html
@@ -185,7 +185,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.10.1.html b/content/releases/1.10.1.html
index dedd9a7e..242762b5 100644
--- a/content/releases/1.10.1.html
+++ b/content/releases/1.10.1.html
@@ -134,7 +134,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.11.0.html b/content/releases/1.11.0.html
index fa184b48..3984cfd5 100644
--- a/content/releases/1.11.0.html
+++ b/content/releases/1.11.0.html
@@ -152,7 +152,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.2.0.html b/content/releases/1.2.0.html
index 0b2334bb..bd1cc319 100644
--- a/content/releases/1.2.0.html
+++ b/content/releases/1.2.0.html
@@ -322,7 +322,7 @@ and functionality along with bug fixes and other enhancements.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.3.0.html b/content/releases/1.3.0.html
index 5ee15a31..5df75e81 100644
--- a/content/releases/1.3.0.html
+++ b/content/releases/1.3.0.html
@@ -307,7 +307,7 @@ enhancements.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.3.1.html b/content/releases/1.3.1.html
index 602a0b7c..0896e73d 100644
--- a/content/releases/1.3.1.html
+++ b/content/releases/1.3.1.html
@@ -144,7 +144,7 @@ several bug fixes and performance enhancements.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.4.0.html b/content/releases/1.4.0.html
index 84551dd7..25553276 100644
--- a/content/releases/1.4.0.html
+++ b/content/releases/1.4.0.html
@@ -329,7 +329,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.5.0.1.html b/content/releases/1.5.0.1.html
index 17d37774..3d2d1511 100644
--- a/content/releases/1.5.0.1.html
+++ b/content/releases/1.5.0.1.html
@@ -129,7 +129,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.5.0.html b/content/releases/1.5.0.html
index 5a6c15d5..7b8972d5 100644
--- a/content/releases/1.5.0.html
+++ b/content/releases/1.5.0.html
@@ -261,7 +261,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.5.2.html b/content/releases/1.5.2.html
index f0e6703c..10eb0c37 100644
--- a/content/releases/1.5.2.html
+++ b/content/releases/1.5.2.html
@@ -134,7 +134,7 @@ sources and sinks.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.6.0.html b/content/releases/1.6.0.html
index e09942ba..1f044099 100644
--- a/content/releases/1.6.0.html
+++ b/content/releases/1.6.0.html
@@ -259,7 +259,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.7.0.html b/content/releases/1.7.0.html
index 0125c450..603d2c23 100644
--- a/content/releases/1.7.0.html
+++ b/content/releases/1.7.0.html
@@ -247,7 +247,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.8.0.html b/content/releases/1.8.0.html
index 4215d1f8..7c5a0c5c 100644
--- a/content/releases/1.8.0.html
+++ b/content/releases/1.8.0.html
@@ -200,7 +200,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/1.9.0.html b/content/releases/1.9.0.html
index 4f9e207f..5e09a5fb 100644
--- a/content/releases/1.9.0.html
+++ b/content/releases/1.9.0.html
@@ -218,7 +218,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/content/1.11.0/FlumeUserGuide.html b/content/releases/content/1.11.0/FlumeUserGuide.html
index 51afd17d..ff66b402 100644
--- a/content/releases/content/1.11.0/FlumeUserGuide.html
+++ b/content/releases/content/1.11.0/FlumeUserGuide.html
@@ -516,7 +516,9 @@ channel3. The mapping can be set in the agent’s configuration file.</p>
</div>
<div class="section" id="spring-boot-setup">
<h2>Spring Boot Setup<a class="headerlink" href="#spring-boot-setup" title="Permalink to this headline">¶</a></h2>
-<p>As of version 1.11.0 Flume supports being packaged as a Spring Boot application.</p>
+<p>Apache Flume provides the flume-spring-boot module to provide support for packaging and
+configuring an application using Spring Boot. Version 2.0.0 or greater of flume-spring-boot
+should be used.</p>
<p>Flume “normally” follows a paradigm where each component implements the Configurable
interface and must implement the configure method to configure itself by retrieving
the configuration attributes from its Context’s properties. In contrast,
@@ -550,31 +552,31 @@ Boot should configure the Spring Boot Maven plugin with that as the main class a
<h3>Component Scanning<a class="headerlink" href="#component-scanning" title="Permalink to this headline">¶</a></h3>
<p>Spring Boot will automatically locate all the Spring components provided by Flume.
However, in order for the Flume application to be configured Spring needs the
-base Java package name used by the application in order for Spring to locate
-these components.This is accomplished in the application by creating a class
-that implements <cite>org.apache.flume.spring.boot.config.PackageProvider</cite> that is
-registered as a Java service. For example:</p>
-<div class="highlight-none"><div class="highlight"><pre>public class WylieCouotePackageProvider implements PackageProvider {
- private static final String[] PACKAGES = {"org.acme.coyote.wylie"};
-
- @Override
- public List<String> getPackages() {
- return Arrays.asList(PACKAGES);
- }
-}
+configuration and package names used by the application in order for Spring to locate
+these components.This is accomplished in the application by providing a META-INF/spring.factories
+file that enables auto configuration for one class that will then provide the component
+scanning information for the rest of the application. For example:</p>
+<p>META-INF/spring.factories:</p>
+<div class="highlight-none"><div class="highlight"><pre>org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sample.myapp.config.AppConfig
</pre></div>
</div>
-<p>would then be registered in a file with a fully qualified name of
-<cite>src/main/resources/META-INF/services/org.apache.flume.spring.boot.config.PackageProvider</cite>
-which would contain:</p>
-<div class="highlight-none"><div class="highlight"><pre>org.acme.coyote.wylie.config.WylieCoyotePackageProvider
+<p>com.sample.config.AppConfig.java:</p>
+<div class="highlight-none"><div class="highlight"><pre>package com.sample.myapp.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ComponentScan(basePackages="com.sample.myapp")
+public class MyConfiguration {
+
+}
</pre></div>
</div>
-<p>This would result in all classes in the <cite>org.acme.coyote.wylie</cite> package and
+<p>This will result in all classes in the <cite>com.sample.myapp</cite> package and
it`s sub-packages being scanned by Spring for components to be included. Note
that classes found there may also use Spring’s <cite>@Import</cite> annotation to include
-classes in other packages. In addition, since the getPackages method returns
-a List more than one package can be specified.</p>
+classes in other packages.</p>
</div>
<div class="section" id="component-wiring">
<h3>Component Wiring<a class="headerlink" href="#component-wiring" title="Permalink to this headline">¶</a></h3>
@@ -588,6 +590,7 @@ creates these Flume components. An example configuration that generates
sequence numbers, writes them to a MemoryChannel and then consumes these events
without publishing them anywhere would look like:</p>
<div class="highlight-none"><div class="highlight"><pre>@Configuration
+@ComponentScan(basePackages="com.sample.myapp")
public class AppConfig extends AbstractFlumeConfiguration {
@Bean
@@ -7942,7 +7945,7 @@ source code of the components.</p>
<div class="section" id="sinks-1">
<h4>Sinks 1<a class="headerlink" href="#sinks-1" title="Permalink to this headline">¶</a></h4>
<div class="system-message">
-<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/rgoers/projects/apache/flume/flume-site/source/sphinx/FlumeUserGuide.rst</tt>, line 5327)</p>
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/rgoers/projects/apache/flume/flume-site/source/sphinx/FlumeUserGuide.rst</tt>, line 5331)</p>
<p>Malformed table.</p>
<div class="highlight-none"><div class="highlight"><pre>+------------------------+-------------+------------+-------+--------+
| | Avro/Thrift | AsyncHBase | HBase | HBase2 |
@@ -9207,7 +9210,7 @@ can be leveraged to move the Flume agent to another host.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/releases/index.html b/content/releases/index.html
index 607c65f4..0f868626 100644
--- a/content/releases/index.html
+++ b/content/releases/index.html
@@ -132,7 +132,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/search.html b/content/search.html
index f82ba096..4eb07b63 100644
--- a/content/search.html
+++ b/content/search.html
@@ -131,7 +131,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/searchindex.js b/content/searchindex.js
index 869b9dbc..502d2d30 100644
--- a/content/searchindex.js
+++ b/content/searchindex.js
@@ -1 +1 @@
-Search.setIndex({objtypes:{},objects:{},titles:["Version 1.0.0 - Incubating","Version 1.1.0 - Incubating","Version 1.10.0","Version 1.11.0","Version 1.10.1","Version 1.4.0","Version 1.3.1","Version 1.5.0","Version 1.2.0","Version 1.3.0","Flume 1.11.0 Developer Guide","Version 1.8.0","Version 1.9.0","Version 1.5.0.1","Version 1.6.0","Source Repository","Version 1.5.2","Version 1.7.0","Download","Mailing lists","Apache Flume Security Vulnerabilities","Flume 1.11.0 User Guide","Testing","Do [...]
\ No newline at end of file
+Search.setIndex({objtypes:{},objects:{},titles:["Version 1.0.0 - Incubating","Version 1.10.0","Version 1.1.0 - Incubating","Version 1.10.1","Version 1.11.0","Version 1.3.1","Version 1.4.0","Version 1.5.0","Version 1.2.0","Version 1.3.0","Flume 1.11.0 Developer Guide","Version 1.8.0","Version 1.5.0.1","Version 1.9.0","Version 1.6.0","Version 1.7.0","Version 1.5.2","Source Repository","Download","Apache Flume Security Vulnerabilities","Mailing lists","Flume 1.11.0 User Guide","Testing","Do [...]
\ No newline at end of file
diff --git a/content/security.html b/content/security.html
index 980af9a1..fec61e95 100644
--- a/content/security.html
+++ b/content/security.html
@@ -210,7 +210,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/source.html b/content/source.html
index 9d485ff3..06cb07c3 100644
--- a/content/source.html
+++ b/content/source.html
@@ -175,7 +175,7 @@ the source code.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/team.html b/content/team.html
index 3936376b..d552a70b 100644
--- a/content/team.html
+++ b/content/team.html
@@ -336,7 +336,7 @@ to the project are greatly appreciated.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/content/testing.html b/content/testing.html
index 59ae9fd6..829f0f1c 100644
--- a/content/testing.html
+++ b/content/testing.html
@@ -111,7 +111,7 @@ and all Pull Requests at GitHub.</p>
<div class="clearer"></div>
</div>
<div class="footer">
- © Copyright 2009-2022 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
+ © Copyright 2009-2023 The Apache Software Foundation. Apache Flume, Flume, Apache, the Apache feather logo, and the Apache Flume project logo are trademarks of The Apache Software Foundation..
</div>
</body>
</html>
\ No newline at end of file
diff --git a/source/sphinx/FlumeUserGuide.rst b/source/sphinx/FlumeUserGuide.rst
index cb4c132b..ea420a6b 100644
--- a/source/sphinx/FlumeUserGuide.rst
+++ b/source/sphinx/FlumeUserGuide.rst
@@ -510,7 +510,9 @@ channel3. The mapping can be set in the agent's configuration file.
Spring Boot Setup
=================
-As of version 1.11.0 Flume supports being packaged as a Spring Boot application.
+Apache Flume provides the flume-spring-boot module to provide support for packaging and
+configuring an application using Spring Boot. Version 2.0.0 or greater of flume-spring-boot
+should be used.
Flume "normally" follows a paradigm where each component implements the Configurable
interface and must implement the configure method to configure itself by retrieving
@@ -546,31 +548,32 @@ Component Scanning
------------------
Spring Boot will automatically locate all the Spring components provided by Flume.
However, in order for the Flume application to be configured Spring needs the
-base Java package name used by the application in order for Spring to locate
-these components.This is accomplished in the application by creating a class
-that implements `org.apache.flume.spring.boot.config.PackageProvider` that is
-registered as a Java service. For example::
+configuration and package names used by the application in order for Spring to locate
+these components.This is accomplished in the application by providing a META-INF/spring.factories
+file that enables auto configuration for one class that will then provide the component
+scanning information for the rest of the application. For example:
- public class WylieCouotePackageProvider implements PackageProvider {
- private static final String[] PACKAGES = {"org.acme.coyote.wylie"};
+META-INF/spring.factories::
- @Override
- public List<String> getPackages() {
- return Arrays.asList(PACKAGES);
- }
- }
+ org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.sample.myapp.config.AppConfig
+
+com.sample.config.AppConfig.java::
-would then be registered in a file with a fully qualified name of
-`src/main/resources/META-INF/services/org.apache.flume.spring.boot.config.PackageProvider`
-which would contain::
+ package com.sample.myapp.config;
- org.acme.coyote.wylie.config.WylieCoyotePackageProvider
+ import org.springframework.context.annotation.ComponentScan;
+ import org.springframework.context.annotation.Configuration;
+
+ @Configuration
+ @ComponentScan(basePackages="com.sample.myapp")
+ public class MyConfiguration {
+
+ }
-This would result in all classes in the `org.acme.coyote.wylie` package and
+This will result in all classes in the `com.sample.myapp` package and
it`s sub-packages being scanned by Spring for components to be included. Note
that classes found there may also use Spring's `@Import` annotation to include
-classes in other packages. In addition, since the getPackages method returns
-a List more than one package can be specified.
+classes in other packages.
Component Wiring
----------------
@@ -586,6 +589,7 @@ sequence numbers, writes them to a MemoryChannel and then consumes these events
without publishing them anywhere would look like::
@Configuration
+ @ComponentScan(basePackages="com.sample.myapp")
public class AppConfig extends AbstractFlumeConfiguration {
@Bean