-
Notifications
You must be signed in to change notification settings - Fork 2k
Fixes #13353 - Add glossary to operations guide documentation #14234
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+112
−0
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,3 +41,4 @@ | |
| * xref:tools/index.adoc[] | ||
| * xref:troubleshooting/index.adoc[] | ||
| * xref:xml/index.adoc[] | ||
| * xref:glossary.adoc[] | ||
111 changes: 111 additions & 0 deletions
111
documentation/jetty/modules/operations-guide/pages/glossary.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| // | ||
| // ======================================================================== | ||
| // Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Eclipse Public License v. 2.0 which is available at | ||
| // https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 | ||
| // which is available at https://www.apache.org/licenses/LICENSE-2.0. | ||
| // | ||
| // SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 | ||
| // ======================================================================== | ||
| // | ||
|
|
||
| [glossary] | ||
| = Glossary | ||
|
|
||
| This glossary defines common terms used throughout the Jetty documentation. | ||
|
|
||
| [glossary] | ||
| [[bean]] | ||
afarber marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Bean:: | ||
| A component instance added to a `ContainerLifeCycle` container. | ||
| Beans can be _managed_ (lifecycle tied to container), _unmanaged_ (independent lifecycle), or _POJO_ (plain objects without lifecycle). | ||
| See xref:programming-guide:arch/bean.adoc[] for details. | ||
|
|
||
| [[connector]] | ||
| Connector:: | ||
| A component that listens on a network port for incoming connections. | ||
| Connectors are associated with one or more `ConnectionFactory` instances that create protocol-specific connections (HTTP/1.1, HTTP/2, HTTP/3). | ||
| See xref:server/index.adoc[] for server configuration. | ||
|
|
||
| [[container-lifecycle]] | ||
| ContainerLifeCycle:: | ||
| A `LifeCycle` implementation that can contain other components (beans). | ||
| It manages the lifecycle of its managed beans, starting and stopping them together with the container. | ||
| See xref:programming-guide:arch/bean.adoc[] for the component architecture. | ||
|
|
||
| [[context-handler]] | ||
| ContextHandler:: | ||
| A `Handler` that scopes HTTP requests to a specific context path. | ||
| It provides the foundation for web application deployment, managing attributes, MIME types, and class loaders. | ||
| See xref:deploy/index.adoc[] for deployment information. | ||
|
|
||
| [[context-xml]] | ||
| Context XML file:: | ||
| An XML configuration file used to deploy web applications in Jetty. | ||
| Context XML files use Jetty's XML configuration syntax to instantiate and configure `ContextHandler` instances. | ||
| See xref:xml/index.adoc[] for XML configuration syntax and xref:deploy/index.adoc[] for deployment examples. | ||
|
|
||
| [[handler]] | ||
| Handler:: | ||
| The fundamental abstraction for processing HTTP requests in Jetty. | ||
| Handlers form a tree structure where requests flow from the server through various handlers. | ||
| A handler returns `true` if it handled the request, `false` otherwise. | ||
| See xref:programming-guide:server/index.adoc[] for the server programming guide. | ||
|
|
||
| [[jetty-base]] | ||
| `$JETTY_BASE`:: | ||
| The directory containing your Jetty server customizations and configurations. | ||
| You can have multiple `$JETTY_BASE` directories, each with different configurations, all referencing the same `$JETTY_HOME`. | ||
| See xref:arch/index.adoc#jetty-base[Architecture Overview] for details. | ||
|
|
||
| [[jetty-home]] | ||
| `$JETTY_HOME`:: | ||
| The directory containing the Jetty distribution binaries and default configuration. | ||
| This directory should not be modified; all customizations should go in `$JETTY_BASE`. | ||
| See xref:arch/index.adoc#jetty-base[Architecture Overview] for details. | ||
|
|
||
| [[lifecycle]] | ||
| LifeCycle:: | ||
| An interface implemented by Jetty components that can be started and stopped. | ||
| Components implementing `LifeCycle` participate in the container's lifecycle management. | ||
| See xref:programming-guide:arch/bean.adoc#lifecycle[Component Lifecycle] for details. | ||
|
|
||
| [[module]] | ||
| Module:: | ||
| A reusable unit that provides one or more Jetty features. | ||
| Modules are enabled in `$JETTY_BASE` and declare dependencies on other modules. | ||
| Examples include `http`, `https`, `http2`, `deploy`, and `logging`. | ||
| See xref:modules/index.adoc[] for the module system documentation. | ||
|
|
||
| [[server]] | ||
| Server:: | ||
| The root component of a Jetty server application. | ||
| It contains connectors, handlers, and thread pools, forming the top of the component tree. | ||
| See xref:server/index.adoc[] for server configuration. | ||
|
|
||
| [[server-connector]] | ||
| ServerConnector:: | ||
| The standard TCP/IP connector implementation for accepting network connections. | ||
| It supports multiple protocols through `ConnectionFactory` instances. | ||
| See xref:server/index.adoc[] for connector configuration. | ||
|
|
||
| [[thread-pool]] | ||
| ThreadPool:: | ||
| A component that manages worker threads for processing requests. | ||
| The default implementation is `QueuedThreadPool`. | ||
| See xref:programming-guide:arch/threads.adoc[] for thread architecture details. | ||
|
|
||
| [[web-application]] | ||
| Web Application:: | ||
| A collection of code, resources, and configuration deployed to a Jetty server. | ||
| Web applications can be Jakarta EE applications (WAR files), Jetty Core applications (using Handler APIs), or static file applications. | ||
| Each web application is deployed to a specific context path. | ||
| See xref:deploy/index.adoc[] for deployment options. | ||
|
|
||
| [[webapp-context]] | ||
| WebAppContext:: | ||
| A `ContextHandler` subclass specifically for Jakarta EE web applications. | ||
| It handles WAR file extraction, `web.xml` parsing, and servlet lifecycle management. | ||
| See xref:deploy/index.adoc[] for deployment information. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.