You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by bu...@apache.org on 2009/07/13 15:40:02 UTC

DO NOT REPLY [Bug 47518] New: Valve Interface Javadocs for invoke method references non-existent method

https://issues.apache.org/bugzilla/show_bug.cgi?id=47518

           Summary: Valve Interface Javadocs for invoke method references
                    non-existent method
           Product: Tomcat 6
           Version: unspecified
          Platform: PC
               URL: http://tomcat.apache.org/tomcat-6.0-doc/api/org/apache
                    /catalina/Valve.html#invoke%28org.apache.catalina.conn
                    ector.Request,%20org.apache.catalina.connector.Respons
                    e%29
        OS/Version: Windows Vista
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
        AssignedTo: dev@tomcat.apache.org
        ReportedBy: chris@christopherschultz.net


It appears that the Valve interface javadoc hasn't been updated since around TC
5.5. Here is a snip of what it currently available from TC's website (6.0.20 I
would guess):

"
# If the corresponding Response was not generated (and control was not
returned, call the next Valve in the pipeline (if there is one) by executing
context.invokeNext().

.
.
.

# Modify the HTTP headers included with the Response after the invokeNext()
method has returned.
# Perform any actions on the output stream associated with the specified
Response after the invokeNext() method has returned.
"

The invokeNext method has not existed in the Valve interface in many versions.
I believe the replacement is:

this.getNext().invoke(request, response)

I'm happy to provide a doc patch if getNext().invoke(request, response) is the
expected replacement for invokeNext(request, response).

Note that the docs for 5.5 also have the same problem. Please let me know if I
should log that separately.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


DO NOT REPLY [Bug 47518] Valve Interface Javadocs for invoke method references non-existent method

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=47518





--- Comment #1 from Mark Thomas <ma...@apache.org>  2009-07-13 12:09:57 PST ---
That looks like the correct fix to me. No need to log 5.5.x separately although
patches for both would be appreciated.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


DO NOT REPLY [Bug 47518] Valve Interface Javadocs for invoke method references non-existent method

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=47518


Mark Thomas <ma...@apache.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED




--- Comment #4 from Mark Thomas <ma...@apache.org>  2009-07-20 23:38:16 PST ---
Thanks for the patches. They have been applied to trunk, 6.0.x and 5.5.x and
will be included in 6.0.21 and 5.5.29.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


DO NOT REPLY [Bug 47518] Valve Interface Javadocs for invoke method references non-existent method

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=47518





--- Comment #2 from Christopher Schultz <ch...@christopherschultz.net>  2009-07-16 14:48:48 PST ---
Created an attachment (id=23996)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=23996)
Patch to fix javadoc: s/invokeNext/getNext()/invoke/g

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


DO NOT REPLY [Bug 47518] Valve Interface Javadocs for invoke method references non-existent method

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=47518





--- Comment #3 from Christopher Schultz <ch...@christopherschultz.net>  2009-07-16 14:53:13 PST ---
Created an attachment (id=23997)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=23997)
Patch to fix javadoc in tc5.5

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org