You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2018/08/30 04:42:37 UTC
[isis] 01/02: ISIS-1895: minor java-doc improvements
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit dbf1c42502cb5607e009305437ef218e5ac97cf3
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Aug 30 06:21:49 2018 +0200
ISIS-1895: minor java-doc improvements
Task-Url: https://issues.apache.org/jira/browse/ISIS-1895
---
.../apache/isis/core/webapp/IsisWebAppContextListener.java | 13 ++++++-------
.../main/java/org/apache/isis/core/webapp/WebModule.java | 7 +++----
2 files changed, 9 insertions(+), 11 deletions(-)
diff --git a/core/runtime/src/main/java/org/apache/isis/core/webapp/IsisWebAppContextListener.java b/core/runtime/src/main/java/org/apache/isis/core/webapp/IsisWebAppContextListener.java
index 8568b28..40612fe 100644
--- a/core/runtime/src/main/java/org/apache/isis/core/webapp/IsisWebAppContextListener.java
+++ b/core/runtime/src/main/java/org/apache/isis/core/webapp/IsisWebAppContextListener.java
@@ -37,8 +37,7 @@ import org.slf4j.LoggerFactory;
* Introduced to render web.xml listener configurations obsolete.
* <p>
* Acts as the single application entry-point when running within a Servlet context.
- * Delegates the bootstrapping to appropriate 'bootstrappers' that are discovered
- * on the class-path.
+ * Installs WebModules on the ServletContext when discovered on the class-path.
* </p>
*
* @since 2.0.0
@@ -59,7 +58,7 @@ public class IsisWebAppContextListener implements ServletContextListener {
final ServletContext context = event.getServletContext();
WebModule.discoverWebModules()
- .filter(module->module.isAvailable(context))
+ .filter(module->module.isAvailable(context)) // filter those WebModules that are applicable
.forEach(module->addListener(context, module));
activeListeners.forEach(listener->listener.contextInitialized(event));
@@ -73,12 +72,12 @@ public class IsisWebAppContextListener implements ServletContextListener {
// -- HELPER
- private void addListener(ServletContext context, WebModule provider) {
- LOG.info(String.format("ServletContext: adding '%s'", provider.getName()));
+ private void addListener(ServletContext context, WebModule module) {
+ LOG.info(String.format("ServletContext: adding '%s'", module.getName()));
try {
- acceptIfPresent(provider.init(context), activeListeners::add);
+ acceptIfPresent(module.init(context), activeListeners::add);
} catch (ServletException e) {
- LOG.error(String.format("Failed to add '%s' to the ServletContext.", provider.getName()), e);
+ LOG.error(String.format("Failed to add '%s' to the ServletContext.", module.getName()), e);
}
}
diff --git a/core/runtime/src/main/java/org/apache/isis/core/webapp/WebModule.java b/core/runtime/src/main/java/org/apache/isis/core/webapp/WebModule.java
index 8db2b6f..e8594f2 100644
--- a/core/runtime/src/main/java/org/apache/isis/core/webapp/WebModule.java
+++ b/core/runtime/src/main/java/org/apache/isis/core/webapp/WebModule.java
@@ -32,7 +32,7 @@ public interface WebModule {
// -- INTERFACE
/**
- * @return (display-) name of this provider
+ * @return (display-) name of this module
*/
public String getName();
@@ -44,15 +44,14 @@ public interface WebModule {
/**
* @param ctx ServletContext
- * @return whether this provider is available on the class-path and also applicable
+ * @return whether this module is available (on the class-path) and also applicable
*/
public boolean isAvailable(ServletContext ctx);
// -- DISCOVERY
/**
- * Searches the class-path for 'bootstrappers'.
- * @return stream of 'bootstrappers'
+ * @return Stream of 'known' WebModules, whether applicable or not is not decided here
*/
static Stream<WebModule> discoverWebModules() {