[java-shib-shared] branch main updated: JSSH-25 HTTPResource needs some rework to properly close response

[Rod Widdowson]

This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=cba7b6a8eaefcae19e592239df9fb27cce39cfeb

The following commit(s) were added to refs/heads/main by this push:
     new cba7b6a8 JSSH-25 HTTPResource needs some rework to properly close response
cba7b6a8 is described below

commit cba7b6a8eaefcae19e592239df9fb27cce39cfeb
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Apr 6 13:31:46 2023 +0100

    JSSH-25 HTTPResource needs some rework to properly close response
    
    https://shibboleth.atlassian.net/browse/JSSH-25
    
    Add some explanatory words to the javadoc for getResourceHeaders()
---
 .../shibboleth/shared/spring/httpclient/resource/HTTPResource.java    | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
index b390a705..5aedf091 100644
--- a/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
+++ b/shib-networking-spring/src/main/java/net/shibboleth/shared/spring/httpclient/resource/HTTPResource.java
@@ -250,7 +250,9 @@ public class HTTPResource extends AbstractIdentifiedInitializableComponent imple
      * Attempts to fetch only the headers for a given resource. If HEAD requests are unsupported then a more costly GET
      * request is performed.
      * 
-     * TODO: I suspect this needs to be revised to not return the HttpResponse since it's been closed.
+     * <b>NOTE</b> This method returns a <b>closed</b> {@link ClassicHttpResponse}.  See JSSH-25.
+     * It turns out that for the cases we need it this is OK and all three of them have regression
+     * tests.  If they fail, this will be revisisted.
      * 
      * @return the response from the request
      * 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.