You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2024/09/10 16:06:31 UTC

(tomcat) branch 9.0.x updated (8ac8eb232e -> d0aa8b032d)

This is an automated email from the ASF dual-hosted git repository.

markt pushed a change to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git


    from 8ac8eb232e Checkstyle
     new fa27bc02a0 Add diagram 6 - deployment of applications by HostConfig
     new d0aa8b032d Add diagram 7 that shows Context configuration process

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 webapps/docs/architecture/startup.xml              |  11 ++-
 .../startup/6_catalina_host_config.plantuml        |  90 +++++++++++++++++
 .../startup/6_catalina_host_config.png             | Bin 0 -> 65519 bytes
 .../startup/7_catalina_context_config.plantuml     | 109 +++++++++++++++++++++
 .../startup/7_catalina_context_config.png          | Bin 0 -> 89731 bytes
 5 files changed, 207 insertions(+), 3 deletions(-)
 create mode 100644 webapps/docs/architecture/startup/6_catalina_host_config.plantuml
 create mode 100644 webapps/docs/architecture/startup/6_catalina_host_config.png
 create mode 100644 webapps/docs/architecture/startup/7_catalina_context_config.plantuml
 create mode 100644 webapps/docs/architecture/startup/7_catalina_context_config.png


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


(tomcat) 01/02: Add diagram 6 - deployment of applications by HostConfig

Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit fa27bc02a0211850d88e95bb6543c2463a67ed99
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Sep 10 13:55:03 2024 +0100

    Add diagram 6 - deployment of applications by HostConfig
---
 webapps/docs/architecture/startup.xml              |   5 +-
 .../startup/6_catalina_host_config.plantuml        |  90 +++++++++++++++++++++
 .../startup/6_catalina_host_config.png             | Bin 0 -> 65519 bytes
 3 files changed, 93 insertions(+), 2 deletions(-)

diff --git a/webapps/docs/architecture/startup.xml b/webapps/docs/architecture/startup.xml
index 28fec45bf2..c96eab6632 100644
--- a/webapps/docs/architecture/startup.xml
+++ b/webapps/docs/architecture/startup.xml
@@ -96,8 +96,9 @@ Clusters, Realms and Valves.
 for Context elements as it is rather more involved that the other Containers.
 </p>
 <p>
-Diagram 6 will show HostConfig.
-</p>
+<a href="startup/6_catalina_host_config.png">Diagram 5</a> shows how the
+HostConfig component responds to lifecycle events triggered by the Host to
+deploy web applications to the Host.</p>
 <p>
 Diagram 7 will show ContextConfig.
 </p>
diff --git a/webapps/docs/architecture/startup/6_catalina_host_config.plantuml b/webapps/docs/architecture/startup/6_catalina_host_config.plantuml
new file mode 100644
index 0000000000..7cd77e9b2c
--- /dev/null
+++ b/webapps/docs/architecture/startup/6_catalina_host_config.plantuml
@@ -0,0 +1,90 @@
+@startuml
+
+' 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.
+
+hide footbox
+skinparam style strictuml
+
+activate Host
+
+== BEFORE_START_EVENT ==
+
+Host -> HostConfig ++:lifecycleEvent(BEFORE_START_EVENT)
+
+HostConfig -> HostConfig  ++: beforeStart()
+return
+
+return
+
+== START_EVENT ==
+
+Host -> HostConfig ++:lifecycleEvent(START_EVENT)
+
+HostConfig -> HostConfig ++: start()
+
+HostConfig -> HostConfig ++: deployApps()
+
+|||
+HostConfig -> HostConfig ++: migrateLegacyApps()
+return
+
+|||
+HostConfig -> HostConfig ++: deployDescriptors()
+return
+
+|||
+HostConfig -> HostConfig ++: deployWARs()
+return
+
+|||
+HostConfig -> HostConfig ++: deployDirectories()
+return
+
+return
+
+return
+
+return
+
+== PERIODIC_EVENT ==
+
+Host -> HostConfig ++:lifecycleEvent(PERIODIC_EVENT)
+
+HostConfig -> HostConfig  ++: check()
+
+group Each DeployedApplication is called sequentially
+HostConfig -> DeployedApplication ++: checkResources()
+note right
+Triggers reloading, redeployment
+or undeployment as appropriate
+depending on which resources have
+been added, removed and/or changed.
+end note
+return
+end group
+
+HostConfig -> HostConfig ++: deployApps()
+note right
+See START_EVENT for an expansion
+of the deployApps() call.
+end note
+return
+
+return
+
+return
+
+@enduml
\ No newline at end of file
diff --git a/webapps/docs/architecture/startup/6_catalina_host_config.png b/webapps/docs/architecture/startup/6_catalina_host_config.png
new file mode 100644
index 0000000000..5f75867dc1
Binary files /dev/null and b/webapps/docs/architecture/startup/6_catalina_host_config.png differ


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


