Marcono1234 created HTTPCORE-656:
------------------------------------
Summary: Explicitly mention in HttpEntity.getContent() javadoc
that closing InputStream will consume content
Key: HTTPCORE-656
URL: https://issues.apache.org/jira/browse/HTTPCORE-656
Project: HttpComponents HttpCore
Issue Type: Improvement
Components: Documentation
Reporter: Marcono1234
Could the documentation of {{org.apache.http.HttpEntity.getContent()}} please
be improved to explicitly mention that calling {{close()}} on the returned
{{InputStream}} will try to consume the remaining entity content?
This is mentioned in the
[tutorial|https://hc.apache.org/httpcomponents-client-4.4.x/tutorial/html/fundamentals.html#d5e145],
but the javadoc only contains an "IMPORTANT" section which seems to be
addressed to implementers, but not users. Maybe it would also be good to
additionally link to the tutorial from the documentation of the method.
It appears the documentation not being explicit about this might be the reason
for HTTPCORE-402 and other issues users are having when {{close()}} is blocking
for them.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
