From: costin <costin@13f79535-47bb-0310-9956-ffa450edef68>
Date: Tue, 20 Jun 2006 20:46:23 +0000 (+0000)
Subject: Add a quick comment.
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=ebf07466cdbd83f833b69179686aa9c556db7383;p=tomcat7.0

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 b81fd7763..5265bee80 100644
--- 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" --------------------
 
 
+    /** 
+     * Used to store private data. Thread data could be used instead - but 
+     * if you have the req, getting/setting a note is just a array access, may
+     * be faster than ThreadLocal for very frequent operations.
+     * 
+     *  Example use: 
+     *   Jk:
+     *     HandlerRequest.HOSTBUFFER = 10 CharChunk, buffer for Host decoding
+     *     WorkerEnv: SSL_CERT_NOTE=16 - MessageBytes containing the cert
+     *                
+     *   Catalina CoyoteAdapter:
+     *      ADAPTER_NOTES = 1 - stores the HttpServletRequest object ( req/res)             
+     *      
+     *   To avoid conflicts, note in the range 0 - 8 are reserved for the 
+     *   servlet container ( catalina connector, etc ), and values in 9 - 16 
+     *   for connector use. 
+     *   
+     *   17-31 range is not allocated or used.
+     */
     public final void setNote(int pos, Object value) {
         notes[pos] = value;
     }