Skip to content

Document Apache HTTP client APIs #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 2 commits into from
Aug 14, 2026
Merged

Document Apache HTTP client APIs #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21026b5
Document Apache HTTP client APIs
jonathanpeppers Aug 14, 2026
157a8c0
Address Apache HTTP client doc review
jonathanpeppers Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/xml/Org.Apache.Http.Client/CircularRedirectException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<param name="message">The exception detail message.</param>
<summary>Creates a new CircularRedirectException with the specified detail message.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
Expand Down Expand Up @@ -134,8 +134,8 @@
<Parameter Name="cause" Type="Java.Lang.Throwable" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<param name="cause">To be added.</param>
<param name="message">The exception detail message.</param>
<param name="cause">The <see cref="T:Java.Lang.Throwable" /> that caused this exception, or <c>null</c> if the cause is unavailable or unknown.</param>
<summary>Creates a new CircularRedirectException with the specified detail message and cause.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
Expand Down
6 changes: 3 additions & 3 deletions docs/xml/Org.Apache.Http.Client/ICookieStore.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@
<Parameter Name="date" Type="Java.Util.Date" />
</Parameters>
<Docs>
<param name="date">To be added.</param>
<param name="date">The date by which cookies must have expired to be removed.</param>
<summary>Removes all of <see cref="T:Org.Apache.Http.Cookies.ICookie" /> in this store that have expired by
the specified <see cref="T:Java.Util.Date" />.</summary>
<returns>To be added.</returns>
<returns><c>true</c> if any cookies were purged; otherwise, <c>false</c>.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -159,7 +159,7 @@
</ReturnValue>
<Docs>
<summary>Returns all cookies contained in this store.</summary>
<value>To be added.</value>
<value>All cookies.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
2 changes: 1 addition & 1 deletion docs/xml/Org.Apache.Http.Client/ICredentialsProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
<Docs>
<param name="authscope">the <see cref="T:Org.Apache.Http.Authentication.AuthScope" /></param>
<summary>Get the <see cref="T:Org.Apache.Http.Authentication.ICredentials" /> for the given authentication scope.</summary>
<returns>To be added.</returns>
<returns>The credentials.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
52 changes: 26 additions & 26 deletions docs/xml/Org.Apache.Http.Client/IHttpClient.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ReturnValue>
<Docs>
<summary>Obtains the connection manager used by this client.</summary>
<value>To be added.</value>
<value>The connection manager.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -94,7 +94,7 @@
<Docs>
<param name="request">the request to execute</param>
<summary tool="true">Executes a request to the target using the given context.</summary>
<returns>To be added.</returns>
<returns>The final response to the request. It is never an intermediate response with a 1xx status code. Whether redirects or authentication challenges are returned or handled automatically depends on the client implementation and configuration.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -132,10 +132,10 @@
<Parameter Name="responseHandler" Type="Org.Apache.Http.Client.IResponseHandler" />
</Parameters>
<Docs>
<param name="request">To be added.</param>
<param name="responseHandler">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="request">The request to execute.</param>
<param name="responseHandler">The response handler.</param>
<summary>Executes a request using the default context and processes the response using the given response handler.</summary>
<returns>The response object generated by the response handler.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -169,7 +169,7 @@
<param name="context">the context to use for the execution, or
<c>null</c> to use the default context</param>
<summary>Executes a request using the given context.</summary>
<returns>To be added.</returns>
<returns>The final response to the request. It is never an intermediate response with a 1xx status code. Whether redirects or authentication challenges are returned or handled automatically depends on the client implementation and configuration.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -209,7 +209,7 @@
to a default target or by inspecting the request.</param>
<param name="request">the request to execute</param>
<summary>Executes a request to the target using the default context.</summary>
<returns>To be added.</returns>
<returns>The final response to the request. It is never an intermediate response with a 1xx status code. Whether redirects or authentication challenges are returned or handled automatically depends on the client implementation and configuration.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -248,11 +248,11 @@
<Parameter Name="context" Type="Org.Apache.Http.Protocol.IHttpContext" />
</Parameters>
<Docs>
<param name="request">To be added.</param>
<param name="responseHandler">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="request">The request to execute.</param>
<param name="responseHandler">The response handler.</param>
<param name="context">The context to use for the execution, or <c>null</c> to use the default context.</param>
<summary>Executes a request using the given context and processes the response using the given response handler.</summary>
<returns>The response object generated by the response handler.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -287,11 +287,11 @@
<Parameter Name="responseHandler" Type="Org.Apache.Http.Client.IResponseHandler" />
</Parameters>
<Docs>
<param name="target">To be added.</param>
<param name="request">To be added.</param>
<param name="responseHandler">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="target">The target host for the request. Implementations may accept <c>null</c> when they can still determine a route, for example to a default target or by inspecting the request.</param>
<param name="request">The request to execute.</param>
<param name="responseHandler">The response handler.</param>
<summary>Executes a request to the target using the default context and processes the response using the given response handler.</summary>
<returns>The response object generated by the response handler.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -330,7 +330,7 @@
<param name="context">the context to use for the execution, or
<c>null</c> to use the default context</param>
<summary>Executes a request to the target using the given context.</summary>
<returns>To be added.</returns>
<returns>The final response to the request. It is never an intermediate response with a 1xx status code. Whether redirects or authentication challenges are returned or handled automatically depends on the client implementation and configuration.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -370,12 +370,12 @@
<Parameter Name="context" Type="Org.Apache.Http.Protocol.IHttpContext" />
</Parameters>
<Docs>
<param name="target">To be added.</param>
<param name="request">To be added.</param>
<param name="responseHandler">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="target">The target host for the request. Implementations may accept <c>null</c> when they can still determine a route, for example to a default target or by inspecting the request.</param>
<param name="request">The request to execute.</param>
<param name="responseHandler">The response handler.</param>
<param name="context">The context to use for the execution, or <c>null</c> to use the default context.</param>
<summary>Executes a request to the target using the given context and processes the response using the given response handler.</summary>
<returns>The response object generated by the response handler.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand All @@ -402,7 +402,7 @@
</ReturnValue>
<Docs>
<summary>Obtains the parameters for this client.</summary>
<value>To be added.</value>
<value>The default parameters. These become defaults for requests executed with this client and for parameters of dependent objects.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
Loading