You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

175 lines
6.8 KiB

  1. ================================================================================
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. ================================================================================
  15. Apache Tomcat Version @VERSION@
  16. Release Notes
  17. =========
  19. =========
  20. * Dependency Changes
  21. * API Stability
  22. * Bundled APIs
  23. * Web application reloading and static fields in shared libraries
  24. * Security manager URLs
  25. * Symlinking static resources
  26. * Viewing the Tomcat Change Log
  27. * Cryptographic software notice
  28. * When all else fails
  29. ===================
  30. Dependency Changes:
  31. ===================
  32. Tomcat @VERSION_MAJOR_MINOR@ is designed to run on Java @MIN_JAVA_VERSION@ and later.
  33. ==============
  34. API Stability:
  35. ==============
  36. The public interfaces for the following classes are fixed and will not be
  37. changed at all during the remaining lifetime of the @VERSION_MAJOR@.x series:
  38. - All classes in the javax namespace
  39. The public interfaces for the following classes may be added to in order to
  40. resolve bugs and/or add new features. No existing interface method will be
  41. removed or changed although it may be deprecated.
  42. - org.apache.catalina.* (excluding sub-packages)
  43. Note: As Tomcat @VERSION_MAJOR@ matures, the above list will be added to. The list is not
  44. considered complete at this time.
  45. The remaining classes are considered part of the Tomcat internals and may change
  46. without notice between point releases.
  47. =============
  48. Bundled APIs:
  49. =============
  50. A standard installation of Tomcat @VERSION_MAJOR_MINOR@ makes all of the following APIs available
  51. for use by web applications (by placing them in "lib"):
  52. * annotations-api.jar (Annotations package)
  53. * catalina.jar (Tomcat Catalina implementation)
  54. * catalina-ant.jar (Tomcat Catalina Ant tasks)
  55. * catalina-ha.jar (High availability package)
  56. * catalina-ssi.jar (Server-side Includes module)
  57. * catalina-storeconfig.jar (Generation of XML configuration from current state)
  58. * catalina-tribes.jar (Group communication)
  59. * ecj-@JDT_VERSION@.jar (Eclipse JDT Java compiler)
  60. * el-api.jar (EL 3.0 API)
  61. * jasper.jar (Jasper 2 Compiler and Runtime)
  62. * jasper-el.jar (Jasper 2 EL implementation)
  63. * jsp-api.jar (JSP 2.3 API)
  64. * servlet-api.jar (Servlet 4.0 API)
  65. * tomcat-api.jar (Interfaces shared by Catalina and Jasper)
  66. * tomcat-coyote.jar (Tomcat connectors and utility classes)
  67. * tomcat-dbcp.jar (package renamed database connection pool based on Commons DBCP 2)
  68. * tomcat-jdbc.jar (Tomcat's database connection pooling solution)
  69. * tomcat-jni.jar (Interface to the native component of the APR/native connector)
  70. * tomcat-util.jar (Various utilities)
  71. * tomcat-websocket.jar (WebSocket 1.1 implementation)
  72. * websocket-api.jar (WebSocket 1.1 API)
  73. You can make additional APIs available to all of your web applications by
  74. putting unpacked classes into a "classes" directory (not created by default),
  75. or by placing them in JAR files in the "lib" directory.
  76. To override the XML parser implementation or interfaces, use the appropriate
  77. feature for your JVM. For Java <= 8 use the endorsed standards override
  78. feature. The default configuration defines JARs located in "endorsed" as endorsed.
  79. For Java 9+ use the upgradeable modules feature.
  80. ================================================================
  81. Web application reloading and static fields in shared libraries:
  82. ================================================================
  83. Some shared libraries (many are part of the JDK) keep references to objects
  84. instantiated by the web application. To avoid class loading related problems
  85. (ClassCastExceptions, messages indicating that the classloader
  86. is stopped, etc.), the shared libraries state should be reinitialized.
  87. Something which might help is to avoid putting classes which would be
  88. referenced by a shared static field in the web application classloader,
  89. and putting them in the shared classloader instead (JARs should be put in the
  90. "lib" folder, and classes should be put in the "classes" folder).
  91. ======================
  92. Security manager URLs:
  93. ======================
  94. In order to grant security permissions to JARs located inside the
  95. web application repository, use URLs of the following format
  96. in your policy file:
  97. file:${catalina.base}/webapps/examples/WEB-INF/lib/driver.jar
  98. ============================
  99. Symlinking static resources:
  100. ============================
  101. By default, Unix symlinks will not work when used in a web application to link
  102. resources located outside the web application root directory.
  103. This behavior is optional, and the "allowLinking" flag may be used to disable
  104. the check.
  105. ==============================
  106. Viewing the Tomcat Change Log:
  107. ==============================
  108. The full change log is available from and is also
  109. included in the documentation web application.
  110. =============================
  111. Cryptographic software notice
  112. =============================
  113. This distribution includes cryptographic software. The country in
  114. which you currently reside may have restrictions on the import,
  115. possession, use, and/or re-export to another country, of
  116. encryption software. BEFORE using any encryption software, please
  117. check your country's laws, regulations and policies concerning the
  118. import, possession, or use, and re-export of encryption software, to
  119. see if this is permitted. See <> for more
  120. information.
  121. The U.S. Government Department of Commerce, Bureau of Industry and
  122. Security (BIS), has classified this software as Export Commodity
  123. Control Number (ECCN) 5D002.C.1, which includes information security
  124. software using or performing cryptographic functions with asymmetric
  125. algorithms. The form and manner of this Apache Software Foundation
  126. distribution makes it eligible for export under the License Exception
  127. ENC Technology Software Unrestricted (TSU) exception (see the BIS
  128. Export Administration Regulations, Section 740.13) for both object
  129. code and source code.
  130. The following provides more details on the included cryptographic
  131. software:
  132. - Tomcat includes code designed to work with JSSE
  133. - Tomcat includes code designed to work with OpenSSL
  134. ====================
  135. When all else fails:
  136. ====================
  137. See the FAQ