Add a quick comment.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk@415797 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/java/org/apache/coyote/Request.java b/java/org/apache/coyote/Request.java
index b81fd77..5265bee 100644 (file)
--- a/java/org/apache/coyote/Request.java
+++ b/java/org/apache/coyote/Request.java
@@ -440,6 +440,25 @@ public final class Request {
     // -------------------- Per-Request "notes" --------------------\r
 \r
 \r
+    /** \r
+     * Used to store private data. Thread data could be used instead - but \r
+     * if you have the req, getting/setting a note is just a array access, may\r
+     * be faster than ThreadLocal for very frequent operations.\r
+     * \r
+     *  Example use: \r
+     *   Jk:\r
+     *     HandlerRequest.HOSTBUFFER = 10 CharChunk, buffer for Host decoding\r
+     *     WorkerEnv: SSL_CERT_NOTE=16 - MessageBytes containing the cert\r
+     *                \r
+     *   Catalina CoyoteAdapter:\r
+     *      ADAPTER_NOTES = 1 - stores the HttpServletRequest object ( req/res)             \r
+     *      \r
+     *   To avoid conflicts, note in the range 0 - 8 are reserved for the \r
+     *   servlet container ( catalina connector, etc ), and values in 9 - 16 \r
+     *   for connector use. \r
+     *   \r
+     *   17-31 range is not allocated or used.\r
+     */\r
     public final void setNote(int pos, Object value) {\r
         notes[pos] = value;\r
     }\r