(tomcat) 02/02: Add diagram 7 that shows Context configuration process

Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit d0aa8b032d7a541ea791906405422362aec4f2b6
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Sep 10 17:02:36 2024 +0100

    Add diagram 7 that shows Context configuration process
---
 webapps/docs/architecture/startup.xml              |   8 +-
 .../startup/7_catalina_context_config.plantuml     | 109 +++++++++++++++++++++
 .../startup/7_catalina_context_config.png          | Bin 0 -> 89731 bytes
 3 files changed, 115 insertions(+), 2 deletions(-)

diff --git a/webapps/docs/architecture/startup.xml b/webapps/docs/architecture/startup.xml
index c96eab6632..c95e10495b 100644
--- a/webapps/docs/architecture/startup.xml
+++ b/webapps/docs/architecture/startup.xml
@@ -96,11 +96,15 @@ Clusters, Realms and Valves.
 for Context elements as it is rather more involved that the other Containers.
 </p>
 <p>
-<a href="startup/6_catalina_host_config.png">Diagram 5</a> shows how the
+<a href="startup/6_catalina_host_config.png">Diagram 6</a> shows how the
 HostConfig component responds to lifecycle events triggered by the Host to
 deploy web applications to the Host.</p>
 <p>
-Diagram 7 will show ContextConfig.
+<a href="startup/7_catalina_context_config.png">Diagram 7</a> shows how the
+ContextConfig component responds to lifecycle events triggered by the Context to
+parse the global and application provided configuration files to create a merged
+web.xml file that is then used, along with other settings, to configure the web
+application.
 </p>
 </subsection>
 
diff --git a/webapps/docs/architecture/startup/7_catalina_context_config.plantuml b/webapps/docs/architecture/startup/7_catalina_context_config.plantuml
new file mode 100644
index 0000000000..98a70cb5cd
--- /dev/null
+++ b/webapps/docs/architecture/startup/7_catalina_context_config.plantuml
@@ -0,0 +1,109 @@
+@startuml
+
+' 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.
+
+hide footbox
+skinparam style strictuml
+
+activate Context
+
+== BEFORE_START_EVENT ==
+
+Context -> ContextConfig ++:lifecycleEvent(BEFORE_START_EVENT)
+
+ContextConfig -> ContextConfig ++: beforeStart()
+
+ContextConfig -> ContextConfig: fixDocBase()
+
+ContextConfig -> ContextConfig: antiLocking()
+
+return
+
+return
+
+== CONFIGURE_START_EVENT ==
+
+Context -> ContextConfig ++:lifecycleEvent(CONFIGURE_START_EVENT)
+
+ContextConfig -> ContextConfig ++: configureStart()
+
+ContextConfig -> ContextConfig ++: webConfig()
+
+ContextConfig --> WebXmlParser **
+
+ContextConfig -> ContextConfig ++: getDefaultWebXmlFragment()
+
+ContextConfig -> WebXmlParser ++: parseWebXml(defaultWebXml)
+return
+
+return
+
+ContextConfig -> ContextConfig ++: getTomcatWebXmlFragment()
+
+ContextConfig -> WebXmlParser ++: parseWebXml(tomcatWebXml)
+return
+
+return
+
+ContextConfig --> WebXml **
+
+ContextConfig -> WebXmlParser ++: parseWebXml(contextWebXml)
+WebXmlParser -> WebXml ++
+return
+return
+
+ContextConfig -> ContextConfig: processJarsForWebFragments()
+ContextConfig -> ContextConfig: processServletContainerInitializers()
+ContextConfig -> ContextConfig: processClasses()
+
+ContextConfig -> WebXml ++: merge(orderedFragments)
+return
+
+ContextConfig -> WebXml ++: merge(tomcatWebXml)
+return
+
+ContextConfig -> WebXml ++: merge(defaultWebXml)
+return
+
+ContextConfig -> ContextConfig: convertJsps()
+ContextConfig -> ContextConfig: configureContext()
+ContextConfig -> ContextConfig: processResourceJARs()
+
+return
+
+|||
+ContextConfig -> ContextConfig: applicationAnnotationsConfig()
+
+ContextConfig -> ContextConfig: validateSecurityRoles()
+
+ContextConfig -> ContextConfig: authenticatorConfig()
+
+return
+destroy WebXmlParser
+destroy WebXml
+
+return
+
+== AFTER_START_EVENT ==
+
+Context -> ContextConfig ++:lifecycleEvent(AFTER_START_EVENT)
+
+ContextConfig -> Context ++:setDocBase(originalDocBase)
+return
+
+return
+
+@enduml
\ No newline at end of file
diff --git a/webapps/docs/architecture/startup/7_catalina_context_config.png b/webapps/docs/architecture/startup/7_catalina_context_config.png
new file mode 100644
index 0000000000..e8c6c48f0f
Binary files /dev/null and b/webapps/docs/architecture/startup/7_catalina_context_config.png differ


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org