[HTTPCORE-656] Explicitly mention in HttpEntity.getContent() javadoc that closing InputStream will consume content

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 5.1-beta3, 5.1
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Marcono1234
• Created: 21/Dec/20 20:28
• Updated: 02/Apr/21 10:46
• Resolved: 23/Dec/20 22:57

Description

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, 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.