This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new ef8e7dda48 Remove the out-dated description and diagram
ef8e7dda48 is described below
commit ef8e7dda485d1af2e771af9570041befacd4b3cd
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Sep 20 13:53:03 2024 +0100
Remove the out-dated description and diagram
---
webapps/docs/architecture/startup.xml | 29 +----
.../docs/architecture/startup/serverStartup.pdf | Bin 46175 -> 0 bytes
.../docs/architecture/startup/serverStartup.txt | 139 ---------------------
3 files changed, 3 insertions(+), 165 deletions(-)
diff --git a/webapps/docs/architecture/startup.xml
b/webapps/docs/architecture/startup.xml
index 23e41c1168..c854e55143 100644
--- a/webapps/docs/architecture/startup.xml
+++ b/webapps/docs/architecture/startup.xml
@@ -42,23 +42,6 @@ different ways to start tomcat, including:
<li>Automatically as a Windows service.</li>
</ul>
-<subsection name="description">
-<p>
-A <a href="startup/serverStartup.txt">text description</a> of the startup
-procedure created for Tomcat 5. The updated version of this description for
-Tomcat 12 will be included in the updated diagrams and diagram descriptions in
-the following section. This text file will be removed when that update is
-complete.
-</p>
-</subsection>
-
-<subsection name="diagram">
-<p>
-The <a href="startup/serverStartup.pdf">UML sequence diagram</a> of the startup
-procedure created for Tomcat 5 is gradually being replaced with updated
diagrams
-based on Tomcat 12. The scope of these diagrams may be adjusted as they are
-produced.
-</p>
<p>
A series of UML diagrams have been created to document the start-up process for
Tomcat.
@@ -106,20 +89,14 @@ 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>
-<subsection name="comments">
<p>
-The startup process can be customized in many ways, both
-by modifying Tomcat code and by implementing your own
-LifecycleListeners which are then registered in the server.xml
-configuration file.
+The startup process can be customized in many ways by implementing your own
+LifecycleListeners which are then registered in the server.xml configuration
+file.
</p>
-</subsection>
-
</section>
-
</body>
</document>
diff --git a/webapps/docs/architecture/startup/serverStartup.pdf
b/webapps/docs/architecture/startup/serverStartup.pdf
deleted file mode 100644
index 34aa59808b..0000000000
Binary files a/webapps/docs/architecture/startup/serverStartup.pdf and
/dev/null differ
diff --git a/webapps/docs/architecture/startup/serverStartup.txt
b/webapps/docs/architecture/startup/serverStartup.txt
deleted file mode 100644
index 9a13d7a707..0000000000
--- a/webapps/docs/architecture/startup/serverStartup.txt
+++ /dev/null
@@ -1,139 +0,0 @@
- 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.
-
-Tomcat Startup Sequence
-
-Sequence 1. Start from Command Line
-Class: org.apache.catalina.startup.Bootstrap
-What it does:
- a) Set up classloaders
- commonLoader (common)-> System Loader
- sharedLoader (shared)-> commonLoader -> System Loader
- catalinaLoader(server) -> commonLoader -> System Loader
- (by default the commonLoader is used for the
- sharedLoader and the serverLoader)
- b) Load startup class (reflection)
- org.apache.catalina.startup.Catalina
- setParentClassloader -> sharedLoader
- Thread.contextClassloader -> catalinaLoader
- c) Bootstrap.daemon.init() complete
-
-Sequence 2. Process command line argument (start, stop)
-Class: org.apache.catalina.startup.Bootstrap (assume command->start)
-What it does:
- a) Catalina.setAwait(true);
- b) Catalina.load()
- b1) initDirs() -> set properties like
- catalina.home
- catalina.base == catalina.home (most cases)
- b2) initNaming
- setProperty(javax.naming.Context.INITIAL_CONTEXT_FACTORY,
- org.apache.naming.java.javaURLContextFactory ->default)
- b3) createStartDigester()
- Configures a digester for the main server.xml elements like
- org.apache.catalina.core.StandardServer (can change of course :)
- org.apache.catalina.deploy.NamingResources
- Stores naming resources in the Jakarta EE JNDI tree
- org.apache.catalina.LifecycleListener
- implements events for start/stop of major components
- org.apache.catalina.core.StandardService
- The single entry for a set of connectors,
- so that a container can listen to multiple connectors
- ie, single entry
- org.apache.catalina.Connector
- Connectors to listen for incoming requests only
- It also adds the following rulesets to the digester
- NamingRuleSet
- EngineRuleSet
- HostRuleSet
- ContextRuleSet
- b4) Load the server.xml and parse it using the digester
- Parsing the server.xml using the digester is an automatic
- XML-object mapping tool, that will create the objects defined in
server.xml
- Startup of the actual container has not started yet.
- b5) Assigns System.out and System.err to the SystemLogHandler class
- b6) Calls initialize on all components, this makes each object
register itself with the
- JMX agent.
- During the process call the Connectors also initialize the
adapters.
- The adapters are the components that do the request pre-processing.
- Typical adapters are HTTP1.1 (default if no protocol is specified,
- org.apache.coyote.http11.Http11NioProtocol)
- AJP1.3 for mod_jk etc.
-
- c) Catalina.start()
- c1) Starts the NamingContext and binds all JNDI references into it
- c2) Starts the services under <Server> which are:
- StandardService -> starts Engine (ContainerBase -> Realm,Cluster
etc)
- c3) StandardHost (started by the service)
- Configures an ErrorReportValve to do proper HTML output for
different HTTP
- errors codes
- Starts the Valves in the pipeline (at least the
ErrorReportValve)
- Configures the StandardHostValve,
- this valves ties the Webapp Class loader to the thread
context
- it also finds the session for the request
- and invokes the context pipeline
- Starts the HostConfig component
- This component deploys all the webapps
- (webapps & conf/Catalina/localhost/*.xml)
- HostConfig will create a Digester for your context, this
digester
- will then invoke ContextConfig.start()
- The ContextConfig.start() will process the default
web.xml (conf/web.xml)
- and then process the applications web.xml
(WEB-INF/web.xml)
-
- c4) During the lifetime of the container (StandardEngine) there is a
background thread that
- keeps checking if the context has changed. If a context changes
(timestamp of war file,
- context xml file, web.xml) then a reload is issued
(stop/remove/deploy/start)
-
- d) Tomcat receives a request on an HTTP port
- d1) The request is received by a separate thread which is waiting in
the ThreadPoolExecutor
- class. It is waiting for a request in a regular
ServerSocket.accept() method.
- When a request is received, this thread wakes up.
- d2) The ThreadPoolExecutor assigns the a TaskThread to handle the
request.
- It also supplies a JMX object name to the catalina container (not
used I believe)
- d3) The processor to handle the request in this case is Coyote
Http11Processor,
- and the process method is invoked.
- This same processor is also continuing to check the input stream
of the socket
- until the keep alive point is reached or the connection is
disconnected.
- d4) The HTTP request is parsed using an internal buffer class
(Http11InputBuffer)
- The buffer class parses the request line, the headers, etc and
store the result in a
- Coyote request (not an HTTP request) This request contains all the
HTTP info, such
- as servername, port, scheme, etc.
- d5) The processor contains a reference to an Adapter, in this case it
is the
- CoyoteAdapter. Once the request has been parsed, the
Http11Processor
- invokes service() on the adapter. In the service method, the
Request contains a
- CoyoteRequest and CoyoteResponse (null for the first time)
- The CoyoteRequest(Response) implements HttpRequest(Response) and
HttpServletRequest(Response)
- The adapter parses and associates everything with the request,
cookies, the context through a
- Mapper, etc
- d6) When the parsing is finished, the CoyoteAdapter invokes its
container (StandardEngine)
- and invokes the invoke(request,response) method.
- This initiates the HTTP request into the Catalina container
starting at the engine level
- d7) The StandardEngine.invoke() simply invokes the container
pipeline.invoke()
- d8) By default the engine only has one valve the StandardEngineValve,
this valve simply
- invokes the invoke() method on the Host pipeline
(StandardHost.getPipeLine())
- d9) the StandardHost has two valves by default, the StandardHostValve
and the ErrorReportValve
- d10) The standard host valve associates the correct class loader with
the current thread
- It also retrieves the Manager and the session associated with the
request (if there is one)
- If there is a session access() is called to keep the session alive
- d11) After that the StandardHostValve invokes the pipeline on the
context associated
- with the request.
- d12) The first valve that gets invoked by the Context pipeline is the
FormAuthenticator
- valve. Then the StandardContextValve gets invoke.
- The StandardContextValve invokes any context listeners associated
with the context.
- Next it invokes the pipeline on the Wrapper component
(StandardWrapperValve)
- d13) During the invocation of the StandardWrapperValve, the JSP
wrapper (Jasper) gets invoked
- This results in the actual compilation of the JSP.
- And then invokes the actual servlet.
- e) Invocation of the servlet class
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
