BUILDING.txt0100644 0000000 0000000 00000002072 00000250600 011522 0ustar000000000 0000000 Building HttpComponents Client ============================ (1) Requisites -------------- JDK 1.7+ is required in order to compile and run HttpClient. HttpClient utilizes Maven as a distribution management and packaging tool. Version 3.3 or later is required. Maven installation and configuration instructions can be found here: http://maven.apache.org/run-maven/index.html (2) Executing test cases Execute the following command in order to compile and test the components mvn test (3) Building packages Execute the following command in order to build the JAR packages and install them to the local repository: mvn install The JAR packages can be found in the target folders of their respective modules httpclient5/target/httpclient5-.jar httpclient5-cache/target/httpclient5-cache-.jar httpclient5-fluent/target/httpclient5-fluent-.jar httpclient5-osgi/target/org.apache.httpcomponents.httpclient_.jar where is the release version (4) Validating packages Check for proper license headers with: mvn apache-rat:check CODE_OF_CONDUCT.md0100644 0000000 0000000 00000001641 00000250600 012364 0ustar000000000 0000000 The Apache code of conduct page is [https://www.apache.org/foundation/policies/conduct.html](https://www.apache.org/foundation/policies/conduct.html). LICENSE.txt0100644 0000000 0000000 00000065075 00000250600 011423 0ustar000000000 0000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS ========================================================================= This project includes Public Suffix List copied from licensed under the terms of the Mozilla Public License, v. 2.0 Full license text: Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. NOTICE.txt0100644 0000000 0000000 00000001043 00000250600 011303 0ustar000000000 0000000 Apache HttpComponents Client Copyright 1999-2025 The Apache Software Foundation This product includes software developed at The Apache Software Foundation (http://www.apache.org/). This product includes a copy of in https://publicsuffix.org/list/effective_tld_names.dat in httpclient5/src/test/resources/org/publicsuffix/list/effective_tld_names.dat This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/. README.md0100644 0000000 0000000 00000013116 00000250600 011044 0ustar000000000 0000000 Apache HttpComponents Client ============================ Welcome to the HttpClient component of the Apache HttpComponents project. [![GitHub Actions Status](https://github.com/apache/httpcomponents-client/workflows/Java%20CI/badge.svg)](https://github.com/apache/httpcomponents-client/actions) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Building Instructions --------------------- For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt). Dependencies ------------ HttpClient main module requires Java 8 compatible runtime and depends on the following external libraries: * [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core) * [SLF4J API](http://www.slf4j.org/) Other dependencies are optional. (for detailed information on external dependencies please see [pom.xml](./pom.xml)) Protocol conformance -------------------- - [RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110) - HTTP Semantics - [RFC 9111](https://datatracker.ietf.org/doc/html/rfc9111) - HTTP Caching - [RFC 9112](https://datatracker.ietf.org/doc/html/rfc9112) - Hypertext Transfer Protocol Version 1.1 (HTTP/1.1) - [RFC 9113](https://datatracker.ietf.org/doc/html/rfc9113) - Hypertext Transfer Protocol Version 2 (HTTP/2) - [RFC 7541](https://datatracker.ietf.org/doc/html/rfc7541) - HPACK: Header Compression for HTTP/2 - [RFC 1945](https://datatracker.ietf.org/doc/html/rfc1945) - Hypertext Transfer Protocol -- HTTP/1.0 - [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) - Uniform Resource Identifier (URI): Generic Syntax - [RFC 6265](https://datatracker.ietf.org/doc/html/rfc6265) - HTTP State Management Mechanism (Cookies) - [RFC 7616](https://datatracker.ietf.org/doc/html/rfc7616) - HTTP Digest Access Authentication - [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617) - HTTP 'Basic' Authentication Scheme - [RFC 5861](https://datatracker.ietf.org/doc/html/rfc5861) - HTTP Cache-Control Extensions for Stale Content - [RFC 2817](https://datatracker.ietf.org/doc/html/rfc2817) - Upgrading to TLS Within HTTP/1.1 - [RFC 9218](https://datatracker.ietf.org/doc/html/rfc9218) - Extensible Prioritization Scheme for HTTP - [RFC 7804](https://datatracker.ietf.org/doc/html/rfc7804) - Salted Challenge Response HTTP Authentication Mechanism Licensing --------- Apache HttpComponents Client is licensed under the Apache License 2.0. See the files [LICENSE.txt](./LICENSE.txt) and [NOTICE.txt](./NOTICE.txt) for more information. Contact ------- - For general information visit the main project site at https://hc.apache.org/ - For current status information visit the status page at https://hc.apache.org/status.html - If you want to contribute visit https://hc.apache.org/get-involved.html Cryptographic Software Notice ----------------------------- This distribution may include software that has been designed for use with cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See https://www.wassenaar.org/ for more information. The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. The following provides more details on the included software that may be subject to export controls on cryptographic software: > Apache HttpComponents Client interfaces with the > Java Secure Socket Extension (JSSE) API to provide > - HTTPS support > > Apache HttpComponents Client does not include any > implementation of JSSE. RELEASE_NOTES.txt0100644 0000000 0000000 00000504156 00000250600 012367 0ustar000000000 0000000 Release 5.6.2 ------------------ This maintenance release upgrades HttpCore to the latest stable version and restores lazy content decompression by the classic client transport. Change Log ------------------- * Upgraded HttpCore to version 5.4.3. Contributed by Oleg Kalnichevski * HTTPCLIENT-2422: Restore lazy content decompression. Defer construction of the decompression stream until the response content is actually read. Contributed by Arturo Bernal Release 5.6.1 ------------------ This maintenance release disables experimental SCRAM auth scheme by default and fixes SCRAM final response handling. The SCRAM auth scheme can be re-enabled by choosing a custom auth scheme preference sequence that explicitly includes SCRAM auth. Change Log ------------------- * Fix SCRAM final response handling. Contributed by Arturo Bernal * Auth challenge parsing code improvement. Contributed by Oleg Kalnichevski * Add missing Javadoc for ConnectionConfig (#820). Contributed by Gary Gregory * Bug fix: Corrected async message exchange cancellation logic in InternalHttpAsyncExecRuntime. Contributed by Oleg Kalnichevski * HTTPCLIENT-2417: Honor TlsConfig attachment in async connect path. Contributed by Arturo Bernal * HTTPCLIENT-2414: Fix Basic auth cache scoping across path prefixes (#802). Contributed by Arturo Bernal * HTTPCLIENT-2415: Normalize CookieOrigin path for cookie matching (#803). Contributed by Arturo Bernal * Bug fix: Corrected sleep time calculation in IdleConnectionEvictor; use 1 minute sleep time by default. Contributed by Oleg Kalnichevski * DefaultManagedHttpClientConnection: Restore original socket timeout. Contributed by Ryan Schmitt * HTTPCLIENT-2411: Use standard HTTP-date format for synthesized Date header (#775). Contributed by Arturo Bernal * Fix NPE in connection evictor setup (#774). Contributed by Arturo Bernal Release 5.6 ------------------ This is the first GA release in the 5.6 release series. It adds several features such as transport content decompression and content compression for the async transport, support for Unix sockets, experimental support for SCRAM-SHA-256 authentication scheme, and Micrometer/OTel observations & metrics. Commons Compress, Brotli codec, and ZStd codec are optional dependencies and get wired into the execution pipeline only if present on the classpath. Notable changes and features included in the 5.6 series: * Unix domain socket support. * Support for pluggable content codecs via Commons-Compress in the classic transport. (optional). * Support for transparent content decompression and content compression with `deflate`, `gzip`, `zstd` (optional), and `brotli` (optional) codecs in the async transport. * Micrometer/OTel observations & metrics (optinal). * Off-lock connection disposal by the classic pooling connection manager. Experimental. * SCRAM-SHA-256 authentication scheme (RFC 7804). Experimental. * Request Priority support (RFC 9218). Experimental. * OFFLOCK connection pool concurrency policy. Experimental. Compatibility notes: * As of this version, HttpClient uses BUILTIN HostnameVerificationPolicy by default, delegating host verification to JSSE security manager. One must explicitly configure the TLS strategy to continue using the hostname verifier shipped with HttpClient. * Five-second TCP keep-alive is now enabled by default. Change Log ------------------- * Limit the length of the content codec list that can be processed automatically. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.4 Contributed by Oleg Kalnichevski * OFFLOCK connection pool concurrency policy backed by RouteSegmentedConnPool (#765). Contributed by Arturo Bernal Release 5.6 ALPHA1 ------------------ This is the first ALPHA release in the 5.6 release series. It adds several features such as transport content decompression and content compression for the async transport, support for Unix sockets, experimental support for SCRAM-SHA-256 authentication scheme, and Micrometer/OTel observations & metrics. Commons Compress, Brotli codec, and ZStd codec are optional dependencies and get wired into the execution pipeline only if present on the classpath. Change Log ------------------- * RequestConfig: Un-deprecate #setProxy. Contributed by Ryan Schmitt * Stale connection check support in PoolingAsyncClientConnectionManager. Contributed by Ryan Schmitt * ConnectionConfig: `#idleTimeout` support. Contributed by Ryan Schmitt * HTTPCLIENT-1822: Support for async transparent content decompression and content compression with `brotli` codec (#720). Contributed by Arturo Bernal * SCRAM-SHA-256 authentication scheme (RFC 7804) (#718). Contributed by Arturo Bernal * Off-lock connection disposal in PoolingHttpClientConnectionManager (#726). Contributed by Arturo Bernal * Add SPKI pinning TLS decorator (#715). Contributed by Arturo Bernal * HTTPCLIENT-2387: Micrometer/OTel observations & metrics (#706). Contributed by Arturo Bernal * Clarification of the behavior of the protocol level `responseTimeout` and the connection management level `socketTimeout` and their interrelation. Contributed by ChangYong * HTTPCLIENT-1822: Support for async transparent content decompression and content compression with `zstd` codec (#703). Contributed by Arturo Bernal * HTTPCLIENT-1822: Support for async transparent content decompression and content compression with `gzip` codec (#700). Contributed by Arturo Bernal * Enable new TcpKeepAlive options on Java 8. Contributed by Ryan Schmitt * Unsupported content encoding to be treated as an error. Contributed by Oleg Kalnichevski * HTTPCLIENT-1822: Support for async transparent content decompression and content compression with `deflate` codec. Contributed by Arturo Bernal * HTTPCLIENT-2385: Default managed connection implementations now have public constructors marked as internal (#692). Contributed by winfriedgerlach <158032591+winfriedgerlach at users.noreply.github.com> * HTTPCLIENT-2383: Bypass sensitive-header check in LaxRedirectStrategy (#676). Contributed by Arturo Bernal * Enable JEP 380 UDS support for sync client. Contributed by Ryan Schmitt * HTTPCLIENT-2375 Support for pluggable Commons-Compress encoders (#657). Contributed by Arturo Bernal * HTTPCLIENT-1843: Support for pluggable Commons-Compress decoders (#651). Contributed by Arturo Bernal * Switched HostnameVerificationPolicy to BUILTIN by default Contributed by Oleg Kalnichevski * Omit cookie spec registry when cookie management is disabled. Contributed by Ryan Schmitt * java.nio.file.Body-based MIME body (#641). Contributed by Gary Gregory * Unix domain socket support. Contributed by Ryan Schmitt Release 5.5 ------------------ This is the first GA release in the 5.5 release series. This release finalizes the 5.5 APIs and adds several experimental features and improvements, such as request multiplexing over a shared HTTP/2 connection and the Classic API facade acting as a compatibility bridge between classic I/O client services and the asynchronous message transport used internally. Notable changes and features included in the 5.5 series: * Improved conformance to RFC 7616 (HTTP Digest Access Authentication). * The connection pool implementation acts as a caching facade in front of a standard managed connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Experimental. * Extended Auth API and improved authentication protocol logic to support mutual authentication. * The Classic API facade now acts as a compatibility bridge between the classic I/O client services (based on the standard InputStream / OutputStream model) and the asynchronous message transport used internally. This is experimental. * HTTP/2 support for the Fluent Facade (via Classic API facade). This is experimental. Compatibility notes: * As of this release, HttpClient does not automatically execute redirects if the original request manually added headers that are considered sensitive. Change Log ------------------- * HTTPCLIENT-2367: Fixed NPE in InternalAbstractHttpAsyncClient by adding a null check for resolvedTarget (#634). Contributed by Arturo Bernal * Fixed case of Cookie#HTTP_ONLY_ATTR Contributed by Finn Petersen * Simplified ProtocolSwitchStrategy by leveraging ProtocolVersionParser (#627). Contributed by Arturo Bernal * HTTPCLIENT-2364: Fixed incorrect re-binding of the upgraded SSL socket to the HTTP connection by the #upgrade method of the DefaultHttpClientConnectionOperator. Contributed by Oleg Kalnichevski * HTTPCLIENT-2363: ensure requests have a scheme and an authority populated before they get committed to the execution pipeline. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.3.4 Contributed by Oleg Kalnichevski * Disallow automatic request redirection if the original request contains potentially sensitive headers. Contributed by Oleg Kalnichevski * HTTPCLIENT-2360: Enhance filename encoding in multipart/form-data per RFC 6266/5987 (#618). Contributed by Oleg Kalnichevski * Corrected APIs in ClientTlsStrategyBuilder to be compatible with Classic APIs. Contributed by Oleg Kalnichevski * Bump testcontainers.version from 1.20.4 to 1.20.6 #622. Contributed by Gary Gregory * Bump org.junit:junit-bom from 5.11.4 to 5.12.2 #623, #632. Contributed by Gary Gregory * Bump log4j.version from 2.23.1 to 2.24.3 #626. Contributed by Gary Gregory Release 5.5 ALPHA1 ------------------ This is the first ALPHA release in the 5.5 release series. It adds several experimental features and improvements such as request multiplexing over a shared HTTP/2 connection and the Classic API facade acting as a compatibility bridge between classic I/O client services and the asynchronous message transport used internally. Notable changes and features included in the 5.5 series: * Improved conformance to RFC 7616 (HTTP Digest Access Authentication). * The connection pool implementation acts as a caching facade in front of a standard managed connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Experimental. * Extended Auth API and improved authentication protocol logic to support mutual authentication. * The Classic API facade acting as a compatibility bridge between the classic I/O client services (based on the standard InputStream / OutputStream model) and the asynchronous message transport used internally. Experimental. * HTTP/2 support for the Fluent Facade (via Classic API facade). Experimental. Change Log ------------------- * Async transport can now be used internally by the Fluent Facade. Contributed by Oleg Kalnichevski * Classic over async bridge. Contributed by Oleg Kalnichevski * HTTPCLIENT-2356: Extended Auth APIs and authentication protocol logic to support mutual authentication. Contributed by Istvan Toth * Decode Subject Alternative Names for IP, DNS, and binary data (#610). Contributed by Arturo Bernal * Do not add `Upgrade` header if `Connection` header is already present (the caller manually manages connection state). Contributed by Oleg Kalnichevski * Avoid logging the HTTP message version where it can be a hint, not a protocol version. Contributed by Oleg Kalnichevski * Experimental connections pool implementation that acts as a caching facade in front of a standard ManagedConnPool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Contributed by Oleg Kalnichevski * HTTPCLIENT-2350 - Refactored the connect method in DefaultHttpClientConnectionOperator to enhance flexibility in address resolution, specifically allowing for direct handling of unresolved addresses (#598). Contributed by Arturo Bernal * Enhanced DigestScheme for RFC 7616 Compliance and Expanded Hash Algorithm Support (#597). Contributed by Arturo Bernal * Added request interceptor to check the `Authentication-Info` header in HTTP Digest Access Authentication (#596). Contributed by Arturo Bernal * Added client-side `rspauth` value for Digest auth, verifying server knowledge of shared secret per RFC 7616. (#594). Contributed by Arturo Bernal * Corrected method chaining in ClientTlsStrategyBuilder. Contributed by Osip Fatkullin * HTTPCLIENT-2337: Sanitize X500Principal Logging in ClientTlsStrategy classes (#581). Contributed by Arturo Bernal Release 5.4 ------------------ This is the first GA release in the 5.4 release series. This release finalizes the 5.4 APIs, upgrades HttpCore to version 5.3 and improves the Public Suffix matching algorithm implementation. IMPORTANT! The new cache entry serialization format is incompatible with earlier versions of HttpClient Cache. Persistent caches (file system based, Memcached, EhCAche with object serialization) created with any earlier version MUST be flushed and re-populated or the cache backend MUST be configured to use the old, deprecated cache entry serializer. Notable changes and features included in the 5.4 series: * Improved conformance to RFC 9110 (HTTP Semantics), RFC 7616 (HTTP Digest Access Authentication), RFC 2617 (’Basic’ HTTP Authentication Scheme). * UTF-8 encoding is used by default for text where appropriate. * Compatibility with Java Virtual Threads and Java 21 Runtime. * Redesign and rewrite of the HTTP caching protocol layer for better efficiency and improved conformance to RFC 9111 (HTTP Caching). * Cache control and context APIs. * ETag APIs. * TLS SNI and endpoint identification improvements. * Support for RFC 2817 (Upgrading to TLS Within HTTP/1.1). * Auth cache no longer makes use of Java serialization. * Deprecation of ConnectionSocketFactory and LayeredConnectionSocketFactory. * HttpContext optimization and performance improvement. * Async cache is no longer considered experimental. Change Log ------------------- * HTTPCLIENT-2338: Put compress exec interceptor after retry exec interceptor. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.3. Contributed by Oleg Kalnichevski * Javadoc improvements. Contributed by Gary Gregory * DeflateInputStream extends FilterInputStream Contributed by Gary Gregory * HTTPCLIENT-2335: Added close() method with CloseMode parameter to CloseableHttpResponse. Contributed by Oleg Kalnichevski * HTTPCLIENT-2336: Corrected hostname identity verification logic. Contributed by Oleg Kalnichevski * HTTPCLIENT-2336: Updated PublicSuffixMatcher to use the 'formal algorithm' as specified https://github.com/publicsuffix/list/wiki/Format#formal-algorithm. Contributed by Adrian Woodhead * Input streams returned by DecompressingEntity#getContent to support mark(int) and reset() if the underlying stream does. Contributed by Gary Gregory * Improved FQDN matching. Contributed by Oleg Kalnichevski * Removed @Experimental from async cache classes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2333: Update execution scope upon request redirect to avoid re-execution of the original request in case of an I/O error. Contributed by Oleg Kalnichevski * Re-introduced LaxRedirectStrategy from 4.x Contributed by Otavio Prado Release 5.4 BETA1 ------------------ This is the first BETA release in the 5.4 release series. It upgrades HttpCore to version 5.3-beta1 and adds a few minor improvements and fixes. Change Log ------------------- * HTTPCLIENT-2328: Blocking I/O connections to check if the opposite TLS endpoint has been closed by the opposite endpoint while writing out request body. Contributed by Oleg Kalnichevski * Redesign of test server APIs and integration test setup. Contributed by Oleg Kalnichevski * HTTPCLIENT-2331: Skip cookie header generation if a Cookie header is already present (#561). Contributed by Arturo Bernal * HTTPCLIENT-2326: Propagate original proxy response to the caller in case of HTTP CONNECT request failure. Contributed by Oleg Kalnichevski * HTTPCLIENT-2327: Propagate CancellationExceptions from MemcachedClient operations as ResourceIOExceptions (#559). Contributed by jattisha * Callbacks for Connection initialization. Contributed by Richard Tippl * HTTPCLIENT-2325 Avoid adding "; charset=" for multipart/form-data requests Contributed by Vladimir Sitnikov Release 5.4 ALPHA2 ------------------ This is the second and likely the last ALPHA release in the 5.3 release series. It finalizes the new Cache API introduced in the previous ALPHA release and also improves TLS customization for the classic transport, SNI and endpoint identification support, authentication data caching, and HTTP context performance. It also introduces support for optional TLS upgrades for HTTP/1.1 connections. Change Log ------------------- * HttpClientContext to use instance variables for standard attributes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2151: Support for JSSE in-built endpoint identification. Contributed by Oleg Kalnichevski * Internal connection operators to make use of the target name from the request URI authority. Contributed by Oleg Kalnichevski * DefaultRoutePlanner to take the request authority into account when determining a route for HTTPS requests. Contributed by Oleg Kalnichevski * RouteInfo and HttpRoute to include the target name from the URI authority in case it differs from the target host (the host recognizes multiple authorities). Contributed by Oleg Kalnichevski * HTTPCLIENT-2316: BasicHttpClientConnectionManager incorrectly re-uses the released connection if it has been closed out by the protocol handler. Contributed by Oleg Kalnichevski * HTTPCLIENT-2070: Auth cache to no longer rely on Java serialization for auth state caching. Contributed by Oleg Kalnichevski * HTTPCLIENT-751: Support for RFC 2817 (Upgrading to TLS Within HTTP/1.1). Contributed by Oleg Kalnichevski * Connection endpoints to provide TLS details and protocol version. Contributed by Oleg Kalnichevski * Deprecated ConnectionSocketFactory, LayeredConnectionSocketFactory, and their plain and SSL implementations in favor of DefaultClientTlsStrategy. Contributed by Oleg Kalnichevski * Standard client TLS strategy implementations support the upgrading of blocking sockets. Contributed by Oleg Kalnichevski * FileResourceFactory to generate stable file names for the same request ID and entity tag. Contributed by Oleg Kalnichevski * Cache ResourceFactory to make use of strong eTags when available. Contributed by Oleg Kalnichevski * ETag APIs. Contributed by Oleg Kalnichevski * Fixed a design mistake of ConnectionEndpoint having a direct dependency on HttpRequestExecutor class. Contributed by Oleg Kalnichevski * Cache control and context APIs. Contributed by Oleg Kalnichevski * HTTPCLIENT-2315: Client builders fail to apply system properties to the default connection manager. Contributed by Oleg Kalnichevski * HTTPCLIENT-2314: Handle gracefully a failure of DnsResolver to return a list of resolved addresses (#533). Contributed by Philip Helger * HTTPCLIENT-2314: Throw ConnectionShutdownException in case of pooled connection having been closed or discarded instead of plain IllegalStateException. Contributed by Oleg Kalnichevski Release 5.4 ALPHA1 ------------------- This is the first ALPHA release in the 5.4 release series that improves HTTP protocol support by ensuring conformance to the latest HTTP specification (RFC 9110, RFC 9111, RFC 7616, RFC 7617), ensures compatibility with Java Virtual Threads by replacing 'synchronized' keywords in critical sections with Java lock primitives. The HTTP caching protocol layer has also been redesigned and overhauled to improve cache efficiency and optimize performance. Change Log ------------------- * `username*` validation and decoding in DigestScheme as per RFC (#511). Contributed by Arturo Bernal * Support for Userhash parameter in Digest authentication as per RFC 7616 (#509). Contributed by Arturo Bernal * Enforce UTF-8 encoding in Digest authentication according to RFC 7616 (#508). Contributed by Arturo Bernal * Enforce UTF-8 encoding in BasicSchemeFactory as per RFC 7617 (#506). Contributed by Arturo Bernal * Stricter password validation in BasicScheme (#505). Contributed by Arturo Bernal * Bug fix: When validating a cache entry the protocol handlers must use the current request message with additional headers generated by the previous request interceptors instead of the original request message. Contributed by Oleg Kalnichevski * Better debug logging in the caching protocol handlers. Contributed by Oleg Kalnichevski * Better HTTP execution context management by caching protocol handlers. Contributed by Oleg Kalnichevski * HTTPCLIENT-2301. Fixed a concurrency defect in the connection release code of BasicHttpClientConnectionManager. Contributed by Arturo Bernal * HttpCacheEntry to cache parsed DATE, EXPIRES, and LAST_MODIFIED values; avoid parsing DATE header of cache entries and HTTP messages multiple times. Contributed by Oleg Kalnichevski * HTTPCLIENT-2293: Via header protocol improvements and performance optimization. Contributed by Oleg Kalnichevski * HTTPCLIENT-2293: RFC-compliant TRACE request interceptor (#486). Contributed by Arturo Bernal * HTTPCLIENT-2293: 'If-Range' request validation as per RFC 9110 (#485). Contributed by Arturo Bernal * HTTPCLIENT-2293: Enforce port specification for CONNECT requests as per RFC 9110 (#482). Contributed by Arturo Bernal * HTTPCLIENT-2284: Internal cache storage improvements (#478). Contributed by Oleg Kalnichevski * Replace `synchronized` blocks with ReentrantLock to ensure compatibility with virtual threads (#476). Contributed by Arturo Bernal * HTTPCLIENT-2284: Cache entry representation improvements: (#477). Contributed by Oleg Kalnichevski * HTTPCLIENT-2277: Rewrite the caching protocol layer for improved efficiency and conformance to RFC 9111. Contributed by Arturo Bernal and Oleg Kalnichevski and * Request and response Cache-Control APIs Contributed by Arturo Bernal and Oleg Kalnichevski and * HttpByteArrayCacheEntrySerializer refactoring and performance improvements. Contributed by Arturo Bernal Release 5.3 ------------------- This is the first GA release in the 5.3 release series. This release finalizes the 5.3 APIs and also includes all bug fixes from the 5.2 release branch. The 5.3 release series introduces support for the Bearer authentication scheme (RFC 6750) and deprecates NTLM and GSS-based experimental authentication schemes in favor of Basic / Bearer authentication with TLS. Notable changes and features included in the 5.3 series: * Introduction of the Bearer authentication scheme. * Deprecation of the NTLM authentication scheme. * Deprecation of the GSS-based experimental authentication schemes. * Support for load distribution across multiple proxies. Change Log ------------------- * HTTPCLIENT-2310: Async Connect exec handler incorrectly pipes CONNECT requests through the main request protocol chain. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.2.4. Contributed by Oleg Kalnichevski * SEE OTHER redirect handling fix. Contributed by Oleg Kalnichevski * HTTPCLIENT-2305: SSLConnectionSocketFactory allows Socket.connect() to be decorated (#499). Contributed by Carter Kozak * Add security warning to TrustStrategy implementations documentation (#490). Contributed by Marcono1234 * More consistent handling of OperationTimeoutException in MemcachedHttpCacheStorage. Contributed by Oleg Kalnichevski * Document exec chain behavior when automatic retries are enabled. (#480). Contributed by cachescrubber * HTTPCLIENT-2291: Fixed inconsistency in behavior between the class and async implementation of the request re-execution. The async request retry exec will now restart request execution from itself instead of from the very beginning of the execution chain. Contributed by Oleg Kalnichevski Release 5.3 ALPHA1 ------------------ This is the first release in the 5.3 release series that introduces support for the Bearer authentication scheme (RFC 6750) and deprecates NTLM and GSS-based experimental authentication schemes in favor of Basic / Bearer authentication with TLS. Change Log ------------------- * GSS-based experimental authentication schemes deprecated and disabled by default. Contributed by Oleg Kalnichevski * NTLM scheme deprecated and disabled by default. Contributed by Oleg Kalnichevski * Added linear and exponential BackoffManager implementations. Contributed by Arturo Bernal * Improved AIMDBackoffManager. Contributed by Arturo Bernal * Added DistributedProxySelector with support for load distribution across multiple proxies. Contributed by Arturo Bernal * Support for preamble and epilogue in multipart entities. Contributed by Arturo Bernal * HttpResponseException to include response message content (up to 256 bytes). Contributed by Arturo Bernal * Workaround for URL quoting issue with LLv6 host literals. Contributed by Arturo Bernal * Bearer auth scheme support (RFC 6750) Contributed by Oleg Kalnichevski * Credentials interface should be able to represent different types of user credentials including token-based with no password. Contributed by Oleg Kalnichevski * Connection settings `timeToLive` and `validateAfterInactivity` set to zero to always close or validate connections being leased. Contributed by Christoph Kaser * Digest authentication scheme to omit the algorithm in the authentication response if it has not been explicitly set in the authentication challenge, as per RFC 7616. Contributed by John Vasileff * HTTPCLIENT-2271: Do not optimize the path component of the resolved URI by default. Contributed by Oleg Kalnichevski * Pass HttpContext to SSLConnectionSocketFactory#prepareSocket method (#404) Contributed by Alen Turkovic Release 5.2.1 ------------------ This is a maintenance release that fixes several regressions found in release 5.2. Change Log ------------------- * Regression: Async execution runtimes set the negotiated protocol version in the execution context at the wrong point of request execution. Contributed by Oleg Kalnichevski * Cancel connection request on exception. Contributed by Bryan Keller * Replace deprecated use of LangUtils#equals() with Objects.equals(). Contributed by Gary Gregory * Regression: Multipart body builder and multipart formatters fail to escape special characters such as backslash and quote mark. Contributed by Oleg Kalnichevski Release 5.2 ------------------ This is the first GA release in the 5.2 release series. This release finalizes the 5.2 APIs and corrects several defects discovered since the previous release. Please note that 5.2 upgrades the minimal JRE level to version 8 (8u251 is required). Please note this is likely to be the last release series with support for SPNEGO and NTLM authentication. As of version 5.3 GSS-API-based authentication schemes (Kerberos, SPNEGO) and NTLM authentication schemes are going to be deprecated and disabled by default. Notable changes and features included in the 5.2 series: * Upgrade to Java 8. * Improved support for TLS upgrade and HTTP protocol upgrade (async). * Support for H2 tunneling via HTTP/1.1 proxy. * Conformance to RFC 7617 (The 'Basic' HTTP Authentication Scheme). * Migration to Java 8 Time primitives in State Management and Cache APIs. * Connection and TLS configuration on a per-route basis. * Base64 codec based on Commons Codec replaced with JRE Base64 codec. Dependency on Commons Codec dropped. * Optional support for BR (Brotli) decompression. Change Log ------------------- * HTTPCLIENT-2242: RoutingSupport fails to copy InetAddress when normalizing HttpHost. Contributed by Oleg Kalnichevski * HTTPCLIENT-2240: Fixed incorrect CONNECT method initialization in ProxyClient. Contributed by Oleg Kalnichevski * HTTPCLIENT-2236: MultihomeIOSessionRequester fails to enhance the cause exception in case of connect failure if the remoteAddress argument has been given. Contributed by Oleg Kalnichevski * Use Objects.toString() instead of String type cast Contributed by Gary Gregory * HTTPCLIENT-2232: Last protocol interceptors moved at the end of the H2 protocol processing pipeline. Contributed by Oleg Kalnichevski * H2 async runtime to proactively set HTTP/2 protocol version in the execution context. Contributed by Oleg Kalnichevski * HTTPCLIENT-2231: Fixed a race condition in the main async executor when the request execution on an I/O thread is faster than execution pipeline management on the client thread. Contributed by Oleg Kalnichevski * Avoid duplicate redundant objects and use Singleton instead. Contributed by Arturo Bernal * HTTPCLIENT-2225: Connection route calculation does not take the default RequestConfig into account. Contributed by Oleg Kalnichevski * Avoid unnecessary use of Instant.toEpochMilli by using Instant#compareTo to compare Instants directly. Contributed by jkmcl * HTTPCLIENT-2221 Closing a classic response/entity allows connection reuse. Contributed by Carter Kozak Release 5.2 BETA1 ------------------ This is the first BETA release in the 5.2 release series that upgrades the minimal JRE level to version 8 (8u251 is required) and includes several protocol level and API improvements. It also includes all bug fixes from the 5.1 branch. Change Log ------------------- * Upgraded HttpCore to version 5.2-beta2. Contributed by Oleg Kalnichevski * HTTPCLIENT-2218: Use Java 8 Base64 utility (#370). Contributed by j3graham * Added support for BR (Brotli) decompression (#363). Contributed by 殷成涛 * HTTPCLIENT-2212: MinimalHttpAsyncClient fails to release client endpoints in case of a connect error (such as TLS handshake failure). Contributed by Oleg Kalnichevski * InternalAbstractHttpAsyncClient to create daemon threads. Contributed by Richard Hernandez * HTTPCLIENT-2080: Added #getRetryInterval method to HttpRequestRetryStrategy for use on retriable IOExceptions (#356). Contributed by Anthony Baldocchi <489445+ajbaldocchi at users.noreply.github.com> * Fixed infinite recursion in SSLConnectionSocketFactory. Contributed by Ryan Schmitt * HTTPCLIENT-2200: Protocol interceptors are executed before the connection route has been fully established. Contributed by Oleg Kalnichevski * HTTPCLIENT-2209: Pass HttpContext to AsyncClientConnectionOperator (#353). Contributed by Andriy Redko * HTTPCLIENT-2206: Corrected resource de-allocation by fluent response objects. Contributed by Oleg Kalnichevski * ExecSupport#getNextExchangeId() optimization (#352) Contributed by David Schlosnagle * HTTPCLIENT-2203: Corrected target host normalization by the request execution interceptors; added ContextBuilder with support for preemptive authentication initialization. Contributed by Oleg Kalnichevski * HTTPCLIENT-2202: MemcachedHttpCacheStorage to support MemcachedClientIF interface. Contributed by Oleg Kalnichevski * Bug fix: ByteArrayBuilder incorrectly handles empty strings. Contributed by Oleg Kalnichevski * HTTPCLIENT-2198: Fixed AbstractClientTlsStrategy to respect HttpVersionPolicy. Contributed by Andrei Vasilev <59628447+AndreiSVasilev at users.noreply.github.com> * Updated AbstractClientTlsStrategy to pass only the HttpVersionPolicy set by TlsConfig instead of the entire TlsConfig to H2TlsSupport#selectApplicationProtocols() method. Contributed by Andrei Vasilev <59628447+AndreiSVasilev at users.noreply.github.com> * HTTPCLIENT-2195, regression: Classic ConnectExec incorrectly discards the proxy response body even if the request cannot be executed and the response is final. Contributed by Oleg Kalnichevski * HTTPCLIENT-2194: Async retry request interceptor fails to correct include request body on retry (#343). Contributed by JasonMathison * Deprecated execute methods that return an open response object in favor of execute methods with a response handler and automatic resource deallocation. Contributed by Oleg Kalnichevski * HTTPCLIENT-2189: Cookie and Cache APIs to use Java time primitives. Contributed by Arturo Bernal * Apply English locale to all date header formatters. Contributed by Michael Osipov * HTTPCLIENT-2184: Fixed an issue in which connections were not returned to the pool when requests contained non-repeatable bodies AND responses were streamed. Contributed by Carter Kozak Release 5.2 ALPHA1 ------------------ This is the first ALPHA release in the 5.2 release series that upgrades minimal JRE level to version 1.8 (8u251 is required) and includes several protocol level and API improvements. It also includes all bug fixes from the 5.1 branch. Notable changes and features included in the 5.2 series: * Upgrade to Java 8. * Improved support for TLS upgrade and HTTP protocol upgrade (async). * Support for H2 tunneling via HTTP/1.1 proxy. * Conformance to RFC 7617 (The 'Basic' HTTP Authentication Scheme). Change Log ------------------- * Replaced SimpleDateFormat and Calendar with Java 8 Time APIs; removed thread-local from DateUtils. Contributed by Oleg Kalnichevski * Support for connection 'total time to live' setting on a per-route basis. Contributed by Oleg Kalnichevski * Configurable IOReactor IO session decorator configurable. Contributed by Arturo Bernal * HTTPCLIENT-2182: Access to SSLSession attributes via reflection is disallowed as of Java 16. Core TLS functions now use new Java 1.8 API introduced by 8u251 update. Contributed by Oleg Kalnichevski * HTTPCLIENT-2135: TLS configuration on a per-host basis. Contributed by Oleg Kalnichevski * RFC 7230: Treat presence of userinfo in authority component in request URI as an HTTP protocol violation. Contributed by Oleg Kalnichevski * AuthCache conformance to RFC 7617. Contributed by Oleg Kalnichevski * Added immutable CredentialsProvider implementations and a CredentialsProvider builder. Contributed by Oleg Kalnichevski * HTTPCLIENT-2045: BASIC auth scheme conformance to RFC 7617. Contributed by Oleg Kalnichevski * HTTPCLIENT-2120: support for H2 via HTTP/1.1 proxy. Contributed by Oleg Kalnichevski * Moved connection management-related settings from RequestConfig to new class ConnectionConfig. Contributed by Oleg Kalnichevski * HTTPCLIENT-2139: Cookie Header HttpOnly attribute. Contributed by Arturo Bernal Release 5.1.1 ----------- This release upgrades HttpCore to the latest 5.1 version and fixes a number of issues found since release 5.1. Change Log ------------------- * Don't initialize AtomicReference to its default value. Contributed by Gary Gregory * Corrected resolution of the target host in DefaultUserTokenHandler. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: automatically force HTTP/1.1 protocol policy when executing requests via a proxy tunnel. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: fixed incorrect route state tracking by the async connect executor when negotiating a tunnel via a proxy. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: keep successful tunnel connections alive regardless of `Connection: close`. Contributed by Oleg Kalnichevski * HTTPCLIENT-2173: async pooling connection manager to close half-open connection gracefully. Contributed by Oleg Kalnichevski * Don't retry a request for NoRouteToHostException. Contributed by Jaikiran Pai * HTTPCLIENT-2170: Classic protocol layer no longer releases the underlying connection back to the pool prematurely while the NTLM handshake is still ongoing. Contributed by Oleg Kalnichevski * Fixed connection lease request cancellation race in both classic and asyc pooling connection managers. Contributed by Oleg Kalnichevski Release 5.1 ----------- This is the first GA release in the 5.1 release series. Notable changes and features included in the 5.1 series: * Conditional conformance with RFC 3986 (Uniform Resource Identifier (URI): Generic Syntax). * Improved support for out of sequence response message handing by the the classic (blocking) HTTP transport. * Improved message builders. Please note that 5.1 is going to be the last release series compatible with Java 1.7. HttpClient will require Java 1.8 as of 5.2. Change Log ------------------- * HTTPCLIENT-2157: Response object generated by the classic caching backend is missing the original content encoding. Contributed by Oleg Kalnichevski * HTTPCLIENT-2152: Fixed handling of unexpected unchecked exception by the async request retry exec interceptor. Contributed by Oleg Kalnichevski * Async clients to support scheduled (delayed) re-execution of requests. Contributed by Oleg Kalnichevski * HTTPCLIENT-2148: fluent Executor volatile access thread safety (#301). Contributed by Carter Kozak * HTTPCLIENT-2149: When no dNSName, match against CN. Contributed by Peter Dettman * HTTPCLIENT-2147: fixed broken preemptive auth in HC Fluent. Contributed by Robert Rodewald * HTTPCORE-672: cleanup of H2 connection validation code. Contributed by Oleg Kalnichevski * HttpAsyncClientBuilder: Make IOReactor exception callback configurable Contributed by Ryan Schmitt * HTTPCLIENT-2141: HttpClient to not retry requests if the retry interval exceeds the response timeout. Contributed by Oleg Kalnichevski * Fixed NPE during dispose in Response if entity is null Contributed by Sandeep Kulkarni * Blocking connection managers to validate connections after inactivity of more than 2s by default. Contributed by Oleg Kalnichevski * Deprecated request factory classes in favor of request builders. Contributed by Oleg Kalnichevski * HTTPCLIENT-2140: Upgraded Commons Codec to version 1.15. Contributed by Oleg Kalnichevski * Deprecated message copiers in favor of generic message builders. Contributed by Oleg Kalnichevski * Kerberos/SPNego fixes Contributed by Carey Lin Release 5.1 BETA1 ------------------ This is the first BETA release in the 5.1 release series that includes a number of new features as well performance optimizations in the classic HTTP transport. Notable changes and features included in the 5.1 series: * Conditional conformance with RFC 3986 (Uniform Resource Identifier (URI): Generic Syntax). * Improved support for out of sequence response message handing by the the classic (blocking) HTTP transport. Changelog: ------------------- * RFC 3986 conformance: URIUtils to re-use URIBuilder functionality. Contributed by Oleg Kalnichevski * Improved I/O session and wire logging. Contributed by Oleg Kalnichevski * Add interceptors before MAIN_TRANSPORT so they won't be ignored (#272) Contributed by Rob Spoor * HTTPCLIENT-2104: ManagedHttpClientConnectionFactory to support ResponseOutOfOrderStrategy configuration. Contributed by Carter Kozak * Fixed NPE when H2/Async client interceptors are added using first/last (#268). Contributed by Koji Lin * HTTPCLIENT-2126: `InternalAbstractHttpAsyncClient` incorrectly handles response messages with no enclosed entity. Contributed by Oleg Kalnichevski * HTTPCLIENT-2124: Fixed NOE in MinimalHttpClient#doExecute (#261). Contributed by Gary Gregory * HTTPCLIENT-2122: async client to throw `HTTP/2 tunneling not supported` protocol exception in case of `force HTTP/2` version policy used along with request proxy routing. Contributed by Oleg Kalnichevski * HTTPCLIENT-2123: H2AsyncClientBuilder incorrectly adds last request interceptors to the head of the interceptor list. Contributed by Oleg Kalnichevski * Use decimal numbers for endpoint/execution IDs (#249). Contributed by Michael Osipov * HTTPCLIENT-2106: Added charset parameter for DigestScheme. Contributed by Oleg Kalnichevski * HTTPCLIENT-2103: ManagedHttpClientConnectionFactory provides a fluent builder Contributed by Carter Kozak Release 5.0.3 ----------------- This release upgrades HttpCore to the latest version, improves conformance to RFC 7235 (Hypertext Transfer Protocol (HTTP/1.1): Authentication) and addresses a number of issues found since 5.0.2 release. Changelog: ------------------- * PR #270: Master try w res and more. - Use try-with-resources. - Use Arrays.fill(). - Add missing @override. - Simplify if/else. - Remove redundant modifiers. … - Remove redundant returns. Contributed by Gary Gregory Release 5.0.2 ----------------- This release upgrades HttpCore to the latest version, improves conformance to RFC 7235 (Hypertext Transfer Protocol (HTTP/1.1): Authentication) and addresses a number of issues found since 5.0.1 release. Changelog: ------------------- * HTTPCLIENT-2116: Incorrect request message composition when routing requests via a proxy. Contributed by Oleg Kalnichevski * PoolingAsyncClientConnectionManager incorrectly emits Ping commands to HTTP/1.1 endpoints (#255). Contributed by 滕杰1 * HTTPCLIENT-2115: HttpAsyncClientBuilder and H2AsyncClientBuilder fail to take `replaceExecInterceptor()` into account. Contributed by Oleg Kalnichevski * HTTPCLIENT-2112: AbstractMultipartFormat respects ByteBuffer.arrayOffset (#253). Contributed by Carter Kozak * Avoid updating Content-Length header in a 304 response. Contributed by Dirk Henselin * HTTPCLIENT-2105: Async clients incorrectly handle redirects of requests with enclosed entity. Contributed by Oleg Kalnichevski * HTTPCLIENT-2100: Incorrect handling of EXTENDED mode by MultipartEntityBuilder Contributed by Oleg Kalnichevski * HTTPCLIENT-2099, HTTPCLIENT-2091: SSLConnectionSocketFactory connect timeout fix (#241). Contributed by Carter Kozak * Bug fix: BasicExpiresHandler is annotated as immutable but is not (#240). Contributed by Gary Gregory * HTTPCLIENT-2096: Migrate instance loggers to static fields Contributed by Carter Kozak * Added Automatic-Module-Name to the artefact manifests. Contributed by Niels Basjes * MultipartEntityBuilder#generateBoundary optimization (#233) Contributed by slisaasquatch * HTTPCLIENT-2094: ConnectionManager validateAfterInactivity zero duration agreement Contributed by Carter Kozak * RFC 7235 compliance, HTTPCLIENT-2086: Fixed parsing of token68 based (base64-encoded) auth schemes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2091: Connect timeout is used instead of socket timeout after a tls upgrade Contributed by Oleg Kalnichevski * HTTPCLIENT-2084: Client builders incorrectly add message interceptors with LAST position to the head of the list. Contributed by Oleg Kalnichevski * HTTPCLIENT-2083: Fix NPE when classic client interceptors are added. Contributed by Carter Kozak Release 5.0.1 ----------------- This release upgrades HttpCore to the latest version and addresses a number of issues found since 5.0 release. Changelog: ------------------- * Bug fix: Classic connection managers fail to take #isConsistent() flag into account when re-using persistent connections. 7 Contributed by Oleg Kalnichevski * HTTPCLIENT-2077: Authentication failure due to incorrect NTLM auth value check. Contributed by vonahok <64310078+vonahok at users.noreply.github.com> * HTTPCLIENT-2051: Corrected handling of 303 redirects. Contributed by Oleg Kalnichevski * HTTPASYNC-160: HttpAsyncClient in INACTIVE or STOPPED state throws a IllegalStateException causing the current thread to terminate. Contributed by Oleg Kalnichevski * HTTPCLIENT-2076: Fixed NPE in LaxExpiresHandler. Contributed by heejeongkim * HTTPCLIENT-2074: Disallow direct execution of CONNECT methods by standard client implementations. Contributed by Oleg Kalnichevski * HTTPCLIENT-2075: New method Request.responseTimeout(Timeout) in Fluent HC. Contributed by Ralph * HTTPCLIENT-2073: (regression) WindowsNegotiateScheme incorrectly rejects empty NTLM challenge. Contributed by Oleg Kalnichevski * HTTPCLIENT-2069: RequestConfig#copy does not copy #responseTimeout. Contributed by Oleg Kalnichevski * HTTPCLIENT-2061: Corrected sequence of request execution interceptors in classic HttpClient. Contributed by Oleg Kalnichevski * Fixed NPE for null HttpContext in minimal async clients. Contributed by slisaasquatch Release 5.0 ----------------- This is the first stable (GA) release of HttpClient 5.0. Notable changes and features included in the 5.0 series are: * Support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * New connection pool implementation with lax connection limit guarantees and better performance under higher concurrency due to absence of a global pool lock. * Support for Reactive Streams API [http://www.reactive-streams.org/] * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Changelog: ------------------- * Removed work-around for resumed TLS sessions given that JDK-8212885 fix has been ported to Java 11 and released in Oracle JDK 11.0.3. Contributed by Oleg Kalnichevski * Upgraded HttpCore dependency to version 5.0 Contributed by Oleg Kalnichevski * DefaultHttpRequestRetryStrategy: Allow zero retry interval Contributed by Ryan Schmitt * HTTPCLIENT-2047: fixed regression in DefaultHostnameVerifier causing rejection of certs with non-standard domains. Contributed by Oleg Kalnichevski * GitHub #204: Build requests from method names in ClassicHttpRequests: ClassicHttpRequests.create(String, String) ClassicHttpRequests.create(String, URI) Contributed by Gary Gregory * GitHub #205: Update request factory classes with matching APIs for Method and String method name inputs: BasicHttpRequests.create(String, URI) BasicHttpRequests.create(String, String) ClassicHttpRequests.create(Method, String) ClassicHttpRequests.create(Method, URI) SimpleHttpRequests.create(String, URI) SimpleHttpRequests.create(String, String) Contributed by Gary Gregory * GitHub #208: Do not use input type names in method names: SimpleHttpRequest: Delete setBodyBytes(byte[], ContentType) in favor of setBody(byte[], ContentType) SimpleHttpRequest: Delete setBodyText(String, ContentType) in favor of setBody(String, ContentType) SimpleHttpResponse: Delete setBodyBytes(byte[], ContentType) in favor of setBody(byte[], ContentType) SimpleHttpResponse: Delete setBodyText(String, ContentType) in favor of setBody(String, ContentType) Contributed by Gary Gregory Release 5.0-BETA7 ----------------- This BETA release upgrades HttpCore to the latest version and addresses a number of issues found since the previous BETA release. IMPORTANT: This release is expected to be the last BETA version. If no major design flaws are found the actual 5.0 API will be frozen and the next version will be promoted to GA. Changelog: ------------------- * Improved domain name normalization by DefaultHostnameVerifier. Contributed by Oleg Kalnichevski * DefaultHostnameVerifier: Match DNS and CN names against ICANN domains. Contributed by Ryan Schmitt * HTTPCORE-615: Implement HTTP-based cache serializer-deserializer. Contributed by Scott Gifford * HTTPCLIENT-2040: Copy headers from the original request to the redirect request. Contributed by Oleg Kalnichevski * Removed RFC 2965 specific requirements deprecated and superseded by RFC 6265. Contributed by Oleg Kalnichevski * HTTPCLIENT-2035: Remove HttpRequestRetryHandler in favor of HttpRequestRetryStrategy. Contributed by Michael Osipov * HTTPCLIENT-2019: Remove ServiceUnavailableRetryStrategy in favor of HttpRequestRetryStrategy. Contributed by Michael Osipov * HTTPCLIENT-2034: Introduce HttpRequestRetryStrategy. Contributed by Michael Osipov * CloseableHttpAsyncClient to support explicit HttpHost execution parameter. Contributed by Oleg Kalnichevski * HTTPCLIENT-2020: DefaultBackoffStrategy to support TOO_MANY_REQUESTS (429). Contributed by Michael Osipov * HTTPCLIENT-2030: Fixed PublicSuffixMatcher#getDomainRoot behavior with invalid hostnames. Contributed by Niels Basjes * HTTPCLIENT-2028: Connection managers to allow 0 for `validateAfterInactivity` time value. Contributed by Peter Frank * HTTPCLIENT-2023: Allow nested arrays and all primitive types in DefaultHttpCacheEntrySerializer. Contributed by Olof Larsson Release 5.0-BETA6 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. Changelog: ------------------- * Fixed fallback PublicSuffixMatcher. Contributed by Ryan Schmitt * Enforce h2 TLS rules after negotiating TLS, not before. Contributed by Ryan Schmitt * HTTPCLIENT-2013: Revised handling of connect exceptions; improved consistency in behavior of the classic and async clients; ConnectTimeoutException now extends SocketTimeoutException. Contributed by Oleg Kalnichevski * Improved handling of request cancellation (classic API). Contributed by Oleg Kalnichevski * Fixed concurrent use of threading unsafe ClassicHttpRequest messages. Contributed by Oleg Kalnichevski * Execute Socket#connect under doPrivileged. Contributed by Simon Willnauer * HTTPCLIENT-2009: Fixed StringIndexOutOfBoundsException in AuthSupport#extractFromAuthority. Contributed by itonyli <429284840 at qq.com> * Make Accept-Encoding header handling thread-safe. Contributed by Linton Miller Release 5.0-BETA5 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. IMPORTANT: This release is expected to be the last BETA version. If no major design flaws are found the actual 5.0 API will be frozen and the next version will be promoted to GA. Changelog: ------------------- * Information response (1xx) processing support. Contributed by Kirill Usov * HTTPCLIENT-1968: Preserve escaped PATHSAFE characters when normalizing URI path segments. Contributed by Oleg Kalnichevski * HTTPCLIENT-1992: Impossible to access trailer-headers available in chunked transfer-encoding with classic API. Contributed by Serkan Turgut * HTTPCLIENT-1991: incorrect handling of non-standard DNS entries by PublicSuffixMatcher. Contributed by Oleg Kalnichevski * Refactor to enable support for non-form based multipart requests Contributed by Adam Retter * HTTPCLIENT-1981: disallow TRACE requests with an enclosed entity Contributed by Jay Modi Release 5.0-BETA4 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. Notable features in this release: * Security improvements. * URI handling improvements. Changelog: ------------------- * HTTPCLIENT-1976: Unsafe deserialization in DefaultHttpCacheEntrySerializer. Contributed by Artem Smotrakov * HTTPCLIENT-1969: Filter out weak cipher suites. Contributed by Artem Smotrakov * HttpClient should not retry requests in case of ConnectionClosedException Contributed by Oleg Kalnichevski * Bug fix: Simple response consumer to discard stored content when releasing resources. Contributed by Oleg Kalnichevski * Bug fix: main async request execution handlers to release the associated response consumer upon exception. Contributed by Oleg Kalnichevski * Update Apache Commons Codec from 1.11 to 1.12. Contributed by Gary Gregory * Update RxJava from 2.2.2 to 2.2.7. Contributed by Gary Gregory * Update JNA from 5.0.0 to 5.2.0. Contributed by Gary Gregory * Some well known proxies respond with Content-Length=0, when returning 304. For robustness, always use the cached entity's content length, as modern browsers do. Contributed by Jayson Raymond * HTTPCLIENT-1960: URIBuilder incorrect handling of multiple leading slashes in path component. Contributed by Oleg Kalnichevski * HTTPCLIENT-1958: PoolingHttpClientConnectionManager to throw ExecutionException in case of a lease operation cancellation instead of InterruptedException. Contributed by Oleg Kalnichevski * Shutdown executorService on AbstractHttpAsyncClientBase shutdown. Contributed by 吴雪山 * [HTTPCLIENT-1952: Allow default User Agent to be disabled Contributed by Michael Osipov * Improve HttpResponseException#getMessage. Contributed by Michael Osipov * Better handling of http(s).proxyUser and http(s).proxyPassword Contributed by Jens Borgland * Wrong argument name in PoolingAsyncClientConnectionManagerBuilder#setConnPoolPolicy results with self assignment of variable. Contributed by Eryk Szymanski Release 5.0-BETA3 ------------------- This BETA release adds support for advanced TLS functions (such as ALPN protocol negotiation) on Java 1.7 and Java 1.8 through Conscrypt TLS library and picks up the latest fixes and performance improvements from HttpCore. Notable features in this release: * TLS ALPN protocol negotiation support on older JREs through Conscrypt TLS library. Changelog: ------------------- * Added optional dependency on conscrypt-openjdk-uber 1.4.1; support for advanced TLS functions (such as ALPN extension) on Java 1.7 and Java 1.8 through Conscrypt TLS library Contributed by Oleg Kalnichevski * Removed OSGi module Contributed by Oleg Kalnichevski * Removed experimental CredSsp auth scheme Contributed by Oleg Kalnichevski * HTTPCLIENT-1949: DigestScheme to use HttpRequest#getRequestUri instead of HttpRequest#getPath Contributed by Oleg Kalnichevski Release 5.0-BETA2 ------------------- This BETA release resolves compatibility issues with Java 11 new TLS engine as well as a number of defects found since the previous release. Notable new features in this release: * JDK 11 compatibility * Support for request specific push consumers * Support for Reactive Streams API [http://www.reactive-streams.org/] Changelog: ------------------- * Hack to make hostname verification work with TLSv1.3 resumed sessions. For details see https://markmail.org/message/mxf5v2d2gh6ws2j3 Contributed by Oleg Kalnichevski * Added builders for SSLConnectionSocketFactory and client TlsStrategy. Contributed by Oleg Kalnichevski * Added enum for supported TLS versions & TLS version parser. Contributed by Oleg Kalnichevski * HTTPCLIENT-1946: handling of 308 status as per RFC 7538. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.0-beta5. Contributed by Oleg Kalnichevski * Async clients to support request specific push consumers. Contributed by Oleg Kalnichevski * HTTPCLIENT-1944: Add hardCancellationEnabled option to RequestConfig. Contributed by Ryan Schmitt * Overload Request's execute method to allow custom CloseableHttpClient. Contributed by Nicolas Gomez * Fix HttpClient 4.5.4 regression in BasicCookieStore serialization. Contributed by Mark Mielke * HTTPCLIENT-1934: Default client TLS strategy passes wrong hostname to the hostname verifier. Contributed by Oleg Kalnichevski * HTTPCLIENT-1882: reset authentication state on I/O or runtime error for connection based authentication schemes (such as NTLM). Contributed by Oleg Kalnichevski * HTTPCLIENT-1924: HttpClient to shut down the connection manager if a fatal error occurs in the course of a request execution. Contributed by Oleg Kalnichevski * Pooling connection managers to implement graceful and immediate shut down. Contributed by Oleg Kalnichevski * HTTPCLIENT-1906: certificates containing alternative subject names other than DNS and IP (such as RFC822) get rejected as invalid. Contributed by Oleg Kalnichevski * HTTPCLIENT-1904: check cookie domain for null Contributed by Hans-Peter Keck * HTTPCLIENT-1900: proxy protocol processor in the CONNECT exec interceptor does not post-process CONNECT response messages. Contributed by Oleg Kalnichevski * HTTPCLIENT-1898: Incorrect comment in example class ClientMultiThreadedExecution.java Contributed by Ulrich Romahn * HTTPCLIENT-1931: Add factory enum org.apache.hc.client5.http.classic.methods.ClassicHttpRequests Contributed by Gary Gregory * HTTPCLIENT-1932: Add factory enum org.apache.hc.client5.http.async.methods.HttpRequests Contributed by Gary Gregory * HTTPCLIENT-1939: Update Apache Commons Codec from 1.10 to 1.11 Contributed by Gary Gregory * HTTPCLIENT-1947: Update JNA from 4.5.2 to 5.0.0 Contributed by Gary Gregory Release 5.0-BETA1 ------------------- This is the first BETA release of HttpClient 5.0. The 5.0 release serices introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. Changelog: ------------------- * DefaultHostnameVerifier to use a custom distinguished name (DN) parser instead of LdapName. Removed dependency on Java Naming extensions. Contributed by Oleg Kalnichevski * HTTP/2 client implementations to support cancellation of ongoing message exchanges without terminating the underlying connections. Contributed by Oleg Kalnichevski * HTTPCLIENT-1395: added config parameter to skip an extra cache entry freshness check upon cache update in case of a cache miss. Contributed by Oleg Kalnichevski * HTTPCLIENT-1824, HTTPCLIENT-1384: asynchronous HTTP cache invalidator. Contributed by Oleg Kalnichevski * Redesign of CacheKeyGenerator and HttpCacheInvalidator APIs. Contributed by Oleg Kalnichevski * New APIs for cache entry bulk retrieval; bulk retrieval support by Memcached storage implementation. Contributed by Oleg Kalnichevski * HTTPCLIENT-1824, HTTPCLIENT-1868: Asynchronous HTTP cache storage API. Memcached backend implementation of async HTTP cache storage. Contributed by Oleg Kalnichevski * HTTPCLIENT-1885: Content compression exec interceptor generates incorrect 'Accept-Encoding' header value. Contributed by Oleg Kalnichevski Release 5.0-ALPHA3 ------------------- This is a major release that introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. HttpClient ships with two client implementations: * HttpClient Classic is based on the classic (blocking) I/O model; largely compatible with the 4.x APIs; supports HTTP/1.1 only. * HttpClient Async is based on NIO model; new event driven APIs consistent for all supported HTTP protocol versions; supports both HTTP/1.1 and HTTP/2. Notable new features in this release: * Asynchronous HttpClient implementations optimized for HTTP/2 multiplexed request execution. * Full support for HTTP caching by asynchronous HttpClient implementations including streaming message exchanages. Notable changes and features included in the 5.0 series are: * Support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) on Java 9.0.1+ ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * Redesigned connection pool implementation with reduced pool lock contention. * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. * Apache Log4j2 logging APIs used for internal logging instead of Commons Logging APIs. HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Please note that as of 5.0, HttpClient requires Java 1.7 or newer. Changelog: ------------------- * HttpAsyncClient implementations optimized for HTTP/2 multiplexed request execution. Contributed by Oleg Kalnichevski * Improved Ehcache and Memcached storage backends. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1827] Full support for HTTP caching by asynchronous HTTP clients. Contributed by Oleg Kalnichevski * Redesign of HTTP cache resource APIs. Contributed by Oleg Kalnichevski * Deprecated Content-Transfer-Encoding field in MIME body parts per RFC 7578, section 4.7. Contributed by Oleg Kalnichevski * [HTTPCLIENT-293] Implemented the percent encoding of the filename parameter of the Content-Disposition header. Contributed by Ioannis Sermetziadis * [HTTPCLIENT-1845]: Extract InputStreamFactory classes out of GzipDecompressingEntity and DeflateDecompressingEntity for reuse and to create less garbage. Contributed by Gary Gregory * [HTTPCLIENT-1858] Alleviate GC pressure due to wire logging. Contributed by Gary Gregory * Avoid fetching the cached entity twice on cache hit. Contributed by Leandro Nunes * [HTTPASYNC-124] Add doPrivileged blocks to async client and connection manager builders Contributed by Jay Modi Release 5.0-ALPHA2 ------------------- This is a major release that introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. HttpClient ships with two client implementations: * HttpClient Classic is based on the classic (blocking) I/O model; largely compatible with the 4.x APIs; supports HTTP/1.1 only. * HttpClient Async is based on NIO model; new event driven APIs consistent for all supported HTTP protocol versions; supports both HTTP/1.1 and HTTP/2. Notable changes and features included in the 5.0 series are: * Partial support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) on Java 1.9+ ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * Redesigned connection pool implementation with reduced pool lock contention. * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. * Apache Log4j2 logging APIs used for internal logging instead of Commons Logging APIs. Features that are presently NOT supported: * HTTP/2 transport (classic) * HTTP tunneling (async) * Automatic response content decompression (async) * Caching (async) HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Please note that as of 5.0, HttpClient requires Java 1.7 or newer. Please note that at this point 5.0 APIs are considered experimental and unstable and are expected to change in the coming releases without providing a migration path. Changelog: ------------------- * [HTTPCLIENT-1714] Add HttpClientBuilder.setDnsResolver(DnsResolver). Contributed by Alexis Thaveau * [HTTPCLIENT-1715] NTLMEngineImpl.Type1Message not thread safe but declared as a constant. Contributed by Olivier Lafontaine , Gary Gregory * [HTTPCLIENT-1716] redirect handling of unsafe methods defined by RFC 7231. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1717] Make fluent API .Content.Content(byte[], ContentType) public. Contributed by Cash Costello * [HTTPCLIENT-1730] added #setValidateAfterInactivity to HttpClientBuilder. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1752] Allow to configure the OSGI clients with relaxed SSL checks. Contributed by Simone Tripodi * [HTTPCLIENT-1748] Improved compatibility with system authentication API in applets. Contributed by Sebastien Caille * [HTTPCLIENT-1786] Port from Apache Commons Logging to Apache Log4j 2. Contributed by Gary Gregory * [HTTPCLIENT-1817] Add a "Trust All" TrustStrategy implementation. Contributed by Gary Gregory * [HTTPCLIENT-1836] DefaultHostnameVerifier#getSubjectAltNames(X509Certificate) throws java.lang.ClassCastException. Contributed by Gary Gregory , Ilian Iliev * [HTTPCLIENT-1691] HttpClient instance used internally by HC Fluent to take system properties into account by default. Contributed by Oleg Kalnichevski Release 5.0-ALPHA1 ------------------- This major release renders HttpClient API incompatible with the stable 4.x branch and upgrades HTTP/1.1 protocol conformance to the requirements and recommendations of the latest protocol specification. This release lays the foundation for transition to HTTP/2 as the primary transport protocol in the future releases. Notable changes and features included in the 5.0 series are: * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification (RFC 7230, RFC 7231, RFC 7235) * Package name space changed to 'org.apache.hc.client5' * Maven group id changed to 'org.apache.httpcomponents.client5' * By default the maximum connections per route limit is set to 5 * By default connection request timeout and connect timeout are set to 3 minutes. HttpClient 5.0 releases can be co-located with earlier versions, meaning you can have both 5.x and 4.x on the classpath without experiencing jar hell. Please note that as of 5.0 HttpClient requires Java 1.7 or newer. Please note that at this point we consider 5.0 APIs experimental and unstable and expect them to change in the coming releases without providing a migration path. Changelog: ------------------- * [HTTPCLIENT-1575] route target port must be non negative Contributed by Oleg Kalnichevski * [HTTPCLIENT-1106] Use character arrays for passwords in Credentials objects Contributed by Oleg Kalnichevski * RFC 7235: redesign of HTTP authenticator and related classes Contributed by Oleg Kalnichevski * RFC 7231: parse capable of parsing multiple auth challenges Contributed by Oleg Kalnichevski * RFC 7231: DefaultServiceUnavailableRetryStrategy to take Retry-After header value into account if specified Contributed by Oleg Kalnichevski * RFC 7231: removed restriction on the use of relative URIs in Location header Contributed by Oleg Kalnichevski * RFC 7231: revised redirect handling Contributed by Oleg Kalnichevski * RFC 7231: do not generate header fields in TRACE requests containing sensitive data such as cookie and user credentials Contributed by Oleg Kalnichevski * RFC 7231: automatic retrial of idempotent methods Contributed by Oleg Kalnichevski * RFC 7230: increased the default max number of concurrent connection for the same route from 2 to 5 Contributed by Oleg Kalnichevski * Cache request line in HttpRequestWrapper Contributed by Dmitry Potapov * [HTTPCLIENT-1651] Add ability to disable content compression on a request basis Contributed by Oleg Kalnichevski * [HTTPCLIENT-1696]: Add convenience methods to fluent API class Request. Contributed by Gary Gregory Release 4.5.1 ------------------- HttpClient 4.5.1 (GA) is a maintenance release that fixes a number of minor defects found since 4.5. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * [HTTPCLIENT-1680] redirect of a POST request causes ClientProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1673] org.apache.http.entity.mime.content.* missing from OSGi exports. Contributed by Benson Margulies * [HTTPCLIENT-1668] Fluent request incorrectly handles connect timeout setting. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1667] RequestBuilder does not take charset into account when creating UrlEncodedFormEntity. Contributed by Sergey Smith * [HTTPCLIENT-1655] HttpClient sends RST instead of FIN ACK sequence when using non-persistant connections. Contributed by Oleg Kalnichevski Release 4.5 ------------------- HttpClient 4.5 (GA) is a minor feature release that includes several incremental enhancements to the exisitng functionality such as support for private domains in the Mozilla Public Suffix List. Changelog: ------------------- * Reduced default validate after inactivity setting from 5 sec to 2 sec. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1649] Fixed serialization of auth schemes. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1645]: Fluent requests to inherit config parameters of the executor. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1640]: RFC6265 lax cookie policy fails to parse 'max-age' attribute. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1633]: RFC6265CookieSpecProvider compatibility level setting has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1613]: Support for private domains in Mozilla Public Suffix List. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1651]: Add ability to disable content compression on a request basis. Contributed by Michael Osipov * [HTTPCLIENT-1654]: Deprecate/remove RequestConfig#decompressionEnabled in favor of #contentCompressionEnabled. Contributed by Michael Osipov Release 4.4.1 ------------------- HttpClient 4.4.1 (GA) is a maintenance release that fixes a number of defects in new functionality introduced in version 4.4. Users of HttpClient 4.4 are encouraged to upgrade. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * Marked RFC 2109, RFC 2965, Netscape draft cookie specs as obsolete. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1633] RFC6265CookieSpecProvider compatibility level setting has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1628]: Auth cache can fail when domain name contains uppercase characters. Contributed by Dennis Ju * [HTTPCLIENT-1609] Stale connection check in PoolingHttpClientConnectionManager has no effect. Internal connection pool does not correctly implement connection validation. Contributed by Charles Lip Release 4.4 Final ------------------- This is the first stable (GA) release of HttpClient 4.4. Notable features and enhancements included in 4.4 series are: * Support for the latest HTTP state management specification (RFC 6265). Please note that the old cookie policy is still used by default for compatibility reasons. RFC 6265 compliant cookie policies need to be explicitly configured by the user. Please also note that as of next feature release support for Netscape draft, RFC 2109 and RFC 2965 cookie policies will be deprecated and disabled by default. It is recommended to use RFC 6265 compliant policies for new applications unless compatibility with RFC 2109 and RFC 2965 is required and to migrate existing applications to the default cookie policy. * Enhanced, redesigned and rewritten default SSL hostname verifier with improved RFC 2818 compliance. * Default SSL hostname verifier and default cookie policy now validate certificate identity and cookie domain of origin against the public suffix list maintained by Mozilla.org * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed.) * Authentication cache thread-safety: authentication cache used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests. * Native Windows Negotiate and NTLM via SSPI through JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user credentials. This functionality is still considered experimental, known to have compatibility issues and subject to change without prior notice. Use at your discretion. This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * Support for the latest HTTP state management specification (RFC 6265). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1515] Caching of responses to HEAD requests Contributed by Tyrone Cutajar and Francois-Xavier Bonnet * [HTTPCLIENT-1560] Native Windows auth improvements. Contributed by Michael Osipov * Update Apache Commons Logging version from 1.1.3 to 1.2. Contributed by Gary Gregory * Update Apache Commons Codec version from 1.6 to 1.9. Contributed by Gary Gregory * Update Ehcache version from 2.2.0 to 2.6.9. Contributed by Gary Gregory * Update Ehcache version from 2.2.0 to 2.6.9. Contributed by Gary Gregory * Update Spymemcached version from 2.6 to 2.11.4. Contributed by Gary Gregory * Update SLF4J version from 1.5.11 to 1.7.7. Contributed by Gary Gregory Release 4.4 BETA1 ------------------- This is the first BETA release of HttpClient 4.4. Notable features and enhancements included in 4.4 series are: * Enhanced redesigned and rewritten default SSL hostname verifier with improved RFC 2818 compliance * Default SSL hostname verifier and default cookie policy now validate certificate identity and cookie domain of origin against the public suffix list maintained by Mozilla.org * Native windows Negotiate/NTLM via JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user system credentials * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed) * Authentication cache thread-safety: authentication caches used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * [HTTPCLIENT-1547] HttpClient OSGi bundle doesn't import the package "javax.naming". Contributed by Willem Jiang * [HTTPCLIENT-1541] Use correct (HTTP/hostname) service principal name for Windows native Negotiate/NTLM auth schemes. Contributed by Ka-Lok Fung * Improved compliance with RFC 2818: default hostname verifier to ignore the common name of the certificate subject if alternative subject names (dNSName or iPAddress) are present. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1540] Support delegated credentials (ISC_REQ_DELEGATE) by Native windows native Negotiate/NTLM auth schemes. Contributed by Ka-Lok Fung Release 4.4 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.4. Notable features and enhancements included in the 4.4 branch are: * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed) * Native windows Negotiate/NTLM via JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user system credentials * Authentication cache thread-safety: authentication caches used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Please note that new features included in this release are still considered experimental and their API may change in the future 4.4 alpha and beta releases. Changelog: ------------------- * [HTTPCLIENT-1493] Indiscriminate connection checking has been deprecated in favor of conditional connection state validation. Persistent connections are to be re-validated only after a defined period inactivity prior to being leased to the consumer. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1519] Use the original HttpHost instance passed as a parameter to HttpClient#execute when generating 'Host' request header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1491] Enable provision of Service Principal Name in Windows native auth scheme. Contributed by Malcolm Smith * [HTTPCLIENT-1403] Pluggable content decoders. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1466] FileBodyPart#generateContentType() ignores custom ContentType values. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1461] fixed performance degradation in gzip encoded content processing introduced by HTTPCLIENT-1432. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1457] Incorrect handling of Windows (NT) credentials by SystemDefaultCredentialsProvider. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1456] Request retrial after status 503 causes ClientProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1454] Make connection operator APIs public. Contributed by Tamas Cservenak * Update JUnit to version 4.11 from 4.9 Contributed by Gary Gregory Release 4.3.6 ------------------- HttpClient 4.3.6 (GA) is a maintenance release that fixes several problems with HttpClient OSGi bundle as well as some other issues reported since release 4.3.5. Please note that as of this release HttpClient disables all versions of SSL (including SSLv3) in favor of the TLS protocol by default. Those users who wish to continue using SSLv3 need to explicitly enable support for it. Users of all HttpClient versions are advised to upgrade. Changelog: ------------------- * SSLv3 protocol is disabled by default Contributed by Oleg Kalnichevski * [HTTPCLIENT-1558] HttpCore classes included in the OSGi bundle by mistake Contributed by Oleg Kalnichevski * HTTPCLIENT-1544] Fixed NPE in ResponseProcessCookies when running with DEBUG priority Contributed by Oleg Kalnichevski * [HTTPCLIENT-1542] Caching HttpClient uses absolute URIs for validation Based on contribution by Joseph Walton * [HTTPCLIENT-1537] OSGi metadata contains invalid default proxy port value Contributed by Oleg Kalnichevski * [HTTPCLIENT-1547, HTTPCLIENT-1563] HttpClient OSGi bundle doesn't import packages "javax.naming", "javax.naming.ldap" and "javax.naming.directory". Contributed by Willem Jiang Release 4.3.5 ------------------- HttpClient 4.3.5 (GA) is a bug fix release that addresses several of issues reported since release 4.3.4. Users of all HttpClient versions are advised to upgrade. Changelog: ------------------- * Improved SSL cert subject parsing * [HTTPCLIENT-1524] RFC 2617 auth schemes (basic and digest) cannot handle auth parameters with mixed or upper case Release 4.3.4 ------------------- HttpClient 4.3.4 (GA) is a maintenance release that improves performance in high concurrency scenarios. This version replaces dynamic proxies with custom proxy classes and eliminates thread contention in java.reflect.Proxy.newInstance() when leasing connections from the connection pool and processing response messages. Changelog: ------------------- * Replaced dynamic proxies with custom proxy classes to reduce thread contention. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1484] GzipCompressingEntity should not close the underlying output stream if the entity has not been fully written out due to an exception. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1474] Fixed broken entity enclosing requests in HC Fluent. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1470] CachingExec(ClientExecChain, HttpCache, CacheConfig, AsynchronousValidator) throws NPE if config is null Release 4.3.3 ------------------- HttpClient 4.3.3 (GA) is a bug fix release that fixes a regression introduced by the previous release causing a significant performance degradation in compressed content processing. Users of HttpClient 4.3 are encouraged to upgrade. Changelog: ------------------- * [HTTPCLIENT-1466] FileBodyPart#generateContentType() ignores custom ContentType values. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1453] Thread safety regression in PoolingHttpClientConnectionManager #closeExpiredConnections that can lead to ConcurrentModificationException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1461] fixed performance degradation in compressed content processing introduced by HTTPCLIENT-1432. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1457] Incorrect handling of Windows (NT) credentials by SystemDefaultCredentialsProvider. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1456] Request retrial after status 503 causes ClientProtocolException. Contributed by Oleg Kalnichevski Release 4.3.2 ------------------- HttpClient 4.3.2 (GA) is a maintenance release that delivers a number of improvements as well as bug fixes for issues reported since 4.3.1 release. SNI support for Oracle JRE 1.7+ is being among the most notable improvements. Users of HttpClient 4.3 are encouraged to upgrade. Changelog: ------------------- * [HTTPCLIENT-1447] Clients created with HttpClients.createMinimal do not work with absolute URIs Contributed by Joseph Walton * [HTTPCLIENT-1446] NTLM proxy + BASIC target auth fails with 'Unexpected state: MSG_TYPE3_GENERATED'. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1443] HttpCache uses the physical host instead of the virtual host as a cache key. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1442] Authentication header set by the user gets removed in case of proxy authentication (affects plan HTTP requests only). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1441] Caching AsynchronousValidationRequest leaks connections. Contributed by Dominic Tootell * [HTTPCLIENT-1440] 'file' scheme in redirect location URI causes NPE. Contributed by James Leigh * [HTTPCLIENT-1437] Made Executor#execute thread safe. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1119] SNI support (Oracle Java 1.7+ only). Contributed by Bruno Harbulot * [HTTPCLIENT-1435] Fluent Executor ignores custom request properties. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1432] Lazy decompressing of HttpEntity#getContent() to avoid EOFException in case of an empty response with 'Content-Encoding: gzip' header. Contributed by Yihua Huang * [HTTPCLIENT-1431] (Regression) deprecated connection manager cannot be used with a custom LayeredSchemeSocketFactory. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1425] Fixed socket closed exception thrown by caching HttpClient when the origin server sends a long chunked response. Contributed by James Leigh * [HTTPCLIENT-1417] Fixed NPE in BrowserCompatSpec#formatCookies caused by version 1 cookies with null cookie value. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1416] Fixed NPE in CachingHttpClientBuilder#build(). Contributed by Oleg Kalnichevski Release 4.3.1 ------------------- HttpClient 4.3.1 (GA) is a bug fix release that addresses a number of issues reported since release 4.3. Users of HttpClient 4.3 are strongly encouraged to upgrade. Changelog ------------------- * [HTTPCLIENT-1410] Browser compatible hostname verifier no longer rejects *.co., *.gov., *.info., etc as invalid. Contributed by Oleg Kalnichevski * Ensure X509HostnameVerifier is never null. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1405] CONNECT HTTP/1.1 requests lack mandatory 'Host' header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1402] Cache default User-Agent value. Contributed by yuexiaojun * [HTTPCLIENT-1398] Fixed invalid OSGi metadata caused by corrupted Maven bundle plugin metadata. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1399] Fixed NPE in RequestBuilder. Contributed by Oleg Kalnichevski Release 4.3 Final ------------------- This is the first stable (GA) release of HttpClient 4.3. The most notable enhancements included in this release are: * Support for Java 7 try-with-resources for resource management (connection release.) * Added fluent Builder classes for HttpEntity, HttpRequest, HttpClient and SSLContext instances. * Deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects. * Reliance on object immutability instead of access synchronization for thread safety. Several old classes whose instances can be shared by multiple request exchanges have been replaced by immutable equivalents. * DefaultHttpClient, DecompressingHttpClient, CachingHttpClient and similar classes are deprecated in favor of builder classes that produce immutable HttpClient instances. * HttpClient builders now dynamically construct a request execution pipeline tailored specifically to the user configuration by physically excluding unnecessary protocol components. * There is now an option to construct a minimal HttpClient implementation that can only execute basic HTTP message exchanges without redirects, authentication, state management or proxy support. This feature might be of particular use in web crawler development. * There is now option to avoid strict URI syntax for request URIs by executing HTTP requests with an explicitly specified target host. HttpClient will no longer attempt to parse the request URI if it does not need to extract the target host from it. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1371] Weak ETag Validation is Useful On PUT With If-Match Contributed by James Leigh * [HTTPCLIENT-1394] Support for Native windows Negotiate/NTLM via JNA Contributed by Ryan McKinley * [HTTPCLIENT-1384] Expose CacheInvalidator interface. Contributed by Nicolas Richeton * [HTTPCLIENT-1385] Fixed path normalization in CacheKeyGenerator Contributed by James Leigh * [HTTPCLIENT-1370] Response to non-GET requests should never be cached with the default ResponseCachingPolicy Contributed by James Leigh * [HTTPCLIENT-1373] OPTIONS and TRACE should not invalidate cache Contributed by James Leigh * [HTTPCLIENT-1383] HttpClient enters an infinite loop during NTLM authentication if the opposite endpoint keeps responding with a type 2 NTLM response after type 3 MTLM message has already been sent by the client. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1372] Refactor HttpMultipart, and add RFC6532 mode, so that headers in post are no longer constrained to ASCII values. Contributed by Karl Wright * [HTTPCLIENT-1377] User principal for non-NTLM authentication is incorrectly generated when using user credentials are specified as NTCredentials Contributed by Gary Gregory Release 4.3 BETA2 ------------------- This is the second BETA release of HttpClient 4.3. The most notable features and improvements in the 4.3 branch are: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1366] org.apache.http.client.utils.URLEncodedUtils should parse the semicolon as a query parameter separator. Contributed by Gary Gregory * [HTTPCLIENT-1365] NPE when ManagedHttpClientConnectionFactory.create(ConnectionConfig) is called with null. Contributed by Gary Gregory * [HTTPCLIENT-1362] Better error messages for connect timed out and connection refused exceptions. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1360] separate out DeflateInputStream as an independent class, so it can be used by others. Contributed by Karl Wright * [HTTPCLIENT-1359] repeated requests using the same context fail if they redirect. Contributed by James Leigh * [HTTPCLIENT-1354] do not quote algorithm parameter in DIGEST auth response. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1351] Added utility method to resolve final location from original request, target host and a list of redirects. Contributed by James Leigh * [HTTPCLIENT-1344] Userinfo credentials in URI should not default to preemptive BASIC authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1345] Useinfo credentials ignored in redirect location header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1294] HttpClient to rewrite host name of the redirect location URI in order to avoid circular redirect exception due to host name case mismatch. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1264] Add support for multiple levels of browser compatibility to BrowserCompatSpec and BrowserCompatSpecFactory. Include constructor argument for IE medium-security compatibility. Contributed by Karl Wright (kwright at apache.org) * [HTTPCLIENT-1349] SSLSocketFactory incorrectly identifies key passed with keystore as the keystore password. Contributed by David Graff * [HTTPCLIENT-1346] Ensure propagation of SSL handshake exceptions. Contributed by Pasi Eronen * [HTTPCLIENT-1343] SSLSocketFactory optional parameters for supported SSL protocols and cipher suites. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1238] Contribute Bundle Activator And Central Proxy Configuration. Contributed by Simone Tripodi * [HTTPCLIENT-1299] (regression) cache incorrectly disposes of the underlying cache resource when storing variant entry. Contributed by James Leigh * [HTTPCLIENT-1342] Redirects with underscore character in the location hostname cause "java.lang.IllegalArgumentException: Host name may not be null". Contributed by Oleg Kalnichevski Release 4.3 BETA1 ------------------- This is the first BETA release of HttpClient 4.3. The 4.3 branch enhances HttpClient in several key areas and includes several notable features and improvements: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1317] InetAddressUtils should handle IPv6 Addresses with Embedded IPv4 Addresses Contributed Sebastian Bazley . * [HTTPCLIENT-1320] Leverage javax.net.ssl.SSLSocketFactory#getDefault() to initialize SSL context based on system defaults instead of using an internal custom routine. Contributed by Abe Backus and Oleg Kalnichevski * [HTTPCLIENT-1316] Certificate verification rejects IPv6 addresses which are not String-equal. Contributed Sebastian Bazley . * [HTTPCLIENT-1307] Future based asynchronous request execution. Contributed by Jilles van Gurp * [HTTPCLIENT-1313] Fixed IllegalStateException in deprecated ThreadSafeClientConnManager. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1298] Add AsynchronousValidator in HttpClientBuilder's list of closeable objects. Contributed by Martin Meinhold Release 4.3 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.3. The 4.3 branch enhances HttpClient in several key areas and includes several notable features and improvements: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. We are kindly asking all upstream projects to review API changes and help us improve the APIs by providing feedback and sharing ideas on dev@hc.apache.org. This release also includes all fixes from the stable 4.2.x release branch. Please note that new features included in this release are still considered experimental and their API may change in the future 4.3 alpha and beta releases. Changelog ------------------- * [HTTPCLIENT-1250] Allow query string to be ignored when determining cacheability for HTTP 1.0 responses. Contributed by Don Brown * [HTTPCLIENT-1261] Make SystemDefaultHttpClient honor http.agent system property. Contributed by Oleg Kalnichevski * [HTTPCLIENT-900] Don't enforce URI syntax for messages with an explicit target host. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1190] HttpClient cache does not support "Vary: Cookie" Contributed by Oleg Kalnichevski * [HTTPCLIENT-1259] Calling #abort() on requests executed with DecompressingHttpClient has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1253] URIBuilder setParameter() method could exceed the HTTP header size. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1216] Added method to force clean thread-local used by DateUtils. Contributed by Oleg Kalnichevski Release 4.2.3 ------------------- HttpClient 4.2.3 (GA) is a bug fix release that addresses a number of issues reported since release 4.2.2. This release also includes a thoroughly reworked NTLM authentication engine which should result in a better compatibility with the newest Microsoft products. Users of HttpClient 4.x are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1296] NPE gets thrown if you combine a default host with a virtual host that has a -1 value for the port. Contributed by Karl Wright * [HTTPCLIENT-1290] 304 cached response never reused with If-modified-since conditional requests. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1291] Absolute request URIs without an explicitly specified path are rewritten to have "/" path). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1286] Request URI rewriting is inconsistent - URI fragments are not removed from absolute request URIs. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1284] HttpClient incorrectly generates Host header when physical connection route differs from the host name specified in the request URI. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1293] Kerberos and SPNego auth schemes use incorrect authorization header name when authenticating with a proxy. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1283] NTLM needs to use Locale-independent form of toUpperCase(). Contributed by Karl Wright * [HTTPCLIENT-1279] Target host responding with status 407 (proxy authentication required) causes an NPE. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1281] GzipDecompressingEntity does not release InputStream when an IOException occurs while reading the Gzip header Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1277] Caching client sends a 304 to an unconditional request. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1278] Update NTLM documentation. Contributed by Karl Wright * SystemDefaultHttpClient misinterprets 'http.keepAlive' default value and disables connection persistence if the system property is not set. This causes connection based authentication schemes such as NTLM to fail. * [HTTPCLIENT-1276] cache update on a 304 response causes NPE. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1273] DecompressingHttpClient does not automatically consume response content in case of an i/o, HTTP or runtime exception thrown by the decompressing protocol interceptor leading to a potential connection leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1268] NTLM engine refactor fix, to correct a buffer overrun, and get NTLMv2 flags right. Contributed by Karl Wright * [HTTPCLIENT-1266] NTLM engine refactoring and compatibility improvements. Contributed by Karl Wright * [HTTPCLIENT-1263] BrowserCompatSpec: attribute values containing spaces or special characters should be enclosed with quotes marks for version 1 cookies. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1263] CachingHttpClient fails to release connections back to the connection manager for some type of HTTP response messages when used together with DecompressingHttpClient. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1258] Fixed NullPointerException in NTLMEngineImpl caused by null NT domain attribute. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1254] Redirect with underscore in hostname causes ProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1255] AbstractVerifier incorrectly parses certificate CN containing wildcard. Contributed by Oleg Kalnichevski Release 4.2.2 ------------------- HttpClient 4.2.2 (GA) is a bug fix release that addresses a number of issues reported since release 4.2.1. Users of HttpClient 4.2 are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1248] Default and lax redirect strategies should not convert requests redirected with 307 status to GET method. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1215] BasicAuthCache does not take default ports into consideration when looking up cached authentication details by HttpHost key. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1241] (regression) Preemptive BASIC authentication failure should be considered final and no further attempts to re-authenticate using the same credentials should be made. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1229] Fixed NPE in BasicClientConnectionManager that can be triggered by releasing connection after the connection manager has already been shut down. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1227] Date parsing in DateUtils made more efficient. Contributed by Patrick Linskey * [HTTPCLIENT-1224] (regression) NTLM auth not retried after a redirect over a non-persistent connection. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1223] Cache could be more aggressive on cache invalidations from Content-Location. Contributed by Jon Moore . Contributed by Jon Moore * [HTTPCLIENT-1217] AutoRetryHttpClient does not release connection used by the previous response when request is retried Contributed by Oleg Kalnichevski Release 4.2.1 ------------------- HttpClient 4.2.1 (GA) is a bug fix release that addresses a number of issues reported since release 4.2. Users of HttpClient 4.2 are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1209] Redirect URIs are now normalized. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1202] ResponseCachingPolicy should honor explicit cache-control directives for other status codes Contributed by Jon Moore * [HTTPCLIENT-1199] DecompressingHttpClient strips content from entity enclosing requests Contributed by Oleg Kalnichevski * [HTTPCLIENT-1198] HttpHost is not set in HttpContext in CachingHttpClient. Contributed by Jon Moore * [HTTPCLIENT-1200] DecompressingHttpClient fails to generate correct HttpHost context attribute. Contributed by Guillaume Castagnino * [HTTPCLIENT-1192] URIBuilder encodes query parameters twice. Contributed by Oleg Kalnichevski and Sebastian Bazley . * [HTTPCLIENT-1196] Fixed NPE in UrlEncodedFormEntity constructor thrown if charset is null. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1193] Fixed regression in the route tracking logic of the default connection manager causing cross-site redirect failures. Contributed by Oleg Kalnichevski Release 4.2 ------------------- This is the first stable (GA) release of HttpClient 4.2. The most notable enhancements included in this release are: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Changelog ------------------- * [HTTPCLIENT-1187] If a revalidation response is deemed too old CachingHttpClient fails to consume its content resulting in a connection leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1186] State of newly created connections in the connection pool is not always correctly updated potentially allowing those connections to be leased to users with a different security context. Contributed by Ralf Poehlmann * [HTTPCLIENT-1179] Upgraded Commons Codec dependency to version 1.6 Contributed by Oleg Kalnichevski * [HTTPCLIENT-1177] always remove fragments from request URIs Contributed by Oleg Kalnichevski Incompatible changes -------------------- [Compared to release version 4.1.3] The following fields have been deprecated for some time now and have been deleted: org.apache.http.client.params.ClientPNames#CONNECTION_MANAGER_FACTORY org.apache.http.impl.cookie.BrowserCompatSpec#DATE_PATTERNS The following methods have been deprecated for some time now and have been deleted: org.apache.http.client.params.ClientParamBean#setConnectionManagerFactory(org.apache.http.conn.ClientConnectionManagerFactory) org.apache.http.client.protocol.ClientContextConfigurer#setAuthSchemePref(java.util.List) org.apache.http.entity.mime.content.FileBody#writeTo(java.io.OutputStream, int) org.apache.http.entity.mime.content.InputStreamBody#writeTo(java.io.OutputStream, int) org.apache.http.entity.mime.content.StringBody#writeTo(java.io.OutputStream, int) The following classes have been deprecated for some while now and have been deleted: org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.AbstractConnPool no longer implements interface org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.ConnPoolByRoute no longer implements interface org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.RefQueueWorker Release 4.2 BETA1 ------------------- This is the first BETA release of HttpClient 4.2. This release completes development of several notable enhancements in HttpClient: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. As of release 4.2 HttpClient will be using pooling connection manager per default. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Changelog ------------------- * [HTTPCLIENT-1164] Compressed entities are not being cached properly. Contributed by Jon Moore . * [HTTPCLIENT-1154] MemcachedHttpCacheStorage should allow client to specify custom prefix string for keys. Contributed by Jon Moore . * [HTTPCLIENT-1153] MemcachedHttpCacheStorage uses URL as cache key; shouldn't due to fixed maximum-length memcached keys. Contributed by Jon Moore . * [HTTPCLIENT-1157] MemcachedHttpCacheStroage should throw IOExceptions instead of RuntimeExceptions. Contributed by James Miller . * [HTTPCLIENT-1152] MemcachedHttpCacheStorage should verify class of returned object before casting. Contributed by Rajika Kumarasiri . * [HTTPCLIENT-1155] CachingHttpClient fails to ensure that the response content gets fully consumed when using a ResponseHandler, which can potentially lead to connection leaks. Contributed by James Miller * [HTTPCLIENT-1147] When HttpClient-Cache cannot open cache file, should act like miss. Contributed by Joe Campbell * [HTTPCLIENT-1137] Values for the Via header are cached and reused by httpclient-cache. Contributed by Alin Vasile * [HTTPCLIENT-1142] Infinite loop on NTLM authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1143] CachingHttpClient leaks connections with stale-if-error. Contributed by James Miller Release 4.2 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.2. The 4.2 branch enhances HttpClient in several key areas and includes several notable features and improvements: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. As of release 4.2 HttpClient will be using pooling connection manager per default. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Please note that new features included in this release are still considered experimental and their API may change in the future ALPHA releases. Changelog ------------------- * [HTTPCLIENT-1128] SystemDefaultHttpClient (HttpClient implementation initialized using system properties). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1135] RandomAccessFile mode 'w' used by HttpClientCache is not valid. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1131] HttpClient to authenticate preemptively using BASIC scheme if a userinfo attribute is specified in the request URI. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1134] make BasicResponseHandler consume response content in case of an unsuccessful result (status code >= 300). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1132] ProxyClient implementation. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1127] fixed dead-lock between SingleClientConnManager and AbstractPooledConnAdapter. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1107] Auth framework redesign. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1116] ResponseCachingPolicy uses integers for sizes Contributed by Greg Bowyer * [HTTPCLIENT-1123] Support for pluggable DNS resolvers. Contributed by Alin Vasile * [HTTPCLIENT-1120] DefaultHttpRequestRetryHandler#retryRequest should not retry aborted requests. Contributed by Alin Vasile * Support for auth-int qop (quality of protection) option in Digest auth scheme. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1076] Fluent facade API (Google summer of code 2011 project). Contributed by Xu Lilu * UriBuilder implementation. Contributed by Xu Lilu * Redesign of connection management classes based on new pooling components from HttpCore. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1111] Added #prepareSocket method to SSLSocketFactory. Contributed by Pasi Eronen * Added #reset() and #releaseConnection() methods to HttpRequestBase. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1105] AutoRetryHttpClient: built-in way to do auto-retry for certain status codes. Contributed by Dan Checkoway * [HTTPCLIENT-1094] Digest auth scheme refactoring. Contributed by Oleg Kalnichevski * Lax implementation of RedirectStrategy. Contributed by Bartosz Firyn * [HTTPCLIENT-1044] HttpRequestRetryHandler implementation compliant with the definition of idempotent methods given in the RFC 2616. Contributed by Oleg Kalnichevski Release 4.1.2 ------------------- The HttpClient 4.1.2 is a bug fix release that addresses a number of non-critical issues reported since release 4.1.1. * [HTTPCLIENT-1100] Missing Content-Length header makes cached entry invalid Contributed by Bart Robeyns * [HTTPCLIENT-1098] Avoid expensive reverse DNS lookup on connect timeout exception. Contributed by Thomas Boettcher * [HTTPCLIENT-1097] BrowserCompatHostnameVerifier and StrictHostnameVerifier should handle wildcards in SSL certificates better. Contributed by Sebastian Bazley * [HTTPCLIENT-1092] If ClientPNames.VIRTUAL_HOST does not provide the port, derive it from the current request. Contributed by Sebastian Bazley * [HTTPCLIENT-1087] NTLM proxy authentication fails on retry if the underlying connection is closed as a result of a target authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1079] Fixed Kerberos cross-realm support Contributed by Michael Osipov <1983-01-06 at gmx.net> * [HTTPCLIENT-1078] Decompressing entities (DeflateDecompressingEntity, GzipDecompressingEntity) do not close content stream in #writeTo() method. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1075] Decompressing entities (DeflateDecompressingEntity, GzipDecompressingEntity) do not correctly handle content streaming. Contributed by James Abley * [HTTPCLIENT-1051] Avoid reverse DNS lookups when opening SSL connections by IP address. Contributed by Oleg Kalnichevski Release 4.1.1 ------------------- HttpClient v4.1.1 is a bug fix release that addresses a number of issues reported since release 4.1, including one critical security issue (HTTPCLIENT-1061). All users of HttpClient 4.0.x and 4.1 are strongly encouraged to upgrade. * [HTTPCLIENT-1069] HttpHostConnectException not correctly retried for direct and non-tunnelled proxy connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1066] Changed the way URIUtils#rewriteURI handles multiple consecutive slashes in the URI path component: multiple leading slashes will be replaced by one slash in order to avoid confusion with the authority component. The remaining content of the path will not be modified. (also see HTTPCLIENT-929). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1061] Fixed critical bug causing Proxy-Authorization header to be sent to the target host when tunneling requests through a proxy server that requires authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1056] Fixed bug causing the RequestAuthCache protocol interceptor to generate an invalid AuthScope instance when looking up user credentials for preemptive authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1053] Fixed the way DigestScheme generates nonce-count values. Contributed by Oleg Kalnichevski Release 4.1 ------------------- The HttpClient 4.1 release builds upon the stable foundation laid by HttpClient 4.0 and adds several functional improvements and popular features. * Response caching conditionally compliant with HTTP/1.1 specification (full compliance with MUST requirements, partial compliance with SHOULD requirements) * Full support for NTLMv1, NTLMv2, and NTLM2 Session authentication. The NTLM protocol code was kindly contributed by the Lucene Connector Framework project. * Support for SPNEGO/Kerberos authentication. * Persistence of authentication data between request executions within the same execution context. * Support for preemptive authentication for BASIC and DIGEST schemes. * Support for transparent content encoding. Please note transparent content encoding is not enabled per default in order to avoid conflicts with already existing custom content encoding solutions. * Mechanism to bypass the standard certificate trust verification (useful when dealing with self-signed certificates). * Simplified configuration for connection managers. * Transparent support for host multihoming. IMPORTANT: please note that the HttpClient 3.x branch is now officially END OF LIFE and is no longer maintained and supported by the Apache HttpComponents project. Changelog ------------------- * The public API for the caching module had a minor change between 4.1-beta and 4.1-GA to the HttpCacheEntry class - the deprecated public Set getVariantURIs() method and constructor public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource, Set variants) were both removed. This will not affect you unless you are implementing new storage backends that use the deprecated code and/or are implementing custom serializers for cache entries. * Changed Browser-Compatibility and Best-Match cookie policies to emulate the behaviour of FireFox more closely when parsing Netscape style cookies. Comma will no longer be treated as a header element separator if Set-Cookie does not contain a Version attribute mandated by the RFC2109 / RFC 2965 cookie specifications. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1036] StringBody has incorrect default for characterset. (Default changed to US-ASCII) Contributed by Sebastian Bazley * [HTTPCLIENT-975] Support stale-if-error and stale-while-revalidate extension directive (RFC5861). Contributed by Mohammed Azeem Uddin , Michajlo Matijkiw , and Matthew Hawthorne . * [HTTPCLIENT-1033] HttpRoute.equals(Object o) is quite inefficient, as it does not take full advantage of shortcut logic. Contributed by Sebastian Bazley * [HTTPCLIENT-1030] Implement "ignoreCookies" CookieSpec Contributed by Sebastian Bazley Release 4.1 BETA1 ------------------- HttpClient 4.1 BETA1 finalizes the 4.1 API and brings a number of major improvements to the HTTP caching module. This release also adds full support for NTLMv1, NTLMv2, and NTLM2 Session authentication. The NTLM protocol code was kindly contributed by the Lucene Connector Framework project. Changelog ------------------- * [HTTPCLIENT-1015] Support only-if-cached directive. Contributed by Michajlo Matijkiw * [HTTPCLIENT-990] Allow heuristic freshness caching. Contributed by Michajlo Matijkiw * [HTTPCLIENT-919] Support for NTLMv1, NTLMv2, and NTLM2 Session authentication. Contributed by Karl Wright * [HTTPCLIENT-1008] Send all variants' ETags on "variant miss". Contributed by Michajlo Matijkiw and Mohammed Azeem Uddin * [HTTPCLIENT-1011] Handling of IOExceptions thrown by cache components. Contributed by Jonathan Moore * [HTTPCLIENT-1003] Handle conditional requests in cache. Contributed by Michajlo Matijkiw and Mohammed Azeem Uddin * [HTTPCLIENT-1002] Stale connection check fails if wire logging is on. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1000] Maximum connection lifetimes settings for ThreadSafeClientConnManager. Contributed by Michajlo Matijkiw * [HTTPCLIENT-960] HttpMultipart doesn't generate Content-Type header for binary parts in BROWSER_COMPATIBLE mode. Contributed by Oleg Kalnichevski * [HTTPCLIENT-998] Cache should use both Last-Modified and ETag for validations when available. Contributed by Jonathan Moore * [HTTPCLIENT-997] Cache module should handle out-of-order validations properly and unconditionally refresh. Contributed by Jonathan Moore * [HTTPCLIENT-994] Cache does not allow client to override origin-specified freshness using max-stale. Contributed by Jonathan Moore * [HTTPCLIENT-995] Cache returns cached responses even if validators not consistent with all conditional headers. Contributed by Jonathan Moore * [HTTPCLIENT-977] Memcached implementation for HttpCache. Contributed by Mohammed Azeem Uddin * [HTTPCLIENT-992] cache should not generate stale responses to requests explicitly requesting first-hand or fresh ones. Contributed by Jonathan Moore * [HTTPCLIENT-991] cache module produces improperly formatted Warning header when revalidation fails. Contributed by Jonathan Moore * [HTTPCLIENT-989] DefaultHttpRequestRetryHandler no longer retries non-idempotent http methods if NoHttpResponseException is thrown. Contributed by Oleg Kalnichevski * [HTTPCLIENT-988] Cache module should strip 'Content-Encoding: identity' from responses Contributed by Jonathan Moore * [HTTPCLIENT-987] cache module does not recognize equivalent URIs. Contributed by Jonathan Moore * [HTTPCLIENT-986] cache module does not completely handle upstream Warning headers correctly Contributed by Jonathan Moore * [HTTPCLIENT-985] cache module should populate Via header to capture upstream and downstream protocols Contributed by Jonathan Moore * [HTTPCLIENT-984] Additional conditional compliance tests for the caching module for Content-Encoding, Content-Location, Date, Expires, Server, Transfer-Encoding, and Vary headers. Contributed by Jonathan Moore * [HTTPCLIENT-978] HTTP cache update exception handling Contributed by Michajlo Matijkiw * [HTTPCLIENT-981] CachingHttpClient returns a 411 respones when executing a POST (HttpPost) request. Contributed by Joe Campbell * [HTTPCLIENT-980] CachingHttpClient returns a 503 response when the backend HttpClient produces an IOException. Contributed by Jonathan Moore * [HTTPCLIENT-978] Ehcache based HTTP cache implementation Contributed by Michajlo Matijkiw * [HTTPCLIENT-967] support for non-shared (private) caches Contributed by Jonathan Moore * [HTTPCLIENT-969] BasicCookieStore#getCookies() to return a copy of Cookie list Contributed by David Smiley * [HTTPCLIENT-965] Fixed problem with cache not honoring must-revalidate or proxy-revalidate Cache-Control directives. Contributed by Jonathan Moore * [HTTPCLIENT-964] 'no-cache' directives with field names are no longer transmitted downstream. Contributed by Jonathan Moore * [HTTPCLIENT-963] Fixed handling of 'Cache-Control: no-store' on requests. Contributed by Jonathan Moore * [HTTPCLIENT-962] Fixed handling of Authorization headers in shared cache mode. Contributed by Jonathan Moore * [HTTPCLIENT-961] Not all applicable URIs are invalidated on PUT/POST/DELETEs that pass through client cache. Contributed by Jonathan Moore * [HTTPCLIENT-958] Client cache no longer allows incomplete responses to be passed on to the client. Contributed by Jonathan Moore * [HTTPCLIENT-951] Non-repeatable entity enclosing requests are not correctly retried when 'expect-continue' handshake is active. Contributed by Oleg Kalnichevski * [HTTPCLIENT-948] In rare circumstances the idle connection handling code can leave closed connections in a inconsistent state. Contributed by Oleg Kalnichevski * [HTTPCLIENT-953] IllegalStateException thrown by RouteSpecificPool. Contributed by Guillaume * [HTTPCLIENT-952] Trust store parameter is ignored by SSLSocketFactory (affects version 4.1-alpha2 only) Contributed by Oleg Kalnichevski * [HTTPCLIENT-937] CacheEntry made immutable; now uses immutable HttpEntity to store cached content. Contributed by David Mays and Oleg Kalnichevski Release 4.1 ALPHA2 ------------------- HttpClient 4.1 ALPHA2 fixes a number of non-severe bugs discovered since the last release and introduces support for two frequently requested features: * HTTP/1.1 response caching * transparent support for host multihoming * a mechanism to bypass the standard certificate trust verification (useful when dealing with self-signed certificates) Compatibility notes ------------------- (1) Please note the HTTP caching module is still considered experimental and its API may change significantly in the future releases. (2) This release eliminates Mime4J as a dependency for the HttpMime module. HttpMime is no longer binary compatible with the previous releases. Full API and binary compatibility between minor versions of HttpMime will be maintained as of 4.1 GA release. Changelog ------------------- * [HTTPCLIENT-936] Fixed bug causing NPE or an infinite loop in the authentication code in case of a SPNEGO authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-427] HTTP caching support Contributed by Joe Campbell, David Cleaver, David Mays, Jon Moore, Brad Spenla * Dropped dependency on Mime4j for HttpMime. Contributed by Oleg Kalnichevski * Extended SSLSocketFactory with a mechanism to bypass the standard certificate trust verification (primarily to simplify dealing with self-signed certificates) Contributed by Oleg Kalnichevski * [HTTPCLIENT-898] Improved support for host multihoming Contributed by Oleg Kalnichevski * [HTTPCLIENT-916] UsernamePasswordCredentials, NTUserPrincipal, BasicClientCookie, BasicClientCookie2 and BasicCookieStore made Serializable. Contributed by Oleg Kalnichevski * [HTTPCLIENT-914] Upgraded Commons Codec dependency to version 1.4 Contributed by Oleg Kalnichevski * [HTTPCLIENT-903] Use ConcurrentHashMap instead of [Linked]HashMap for thread-safety. Improve performance of AuthSchemeRegistry, CookieSpecRegistry and SchemeRegistry classes. Contributed by Sebastian Bazley * [HTTPCLIENT-902] HttpRequestRetryHandler not called on I/O exceptions thrown when opening a new connection. Contributed by Olivier Lamy and Oleg Kalnichevski Release 4.1 ALPHA1 ------------------- HttpClient 4.1 ALPHA1 builds on the stable 4.0 release and adds several functionality improvements and new features. * Simplified configuration of connection managers. * Persistence of authentication data between request executions within the same execution context. * Support for SPNEGO/Kerberos authentication scheme * Support for transparent content encoding. Please note transparent content encoding is not enabled per default in order to avoid conflicts with already existing custom content encoding solutions. * 5 to 10% performance increase due to elimination of unnecessary Log object lookups by short-lived components. Please note all methods and classes added in this release and marked as 4.1 are API unstable and can change in the future 4.1 ALPHA releases. Changelog ------------------- * [HTTPCLIENT-889] 'expect: continue' handshake disabled per default. Contributed by Oleg Kalnichevski * [HTTPCLIENT-862] Extended client's redirect handling interface to allow control of the content of the redirect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-872] HttpClient can now persist authentication data between request executions as long as they share the same execution context. It has also become much easier to make HttpClient authenticate preemptively by pre-populating authentication data cache. Contributed by Oleg Kalnichevski * [HTTPCLIENT-883] SO_TIMEOUT is not reset on persistent (re-used) connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-832] Distinguish cookie format errors from violations of restrictions imposed by a cookie specification. In the latter case CookieRestrictionViolationException will be thrown. Contributed by Oleg Kalnichevski * [HTTPCLIENT-523] Support for SPNEGO authentication scheme. Contributed by Matthew Stevenson * Simplified configuration of connection managers. Total connection maximum and maximum connection per route limits can be set using methods of the class instead of HTTP parameters. Contributed by Oleg Kalnichevski * Added parameters to define the order of preference for supported auth schemes for target host and proxy authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-875] DefaultClientConnectionOperator#openConnection doesn't update the connection state if the connection socket changed after the call to SocketFactory#connectSocket(). Contributed by Oleg Kalnichevski * [HTTPCLIENT-834] Transparent content encoding support. Contributed by James Abley Release 4.0.1 ------------------- This is a bug fix release that addresses a number of issues discovered since the previous stable release. None of the fixed bugs is considered critical. Most notably this release eliminates eliminates dependency on JCIP annotations. This release is also expected to improve performance by 5 to 10% due to elimination of unnecessary Log object lookups by short-lived components. Changelog ------------------- * [HTTPCLIENT-895] Eliminated Log lookups in short lived objects impairing performance. Contributed by Oleg Kalnichevski * [HTTPCLIENT-885] URLEncodedUtils now correctly parses form-url-encoded entities that specify a charset. Contributed by Oleg Kalnichevski * [HTTPCLIENT-884] UrlEncodedFormEntity now sets charset on the Content-Type header. Contributed by Jared Jacobs * [HTTPCLIENT-883] SO_TIMEOUT is not reset on persistent (re-used) connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-882] Auth state is now correctly updated if a successful NTLM authentication results in a redirect. This is a minor bug as HttpClient manages to recover from the problem automatically. Contributed by Oleg Kalnichevski * [HTTPCLIENT-881] Fixed race condition in AbstractClientConnAdapter that makes it possible for an aborted connection to be returned to the pool. Contributed by Tim Boemker and Oleg Kalnichevski * [HTTPCLIENT-866] Removed dependency on jcip-annotations.jar. Contributed by Oleg Kalnichevski and Sebastian Bazley Release 4.0 ------------------- HttpClient 4.0 represents a complete, ground-up redesign and almost a complete rewrite of the HttpClient 3.x codeline. This release finally addresses several design flaws that existed since the 1.0 release and could not be fixed without a major code overhaul and breaking API compatibility. Architectural changes --------------------- * Redesign of the HttpClient internals addressing all known major architectural shortcomings of the 3.x codeline. * Cleaner, more flexible and expressive API. * More modular structure. * Better performance and smaller memory footprint due to a more efficient HTTP transport based on HttpCore. * Implementation of cross-cutting HTTP protocol aspects through protocol interceptors. * Improved connection management, better handling of persistent connections, support for stateful connections * Pluggable redirect and authentication handlers. * Improved support for sending requests via a proxy or a chain of proxies * More flexible SSL context customization * Reduced intermediate garbage in the process of generating HTTP requests and parsing HTTP responses Important notes ------------------- * Future releases of HttpMime module may be binary incompatible with this release due to possible API changes in Apache Mime4J. Apache Mime4J is still being actively developed and its API is considered unstable. * HttpClient 4.0 is not fully binary compatible with 4.0 BETA1 release. Some protected variables in connection management class have been made final in order to help ensure their thread safety: org.apache.http.conn.BasicEofSensorWatcher#attemptReuse org.apache.http.conn.BasicEofSensorWatcher#managedConn org.apache.http.impl.conn.DefaultClientConnectionOperator#schemeRegistry org.apache.http.impl.conn.DefaultHttpRoutePlanner#schemeRegistry org.apache.http.impl.conn.ProxySelectorRoutePlanner#schemeRegistry org.apache.http.impl.conn.SingleClientConnManager#alwaysShutDown org.apache.http.impl.conn.SingleClientConnManager#connOperator org.apache.http.impl.conn.SingleClientConnManager#schemeRegistry org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager#connOperator org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager#schemeRegistry Bug fixes since 4.0 BETA2 release ------------------- * [HTTPCLIENT-861] URIUtils#resolve is now compatible with all examples given in RFC 3986. Contributed by Johannes Koch * [HTTPCLIENT-860] HttpClient no longer converts redirects of PUT/POST to GET for status codes 301, 302, 307, as required by the HTTP spec. Contributed by Oleg Kalnichevski * [HTTPCLIENT-859] CookieIdentityComparator now takes path attribute into consideration when comparing cookies. Contributed by Oleg Kalnichevski * HttpClient will no longer send expired cookies back to the origin server. Contributed by Oleg Kalnichevski * [HTTPCLIENT-856] Proxy NTLM authentication no longer fails on a redirect to a different host. Contributed by Oleg Kalnichevski * [HTTPCLIENT-841] Removed automatic connection release using garbage collection due to a memory leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-853] Fixed bug causing invalid cookie origin port to be selected when the target is accessed on the default port and the connection is established via a proxy. Contributed by Oleg Kalnichevski * [HTTPCLIENT-852] Fixed bug causing automatically retried redirects fail with CircularRedirectException. Contributed by Oleg Kalnichevski * Fixed problem with the default HTTP response parser failing to handle garbage preceding a valid HTTP response. Contributed by Oleg Kalnichevski * NonRepeatableRequestExceptions now include the cause that the original request failed. Contributed by Sam Berlin * [HTTPCLIENT-837] Fixed problem with the wire log skipping zero byte values if read one byte at a time. Contributed by Kirill Safonov * [HTTPCLIENT-823] 'http.conn-manager.max-total' parameter can be adjusted dynamically. However, the size of existing connection pools per route, once allocated, will not be adjusted. Contributed by Oleg Kalnichevski * [HTTPCLIENT-822] Default socket factories to rethrow SocketTimeoutException as ConnectTimeoutException in case of connect failure due to a time out. Contributed by Oleg Kalnichevski * [HTTPCLIENT-813] Fixed default port resolution. Invalid ports no longer get replaced with the default port value. Contributed by Oleg Kalnichevski Release 4.0 beta 2 ------------------- BETA2 is a maintenance release, which addresses a number of issues discovered since the previous release. The only significant new feature is an addition of an OSGi compliant bundle combining HttpClient and HttpMime jars. All upstream projects are strongly encouraged to upgrade. * Fixed NPE in DefaultRequestDirector thrown when retrying a failed request over a proxied connection. Contributed by Oleg Kalnichevski * [HTTPCLIENT-803] Fixed bug in SSL host verifier implementations causing the SSL certificate to be rejected as invalid if the connection is established using an IP address. Contributed by Oleg Kalnichevski * [HTTPCLIENT-806] DefaultHttpMethodRetryHandler will no longer retry on ConnectExceptions. Contributed by Oleg Kalnichevski * DigestScheme can use an arbitrary digest algorithm requested by the target server (such as SHA) as long as this algorithm is supported by the Java runtime. Contributed by Oleg Kalnichevski * Fixed parsing and validation of RFC2109 compliant Set-Cookie headers by the Best-Match cookie spec. Contributed by Oleg Kalnichevski * Fixed bug that can cause a managed connection to be returned from the pool in an inconsistent state. Contributed by Oleg Kalnichevski 4.0 Beta 1 ------------------- BETA1 release brings yet another round of API enhancements and improvements in the area of connection management. Among the most notable ones is the capability to handle stateful connections such as persistent NTLM connections and private key authenticated SSL connections. This is the first API stable release of HttpClient 4.0. All further releases in the 4.0 code line will maintain API compatibility with this release. There has been a number of important bug fixes since ALPHA4. All upstream projects are encouraged to upgrade to the latest release. Please note HttpClient currently provides only limited support for NTLM authentication. For details please see NTLM_SUPPORT.txt. ------------------- Changelog: ------------------- * [HTTPCLIENT-790] Protocol interceptors are now correctly invoked when executing CONNECT methods. Contributed by Oleg Kalnichevski * [HTTPCLIENT-668] Do not use static loggers. Contributed by Oleg Kalnichevski * [HTTPCLIENT-781] Respect Keep-Alive header's timeout value. Contributed by Sam Berlin * [HTTPCLIENT-779] Top-level classes (HttpClient, and HttpGet, HttpPut and similar HttpMethods) throw fewer checked exceptions. Contributed by Sam Berlin * HttpClient will throw an exception if an attempt is made to retry a request with a non-repeatable request entity. Contributed by Oleg Kalnichevski * Fixed request re-generation logic when retrying a failed request. Auto-generated headers will no accumulate. Contributed by Oleg Kalnichevski * [HTTPCLIENT-424] Preemptive authentication no longer limited to BASIC scheme only. HttpClient can be customized to authenticate preemptively with DIGEST scheme. Contributed by Oleg Kalnichevski * [HTTPCLIENT-670] Pluggable hostname resolver. Contributed by Oleg Kalnichevski * [HTTPCLIENT-719] Clone support for HTTP request and cookie objects. Contributed by Oleg Kalnichevski * [HTTPCLIENT-776] Fixed concurrency issues with AbstractPoolEntry. Contributed by Sam Berlin * Resolved a long standing problem with HttpClient not taking into account the user context when pooling / re-using connections. HttpClient now correctly handles stateful / user specific connections such as persistent NTLM connections and SSL connections with client side authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-773] Improved handling of the 'expires' attribute by the 'Best Match' cookie spec. Contributed by Oleg Kalnichevski * Partial NTLM support (requires an external NTLM engine). For details see NTLM_SUPPORT.txt Contributed by Oleg Kalnichevski * Redesigned local execution context management. Contributed by Oleg Kalnichevski -------------------------------------- Release 4.0 Alpha 4 ------------------- ALPHA4 marks the completion of the overhaul of the connection management code in HttpClient. All known shortcomings of the old HttpClient 3.x connection management API have been addressed. NTLM authentication remains the only missing major feature in the new codeline that prevents us from moving awards the API freeze. There has been a number of important bug fixes since ALPHA3. All upstream projects are encouraged to upgrade to the latest release. ------------------- HttpClient 3.x features that have NOT yet been ported: ------------------- * NTLM authentication scheme ------------------- Changelog: ------------------- * [HTTPCLIENT-765] String.toLowerCase() / toUpperCase() should specify Locale.ENGLISH Contributed by Sebastian Bazley * [HTTPCLIENT-769] Do not pool connection marked non-reusable. Contributed by Oleg Kalnichevski * [HTTPCLIENT-763] Fixed problem with AbstractClientConnAdapter#abortConnection() not releasing the connection if called from the main execution thread while there is no blocking I/O operation. Contributed by Oleg Kalnichevski * [HTTPCLIENT-652] Added optional state attribute to managed client connections. This enables connection managers to correctly handle stateful connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-673] Revised max connections per route configuration Contributed by Oleg Kalnichevski * [HTTPCLIENT-753] Class Scheme and related classes moved to a separate package Contributed by Oleg Kalnichevski * [HTTPCLIENT-757] Improved request wrapping in the DefaultClientRequestDirector. This also fixed the problem with the default proxy set at the client level having no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-734] Request abort will unblock the thread waiting for a connection Contributed by Sam Berlin * [HTTPCLIENT-759] Ensure release of connections back to the connection manager on exceptions. Contributed by Sam Berlin * [HTTPCLIENT-758] Fixed the use of generics in AbstractHttpClient #removeRequestInterceptorByClass and #removeResponseInterceptorByClass Contributed by Johannes Koch * [HTTPCLIENT-749] HttpParams beans Contributed by Stojce Dimski * [HTTPCLIENT-755] Workaround for known bugs in java.net.URI.resolve() Bug ID: 4708535 Contributed by Johannes Koch -------------------------------------- Release 4.0 Alpha 3 ------------------- ALPHA3 release brings another round of API refinements and improvements in functionality. As of this release HttpClient requires Java 5 compatible runtime environment and takes full advantage of generics and new concurrency primitives. This release also introduces new default cookie policy that selects a cookie specification depending on the format of cookies sent by the target host. It is no longer necessary to know beforehand what kind of HTTP cookie support the target host provides. HttpClient is now able to pick up either a lenient or a strict cookie policy depending on the compliance level of the target host. Another notable improvement is a completely reworked support for multipart entities based on Apache mime4j library. ------------------- HttpClient 3.x features that have NOT yet been ported: ------------------- * NTLM authentication scheme ------------------- Changelog: ------------------- * [HTTPCLIENT-742] common interface for HttpRoute and RouteTracker Contributed by Roland Weber * [HTTPCLIENT-741] Fixed concurrency issues in AbstractClientConnAdapter. Contributed by Oleg Kalnichevski * [HTTPCLIENT-726] testcase for spurious wakeups in ThreadSafeClientConnManager Contributed by Roland Weber * [HTTPCLIENT-643] Automatic connect fail-over for multi-home remote servers. Contributed by Oleg Kalnichevski * [HTTPCLIENT-735] unsetting of DEFAULT_PROXY and FORCED_ROUTE in hierarchies Contributed by Roland Weber * [HTTPCLIENT-723] route planner based on java.net.ProxySelector Contributed by Roland Weber * [HTTPCLIENT-740] don't start connection GC thread in pool constructor Contributed by Roland Weber * [HTTPCLIENT-736] route planners use SchemeRegistry instead of ConnManager Contributed by Roland Weber * [HTTPCLIENT-730] Fixed rewriting of URIs containing escaped characters Contributed by Sam Berlin and Oleg Kalnichevski * [HTTPCLIENT-667] Added 'Meta' cookie policy that selects a cookie specification depending on the format of the cookie(s). Contributed by Oleg Kalnichevski * [HTTPCLIENT-729] Move HttpRoute and related classes to routing package. Contributed by Roland Weber * [HTTPCLIENT-725] Use TimeUnit arguments for timeouts in connection manager. Contributed by Roland Weber * [HTTPCLIENT-677] Connection manager no longer uses Thread.interrupt(). Contributed by Roland Weber * [HTTPCLIENT-716] Allow application-defined routes. Contributed by Roland Weber * [HTTPCLIENT-712] Improve HttpRoute API Contributed by Roland Weber * [HTTPCLIENT-711] Bad route computed for redirected requests Contributed by Oleg Kalnichevski * [HTTPCLIENT-715] Remove RoutedRequest from API Contributed by Roland Weber * [HTTPCLIENT-705] Fixed incorrect handling of URIs with null path component. Contributed by Oleg Kalnichevski * [HTTPCLIENT-688] HttpOptions#getAllowedMethods can now handle multiple Allow headers. Contributed by Andrea Selva -------------------------------------- Release 4.0 Alpha 2 ------------------- ALPHA2 release is another milestone in the redesign of HttpClient. It includes a number of improvements since ALPHA1, among which are improved connection pooling, support for proxy chains, redesigned HTTP state and authentication credentials management API, improved RFC 2965 cookie specification. ------------------- HttpClient 3.x features that have NOT yet been ported ------------------- * NTLM authentication scheme * Support for multipart MIME coded entities ------------------- Changelog ------------------- * [HTTPCLIENT-698] Resolve non-absolute redirect URIs relative to the request URI Contributed by Johannes Koch * [HTTPCLIENT-697] Throw a more intelligible exception when connection to a remote host cannot be established. Contributed by Oleg Kalnichevski * [HTTPCLIENT-689] Caching of SimpleDateFormat in DateUtils Contributed by Daniel Müller * [HTTPCLIENT-689] stackable parameters in AbstractHttpClient Contributed by Roland Weber * [HTTPCLIENT-477] Use distinct instances of the authentication handler interface for authentication with target and proxy hosts Contributed by Oleg Kalnichevski * [HTTPCLIENT-690] ManagedClientConnection provides access to SSLSession Contributed by Roland Weber * [HTTPCLIENT-692] ClientConnectionManager throws InterruptedException Contributed by Roland Weber * [HTTPCORE-116] moved parameter names to interfaces Contributed by Roland Weber * [HTTPCLIENT-649] support for proxy chains in HttpConn Contributed by Roland Weber * [HTTPCLIENT-636] refactor ThreadSafeClientConnManager in separate package Contributed by Roland Weber * [HTTPCLIENT-669] new HttpRoutePlanner interface and implementation Contributed by Andrea Selva * [HTTPCLIENT-653] detached connection wrapper no longer prevents garbage collection of ThreadSafeClientConnManager Contributed by Roland Weber * [HTTPCLIENT-674] use org.apache.http.util.VersionInfo instead of a local one Contributed by Roland Weber * [HTTPCLIENT-666] Replaced HttpState with CredentialsProvier and CookieStore interfaces Contributed by Oleg Kalnichevski * [HTTPCORE-100] revised HttpContext hierarchy Contributed by Roland Weber * [HTTPCLIENT-618] eliminate class HostConfiguration Contributed by Roland Weber * [HTTPCLIENT-672] re-sync with API changes in core alpha6-SNAPSHOT Contributed by Roland Weber -------------------------------------- Release 4.0 Alpha 1 ------------------- HttpClient 4.0 represents a complete, ground-up redesign and almost a complete rewrite of the HttpClient 3.x codeline. This release finally addresses several design flaws that existed since the 1.0 release and could not be fixed without a major code overhaul and breaking API compatibility. The HttpClient 4.0 API is still very experimental and is bound to change during the course of the ALPHA development phase. Several important features have not yet been ported to the new API. Architectural changes --------------------- * Redesign of the HttpClient internals addressing all known major architectural shortcomings of the 3.x codeline * Cleaner, more flexible and expressive API * Better performance and smaller memory footprint due to a more efficient HTTP transport based on HttpCore. HttpClient 4.0 is expected to be 10% to 25% faster than HttpClient 3.x codeline * More modular structure * Pluggable redirect and authentication handlers * Support for protocol incerceptors * Improved connection management * Improved support for sending requests via a proxy or a chain of proxies * Improved handling redirects of entity enclosing requests * More flexible SSL context customization * Reduced intermediate garbage in the process of generating HTTP requests and parsing HTTP responses ------------------- HttpClient 3.x features that have NOT yet been ported ------------------- * NTLM authentication scheme * RFC2965 cookie policy (Cookie2) * Support for multipart MIME coded entities ------------------- Changelog ------------------- The following is a list of contributions tracked in JIRA. Note that this is not a complete list of contributions or changes. Since the API was redesigned completely, tracking everything outside of the source code repository would have been too burdensome. * [HTTPCLIENT-655] User-Agent string no longer violates RFC Contributed by Oleg Kalnichevski * [HTTPCLIENT-541] Virtual host API redesign Contributed by Oleg Kalnichevski * [HTTPCLIENT-614] Allow for different strategies when checking CN of x509 certificates Contributed by Julius Davies * [HTTPCLIENT-136] Fixed inadequate proxy support Long standing architectural problem. Issue opened on 19/Dec/2002. Contributed by Oleg Kalnichevski * [HTTPCLIENT-63] Support for pluggable redirect and authentication handlers Long standing architectural problem. Issue opened on 15/Jul/2002. Contributed by Oleg Kalnichevski * [HTTPCLIENT-245] Fixed redirect handling. HttpClient can now automatically handle redirects of entity enclosing requests. Long standing architectural problem. Issue opened on 14/Jul/2003. Contributed by Oleg Kalnichevski * [HTTPCLIENT-613] HTTPS connections now verify CN of x509 certificates Contributed by Julius Davies * [HTTPCLIENT-497] Wire/header logger names consistent with class loggers Contributed by Oleg Kalnichevski * [HTTPCLIENT-484] AuthSSLProtocolSocketFactory in the main distribution Contributed by Oleg Kalnichevski * [HTTPCLIENT-589] Do not consume the remaining response content if the connection is to be closed Contributed by Roland Weber * [HTTPCLIENT-475] Support for unconnected sockets. HTTP requests can now be aborted while network socket is still being connected. Contributed by Roland Weber SECURITY.md0100644 0000000 0000000 00000002126 00000250600 011355 0ustar000000000 0000000 # HttpComponents Security The HttpComponents Security process and model are on our website's [Security](https://hc.apache.org/security.html) page. If you believe you found a vulnerability in Apache HttpClient, please contact the [Apache Security Team](https://www.apache.org/security/). doap_HttpComponents_Client.rdf0100644 0000000 0000000 00000013264 00000250600 015554 0ustar000000000 0000000 2007-11-15 Apache HttpComponents Client Java library implementing an HTTP client based on HttpCore components. HttpClient is a library for client-side HTTP communication built on HttpCore. It provides connection management, cookie management, and authentication. This is the successor to the widely used Jakarta Commons HttpClient 3.1. Java Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing IETF RFC 7230 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content IETF RFC 7231 Hypertext Transfer Protocol (HTTP/1.1): Authentication IETF RFC 7235 Hypertext Transfer Protocol Version 2 (HTTP/2) IETF RFC 7540 HPACK: Header Compression for HTTP/2 IETF RFC 7541 Hypertext Transfer Protocol -- HTTP/1.0 IETF RFC 1945 Upgrading to TLS Within HTTP/1.1 IETF RFC 2817 HTTP Over TLS IETF RFC 2818 HTTP State Management Mechanism IETF RFC 6265 mvnw0100644 0000000 0000000 00000024653 00000250600 010507 0ustar000000000 0000000 #!/bin/sh # ---------------------------------------------------------------------------- # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ---------------------------------------------------------------------------- # ---------------------------------------------------------------------------- # Apache Maven Wrapper startup batch script, version 3.3.2 # # Optional ENV vars # ----------------- # JAVA_HOME - location of a JDK home dir, required when download maven via java source # MVNW_REPOURL - repo url base for downloading maven distribution # MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven # MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output # ---------------------------------------------------------------------------- set -euf [ "${MVNW_VERBOSE-}" != debug ] || set -x # OS specific support. native_path() { printf %s\\n "$1"; } case "$(uname)" in CYGWIN* | MINGW*) [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" native_path() { cygpath --path --windows "$1"; } ;; esac # set JAVACMD and JAVACCMD set_java_home() { # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched if [ -n "${JAVA_HOME-}" ]; then if [ -x "$JAVA_HOME/jre/sh/java" ]; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" JAVACCMD="$JAVA_HOME/jre/sh/javac" else JAVACMD="$JAVA_HOME/bin/java" JAVACCMD="$JAVA_HOME/bin/javac" if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 return 1 fi fi else JAVACMD="$( 'set' +e 'unset' -f command 2>/dev/null 'command' -v java )" || : JAVACCMD="$( 'set' +e 'unset' -f command 2>/dev/null 'command' -v javac )" || : if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 return 1 fi fi } # hash string like Java String::hashCode hash_string() { str="${1:-}" h=0 while [ -n "$str" ]; do char="${str%"${str#?}"}" h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) str="${str#?}" done printf %x\\n $h } verbose() { :; } [ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } die() { printf %s\\n "$1" >&2 exit 1 } trim() { # MWRAPPER-139: # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. # Needed for removing poorly interpreted newline sequences when running in more # exotic environments such as mingw bash on Windows. printf "%s" "${1}" | tr -d '[:space:]' } # parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties while IFS="=" read -r key value; do case "${key-}" in distributionUrl) distributionUrl=$(trim "${value-}") ;; distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; esac done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" [ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" case "${distributionUrl##*/}" in maven-mvnd-*bin.*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; :Linux*x86_64*) distributionPlatform=linux-amd64 ;; *) echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 distributionPlatform=linux-amd64 ;; esac distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" ;; maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; *) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; esac # apply MVNW_REPOURL and calculate MAVEN_HOME # maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ [ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" distributionUrlName="${distributionUrl##*/}" distributionUrlNameMain="${distributionUrlName%.*}" distributionUrlNameMain="${distributionUrlNameMain%-bin}" MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" exec_maven() { unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" } if [ -d "$MAVEN_HOME" ]; then verbose "found existing MAVEN_HOME at $MAVEN_HOME" exec_maven "$@" fi case "${distributionUrl-}" in *?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; *) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; esac # prepare tmp dir if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } trap clean HUP INT TERM EXIT else die "cannot create temp dir" fi mkdir -p -- "${MAVEN_HOME%/*}" # Download and Install Apache Maven verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." verbose "Downloading from: $distributionUrl" verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" # select .zip or .tar.gz if ! command -v unzip >/dev/null; then distributionUrl="${distributionUrl%.zip}.tar.gz" distributionUrlName="${distributionUrl##*/}" fi # verbose opt __MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' [ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v # normalize http auth case "${MVNW_PASSWORD:+has-password}" in '') MVNW_USERNAME='' MVNW_PASSWORD='' ;; has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; esac if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then verbose "Found wget ... using wget" wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then verbose "Found curl ... using curl" curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" elif set_java_home; then verbose "Falling back to use Java to download" javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" cat >"$javaSource" <<-END public class Downloader extends java.net.Authenticator { protected java.net.PasswordAuthentication getPasswordAuthentication() { return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); } public static void main( String[] args ) throws Exception { setDefault( new Downloader() ); java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); } } END # For Cygwin/MinGW, switch paths to Windows format before running javac and java verbose " - Compiling Downloader.java ..." "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" verbose " - Running Downloader.java ..." "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" fi # If specified, validate the SHA-256 sum of the Maven distribution zip file if [ -n "${distributionSha256Sum-}" ]; then distributionSha256Result=false if [ "$MVN_CMD" = mvnd.sh ]; then echo "Checksum validation is not supported for maven-mvnd." >&2 echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 exit 1 elif command -v sha256sum >/dev/null; then if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then distributionSha256Result=true fi elif command -v shasum >/dev/null; then if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then distributionSha256Result=true fi else echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 exit 1 fi if [ $distributionSha256Result = false ]; then echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 exit 1 fi fi # unzip and move if command -v unzip >/dev/null; then unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" else tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" fi printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" clean || : exec_maven "$@" mvnw.cmd0100644 0000000 0000000 00000015400 00000250600 011237 0ustar000000000 0000000 <# : batch portion @REM ---------------------------------------------------------------------------- @REM Licensed to the Apache Software Foundation (ASF) under one @REM or more contributor license agreements. See the NOTICE file @REM distributed with this work for additional information @REM regarding copyright ownership. The ASF licenses this file @REM to you under the Apache License, Version 2.0 (the @REM "License"); you may not use this file except in compliance @REM with the License. You may obtain a copy of the License at @REM @REM http://www.apache.org/licenses/LICENSE-2.0 @REM @REM Unless required by applicable law or agreed to in writing, @REM software distributed under the License is distributed on an @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @REM KIND, either express or implied. See the License for the @REM specific language governing permissions and limitations @REM under the License. @REM ---------------------------------------------------------------------------- @REM ---------------------------------------------------------------------------- @REM Apache Maven Wrapper startup batch script, version 3.3.2 @REM @REM Optional ENV vars @REM MVNW_REPOURL - repo url base for downloading maven distribution @REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven @REM MVNW_VERBOSE - true: enable verbose log; others: silence the output @REM ---------------------------------------------------------------------------- @IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) @SET __MVNW_CMD__= @SET __MVNW_ERROR__= @SET __MVNW_PSMODULEP_SAVE=%PSModulePath% @SET PSModulePath= @FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) ) @SET PSModulePath=%__MVNW_PSMODULEP_SAVE% @SET __MVNW_PSMODULEP_SAVE= @SET __MVNW_ARG0_NAME__= @SET MVNW_USERNAME= @SET MVNW_PASSWORD= @IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) @echo Cannot start maven from wrapper >&2 && exit /b 1 @GOTO :EOF : end batch / begin powershell #> $ErrorActionPreference = "Stop" if ($env:MVNW_VERBOSE -eq "true") { $VerbosePreference = "Continue" } # calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties $distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl if (!$distributionUrl) { Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" } switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { "maven-mvnd-*" { $USE_MVND = $true $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" $MVN_CMD = "mvnd.cmd" break } default { $USE_MVND = $false $MVN_CMD = $script -replace '^mvnw','mvn' break } } # apply MVNW_REPOURL and calculate MAVEN_HOME # maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ if ($env:MVNW_REPOURL) { $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" } $distributionUrlName = $distributionUrl -replace '^.*/','' $distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' $MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" if ($env:MAVEN_USER_HOME) { $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" } $MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' $MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" exit $? } if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" } # prepare tmp dir $TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile $TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" $TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null trap { if ($TMP_DOWNLOAD_DIR.Exists) { try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } } } New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null # Download and Install Apache Maven Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." Write-Verbose "Downloading from: $distributionUrl" Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" $webclient = New-Object System.Net.WebClient if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) } [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 $webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null # If specified, validate the SHA-256 sum of the Maven distribution zip file $distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum if ($distributionSha256Sum) { if ($USE_MVND) { Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." } Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." } } # unzip and move Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null try { Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null } catch { if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { Write-Error "fail to move MAVEN_HOME" } } finally { try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } } Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" pom.xml0100644 0000000 0000000 00000046570 00000250600 011114 0ustar000000000 0000000 org.apache.httpcomponents httpcomponents-parent 14 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent Apache HttpComponents Client 5.6.2 Apache HttpComponents Client is a library of components for building client side HTTP services https://hc.apache.org/httpcomponents-client-5.6.x/${project.version}/ 1999 pom Jira https://issues.apache.org/jira/browse/HTTPCLIENT scm:git:https://gitbox.apache.org/repos/asf/httpcomponents-client.git scm:git:https://gitbox.apache.org/repos/asf/httpcomponents-client.git https://github.com/apache/httpcomponents-client/tree/${project.scm.tag} 5.6.2 apache.website Apache HttpComponents Website scm:svn:https://svn.apache.org/repos/asf/httpcomponents/site/components/httpcomponents-client-5.6.x/LATEST/ 1.8 1.8 5.4.3 2.25.0 1.20.0 2.5.2 3.10.8 2.12.3 1.7.36 5.13.3 3.0 4.11.0 1 3.1.10 1.21.3 2.10.1 5.6 javax.net.ssl.SSLEngine,javax.net.ssl.SSLParameters,java.nio.ByteBuffer,java.nio.CharBuffer,jdk.net.ExtendedSocketOptions,jdk.net.Sockets 1.27.1 1.5.7-4 1.15.2 1.5.2 1.49.0 1.26.2 org.apache.httpcomponents.core5 httpcore5 ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-h2 ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-testing ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-reactive ${httpcore.version} org.apache.httpcomponents.client5 httpclient5 ${project.version} org.apache.httpcomponents.client5 httpclient5 ${project.version} tests org.apache.httpcomponents.client5 httpclient5-cache ${project.version} org.apache.httpcomponents.client5 httpclient5-fluent ${project.version} org.slf4j slf4j-api ${slf4j.version} org.apache.logging.log4j log4j-slf4j-impl ${log4j.version} org.apache.logging.log4j log4j-core ${log4j.version} org.conscrypt conscrypt-openjdk-uber ${conscrypt.version} org.ehcache.modules ehcache-api ${ehcache.version} net.spy spymemcached ${memcached.version} io.reactivex.rxjava3 rxjava ${rxjava3.version} test com.kohlschutter.junixsocket junixsocket-core ${junixsocket.version} pom org.junit junit-bom ${junit.version} pom import org.mockito mockito-core ${mockito.version} test org.hamcrest hamcrest ${hamcrest.version} test org.testcontainers testcontainers ${testcontainers.version} org.testcontainers junit-jupiter ${testcontainers.version} commons-io commons-io 2.19.0 org.apache.commons commons-compress ${commons.compress.version} com.github.luben zstd-jni ${zstd.jni.version} io.micrometer micrometer-core ${micrometer.version} io.micrometer micrometer-observation ${micrometer.version} io.micrometer micrometer-registry-prometheus ${micrometer.version} io.micrometer micrometer-tracing ${micrometer.tracing.version} test io.micrometer micrometer-tracing-bridge-otel ${micrometer.tracing.version} io.opentelemetry opentelemetry-bom ${otel.version} pom import com.aayushatharva.brotli4j brotli4j ${brotli4j.version} true httpclient5 httpclient5-observation httpclient5-fluent httpclient5-cache httpclient5-testing clean verify maven-jar-plugin ${Automatic-Module-Name} ${project.url} maven-javadoc-plugin https://hc.apache.org/httpcomponents-core-5.4.x/current/httpcore5/apidocs/ https://hc.apache.org/httpcomponents-core-5.4.x/current/httpcore5-h2/apidocs/ https://hc.apache.org/httpcomponents-client-5.6.x/current/httpclient5/apidocs/ org.apache.maven.plugins maven-checkstyle-plugin validate-main validate hc-stylecheck/default.xml hc-stylecheck/asl2.header true true false ${basedir}/src/main checkstyle validate-test validate hc-stylecheck/default.xml hc-stylecheck/asl2.header true true false ${basedir}/src/test checkstyle com.github.siom79.japicmp japicmp-maven-plugin 0.25.4 ${project.groupId} ${project.artifactId} ${api.comparison.version} jar true true METHOD_NEW_DEFAULT true true @org.apache.hc.core5.annotation.Internal true false false verify cmp org.apache.rat apache-rat-plugin verify check src/docbkx/resources/** src/test/resources/*.truststore src/test/resources/*.serialized .checkstyle .externalToolBuilders/** maven-eclipse.xml **/serial **/index.txt org.apache.maven.plugins maven-surefire-plugin ${hc.surefire.version} slow slow-tests org.apache.maven.plugins maven-surefire-plugin ${hc.surefire.version} slow maven-project-info-reports-plugin false index dependency-info dependency-management issue-management licenses mailing-lists scm summary maven-javadoc-plugin true true https://hc.apache.org/httpcomponents-core-5.4.x/current/httpcore5/apidocs/ https://hc.apache.org/httpcomponents-core-5.4.x/current/httpcore5-h2/apidocs/ ${project.url}/httpclient5/apidocs/ Apache HttpClient org.apache.hc.client5.http* Apache HttpClient Cache org.apache.hc.client5.http.cache*:org.apache.hc.client5.http.impl.cache*:org.apache.hc.client5.http.schedule:org.apache.hc.client5.http.impl.schedule* Apache HttpClient Fluent org.apache.hc.client5.http.fluent* Apache HttpClient Testing org.apache.hc.client5.testing* Apache HttpClient Windows features org.apache.hc.client5.http.impl.win* javadoc com.github.siom79.japicmp japicmp-maven-plugin cmp-report ${project.groupId} ${project.artifactId} ${project.version} jar ${project.groupId} ${project.artifactId} ${api.comparison.version} jar @org.apache.hc.core5.annotation.Internal true run-example.sh0100644 0000000 0000000 00000005473 00000250600 012365 0ustar000000000 0000000 #!/usr/bin/env bash # ==================================================================== # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ==================================================================== # # This software consists of voluntary contributions made by many # individuals on behalf of the Apache Software Foundation. For more # information on the Apache Software Foundation, please see # . set -e usage() { cat <&2 usage >&2 exit 1 ;; *) break;; esac done classname=$1 shift || true args=("$@") # list examples if no classname if [[ -z $classname ]]; then find "$project/src/test/java" -type f -name '*.java' | grep '/examples/' \ | sed -e 's|\.java$||' \ | xargs basename | sort exit 0 fi # compile tests and build classpath cpfile=$(mktemp) trap 'rm -f "$cpfile"' EXIT ./mvnw -q -pl "$project" -am test-compile dependency:build-classpath \ -DincludeScope=test -Dmdep.outputFile="$cpfile" # assemble classpath cp="$project/target/test-classes:$project/target/classes:$(cat "$cpfile")" # find fully qualified classname fqn=$(find "$project/src/test/java" -name "${classname}.java" | head -n1) if [[ -z $fqn ]]; then echo "example not found: $classname" >&2 usage >&2 exit 1 fi fqn=${fqn#"$project/src/test/java/"} fqn=${fqn%.java} fqn=${fqn//\//.} # run it if [[ "$verbose" = true ]]; then echo java -cp "$cp" "$fqn" "${args[@]}" >&2 fi java -cp "$cp" "$fqn" "${args[@]}" httpclient5/0040755 0000000 0000000 00000000000 00000250600 012031 5ustar000000000 0000000 httpclient5/pom.xml0100644 0000000 0000000 00000015112 00000250600 013343 0ustar000000000 0000000 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent 5.6.2 httpclient5 Apache HttpClient Apache HttpComponents Client jar org.apache.httpcomponents.client5.httpclient5 org.apache.httpcomponents.core5 httpcore5 org.apache.httpcomponents.core5 httpcore5-h2 org.slf4j slf4j-api org.conscrypt conscrypt-openjdk-uber true org.apache.httpcomponents.core5 httpcore5-reactive test io.reactivex.rxjava3 rxjava test org.apache.logging.log4j log4j-slf4j-impl test org.apache.logging.log4j log4j-core test com.kohlschutter.junixsocket junixsocket-core test pom org.junit.jupiter junit-jupiter test org.hamcrest hamcrest test org.mockito mockito-core test commons-io commons-io test org.apache.commons commons-compress true com.github.luben zstd-jni true com.aayushatharva.brotli4j brotli4j true src/main/resources true **/*.properties src/main/resources **/*.dat com.googlecode.maven-download-plugin download-maven-plugin 1.13.0 download-public-suffix-list generate-resources wget https://publicsuffix.org/list/effective_tld_names.dat ${project.basedir}/src/main/resources/org/publicsuffix/list org.apache.maven.plugins maven-jar-plugin test-jar maven-project-info-reports-plugin false index dependencies dependency-info summary apache-release com.googlecode.maven-download-plugin download-maven-plugin true true httpclient5/src/0040755 0000000 0000000 00000000000 00000250600 012620 5ustar000000000 0000000 httpclient5/src/main/0040755 0000000 0000000 00000000000 00000250600 013544 5ustar000000000 0000000 httpclient5/src/main/java/0040755 0000000 0000000 00000000000 00000250600 014465 5ustar000000000 0000000 httpclient5/src/main/java/org/0040755 0000000 0000000 00000000000 00000250600 015254 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/0040755 0000000 0000000 00000000000 00000250600 016475 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/0040755 0000000 0000000 00000000000 00000250600 017067 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/0040755 0000000 0000000 00000000000 00000250600 020432 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/0040755 0000000 0000000 00000000000 00000250600 021411 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java0100644 0000000 0000000 00000011724 00000250600 030034 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.util.Args; /** * Abstract {@link HttpClientContext} builder. * * @param The HttpClientContext type or subtype. * @since 5.4 */ public abstract class AbstractClientContextBuilder { private final SchemePortResolver schemePortResolver; private Lookup cookieSpecRegistry; private Lookup authSchemeRegistry; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private AuthCache authCache; private Map authSchemeMap; protected AbstractClientContextBuilder(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } public AbstractClientContextBuilder useCookieSpecRegistry(final Lookup cookieSpecRegistry) { this.cookieSpecRegistry = cookieSpecRegistry; return this; } public AbstractClientContextBuilder useAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.authSchemeRegistry = authSchemeRegistry; return this; } public AbstractClientContextBuilder useCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } public AbstractClientContextBuilder useCredentialsProvider(final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; return this; } public AbstractClientContextBuilder useAuthCache(final AuthCache authCache) { this.authCache = authCache; return this; } public AbstractClientContextBuilder preemptiveAuth(final HttpHost host, final AuthScheme authScheme) { Args.notNull(host, "HTTP host"); if (authSchemeMap == null) { authSchemeMap = new HashMap<>(); } authSchemeMap.put(RoutingSupport.normalize(host, schemePortResolver), authScheme); return this; } public AbstractClientContextBuilder preemptiveBasicAuth(final HttpHost host, final UsernamePasswordCredentials credentials) { Args.notNull(host, "HTTP host"); final BasicScheme authScheme = new BasicScheme(); authScheme.initPreemptive(credentials); preemptiveAuth(host, authScheme); return this; } protected abstract T createContext(); public T build() { final T context = createContext(); context.setCookieSpecRegistry(cookieSpecRegistry); context.setAuthSchemeRegistry(authSchemeRegistry); context.setCookieStore(cookieStore); context.setCredentialsProvider(credentialsProvider); context.setAuthCache(authCache); if (authSchemeMap != null) { for (final Map.Entry entry : authSchemeMap.entrySet()) { context.resetAuthExchange(entry.getKey(), entry.getValue()); } } return context; } } httpclient5/src/main/java/org/apache/hc/client5/http/AuthenticationStrategy.java0100644 0000000 0000000 00000005076 00000250600 026763 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.List; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Strategy to select auth schemes in order of preference based on auth challenges * presented by the opposite endpoint (target server or a proxy). *

* Implementations of this interface must be thread-safe. Access to shared data must be * synchronized as methods of this interface may be executed from multiple threads. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface AuthenticationStrategy { /** * Returns an list of {@link AuthScheme}s to handle the given {@link AuthChallenge}s * in their order of preference. * * @param challengeType challenge type. * @param challenges map of challenges keyed by lowercase auth scheme names. * @param context HTTP context. * @return authentication auth schemes that can be used for authentication. Can be empty. * * @since 5.0 */ List select( ChallengeType challengeType, Map challenges, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/CircularRedirectException.java0100644 0000000 0000000 00000004344 00000250600 027363 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; /** * Signals a circular redirect * * @since 4.0 */ public class CircularRedirectException extends RedirectException { private static final long serialVersionUID = 6830063487001091803L; /** * Creates a new CircularRedirectException with a {@code null} detail message. */ public CircularRedirectException() { super(); } /** * Creates a new CircularRedirectException with the specified detail message. * * @param message The exception detail message */ public CircularRedirectException(final String message) { super(message); } /** * Creates a new CircularRedirectException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public CircularRedirectException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/ClientProtocolException.java0100644 0000000 0000000 00000003442 00000250600 027073 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; /** * Signals an error in the HTTP protocol. * * @since 4.0 */ public class ClientProtocolException extends IOException { private static final long serialVersionUID = -5596590843227115865L; public ClientProtocolException() { super(); } public ClientProtocolException(final String s) { super(s); } public ClientProtocolException(final Throwable cause) { initCause(cause); } public ClientProtocolException(final String message, final Throwable cause) { super(message); initCause(cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectExceptionSupport.java0100644 0000000 0000000 00000007324 00000250600 027124 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import java.net.ConnectException; import java.net.InetAddress; import java.net.SocketTimeoutException; import java.util.Arrays; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.net.NamedEndpoint; /** * Connect exception support methods. * * @since 5.0 */ @Internal public final class ConnectExceptionSupport { public static ConnectTimeoutException createConnectTimeoutException( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { final String message = "Connect to " + (namedEndpoint != null ? namedEndpoint : "remote endpoint") + (remoteAddresses != null && remoteAddresses.length > 0 ? " " + Arrays.asList(remoteAddresses) : "") + ((cause != null && cause.getMessage() != null) ? " failed: " + cause.getMessage() : " timed out"); return new ConnectTimeoutException(message, namedEndpoint); } public static HttpHostConnectException createHttpHostConnectException( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { final String message = "Connect to " + (namedEndpoint != null ? namedEndpoint : "remote endpoint") + (remoteAddresses != null && remoteAddresses.length > 0 ? " " + Arrays.asList(remoteAddresses) : "") + ((cause != null && cause.getMessage() != null) ? " failed: " + cause.getMessage() : " refused"); return new HttpHostConnectException(message, namedEndpoint); } public static IOException enhance( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { if (cause instanceof SocketTimeoutException) { final IOException ex = createConnectTimeoutException(cause, namedEndpoint, remoteAddresses); ex.setStackTrace(cause.getStackTrace()); return ex; } else if (cause instanceof ConnectException) { if ("Connection timed out".equals(cause.getMessage())) { final IOException ex = createConnectTimeoutException(cause, namedEndpoint, remoteAddresses); ex.initCause(cause); return ex; } final IOException ex = createHttpHostConnectException(cause, namedEndpoint, remoteAddresses); ex.setStackTrace(cause.getStackTrace()); return ex; } else { return cause; } } } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java0100644 0000000 0000000 00000004467 00000250600 027103 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.SocketTimeoutException; import org.apache.hc.core5.net.NamedEndpoint; /** * A timeout while connecting to an HTTP server or waiting for an available connection from a connection manager. * * @since 4.0 */ public class ConnectTimeoutException extends SocketTimeoutException { private static final long serialVersionUID = -4816682903149535989L; private final NamedEndpoint namedEndpoint; /** * Creates a ConnectTimeoutException with the specified detail message. * * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method). */ public ConnectTimeoutException(final String message) { super(message); this.namedEndpoint = null; } public ConnectTimeoutException(final String message, final NamedEndpoint namedEndpoint) { super(message); this.namedEndpoint = namedEndpoint; } /** * Gets the named endpoint. * * @return the named endpoint, may be {@code null}. * @since 5.0 */ public NamedEndpoint getHost() { return this.namedEndpoint; } } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectionKeepAliveStrategy.java0100644 0000000 0000000 00000005624 00000250600 027670 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; /** * Interface for deciding how long a connection can remain * idle before being reused. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ConnectionKeepAliveStrategy { /** * Returns the duration of time which this connection can be safely kept * idle. If the connection is left idle for longer than this period of time, * it MUST not reused. A value of 0 or less may be returned to indicate that * there is no suitable suggestion. * * When coupled with a {@link org.apache.hc.core5.http.ConnectionReuseStrategy}, if * {@link org.apache.hc.core5.http.ConnectionReuseStrategy#keepAlive( * org.apache.hc.core5.http.HttpRequest, HttpResponse, HttpContext)} returns true, * this allows you to control how long the reuse will last. If keepAlive returns * false, this should have no meaningful impact * * @param response * The last response received over the connection. * @param context * the context in which the connection is being used. * * @return the duration in ms for which it is safe to keep the connection * idle, or <=0 if no suggested duration. */ TimeValue getKeepAliveDuration(HttpResponse response, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/ContextBuilder.java0100644 0000000 0000000 00000007330 00000250600 025207 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; /** * {@link HttpClientContext} builder. * * @since 5.2 */ public class ContextBuilder extends AbstractClientContextBuilder { protected ContextBuilder(final SchemePortResolver schemePortResolver) { super(schemePortResolver); } public static ContextBuilder create(final SchemePortResolver schemePortResolver) { return new ContextBuilder(schemePortResolver); } public static ContextBuilder create() { return new ContextBuilder(DefaultSchemePortResolver.INSTANCE); } @Override public ContextBuilder useCookieSpecRegistry(final Lookup cookieSpecRegistry) { super.useCookieSpecRegistry(cookieSpecRegistry); return this; } @Override public ContextBuilder useAuthSchemeRegistry(final Lookup authSchemeRegistry) { super.useAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public ContextBuilder useCookieStore(final CookieStore cookieStore) { super.useCookieStore(cookieStore); return this; } @Override public ContextBuilder useCredentialsProvider(final CredentialsProvider credentialsProvider) { super.useCredentialsProvider(credentialsProvider); return this; } @Override public ContextBuilder useAuthCache(final AuthCache authCache) { super.useAuthCache(authCache); return this; } @Override public ContextBuilder preemptiveAuth(final HttpHost host, final AuthScheme authScheme) { super.preemptiveAuth(host, authScheme); return this; } @Override public ContextBuilder preemptiveBasicAuth(final HttpHost host, final UsernamePasswordCredentials credentials) { super.preemptiveBasicAuth(host, credentials); return this; } @Override protected HttpClientContext createContext() { return HttpClientContext.create(); } } httpclient5/src/main/java/org/apache/hc/client5/http/DnsResolver.java0100644 0000000 0000000 00000006030 00000250600 024516 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.UnknownHostException; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.stream.Collectors; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Users may implement this interface to override the normal DNS lookup offered * by the OS. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface DnsResolver { /** * Returns the IP address for the specified host name, or null if the given * host is not recognized or the associated IP address cannot be used to * build an InetAddress instance. * * @see InetAddress * * @param host * The host name to be resolved by this resolver. * @return The IP address associated to the given host name, or null if the * host name is not known by the implementation class. */ InetAddress[] resolve(String host) throws UnknownHostException; /** * Gets the fully qualified domain name for given host name. * @since 5.0 */ String resolveCanonicalHostname(String host) throws UnknownHostException; /** * Returns a list of {@link InetSocketAddress} for the given host with the given port. * * @see InetSocketAddress * * @since 5.5 */ default List resolve(String host, int port) throws UnknownHostException { final InetAddress[] inetAddresses = resolve(host); if (inetAddresses == null) { return Collections.singletonList(InetSocketAddress.createUnresolved(host, port)); } return Arrays.stream(inetAddresses) .map(e -> new InetSocketAddress(e, port)) .collect(Collectors.toList()); } } httpclient5/src/main/java/org/apache/hc/client5/http/EarlyHintsListener.java0100644 0000000 0000000 00000004561 00000250600 026047 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; /** * Callback interface for receiving {@code 103 Early Hints} * informational responses emitted by the server before the final response. * *

The listener may be invoked multiple times per request, once for each * {@code 103} received. It is never invoked for the final (non-1xx) response.

* *

Implementations should be fast and non-blocking. If heavy work is needed, * offload it to an application executor.

* * @since 5.6 */ @FunctionalInterface public interface EarlyHintsListener { /** * Called for each received {@code 103 Early Hints} informational response. * * @param hints the {@code 103} response object as received on the wire * @param context the current execution context (never {@code null}) * @throws HttpException to signal an HTTP-layer error while handling hints * @throws IOException to signal an I/O error while handling hints */ void onEarlyHints(HttpResponse hints, HttpContext context) throws HttpException, IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/EndpointInfo.java0100644 0000000 0000000 00000003745 00000250600 024656 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import javax.net.ssl.SSLSession; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ProtocolVersion; /** * @since 5.4 */ public final class EndpointInfo { private final ProtocolVersion protocol; private final SSLSession sslSession; @Internal public EndpointInfo(final ProtocolVersion protocol, final SSLSession sslSession) { this.protocol = protocol; this.sslSession = sslSession; } public ProtocolVersion getProtocol() { return protocol; } public SSLSession getSslSession() { return sslSession; } @Override public String toString() { return "EndpointInfo{" + "protocol=" + protocol + ", sslSession=" + sslSession + '}'; } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpHostConnectException.java0100644 0000000 0000000 00000004107 00000250600 027221 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.ConnectException; import org.apache.hc.core5.net.NamedEndpoint; /** * A {@link ConnectException} that specifies the {@link NamedEndpoint} that was being connected to. * * @since 4.0 */ public class HttpHostConnectException extends ConnectException { private static final long serialVersionUID = -3194482710275220224L; private final NamedEndpoint namedEndpoint; /** * Creates a HttpHostConnectException with the specified detail message. */ public HttpHostConnectException(final String message) { super(message); this.namedEndpoint = null; } public HttpHostConnectException(final String message, final NamedEndpoint namedEndpoint) { super(message); this.namedEndpoint = namedEndpoint; } /** * @since 5.0 */ public NamedEndpoint getHost() { return this.namedEndpoint; } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpRequestRetryStrategy.java0100644 0000000 0000000 00000010044 00000250600 027311 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; /** * Strategy interface that allows API users to plug in their own logic to * control whether or not a retry should automatically be done, how many times * it should be done and so on. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRequestRetryStrategy { /** * Determines if a method should be retried after an I/O exception * occurred during execution. * * @param request the request failed due to an I/O exception * @param exception the exception that occurred * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return {@code true} if the request should be retried, {@code false} * otherwise */ boolean retryRequest(HttpRequest request, IOException exception, int execCount, HttpContext context); /** * Determines if a method should be retried given the response from * the target server. * * @param response the response from the target server * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return {@code true} if the request should be retried, {@code false} * otherwise */ boolean retryRequest(HttpResponse response, int execCount, HttpContext context); /** * Determines the retry interval between subsequent retries. * * @param request the request failed due to an I/O exception * @param exception the exception that occurred * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return the retry interval between subsequent retries */ default TimeValue getRetryInterval(HttpRequest request, IOException exception, int execCount, HttpContext context) { return TimeValue.ZERO_MILLISECONDS; } /** * Determines the retry interval between subsequent retries. * * @param response the response from the target server * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return the retry interval between subsequent retries */ TimeValue getRetryInterval(HttpResponse response, int execCount, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/HttpResponseException.java0100644 0000000 0000000 00000007055 00000250600 026575 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.TextUtils; /** * Signals a non 2xx HTTP response. * * @since 4.0 */ public class HttpResponseException extends ClientProtocolException { private static final long serialVersionUID = -7186627969477257933L; private final int statusCode; private final String reasonPhrase; private final byte[] contentBytes; private final ContentType contentType; /** * Constructs a new instance of {@code HttpResponseException} with the given * status code and reason phrase, and no content bytes or content type. * * @param statusCode the HTTP status code * @param reasonPhrase the reason phrase associated with the HTTP status code */ public HttpResponseException(final int statusCode, final String reasonPhrase) { this(statusCode, reasonPhrase, null, null); } /** * Constructs a new instance of {@code HttpResponseException} with the given * status code, reason phrase, content bytes, and content type. * * @param statusCode the HTTP status code * @param reasonPhrase the reason phrase associated with the HTTP status code * @param contentBytes the content bytes of the HTTP response * @param contentType the content type of the HTTP response */ public HttpResponseException(final int statusCode, final String reasonPhrase, final byte[] contentBytes, final ContentType contentType) { super(String.format("status code: %d" + (TextUtils.isBlank(reasonPhrase) ? "" : ", reason phrase: %s") + (contentBytes == null ? "" : ", content: %s"), statusCode, reasonPhrase, contentBytes == null || contentType == null || contentType.getCharset() == null ? null : new String(contentBytes, contentType.getCharset()))); this.statusCode = statusCode; this.reasonPhrase = reasonPhrase; this.contentBytes = contentBytes; this.contentType = contentType; } public int getStatusCode() { return this.statusCode; } public String getReasonPhrase() { return this.reasonPhrase; } public byte[] getContentBytes() { return contentBytes; } public ContentType getContentType() { return contentType; } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpRoute.java0100644 0000000 0000000 00000042532 00000250600 024215 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.net.InetSocketAddress; import java.nio.file.Path; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Connection route definition for HTTP requests. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class HttpRoute implements RouteInfo, Cloneable { /** The target host to connect to. */ private final HttpHost targetHost; /** The target name, if different from the target host, {@code null} otherwise. */ private final NamedEndpoint targetName; /** * The local address to connect from. * {@code null} indicates that the default should be used. */ private final InetAddress localAddress; /** The proxy servers, if any. Never null. */ private final List proxyChain; /** The path to the UDS to connect to, if any. */ private final Path unixDomainSocket; /** Whether the the route is tunnelled through the proxy. */ private final TunnelType tunnelled; /** Whether the route is layered. */ private final LayerType layered; /** Whether the route is (supposed to be) secure. */ private final boolean secure; HttpRoute(final HttpHost targetHost, final NamedEndpoint targetName, final InetAddress local, final List proxies, final Path unixDomainSocket, final boolean secure, final TunnelType tunnelled, final LayerType layered) { Args.notNull(targetHost, "Target host"); Args.notNegative(targetHost.getPort(), "Target port"); this.targetName = targetName; this.targetHost = targetHost; this.localAddress = local; this.unixDomainSocket = unixDomainSocket; if (proxies != null && !proxies.isEmpty()) { this.proxyChain = new ArrayList<>(proxies); } else { this.proxyChain = null; } if (tunnelled == TunnelType.TUNNELLED) { Args.check(this.proxyChain != null, "Proxy required if tunnelled"); } this.secure = secure; this.tunnelled = tunnelled != null ? tunnelled : TunnelType.PLAIN; this.layered = layered != null ? layered : LayerType.PLAIN; if (this.unixDomainSocket != null) { validateUdsArguments(); } } private void validateUdsArguments() { if (this.localAddress != null) { throw new UnsupportedOperationException("A localAddress cannot be specified for a UDS connection"); } else if (this.proxyChain != null) { throw new UnsupportedOperationException("Proxies are not supported over a UDS connection"); } else if (this.layered != LayerType.PLAIN) { throw new UnsupportedOperationException("Layering is not supported over a UDS connection"); } else if (this.tunnelled != TunnelType.PLAIN) { throw new UnsupportedOperationException("Tunnelling is not supported over a UDS connection"); } } /** * Creates a new route with all attributes specified explicitly. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxies the proxy chain to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled the tunnel type of this route * @param layered the layering type of this route */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost[] proxies, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, null, local, proxies != null ? Arrays.asList(proxies) : null, null, secure, tunnelled, layered); } /** * Creates a new route with all attributes specified explicitly. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param proxies the proxy chain to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled the tunnel type of this route * @param layered the layering type of this route * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final HttpHost[] proxies, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, targetName, local, proxies != null ? Arrays.asList(proxies) : null, null, secure, tunnelled, layered); } /** * Creates a new route with at most one proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled {@code true} if the route is (to be) tunnelled * via the proxy, * {@code false} otherwise * @param layered {@code true} if the route includes a * layered protocol, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, null, local, proxy != null ? Collections.singletonList(proxy) : null, null, secure, tunnelled, layered); } /** * Creates a new direct route. * That is a route without a proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final boolean secure) { this(target, null, local, Collections.emptyList(), null, secure, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new direct route. That is a route without a proxy. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final boolean secure) { this(target, targetName, local, Collections.emptyList(), null, secure, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new direct route that connects over a Unix domain socket rather than TCP. * * @param target the host to which to route * @param unixDomainSocket the path to the Unix domain socket * * @since 5.6 */ public HttpRoute(final HttpHost target, final Path unixDomainSocket) { this(target, false, unixDomainSocket); } /** * Creates a new direct route that connects over a Unix domain socket rather than TCP. * * @param target the host to which to route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param unixDomainSocket the path to the Unix domain socket * * @since 5.6 */ public HttpRoute(final HttpHost target, final boolean secure, final Path unixDomainSocket) { this(target, null, null, Collections.emptyList(), unixDomainSocket, secure, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new direct insecure route. * * @param target the host to which to route */ public HttpRoute(final HttpHost target) { this(target, null, null, Collections.emptyList(), null, false, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new route through a proxy. * When using this constructor, the {@code proxy} MUST be given. * For convenience, it is assumed that a secure connection will be * layered over a tunnel through the proxy. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final HttpHost proxy, final boolean secure) { this(target, targetName, local, Collections.singletonList(Args.notNull(proxy, "Proxy host")), null, secure, secure ? TunnelType.TUNNELLED : TunnelType.PLAIN, secure ? LayerType.LAYERED : LayerType.PLAIN); } /** * Creates a new route through a proxy. * When using this constructor, the {@code proxy} MUST be given. * For convenience, it is assumed that a secure connection will be * layered over a tunnel through the proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy, final boolean secure) { this(target, null, local, Collections.singletonList(Args.notNull(proxy, "Proxy host")), null, secure, secure ? TunnelType.TUNNELLED : TunnelType.PLAIN, secure ? LayerType.LAYERED : LayerType.PLAIN); } /** * Creates a new plain route through a proxy. * * @param target the host to which to route * @param proxy the proxy to use * * @since 4.3 */ public HttpRoute(final HttpHost target, final HttpHost proxy) { this(target, null, proxy, false); } @Override public HttpHost getTargetHost() { return this.targetHost; } /** * @since 5.4 */ @Override public NamedEndpoint getTargetName() { return targetName; } @Override public InetAddress getLocalAddress() { return this.localAddress; } public InetSocketAddress getLocalSocketAddress() { return this.localAddress != null ? new InetSocketAddress(this.localAddress, 0) : null; } @Override public int getHopCount() { return proxyChain != null ? proxyChain.size() + 1 : 1; } @Override public HttpHost getHopTarget(final int hop) { Args.notNegative(hop, "Hop index"); final int hopcount = getHopCount(); Args.check(hop < hopcount, "Hop index exceeds tracked route length"); if (hop < hopcount - 1) { return this.proxyChain.get(hop); } return this.targetHost; } @Override public HttpHost getProxyHost() { return proxyChain != null && !this.proxyChain.isEmpty() ? this.proxyChain.get(0) : null; } @Override public Path getUnixDomainSocket() { return this.unixDomainSocket; } @Override public TunnelType getTunnelType() { return this.tunnelled; } @Override public boolean isTunnelled() { return this.tunnelled == TunnelType.TUNNELLED; } @Override public LayerType getLayerType() { return this.layered; } @Override public boolean isLayered() { return this.layered == LayerType.LAYERED; } @Override public boolean isSecure() { return this.secure; } /** * Compares this route to another. * * @param obj the object to compare with * * @return {@code true} if the argument is the same route, * {@code false} */ @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof HttpRoute) { final HttpRoute that = (HttpRoute) obj; return // Do the cheapest tests first this.secure == that.secure && this.tunnelled == that.tunnelled && this.layered == that.layered && Objects.equals(this.targetHost, that.targetHost) && Objects.equals(this.targetName, that.targetName) && Objects.equals(this.localAddress, that.localAddress) && Objects.equals(this.proxyChain, that.proxyChain) && Objects.equals(this.unixDomainSocket, that.unixDomainSocket); } return false; } /** * Generates a hash code for this route. * * @return the hash code */ @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.targetHost); hash = LangUtils.hashCode(hash, this.targetName); hash = LangUtils.hashCode(hash, this.localAddress); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { hash = LangUtils.hashCode(hash, element); } } if (this.unixDomainSocket != null) { hash = LangUtils.hashCode(hash, unixDomainSocket); } hash = LangUtils.hashCode(hash, this.secure); hash = LangUtils.hashCode(hash, this.tunnelled); hash = LangUtils.hashCode(hash, this.layered); return hash; } /** * Obtains a description of this route. * * @return a human-readable representation of this route */ @Override public String toString() { final StringBuilder cab = new StringBuilder(50 + getHopCount() * 30); if (this.localAddress != null) { cab.append(this.localAddress); cab.append("->"); } else if (unixDomainSocket != null) { cab.append(unixDomainSocket).append("->"); } cab.append('{'); if (this.tunnelled == TunnelType.TUNNELLED) { cab.append('t'); } if (this.layered == LayerType.LAYERED) { cab.append('l'); } if (this.secure) { cab.append('s'); } cab.append("}->"); if (this.proxyChain != null) { for (final HttpHost aProxyChain : this.proxyChain) { cab.append(aProxyChain); cab.append("->"); } } if (this.targetName != null) { cab.append(this.targetName); cab.append("/"); } cab.append("["); cab.append(this.targetHost); cab.append("]"); return cab.toString(); } // default implementation of clone() is sufficient @Override public Object clone() throws CloneNotSupportedException { return super.clone(); } } httpclient5/src/main/java/org/apache/hc/client5/http/RedirectException.java0100644 0000000 0000000 00000004412 00000250600 025672 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.http.ProtocolException; /** * Signals violation of HTTP specification caused by an invalid redirect * * @since 4.0 */ public class RedirectException extends ProtocolException { private static final long serialVersionUID = 4418824536372559326L; /** * Creates a new RedirectException with a {@code null} detail message. */ public RedirectException() { super(); } /** * Creates a new RedirectException with the specified detail message. * * @param message The exception detail message */ public RedirectException(final String message) { super(message); } /** * Creates a new RedirectException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public RedirectException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/RouteInfo.java0100644 0000000 0000000 00000012753 00000250600 024173 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.nio.file.Path; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; /** * Connection route information. * * @since 4.0 */ public interface RouteInfo { /** * The tunnelling type of a route. * Plain routes are established by connecting to the target or * the first proxy. * Tunnelled routes are established by connecting to the first proxy * and tunnelling through all proxies to the target. * Routes without a proxy cannot be tunnelled. */ enum TunnelType { PLAIN, TUNNELLED } /** * The layering type of a route. * Plain routes are established by connecting or tunnelling. * Layered routes are established by layering a protocol such as TLS/SSL * over an existing connection. * Protocols can only be layered over a tunnel to the target, or * or over a direct connection without proxies. *

* Layering a protocol * over a direct connection makes little sense, since the connection * could be established with the new protocol in the first place. * But we don't want to exclude that use case. *

*/ enum LayerType { PLAIN, LAYERED } /** * Obtains the target host. * * @return the target host */ HttpHost getTargetHost(); /** * Obtains the target name, if different from the target host, {@code null} otherwise. * * @since 5.4 */ default NamedEndpoint getTargetName() { return null; } /** * Obtains the local address to connect from. * * @return the local address, * or {@code null} */ InetAddress getLocalAddress(); /** * Obtains the Unix domain socket through which to connect to the target host. * * @return the path to the Unix domain socket, or {@code null} if none */ default Path getUnixDomainSocket() { return null; } /** * Obtains the number of hops in this route. * A direct route has one hop. A route through a proxy has two hops. * A route through a chain of n proxies has n+1 hops. * * @return the number of hops in this route */ int getHopCount(); /** * Obtains the target of a hop in this route. * The target of the last hop is the {@link #getTargetHost target host}, * the target of previous hops is the respective proxy in the chain. * For a route through exactly one proxy, target of hop 0 is the proxy * and target of hop 1 is the target host. * * @param hop index of the hop for which to get the target, * 0 for first * * @return the target of the given hop * * @throws IllegalArgumentException * if the argument is negative or not less than * {@link #getHopCount getHopCount()} */ HttpHost getHopTarget(int hop); /** * Obtains the first proxy host. * * @return the first proxy in the proxy chain, or * {@code null} if this route is direct */ HttpHost getProxyHost(); /** * Obtains the tunnel type of this route. * If there is a proxy chain, only end-to-end tunnels are considered. * * @return the tunnelling type */ TunnelType getTunnelType(); /** * Checks whether this route is tunnelled through a proxy. * If there is a proxy chain, only end-to-end tunnels are considered. * * @return {@code true} if tunnelled end-to-end through at least * one proxy, * {@code false} otherwise */ boolean isTunnelled(); /** * Obtains the layering type of this route. * In the presence of proxies, only layering over an end-to-end tunnel * is considered. * * @return the layering type */ LayerType getLayerType(); /** * Checks whether this route includes a layered protocol. * In the presence of proxies, only layering over an end-to-end tunnel * is considered. * * @return {@code true} if layered, * {@code false} otherwise */ boolean isLayered(); /** * Checks whether this route is secure. * * @return {@code true} if secure, * {@code false} otherwise */ boolean isSecure(); } httpclient5/src/main/java/org/apache/hc/client5/http/RouteTracker.java0100644 0000000 0000000 00000031342 00000250600 024666 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.nio.file.Path; import java.util.Objects; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.LangUtils; /** * Helps tracking the steps in establishing a route. * * @since 4.0 */ public final class RouteTracker implements RouteInfo, Cloneable { /** The target host to connect to. */ private final HttpHost targetHost; /** * The local address to connect from. * {@code null} indicates that the default should be used. */ private final InetAddress localAddress; /** The Unix domain socket to connect through, if any. */ private final Path unixDomainSocket; // the attributes above are fixed at construction time // now follow attributes that indicate the established route /** Whether the first hop of the route is established. */ private boolean connected; /** The proxy chain, if any. */ private HttpHost[] proxyChain; /** Whether the the route is tunnelled end-to-end through proxies. */ private TunnelType tunnelled; /** Whether the route is layered over a tunnel. */ private LayerType layered; /** Whether the route is secure. */ private boolean secure; /** * Creates a new route tracker. * The target and origin need to be specified at creation time. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default */ public RouteTracker(final HttpHost target, final InetAddress local) { this(target, local, null); } /** * Creates a new route tracker. * The target and origin need to be specified at creation time. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param unixDomainSocket the path to the Unix domain socket * through which to connect, or {@code null} */ public RouteTracker(final HttpHost target, final InetAddress local, final Path unixDomainSocket) { Args.notNull(target, "Target host"); this.targetHost = target; this.localAddress = local; this.unixDomainSocket = unixDomainSocket; this.tunnelled = TunnelType.PLAIN; this.layered = LayerType.PLAIN; } /** * @since 4.2 */ public void reset() { this.connected = false; this.proxyChain = null; this.tunnelled = TunnelType.PLAIN; this.layered = LayerType.PLAIN; this.secure = false; } /** * Creates a new tracker for the given route. * Only target and origin are taken from the route, * everything else remains to be tracked. * * @param route the route to track */ public RouteTracker(final HttpRoute route) { this(route.getTargetHost(), route.getLocalAddress(), route.getUnixDomainSocket()); } /** * Tracks connecting to the target. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void connectTarget(final boolean secure) { Asserts.check(!this.connected, "Already connected"); this.connected = true; this.secure = secure; } /** * Tracks connecting to the first proxy. * * @param proxy the proxy connected to * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void connectProxy(final HttpHost proxy, final boolean secure) { Args.notNull(proxy, "Proxy host"); Asserts.check(!this.connected, "Already connected"); this.connected = true; this.proxyChain = new HttpHost[]{proxy}; this.secure = secure; } /** * Tracks tunnelling to the target. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void tunnelTarget(final boolean secure) { Asserts.check(this.connected, "No tunnel unless connected"); Asserts.notNull(this.proxyChain, "No tunnel without proxy"); this.tunnelled = TunnelType.TUNNELLED; this.secure = secure; } /** * Tracks tunnelling to a proxy in a proxy chain. * This will extend the tracked proxy chain, but it does not mark * the route as tunnelled. Only end-to-end tunnels are considered there. * * @param proxy the proxy tunnelled to * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void tunnelProxy(final HttpHost proxy, final boolean secure) { Args.notNull(proxy, "Proxy host"); Asserts.check(this.connected, "No tunnel unless connected"); Asserts.notNull(this.proxyChain, "No tunnel without proxy"); // prepare an extended proxy chain final HttpHost[] proxies = new HttpHost[this.proxyChain.length + 1]; System.arraycopy(this.proxyChain, 0, proxies, 0, this.proxyChain.length); proxies[proxies.length - 1] = proxy; this.proxyChain = proxies; this.secure = secure; } /** * Tracks layering a protocol. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void layerProtocol(final boolean secure) { // it is possible to layer a protocol over a direct connection, // although this case is probably not considered elsewhere Asserts.check(this.connected, "No layered protocol unless connected"); this.layered = LayerType.LAYERED; this.secure = secure; } @Override public HttpHost getTargetHost() { return this.targetHost; } @Override public InetAddress getLocalAddress() { return this.localAddress; } @Override public Path getUnixDomainSocket() { return this.unixDomainSocket; } @Override public int getHopCount() { int hops = 0; if (this.connected) { if (proxyChain == null) { hops = 1; } else { hops = proxyChain.length + 1; } } return hops; } @Override public HttpHost getHopTarget(final int hop) { Args.notNegative(hop, "Hop index"); final int hopcount = getHopCount(); Args.check(hop < hopcount, "Hop index exceeds tracked route length"); HttpHost result = null; if (hop < hopcount - 1) { result = this.proxyChain[hop]; } else { result = this.targetHost; } return result; } @Override public HttpHost getProxyHost() { return this.proxyChain == null ? null : this.proxyChain[0]; } public boolean isConnected() { return this.connected; } @Override public TunnelType getTunnelType() { return this.tunnelled; } @Override public boolean isTunnelled() { return this.tunnelled == TunnelType.TUNNELLED; } @Override public LayerType getLayerType() { return this.layered; } @Override public boolean isLayered() { return this.layered == LayerType.LAYERED; } @Override public boolean isSecure() { return this.secure; } /** * Obtains the tracked route. * If a route has been tracked, it is {@link #isConnected connected}. * If not connected, nothing has been tracked so far. * * @return the tracked route, or * {@code null} if nothing has been tracked so far */ public HttpRoute toRoute() { if (!this.connected) { return null; } else if (this.unixDomainSocket != null) { return new HttpRoute(this.targetHost, this.secure, this.unixDomainSocket); } else { return new HttpRoute(this.targetHost, this.localAddress, this.proxyChain, this.secure, this.tunnelled, this.layered); } } /** * Compares this tracked route to another. * * @param o the object to compare with * * @return {@code true} if the argument is the same tracked route, * {@code false} */ @Override public boolean equals(final Object o) { if (o == this) { return true; } if (!(o instanceof RouteTracker)) { return false; } final RouteTracker that = (RouteTracker) o; return // Do the cheapest checks first this.connected == that.connected && this.secure == that.secure && this.tunnelled == that.tunnelled && this.layered == that.layered && Objects.equals(this.targetHost, that.targetHost) && Objects.equals(this.localAddress, that.localAddress) && Objects.equals(this.unixDomainSocket, that.unixDomainSocket) && Objects.equals(this.proxyChain, that.proxyChain); } /** * Generates a hash code for this tracked route. * Route trackers are modifiable and should therefore not be used * as lookup keys. Use {@link #toRoute toRoute} to obtain an * unmodifiable representation of the tracked route. * * @return the hash code */ @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.targetHost); hash = LangUtils.hashCode(hash, this.localAddress); hash = LangUtils.hashCode(hash, this.unixDomainSocket); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { hash = LangUtils.hashCode(hash, element); } } hash = LangUtils.hashCode(hash, this.connected); hash = LangUtils.hashCode(hash, this.secure); hash = LangUtils.hashCode(hash, this.tunnelled); hash = LangUtils.hashCode(hash, this.layered); return hash; } /** * Obtains a description of the tracked route. * * @return a human-readable representation of the tracked route */ @Override public String toString() { final StringBuilder cab = new StringBuilder(50 + getHopCount() * 30); cab.append("RouteTracker["); if (this.localAddress != null) { cab.append(this.localAddress); cab.append("->"); } else if (this.unixDomainSocket != null) { cab.append(this.unixDomainSocket).append("->"); } cab.append('{'); if (this.connected) { cab.append('c'); } if (this.tunnelled == TunnelType.TUNNELLED) { cab.append('t'); } if (this.layered == LayerType.LAYERED) { cab.append('l'); } if (this.secure) { cab.append('s'); } cab.append("}->"); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { cab.append(element); cab.append("->"); } } cab.append(this.targetHost); cab.append(']'); return cab.toString(); } // default implementation of clone() is sufficient @Override public Object clone() throws CloneNotSupportedException { return super.clone(); } } httpclient5/src/main/java/org/apache/hc/client5/http/SchemePortResolver.java0100644 0000000 0000000 00000003650 00000250600 026050 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; /** * Strategy for default port resolution for protocol schemes. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface SchemePortResolver { /** * Returns the actual port for the host based on the protocol scheme. */ int resolve(HttpHost host); /** * Returns the actual port for the host based on the protocol scheme. * * @since 5.2 */ default int resolve(String scheme, NamedEndpoint endpoint) { return resolve(new HttpHost(scheme, endpoint)); } } httpclient5/src/main/java/org/apache/hc/client5/http/SystemDefaultDnsResolver.java0100644 0000000 0000000 00000006351 00000250600 027236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.IDN; import java.net.InetAddress; import java.net.UnknownHostException; import org.apache.hc.core5.util.TextUtils; /** * DNS resolver that uses the default OS implementation for resolving host names. * * @since 4.2 */ public class SystemDefaultDnsResolver implements DnsResolver { /** * Default instance of {@link SystemDefaultDnsResolver}. */ public static final SystemDefaultDnsResolver INSTANCE = new SystemDefaultDnsResolver(); @Override public InetAddress[] resolve(final String host) throws UnknownHostException { try { String normalizedHost; if (TextUtils.isAllASCII(host)) { normalizedHost = host; } else { try { normalizedHost = IDN.toASCII(host); } catch (final IllegalArgumentException e) { normalizedHost = host; // Fall back to original hostname } } // Try resolving using the default resolver return InetAddress.getAllByName(normalizedHost); } catch (final UnknownHostException e) { // If default resolver fails, try stripping the IPv6 zone ID and resolving again String strippedHost = null; if (host.charAt(0) == '[') { final int i = host.lastIndexOf('%'); if (i != -1) { strippedHost = host.substring(0, i) + "]"; } } if (strippedHost != null) { return InetAddress.getAllByName(strippedHost); } throw e; } } @Override public String resolveCanonicalHostname(final String host) throws UnknownHostException { if (host == null) { return null; } final InetAddress in = InetAddress.getByName(host); final String canonicalServer = in.getCanonicalHostName(); if (in.getHostAddress().contentEquals(canonicalServer)) { return host; } return canonicalServer; } } httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java0100644 0000000 0000000 00000003410 00000250600 027603 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; /** * Signals failure to establish connection using an unknown protocol scheme. * * @since 4.3 */ public class UnsupportedSchemeException extends IOException { private static final long serialVersionUID = 3597127619218687636L; /** * Creates a UnsupportedSchemeException with the specified detail message. * * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method). */ public UnsupportedSchemeException(final String message) { super(message); } } httpclient5/src/main/java/org/apache/hc/client5/http/UserTokenHandler.java0100644 0000000 0000000 00000006021 00000250600 025465 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * A handler for determining if the given execution context is user specific * or not. The token object returned by this handler is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if the context does not contain any resources or details * specific to the current user. *

* The user token will be used to ensure that user specific resources will not * be shared with or reused by other users. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface UserTokenHandler { /** * The token object returned by this method is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if it is not. * * @param route HTTP route * @param context the execution context * * @return user token that uniquely identifies the user or * {@code null} if the context is not user specific. */ Object getUserToken(HttpRoute route, HttpContext context); /** * The token object returned by this method is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if it is not. * * @param route HTTP route * @param request HTTP request * @param context the execution context * * @return user token that uniquely identifies the user or * {@code null} if the context is not user specific. * * @since 5.2 */ default Object getUserToken(HttpRoute route, HttpRequest request, HttpContext context) { return getUserToken(route, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/package-info.java0100644 0000000 0000000 00000002604 00000250600 024577 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client component APIs common to all client transports * such as connection route information and resolution * as well as common HTTP method definitions and * exception classes. */ package org.apache.hc.client5.http; httpclient5/src/main/java/org/apache/hc/client5/http/async/0040755 0000000 0000000 00000000000 00000250600 022526 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecCallback.java0100644 0000000 0000000 00000006337 00000250600 026676 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncDataConsumer; /** * AsyncExecCallback methods represent response processing events * in the client side request execution chain. * * @since 5.0 */ public interface AsyncExecCallback { /** * Triggered to signal receipt of a response message head sent by the server * in response to the request being executed. * * @param response the response message head. * @param entityDetails the response entity details or {@code null} if the response * does not enclose an entity. * @return the data consumer to be used for processing of incoming response message body. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ AsyncDataConsumer handleResponse( HttpResponse response, EntityDetails entityDetails) throws HttpException, IOException; /** * Triggered to signal receipt of an intermediate response message. * * @param response the intermediate response message. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ void handleInformationResponse(HttpResponse response) throws HttpException, IOException; /** * Triggered to signal completion of the message exchange. *

* Implementations of this message are expected to perform resource deallocation * allocated in the course of the request execution and response processing. *

*/ void completed(); /** * Triggered to signal a failure occurred during the message exchange. *

* Implementations of this message are expected to perform resource deallocation * allocated in the course of the request execution and response processing. *

*/ void failed(Exception cause); } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecChain.java0100644 0000000 0000000 00000015553 00000250600 026224 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Represents a single element in the client side asynchronous request execution chain. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface AsyncExecChain { /** * Request execution scope that includes the unique message exchange ID, * the connection route, the original request message, the execution * context and the internal execution runtime. */ final class Scope { public final String exchangeId; public final HttpRoute route; public final HttpRequest originalRequest; public final CancellableDependency cancellableDependency; public final HttpClientContext clientContext; public final AsyncExecRuntime execRuntime; public final Scheduler scheduler; public final AtomicInteger execCount; /** * @since 5.1 */ public Scope( final String exchangeId, final HttpRoute route, final HttpRequest originalRequest, final CancellableDependency cancellableDependency, final HttpClientContext clientContext, final AsyncExecRuntime execRuntime, final Scheduler scheduler, final AtomicInteger execCount) { this.exchangeId = Args.notBlank(exchangeId, "Exchange id"); this.route = Args.notNull(route, "Route"); this.originalRequest = Args.notNull(originalRequest, "Original request"); this.cancellableDependency = Args.notNull(cancellableDependency, "Dependency"); this.clientContext = Args.notNull(clientContext, "HTTP context"); this.execRuntime = Args.notNull(execRuntime, "Exec runtime"); this.scheduler = scheduler; this.execCount = execCount != null ? execCount : new AtomicInteger(1); } /** * @deprecated Use {@link Scope#Scope(String, HttpRoute, HttpRequest, CancellableDependency, HttpClientContext, * AsyncExecRuntime, Scheduler, AtomicInteger)} */ @Deprecated public Scope( final String exchangeId, final HttpRoute route, final HttpRequest originalRequest, final CancellableDependency cancellableDependency, final HttpClientContext clientContext, final AsyncExecRuntime execRuntime) { this(exchangeId, route, originalRequest, cancellableDependency, clientContext, execRuntime, null, new AtomicInteger(1)); } } /** * Request execution scheduler * * @since 5.1 */ interface Scheduler { /** * Schedules request re-execution immediately or after a delay. * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope. * @param asyncExecCallback the execution callback. * @param delay re-execution delay. Can be {@code null} if the request is to be * re-executed immediately. */ void scheduleExecution( HttpRequest request, AsyncEntityProducer entityProducer, AsyncExecChain.Scope scope, AsyncExecCallback asyncExecCallback, TimeValue delay); /** * Schedules request re-execution of the given execution chain immediately or * after a delay. * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope. * @param chain the execution chain. * @param asyncExecCallback the execution callback. * @param delay re-execution delay. Can be {@code null} if the request is to be * re-executed immediately. * * @since 5.3 */ @Internal default void scheduleExecution( HttpRequest request, AsyncEntityProducer entityProducer, AsyncExecChain.Scope scope, AsyncExecChain chain, AsyncExecCallback asyncExecCallback, TimeValue delay) { scheduleExecution(request, entityProducer, scope, asyncExecCallback, delay); } } /** * Proceeds to the next element in the request execution chain. * * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope . * @param asyncExecCallback the execution callback. */ void proceed( HttpRequest request, AsyncEntityProducer entityProducer, Scope scope, AsyncExecCallback asyncExecCallback) throws HttpException, IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecChainHandler.java0100644 0000000 0000000 00000007325 00000250600 027520 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.AsyncHttpRequestRetryExec; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; /** * Abstract request execution handler in an asynchronous client side request execution * chain. Handlers can either be a decorator around another element that implements * a cross cutting aspect or a self-contained executor capable of producing a response * for the given request. *

* For information regarding the handler chain behaviour in case of a request re-execution, * please refer to the {@link AsyncHttpRequestRetryExec} javadoc. *

*

* Well known request execution handlers could be referred to by name using one of the * {@link ChainElement} enum values. *

* @since 5.0 * @see ChainElement * @see HttpAsyncClientBuilder#addExecInterceptorFirst(String, AsyncExecChainHandler) * @see HttpAsyncClientBuilder#addExecInterceptorBefore(String, String, AsyncExecChainHandler) * @see HttpAsyncClientBuilder#addExecInterceptorAfter(String, String, AsyncExecChainHandler) * @see HttpAsyncClientBuilder#addExecInterceptorLast(String, AsyncExecChainHandler) */ @Contract(threading = ThreadingBehavior.STATELESS) public interface AsyncExecChainHandler { /** * Executes the actual HTTP request. The handler can choose to return * a response message immediately inside the call or asynchronously * at some later point or delegate request execution to the next * element in the execution chain. * * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope . * @param chain the next element in the request execution chain. * @param asyncExecCallback the execution callback. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ void execute( HttpRequest request, AsyncEntityProducer entityProducer, AsyncExecChain.Scope scope, AsyncExecChain chain, AsyncExecCallback asyncExecCallback) throws HttpException, IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecRuntime.java0100644 0000000 0000000 00000014305 00000250600 026617 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.util.TimeValue; /** * Execution runtime that provides access to the underlying connection endpoint and helps * manager its life cycle. *

* This interface is considered internal and generally ought not be used or accessed * by custom request exec handlers. *

* * @since 5.0 */ @Internal public interface AsyncExecRuntime { /** * Determines of a connection endpoint has been acquired. * * @return {@code true} if an endpoint has been acquired, {@code false} otherwise. */ boolean isEndpointAcquired(); /** * Initiates operation to acquire a connection endpoint. Endpoints can leased from a pool * or unconnected new endpoint can be created. * * @param id unique operation ID or {@code null}. * @param route the connection route. * @param state the expected connection state. May be {@code null} if connection * can be state-less or its state is irrelevant. * @param context the execution context. * @param callback the result callback. * @return handle that can be used to cancel the operation. */ Cancellable acquireEndpoint( String id, HttpRoute route, Object state, HttpClientContext context, FutureCallback callback); /** * Releases the acquired endpoint potentially making it available for re-use. */ void releaseEndpoint(); /** * Shuts down and discards the acquired endpoint. */ void discardEndpoint(); /** * Determines of there the endpoint is connected to the initial hop (connection target * in case of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @return {@code true} if the endpoint is connected, {@code false} otherwise. */ boolean isEndpointConnected(); /** * Initiates operation to connect the local endpoint to the initial hop (connection * target in case of a direct route or to the first proxy hop in case of a route * via a proxy or multiple proxies). * * @param context the execution context. * @param callback the result callback. * @return handle that can be used to cancel the operation. */ Cancellable connectEndpoint( HttpClientContext context, FutureCallback callback); /** * Disconnects the local endpoint from the initial hop in the connection route. */ void disconnectEndpoint(); /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. */ void upgradeTls(HttpClientContext context); /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. * * @since 5.2 */ default void upgradeTls(HttpClientContext context, FutureCallback callback) { upgradeTls(context); if (callback != null) { callback.completed(this); } } /** * Gets information about the underlying endpoint when connected or {@code null} otherwise. * * @return the underlying endpoint or {@code null} */ default EndpointInfo getEndpointInfo() { return null; } /** * Validates the connection making sure it can be used to execute requests. * * @return {@code true} if the connection is valid, {@code false}. */ boolean validateConnection(); /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the client message handler. * @param context the execution context. */ Cancellable execute( String id, AsyncClientExchangeHandler exchangeHandler, HttpClientContext context); /** * Marks the connection as potentially re-usable for the given period of time * and also marks it as stateful if the state representation is given. * @param state the connection state representation or {@code null} if stateless. * @param validityTime the period of time this connection is valid for. */ void markConnectionReusable(Object state, TimeValue validityTime); /** * Marks the connection as non re-usable. */ void markConnectionNonReusable(); /** * Forks this runtime for parallel execution. * * @return another runtime with the same configuration. */ AsyncExecRuntime fork(); } httpclient5/src/main/java/org/apache/hc/client5/http/async/HttpAsyncClient.java0100644 0000000 0000000 00000006270 00000250600 026447 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.util.concurrent.Future; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents only the most basic contract for HTTP request * execution. It imposes no restrictions or particular details on the request * execution process and leaves the specifics of state management, * authentication and redirect handling up to individual implementations. * * @since 4.0 */ public interface HttpAsyncClient { /** * Initiates asynchronous HTTP request execution using the given context. *

* The request producer passed to this method will be used to generate * a request message and stream out its content without buffering it * in memory. The response consumer passed to this method will be used * to process a response message without buffering its content in memory. *

* Please note it may be unsafe to interact with the context instance * while the request is still being executed. * * @param the result type of request execution. * @param requestProducer request producer callback. * @param responseConsumer response consumer callback. * @param pushHandlerFactory the push handler factory. Optional and may be {@code null}. * @param context HTTP context. Optional and may be {@code null}. * @param callback future callback. Optional and may be {@code null}. * @return future representing pending completion of the operation. */ Future execute( AsyncRequestProducer requestProducer, AsyncResponseConsumer responseConsumer, HandlerFactory pushHandlerFactory, HttpContext context, FutureCallback callback); } httpclient5/src/main/java/org/apache/hc/client5/http/async/package-info.java0100644 0000000 0000000 00000002432 00000250600 025713 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client APIs based on the asynchronous, event driven I/O model. */ package org.apache.hc.client5.http.async; httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/0040755 0000000 0000000 00000000000 00000250600 024171 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractBinPushConsumer.java0100644 0000000 0000000 00000006503 00000250600 031605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract push response consumer that processes response body data as an octet stream. * * @since 5.0 */ public abstract class AbstractBinPushConsumer extends AbstractBinDataConsumer implements AsyncPushConsumer { /** * Triggered to signal the beginning of response processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException; @Override public final void consumePromise( final HttpRequest promise, final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_BINARY); } else { start(promise, response, null); completed(); } } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractBinResponseConsumer.java0100644 0000000 0000000 00000007656 00000250600 032476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract response consumer that processes response body data as an octet stream. * * @since 5.0 * * @param response message representation. */ public abstract class AbstractBinResponseConsumer extends AbstractBinDataConsumer implements AsyncResponseConsumer { private volatile FutureCallback resultCallback; /** * Triggered to signal the beginning of response processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpResponse response, ContentType contentType) throws HttpException, IOException; /** * Triggered to generate object that represents a result of response message processing. * * @return the result of response processing. */ protected abstract T buildResult(); @Override public void informationResponse( final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public final void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context, final FutureCallback resultCallback) throws HttpException, IOException { this.resultCallback = resultCallback; if (entityDetails != null) { try { final ContentType contentType = ContentType.parse(entityDetails.getContentType()); start(response, contentType != null ? contentType : ContentType.DEFAULT_BINARY); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } } else { start(response, null); completed(); } } @Override protected final void completed() { resultCallback.completed(buildResult()); } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharPushConsumer.java0100644 0000000 0000000 00000010217 00000250600 031747 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract push response consumer that processes response body data as a character stream. * * @since 5.0 */ public abstract class AbstractCharPushConsumer extends AbstractCharDataConsumer implements AsyncPushConsumer { private final Charset defaultCharset; public AbstractCharPushConsumer() { this.defaultCharset = StandardCharsets.UTF_8; } protected AbstractCharPushConsumer(final int bufSize, final CharCodingConfig charCodingConfig) { super(bufSize, charCodingConfig); this.defaultCharset = charCodingConfig != null && charCodingConfig.getCharset() != null ? charCodingConfig.getCharset() : StandardCharsets.UTF_8; } /** * Triggered to signal the beginning of data processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException; @Override public final void consumePromise( final HttpRequest promise, final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } Charset charset = contentType != null ? contentType.getCharset() : null; if (charset == null) { charset = defaultCharset; } setCharset(charset); start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_TEXT); } else { start(promise, response, null); completed(); } } @Override public void failed(final Exception cause) { } }././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharResponseConsumer.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharResponseConsumer.java0100644 0000000 0000000 00000011477 00000250600 032637 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract response consumer that processes response body data as a character stream. * * @since 5.0 * * @param response message representation. */ public abstract class AbstractCharResponseConsumer extends AbstractCharDataConsumer implements AsyncResponseConsumer { private volatile FutureCallback resultCallback; private final Charset defaultCharset; public AbstractCharResponseConsumer() { this.defaultCharset = StandardCharsets.UTF_8; } protected AbstractCharResponseConsumer(final int bufSize, final CharCodingConfig charCodingConfig) { super(bufSize, charCodingConfig); this.defaultCharset = charCodingConfig != null && charCodingConfig.getCharset() != null ? charCodingConfig.getCharset() : StandardCharsets.UTF_8; } /** * Triggered to signal the beginning of data processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpResponse response, ContentType contentType) throws HttpException, IOException; /** * Triggered to generate object that represents a result of response message processing. * * @return the result of response processing. */ protected abstract T buildResult() throws IOException; @Override public void informationResponse( final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public final void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context, final FutureCallback resultCallback) throws HttpException, IOException { this.resultCallback = resultCallback; if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } Charset charset = contentType != null ? contentType.getCharset() : null; if (charset == null) { charset = defaultCharset; } setCharset(charset); start(response, contentType != null ? contentType : ContentType.DEFAULT_TEXT); } else { start(response, null); completed(); } } @Override protected final void completed() throws IOException { resultCallback.completed(buildResult()); } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/BasicHttpRequests.java0100644 0000000 0000000 00000023556 00000250600 030461 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHttpRequest; /** * Common HTTP methods using {@link BasicHttpRequest} as a HTTP request message representation. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.support.BasicRequestBuilder}. */ @Deprecated public final class BasicHttpRequests { /** * Creates a new BasicHttpRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @return A new BasicHttpRequest. */ public static BasicHttpRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new BasicHttpRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @return A new BasicHttpRequest. */ public static BasicHttpRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final String uri) { return delete(URI.create(uri)); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final URI uri) { return create(Method.DELETE, uri); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final HttpHost host, final String path) { return create(Method.DELETE, host, path); } /** * Creates a new GET {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final String uri) { return get(URI.create(uri)); } /** * Creates a new GET {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final URI uri) { return create(Method.GET, uri); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final HttpHost host, final String path) { return create(Method.GET, host, path); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final String uri) { return head(URI.create(uri)); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final URI uri) { return create(Method.HEAD, uri); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final HttpHost host, final String path) { return create(Method.HEAD, host, path); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final String uri) { return options(URI.create(uri)); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final URI uri) { return create(Method.OPTIONS, uri); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final HttpHost host, final String path) { return create(Method.OPTIONS, host, path); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final String uri) { return patch(URI.create(uri)); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final URI uri) { return create(Method.PATCH, uri); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final HttpHost host, final String path) { return create(Method.PATCH, host, path); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final String uri) { return post(URI.create(uri)); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final URI uri) { return create(Method.POST, uri); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final HttpHost host, final String path) { return create(Method.POST, host, path); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final String uri) { return put(URI.create(uri)); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final URI uri) { return create(Method.PUT, uri); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final HttpHost host, final String path) { return create(Method.PUT, host, path); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final String uri) { return trace(URI.create(uri)); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final URI uri) { return create(Method.TRACE, uri); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final HttpHost host, final String path) { return create(Method.TRACE, host, path); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI String. * @return a new BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final URI uri) { return new BasicHttpRequest(method, uri); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param host HTTP host. * @param path request path. * @return a new subclass of BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final HttpHost host, final String path) { return new BasicHttpRequest(method, host, path); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/ConfigurableHttpRequest.java0100644 0000000 0000000 00000006716 00000250600 031654 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.net.URIAuthority; /** * HTTP request message with a custom configuration. * * @since 5.0 */ public class ConfigurableHttpRequest extends BasicHttpRequest implements Configurable { private static final long serialVersionUID = 1L; private RequestConfig requestConfig; /** * Constructs a new request message with the given method and request path. * * @param method request method. * @param path request path. */ public ConfigurableHttpRequest(final String method, final String path) { super(method, path); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. */ public ConfigurableHttpRequest(final String method, final HttpHost host, final String path) { super(method, host, path); } /** * Constructs a new request message with the given method, scheme, authority, and request path. * * @param method request method. * @param scheme request host. * @param authority request URI authority. * @param path request path. * @since 5.1 */ public ConfigurableHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path) { super(method, scheme, authority, path); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public ConfigurableHttpRequest(final String method, final URI requestUri) { super(method, requestUri); } @Override public RequestConfig getConfig() { return requestConfig; } /** * Sets the request configuration. * * @param requestConfig the request configuration. */ public void setConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingAsyncEntityProducer.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingAsyncEntityProducer.java0100644 0000000 0000000 00000016554 00000250600 032640 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.Collections; import java.util.List; import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import java.util.zip.Deflater; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.util.Args; /** * {@code AsyncEntityProducer} that streams the output of another producer * through the raw DEFLATE compression algorithm. * *

The delegate’s bytes are read in small chunks, compressed with * {@link java.util.zip.Deflater} and written immediately to the HTTP I/O * layer. Memory use is therefore bounded even for very large request * entities.

* * @since 5.6 */ public final class DeflatingAsyncEntityProducer implements AsyncEntityProducer { /** * inbound copy‐buffer */ private static final int IN_BUF = 8 * 1024; /** * outbound staging buffer */ private static final int OUT_BUF = 8 * 1024; private final AsyncEntityProducer delegate; private final String contentType; private final Deflater deflater = new Deflater(Deflater.DEFAULT_COMPRESSION, /*nowrap=*/true); /** * holds compressed bytes not yet sent downstream */ private final ByteBuffer pending = ByteBuffer.allocate(OUT_BUF); private final byte[] in = new byte[IN_BUF]; private final AtomicBoolean delegateEnded = new AtomicBoolean(false); private boolean finished = false; public DeflatingAsyncEntityProducer(final AsyncEntityProducer delegate) { this.delegate = Args.notNull(delegate, "delegate"); this.contentType = delegate.getContentType(); /* place pending into “read-mode” with no data */ pending.flip(); } // ------------------------------------------------------------------ metadata @Override public boolean isRepeatable() { return false; } @Override public long getContentLength() { return -1; } // unknown @Override public String getContentType() { return contentType; } @Override public String getContentEncoding() { return "deflate"; } @Override public boolean isChunked() { return true; } @Override public Set getTrailerNames() { return Collections.emptySet(); } @Override public int available() { if (pending.hasRemaining()) { return pending.remaining(); } return delegate.available(); } // ------------------------------------------------------------------ core @Override public void produce(final DataStreamChannel channel) throws IOException { /* 1 — flush any leftover compressed bytes first */ if (flushPending(channel)) { return; // back-pressure: outer channel could not accept more } /* 2 — pull more data from delegate */ delegate.produce(new InnerChannel(channel)); /* 3 — if delegate ended, finish the deflater */ if (delegateEnded.get() && !finished) { deflater.finish(); deflateToPending(); flushPending(channel); if (!pending.hasRemaining()) { finished = true; channel.endStream(); } } } /** * copy as much as possible from {@link #pending} to the wire */ private boolean flushPending(final DataStreamChannel ch) throws IOException { while (pending.hasRemaining()) { final int written = ch.write(pending); if (written == 0) { return true; // back-pressure } } pending.clear().flip(); // no data left → empty read-mode return false; } /** * drain {@link #deflater} into {@link #pending} */ private void deflateToPending() { /* switch pending to write-mode */ pending.compact(); final byte[] out = pending.array(); int total; do { total = deflater.deflate(out, pending.position(), pending.remaining(), Deflater.NO_FLUSH); pending.position(pending.position() + total); if (!pending.hasRemaining() && total > 0) { /* buffer full: grow to the next power of two */ final ByteBuffer bigger = ByteBuffer.allocate(pending.capacity() * 2); pending.flip(); bigger.put(pending); pending.clear(); pending.put(bigger); } } while (total > 0); pending.flip(); // back to read-mode } // ------------------------------------------------------------------ inner channel that receives raw bytes private final class InnerChannel implements DataStreamChannel { private final DataStreamChannel outer; InnerChannel(final DataStreamChannel outer) { this.outer = outer; } @Override public void requestOutput() { outer.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { int consumed = 0; while (src.hasRemaining()) { final int chunk = Math.min(src.remaining(), in.length); src.get(in, 0, chunk); deflater.setInput(in, 0, chunk); consumed += chunk; deflateToPending(); if (flushPending(outer)) { // honour back-pressure break; } } return consumed; } @Override public void endStream() { delegateEnded.set(true); } @Override public void endStream(final List trailers) { endStream(); } } // ------------------------------------------------------------------ error / cleanup @Override public void failed(final Exception cause) { delegate.failed(cause); } @Override public void releaseResources() { delegate.releaseResources(); deflater.end(); } } ././@LongLink0100644 0000000 0000000 00000000146 00000250600 011612 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingBrotliEntityProducer.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingBrotliEntityProducer.jav0100644 0000000 0000000 00000023723 00000250600 032651 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.Collections; import java.util.List; import java.util.Set; import com.aayushatharva.brotli4j.encoder.Encoder; import com.aayushatharva.brotli4j.encoder.EncoderJNI; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.util.Args; /** * {@code AsyncEntityProducer} that Brotli-compresses bytes from an upstream producer * on the fly and writes the compressed stream to the target {@link DataStreamChannel}. *

* Purely async/streaming: no {@code InputStream}/{@code OutputStream}. Back-pressure is * honored via {@link #available()} and the I/O reactor’s calls into {@link #produce(DataStreamChannel)}. * Trailers from the upstream producer are preserved and emitted once the compressed output * has been fully drained. *

* *

Content metadata

* Returns {@code Content-Encoding: br}, {@code Content-Length: -1} and {@code chunked=true}. * Repeatability matches the upstream producer. * *

Implementation notes

* Uses Brotli4j’s {@code EncoderJNI.Wrapper}. JNI-owned output buffers are written directly * when possible; if the channel applies back-pressure, the unwritten tail is copied into * small pooled direct {@link java.nio.ByteBuffer}s to reduce allocation churn. Native * resources are released in {@link #releaseResources()}. *

* Ensure {@link com.aayushatharva.brotli4j.Brotli4jLoader#ensureAvailability()} has been * called once at startup; this class also invokes it in a static initializer as a safeguard. *

* * @see org.apache.hc.core5.http.nio.AsyncEntityProducer * @see org.apache.hc.core5.http.nio.DataStreamChannel * @see com.aayushatharva.brotli4j.encoder.EncoderJNI * @since 5.6 */ public final class DeflatingBrotliEntityProducer implements AsyncEntityProducer { private enum State { STREAMING, FINISHING, DONE } private final AsyncEntityProducer upstream; private final EncoderJNI.Wrapper encoder; private ByteBuffer pendingOut; private List pendingTrailers; private State state = State.STREAMING; /** * Create a producer with explicit Brotli params. * * @param upstream upstream entity producer whose bytes will be compressed * @param quality Brotli quality level (see brotli4j documentation) * @param lgwin Brotli window size log2 (see brotli4j documentation) * @param mode Brotli mode hint (GENERIC/TEXT/FONT) * @throws IOException if the native encoder cannot be created * @since 5.6 */ public DeflatingBrotliEntityProducer( final AsyncEntityProducer upstream, final int quality, final int lgwin, final Encoder.Mode mode) throws IOException { this.upstream = Args.notNull(upstream, "upstream"); this.encoder = new EncoderJNI.Wrapper(256 * 1024, quality, lgwin, mode); } /** * Convenience constructor mapping {@code 0=GENERIC, 1=TEXT, 2=FONT}. * * @since 5.6 */ public DeflatingBrotliEntityProducer( final AsyncEntityProducer upstream, final int quality, final int lgwin, final int modeInt) throws IOException { this(upstream, quality, lgwin, modeInt == 1 ? Encoder.Mode.TEXT : modeInt == 2 ? Encoder.Mode.FONT : Encoder.Mode.GENERIC); } /** * Create a producer with sensible defaults ({@code quality=5}, {@code lgwin=22}, {@code GENERIC}). * * @since 5.6 */ public DeflatingBrotliEntityProducer(final AsyncEntityProducer upstream) throws IOException { this(upstream, 5, 22, Encoder.Mode.GENERIC); } @Override public String getContentType() { return upstream.getContentType(); } @Override public String getContentEncoding() { return "br"; } @Override public long getContentLength() { return -1; } @Override public boolean isChunked() { return true; } @Override public Set getTrailerNames() { return upstream.getTrailerNames(); } @Override public boolean isRepeatable() { return upstream.isRepeatable(); } @Override public int available() { if (state == State.DONE) { return 0; } if (pendingOut != null && pendingOut.hasRemaining() || pendingTrailers != null) { return 1; } final int up = upstream.available(); return (state != State.STREAMING || up > 0) ? 1 : 0; } @Override public void produce(final DataStreamChannel channel) throws IOException { if (flushPending(channel)) { return; } if (state == State.FINISHING) { encoder.push(EncoderJNI.Operation.FINISH, 0); if (drainEncoder(channel)) { return; } if (pendingTrailers == null) { pendingTrailers = Collections.emptyList(); } channel.endStream(pendingTrailers); pendingTrailers = null; state = State.DONE; return; } upstream.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { int accepted = 0; while (src.hasRemaining()) { final ByteBuffer in = encoder.getInputBuffer(); if (!in.hasRemaining()) { encoder.push(EncoderJNI.Operation.PROCESS, 0); if (drainEncoder(channel)) { break; } continue; } final int xfer = Math.min(src.remaining(), in.remaining()); final int lim = src.limit(); src.limit(src.position() + xfer); in.put(src); src.limit(lim); accepted += xfer; encoder.push(EncoderJNI.Operation.PROCESS, xfer); if (drainEncoder(channel)) { break; } } return accepted; } @Override public void endStream() throws IOException { endStream(Collections.emptyList()); } @Override public void endStream(final List trailers) throws IOException { pendingTrailers = trailers; state = State.FINISHING; encoder.push(EncoderJNI.Operation.FINISH, 0); if (drainEncoder(channel)) { return; } if (pendingTrailers == null) { pendingTrailers = Collections.emptyList(); } channel.endStream(pendingTrailers); pendingTrailers = null; state = State.DONE; } }); } @Override public void failed(final Exception cause) { upstream.failed(cause); } @Override public void releaseResources() { try { encoder.destroy(); } catch (final Throwable ignore) { } upstream.releaseResources(); pendingOut = null; pendingTrailers = null; state = State.DONE; } private boolean flushPending(final DataStreamChannel channel) throws IOException { if (pendingOut != null && pendingOut.hasRemaining()) { channel.write(pendingOut); if (pendingOut.hasRemaining()) { channel.requestOutput(); return true; } pendingOut = null; } if (pendingOut == null && pendingTrailers != null && state != State.STREAMING) { channel.endStream(pendingTrailers); pendingTrailers = null; state = State.DONE; return true; } return false; } private boolean drainEncoder(final DataStreamChannel channel) throws IOException { while (encoder.hasMoreOutput()) { final ByteBuffer buf = encoder.pull(); if (buf == null || !buf.hasRemaining()) { continue; } channel.write(buf); if (buf.hasRemaining()) { pendingOut = ByteBuffer.allocateDirect(buf.remaining()); pendingOut.put(buf).flip(); channel.requestOutput(); return true; } } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingGzipEntityProducer.java0100644 0000000 0000000 00000017470 00000250600 032472 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.Collections; import java.util.List; import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import java.util.zip.CRC32; import java.util.zip.Deflater; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.util.Args; /** * Streams an {@link AsyncEntityProducer} through raw DEFLATE * and wraps the result in a valid GZIP container. *

* Memory usage is bounded (8 KiB buffers) and back-pressure * from the I/O reactor is honoured. * * @since 5.6 */ public final class DeflatingGzipEntityProducer implements AsyncEntityProducer { /* ---------------- constants & buffers --------------------------- */ private static final int IN_BUF = 8 * 1024; private static final int OUT_BUF = 8 * 1024; private final AsyncEntityProducer delegate; private final CRC32 crc = new CRC32(); private final Deflater deflater = new Deflater(Deflater.DEFAULT_COMPRESSION, true); private final byte[] in = new byte[IN_BUF]; private final ByteBuffer outBuf = ByteBuffer.allocate(OUT_BUF); private boolean headerSent = false; private boolean finished = false; private long uncompressed = 0; private final AtomicBoolean released = new AtomicBoolean(false); public DeflatingGzipEntityProducer(final AsyncEntityProducer delegate) { this.delegate = Args.notNull(delegate, "delegate"); outBuf.flip(); // start in “read mode” with no data } /* ------------------- metadata ------------------- */ @Override public boolean isRepeatable() { return delegate.isRepeatable(); } @Override public long getContentLength() { return -1; } // unknown @Override public String getContentType() { return delegate.getContentType(); } @Override public String getContentEncoding() { return "gzip"; } @Override public boolean isChunked() { return true; } @Override public Set getTrailerNames() { return Collections.emptySet(); } @Override public int available() { return outBuf.hasRemaining() ? outBuf.remaining() : delegate.available(); } /* ------------------- core ----------------------- */ @Override public void produce(final DataStreamChannel chan) throws IOException { flushOut(chan); // 1) flush any pending data if (finished) { return; // already done } delegate.produce(new InnerChannel(chan)); // 2) pull more input /* 3) when delegate is done → finish deflater, drain, trailer */ if (delegate.available() == 0 && !finished) { deflater.finish(); // signal EOF to compressor while (!deflater.finished()) { // drain *everything* deflateToOut(); flushOut(chan); } /* ---------------- little-endian trailer ---------------- */ final int crcVal = (int) crc.getValue(); final int size = (int) uncompressed; final byte[] trailer = { (byte) crcVal, (byte) (crcVal >>> 8), (byte) (crcVal >>> 16), (byte) (crcVal >>> 24), (byte) size, (byte) (size >>> 8), (byte) (size >>> 16), (byte) (size >>> 24) }; chan.write(ByteBuffer.wrap(trailer)); finished = true; chan.endStream(); } } /* copy all currently available bytes from deflater into outBuf */ private void deflateToOut() { outBuf.compact(); // switch to “write mode” byte[] arr = outBuf.array(); int pos = outBuf.position(); int lim = outBuf.limit(); int n; while ((n = deflater.deflate(arr, pos, lim - pos, Deflater.NO_FLUSH)) > 0) { pos += n; if (pos == lim) { // buffer full → grow 2× final ByteBuffer bigger = ByteBuffer.allocate(arr.length * 2); outBuf.flip(); bigger.put(outBuf); outBuf.clear(); outBuf.put(bigger); arr = outBuf.array(); lim = outBuf.limit(); pos = outBuf.position(); } } outBuf.position(pos); outBuf.flip(); // back to “read mode” } /* send as much of outBuf as the channel will accept */ private void flushOut(final DataStreamChannel chan) throws IOException { while (outBuf.hasRemaining()) { final int written = chan.write(outBuf); if (written == 0) { break; // back-pressure } } } /* --------------- inner channel feeding deflater ---------------- */ private final class InnerChannel implements DataStreamChannel { private final DataStreamChannel chan; InnerChannel(final DataStreamChannel chan) { this.chan = chan; } @Override public void requestOutput() { chan.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { if (!headerSent) { // write 10-byte GZIP header chan.write(ByteBuffer.wrap(new byte[]{ 0x1f, (byte) 0x8b, 8, 0, 0, 0, 0, 0, 0, 0 })); headerSent = true; } int consumed = 0; while (src.hasRemaining()) { final int chunk = Math.min(src.remaining(), in.length); src.get(in, 0, chunk); crc.update(in, 0, chunk); uncompressed += chunk; deflater.setInput(in, 0, chunk); consumed += chunk; deflateToOut(); flushOut(chan); } return consumed; } @Override public void endStream() { /* delegate.available()==0 is our signal */ } @Override public void endStream(final List t) { endStream(); } } /* ---------------- failure / cleanup ---------------------------- */ @Override public void failed(final Exception cause) { delegate.failed(cause); } @Override public void releaseResources() { if (released.compareAndSet(false, true)) { deflater.end(); delegate.releaseResources(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/DeflatingZstdEntityProducer.java0100644 0000000 0000000 00000027162 00000250600 032504 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.ArrayDeque; import java.util.Collections; import java.util.Deque; import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import com.github.luben.zstd.ZstdDirectBufferCompressingStream; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.util.Args; /** * {@code AsyncEntityProducer} that compresses the bytes produced by a delegate entity * into a single Zstandard (zstd) frame * on the fly. * *

This producer wraps a {@link org.apache.hc.core5.http.nio.AsyncEntityProducer} and * performs streaming, ByteBuffer-to-ByteBuffer compression as the delegate writes to the * provided {@link org.apache.hc.core5.http.nio.DataStreamChannel}. No {@code InputStream} * is used in the client pipeline.

* *

Metadata reported by this producer:

*
    *
  • {@link #getContentEncoding()} returns {@code "zstd"}.
    • *
  • {@link #getContentLength()} returns {@code -1} (unknown after compression).
    • *
  • {@link #isChunked()} returns {@code true} (requests are typically sent chunked).
    • *
* *

Behavior

*
    *
  • Streaming & back-pressure: compressed output is staged in direct * {@link java.nio.ByteBuffer}s and written only when the channel accepts bytes. * When {@code DataStreamChannel.write(...)} returns {@code 0}, the producer pauses and * requests another output turn.
    • *
  • Finalization: after the delegate signals {@code endStream()}, this producer emits * the zstd frame epilogue and then calls {@code DataStreamChannel.endStream()}.
    • *
  • Repeatability: repeatable only if the delegate is repeatable.
    • *
  • Headers: callers are responsible for sending {@code Content-Encoding: zstd} on * the request if required by the server. Content length is not known in advance.
    • *
  • Resources: invoke {@link #releaseResources()} to free native compressor resources.
    • *
* *

Constructors

*
    *
  • {@code DeflatingZstdEntityProducer(delegate)} – uses a default compression level.
    • *
  • {@code DeflatingZstdEntityProducer(delegate, level)} – explicitly sets the zstd level.
    • *
* *

Thread-safety

*

Not thread-safe; one instance per message exchange.

* *

Runtime dependency

*

Requires {@code com.github.luben:zstd-jni} on the classpath.

* * @see org.apache.hc.client5.http.async.methods.InflatingZstdDataConsumer * @see org.apache.hc.core5.http.nio.support.BasicRequestProducer * @see org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer * @see org.apache.hc.client5.http.impl.async.ContentCompressionAsyncExec * @since 5.6 */ public final class DeflatingZstdEntityProducer implements AsyncEntityProducer { private static final int IN_BUF = 64 * 1024; private static final int OUT_BUF_DEFAULT = 128 * 1024; private final AsyncEntityProducer delegate; /** * Direct staging for heap inputs. */ private final ByteBuffer inDirect = ByteBuffer.allocateDirect(IN_BUF); /** * Pending compressed output buffers, ready to write (pos=0..limit). */ private final Deque pending = new ArrayDeque<>(); /** * Current output buffer owned by zstd; replaced when it overflows or flushes. */ private ByteBuffer outBuf; /** * Zstd compressor stream. */ private ZstdDirectBufferCompressingStream zstream; private volatile boolean upstreamEnded = false; private volatile boolean finished = false; private final AtomicBoolean released = new AtomicBoolean(false); private final int level; private final int outCap; public DeflatingZstdEntityProducer(final AsyncEntityProducer delegate) { this(delegate, 3); // default compression level } public DeflatingZstdEntityProducer(final AsyncEntityProducer delegate, final int level) { this.delegate = Args.notNull(delegate, "delegate"); this.level = level; inDirect.limit(0); // Pick a sensible out buffer size (at least the recommended size). final int rec = ZstdDirectBufferCompressingStream.recommendedOutputBufferSize(); this.outCap = Math.max(OUT_BUF_DEFAULT, rec); outBuf = ByteBuffer.allocateDirect(outCap); } @Override public boolean isRepeatable() { return delegate.isRepeatable(); } @Override public long getContentLength() { return -1; } // unknown after compression @Override public String getContentType() { return delegate.getContentType(); } @Override public String getContentEncoding() { return "zstd"; } @Override public boolean isChunked() { return true; } @Override public Set getTrailerNames() { return Collections.emptySet(); } @Override public int available() { if (!pending.isEmpty()) { final ByteBuffer head = pending.peekFirst(); return head != null ? head.remaining() : 1; } // Delegate ended but we still must write zstd frame epilogue (produced on close()). if (upstreamEnded && !finished) { // Return a positive value to keep the reactor calling produce(). return OUT_BUF_DEFAULT; } return delegate.available(); } @Override public void produce(final DataStreamChannel chan) throws IOException { ensureStreamInitialized(); // 1) flush anything already compressed if (!flushPending(chan)) { return; // back-pressure; we'll be called again } if (finished) { return; } // 2) pull more input from delegate (this will drive compression via Inner.write) delegate.produce(new Inner(chan)); // 3) If upstream ended, finish the frame and drain everything if (upstreamEnded && !finished) { try { zstream.close(); // triggers flushBuffer for remaining + frame trailer } finally { // fall through } if (!flushPending(chan)) { // trailer not fully sent yet; wait for next turn return; } finished = true; chan.endStream(); } } private void ensureStreamInitialized() throws IOException { if (zstream != null) { return; } // Create the compressor; override flushBuffer to queue full buffers. zstream = new ZstdDirectBufferCompressingStream(outBuf, level) { @Override protected ByteBuffer flushBuffer(final ByteBuffer toFlush) throws IOException { toFlush.flip(); if (toFlush.hasRemaining()) { pending.addLast(toFlush); // queue for network write } // hand a fresh direct buffer back to the compressor outBuf = ByteBuffer.allocateDirect(outCap); return outBuf; } }; } /** * Try to write as much of the pending compressed data as the channel accepts. */ private boolean flushPending(final DataStreamChannel chan) throws IOException { while (!pending.isEmpty()) { final ByteBuffer head = pending.peekFirst(); while (head.hasRemaining()) { final int n = chan.write(head); if (n == 0) { // back-pressure: ask to be called again chan.requestOutput(); return false; } } pending.removeFirst(); // this buffer fully sent } return true; } /** * Compress the bytes in {@code src} (may be heap or direct). */ private int compressFrom(final ByteBuffer src) throws IOException { final int before = src.remaining(); if (src.isDirect()) { zstream.compress(src); } else { // Stage heap → direct in chunks while (src.hasRemaining()) { inDirect.compact(); final int take = Math.min(inDirect.remaining(), src.remaining()); final int oldLimit = src.limit(); src.limit(src.position() + take); inDirect.put(src); src.limit(oldLimit); inDirect.flip(); zstream.compress(inDirect); } } // The compressor calls flushBuffer() as needed; new buffers are queued in 'pending'. return before - src.remaining(); } private final class Inner implements DataStreamChannel { private final DataStreamChannel downstream; Inner(final DataStreamChannel downstream) { this.downstream = downstream; } @Override public void requestOutput() { downstream.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { final int consumed = compressFrom(src); // Try to flush any buffers the compressor just queued if (!flushPending(downstream)) { // Not all data could be written now; ensure we get another callback downstream.requestOutput(); } return consumed; } @Override public void endStream() { upstreamEnded = true; // We will finalize and flush in the outer produce(); make sure it runs again soon. downstream.requestOutput(); } @Override public void endStream(final java.util.List trailers) { endStream(); } } @Override public void failed(final Exception cause) { delegate.failed(cause); } @Override public void releaseResources() { if (released.compareAndSet(false, true)) { try { try { if (zstream != null) { zstream.close(); } } catch (final IOException ignore) { } } finally { delegate.releaseResources(); } } } } ././@LongLink0100644 0000000 0000000 00000000156 00000250600 011613 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptionFutureCallback.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptionFutureCall0100644 0000000 0000000 00000004472 00000250600 032702 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.concurrent.FutureCallback; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * @param the future result type returned by this callback. * @since 5.2 */ public class IgnoreCompleteExceptionFutureCallback implements FutureCallback { private final FutureCallback callback; private static final Logger LOG = LoggerFactory.getLogger(IgnoreCompleteExceptionFutureCallback.class); public IgnoreCompleteExceptionFutureCallback(final FutureCallback callback) { super(); this.callback = callback; } @Override public void completed(final T result) { if (callback != null) { try { callback.completed(result); } catch (final Exception ex) { LOG.error(ex.getMessage(), ex); } } } @Override public void failed(final Exception ex) { if (callback != null) { callback.failed(ex); } } @Override public void cancelled() { if (callback != null) { callback.cancelled(); } } } ././@LongLink0100644 0000000 0000000 00000000155 00000250600 011612 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptonFutureCallback.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptonFutureCallb0100644 0000000 0000000 00000003214 00000250600 032664 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.concurrent.FutureCallback; /** * @param the future result type returned by this callback. * @deprecated Use {@link IgnoreCompleteExceptionFutureCallback} * @since 5.2 */ @Deprecated public class IgnoreCompleteExceptonFutureCallback extends IgnoreCompleteExceptionFutureCallback { public IgnoreCompleteExceptonFutureCallback(final FutureCallback callback) { super(callback); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/InflatingAsyncDataConsumer.java0100644 0000000 0000000 00000011145 00000250600 032252 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; import java.util.zip.DataFormatException; import java.util.zip.Inflater; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; /** *

Streaming, non-blocking {@link AsyncDataConsumer} that transparently * inflates a response whose {@code Content-Encoding} is {@code deflate}. * The decoded bytes are pushed straight to the wrapped downstream consumer * while honouring reactor back-pressure.

* *

The implementation understands both formats that exist “in the wild”: the * raw DEFLATE stream (RFC 1951) and the zlib-wrapped variant (RFC 1950). * If the caller does not specify which one to expect, the first two bytes of * the stream are inspected and the proper decoder is chosen automatically.

* *

No {@code InputStream}/{@code OutputStream} buffering is used; memory * footprint is bounded and suitable for very large payloads.

* * @since 5.6 */ public final class InflatingAsyncDataConsumer implements AsyncDataConsumer { private final AsyncDataConsumer downstream; private final Boolean nowrapHint; private Inflater inflater; private boolean formatChosen; private final byte[] out = new byte[8 * 1024]; private final AtomicBoolean closed = new AtomicBoolean(false); public InflatingAsyncDataConsumer( final AsyncDataConsumer downstream, final Boolean nowrapHint) { this.downstream = downstream; this.nowrapHint = nowrapHint; this.inflater = new Inflater(nowrapHint == null || nowrapHint); } @Override public void updateCapacity(final CapacityChannel ch) throws IOException { downstream.updateCapacity(ch); } @Override public void consume(final ByteBuffer src) throws IOException { if (closed.get()) { return; } if (nowrapHint == null && !formatChosen && src.remaining() >= 2) { src.mark(); final int b0 = src.get() & 0xFF; final int b1 = src.get() & 0xFF; src.reset(); final boolean zlib = b0 == 0x78 && (b1 == 0x01 || b1 == 0x5E || b1 == 0x9C || b1 == 0xDA); if (zlib) { inflater.end(); inflater = new Inflater(false); } formatChosen = true; } final byte[] in = new byte[src.remaining()]; src.get(in); inflater.setInput(in); try { int n; while ((n = inflater.inflate(out)) > 0) { downstream.consume(ByteBuffer.wrap(out, 0, n)); } if (inflater.needsDictionary()) { throw new IOException("Deflate dictionary required"); } } catch (final DataFormatException ex) { throw new IOException("Corrupt DEFLATE stream", ex); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (closed.compareAndSet(false, true)) { inflater.end(); downstream.streamEnd(trailers); } } @Override public void releaseResources() { inflater = null; downstream.releaseResources(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/InflatingBrotliDataConsumer.java0100644 0000000 0000000 00000015045 00000250600 032433 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import com.aayushatharva.brotli4j.decoder.DecoderJNI; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.util.Asserts; /** * {@code AsyncDataConsumer} that inflates a Brotli-compressed byte stream and forwards * decompressed bytes to a downstream consumer. *

* Purely async/streaming: no {@code InputStream}/{@code OutputStream}. Back-pressure from * the I/O reactor is propagated via {@link CapacityChannel}. JNI output buffers are copied * into small reusable direct {@link java.nio.ByteBuffer}s before handing them to the * downstream consumer (which may retain them). *

* *

Implementation notes

* Uses Brotli4j’s {@code DecoderJNI.Wrapper}. Native resources are released in * {@link #releaseResources()}. Throws an {@link java.io.IOException} if the stream is * truncated or corrupted. *

* Ensure {@link com.aayushatharva.brotli4j.Brotli4jLoader#ensureAvailability()} has been * called once at startup; this class also invokes it in a static initializer as a safeguard. *

* * @see org.apache.hc.core5.http.nio.AsyncDataConsumer * @see org.apache.hc.core5.http.nio.CapacityChannel * @see com.aayushatharva.brotli4j.decoder.DecoderJNI * @since 5.6 */ public final class InflatingBrotliDataConsumer implements AsyncDataConsumer { private final AsyncDataConsumer downstream; private final DecoderJNI.Wrapper decoder; private volatile CapacityChannel capacity; public InflatingBrotliDataConsumer(final AsyncDataConsumer downstream) { this.downstream = downstream; try { this.decoder = new DecoderJNI.Wrapper(8 * 1024); } catch (final IOException e) { throw new RuntimeException("Unable to initialize DecoderJNI", e); } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { this.capacity = capacityChannel; downstream.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { while (src.hasRemaining()) { final ByteBuffer in = decoder.getInputBuffer(); final int xfer = Math.min(src.remaining(), in.remaining()); if (xfer == 0) { decoder.push(0); pump(); continue; } final int lim = src.limit(); src.limit(src.position() + xfer); in.put(src); src.limit(lim); decoder.push(xfer); pump(); } final CapacityChannel ch = this.capacity; if (ch != null) { ch.update(Integer.MAX_VALUE); } } @Override public void streamEnd(final List trailers) throws IOException, HttpException { pump(); Asserts.check(decoder.getStatus() == DecoderJNI.Status.DONE || !decoder.hasOutput(), "Truncated brotli stream"); downstream.streamEnd(trailers); } @Override public void releaseResources() { try { decoder.destroy(); } catch (final Throwable ignore) { } downstream.releaseResources(); } private void pump() throws IOException { for (; ; ) { switch (decoder.getStatus()) { case OK: decoder.push(0); break; case NEEDS_MORE_OUTPUT: { // Pull a decoder-owned buffer; copy before handing off. final ByteBuffer nativeBuf = decoder.pull(); if (nativeBuf != null && nativeBuf.hasRemaining()) { final ByteBuffer copy = ByteBuffer.allocateDirect(nativeBuf.remaining()); copy.put(nativeBuf).flip(); downstream.consume(copy); } break; } case NEEDS_MORE_INPUT: if (decoder.hasOutput()) { final ByteBuffer nativeBuf = decoder.pull(); if (nativeBuf != null && nativeBuf.hasRemaining()) { final ByteBuffer copy = ByteBuffer.allocateDirect(nativeBuf.remaining()); copy.put(nativeBuf).flip(); downstream.consume(copy); break; } } return; // wait for more input case DONE: if (decoder.hasOutput()) { final ByteBuffer nativeBuf = decoder.pull(); if (nativeBuf != null && nativeBuf.hasRemaining()) { final ByteBuffer copy = ByteBuffer.allocateDirect(nativeBuf.remaining()); copy.put(nativeBuf).flip(); downstream.consume(copy); break; } } return; default: // Corrupted stream throw new IOException("Brotli stream corrupted"); } } } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/InflatingGzipDataConsumer.java0100644 0000000 0000000 00000013005 00000250600 032103 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; import java.util.zip.CRC32; import java.util.zip.DataFormatException; import java.util.zip.Inflater; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; /** * Streaming {@link AsyncDataConsumer} that inflates {@code Content-Encoding: * gzip}. It parses the GZIP header on the fly, passes the deflated body * through a {@link java.util.zip.Inflater} and verifies CRC + length trailer. * *

The implementation is fully non-blocking and honours back-pressure.

* * @since 5.6 */ public final class InflatingGzipDataConsumer implements AsyncDataConsumer { private static final int OUT = 8 * 1024; private final AsyncDataConsumer downstream; private final Inflater inflater = new Inflater(true); // raw DEFLATE private final CRC32 crc = new CRC32(); private final byte[] out = new byte[OUT]; private final ByteArrayOutputStream headerBuf = new ByteArrayOutputStream(18); private boolean headerDone = false; private final AtomicBoolean closed = new AtomicBoolean(false); public InflatingGzipDataConsumer(final AsyncDataConsumer downstream) { this.downstream = downstream; } @Override public void updateCapacity(final CapacityChannel c) throws IOException { downstream.updateCapacity(c); } @Override public void consume(final ByteBuffer src) throws IOException { if (closed.get()) return; /* ----------- parse GZIP header first ------------------------ */ if (!headerDone) { while (src.hasRemaining() && headerBuf.size() < 10) { headerBuf.write(src.get()); } if (headerBuf.size() < 10) { return; // need more } final byte[] hdr = headerBuf.toByteArray(); if (hdr[0] != 0x1f || hdr[1] != (byte) 0x8b || hdr[2] != 8) { throw new IOException("Malformed GZIP header"); } int flg = hdr[3] & 0xff; int need = 10; if ((flg & 0x04) != 0) { need += 2; // extra len (will read later) } if ((flg & 0x08) != 0) { need = Integer.MAX_VALUE; // fname – scan to 0 } if ((flg & 0x10) != 0) { need = Integer.MAX_VALUE; // fcomment – scan to 0 } if ((flg & 0x02) != 0) { need += 2; // header CRC } while (src.hasRemaining() && headerBuf.size() < need) { headerBuf.write(src.get()); if (need == Integer.MAX_VALUE && headerBuf.toByteArray()[headerBuf.size() - 1] == 0) { // zero-terminated section finished; keep reading until flags handled if (flg == 0x08 || flg == 0x10) { flg ^= flg & 0x18; // clear fname/fcomment flag } if ((flg & 0x18) == 0) { need = headerBuf.size(); // done } } } if (headerBuf.size() < need) { return; // still need more } headerDone = true; } /* ----------- body ------------------------------------------ */ final byte[] in = new byte[src.remaining()]; src.get(in); inflater.setInput(in); try { int n; while ((n = inflater.inflate(out)) > 0) { crc.update(out, 0, n); downstream.consume(ByteBuffer.wrap(out, 0, n)); } } catch (final DataFormatException ex) { throw new IOException("Corrupt GZIP stream", ex); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (closed.compareAndSet(false, true)) { inflater.end(); downstream.streamEnd(trailers); } } @Override public void releaseResources() { inflater.end(); downstream.releaseResources(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/InflatingZstdDataConsumer.java0100644 0000000 0000000 00000012343 00000250600 032122 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; import com.github.luben.zstd.ZstdDecompressCtx; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; /** * {@code AsyncDataConsumer} that inflates Zstandard (zstd) content codings. * *

This consumer accepts compressed bytes and forwards decompressed data to a downstream * {@link org.apache.hc.core5.http.nio.AsyncDataConsumer}. It is intended to be installed by the * client execution chain when a response carries {@code Content-Encoding: zstd}. Applications * normally do not instantiate it directly—enable content compression (default) and let * {@code ContentCompressionAsyncExec} wire it automatically.

* *

Behavior

*
    *
  • Streams decompression as data arrives; does not require the full message in memory.
    • *
  • Updates the downstream with plain bytes; the client removes the original * {@code Content-Encoding} and related headers.
    • *
  • On malformed input it throws an {@link java.io.IOException} with a descriptive message.
    • *
  • {@link #releaseResources()} must be called to free native resources.
    • *
* * @since 5.6 */ public final class InflatingZstdDataConsumer implements AsyncDataConsumer { private static final int IN_BUF = 64 * 1024; private static final int OUT_BUF = 128 * 1024; // ~ZSTD_DStreamOutSize(); tweak if you like. :contentReference[oaicite:3]{index=3} private final AsyncDataConsumer downstream; private final ZstdDecompressCtx dctx = new ZstdDecompressCtx(); private final ByteBuffer inDirect = ByteBuffer.allocateDirect(IN_BUF); private final ByteBuffer outDirect = ByteBuffer.allocateDirect(OUT_BUF); private final AtomicBoolean closed = new AtomicBoolean(false); public InflatingZstdDataConsumer(final AsyncDataConsumer downstream) { this.downstream = downstream; inDirect.limit(0); outDirect.limit(0); } @Override public void updateCapacity(final CapacityChannel c) throws IOException { downstream.updateCapacity(c); } @Override public void consume(final ByteBuffer src) throws IOException { if (closed.get()) { return; } // Copy any incoming bytes into the direct input buffer, draining as we go. while (src.hasRemaining()) { inDirect.compact(); final int take = Math.min(inDirect.remaining(), src.remaining()); final int oldLimit = src.limit(); src.limit(src.position() + take); inDirect.put(src); src.limit(oldLimit); inDirect.flip(); // Pull decompressed bytes until we either need more input or downstream back-pressures while (inDirect.hasRemaining()) { outDirect.compact(); // Streaming decompress: fills outDirect from inDirect; returns when either // input exhausted or output buffer full. dctx.decompressDirectByteBufferStream(outDirect, inDirect); outDirect.flip(); if (outDirect.hasRemaining()) { downstream.consume(outDirect); if (outDirect.hasRemaining()) { // downstream applied back-pressure; stop here, we’ll resume on next callback return; } } else { break; // need more input } } } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (closed.compareAndSet(false, true)) { dctx.close(); downstream.streamEnd(trailers); } } @Override public void releaseResources() { dctx.close(); downstream.releaseResources(); } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleAsyncEntityConsumer.java0100644 0000000 0000000 00000005027 00000250600 032175 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityConsumer; import org.apache.hc.core5.util.ByteArrayBuffer; final class SimpleAsyncEntityConsumer extends AbstractBinAsyncEntityConsumer { private final ByteArrayBuffer buffer; SimpleAsyncEntityConsumer() { super(); this.buffer = new ByteArrayBuffer(1024); } @Override protected void streamStart(final ContentType contentType) throws HttpException, IOException { } @Override protected int capacityIncrement() { return Integer.MAX_VALUE; } @Override protected void data(final ByteBuffer src, final boolean endOfStream) throws IOException { if (src == null) { return; } if (src.hasArray()) { buffer.append(src.array(), src.arrayOffset() + src.position(), src.remaining()); } else { while (src.hasRemaining()) { buffer.append(src.get()); } } } @Override protected byte[] generateContent() throws IOException { return buffer.toByteArray(); } @Override public void releaseResources() { buffer.clear(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleBody.java0100644 0000000 0000000 00000010330 00000250600 027075 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Message body representation as a simple text string or an array of bytes. * * @since 5.0 */ public final class SimpleBody { private final byte[] bodyAsBytes; private final String bodyAsText; private final ContentType contentType; SimpleBody(final byte[] bodyAsBytes, final String bodyAsText, final ContentType contentType) { this.bodyAsBytes = bodyAsBytes; this.bodyAsText = bodyAsText; this.contentType = contentType; } static SimpleBody create(final String body, final ContentType contentType) { Args.notNull(body, "Body"); if (body.length() > 2048) { return new SimpleBody(null, body, contentType); } final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); final byte[] bytes = body.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); return new SimpleBody(bytes, null, contentType); } static SimpleBody create(final byte[] body, final ContentType contentType) { Args.notNull(body, "Body"); return new SimpleBody(body, null, contentType); } /** * Gets the content type. * * @return the content type. */ public ContentType getContentType() { return contentType; } /** * Gets the body as a byte array. * * @return the body as a byte array. */ public byte[] getBodyBytes() { if (bodyAsBytes != null) { return bodyAsBytes; } else if (bodyAsText != null) { final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); return bodyAsText.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); } else { return null; } } /** * Gets the body as a String. * * @return the body as a String. */ public String getBodyText() { if (bodyAsBytes != null) { final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); return new String(bodyAsBytes, charset != null ? charset : StandardCharsets.US_ASCII); } return bodyAsText; } /** * Tests whether the body is currently cached as a String. * * @return whether the body is currently cached as a String. */ public boolean isText() { return bodyAsText != null; } /** * Tests whether the body is currently cached as a byte array. * * @return whether the body is currently cached as a byte array. */ public boolean isBytes() { return bodyAsBytes != null; } @Override public String toString() { return "SimpleBody{content length=" + (bodyAsBytes != null ? bodyAsBytes.length : "chunked") + ", content type=" + contentType + "}"; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleHttpRequest.java0100644 0000000 0000000 00000021152 00000250600 030474 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import java.util.Iterator; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; /** * HTTP request that can enclose a body represented as a simple text string or an array of bytes. *

* IMPORTANT: {@link SimpleHttpRequest}s are intended for simple scenarios where entities inclosed * in requests are known to be small. It is generally recommended to use * {@link org.apache.hc.core5.http.nio.support.AsyncRequestBuilder} and streaming * {@link org.apache.hc.core5.http.nio.AsyncEntityProducer}s. * * @since 5.0 * * @see SimpleBody * @see org.apache.hc.core5.http.nio.support.AsyncRequestBuilder * @see org.apache.hc.core5.http.nio.AsyncEntityProducer */ public final class SimpleHttpRequest extends ConfigurableHttpRequest { private static final long serialVersionUID = 1L; private SimpleBody body; /** * Creates a new request message with the given method and request path. * * @param method request method. * @param uri request URI. * @return a new SimpleHttpRequest. * @since 5.1 */ public static SimpleHttpRequest create(final String method, final String uri) { return new SimpleHttpRequest(method, uri); } /** * Creates a new request message with the given method and request path. * * @param method request method. * @param uri request URI. * @return a new SimpleHttpRequest. * @since 5.1 */ public static SimpleHttpRequest create(final String method, final URI uri) { return new SimpleHttpRequest(method, uri); } /** * Creates a new request message with the given method and request path. * * @param method request method. * @param uri request URI. * @return a new SimpleHttpRequest. * @since 5.1 */ public static SimpleHttpRequest create(final Method method, final URI uri) { return new SimpleHttpRequest(method, uri); } /** * Creates a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. * @return a new SimpleHttpRequest. * @since 5.1 */ public static SimpleHttpRequest create(final Method method, final HttpHost host, final String path) { return new SimpleHttpRequest(method, host, path); } /** * Creates a new request message with the given method, scheme, authority, and request path. * * @param method request method. * @param scheme request host. * @param authority request URI authority. * @param path request path. * @return a new SimpleHttpRequest. * @since 5.1 */ public static SimpleHttpRequest create(final String method, final String scheme, final URIAuthority authority, final String path) { return new SimpleHttpRequest(method, scheme, authority, path); } /** * Copies the given HttpRequest. * * @param original the source to copy. * @return a new SimpleHttpRequest. * @deprecated Use {@link SimpleRequestBuilder} */ @Deprecated public static SimpleHttpRequest copy(final HttpRequest original) { Args.notNull(original, "HTTP request"); final SimpleHttpRequest copy = new SimpleHttpRequest(original.getMethod(), original.getRequestUri()); copy.setVersion(original.getVersion()); for (final Iterator

it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); return copy; } /** * Constructs a new request message with the given method and request path. * * @param method request method. * @param path request path. */ public SimpleHttpRequest(final String method, final String path) { super(method, path); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. */ public SimpleHttpRequest(final String method, final HttpHost host, final String path) { super(method, host, path); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public SimpleHttpRequest(final String method, final URI requestUri) { super(method, requestUri); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public SimpleHttpRequest(final Method method, final URI requestUri) { this(method.name(), requestUri); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. * @since 5.1 */ public SimpleHttpRequest(final Method method, final HttpHost host, final String path) { this(method.name(), host, path); } /** * Constructs a new request message with the given method, scheme, authority, and request path. * * @param method request method. * @param scheme request host. * @param authority request URI authority. * @param path request path. * @since 5.1 */ public SimpleHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path) { super(method, scheme, authority, path); } /** * Sets the message body and content type. * * @param body request body. */ public void setBody(final SimpleBody body) { this.body = body; } /** * Sets the message body and content type. * * @param bodyBytes request body. * @param contentType request content type. */ public void setBody(final byte[] bodyBytes, final ContentType contentType) { this.body = SimpleBody.create(bodyBytes, contentType); } /** * Sets the message body and content type. * * @param bodyText request body. * @param contentType request content type. */ public void setBody(final String bodyText, final ContentType contentType) { this.body = SimpleBody.create(bodyText, contentType); } /** * Gets the request body. * * @return the request body. */ public SimpleBody getBody() { return body; } /** * Gets the request content type. * * @return the request content type. */ public ContentType getContentType() { return body != null ? body.getContentType() : null; } /** * Gets the request body as a String. * * @return the request body. */ public String getBodyText() { return body != null ? body.getBodyText() : null; } /** * Gets the request body as a byte array. * * @return the request body. */ public byte[] getBodyBytes() { return body != null ? body.getBodyBytes() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleHttpRequests.java0100644 0000000 0000000 00000014262 00000250600 030663 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; /** * Common HTTP methods using {@link SimpleHttpRequest} as a HTTP request message representation. * * @since 5.0 * * @deprecated Use {@link SimpleRequestBuilder}. */ @Deprecated public final class SimpleHttpRequests { /** * Creates a new BasicHttpRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @return A new BasicHttpRequest. */ public static SimpleHttpRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new BasicHttpRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @return A new BasicHttpRequest. */ public static SimpleHttpRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } public static SimpleHttpRequest delete(final String uri) { return delete(URI.create(uri)); } public static SimpleHttpRequest delete(final URI uri) { return create(Method.DELETE, uri); } public static SimpleHttpRequest delete(final HttpHost host, final String path) { return create(Method.DELETE, host, path); } public static SimpleHttpRequest get(final String uri) { return get(URI.create(uri)); } public static SimpleHttpRequest get(final URI uri) { return create(Method.GET, uri); } public static SimpleHttpRequest get(final HttpHost host, final String path) { return create(Method.GET, host, path); } public static SimpleHttpRequest head(final String uri) { return head(URI.create(uri)); } public static SimpleHttpRequest head(final URI uri) { return create(Method.HEAD, uri); } public static SimpleHttpRequest head(final HttpHost host, final String path) { return create(Method.HEAD, host, path); } public static SimpleHttpRequest options(final String uri) { return options(URI.create(uri)); } public static SimpleHttpRequest options(final URI uri) { return create(Method.OPTIONS, uri); } public static SimpleHttpRequest options(final HttpHost host, final String path) { return create(Method.OPTIONS, host, path); } public static SimpleHttpRequest patch(final String uri) { return patch(URI.create(uri)); } public static SimpleHttpRequest patch(final URI uri) { return create(Method.PATCH, uri); } public static SimpleHttpRequest patch(final HttpHost host, final String path) { return create(Method.PATCH, host, path); } public static SimpleHttpRequest post(final String uri) { return post(URI.create(uri)); } public static SimpleHttpRequest post(final URI uri) { return create(Method.POST, uri); } public static SimpleHttpRequest post(final HttpHost host, final String path) { return create(Method.POST, host, path); } public static SimpleHttpRequest put(final String uri) { return put(URI.create(uri)); } public static SimpleHttpRequest put(final URI uri) { return create(Method.PUT, uri); } public static SimpleHttpRequest put(final HttpHost host, final String path) { return create(Method.PUT, host, path); } public static SimpleHttpRequest trace(final String uri) { return trace(URI.create(uri)); } public static SimpleHttpRequest trace(final URI uri) { return create(Method.TRACE, uri); } public static SimpleHttpRequest trace(final HttpHost host, final String path) { return create(Method.TRACE, host, path); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param uri a non-null URI String. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final URI uri) { return new SimpleHttpRequest(method, uri); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param method a non-null HTTP method. * @param host HTTP host. * @param path request path. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final HttpHost host, final String path) { return new SimpleHttpRequest(method, host, path); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleHttpResponse.java0100644 0000000 0000000 00000011040 00000250600 030635 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.util.Iterator; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.util.Args; /** * HTTP response that can enclose a body represented as a simple text string or an array of bytes. *

* IMPORTANT: {@link SimpleHttpResponse}s are intended for simple scenarios where entities inclosed * in responses are known to be small. It is generally recommended to use streaming * {@link org.apache.hc.core5.http.nio.AsyncResponseConsumer}s, for instance, such as based on * {@link AbstractCharResponseConsumer} or {@link AbstractBinResponseConsumer}. * * @since 5.0 * * @see SimpleBody * @see AbstractCharResponseConsumer * @see AbstractBinResponseConsumer */ public final class SimpleHttpResponse extends BasicHttpResponse { private static final long serialVersionUID = 1L; private SimpleBody body; public SimpleHttpResponse(final int code) { super(code); } public SimpleHttpResponse(final int code, final String reasonPhrase) { super(code, reasonPhrase); } public static SimpleHttpResponse copy(final HttpResponse original) { Args.notNull(original, "HTTP response"); final SimpleHttpResponse copy = new SimpleHttpResponse(original.getCode()); copy.setVersion(original.getVersion()); for (final Iterator

it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } return copy; } public static SimpleHttpResponse create(final int code) { return new SimpleHttpResponse(code); } public static SimpleHttpResponse create(final int code, final String content, final ContentType contentType) { final SimpleHttpResponse response = new SimpleHttpResponse(code); if (content != null) { response.setBody(content, contentType); } return response; } public static SimpleHttpResponse create(final int code, final String content) { return create(code, content, ContentType.TEXT_PLAIN); } public static SimpleHttpResponse create(final int code, final byte[] content, final ContentType contentType) { final SimpleHttpResponse response = new SimpleHttpResponse(code); if (content != null) { response.setBody(content, contentType); } return response; } public static SimpleHttpResponse create(final int code, final byte[] content) { return create(code, content, ContentType.TEXT_PLAIN); } public void setBody(final SimpleBody body) { this.body = body; } public void setBody(final byte[] bodyBytes, final ContentType contentType) { this.body = SimpleBody.create(bodyBytes, contentType); } public void setBody(final String bodyText, final ContentType contentType) { this.body = SimpleBody.create(bodyText, contentType); } public SimpleBody getBody() { return body; } public ContentType getContentType() { return body != null ? body.getContentType() : null; } public String getBodyText() { return body != null ? body.getBodyText() : null; } public byte[] getBodyBytes() { return body != null ? body.getBodyBytes() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleRequestBuilder.java0100644 0000000 0000000 00000032150 00000250600 031143 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.Charset; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.support.AbstractRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.net.WWWFormCodec; import org.apache.hc.core5.util.Args; /** * Builder for {@link SimpleHttpRequest} instances. *

* Please note that this class treats parameters differently depending on composition * of the request: if the request has a content entity explicitly set with * {@link #setBody(SimpleBody)} or it is not an entity enclosing method * (such as POST or PUT), parameters will be added to the query component * of the request URI. Otherwise, parameters will be added as a URL encoded entity. *

* * @since 5.0 */ public class SimpleRequestBuilder extends AbstractRequestBuilder { private SimpleBody body; private RequestConfig requestConfig; SimpleRequestBuilder(final String method) { super(method); } SimpleRequestBuilder(final Method method) { super(method); } SimpleRequestBuilder(final String method, final URI uri) { super(method, uri); } SimpleRequestBuilder(final Method method, final URI uri) { super(method, uri); } SimpleRequestBuilder(final Method method, final String uri) { super(method, uri); } SimpleRequestBuilder(final String method, final String uri) { super(method, uri); } public static SimpleRequestBuilder create(final String method) { Args.notBlank(method, "HTTP method"); return new SimpleRequestBuilder(method); } public static SimpleRequestBuilder create(final Method method) { Args.notNull(method, "HTTP method"); return new SimpleRequestBuilder(method); } public static SimpleRequestBuilder get() { return new SimpleRequestBuilder(Method.GET); } public static SimpleRequestBuilder get(final URI uri) { return new SimpleRequestBuilder(Method.GET, uri); } public static SimpleRequestBuilder get(final String uri) { return new SimpleRequestBuilder(Method.GET, uri); } public static SimpleRequestBuilder head() { return new SimpleRequestBuilder(Method.HEAD); } public static SimpleRequestBuilder head(final URI uri) { return new SimpleRequestBuilder(Method.HEAD, uri); } public static SimpleRequestBuilder head(final String uri) { return new SimpleRequestBuilder(Method.HEAD, uri); } public static SimpleRequestBuilder patch() { return new SimpleRequestBuilder(Method.PATCH); } public static SimpleRequestBuilder patch(final URI uri) { return new SimpleRequestBuilder(Method.PATCH, uri); } public static SimpleRequestBuilder patch(final String uri) { return new SimpleRequestBuilder(Method.PATCH, uri); } public static SimpleRequestBuilder post() { return new SimpleRequestBuilder(Method.POST); } public static SimpleRequestBuilder post(final URI uri) { return new SimpleRequestBuilder(Method.POST, uri); } public static SimpleRequestBuilder post(final String uri) { return new SimpleRequestBuilder(Method.POST, uri); } public static SimpleRequestBuilder put() { return new SimpleRequestBuilder(Method.PUT); } public static SimpleRequestBuilder put(final URI uri) { return new SimpleRequestBuilder(Method.PUT, uri); } public static SimpleRequestBuilder put(final String uri) { return new SimpleRequestBuilder(Method.PUT, uri); } public static SimpleRequestBuilder delete() { return new SimpleRequestBuilder(Method.DELETE); } public static SimpleRequestBuilder delete(final URI uri) { return new SimpleRequestBuilder(Method.DELETE, uri); } public static SimpleRequestBuilder delete(final String uri) { return new SimpleRequestBuilder(Method.DELETE, uri); } public static SimpleRequestBuilder trace() { return new SimpleRequestBuilder(Method.TRACE); } public static SimpleRequestBuilder trace(final URI uri) { return new SimpleRequestBuilder(Method.TRACE, uri); } public static SimpleRequestBuilder trace(final String uri) { return new SimpleRequestBuilder(Method.TRACE, uri); } public static SimpleRequestBuilder options() { return new SimpleRequestBuilder(Method.OPTIONS); } public static SimpleRequestBuilder options(final URI uri) { return new SimpleRequestBuilder(Method.OPTIONS, uri); } public static SimpleRequestBuilder options(final String uri) { return new SimpleRequestBuilder(Method.OPTIONS, uri); } /** * @since 5.1 */ public static SimpleRequestBuilder copy(final SimpleHttpRequest request) { Args.notNull(request, "HTTP request"); final SimpleRequestBuilder builder = new SimpleRequestBuilder(request.getMethod()); builder.digest(request); return builder; } /** * @since 5.1 */ public static SimpleRequestBuilder copy(final HttpRequest request) { Args.notNull(request, "HTTP request"); final SimpleRequestBuilder builder = new SimpleRequestBuilder(request.getMethod()); builder.digest(request); return builder; } protected void digest(final SimpleHttpRequest request) { super.digest(request); setBody(request.getBody()); } @Override protected void digest(final HttpRequest request) { super.digest(request); } @Override public SimpleRequestBuilder setVersion(final ProtocolVersion version) { super.setVersion(version); return this; } @Override public SimpleRequestBuilder setUri(final URI uri) { super.setUri(uri); return this; } @Override public SimpleRequestBuilder setUri(final String uri) { super.setUri(uri); return this; } @Override public SimpleRequestBuilder setScheme(final String scheme) { super.setScheme(scheme); return this; } @Override public SimpleRequestBuilder setAuthority(final URIAuthority authority) { super.setAuthority(authority); return this; } @Override public SimpleRequestBuilder setHttpHost(final HttpHost httpHost) { super.setHttpHost(httpHost); return this; } @Override public SimpleRequestBuilder setPath(final String path) { super.setPath(path); return this; } @Override public SimpleRequestBuilder setHeaders(final Header... headers) { super.setHeaders(headers); return this; } @Override public SimpleRequestBuilder addHeader(final Header header) { super.addHeader(header); return this; } @Override public SimpleRequestBuilder addHeader(final String name, final String value) { super.addHeader(name, value); return this; } @Override public SimpleRequestBuilder removeHeader(final Header header) { super.removeHeader(header); return this; } @Override public SimpleRequestBuilder removeHeaders(final String name) { super.removeHeaders(name); return this; } @Override public SimpleRequestBuilder setHeader(final Header header) { super.setHeader(header); return this; } @Override public SimpleRequestBuilder setHeader(final String name, final String value) { super.setHeader(name, value); return this; } @Override public SimpleRequestBuilder setCharset(final Charset charset) { super.setCharset(charset); return this; } @Override public SimpleRequestBuilder addParameter(final NameValuePair nvp) { super.addParameter(nvp); return this; } @Override public SimpleRequestBuilder addParameter(final String name, final String value) { super.addParameter(name, value); return this; } @Override public SimpleRequestBuilder addParameters(final NameValuePair... nvps) { super.addParameters(nvps); return this; } @Override public SimpleRequestBuilder setAbsoluteRequestUri(final boolean absoluteRequestUri) { super.setAbsoluteRequestUri(absoluteRequestUri); return this; } public SimpleBody getBody() { return body; } public SimpleRequestBuilder setBody(final SimpleBody body) { this.body = body; return this; } public SimpleRequestBuilder setBody(final String content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } public SimpleRequestBuilder setBody(final byte[] content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } public RequestConfig getRequestConfig() { return requestConfig; } public SimpleRequestBuilder setRequestConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; return this; } @Override public SimpleHttpRequest build() { String path = getPath(); SimpleBody bodyCopy = this.body; final String method = getMethod(); final List parameters = getParameters(); if (parameters != null && !parameters.isEmpty()) { final Charset charsetCopy = getCharset(); if (bodyCopy == null && (Method.POST.isSame(method) || Method.PUT.isSame(method))) { final String content = WWWFormCodec.format( parameters, charsetCopy != null ? charsetCopy : ContentType.APPLICATION_FORM_URLENCODED.getCharset()); bodyCopy = SimpleBody.create(content, ContentType.APPLICATION_FORM_URLENCODED); } else { try { final URI uri = new URIBuilder(path) .setCharset(charsetCopy) .addParameters(parameters) .build(); path = uri.toASCIIString(); } catch (final URISyntaxException ex) { // should never happen } } } if (bodyCopy != null && Method.TRACE.isSame(method)) { throw new IllegalStateException(Method.TRACE + " requests may not include an entity"); } final SimpleHttpRequest result = new SimpleHttpRequest(method, getScheme(), getAuthority(), path); result.setVersion(getVersion()); result.setHeaders(getHeaders()); result.setBody(bodyCopy); result.setAbsoluteRequestUri(isAbsoluteRequestUri()); result.setConfig(requestConfig); return result; } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("ClassicRequestBuilder [method="); builder.append(getMethod()); builder.append(", scheme="); builder.append(getScheme()); builder.append(", authority="); builder.append(getAuthority()); builder.append(", path="); builder.append(getPath()); builder.append(", parameters="); builder.append(getParameters()); builder.append(", headerGroup="); builder.append(Arrays.toString(getHeaders())); builder.append(", body="); builder.append(body); builder.append("]"); return builder.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleRequestProducer.java0100644 0000000 0000000 00000006006 00000250600 031341 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.util.Args; /** * HTTP request producer that generates message data stream events based * on content of a {@link SimpleHttpRequest} instance. *

* IMPORTANT: {@link SimpleHttpRequest}s are intended for simple scenarios where entities inclosed * in requests are known to be small. It is generally recommended to use * {@link org.apache.hc.core5.http.nio.support.AsyncRequestBuilder} and streaming * {@link org.apache.hc.core5.http.nio.AsyncEntityProducer}s. * * @since 5.0 * * @see SimpleBody * @see SimpleHttpRequest * @see org.apache.hc.core5.http.nio.support.AsyncRequestBuilder * @see org.apache.hc.core5.http.nio.AsyncEntityProducer */ public final class SimpleRequestProducer extends BasicRequestProducer { SimpleRequestProducer(final SimpleHttpRequest request, final AsyncEntityProducer entityProducer) { super(request, entityProducer); } public static SimpleRequestProducer create(final SimpleHttpRequest request) { Args.notNull(request, "Request"); final SimpleBody body = request.getBody(); final AsyncEntityProducer entityProducer; if (body != null) { if (body.isText()) { entityProducer = new StringAsyncEntityProducer(body.getBodyText(), body.getContentType()); } else { entityProducer = new BasicAsyncEntityProducer(body.getBodyBytes(), body.getContentType()); } } else { entityProducer = null; } return new SimpleRequestProducer(request, entityProducer); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleResponseBuilder.java0100644 0000000 0000000 00000013071 00000250600 031312 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.util.Arrays; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.support.AbstractResponseBuilder; import org.apache.hc.core5.util.Args; /** * Builds {@link SimpleHttpResponse} instances. * * @since 5.1 */ public class SimpleResponseBuilder extends AbstractResponseBuilder { private SimpleBody body; SimpleResponseBuilder(final int status) { super(status); } /** * Creates a new SimpleResponseBuilder with the given status. * * @param status response status. * @return a new SimpleResponseBuilder. */ public static SimpleResponseBuilder create(final int status) { Args.checkRange(status, 100, 599, "HTTP status code"); return new SimpleResponseBuilder(status); } /** * Copies a source instance into a new one. * * @param response the source instance to copy. * @return a new SimpleResponseBuilder. */ public static SimpleResponseBuilder copy(final SimpleHttpResponse response) { Args.notNull(response, "HTTP response"); final SimpleResponseBuilder builder = new SimpleResponseBuilder(response.getCode()); builder.digest(response); return builder; } protected void digest(final SimpleHttpResponse response) { super.digest(response); setBody(response.getBody()); } @Override public SimpleResponseBuilder setVersion(final ProtocolVersion version) { super.setVersion(version); return this; } @Override public SimpleResponseBuilder setHeaders(final Header... headers) { super.setHeaders(headers); return this; } @Override public SimpleResponseBuilder addHeader(final Header header) { super.addHeader(header); return this; } @Override public SimpleResponseBuilder addHeader(final String name, final String value) { super.addHeader(name, value); return this; } @Override public SimpleResponseBuilder removeHeader(final Header header) { super.removeHeader(header); return this; } @Override public SimpleResponseBuilder removeHeaders(final String name) { super.removeHeaders(name); return this; } @Override public SimpleResponseBuilder setHeader(final Header header) { super.setHeader(header); return this; } @Override public SimpleResponseBuilder setHeader(final String name, final String value) { super.setHeader(name, value); return this; } /** * Gets the body. * * @return the body. */ public SimpleBody getBody() { return body; } /** * Sets the body. * * @param body the body. * @return this instance. */ public SimpleResponseBuilder setBody(final SimpleBody body) { this.body = body; return this; } /** * Sets the body. * * @param content the body content. * @param contentType the body content-type. * @return this instance. */ public SimpleResponseBuilder setBody(final String content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } /** * Sets the body. * * @param content the body content. * @param contentType the body content-type. * @return this instance. */ public SimpleResponseBuilder setBody(final byte[] content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } @Override public SimpleHttpResponse build() { final SimpleHttpResponse result = new SimpleHttpResponse(getStatus()); result.setVersion(getVersion()); result.setHeaders(getHeaders()); result.setBody(body); return result; } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("SimpleResponseBuilder [status="); builder.append(getStatus()); builder.append(", headerGroup="); builder.append(Arrays.toString(getHeaders())); builder.append(", body="); builder.append(body); builder.append("]"); return builder.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleResponseConsumer.java0100644 0000000 0000000 00000006333 00000250600 031522 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.AbstractAsyncResponseConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * HTTP response consumer that generates a {@link SimpleHttpResponse} instance based on events * of an incoming data stream. *

* IMPORTANT: {@link SimpleHttpResponse}s are intended for simple scenarios where entities inclosed * in responses are known to be small. It is generally recommended to use streaming * {@link org.apache.hc.core5.http.nio.AsyncResponseConsumer}s, for instance, such as based on * {@link AbstractCharResponseConsumer} or {@link AbstractBinResponseConsumer}. * * @since 5.0 * * @see SimpleBody * @see SimpleHttpResponse * @see AbstractCharResponseConsumer * @see AbstractBinResponseConsumer */ public final class SimpleResponseConsumer extends AbstractAsyncResponseConsumer { SimpleResponseConsumer(final AsyncEntityConsumer entityConsumer) { super(entityConsumer); } /** * Creates a new SimpleResponseConsumer instance initialized with a new {@code SimpleAsyncEntityConsumer}. * * @return a new SimpleResponseConsumer instance. */ public static SimpleResponseConsumer create() { return new SimpleResponseConsumer(new SimpleAsyncEntityConsumer()); } @Override public void informationResponse(final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override protected SimpleHttpResponse buildResult(final HttpResponse response, final byte[] entity, final ContentType contentType) { final SimpleHttpResponse simpleResponse = SimpleHttpResponse.copy(response); if (entity != null) { simpleResponse.setBody(entity, contentType); } return simpleResponse; } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/package-info.java0100644 0000000 0000000 00000002447 00000250600 027364 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Common HTTP methods and message handlers for the asynchronous I/O model. */ package org.apache.hc.client5.http.async.methods; httpclient5/src/main/java/org/apache/hc/client5/http/auth/0040755 0000000 0000000 00000000000 00000250600 022352 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthCache.java0100644 0000000 0000000 00000007265 00000250600 025051 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.HttpHost; /** * This interface represents an cache of {@link AuthScheme} state information * that can be re-used for preemptive authentication by subsequent requests. * * @since 4.1 */ public interface AuthCache { /** * Stores the authentication state with the given authentication scope in the cache. * * @param host the authentication authority. * @param authScheme the cacheable authentication state. */ void put(HttpHost host, AuthScheme authScheme); /** * Returns the authentication state with the given authentication scope from the cache * if available. * * @param host the authentication authority. * @return the authentication state ir {@code null} if not available in the cache. */ AuthScheme get(HttpHost host); /** * Removes the authentication state with the given authentication scope from the cache * if found. * * @param host the authentication authority. */ void remove(HttpHost host); void clear(); /** * Stores the authentication state with the given authentication scope in the cache. * * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * @param authScheme the cacheable authentication state. * * @since 5.2 */ default void put(HttpHost host, String pathPrefix, AuthScheme authScheme) { put(host, authScheme); } /** * Returns the authentication state with the given authentication scope from the cache * if available. * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * @return the authentication state ir {@code null} if not available in the cache. * * @since 5.2 */ default AuthScheme get(HttpHost host, String pathPrefix) { return get(host); } /** * Removes the authentication state with the given authentication scope from the cache * if found. * * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * * @since 5.2 */ default void remove(HttpHost host, String pathPrefix) { remove(host); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthChallenge.java0100644 0000000 0000000 00000006216 00000250600 025723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; /** * This class represents an authentication challenge consisting of a auth scheme * and either a single parameter or a list of name / value pairs. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class AuthChallenge { private final ChallengeType challengeType; private final String schemeName; private final String value; private final List params; public AuthChallenge(final ChallengeType challengeType, final String schemeName, final String value, final List params) { super(); this.challengeType = Args.notNull(challengeType, "Challenge type"); this.schemeName = Args.notNull(schemeName, "schemeName"); this.value = value; this.params = params != null ? Collections.unmodifiableList(new ArrayList<>(params)) : null; } public AuthChallenge(final ChallengeType challengeType, final String schemeName, final NameValuePair... params) { this(challengeType, schemeName, null, Arrays.asList(params)); } public ChallengeType getChallengeType() { return challengeType; } public String getSchemeName() { return schemeName; } public String getValue() { return value; } public List getParams() { return params; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append(schemeName).append(" "); if (value != null) { buffer.append(value); } else if (params != null) { buffer.append(params); } return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthExchange.java0100644 0000000 0000000 00000010224 00000250600 025555 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.Queue; import org.apache.hc.core5.util.Args; /** * This class represents the actual state of authentication handshake including the current {@link AuthScheme} * used for request authorization as well as a collection of backup authentication options if available. * * @since 4.5 */ public class AuthExchange { // This only tracks the server state. In particular, even if the state is SUCCESS, // the authentication may still fail if the challenge sent with a response cannot // be validated locally in case of a mutual authentication. public enum State { UNCHALLENGED, CHALLENGED, HANDSHAKE, FAILURE, SUCCESS } private State state; private AuthScheme authScheme; private Queue authOptions; private String pathPrefix; public AuthExchange() { super(); this.state = State.UNCHALLENGED; } public void reset() { this.state = State.UNCHALLENGED; this.authOptions = null; this.authScheme = null; this.pathPrefix = null; } public State getState() { return this.state; } public void setState(final State state) { this.state = state != null ? state : State.UNCHALLENGED; } /** * Returns actual {@link AuthScheme}. May be null. */ public AuthScheme getAuthScheme() { return this.authScheme; } /** * Returns {@code true} if the actual authentication scheme is connection based. */ public boolean isConnectionBased() { return this.authScheme != null && this.authScheme.isConnectionBased(); } /** * @since 5.2 */ public String getPathPrefix() { return pathPrefix; } /** * @since 5.2 */ public void setPathPrefix(final String pathPrefix) { this.pathPrefix = pathPrefix; } /** * Resets the auth state with {@link AuthScheme} and clears auth options. * * @param authScheme auth scheme. May not be null. */ public void select(final AuthScheme authScheme) { Args.notNull(authScheme, "Auth scheme"); this.authScheme = authScheme; this.authOptions = null; } /** * Returns available auth options. May be null. */ public Queue getAuthOptions() { return this.authOptions; } /** * Updates the auth state with a queue of auth options. * * @param authOptions a queue of auth options. May not be null or empty. */ public void setOptions(final Queue authOptions) { Args.notEmpty(authOptions, "Queue of auth options"); this.authOptions = authOptions; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[").append(this.state); if (this.authScheme != null) { buffer.append(" ").append(this.authScheme); } buffer.append("]"); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthScheme.java0100644 0000000 0000000 00000024531 00000250600 025245 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.security.Principal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents an abstract challenge-response oriented authentication scheme. *

* Authentication schemes can be either request or connection based. The former are * expected to provide an authorization response with each request message while the latter * is executed only once and applies to the underlying connection for its entire life span. * Care must be taken when re-using connections authorized through a connection based * authentication scheme and they may carry a particular security context and be authorized * for a particular user identity. It is important that such schemes always provide * the user identity they represent through the {@link #getPrincipal()} method. *

*

* Authentication scheme are expected to transition through a series of standard phases or * states. *

*

* Authentication scheme starts off its life cycle with no context and no specific state. *

*

* The {@link #processChallenge(AuthChallenge, HttpContext)} method is called to * process an authentication challenge received either from the target server or a proxy. * The authentication scheme transitions to CHALLENGED state and is expected to validate * the token passed to it as a parameter and initialize its internal state based on * challenge details. Standard authentication schemes are expected to provide a realm * attribute in the challenge. {@link #getRealm()} can be called to obtain an identifier * of the realm that requires authorization. *

*

* Once the challenge has been fully processed the {@link #isResponseReady(HttpHost, * CredentialsProvider, HttpContext)} method to determine whether the scheme is capable of * generating a authorization response based on its current state and it holds user credentials * required to do so. If this method returns {@code false} the authentication is considered * to be in FAILED state and no authorization response. Otherwise the scheme is considered * to be in RESPONSE_READY state. *

*

* Once the scheme is ready to respond to the challenge the {@link #generateAuthResponse( * HttpHost, HttpRequest, HttpContext)} method to generate a response token, which will * be sent to the opposite endpoint in the subsequent request message. *

*

* Certain non-standard schemes may involve multiple challenge / response exchanges to * fully establish a shared context and complete the authentication process. Authentication * schemes are required to return {@code true} {@link #isChallengeComplete()} once the * handshake is considered complete. *

*

* The authentication scheme is considered successfully completed and in SUCCESS state * if the opposite endpoint accepts the request message containing the authorization * response and responds with a message indicating no authentication failure . * If the opposite endpoint sends status code 401 or 407 in response to a request message * containing the terminal authorization response, the scheme is considered unsuccessful * and in FAILED state. *

* * @since 4.0 */ public interface AuthScheme { /** * Returns textual designation of the given authentication scheme. * * @return the name of the given authentication scheme */ String getName(); /** * Determines if the authentication scheme is expected to provide an authorization response * on a per connection basis instead of the standard per request basis * * @return {@code true} if the scheme is connection based, {@code false} * if the scheme is request based. */ boolean isConnectionBased(); /** * Processes the given auth challenge. Some authentication schemes may involve multiple * challenge-response exchanges. Such schemes must be able to maintain internal state * when dealing with sequential challenges *

* Please note auth schemes that perform mutual authentication must implement * {@link #processChallenge(HttpHost, boolean, AuthChallenge, HttpContext)} and * {@link #isChallengeExpected()} instead. * * @param authChallenge the auth challenge * @param context HTTP context * @throws MalformedChallengeException in case the auth challenge is incomplete, * malformed or otherwise invalid. * * @see #processChallenge(HttpHost, boolean, AuthChallenge, HttpContext) * * @since 5.0 */ void processChallenge( AuthChallenge authChallenge, HttpContext context) throws MalformedChallengeException; /** * Indicates that the even authorized (i.e. not 401 or 407) responses must be processed * by this scheme. * * @return true if responses with non 401/407 response codes must be processed by the scheme. * * @since 5.5 */ default boolean isChallengeExpected() { return false; } /** * Processes the given auth challenge. Some authentication schemes may involve multiple * challenge-response exchanges. Such schemes must be able to maintain internal state * when dealing with sequential challenges. *

* When {@link #isChallengeExpected()} returns true, but no challenge was sent, this method * must be called with a null {@link AuthChallenge} so that the scheme can handle this situation. * * @param host HTTP host * @param challenged true if the response was unauthorised (401/407) * @param authChallenge the auth challenge or null if no challenge was received * @param context HTTP context * * @throws MalformedChallengeException in case the auth challenge is incomplete, * @throws AuthenticationException in case the authentication process is unsuccessful. * * @since 5.5 */ default void processChallenge( HttpHost host, boolean challenged, AuthChallenge authChallenge, HttpContext context) throws MalformedChallengeException, AuthenticationException { processChallenge(authChallenge, context); } /** * Authentication process may involve a series of challenge-response exchanges. * This method tests if the authorization process has been fully completed (either * successfully or unsuccessfully), that is, all the required authorization * challenges have been processed in their entirety. *

* Please note if the scheme returns {@code true} from this method in response * to a challenge, it effectively implies a failure to respond to this challenge * and termination of the authentication process. * * @return {@code true} if the authentication process has been completed, * {@code false} otherwise. * * @since 5.0 */ boolean isChallengeComplete(); /** * Returns authentication realm. If the concept of an authentication * realm is not applicable to the given authentication scheme, returns * {@code null}. * * @return the authentication realm */ String getRealm(); /** * Determines whether or not an authorization response can be generated based on * the actual authentication state. Generally the outcome of this method will depend * upon availability of user credentials necessary to produce an authorization * response. * * @param credentialsProvider The credentials to be used for authentication * @param context HTTP context * @throws AuthenticationException if authorization string cannot * be generated due to an authentication failure * * @return {@code true} if an authorization response can be generated and * the authentication handshake can proceed, {@code false} otherwise. * * @since 5.0 */ boolean isResponseReady( HttpHost host, CredentialsProvider credentialsProvider, HttpContext context) throws AuthenticationException; /** * Returns {@link Principal} whose credentials are used to generate * an authentication response. Connection based schemes are required * to return a user {@link Principal} if authorization applies to * for the entire life span of connection. * @return user principal * * @see #isConnectionBased() * * @since 5.0 */ Principal getPrincipal(); /** * Generates an authorization response based on the current state. Some authentication * schemes may need to load user credentials required to generate an authorization * response from a {@link CredentialsProvider} prior to this method call. * * @param request The request being authenticated * @param context HTTP context * @throws AuthenticationException if authorization string cannot * be generated due to an authentication failure * * @return authorization header * * @see #isResponseReady(HttpHost, CredentialsProvider, HttpContext) * * @since 5.0 */ String generateAuthResponse( HttpHost host, HttpRequest request, HttpContext context) throws AuthenticationException; } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthSchemeFactory.java0100644 0000000 0000000 00000003010 00000250600 026562 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.protocol.HttpContext; /** * Factory for {@link AuthScheme} implementations. * * @since 4.3 */ public interface AuthSchemeFactory { /** * Creates an instance of {@link AuthScheme}. * * @return auth scheme. */ AuthScheme create(HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthScope.java0100644 0000000 0000000 00000021127 00000250600 025110 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * {@code AuthScope} represents an authentication scope consisting of * an application protocol, a host name, a port number, a realm name * and an authentication scheme name. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class AuthScope { private final String protocol; private final String host; private final int port; private final String realm; private final String schemeName; /** * Defines auth scope with the given {@code protocol}, {@code host}, {@code port}, * {@code realm}, and {@code schemeName}. * * @param protocol application protocol. May be {@code null} if applies * to any protocol. * @param host authentication host. May be {@code null} if applies * to any host. * @param port authentication port. May be {@code -1} if applies * to any port of the host. * @param realm authentication realm. May be {@code null} if applies * to any realm on the host. * @param schemeName authentication scheme name. May be {@code null} if applies * to any auth scheme supported by the host. */ public AuthScope( final String protocol, final String host, final int port, final String realm, final String schemeName) { this.protocol = protocol != null ? protocol.toLowerCase(Locale.ROOT) : null; this.host = host != null ? host.toLowerCase(Locale.ROOT) : null; this.port = port >= 0 ? port : -1; this.realm = realm; this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null; } /** * Defines auth scope for a specific host of origin. * * @param origin host of origin * @param realm authentication realm. May be {@code null} if applies * to any realm on the host. * @param schemeName authentication scheme name. May be {@code null} if applies * to any auth scheme supported by the host. * * @since 4.2 */ public AuthScope( final HttpHost origin, final String realm, final String schemeName) { Args.notNull(origin, "Host"); this.protocol = origin.getSchemeName().toLowerCase(Locale.ROOT); this.host = origin.getHostName().toLowerCase(Locale.ROOT); this.port = origin.getPort() >= 0 ? origin.getPort() : -1; this.realm = realm; this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null; } /** * Defines auth scope for a specific host of origin. * * @param origin host of origin * * @since 4.2 */ public AuthScope(final HttpHost origin) { this(origin, null, null); } /** * Defines auth scope with the given {@code host} and {@code port}. * * @param host authentication host. May be {@code null} if applies * to any host. * @param port authentication port. May be {@code -1} if applies * to any port of the host. */ public AuthScope(final String host, final int port) { this(null, host, port, null, null); } /** * Creates a copy of the given credentials scope. */ public AuthScope(final AuthScope authScope) { super(); Args.notNull(authScope, "Scope"); this.protocol = authScope.getProtocol(); this.host = authScope.getHost(); this.port = authScope.getPort(); this.realm = authScope.getRealm(); this.schemeName = authScope.getSchemeName(); } public String getProtocol() { return protocol; } public String getHost() { return this.host; } public int getPort() { return this.port; } public String getRealm() { return this.realm; } public String getSchemeName() { return this.schemeName; } /** * Tests if the authentication scopes match. * * @return the match factor. Negative value signifies no match. * Non-negative signifies a match. The greater the returned value * the closer the match. */ public int match(final AuthScope that) { int factor = 0; if (Objects.equals(this.schemeName, that.schemeName)) { factor += 1; } else { if (this.schemeName != null && that.schemeName != null) { return -1; } } if (Objects.equals(this.realm, that.realm)) { factor += 2; } else { if (this.realm != null && that.realm != null) { return -1; } } if (this.port == that.port) { factor += 4; } else { if (this.port != -1 && that.port != -1) { return -1; } } if (Objects.equals(this.protocol, that.protocol)) { factor += 8; } else { if (this.protocol != null && that.protocol != null) { return -1; } } if (Objects.equals(this.host, that.host)) { factor += 16; } else { if (this.host != null && that.host != null) { return -1; } } return factor; } @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof AuthScope) { final AuthScope that = (AuthScope) obj; return Objects.equals(this.protocol, that.protocol) && Objects.equals(this.host, that.host) && this.port == that.port && Objects.equals(this.realm, that.realm) && Objects.equals(this.schemeName, that.schemeName); } return false; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.protocol); hash = LangUtils.hashCode(hash, this.host); hash = LangUtils.hashCode(hash, this.port); hash = LangUtils.hashCode(hash, this.realm); hash = LangUtils.hashCode(hash, this.schemeName); return hash; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); if (this.schemeName != null) { buffer.append(this.schemeName); } else { buffer.append(""); } buffer.append(' '); if (this.realm != null) { buffer.append('\''); buffer.append(this.realm); buffer.append('\''); } else { buffer.append(""); } buffer.append(' '); if (this.protocol != null) { buffer.append(this.protocol); } else { buffer.append(""); } buffer.append("://"); if (this.host != null) { buffer.append(this.host); } else { buffer.append(""); } buffer.append(':'); if (this.port >= 0) { buffer.append(this.port); } else { buffer.append(""); } return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthStateCacheable.java0100644 0000000 0000000 00000003252 00000250600 026666 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * Indicates that the state of an {@link AuthScheme} can be cached * and re-used for preemptive authentication by subsequent requests. * * @since 5.0 */ @Documented @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface AuthStateCacheable { } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthenticationException.java0100644 0000000 0000000 00000004432 00000250600 030053 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.ProtocolException; /** * Signals a failure in authentication process * * @since 4.0 */ public class AuthenticationException extends ProtocolException { private static final long serialVersionUID = -6794031905674764776L; /** * Creates a new AuthenticationException with a {@code null} detail message. */ public AuthenticationException() { super(); } /** * Creates a new AuthenticationException with the specified message. * * @param message the exception detail message */ public AuthenticationException(final String message) { super(message); } /** * Creates a new AuthenticationException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public AuthenticationException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/BasicUserPrincipal.java0100644 0000000 0000000 00000005366 00000250600 026746 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Basic username based principal representation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class BasicUserPrincipal implements Principal, Serializable { private static final long serialVersionUID = -2266305184969850467L; private final String username; public BasicUserPrincipal(final String username) { super(); Args.notNull(username, "User name"); this.username = username; } @Override public String getName() { return this.username; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.username); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof BasicUserPrincipal) { final BasicUserPrincipal that = (BasicUserPrincipal) o; return Objects.equals(this.username, that.username); } return false; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[principal: "); buffer.append(this.username); buffer.append("]"); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/BearerToken.java0100644 0000000 0000000 00000005101 00000250600 025410 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Opaque token {@link Credentials} usually representing a set of claims, often encrypted * or signed. The JWT (JSON Web Token) is among most widely used tokens used at the time * of writing. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class BearerToken implements Credentials, Serializable { private final String token; public BearerToken(final String token) { super(); this.token = Args.notBlank(token, "Token"); } @Override public Principal getUserPrincipal() { return null; } /** * @deprecated Do not use. */ @Deprecated @Override public char[] getPassword() { return null; } public String getToken() { return token; } @Override public int hashCode() { return token.hashCode(); } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof BearerToken) { final BearerToken that = (BearerToken) o; return Objects.equals(this.token, that.token); } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/ChallengeType.java0100644 0000000 0000000 00000002471 00000250600 025742 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Challenge type (TARGET or PROXY) * * @since 4.2 */ public enum ChallengeType { TARGET, PROXY } httpclient5/src/main/java/org/apache/hc/client5/http/auth/Credentials.java0100644 0000000 0000000 00000003232 00000250600 025447 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.security.Principal; /** * This interface represents a set of credentials consisting of a security * principal and a secret (password) that can be used to establish user * identity * * @since 4.0 */ public interface Credentials { Principal getUserPrincipal(); /** * @deprecated Use specific credentials class that represent a username / password * set of a security token. */ @Deprecated char[] getPassword(); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/CredentialsProvider.java0100644 0000000 0000000 00000003646 00000250600 027173 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.protocol.HttpContext; /** * Provider of authentication credentials. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 4.0 */ public interface CredentialsProvider { /** * Returns {@link Credentials credentials} for the given authentication scope, * if available. * * @param authScope the {@link AuthScope authentication scope} * @param context the {@link HttpContext http context} * @return the credentials * @since 5.0 */ Credentials getCredentials(AuthScope authScope, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/CredentialsStore.java0100644 0000000 0000000 00000004134 00000250600 026466 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Abstract store of authentication credentials. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 4.0 */ public interface CredentialsStore extends CredentialsProvider { /** * Sets the {@link Credentials credentials} for the given authentication * scope. Any previous credentials for the given scope will be overwritten. * * @param authScope the {@link AuthScope authentication scope} * @param credentials the authentication {@link Credentials credentials} * for the given scope. * * @see #getCredentials(AuthScope, org.apache.hc.core5.http.protocol.HttpContext) */ void setCredentials(AuthScope authScope, Credentials credentials); /** * Clears all credentials. */ void clear(); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/InvalidCredentialsException.java0100644 0000000 0000000 00000004467 00000250600 030650 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Authentication credentials required to respond to a authentication * challenge are invalid * * @since 4.0 */ public class InvalidCredentialsException extends AuthenticationException { private static final long serialVersionUID = -4834003835215460648L; /** * Creates a new InvalidCredentialsException with a {@code null} detail message. */ public InvalidCredentialsException() { super(); } /** * Creates a new InvalidCredentialsException with the specified message. * * @param message the exception detail message */ public InvalidCredentialsException(final String message) { super(message); } /** * Creates a new InvalidCredentialsException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public InvalidCredentialsException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosConfig.java0100644 0000000 0000000 00000012003 00000250600 026110 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Immutable class encapsulating Kerberos configuration options. * * @since 4.6 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class KerberosConfig implements Cloneable { public enum Option { DEFAULT, ENABLE, DISABLE } public static final KerberosConfig DEFAULT = new Builder().build(); private final Option stripPort; private final Option useCanonicalHostname; private final Option requestDelegCreds; /** * Intended for CDI compatibility */ protected KerberosConfig() { this(Option.DEFAULT, Option.DEFAULT, Option.DEFAULT); } KerberosConfig( final Option stripPort, final Option useCanonicalHostname, final Option requestDelegCreds) { super(); this.stripPort = stripPort; this.useCanonicalHostname = useCanonicalHostname; this.requestDelegCreds = requestDelegCreds; } public Option getStripPort() { return stripPort; } public Option getUseCanonicalHostname() { return useCanonicalHostname; } public Option getRequestDelegCreds() { return requestDelegCreds; } @Override protected KerberosConfig clone() throws CloneNotSupportedException { return (KerberosConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("stripPort=").append(stripPort); builder.append(", useCanonicalHostname=").append(useCanonicalHostname); builder.append(", requestDelegCreds=").append(requestDelegCreds); builder.append("]"); return builder.toString(); } public static KerberosConfig.Builder custom() { return new Builder(); } public static KerberosConfig.Builder copy(final KerberosConfig config) { return new Builder() .setStripPort(config.getStripPort()) .setUseCanonicalHostname(config.getUseCanonicalHostname()) .setRequestDelegCreds(config.getRequestDelegCreds()); } public static class Builder { private Option stripPort; private Option useCanonicalHostname; private Option requestDelegCreds; Builder() { super(); this.stripPort = Option.DEFAULT; this.useCanonicalHostname = Option.DEFAULT; this.requestDelegCreds = Option.DEFAULT; } public Builder setStripPort(final Option stripPort) { this.stripPort = stripPort; return this; } public Builder setStripPort(final boolean stripPort) { this.stripPort = stripPort ? Option.ENABLE : Option.DISABLE; return this; } public Builder setUseCanonicalHostname(final Option useCanonicalHostname) { this.useCanonicalHostname = useCanonicalHostname; return this; } public Builder setUseCanonicalHostname(final boolean useCanonicalHostname) { this.useCanonicalHostname = useCanonicalHostname ? Option.ENABLE : Option.DISABLE; return this; } public Builder setRequestDelegCreds(final Option requestDelegCreds) { this.requestDelegCreds = requestDelegCreds; return this; } public KerberosConfig build() { return new KerberosConfig( stripPort, useCanonicalHostname, requestDelegCreds); } } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosCredentials.java0100644 0000000 0000000 00000004725 00000250600 027154 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.ietf.jgss.GSSCredential; /** * Kerberos specific {@link Credentials} representation based on {@link GSSCredential}. * * @since 4.4 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see UsernamePasswordCredentials * @see BearerToken */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class KerberosCredentials implements Credentials, Serializable { private static final long serialVersionUID = 487421613855550713L; /** GSSCredential */ private final GSSCredential gssCredential; /** * Constructor with GSSCredential argument * * @param gssCredential */ public KerberosCredentials(final GSSCredential gssCredential) { this.gssCredential = gssCredential; } public GSSCredential getGSSCredential() { return gssCredential; } @Override public Principal getUserPrincipal() { return null; } @Override public char[] getPassword() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/MalformedChallengeException.java0100644 0000000 0000000 00000004547 00000250600 030614 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.ProtocolException; /** * Signals that authentication challenge is in some way invalid or * illegal in the given context * * @since 4.0 */ public class MalformedChallengeException extends ProtocolException { private static final long serialVersionUID = 814586927989932284L; /** * Creates a new MalformedChallengeException with a {@code null} detail message. */ public MalformedChallengeException() { super(); } /** * Creates a new MalformedChallengeException with the specified message. * * @param message the exception detail message */ public MalformedChallengeException(final String message) { super(message); } /** * Creates a new MalformedChallengeException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public MalformedChallengeException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/NTCredentials.java0100644 0000000 0000000 00000021573 00000250600 025721 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.net.InetAddress; import java.net.UnknownHostException; import java.security.Principal; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Microsoft Windows specific {@link Credentials} representation that includes * Windows specific attributes such as name of the domain the user belongs to. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see UsernamePasswordCredentials * @see BearerToken */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class NTCredentials implements Credentials, Serializable { private static final long serialVersionUID = -7385699315228907265L; /** The user principal */ private final NTUserPrincipal principal; /** Password */ private final char[] password; /** The netbios hostname the authentication request is originating from. */ private final String workstation; /** The netbios domain the authentication request is against */ private final String netbiosDomain; /** * Constructor. * @param userName The user name. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. * @param password The password. * @param workstation The workstation the authentication request is originating from. * Essentially, the computer name for this machine. * @param domain The domain to authenticate within. */ public NTCredentials( final String userName, final char[] password, final String workstation, final String domain) { this(password, userName, domain, convertDomain(domain)); } /** * Constructor. * @param userName The user name. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. * @param password The password. * @param workstation The netbios workstation name that the authentication request is originating from. * Essentially, the computer name for this machine. * @param domain The domain to authenticate within. * @param netbiosDomain The netbios version of the domain name. */ public NTCredentials( final String userName, final char[] password, final String workstation, final String domain, final String netbiosDomain) { this(password, userName, domain, netbiosDomain); } /** * Constructor to create an instance of NTCredentials. * * @param password The password to use for authentication. Must not be null. * @param userName The user name for authentication. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. Must not be null. * @param domain The domain to authenticate within. Can be null. * @param netbiosDomain An alternative representation of the domain name in NetBIOS format. Can be null. * This parameter is provided to accommodate specific scenarios that require the NetBIOS version of the domain name. *

* This constructor creates a new instance of NTCredentials, determining the workstation name at runtime * using the {@link #getWorkstationName()} method. The workstation name will be converted to uppercase * using the {@link Locale#ROOT} locale. */ public NTCredentials( final char[] password, final String userName, final String domain, final String netbiosDomain) { super(); Args.notNull(userName, "User name"); this.principal = new NTUserPrincipal(domain, userName); this.password = password; this.workstation = getWorkstationName().toUpperCase(Locale.ROOT); this.netbiosDomain = netbiosDomain; } @Override public Principal getUserPrincipal() { return this.principal; } public String getUserName() { return this.principal.getUsername(); } @Override public char[] getPassword() { return this.password; } /** * Retrieves the name to authenticate with. * * @return String the domain these credentials are intended to authenticate with. */ public String getDomain() { return this.principal.getDomain(); } /** * Retrieves the netbios domain to authenticate with. * @return String the netbios domain name. */ public String getNetbiosDomain() { return this.netbiosDomain; } /** * Retrieves the netbios workstation name of the computer originating the request. * * @return String the netbios workstation the user is logged into. */ public String getWorkstation() { return this.workstation; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.principal); hash = LangUtils.hashCode(hash, this.workstation); hash = LangUtils.hashCode(hash, this.netbiosDomain); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof NTCredentials) { final NTCredentials that = (NTCredentials) o; return Objects.equals(this.principal, that.principal) && Objects.equals(this.workstation, that.workstation) && Objects.equals(this.netbiosDomain, that.netbiosDomain); } return false; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[principal: "); buffer.append(this.principal); buffer.append("][workstation: "); buffer.append(this.workstation); buffer.append("][netbiosDomain: "); buffer.append(this.netbiosDomain); buffer.append("]"); return buffer.toString(); } /** Strip dot suffix from a name */ private static String stripDotSuffix(final String value) { if (value == null) { return null; } final int index = value.indexOf('.'); if (index != -1) { return value.substring(0, index); } return value; } /** Convert domain to standard form */ private static String convertDomain(final String domain) { final String returnString = stripDotSuffix(domain); return returnString == null ? returnString : returnString.toUpperCase(Locale.ROOT); } /** * Retrieves the workstation name of the computer originating the request. * This method attempts to get the local host name using the InetAddress class. * If it fails to retrieve the host name due to an UnknownHostException, it returns "localhost" as a fallback. * * @return The unqualified workstation name as a String. */ private static String getWorkstationName() { try { final InetAddress addr = InetAddress.getLocalHost(); final String hostName = addr.getHostName(); // Ensure the hostname is unqualified by removing any domain part return stripDotSuffix(hostName); } catch (final UnknownHostException e) { return "localhost"; } } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/NTUserPrincipal.java0100644 0000000 0000000 00000006674 00000250600 026251 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Microsoft Windows specific user principal implementation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class NTUserPrincipal implements Principal, Serializable { private static final long serialVersionUID = -6870169797924406894L; private final String username; private final String domain; private final String ntname; public NTUserPrincipal( final String domain, final String username) { super(); Args.notNull(username, "User name"); this.username = username; if (domain != null) { this.domain = domain.toUpperCase(Locale.ROOT); } else { this.domain = null; } if (this.domain != null && !this.domain.isEmpty()) { final StringBuilder buffer = new StringBuilder(); buffer.append(this.domain); buffer.append('\\'); buffer.append(this.username); this.ntname = buffer.toString(); } else { this.ntname = this.username; } } @Override public String getName() { return this.ntname; } public String getDomain() { return this.domain; } public String getUsername() { return this.username; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.username); hash = LangUtils.hashCode(hash, this.domain); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof NTUserPrincipal) { final NTUserPrincipal that = (NTUserPrincipal) o; return Objects.equals(this.username, that.username) && Objects.equals(this.domain, that.domain); } return false; } @Override public String toString() { return this.ntname; } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/StandardAuthScheme.java0100644 0000000 0000000 00000005765 00000250600 026736 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Authentication schemes by their names supported by the HttpClient. * * @since 4.3 */ public final class StandardAuthScheme { private StandardAuthScheme() { // no instances } /** * Basic authentication scheme (considered inherently insecure without TLS, * but most widely supported). */ public static final String BASIC = "Basic"; /** * Digest authentication scheme. */ public static final String DIGEST = "Digest"; /** * Bearer authentication scheme (should be used with TLS). */ public static final String BEARER = "Bearer"; /** * The NTLM authentication scheme is a proprietary Microsoft Windows * authentication protocol as defined in [MS-NLMP]. * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String NTLM = "NTLM"; /** * SPNEGO authentication scheme as defined in RFC 4559 and RFC 4178. * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String SPNEGO = "Negotiate"; /** * Kerberos authentication scheme as defined in RFC 4120. * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String KERBEROS = "Kerberos"; /** * SCRAM with SHA-256 as defined by RFC 7804 / RFC 7677. * * @since 5.6 */ public static final String SCRAM_SHA_256 = "SCRAM-SHA-256"; } httpclient5/src/main/java/org/apache/hc/client5/http/auth/UsernamePasswordCredentials.java0100644 0000000 0000000 00000007060 00000250600 030675 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Simple {@link Credentials} representation based on a user name / password * pair. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class UsernamePasswordCredentials implements Credentials, Serializable { private static final long serialVersionUID = 243343858802739403L; private final Principal principal; private final char[] password; /** * The constructor with the username and password arguments. * * @param principal the user principal * @param password the password * * @since 5.3 * * @see BasicUserPrincipal * @see NTUserPrincipal */ public UsernamePasswordCredentials(final Principal principal, final char[] password) { super(); this.principal = Args.notNull(principal, "User principal"); this.password = password; } /** * The constructor with the username and password arguments. * * @param username the user name * @param password the password */ public UsernamePasswordCredentials(final String username, final char[] password) { this(new BasicUserPrincipal(username), password); } @Override public Principal getUserPrincipal() { return this.principal; } public String getUserName() { return this.principal.getName(); } /** * @since 5.3 */ public char[] getUserPassword() { return password; } /** * @deprecated Use {@link #getUserPassword()}. */ @Deprecated @Override public char[] getPassword() { return password; } @Override public int hashCode() { return this.principal.hashCode(); } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof UsernamePasswordCredentials) { final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o; return Objects.equals(this.principal, that.principal); } return false; } @Override public String toString() { return this.principal.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/package-info.java0100644 0000000 0000000 00000002366 00000250600 025545 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client HTTP authentication APIs. */ package org.apache.hc.client5.http.auth; httpclient5/src/main/java/org/apache/hc/client5/http/classic/0040755 0000000 0000000 00000000000 00000250600 023032 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/classic/BackoffManager.java0100644 0000000 0000000 00000003643 00000250600 026526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import org.apache.hc.client5.http.HttpRoute; /** * Represents a controller that dynamically adjusts the size * of an available connection pool based on feedback from * using the connections. * * @since 4.2 */ public interface BackoffManager { /** * Called when we have decided that the result of * using a connection should be interpreted as a * backoff signal. * * @param route the affected route. */ void backOff(HttpRoute route); /** * Called when we have determined that the result of * using a connection has succeeded and that we may * probe for more connections. * * @param route the affected route. */ void probe(HttpRoute route); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ConnectionBackoffStrategy.java0100644 0000000 0000000 00000004672 00000250600 031001 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import org.apache.hc.core5.http.HttpResponse; /** * When managing a dynamic number of connections for a given route, this * strategy assesses whether a given request execution outcome should * result in a backoff signal or not, based on either examining the * {@code Throwable} that resulted or by examining the resulting * response (e.g. for its status code). * * @since 4.2 * */ public interface ConnectionBackoffStrategy { /** * Determines whether seeing the given {@code Throwable} as * a result of request execution should result in a backoff * signal. * @param t the {@code Throwable} that happened * @return {@code true} if a backoff signal should be * given */ boolean shouldBackoff(Throwable t); /** * Determines whether receiving the given {@link HttpResponse} as * a result of request execution should result in a backoff * signal. Implementations MUST restrict themselves to examining * the response header and MUST NOT consume any of the response * body, if any. * @param response the {@code HttpResponse} that was received * @return {@code true} if a backoff signal should be * given */ boolean shouldBackoff(HttpResponse response); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecChain.java0100644 0000000 0000000 00000005375 00000250600 025533 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.util.Args; /** * Represents a single element in the client side classic request execution chain. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ExecChain { final class Scope { public final String exchangeId; public final HttpRoute route; public final ClassicHttpRequest originalRequest; public final ExecRuntime execRuntime; public final HttpClientContext clientContext; public Scope(final String exchangeId, final HttpRoute route, final ClassicHttpRequest originalRequest, final ExecRuntime execRuntime, final HttpClientContext clientContext) { this.exchangeId = Args.notNull(exchangeId, "Exchange id"); this.route = Args.notNull(route, "Route"); this.originalRequest = Args.notNull(originalRequest, "Original request"); this.execRuntime = Args.notNull(execRuntime, "Exec runtime"); this.clientContext = Args.notNull(clientContext, "HTTP context"); } } ClassicHttpResponse proceed( ClassicHttpRequest request, Scope scope) throws IOException, HttpException; } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecChainHandler.java0100644 0000000 0000000 00000007074 00000250600 027027 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.classic.HttpRequestRetryExec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; /** * Abstract request execution handler in a classic client side request execution chain. * Handlers can either be a decorator around another element that implements a cross * cutting aspect or a self-contained executor capable of producing a response * for the given request. *

* Important: please note it is required for decorators that implement post execution aspects * or response post-processing of any sort to release resources associated with the response * by calling {@link ClassicHttpResponse#close()} methods in case of an I/O, protocol or * runtime exception, or in case the response is not propagated to the caller. *

*

* For information regarding the handler chain behaviour in case of a request re-execution, * please refer to the {@link HttpRequestRetryExec} javadoc. *

*

* Well known request execution handlers could be referred to by name using one of the * {@link ChainElement} enum values. *

* * @since 4.3 * @see ChainElement * @see HttpClientBuilder#addExecInterceptorFirst(String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorBefore(String, String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorAfter(String, String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorLast(String, ExecChainHandler) */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ExecChainHandler { /** * Executes the actual HTTP request. The handler can choose to return * a response message or delegate request execution to the next element * in the execution chain. * * @param request the actual request. * @param scope the execution scope . * @param chain the next element in the request execution chain. */ ClassicHttpResponse execute( ClassicHttpRequest request, ExecChain.Scope scope, ExecChain chain) throws IOException, HttpException; } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecRuntime.java0100644 0000000 0000000 00000015652 00000250600 026133 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.io.HttpResponseInformationCallback; import org.apache.hc.core5.util.TimeValue; /** * Execution runtime that provides access to the underlying connection endpoint and helps * manager its life cycle. *

* This interface is considered internal and generally ought not be used or accessed * by custom request exec handlers. * * @since 5.0 */ @Internal public interface ExecRuntime { /** * Determines of the request execution has been aborted. * * @return {@code true} if the request execution has been acquired, * {@code false} otherwise. */ boolean isExecutionAborted(); /** * Determines of a connection endpoint has been acquired. * * @return {@code true} if an endpoint has been acquired, {@code false} otherwise. */ boolean isEndpointAcquired(); /** * Acquires a connection endpoint. Endpoints can leased from a pool * or unconnected new endpoint can be created. * * @param id unique operation ID or {@code null}. * @param route the connection route. * @param state the expected connection state. May be {@code null} if connection * can be state-less or its state is irrelevant. * @param context the execution context. * @throws IOException if an I/O error occurs. */ void acquireEndpoint( String id, HttpRoute route, Object state, HttpClientContext context) throws IOException; /** * Releases the acquired endpoint potentially making it available for re-use. */ void releaseEndpoint(); /** * Shuts down and discards the acquired endpoint. */ void discardEndpoint(); /** * Determines of there the endpoint is connected to the initial hop (connection * target in case of a direct route or to the first proxy hop in case of a route * via a proxy or multiple proxies). * * @return {@code true} if the endpoint is connected, {@code false} otherwise. */ boolean isEndpointConnected(); /** * Disconnects the local endpoint from the initial hop in the connection route. * * @throws IOException if an I/O error occurs. */ void disconnectEndpoint() throws IOException; /** * Connect the local endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param context the execution context. * @throws IOException if an I/O error occurs. */ void connectEndpoint(HttpClientContext context) throws IOException; /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. * @throws IOException if an I/O error occurs. */ void upgradeTls(HttpClientContext context) throws IOException; /** * Gets information about the underlying endpoint when connected or {@code null} otherwise. * * @return an EndpointInfo, defaults to {@code null}. */ default EndpointInfo getEndpointInfo() { return null; } /** * Executes HTTP request using the given context. * * @param id unique operation ID or {@code null}. * @param request the request message. * @param context the execution context. * @return a ClassicHttpResponse. * @throws IOException if an I/O error occurs. * @throws HttpException if a protocol error occurs. */ ClassicHttpResponse execute( String id, ClassicHttpRequest request, HttpClientContext context) throws IOException, HttpException; /** * Executes HTTP request using the given context. * * @param id unique operation ID or {@code null}. * @param request the request message. * @param informationCallback information (1xx) response handler * @param context the execution context. * @return a ClassicHttpResponse. * @throws IOException if an I/O error occurs. * @throws HttpException if a protocol error occurs. * @since 5.4 */ default ClassicHttpResponse execute( String id, ClassicHttpRequest request, HttpResponseInformationCallback informationCallback, HttpClientContext context) throws IOException, HttpException { return execute(id, request, context); } /** * Determines of the connection is considered re-usable. * * @return {@code true} if the connection is re-usable, {@code false} otherwise. */ boolean isConnectionReusable(); /** * Marks the connection as potentially re-usable for the given period of time * and also marks it as stateful if the state representation is given. * @param state the connection state representation or {@code null} if stateless. * @param validityTime the period of time this connection is valid for. */ void markConnectionReusable(Object state, TimeValue validityTime); /** * Marks the connection as non re-usable. */ void markConnectionNonReusable(); /** * Forks this runtime for parallel execution. * * @return another runtime with the same configuration. */ ExecRuntime fork(CancellableDependency cancellableAware); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/HttpClient.java0100644 0000000 0000000 00000033636 00000250600 025763 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.Closeable; import java.io.IOException; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents only the most basic contract for HTTP request * execution. It imposes no restrictions or particular details on the request * execution process and leaves the specifics of state management, * authentication and redirect handling up to individual implementations. * * @since 4.0 */ public interface HttpClient { /** * Executes HTTP request using the default context. * * @param request the request to execute * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(ClassicHttpRequest request) throws IOException; /** * Executes HTTP request using the given context. * * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(ClassicHttpRequest request, HttpContext context) throws IOException; /** * Executes HTTP request using the default context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated ClassicHttpResponse execute(HttpHost target, ClassicHttpRequest request) throws IOException; /** * Executes HTTP request using the given context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException; /** * Executes the request and opens the response stream using the given context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * The response returned by this method must be closed with * {@link Closeable#close()} in order ensure deallocation * of system resources. * @throws IOException in case of a problem or the connection was aborted * * @since 5.2 */ @SuppressWarnings("deprecation") default ClassicHttpResponse executeOpen(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException { return (ClassicHttpResponse) execute(target, request, context); } /** * Executes HTTP request using the default context and processes the * response using the given response handler. *

* Implementing classes are required to ensure that the content entity * associated with the response is fully consumed and the underlying * connection is released back to the connection manager automatically * in all cases relieving individual {@link HttpClientResponseHandler}s from * having to manage resource deallocation internally. *

* * @param the type of the value determined by the response. * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted */ T execute(ClassicHttpRequest request, HttpClientResponseHandler responseHandler) throws IOException; /** * Executes HTTP request using the given context and processes the * response using the given response handler. *

* Implementing classes are required to ensure that the content entity * associated with the response is fully consumed and the underlying * connection is released back to the connection manager automatically * in all cases relieving individual {@link HttpClientResponseHandler}s from * having to manage resource deallocation internally. *

* * @param the type of the value determined by the response. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted */ T execute( ClassicHttpRequest request, HttpContext context, HttpClientResponseHandler responseHandler) throws IOException; /** * Executes HTTP request to the target using the default context and * processes the response using the given response handler. *

* Implementing classes are required to ensure that the content entity * associated with the response is fully consumed and the underlying * connection is released back to the connection manager automatically * in all cases relieving individual {@link HttpClientResponseHandler}s from * having to manage resource deallocation internally. *

* * @param the type of the value determined by the response. * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted */ T execute( HttpHost target, ClassicHttpRequest request, HttpClientResponseHandler responseHandler) throws IOException; /** * Executes HTTP request to the target using the given context and * processes the response using the given response handler. *

* Implementing classes are required to ensure that the content entity * associated with the response is fully consumed and the underlying * connection is released back to the connection manager automatically * in all cases relieving individual {@link HttpClientResponseHandler}s from * having to manage resource deallocation internally. *

* * @param the type of the value determined by the response. * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted */ T execute( HttpHost target, ClassicHttpRequest request, HttpContext context, HttpClientResponseHandler responseHandler) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/classic/package-info.java0100644 0000000 0000000 00000002424 00000250600 026220 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client APIs based on the classic (blocking) I/O model. */ package org.apache.hc.client5.http.classic; httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/0040755 0000000 0000000 00000000000 00000250600 024475 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/ClassicHttpRequests.java0100644 0000000 0000000 00000022706 00000250600 031321 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.util.Args; /** * Common HTTP methods using {@link HttpUriRequest} as a HTTP request message representation. *

* Each static method creates a request object of the exact subclass of {@link HttpUriRequest} * with a non-null URI. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.io.support.ClassicRequestBuilder} */ @Deprecated public final class ClassicHttpRequests { /** * Creates a new HttpUriRequest for the given {@code Method} and {@code String} URI. * * @param method A method. * @param uri a URI. * @return a new HttpUriRequest. */ public static HttpUriRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a new HttpUriRequest for the given {@code Method} and {@code URI}. * * @param method A method. * @param uri a URI. * @return a new HttpUriRequest. */ public static HttpUriRequest create(final Method method, final URI uri) { switch (Args.notNull(method, "method")) { case DELETE: return delete(uri); case GET: return get(uri); case HEAD: return head(uri); case OPTIONS: return options(uri); case PATCH: return patch(uri); case POST: return post(uri); case PUT: return put(uri); case TRACE: return trace(uri); default: throw new IllegalArgumentException(method.toString()); } } /** * Creates a new HttpUriRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @throws IllegalArgumentException if the method is not supported. * @throws IllegalArgumentException if the string URI is null. * @return A new HttpUriRequest. */ public static HttpUriRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new HttpUriRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @throws IllegalArgumentException if the method is not supported. * @throws IllegalArgumentException if the URI is null. * @return A new HttpUriRequest. */ public static HttpUriRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } /** * Constructs a new {@code "DELETE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "DELETE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest delete(final String uri) { return delete(URI.create(uri)); } /** * Constructs a new {@code "DELETE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "DELETE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest delete(final URI uri) { return new HttpDelete(uri); } /** * Constructs a new {@code "GET"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "GET" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest get(final String uri) { return get(URI.create(uri)); } /** * Constructs a new {@code "GET"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "GET" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest get(final URI uri) { return new HttpGet(uri); } /** * Constructs a new {@code "HEAD"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "HEAD" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest head(final String uri) { return head(URI.create(uri)); } /** * Constructs a new {@code "HEAD"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "HEAD" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest head(final URI uri) { return new HttpHead(uri); } /** * Constructs a new {@code "OPTIONS"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "OPTIONS" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest options(final String uri) { return options(URI.create(uri)); } /** * Constructs a new {@code "OPTIONS"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "OPTIONS" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest options(final URI uri) { return new HttpOptions(uri); } /** * Constructs a new {@code "PATCH"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PATCH" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest patch(final String uri) { return patch(URI.create(uri)); } /** * Constructs a new {@code "PATCH"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PATCH" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest patch(final URI uri) { return new HttpPatch(uri); } /** * Constructs a new {@code "POST"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "POST" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest post(final String uri) { return post(URI.create(uri)); } /** * Constructs a new {@code "POST"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "POST" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest post(final URI uri) { return new HttpPost(uri); } /** * Constructs a new {@code "PUT"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PUT" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest put(final String uri) { return put(URI.create(uri)); } /** * Constructs a new {@code "PUT"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PUT" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest put(final URI uri) { return new HttpPut(uri); } /** * Constructs a new {@code "TRACE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "TRACE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest trace(final String uri) { return trace(URI.create(uri)); } /** * Constructs a new {@code "TRACE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "TRACE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest trace(final URI uri) { return new HttpTrace(uri); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpDelete.java0100644 0000000 0000000 00000004021 00000250600 027374 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP DELETE method. * * @since 4.0 */ public class HttpDelete extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "DELETE"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the URI is null. */ public HttpDelete(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the URI is invalid. */ public HttpDelete(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpGet.java0100644 0000000 0000000 00000004002 00000250600 026710 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP GET method. * * @since 4.0 */ public class HttpGet extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "GET"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpGet(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpGet(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpHead.java0100644 0000000 0000000 00000004007 00000250600 027037 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP HEAD method. * * @since 4.0 */ public class HttpHead extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "HEAD"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpHead(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpHead(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpOptions.java0100644 0000000 0000000 00000005720 00000250600 027634 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.Args; /** * HTTP OPTIONS method. * * @since 4.0 */ public class HttpOptions extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "OPTIONS"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpOptions(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpOptions(final String uri) { this(URI.create(uri)); } @Override public String getMethod() { return METHOD_NAME; } /** * Gets the allowed method names defined by {@code "Allow"} headers. * * @param response the response to query. * @return The response to query. */ public Set getAllowedMethods(final HttpResponse response) { Args.notNull(response, "HTTP response"); final Iterator it = MessageSupport.iterate(response, "Allow"); final Set methods = new HashSet<>(); while (it.hasNext()) { final HeaderElement element = it.next(); methods.add(element.getName()); } return methods; } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPatch.java0100644 0000000 0000000 00000004014 00000250600 027233 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP PATCH method. * * @since 4.2 */ public class HttpPatch extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "PATCH"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPatch(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPatch(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPost.java0100644 0000000 0000000 00000004007 00000250600 027123 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP POST method. * * @since 4.0 */ public class HttpPost extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "POST"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPost(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPost(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPut.java0100644 0000000 0000000 00000004002 00000250600 026741 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP PUT method. * * @since 4.0 */ public class HttpPut extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "PUT"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPut(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPut(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpTrace.java0100644 0000000 0000000 00000004342 00000250600 027236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import org.apache.hc.core5.http.HttpEntity; /** * HTTP TRACE method. * * @since 4.0 */ public class HttpTrace extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "TRACE"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpTrace(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpTrace(final String uri) { this(URI.create(uri)); } @Override public void setEntity(final HttpEntity entity) { throw new IllegalStateException(METHOD_NAME + " requests may not include an entity."); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpUriRequest.java0100644 0000000 0000000 00000004023 00000250600 030304 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.core5.http.ClassicHttpRequest; /** * Extended version of the {@link ClassicHttpRequest} interface that provides * convenience methods to access request properties such as request URI * and method type. * * @since 4.0 */ public interface HttpUriRequest extends ClassicHttpRequest, Configurable { /** * Aborts execution of the request. * * @throws UnsupportedOperationException if the abort operation * is not supported / cannot be implemented. */ void abort() throws UnsupportedOperationException; /** * Tests if the request execution has been aborted. * * @return {@code true} if the request execution has been aborted, * {@code false} otherwise. */ boolean isAborted(); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpUriRequestBase.java0100644 0000000 0000000 00000010450 00000250600 031100 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import java.util.concurrent.atomic.AtomicMarkableReference; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; /** * Base class for HTTP method subclasses. */ public class HttpUriRequestBase extends BasicClassicHttpRequest implements HttpUriRequest, CancellableDependency { private static final long serialVersionUID = 1L; private final AtomicMarkableReference cancellableRef; private RequestConfig requestConfig; /** * Constructs a new instance with the given method and request URI. * * @param method request method. * @param requestUri request URI. */ public HttpUriRequestBase(final String method, final URI requestUri) { super(method, requestUri); this.cancellableRef = new AtomicMarkableReference<>(null, false); } @Override public boolean cancel() { while (!cancellableRef.isMarked()) { final Cancellable actualCancellable = cancellableRef.getReference(); if (cancellableRef.compareAndSet(actualCancellable, actualCancellable, false, true)) { if (actualCancellable != null) { actualCancellable.cancel(); } return true; } } return false; } @Override public boolean isCancelled() { return cancellableRef.isMarked(); } /** * @since 4.2 */ @Override public void setDependency(final Cancellable cancellable) { final Cancellable actualCancellable = cancellableRef.getReference(); if (!cancellableRef.compareAndSet(actualCancellable, cancellable, false, false)) { cancellable.cancel(); } } /** * Resets internal state of the request making it reusable. * * @since 4.2 */ public void reset() { for (;;) { final boolean marked = cancellableRef.isMarked(); final Cancellable actualCancellable = cancellableRef.getReference(); if (actualCancellable != null) { actualCancellable.cancel(); } if (cancellableRef.compareAndSet(actualCancellable, null, marked, false)) { break; } } } @Override public void abort() throws UnsupportedOperationException { cancel(); } @Override public boolean isAborted() { return isCancelled(); } /** * Sets the request configuration. * * @param requestConfig the request configuration. */ public void setConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; } @Override public RequestConfig getConfig() { return requestConfig; } @Override public String toString() { final StringBuilder sb = new StringBuilder(); sb.append(getMethod()).append(" ").append(getRequestUri()); return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/package-info.java0100644 0000000 0000000 00000002444 00000250600 027665 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Common HTTP methods and message handlers for the classic I/O model. */ package org.apache.hc.client5.http.classic.methods; httpclient5/src/main/java/org/apache/hc/client5/http/config/0040755 0000000 0000000 00000000000 00000250600 022656 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/config/Configurable.java0100644 0000000 0000000 00000002715 00000250600 026123 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; /** * Configuration interface for HTTP requests. * * @since 4.3 */ public interface Configurable { /** * Gets the actual request configuration. * * @return the actual request configuration. */ RequestConfig getConfig(); } httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java0100644 0000000 0000000 00000033460 00000250600 026751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; import java.util.concurrent.TimeUnit; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Immutable class encapsulating connection initialization and management settings. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class ConnectionConfig implements Cloneable { private static final Timeout DEFAULT_CONNECT_TIMEOUT = Timeout.ofMinutes(3); /** * The default connection configuration. *

    *
  • Timeout connectTimeout: 3 minutes
    • *
  • Timeout socketTimeout: {@code null} (undefined)
    • *
  • Timeout idleTimeout: {@code null} (undefined)
    • *
  • TimeValue validateAfterInactivity: {@code null} (undefined)
    • *
  • TimeValue timeToLive: {@code null} (undefined)
    • *
*/ public static final ConnectionConfig DEFAULT = new Builder().build(); private final Timeout connectTimeout; private final Timeout socketTimeout; private final Timeout idleTimeout; private final TimeValue validateAfterInactivity; private final TimeValue timeToLive; /** * Intended for CDI compatibility */ protected ConnectionConfig() { this(DEFAULT_CONNECT_TIMEOUT, null, null, null, null); } ConnectionConfig( final Timeout connectTimeout, final Timeout socketTimeout, final Timeout idleTimeout, final TimeValue validateAfterInactivity, final TimeValue timeToLive) { super(); this.connectTimeout = connectTimeout; this.socketTimeout = socketTimeout; this.idleTimeout = idleTimeout; this.validateAfterInactivity = validateAfterInactivity; this.timeToLive = timeToLive; } /** * Gets the default socket timeout value for I/O operations on connections created by this configuration. * A timeout value of zero is interpreted as an infinite timeout. * * @return the default socket timeout value, defaults to null. * @see Builder#setSocketTimeout(Timeout) */ public Timeout getSocketTimeout() { return socketTimeout; } /** * Gets the timeout until the target endpoint acknowledges accepting the connection request. *

* Note that isn't the same time as the new connection being fully established. An HTTPS connection cannot be considered fully established until the TLS * handshake has been successfully completed. *

*

* A timeout value of zero is interpreted as an infinite timeout. *

* * @return the timeout until the target endpoint acknowledges accepting the connection request, defaults to 3 minutes. * @see Builder#setConnectTimeout(Timeout) */ public Timeout getConnectTimeout() { return connectTimeout; } /** * Gets the maximum period of idleness for a connection. *

* Implementations can use this value to discard connections that have been idle for too long. *

* * @return the maximum period of idleness for a connection, defaults to null. * @see Builder#setIdleTimeout(Timeout) */ public Timeout getIdleTimeout() { return idleTimeout; } /** * Gets the period of inactivity after which persistent connections must be re-validated. * * @return the period of inactivity after which persistent connections must be re-validated, defaults to null. * @see Builder#setValidateAfterInactivity(TimeValue) */ public TimeValue getValidateAfterInactivity() { return validateAfterInactivity; } /** * Gets the total span of time connections can be kept alive or execute requests. * * @return the total span of time connections can be kept alive or execute requests, defaults to null. * @see Builder#setTimeToLive(TimeValue) (TimeValue) */ public TimeValue getTimeToLive() { return timeToLive; } @Override protected ConnectionConfig clone() throws CloneNotSupportedException { return (ConnectionConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("connectTimeout=").append(connectTimeout); builder.append(", socketTimeout=").append(socketTimeout); builder.append(", idleTimeout=").append(idleTimeout); builder.append(", validateAfterInactivity=").append(validateAfterInactivity); builder.append(", timeToLive=").append(timeToLive); builder.append("]"); return builder.toString(); } /** * Creates a new builder for {@link ConnectionConfig}. * * @return a new builder for {@link ConnectionConfig}. */ public static ConnectionConfig.Builder custom() { return new Builder(); } /** * Creates a new builder for {@link ConnectionConfig} based on an existing instance. * * @param config the instance to copy. * @return a new builder for {@link ConnectionConfig}. */ public static ConnectionConfig.Builder copy(final ConnectionConfig config) { return new Builder() .setConnectTimeout(config.getConnectTimeout()) .setSocketTimeout(config.getSocketTimeout()) .setValidateAfterInactivity(config.getValidateAfterInactivity()) .setTimeToLive(config.getTimeToLive()); } /** * Builder for {@link ConnectionConfig}. */ public static class Builder { private Timeout socketTimeout; private Timeout connectTimeout; private Timeout idleTimeout; private TimeValue validateAfterInactivity; private TimeValue timeToLive; Builder() { super(); this.connectTimeout = DEFAULT_CONNECT_TIMEOUT; } /** * Sets the default socket timeout value for I/O operations on connections created by this configuration. * * @param soTimeout The default socket timeout value for I/O operations. * @param timeUnit The time unit of the soTimeout parameter. * @return this instance. * @see #setSocketTimeout(Timeout) */ public Builder setSocketTimeout(final int soTimeout, final TimeUnit timeUnit) { this.socketTimeout = Timeout.of(soTimeout, timeUnit); return this; } /** * Sets the default socket timeout value for I/O operations on * connections created by this configuration. * A timeout value of zero is interpreted as an infinite timeout. *

* This value acts as a baseline at the connection management layer. * This parameter overrides the socket timeout setting applied at the I/O layer * and in its tuen can overridden by settings applied at the protocol layer * for the duration of a message exchange. *

*

* Default: {@code null} (undefined) *

* * @param soTimeout The default socket timeout value for I/O operations. * @return this instance. */ public Builder setSocketTimeout(final Timeout soTimeout) { this.socketTimeout = soTimeout; return this; } /** * Sets the timeout until a new connection is fully established. *

* A timeout value of zero is interpreted as an infinite timeout. *

*

* Default: 3 minutes *

* * @param connectTimeout The timeout until a new connection is fully established. * @return this instance. */ public Builder setConnectTimeout(final Timeout connectTimeout) { this.connectTimeout = connectTimeout; return this; } /** * Sets the timeout until a new connection is fully established. * * @param connectTimeout The timeout until a new connection is fully established. * @param timeUnit The time unit of the timeout parameter. * @return this instance. * @see #setConnectTimeout(Timeout) */ public Builder setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) { this.connectTimeout = Timeout.of(connectTimeout, timeUnit); return this; } /** * Determines the maximum period of idleness for a connection. * Connections that are idle for longer than {@code idleTimeout} are no * longer eligible for reuse. *

* A timeout value of zero is interpreted as an infinite timeout. *

*

* Default: {@code null} (undefined) *

* * @param idleTimeout The maximum period of idleness for a connection. * @return this instance. * * @since 5.6 */ public Builder setIdleTimeout(final Timeout idleTimeout) { this.idleTimeout = idleTimeout; return this; } /** * Sets the maximum period of idleness for a connection. *

* Connections that are idle for longer than {@code idleTimeout} are no longer eligible for reuse. *

* * @param idleTimeout The maximum period of idleness for a connection. * @param timeUnit * @return this instance. * @see #setIdleTimeout(Timeout) */ public Builder setIdleTimeout(final long idleTimeout, final TimeUnit timeUnit) { this.idleTimeout = Timeout.of(idleTimeout, timeUnit); return this; } /** * Sets the period of inactivity after which persistent connections must * be re-validated prior to being leased to the consumer. Negative values passed * to this method disable connection validation. *

* Default: {@code null} (undefined) *

* * @param validateAfterInactivity The period of inactivity after which persistent connections must be re-validated. * @return this instance. */ public Builder setValidateAfterInactivity(final TimeValue validateAfterInactivity) { this.validateAfterInactivity = validateAfterInactivity; return this; } /** * Sets the period of inactivity after which persistent connections must be re-validated prior to being leased to the consumer. * * @param validateAfterInactivity The period of inactivity after which persistent connections must be re-validated. * @param timeUnit The time unit of the validateAfterInactivity parameter. * @return this instance. * @see #setValidateAfterInactivity(TimeValue) */ public Builder setValidateAfterInactivity(final long validateAfterInactivity, final TimeUnit timeUnit) { this.validateAfterInactivity = TimeValue.of(validateAfterInactivity, timeUnit); return this; } /** * Defines the total span of time connections can be kept alive or execute requests. *

* Default: {@code null} (undefined) *

* * @param timeToLive The total span of time connections can be kept alive or execute requests. * @return this instance. */ public Builder setTimeToLive(final TimeValue timeToLive) { this.timeToLive = timeToLive; return this; } /** * Sets the total span of time connections can be kept alive or execute requests. * * @param timeToLive The total span of time connections can be kept alive or execute requests. * @param timeUnit The time unit of the timeToLive parameter. * @return this instance. * @see #setTimeToLive(TimeValue) */ public Builder setTimeToLive(final long timeToLive, final TimeUnit timeUnit) { this.timeToLive = TimeValue.of(timeToLive, timeUnit); return this; } /** * Builds a new {@link ConnectionConfig} instance based on the values provided to the setters methods. * * @return a new {@link ConnectionConfig} instance. */ public ConnectionConfig build() { return new ConnectionConfig( connectTimeout != null ? connectTimeout : DEFAULT_CONNECT_TIMEOUT, socketTimeout, idleTimeout, validateAfterInactivity, timeToLive); } } } httpclient5/src/main/java/org/apache/hc/client5/http/config/RequestConfig.java0100644 0000000 0000000 00000062717 00000250600 026311 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; import java.nio.file.Path; import java.util.Collection; import java.util.concurrent.TimeUnit; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http2.priority.PriorityValue; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Immutable class encapsulating request configuration items. */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class RequestConfig implements Cloneable { private static final Timeout DEFAULT_CONNECTION_REQUEST_TIMEOUT = Timeout.ofMinutes(3); private static final TimeValue DEFAULT_CONN_KEEP_ALIVE = TimeValue.ofMinutes(3); public static final RequestConfig DEFAULT = new Builder().build(); private final boolean expectContinueEnabled; private final HttpHost proxy; private final String cookieSpec; private final boolean redirectsEnabled; private final boolean circularRedirectsAllowed; private final int maxRedirects; private final boolean authenticationEnabled; private final Collection targetPreferredAuthSchemes; private final Collection proxyPreferredAuthSchemes; private final Timeout connectionRequestTimeout; private final Timeout connectTimeout; private final Timeout responseTimeout; private final TimeValue connectionKeepAlive; private final boolean contentCompressionEnabled; private final boolean hardCancellationEnabled; private final boolean protocolUpgradeEnabled; private final Path unixDomainSocket; /** * HTTP/2 Priority header value to emit when using H2+. Null means “don’t emit”. */ private final PriorityValue h2Priority; /** * Intended for CDI compatibility */ protected RequestConfig() { this(false, null, null, false, false, 0, false, null, null, DEFAULT_CONNECTION_REQUEST_TIMEOUT, null, null, DEFAULT_CONN_KEEP_ALIVE, false, false, false, null, null); } RequestConfig( final boolean expectContinueEnabled, final HttpHost proxy, final String cookieSpec, final boolean redirectsEnabled, final boolean circularRedirectsAllowed, final int maxRedirects, final boolean authenticationEnabled, final Collection targetPreferredAuthSchemes, final Collection proxyPreferredAuthSchemes, final Timeout connectionRequestTimeout, final Timeout connectTimeout, final Timeout responseTimeout, final TimeValue connectionKeepAlive, final boolean contentCompressionEnabled, final boolean hardCancellationEnabled, final boolean protocolUpgradeEnabled, final Path unixDomainSocket, final PriorityValue h2Priority) { super(); this.expectContinueEnabled = expectContinueEnabled; this.proxy = proxy; this.cookieSpec = cookieSpec; this.redirectsEnabled = redirectsEnabled; this.circularRedirectsAllowed = circularRedirectsAllowed; this.maxRedirects = maxRedirects; this.authenticationEnabled = authenticationEnabled; this.targetPreferredAuthSchemes = targetPreferredAuthSchemes; this.proxyPreferredAuthSchemes = proxyPreferredAuthSchemes; this.connectionRequestTimeout = connectionRequestTimeout; this.connectTimeout = connectTimeout; this.responseTimeout = responseTimeout; this.connectionKeepAlive = connectionKeepAlive; this.contentCompressionEnabled = contentCompressionEnabled; this.hardCancellationEnabled = hardCancellationEnabled; this.protocolUpgradeEnabled = protocolUpgradeEnabled; this.unixDomainSocket = unixDomainSocket; this.h2Priority = h2Priority; } /** * @see Builder#setExpectContinueEnabled(boolean) */ public boolean isExpectContinueEnabled() { return expectContinueEnabled; } /** * @see Builder#setProxy(HttpHost) */ public HttpHost getProxy() { return proxy; } /** * @see Builder#setCookieSpec(String) */ public String getCookieSpec() { return cookieSpec; } /** * @see Builder#setRedirectsEnabled(boolean) */ public boolean isRedirectsEnabled() { return redirectsEnabled; } /** * @see Builder#setCircularRedirectsAllowed(boolean) */ public boolean isCircularRedirectsAllowed() { return circularRedirectsAllowed; } /** * @see Builder#setMaxRedirects(int) */ public int getMaxRedirects() { return maxRedirects; } /** * @see Builder#setAuthenticationEnabled(boolean) */ public boolean isAuthenticationEnabled() { return authenticationEnabled; } /** * @see Builder#setTargetPreferredAuthSchemes(Collection) */ public Collection getTargetPreferredAuthSchemes() { return targetPreferredAuthSchemes; } /** * @see Builder#setProxyPreferredAuthSchemes(Collection) */ public Collection getProxyPreferredAuthSchemes() { return proxyPreferredAuthSchemes; } /** * @see Builder#setConnectionRequestTimeout(Timeout) */ public Timeout getConnectionRequestTimeout() { return connectionRequestTimeout; } /** * @see Builder#setConnectTimeout(Timeout) * * @deprecated Use {@link ConnectionConfig#getConnectTimeout()}. */ @Deprecated public Timeout getConnectTimeout() { return connectTimeout; } /** * @see Builder#setResponseTimeout(Timeout) */ public Timeout getResponseTimeout() { return responseTimeout; } /** * @see Builder#setConnectionKeepAlive(TimeValue) */ public TimeValue getConnectionKeepAlive() { return connectionKeepAlive; } /** * @see Builder#setContentCompressionEnabled(boolean) */ public boolean isContentCompressionEnabled() { return contentCompressionEnabled; } /** * @see Builder#setHardCancellationEnabled(boolean) */ public boolean isHardCancellationEnabled() { return hardCancellationEnabled; } /** * @see Builder#setProtocolUpgradeEnabled(boolean) (boolean) */ public boolean isProtocolUpgradeEnabled() { return protocolUpgradeEnabled; } /** * @see Builder#setUnixDomainSocket(Path) */ public Path getUnixDomainSocket() { return unixDomainSocket; } /** * Returns the HTTP/2+ priority preference for this request or {@code null} if unset. * @since 5.6 */ @Experimental public PriorityValue getH2Priority() { return h2Priority; } @Override protected RequestConfig clone() throws CloneNotSupportedException { return (RequestConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("expectContinueEnabled=").append(expectContinueEnabled); builder.append(", proxy=").append(proxy); builder.append(", cookieSpec=").append(cookieSpec); builder.append(", redirectsEnabled=").append(redirectsEnabled); builder.append(", maxRedirects=").append(maxRedirects); builder.append(", circularRedirectsAllowed=").append(circularRedirectsAllowed); builder.append(", authenticationEnabled=").append(authenticationEnabled); builder.append(", targetPreferredAuthSchemes=").append(targetPreferredAuthSchemes); builder.append(", proxyPreferredAuthSchemes=").append(proxyPreferredAuthSchemes); builder.append(", connectionRequestTimeout=").append(connectionRequestTimeout); builder.append(", connectTimeout=").append(connectTimeout); builder.append(", responseTimeout=").append(responseTimeout); builder.append(", connectionKeepAlive=").append(connectionKeepAlive); builder.append(", contentCompressionEnabled=").append(contentCompressionEnabled); builder.append(", hardCancellationEnabled=").append(hardCancellationEnabled); builder.append(", protocolUpgradeEnabled=").append(protocolUpgradeEnabled); builder.append(", unixDomainSocket=").append(unixDomainSocket); builder.append(", h2Priority=").append(h2Priority); builder.append("]"); return builder.toString(); } public static RequestConfig.Builder custom() { return new Builder(); } @SuppressWarnings("deprecation") public static RequestConfig.Builder copy(final RequestConfig config) { return new Builder() .setExpectContinueEnabled(config.isExpectContinueEnabled()) .setProxy(config.getProxy()) .setCookieSpec(config.getCookieSpec()) .setRedirectsEnabled(config.isRedirectsEnabled()) .setCircularRedirectsAllowed(config.isCircularRedirectsAllowed()) .setMaxRedirects(config.getMaxRedirects()) .setAuthenticationEnabled(config.isAuthenticationEnabled()) .setTargetPreferredAuthSchemes(config.getTargetPreferredAuthSchemes()) .setProxyPreferredAuthSchemes(config.getProxyPreferredAuthSchemes()) .setConnectionRequestTimeout(config.getConnectionRequestTimeout()) .setConnectTimeout(config.getConnectTimeout()) .setResponseTimeout(config.getResponseTimeout()) .setConnectionKeepAlive(config.getConnectionKeepAlive()) .setContentCompressionEnabled(config.isContentCompressionEnabled()) .setHardCancellationEnabled(config.isHardCancellationEnabled()) .setProtocolUpgradeEnabled(config.isProtocolUpgradeEnabled()) .setUnixDomainSocket(config.getUnixDomainSocket()) .setH2Priority(config.getH2Priority()); } public static class Builder { private boolean expectContinueEnabled; private HttpHost proxy; private String cookieSpec; private boolean redirectsEnabled; private boolean circularRedirectsAllowed; private int maxRedirects; private boolean authenticationEnabled; private Collection targetPreferredAuthSchemes; private Collection proxyPreferredAuthSchemes; private Timeout connectionRequestTimeout; private Timeout connectTimeout; private Timeout responseTimeout; private TimeValue connectionKeepAlive; private boolean contentCompressionEnabled; private boolean hardCancellationEnabled; private boolean protocolUpgradeEnabled; private Path unixDomainSocket; private PriorityValue h2Priority; Builder() { super(); this.redirectsEnabled = true; this.maxRedirects = 50; this.authenticationEnabled = true; this.connectionRequestTimeout = DEFAULT_CONNECTION_REQUEST_TIMEOUT; this.contentCompressionEnabled = true; this.hardCancellationEnabled = true; this.protocolUpgradeEnabled = true; } /** * Determines whether the 'Expect: 100-Continue' handshake is enabled * for entity enclosing methods. The purpose of the 'Expect: 100-Continue' * handshake is to allow a client that is sending a request message with * a request body to determine if the origin server is willing to * accept the request (based on the request headers) before the client * sends the request body. *

* The use of the 'Expect: 100-continue' handshake can result in * a noticeable performance improvement for entity enclosing requests * (such as POST and PUT) that require the target server's * authentication. *

*

* 'Expect: 100-continue' handshake should be used with caution, as it * may cause problems with HTTP servers and proxies that do not support * HTTP/1.1 protocol. *

*

* Default: {@code false} *

* * @return this instance. */ public Builder setExpectContinueEnabled(final boolean expectContinueEnabled) { this.expectContinueEnabled = expectContinueEnabled; return this; } /** * Returns HTTP proxy to be used for request execution. *

* Default: {@code null} *

* * @return this instance. */ public Builder setProxy(final HttpHost proxy) { this.proxy = proxy; return this; } /** * Determines the name of the cookie specification to be used for HTTP state * management. *

* Default: {@code null} *

* * @return this instance. */ public Builder setCookieSpec(final String cookieSpec) { this.cookieSpec = cookieSpec; return this; } /** * Determines whether redirects should be handled automatically. *

* Default: {@code true} *

* * @return this instance. */ public Builder setRedirectsEnabled(final boolean redirectsEnabled) { this.redirectsEnabled = redirectsEnabled; return this; } /** * Determines whether circular redirects (redirects to the same location) should * be allowed. The HTTP spec is not sufficiently clear whether circular redirects * are permitted, therefore optionally they can be enabled *

* Default: {@code false} *

* * @return this instance. */ public Builder setCircularRedirectsAllowed(final boolean circularRedirectsAllowed) { this.circularRedirectsAllowed = circularRedirectsAllowed; return this; } /** * Returns the maximum number of redirects to be followed. The limit on number * of redirects is intended to prevent infinite loops. *

* Default: {@code 50} *

* * @return this instance. */ public Builder setMaxRedirects(final int maxRedirects) { this.maxRedirects = maxRedirects; return this; } /** * Determines whether authentication should be handled automatically. *

* Default: {@code true} *

* * @return this instance. */ public Builder setAuthenticationEnabled(final boolean authenticationEnabled) { this.authenticationEnabled = authenticationEnabled; return this; } /** * Determines the order of preference for supported authentication schemes * by their names when authenticating with the target host. *

* Default: {@code null} *

* * @return this instance. */ public Builder setTargetPreferredAuthSchemes(final Collection targetPreferredAuthSchemes) { this.targetPreferredAuthSchemes = targetPreferredAuthSchemes; return this; } /** * Determines the order of preference for supported authentication schemes * by their names when authenticating with the proxy host. *

* Default: {@code null} *

* * @return this instance. */ public Builder setProxyPreferredAuthSchemes(final Collection proxyPreferredAuthSchemes) { this.proxyPreferredAuthSchemes = proxyPreferredAuthSchemes; return this; } /** * Returns the connection lease request timeout used when requesting * a connection from the connection manager. *

* Default: 3 minutes. *

* * @return this instance. */ public Builder setConnectionRequestTimeout(final Timeout connectionRequestTimeout) { this.connectionRequestTimeout = connectionRequestTimeout; return this; } /** * @return this instance. * @see #setConnectionRequestTimeout(Timeout) */ public Builder setConnectionRequestTimeout(final long connectionRequestTimeout, final TimeUnit timeUnit) { this.connectionRequestTimeout = Timeout.of(connectionRequestTimeout, timeUnit); return this; } /** * Determines the timeout until a new connection is fully established. * This may also include transport security negotiation exchanges * such as {@code SSL} or {@code TLS} protocol negotiation). *

* A timeout value of zero is interpreted as an infinite timeout. *

*

* Default: 3 minutes *

* * @return this instance. * @deprecated Use {@link ConnectionConfig.Builder#setConnectTimeout(Timeout)}. */ @Deprecated public Builder setConnectTimeout(final Timeout connectTimeout) { this.connectTimeout = connectTimeout; return this; } /** * @see #setConnectTimeout(Timeout) * * @return this instance. * @deprecated Use {@link ConnectionConfig.Builder#setConnectTimeout(long, TimeUnit)}. */ @Deprecated public Builder setConnectTimeout(final long connectTimeout, final TimeUnit timeUnit) { this.connectTimeout = Timeout.of(connectTimeout, timeUnit); return this; } /** * Determines the timeout until arrival of a response from the opposite * endpoint. *

* A timeout value of zero is interpreted as an infinite timeout. *

*

* Please note that response timeout may be unsupported by * HTTP transports with message multiplexing. *

*

* This parameter overrides the socket timeout setting applied at the connection * management or I/O layers for the duration of a message exchange. *

*

* Please note that response timeout is not a deadline. Its absolute value * can be exceeded, for example, in case of automatic request re-execution. * Please make sure the automatic request re-execution policy has been * configured appropriately. *

*

* Default: {@code null} *

* * @return this instance. * @since 5.0 */ public Builder setResponseTimeout(final Timeout responseTimeout) { this.responseTimeout = responseTimeout; return this; } /** * @see #setResponseTimeout(Timeout) */ public Builder setResponseTimeout(final long responseTimeout, final TimeUnit timeUnit) { this.responseTimeout = Timeout.of(responseTimeout, timeUnit); return this; } /** * Determines the default of value of connection keep-alive time period when not * explicitly communicated by the origin server with a {@code Keep-Alive} response * header. *

* A negative value is interpreted as an infinite keep-alive period. *

*

* Default: 3 minutes *

* * @return this instance. * @since 5.0 */ public Builder setConnectionKeepAlive(final TimeValue connectionKeepAlive) { this.connectionKeepAlive = connectionKeepAlive; return this; } /** * @return this instance. * @see #setConnectionKeepAlive(TimeValue) */ public Builder setDefaultKeepAlive(final long defaultKeepAlive, final TimeUnit timeUnit) { this.connectionKeepAlive = TimeValue.of(defaultKeepAlive, timeUnit); return this; } /** * Determines whether the target server is requested to compress content. *

* Default: {@code true} *

* * @return this instance. * @since 4.5 */ public Builder setContentCompressionEnabled(final boolean contentCompressionEnabled) { this.contentCompressionEnabled = contentCompressionEnabled; return this; } /** * Determines whether request cancellation, such as through {@code * Future#cancel(boolean)}, should kill the underlying connection. If this * option is set to false, the client will attempt to preserve the * underlying connection by allowing the request to complete in the * background, discarding the response. *

* Note that when this option is {@code true}, cancelling a request may * cause other requests to fail, if they are waiting to use the same * connection. *

*

* On HTTP/2, this option has no effect. Request cancellation will always * result in the stream being cancelled with a {@code RST_STREAM}. This * has no effect on connection reuse. *

*

* On non-asynchronous clients, this option has no effect. Request * cancellation, such as through {@code HttpUriRequestBase#cancel()}, will * always kill the underlying connection. *

*

* Default: {@code true} *

* * @return this instance. * @since 5.0 */ public Builder setHardCancellationEnabled(final boolean hardCancellationEnabled) { this.hardCancellationEnabled = hardCancellationEnabled; return this; } /** * Determines whether the client server should automatically attempt to upgrade * to a safer or a newer version of the protocol, whenever possible. *

* Presently supported: HTTP/1.1 TLS upgrade *

*

* Default: {@code true} *

* * @return this instance. * @since 5.4 */ public Builder setProtocolUpgradeEnabled(final boolean protocolUpgradeEnabled) { this.protocolUpgradeEnabled = protocolUpgradeEnabled; return this; } /** * Sets the Unix Domain Socket path to use for the connection. *

* When set, the connection will use the specified Unix Domain Socket * instead of a TCP socket. This is useful for communicating with local * services like Docker or systemd. *

*

* Default: {@code null} *

* * @return this instance. * @since 5.6 */ public Builder setUnixDomainSocket(final Path unixDomainSocket) { this.unixDomainSocket = unixDomainSocket; return this; } /** * Sets HTTP/2+ request priority. If {@code null}, the header is not emitted. * @since 5.6 */ @Experimental public Builder setH2Priority(final PriorityValue priority) { this.h2Priority = priority; return this; } public RequestConfig build() { return new RequestConfig( expectContinueEnabled, proxy, cookieSpec, redirectsEnabled, circularRedirectsAllowed, maxRedirects, authenticationEnabled, targetPreferredAuthSchemes, proxyPreferredAuthSchemes, connectionRequestTimeout != null ? connectionRequestTimeout : DEFAULT_CONNECTION_REQUEST_TIMEOUT, connectTimeout, responseTimeout, connectionKeepAlive != null ? connectionKeepAlive : DEFAULT_CONN_KEEP_ALIVE, contentCompressionEnabled, hardCancellationEnabled, protocolUpgradeEnabled, unixDomainSocket, h2Priority); } } } httpclient5/src/main/java/org/apache/hc/client5/http/config/TlsConfig.java0100644 0000000 0000000 00000017000 00000250600 025404 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; import java.util.Arrays; import java.util.concurrent.TimeUnit; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.util.Timeout; /** * Immutable class encapsulating TLS protocol settings. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class TlsConfig implements Cloneable { public static final TlsConfig DEFAULT = new Builder().build(); private final Timeout handshakeTimeout; private final String[] supportedProtocols; private final String[] supportedCipherSuites; private final HttpVersionPolicy httpVersionPolicy; /** * Intended for CDI compatibility */ protected TlsConfig() { this(null, null, null, null); } TlsConfig( final Timeout handshakeTimeout, final String[] supportedProtocols, final String[] supportedCipherSuites, final HttpVersionPolicy httpVersionPolicy) { super(); this.handshakeTimeout = handshakeTimeout; this.supportedProtocols = supportedProtocols; this.supportedCipherSuites = supportedCipherSuites; this.httpVersionPolicy = httpVersionPolicy; } /** * @see Builder#setHandshakeTimeout(Timeout) */ public Timeout getHandshakeTimeout() { return handshakeTimeout; } /** * @see Builder#setSupportedProtocols(String...) */ public String[] getSupportedProtocols() { return supportedProtocols != null ? supportedProtocols.clone() : null; } /** * @see Builder#setSupportedCipherSuites(String...) */ public String[] getSupportedCipherSuites() { return supportedCipherSuites != null ? supportedCipherSuites.clone() : null; } /** * @see Builder#setVersionPolicy(HttpVersionPolicy) */ public HttpVersionPolicy getHttpVersionPolicy() { return httpVersionPolicy; } @Override protected TlsConfig clone() throws CloneNotSupportedException { return (TlsConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("handshakeTimeout=").append(handshakeTimeout); builder.append(", supportedProtocols=").append(Arrays.toString(supportedProtocols)); builder.append(", supportedCipherSuites=").append(Arrays.toString(supportedCipherSuites)); builder.append(", httpVersionPolicy=").append(httpVersionPolicy); builder.append("]"); return builder.toString(); } public static TlsConfig.Builder custom() { return new Builder(); } public static TlsConfig.Builder copy(final TlsConfig config) { return new Builder() .setHandshakeTimeout(config.getHandshakeTimeout()) .setSupportedProtocols(config.getSupportedProtocols()) .setSupportedCipherSuites(config.getSupportedCipherSuites()) .setVersionPolicy(config.getHttpVersionPolicy()); } public static class Builder { private Timeout handshakeTimeout; private String[] supportedProtocols; private String[] supportedCipherSuites; private HttpVersionPolicy versionPolicy; /** * Determines the timeout used by TLS session negotiation exchanges (session handshake). *

* A timeout value of zero is interpreted as an infinite timeout. *

*

* Default: {@code null} (undefined) *

* * @return this instance. */ public Builder setHandshakeTimeout(final Timeout handshakeTimeout) { this.handshakeTimeout = handshakeTimeout; return this; } /** * @return this instance. * @see #setHandshakeTimeout(Timeout) */ public Builder setHandshakeTimeout(final long handshakeTimeout, final TimeUnit timeUnit) { this.handshakeTimeout = Timeout.of(handshakeTimeout, timeUnit); return this; } /** * Determines supported TLS protocols. *

* Default: {@code null} (undefined) *

* * @return this instance. */ public Builder setSupportedProtocols(final String... supportedProtocols) { this.supportedProtocols = supportedProtocols; return this; } /** * Determines supported TLS protocols. *

* Default: {@code null} (undefined) *

* * @return this instance. */ public Builder setSupportedProtocols(final TLS... supportedProtocols) { this.supportedProtocols = new String[supportedProtocols.length]; for (int i = 0; i < supportedProtocols.length; i++) { final TLS protocol = supportedProtocols[i]; if (protocol != null) { this.supportedProtocols[i] = protocol.id; } } return this; } /** * Determines supported cipher suites. *

* Default: {@code null} (undefined) *

* * @return this instance. */ public Builder setSupportedCipherSuites(final String... supportedCipherSuites) { this.supportedCipherSuites = supportedCipherSuites; return this; } /** * Determines the HTTP protocol policy. By default, connections are expected to use TLS ALPN * extension to negotiate the application protocol to be used by both endpoints. *

* Default: {@link HttpVersionPolicy#NEGOTIATE} *

* * @return this instance. */ public Builder setVersionPolicy(final HttpVersionPolicy versionPolicy) { this.versionPolicy = versionPolicy; return this; } public TlsConfig build() { return new TlsConfig( handshakeTimeout, supportedProtocols, supportedCipherSuites, versionPolicy != null ? versionPolicy : HttpVersionPolicy.NEGOTIATE); } } } httpclient5/src/main/java/org/apache/hc/client5/http/config/package-info.java0100644 0000000 0000000 00000002367 00000250600 026052 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client configuration APIs. */ package org.apache.hc.client5.http.config; httpclient5/src/main/java/org/apache/hc/client5/http/cookie/0040755 0000000 0000000 00000000000 00000250600 022662 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/cookie/BasicCookieStore.java0100644 0000000 0000000 00000014372 00000250600 026721 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.IOException; import java.io.ObjectInputStream; import java.io.Serializable; import java.time.Instant; import java.util.ArrayList; import java.util.Date; import java.util.Iterator; import java.util.List; import java.util.TreeSet; import java.util.concurrent.locks.ReadWriteLock; import java.util.concurrent.locks.ReentrantReadWriteLock; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Default implementation of {@link CookieStore} * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicCookieStore implements CookieStore, Serializable { private static final long serialVersionUID = -7581093305228232025L; private final TreeSet cookies; private transient ReadWriteLock lock; public BasicCookieStore() { super(); this.cookies = new TreeSet<>(CookieIdentityComparator.INSTANCE); this.lock = new ReentrantReadWriteLock(); } private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException { stream.defaultReadObject(); /* Reinstantiate transient fields. */ this.lock = new ReentrantReadWriteLock(); } /** * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies. * If the given cookie has already expired it will not be added, but existing * values will still be removed. * * @param cookie the {@link Cookie cookie} to be added * * @see #addCookies(Cookie[]) * */ @Override public void addCookie(final Cookie cookie) { if (cookie != null) { lock.writeLock().lock(); try { // first remove any old cookie that is equivalent cookies.remove(cookie); if (!cookie.isExpired(Instant.now())) { cookies.add(cookie); } } finally { lock.writeLock().unlock(); } } } /** * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and * in the given array order. If any of the given cookies has already expired it will * not be added, but existing values will still be removed. * * @param cookies the {@link Cookie cookies} to be added * * @see #addCookie(Cookie) * */ public void addCookies(final Cookie[] cookies) { if (cookies != null) { for (final Cookie cookie : cookies) { this.addCookie(cookie); } } } /** * Returns an immutable array of {@link Cookie cookies} that this HTTP * state currently contains. * * @return an array of {@link Cookie cookies}. */ @Override public List getCookies() { lock.readLock().lock(); try { //create defensive copy so it won't be concurrently modified return new ArrayList<>(cookies); } finally { lock.readLock().unlock(); } } /** * Removes all of {@link Cookie cookies} in this HTTP state * that have expired by the specified {@link Date date}. * * @return true if any cookies were purged. * * @see Cookie#isExpired(Date) */ @Override @SuppressWarnings("deprecation") public boolean clearExpired(final Date date) { if (date == null) { return false; } lock.writeLock().lock(); try { boolean removed = false; for (final Iterator it = cookies.iterator(); it.hasNext(); ) { if (it.next().isExpired(date)) { it.remove(); removed = true; } } return removed; } finally { lock.writeLock().unlock(); } } /** * Removes all of {@link Cookie cookies} in this HTTP state that have expired by the specified * {@link Instant date}. * * @return true if any cookies were purged. * @see Cookie#isExpired(Instant) * @since 5.2 */ @Override public boolean clearExpired(final Instant instant) { if (instant == null) { return false; } lock.writeLock().lock(); try { boolean removed = false; for (final Iterator it = cookies.iterator(); it.hasNext(); ) { if (it.next().isExpired(instant)) { it.remove(); removed = true; } } return removed; } finally { lock.writeLock().unlock(); } } /** * Clears all cookies. */ @Override public void clear() { lock.writeLock().lock(); try { cookies.clear(); } finally { lock.writeLock().unlock(); } } @Override public String toString() { lock.readLock().lock(); try { return cookies.toString(); } finally { lock.readLock().unlock(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CommonCookieAttributeHandler.java0100644 0000000 0000000 00000003037 00000250600 031271 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Extension of {@link org.apache.hc.client5.http.cookie.CookieAttributeHandler} intended * to handle one specific common attribute whose name is returned with * {@link #getAttributeName()} method. * * @since 4.4 */ public interface CommonCookieAttributeHandler extends CookieAttributeHandler { String getAttributeName(); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/Cookie.java0100644 0000000 0000000 00000012702 00000250600 024735 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Date; /** * Cookie interface represents a token or short packet of state information * (also referred to as "magic-cookie") that the HTTP agent and the target * server can exchange to maintain a session. In its simples form an HTTP * cookie is merely a name / value pair. * * @since 4.0 */ public interface Cookie { String PATH_ATTR = "path"; String DOMAIN_ATTR = "domain"; String MAX_AGE_ATTR = "max-age"; String SECURE_ATTR = "secure"; String EXPIRES_ATTR = "expires"; String HTTP_ONLY_ATTR = "httponly"; /** * @since 5.0 */ String getAttribute(String name); /** * @since 5.0 */ boolean containsAttribute(String name); /** * Returns the name. * * @return String name The name */ String getName(); /** * Returns the value. * * @return String value The current value. */ String getValue(); /** * Returns the expiration {@link Date} of the cookie, or {@code null} * if none exists. *

Note: the object returned by this method is * considered immutable. Changing it (e.g. using setTime()) could result * in undefined behaviour. Do so at your peril.

* @return Expiration {@link Date}, or {@code null}. * @deprecated Use {{@link #getExpiryInstant()}} */ @Deprecated Date getExpiryDate(); /** * Returns the expiration {@link Instant} of the cookie, or {@code null} if none exists. *

Note: the object returned by this method is * considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. * Do so at your peril.

* * @return Expiration {@link Instant}, or {@code null}. * @since 5.2 */ @SuppressWarnings("deprecated") default Instant getExpiryInstant() { final Date date = getExpiryDate(); return date != null ? Instant.ofEpochMilli(date.getTime()) : null; } /** * Returns {@code false} if the cookie should be discarded at the end * of the "session"; {@code true} otherwise. * * @return {@code false} if the cookie should be discarded at the end * of the "session"; {@code true} otherwise */ boolean isPersistent(); /** * Returns domain attribute of the cookie. The value of the Domain * attribute specifies the domain for which the cookie is valid. * * @return the value of the domain attribute. */ String getDomain(); /** * Returns the path attribute of the cookie. The value of the Path * attribute specifies the subset of URLs on the origin server to which * this cookie applies. * * @return The value of the path attribute. */ String getPath(); /** * Indicates whether this cookie requires a secure connection. * * @return {@code true} if this cookie should only be sent * over secure connections, {@code false} otherwise. */ boolean isSecure(); /** * Returns true if this cookie has expired. * @param date Current time * * @return {@code true} if the cookie has expired. * @deprecated Use {{@link #isExpired(Instant)}} */ @Deprecated boolean isExpired(final Date date); /** * Returns true if this cookie has expired. * * @param date Current time * @return {@code true} if the cookie has expired. * @since 5.2 */ @SuppressWarnings("deprecation") default boolean isExpired(final Instant date) { return isExpired(date != null ? new Date(date.toEpochMilli()) : null); } /** * Returns creation time of the cookie. * @deprecated Use {@link #getCreationInstant()} */ @Deprecated Date getCreationDate(); /** * Returns creation time of the cookie. */ default Instant getCreationInstant() { return null; } /** * Checks whether this Cookie has been marked as {@code httpOnly}. *

The default implementation returns {@code false}. * * @return true if this Cookie has been marked as {@code httpOnly}, * false otherwise * * @since 5.2 */ default boolean isHttpOnly() { return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieAttributeHandler.java0100644 0000000 0000000 00000006015 00000250600 030117 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This interface represents a cookie attribute handler responsible * for parsing, validating, and matching a specific cookie attribute, * such as path, domain, port, etc. *

* Different cookie specifications can provide a specific * implementation for this class based on their cookie handling * rules. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface CookieAttributeHandler { /** * Parse the given cookie attribute value and processChallenge the corresponding * {@link org.apache.hc.client5.http.cookie.Cookie} property. * * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to be updated * @param value cookie attribute value from the cookie response header * @throws MalformedCookieException if cookie parsing fails for this attribute */ void parse(SetCookie cookie, String value) throws MalformedCookieException; /** * Performs cookie validation for the given attribute value. * * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to validate * @param origin the cookie source to validate against * @throws MalformedCookieException if cookie validation fails for this attribute */ void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException; /** * Matches the given value (property of the destination host where request is being * submitted) with the corresponding cookie attribute. * * @param cookie {@link org.apache.hc.client5.http.cookie.Cookie} to match * @param origin the cookie source to match against * @return {@code true} if the match is successful; {@code false} otherwise */ boolean match(Cookie cookie, CookieOrigin origin); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieIdentityComparator.java0100644 0000000 0000000 00000005405 00000250600 030501 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.Serializable; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator can be used to compare identity of cookies. *

* Cookies are considered identical if their names are equal and * their domain attributes match ignoring case. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookieIdentityComparator implements Serializable, Comparator { /** * Default instance of {@link CookieIdentityComparator}. * * @since 5.2 */ public static final CookieIdentityComparator INSTANCE = new CookieIdentityComparator(); private static final long serialVersionUID = 4466565437490631532L; @Override public int compare(final Cookie c1, final Cookie c2) { int res = c1.getName().compareTo(c2.getName()); if (res == 0) { // do not differentiate empty and null domains String d1 = c1.getDomain(); if (d1 == null) { d1 = ""; } String d2 = c2.getDomain(); if (d2 == null) { d2 = ""; } res = d1.compareToIgnoreCase(d2); } if (res == 0) { String p1 = c1.getPath(); if (p1 == null) { p1 = "/"; } String p2 = c2.getPath(); if (p2 == null) { p2 = "/"; } res = p1.compareTo(p2); } return res; } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieOrigin.java0100644 0000000 0000000 00000005601 00000250600 026105 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.util.Locale; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * CookieOrigin class encapsulates details of an origin server that * are relevant when parsing, validating or matching HTTP cookies. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class CookieOrigin { private final String host; private final int port; private final String path; private final boolean secure; public CookieOrigin(final String host, final int port, final String path, final boolean secure) { super(); Args.notBlank(host, "Host"); Args.notNegative(port, "Port"); Args.notNull(path, "Path"); this.host = host.toLowerCase(Locale.ROOT); this.port = port; if (!TextUtils.isBlank(path)) { this.path = path; } else { this.path = "/"; } this.secure = secure; } public String getHost() { return this.host; } public String getPath() { return this.path; } public int getPort() { return this.port; } public boolean isSecure() { return this.secure; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append('['); if (this.secure) { buffer.append("(secure)"); } buffer.append(this.host); buffer.append(':'); buffer.append(this.port); buffer.append(this.path); buffer.append(']'); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookiePathComparator.java0100644 0000000 0000000 00000005523 00000250600 027605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.Serializable; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator ensures that multiple cookies satisfying * a common criteria are ordered in the {@link Cookie} header such * that those with more specific Path attributes precede those with * less specific. * *

* This comparator assumes that Path attributes of two cookies * path-match a common request-URI. Otherwise, the result of the * comparison is undefined. *

* * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookiePathComparator implements Serializable, Comparator { /** * Default instance of {@link CookiePathComparator}. */ public static final CookiePathComparator INSTANCE = new CookiePathComparator(); private static final long serialVersionUID = 7523645369616405818L; private String normalizePath(final Cookie cookie) { String path = cookie.getPath(); if (path == null) { path = "/"; } if (!path.endsWith("/")) { path = path + '/'; } return path; } @Override public int compare(final Cookie c1, final Cookie c2) { final String path1 = normalizePath(c1); final String path2 = normalizePath(c2); if (path1.equals(path2)) { return 0; } else if (path1.startsWith(path2)) { return -1; } else if (path2.startsWith(path1)) { return 1; } else { // Does not really matter return 0; } } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookiePriorityComparator.java0100644 0000000 0000000 00000005025 00000250600 030527 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator ensures that cookies with longer paths take precedence over * cookies with shorter path. Among cookies with equal path length cookies with earlier * creation time take precedence over cookies with later creation time * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookiePriorityComparator implements Comparator { /** * Default instance of {@link CookiePriorityComparator}. */ public static final CookiePriorityComparator INSTANCE = new CookiePriorityComparator(); private int getPathLength(final Cookie cookie) { final String path = cookie.getPath(); return path != null ? path.length() : 1; } @Override public int compare(final Cookie c1, final Cookie c2) { final int l1 = getPathLength(c1); final int l2 = getPathLength(c2); final int result = l2 - l1; if (result == 0) { final Instant d1 = c1.getCreationInstant(); final Instant d2 = c2.getCreationInstant(); if (d1 != null && d2 != null) { return d1.compareTo(d2); } } return result; } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieRestrictionViolationException.javahttpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieRestrictionViolationException.java0100644 0000000 0000000 00000003646 00000250600 032736 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Signals that a cookie violates a restriction imposed by the cookie * specification. * * @since 4.1 */ public class CookieRestrictionViolationException extends MalformedCookieException { private static final long serialVersionUID = 7371235577078589013L; /** * Creates a new CookeFormatViolationException with a {@code null} detail * message. */ public CookieRestrictionViolationException() { super(); } /** * Creates a new CookeRestrictionViolationException with a specified * message string. * * @param message The exception detail message */ public CookieRestrictionViolationException(final String message) { super(message); } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieSpec.java0100644 0000000 0000000 00000006367 00000250600 025562 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.util.List; import org.apache.hc.core5.http.Header; /** * Defines the cookie management specification. *

Cookie management specification must define *

    *
  • rules of parsing "Set-Cookie" header *
  • rules of validation of parsed cookies *
  • formatting of "Cookie" header *
* for a given host, port and path of origin * * @since 4.0 */ public interface CookieSpec { /** * Parse the {@code "Set-Cookie"} Header into an array of Cookies. * *

This method will not perform the validation of the resultant * {@link Cookie}s

* * @see #validate * * @param header the {@code Set-Cookie} received from the server * @param origin details of the cookie origin * @return an array of {@code Cookie}s parsed from the header * @throws MalformedCookieException if an exception occurs during parsing */ List parse(Header header, CookieOrigin origin) throws MalformedCookieException; /** * Validate the cookie according to validation rules defined by the * cookie specification. * * @param cookie the Cookie to validate * @param origin details of the cookie origin * @throws MalformedCookieException if the cookie is invalid */ void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException; /** * Determines if a Cookie matches the target location. * * @param cookie the Cookie to be matched * @param origin the target to test against * * @return {@code true} if the cookie should be submitted with a request * with given attributes, {@code false} otherwise. */ boolean match(Cookie cookie, CookieOrigin origin); /** * Create {@code "Cookie"} headers for an array of Cookies. * * @param cookies the Cookies format into a Cookie header * @return a Header for the given Cookies. * @throws IllegalArgumentException if an input parameter is illegal */ List
formatCookies(List cookies); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieSpecFactory.java0100644 0000000 0000000 00000003246 00000250600 027103 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Factory for {@link CookieSpec} implementations. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface CookieSpecFactory { /** * Creates an instance of {@link CookieSpec}. * * @return auth scheme. */ CookieSpec create(HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieStore.java0100644 0000000 0000000 00000005036 00000250600 025754 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Date; import java.util.List; /** * This interface represents an abstract store for {@link Cookie} * objects. * * @since 4.0 */ public interface CookieStore { /** * Adds an {@link Cookie}, replacing any existing equivalent cookies. * If the given cookie has already expired it will not be added, but existing * values will still be removed. * * @param cookie the {@link Cookie cookie} to be added */ void addCookie(Cookie cookie); /** * Returns all cookies contained in this store. * * @return all cookies */ List getCookies(); /** * Removes all of {@link Cookie}s in this store that have expired by * the specified {@link Date}. * * @return true if any cookies were purged. * @deprecated Use {@link #clearExpired(Instant)} */ @Deprecated boolean clearExpired(Date date); /** * Removes all of {@link Cookie}s in this store that have expired by * the specified {@link Instant}. * * @return true if any cookies were purged. */ @SuppressWarnings("deprecation") default boolean clearExpired(Instant date) { return clearExpired(date != null ? new Date(date.toEpochMilli()) : null); } /** * Clears all cookies. */ void clear(); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/MalformedCookieException.java0100644 0000000 0000000 00000004512 00000250600 030443 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.http.ProtocolException; /** * Signals that a cookie is in some way invalid or illegal in a given * context * * @since 4.0 */ public class MalformedCookieException extends ProtocolException { private static final long serialVersionUID = -6695462944287282185L; /** * Creates a new MalformedCookieException with a {@code null} detail message. */ public MalformedCookieException() { super(); } /** * Creates a new MalformedCookieException with a specified message string. * * @param message The exception detail message */ public MalformedCookieException(final String message) { super(message); } /** * Creates a new MalformedCookieException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public MalformedCookieException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/SetCookie.java0100644 0000000 0000000 00000007172 00000250600 025416 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Date; import org.apache.hc.client5.http.utils.DateUtils; /** * This interface represents a {@code Set-Cookie} response header sent by the * origin server to the HTTP agent in order to maintain a conversational state. * * @since 4.0 */ public interface SetCookie extends Cookie { void setValue(String value); /** * Sets expiration date. *

Note: the object returned by this method is considered * immutable. Changing it (e.g. using setTime()) could result in undefined * behaviour. Do so at your peril.

* * @param expiryDate the {@link Date} after which this cookie is no longer valid. * * @see Cookie#getExpiryDate * @deprecated Use {{@link #setExpiryDate(Instant)}} */ @Deprecated void setExpiryDate (Date expiryDate); /** * Sets expiration date. *

Note: the object returned by this method is considered * immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at * your peril.

* * @param expiryDate the {@link Instant} after which this cookie is no longer valid. * @see Cookie#getExpiryInstant() * @since 5.2 */ @SuppressWarnings("deprecated") default void setExpiryDate(Instant expiryDate) { setExpiryDate(DateUtils.toDate(expiryDate)); } /** * Sets the domain attribute. * * @param domain The value of the domain attribute * * @see Cookie#getDomain */ void setDomain(String domain); /** * Sets the path attribute. * * @param path The value of the path attribute * * @see Cookie#getPath * */ void setPath(String path); /** * Sets the secure attribute of the cookie. *

* When {@code true} the cookie should only be sent * using a secure protocol (https). This should only be set when * the cookie's originating server used a secure protocol to set the * cookie's value. * * @param secure The value of the secure attribute * * @see #isSecure() */ void setSecure (boolean secure); /** * Marks or unmarks this Cookie as {@code httpOnly}. * * @param httpOnly true if this cookie is to be marked as * {@code httpOnly}, false otherwise * * @since 5.2 */ default void setHttpOnly(final boolean httpOnly) { } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/StandardCookieSpec.java0100644 0000000 0000000 00000003434 00000250600 027233 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Cookie specifications by their names supported by the HttpClient. * * @since 4.3 */ public final class StandardCookieSpec { private StandardCookieSpec() { // no instances } /** * The RFC 6265 compliant policy (interoperability profile). */ public static final String RELAXED = "relaxed"; /** * The RFC 6265 compliant policy (strict profile). * * @since 4.4 */ public static final String STRICT = "strict"; /** * The policy that ignores cookies. */ public static final String IGNORE = "ignore"; } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/package-info.java0100644 0000000 0000000 00000002372 00000250600 026052 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client HTTP state management APIs. */ package org.apache.hc.client5.http.cookie; httpclient5/src/main/java/org/apache/hc/client5/http/entity/0040755 0000000 0000000 00000000000 00000250600 022725 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliDecompressingEntity.java0100644 0000000 0000000 00000004252 00000250600 030743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} responsible for * handling br Content Coded responses. * @deprecated See {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} * * @see GzipDecompressingEntity * @since 5.2 */ @Deprecated public class BrotliDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link DecompressingEntity}. * * @param entity factory to create decompressing stream. */ public BrotliDecompressingEntity(final HttpEntity entity) { super(entity, BrotliInputStreamFactory.getInstance()); } public static boolean isAvailable() { try { Class.forName("org.brotli.dec.BrotliInputStream"); return true; } catch (final ClassNotFoundException | NoClassDefFoundError e) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliInputStreamFactory.java0100644 0000000 0000000 00000004534 00000250600 030552 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import com.aayushatharva.brotli4j.decoder.BrotliInputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link InputStreamFactory} for handling Brotli Content Coded responses. * @deprecated See {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) @Deprecated public class BrotliInputStreamFactory implements InputStreamFactory { /** * Canonical token for the deflate content-coding. * @since 5.6 */ public static final String ENCODING = "br"; /** * Default instance of {@link BrotliInputStreamFactory}. */ private static final BrotliInputStreamFactory INSTANCE = new BrotliInputStreamFactory(); public static BrotliInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new BrotliInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DecompressingEntity.java0100644 0000000 0000000 00000007150 00000250600 027567 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.util.Args; /** * Common base class for decompressing {@link HttpEntity} implementations. * @deprecated See {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} */ @Deprecated public class DecompressingEntity extends HttpEntityWrapper { /** * Default buffer size. */ private static final int BUFFER_SIZE = 1024 * 2; private final InputStreamFactory inputStreamFactory; /** * {@link #getContent()} method must return the same {@link InputStream} * instance when DecompressingEntity is wrapping a streaming entity. */ private InputStream content; /** * Constructs a new {@link DecompressingEntity}. * * @param wrapped the non-null {@link HttpEntity} to be wrapped * @param inputStreamFactory factory to create decompressing stream. */ public DecompressingEntity( final HttpEntity wrapped, final InputStreamFactory inputStreamFactory) { super(wrapped); this.inputStreamFactory = inputStreamFactory; } private InputStream getDecompressingStream() throws IOException { return new LazyDecompressingInputStream(super.getContent(), inputStreamFactory); } @Override public InputStream getContent() throws IOException { if (super.isStreaming()) { if (content == null) { content = getDecompressingStream(); } return content; } return getDecompressingStream(); } @Override public void writeTo(final OutputStream outStream) throws IOException { Args.notNull(outStream, "Output stream"); try (InputStream inStream = getContent()) { final byte[] buffer = new byte[BUFFER_SIZE]; int l; while ((l = inStream.read(buffer)) != -1) { outStream.write(buffer, 0, l); } } } @Override public String getContentEncoding() { /* Content encoding is now 'identity' */ return null; } @Override public long getContentLength() { /* length of decompressed content is not known */ return -1; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateCompressingEntity.java0100644 0000000 0000000 00000005417 00000250600 030547 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.zip.Deflater; import java.util.zip.DeflaterOutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.util.Args; /** * Entity wrapper that compresses the wrapped entity with * Content-Encoding: deflate on write-out. * * @since 5.6 */ public final class DeflateCompressingEntity extends HttpEntityWrapper { private static final String DEFLATE_CODEC = "deflate"; public DeflateCompressingEntity(final HttpEntity entity) { super(entity); } @Override public String getContentEncoding() { return DEFLATE_CODEC; } @Override public long getContentLength() { return -1; // length unknown after compression } @Override public boolean isChunked() { return true; // force chunked transfer-encoding } @Override public InputStream getContent() throws IOException { throw new UnsupportedOperationException("getContent() not supported"); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); // ‘false’ second arg = include zlib wrapper (= RFC 1950 = HTTP “deflate”) try (DeflaterOutputStream deflater = new DeflaterOutputStream(out, new Deflater(Deflater.DEFAULT_COMPRESSION, /*nowrap*/ false))) { super.writeTo(deflater); } } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateDecompressingEntity.java0100644 0000000 0000000 00000005004 00000250600 031050 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} responsible for * handling deflate Content Coded responses. In RFC2616 terms, {@code deflate} * means a {@code zlib} stream as defined in RFC1950. Some server * implementations have misinterpreted RFC2616 to mean that a * {@code deflate} stream as defined in RFC1951 should be used * (or maybe they did that since that's how IE behaves?). It's confusing * that {@code deflate} in HTTP 1.1 means {@code zlib} streams * rather than {@code deflate} streams. We handle both types in here, * since that's what is seen on the internet. Moral - prefer * {@code gzip}! * @deprecated See {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} * * @see GzipDecompressingEntity * * @since 4.1 */ @Deprecated public class DeflateDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link DeflateDecompressingEntity} which will wrap the specified * {@link HttpEntity}. * * @param entity * a non-null {@link HttpEntity} to be wrapped */ public DeflateDecompressingEntity(final HttpEntity entity) { super(entity, DeflateInputStreamFactory.getInstance()); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStream.java0100644 0000000 0000000 00000005707 00000250600 027336 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import java.io.PushbackInputStream; import java.util.zip.Deflater; import java.util.zip.Inflater; import java.util.zip.InflaterInputStream; import java.util.zip.ZipException; /** * Deflates an input stream. This class includes logic needed for various RFCs in order * to reasonably implement the "deflate" compression algorithm. */ public class DeflateInputStream extends FilterInputStream { public DeflateInputStream(final InputStream wrapped) throws IOException { super(null); final PushbackInputStream pushback = new PushbackInputStream(wrapped, 2); final int i1 = pushback.read(); final int i2 = pushback.read(); if (i1 == -1 || i2 == -1) { throw new ZipException("Unexpected end of stream"); } pushback.unread(i2); pushback.unread(i1); boolean nowrap = true; final int b1 = i1 & 0xFF; final int compressionMethod = b1 & 0xF; final int compressionInfo = b1 >> 4 & 0xF; final int b2 = i2 & 0xFF; if (compressionMethod == Deflater.DEFLATED && compressionInfo <= 7 && ((b1 << 8) | b2) % 31 == 0) { nowrap = false; } in = new DeflateStream(pushback, new Inflater(nowrap)); } private static class DeflateStream extends InflaterInputStream { private boolean closed; private DeflateStream(final InputStream in, final Inflater inflater) { super(in, inflater); } @Override public void close() throws IOException { if (closed) { return; } closed = true; inf.end(); super.close(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStreamFactory.java0100644 0000000 0000000 00000004616 00000250600 030664 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link InputStreamFactory} for handling Deflate Content Coded responses. * @deprecated Use {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} * @since 5.0 */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class DeflateInputStreamFactory implements InputStreamFactory { /** * Canonical token for the deflate content-coding. * @since 5.6 */ public static final String ENCODING = "deflate"; /** * Default instance of {@link DeflateInputStreamFactory}. */ private static final DeflateInputStreamFactory INSTANCE = new DeflateInputStreamFactory(); /** * Gets the singleton instance. * * @return the singleton instance. */ public static DeflateInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new DeflateInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/EntityBuilder.java0100644 0000000 0000000 00000034761 00000250600 026363 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.File; import java.io.InputStream; import java.io.Serializable; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.entity.compress.ContentCodecRegistry; import org.apache.hc.client5.http.entity.compress.ContentCoding; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.entity.AbstractHttpEntity; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.FileEntity; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.SerializableEntity; import org.apache.hc.core5.http.io.entity.StringEntity; /** * Builder for {@link HttpEntity} instances. *

* Several setter methods of this builder are mutually exclusive. In case of multiple invocations * of the following methods only the last one will have effect: *

*
    *
  • {@link #setText(String)}
    • *
  • {@link #setBinary(byte[])}
    • *
  • {@link #setStream(java.io.InputStream)}
    • *
  • {@link #setSerializable(java.io.Serializable)}
    • *
  • {@link #setParameters(java.util.List)}
    • *
  • {@link #setParameters(NameValuePair...)}
    • *
  • {@link #setFile(java.io.File)}
    • *
* * @since 4.3 */ public class EntityBuilder { private String text; private byte[] binary; private InputStream stream; private List parameters; private Serializable serializable; private File file; private ContentType contentType; private String contentEncoding; private boolean chunked; /** * @deprecated use {@link #compressWith} instead */ @Deprecated private boolean gzipCompressed; /** * The compression algorithm to apply when {@link #build() building} * the final {@link HttpEntity}. *

* If {@code null} (default) the entity is sent as-is; otherwise the * entity content is wrapped in the corresponding compressing * wrapper (for example {@code GzipCompressingEntity}, * {@code DeflateCompressingEntity}, or a Commons-Compress based * implementation) and the correct {@code Content-Encoding} header is * added. *

* * @since 5.6 */ private ContentCoding compressWith; EntityBuilder() { super(); } public static EntityBuilder create() { return new EntityBuilder(); } private void clearContent() { this.text = null; this.binary = null; this.stream = null; this.parameters = null; this.serializable = null; this.file = null; } /** * Gets the entity content as a string if set using {@link #setText(String)}. * * @return the entity content as a string, may be null. */ public String getText() { return text; } /** * Sets entity content as a string. This method is mutually exclusive with * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)} methods. * * @param text entity content as a string. * @return this instance. */ public EntityBuilder setText(final String text) { clearContent(); this.text = text; return this; } /** * Gets entity content as a byte array if set using * {@link #setBinary(byte[])}. * * @return entity content as a byte array. */ public byte[] getBinary() { return binary; } /** * Sets entity content as a byte array. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param binary The new entity content as a byte array. * @return this instance. */ public EntityBuilder setBinary(final byte[] binary) { clearContent(); this.binary = binary; return this; } /** * Gets entity content as an {@link InputStream} if set using * {@link #setStream(java.io.InputStream)} method. * * @return entity content as an {@link InputStream} */ public InputStream getStream() { return stream; } /** * Sets entity content as an {@link InputStream}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param stream The new entity content as an InputStream. * @return this instance. */ public EntityBuilder setStream(final InputStream stream) { clearContent(); this.stream = stream; return this; } /** * Gets entity content as a parameter list if set using * {@link #setParameters(java.util.List)} or * {@link #setParameters(NameValuePair...)}. * * @return entity content as a parameter list. */ public List getParameters() { return parameters; } /** * Sets entity content as a parameter list. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setFile(java.io.File)}. * * @param parameters entity content as a parameter list. * @return this instance. */ public EntityBuilder setParameters(final List parameters) { clearContent(); this.parameters = parameters; return this; } /** * Sets entity content as a parameter list. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setFile(java.io.File)}. * * @param parameters entity content as a parameter list. * @return this */ public EntityBuilder setParameters(final NameValuePair... parameters) { return setParameters(Arrays.asList(parameters)); } /** * Gets entity content as a {@link Serializable} if set using * {@link #setSerializable(java.io.Serializable)} method. * * @return entity content as a {@link Serializable}. */ public Serializable getSerializable() { return serializable; } /** * Sets entity content as a {@link Serializable}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param serializable entity content as a {@link Serializable}. * @return this instance. */ public EntityBuilder setSerializable(final Serializable serializable) { clearContent(); this.serializable = serializable; return this; } /** * Gets the entity content as a {@link File} if set using * {@link #setFile(java.io.File)}. * * @return Gets the entity content as a {@link File}. */ public File getFile() { return file; } /** * Sets entity content as a {@link File}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setSerializable(java.io.Serializable)}. * * @param file entity content as a {@link File}. * @return this instance. */ public EntityBuilder setFile(final File file) { clearContent(); this.file = file; return this; } /** * Gets the {@link ContentType} of the entity, may be null. * * @return the {@link ContentType} of the entity, may be null. */ public ContentType getContentType() { return contentType; } /** * Sets the {@link ContentType} of the entity. * * @param contentType the {@link ContentType} of the entity, may be null. * @return this instance. */ public EntityBuilder setContentType(final ContentType contentType) { this.contentType = contentType; return this; } /** * Gets the content encoding of the entity, may be null. * * @return the content encoding of the entity, may be null. */ public String getContentEncoding() { return contentEncoding; } /** * Sets the content encoding of the entity. * * @param contentEncoding the content encoding of the entity, may be null. * @return this instance. */ public EntityBuilder setContentEncoding(final String contentEncoding) { this.contentEncoding = contentEncoding; return this; } /** * Tests if the entity is to be chunk coded ({@code true}), or not ({@code false}). * * @return {@code true} if entity is to be chunk coded, {@code false} otherwise. */ public boolean isChunked() { return chunked; } /** * Sets entities to be chunked. * @return this instance. */ public EntityBuilder chunked() { this.chunked = true; return this; } /** * Tests if entities are to be GZIP compressed ({@code true}), or not ({@code false}). * * @return {@code true} if entity is to be GZIP compressed, {@code false} otherwise. * @deprecated since 5.6 – use {@link #getCompressWith()} and * check for {@code ContentCoding.GZIP} instead. */ @Deprecated public boolean isGzipCompressed() { return compressWith == ContentCoding.GZIP; } /** * Sets entities to be GZIP compressed. * * @return this instance. * @deprecated since 5.6 – replace with * {@code compressed(ContentCoding.GZIP)}. */ @Deprecated public EntityBuilder gzipCompressed() { this.compressWith = ContentCoding.GZIP; return this; } /** * Requests that the entity produced by this builder be compressed * with the supplied content-coding. * * @param coding the content-coding to use (never {@code null}) * @return this builder for method chaining * @since 5.6 */ public EntityBuilder compressed(final ContentCoding coding) { this.compressWith = coding; return this; } /** * Returns the content-coding that {@link #build()} will apply to the * outgoing {@link org.apache.hc.core5.http.HttpEntity}, or {@code null} * when no compression has been requested. * * @return the chosen {@link ContentCoding} — typically * {@link ContentCoding#GZIP}, {@link ContentCoding#DEFLATE}, etc. — * or {@code null} if the request body will be sent uncompressed. * @since 5.6 */ public ContentCoding getCompressWith() { return compressWith; } private ContentType getContentOrDefault(final ContentType def) { return this.contentType != null ? this.contentType : def; } /** * Builds a new instance of {@link HttpEntity} based on the current state. * * @return a new instance. */ public HttpEntity build() { final AbstractHttpEntity e; if (this.text != null) { e = new StringEntity(this.text, getContentOrDefault(ContentType.DEFAULT_TEXT), this.contentEncoding, this.chunked); } else if (this.binary != null) { e = new ByteArrayEntity(this.binary, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding, this.chunked); } else if (this.stream != null) { e = new InputStreamEntity(this.stream, -1, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding); } else if (this.parameters != null) { e = new UrlEncodedFormEntity(this.parameters, this.contentType != null ? this.contentType.getCharset() : null); } else if (this.serializable != null) { e = new SerializableEntity(this.serializable, ContentType.DEFAULT_BINARY, this.contentEncoding); } else if (this.file != null) { e = new FileEntity(this.file, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding); } else { throw new IllegalStateException("No entity set"); } if (compressWith != null) { final HttpEntity compressed = ContentCodecRegistry.wrap(compressWith, e); if (compressed == null) { throw new UnsupportedOperationException( "No encoder available for content-coding '" + compressWith.token() + '\''); } return compressed; } return e; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GZIPInputStreamFactory.java0100644 0000000 0000000 00000005077 00000250600 030073 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.util.zip.GZIPInputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link InputStreamFactory} for handling GZIPContent Coded responses. * @deprecated – the public extension point has moved to * {@link org.apache.hc.client5.http.entity.compress.DecompressingEntity}. * For built-in gzip support use * {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry} or * wrap a stream directly with * @since 5.0 */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class GZIPInputStreamFactory implements InputStreamFactory { /** * Canonical token for the gzip content-coding. * @since 5.6 */ public static final String ENCODING = "gzip"; /** * Default instance of {@link GZIPInputStreamFactory}. */ private static final GZIPInputStreamFactory INSTANCE = new GZIPInputStreamFactory(); /** * Gets the singleton instance. * * @return the singleton instance. */ public static GZIPInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new GZIPInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipCompressingEntity.java0100644 0000000 0000000 00000005030 00000250600 030103 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.zip.GZIPOutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.util.Args; /** * Wrapping entity that compresses content when {@link #writeTo writing}. * * * @since 4.0 */ public class GzipCompressingEntity extends HttpEntityWrapper { private static final String GZIP_CODEC = "gzip"; public GzipCompressingEntity(final HttpEntity entity) { super(entity); } @Override public String getContentEncoding() { return GZIP_CODEC; } @Override public long getContentLength() { return -1; } @Override public boolean isChunked() { // force content chunking return true; } @Override public InputStream getContent() throws IOException { throw new UnsupportedOperationException(); } @Override public void writeTo(final OutputStream outStream) throws IOException { Args.notNull(outStream, "Output stream"); final GZIPOutputStream gzip = new GZIPOutputStream(outStream); super.writeTo(gzip); // Only close output stream if the wrapped entity has been // successfully written out gzip.close(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipDecompressingEntity.java0100644 0000000 0000000 00000003716 00000250600 030425 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} for handling * gzip Content Coded responses. * * @deprecated See {@link org.apache.hc.client5.http.entity.compress.ContentCodecRegistry#decoder(org.apache.hc.client5.http.entity.compress.ContentCoding)} * * @since 4.1 */ @Deprecated public class GzipDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link GzipDecompressingEntity} which will wrap the * specified {@link HttpEntity}. * * @param entity * the non-null {@link HttpEntity} to be wrapped */ public GzipDecompressingEntity(final HttpEntity entity) { super(entity, GZIPInputStreamFactory.getInstance()); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/InputStreamFactory.java0100644 0000000 0000000 00000002715 00000250600 027375 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; /** * Factory for decorated {@link InputStream}s. * @since 4.4 */ @FunctionalInterface public interface InputStreamFactory { InputStream create(InputStream inputStream) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/LazyDecompressingInputStream.java0100644 0000000 0000000 00000006423 00000250600 031430 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import java.io.UncheckedIOException; import org.apache.hc.core5.io.Closer; /** * Lazy initializes from an {@link InputStream} wrapper. * @deprecated Superseded by {@link org.apache.hc.client5.http.entity.compress.DecompressingEntity}. */ @Deprecated class LazyDecompressingInputStream extends FilterInputStream { private final InputStreamFactory inputStreamFactory; private InputStream wrapperStream; public LazyDecompressingInputStream( final InputStream wrappedStream, final InputStreamFactory inputStreamFactory) { super(wrappedStream); this.inputStreamFactory = inputStreamFactory; } private InputStream initWrapper() throws IOException { if (wrapperStream == null) { wrapperStream = inputStreamFactory.create(in); } return wrapperStream; } @Override public int read() throws IOException { return initWrapper().read(); } @Override public int read(final byte[] b) throws IOException { return initWrapper().read(b); } @Override public int read(final byte[] b, final int off, final int len) throws IOException { return initWrapper().read(b, off, len); } @Override public long skip(final long n) throws IOException { return initWrapper().skip(n); } @Override public boolean markSupported() { return false; } @Override public int available() throws IOException { return initWrapper().available(); } @Override public void close() throws IOException { try { Closer.close(wrapperStream); } finally { super.close(); } } @Override public void mark(final int readlimit) { try { initWrapper().mark(readlimit); } catch (final IOException e) { throw new UncheckedIOException(e); } } @Override public void reset() throws IOException { initWrapper().reset(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/UrlEncodedFormEntity.java0100644 0000000 0000000 00000006173 00000250600 027641 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.nio.charset.Charset; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.net.WWWFormCodec; /** * An entity composed of a list of url-encoded pairs. * This is typically useful while sending an HTTP POST request. * * @since 4.0 */ public class UrlEncodedFormEntity extends StringEntity { /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters in the specified encoding. * * @param parameters iterable collection of name/value pairs * @param charset encoding the name/value pairs be encoded with * * @since 4.2 */ public UrlEncodedFormEntity( final Iterable parameters, final Charset charset) { super(WWWFormCodec.format( parameters, charset != null ? charset : ContentType.APPLICATION_FORM_URLENCODED.getCharset()), charset != null ? ContentType.APPLICATION_FORM_URLENCODED.withCharset(charset) : ContentType.APPLICATION_FORM_URLENCODED); } /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} * * @param parameters list of name/value pairs */ public UrlEncodedFormEntity(final List parameters) { this(parameters, null); } /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} * * @param parameters iterable collection of name/value pairs * * @since 4.2 */ public UrlEncodedFormEntity( final Iterable parameters) { this(parameters, null); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/package-info.java0100644 0000000 0000000 00000002404 00000250600 026111 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client specific HTTP entity implementations. */ package org.apache.hc.client5.http.entity; httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/0040755 0000000 0000000 00000000000 00000250600 024560 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/BrotliCodecFactory.java0100644 0000000 0000000 00000004136 00000250600 031145 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.io.BufferedOutputStream; import java.io.InputStream; import java.io.OutputStream; import com.aayushatharva.brotli4j.decoder.BrotliInputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.io.IOFunction; /** * Brotli Codecs factory. * * @since 5.6 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) final class BrotliCodecFactory { /** * Creates a lazy decoder that instantiates the Commons Compress stream. */ static IOFunction decoder() { return BrotliInputStream::new; } /** * Creates a lazy encoder that instantiates the Commons Compress stream. */ static IOFunction encoder() { return BufferedOutputStream::new; } } ././@LongLink0100644 0000000 0000000 00000000146 00000250600 011612 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/CommonsCompressCodecFactory.javahttpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/CommonsCompressCodecFactory.jav0100644 0000000 0000000 00000014663 00000250600 032706 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.Locale; import org.apache.commons.compress.compressors.CompressorException; import org.apache.commons.compress.compressors.CompressorStreamFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.io.IOFunction; /** * Codecs factory for Apache Commons Compress. *

* Use {@link #runtimeAvailable(ContentCoding)} to probe whether a given coding * can be provided by the current classpath configuration. Callers can then * register codecs conditionally without hard dependencies. *

* * @since 5.6 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) final class CommonsCompressCodecFactory { private static final String FACTORY_CLASS = "org.apache.commons.compress.compressors.CompressorStreamFactory"; // CC stream classes private static final String CC_BROTLI = "org.apache.commons.compress.compressors.brotli.BrotliCompressorInputStream"; private static final String CC_ZSTD = "org.apache.commons.compress.compressors.zstandard.ZstdCompressorInputStream"; private static final String CC_XZ = "org.apache.commons.compress.compressors.xz.XZCompressorInputStream"; private static final String CC_LZMA = "org.apache.commons.compress.compressors.lzma.LZMACompressorInputStream"; private static final String CC_LZ4_F = "org.apache.commons.compress.compressors.lz4.FramedLZ4CompressorInputStream"; private static final String CC_LZ4_B = "org.apache.commons.compress.compressors.lz4.BlockLZ4CompressorInputStream"; private static final String CC_BZIP2 = "org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream"; private static final String CC_PACK200 = "org.apache.commons.compress.compressors.pack200.Pack200CompressorInputStream"; private static final String CC_DEFLATE64 = "org.apache.commons.compress.compressors.deflate64.Deflate64CompressorInputStream"; // Helper libs private static final String H_BROTLI = "org.brotli.dec.BrotliInputStream"; private static final String H_ZSTD = "com.github.luben.zstd.ZstdInputStream"; private static final String H_XZ = "org.tukaani.xz.XZInputStream"; private CommonsCompressCodecFactory() { } private static boolean isPresent(final String className) { try { Class.forName(className, false, CommonsCompressCodecFactory.class.getClassLoader()); return true; } catch (final ClassNotFoundException | LinkageError ex) { return false; } } /** * Creates a lazy decoder that instantiates the Commons Compress stream. */ static IOFunction decoder(final String token) { final String enc = token.toLowerCase(Locale.ROOT); final CompressorStreamFactory factory = new CompressorStreamFactory(); return in -> { try { return factory.createCompressorInputStream(enc, in); } catch (final CompressorException | LinkageError ex) { throw new IOException("Unable to decode Content-Encoding '" + enc + '\'', ex); } }; } /** * Creates a lazy encoder that instantiates the Commons Compress stream. */ static IOFunction encoder(final String token) { final String enc = token.toLowerCase(Locale.ROOT); final CompressorStreamFactory factory = new CompressorStreamFactory(); return in -> { try { return factory.createCompressorOutputStream(enc, in); } catch (final CompressorException | LinkageError ex) { throw new IOException("Unable to decode Content-Encoding '" + enc + '\'', ex); } }; } /** * Best-effort availability probe for optional Commons-Compress codecs. *

* Returns {@code true} only if the CC factory and the codec-specific * implementation (and helper classes if required) are present on the * classpath. Built-in gzip/deflate are handled elsewhere and are not * probed here. *

*/ static boolean runtimeAvailable(final ContentCoding coding) { if (coding == null) { return false; } if (!isPresent(FACTORY_CLASS)) { return false; } switch (coding) { case BROTLI: return isPresent(CC_BROTLI) && isPresent(H_BROTLI); case ZSTD: return isPresent(CC_ZSTD) && isPresent(H_ZSTD); case XZ: return isPresent(CC_XZ) && isPresent(H_XZ); case LZMA: return isPresent(CC_LZMA) && isPresent(H_XZ); case LZ4_FRAMED: return isPresent(CC_LZ4_F); case LZ4_BLOCK: return isPresent(CC_LZ4_B); case BZIP2: return isPresent(CC_BZIP2); case PACK200: return isPresent(CC_PACK200) || isPresent("java.util.jar.Pack200"); case DEFLATE64: return isPresent(CC_DEFLATE64); default: return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/CommonsCompressRuntime.java0100644 0000000 0000000 00000004552 00000250600 032121 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Lightweight guard that checks whether the Commons Compress factory * class is loadable with the current class loader. *

* Used by the codec registry to decide if reflective wiring of optional * codecs should even be attempted. *

* * @since 5.6 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) final class CommonsCompressRuntime { private static final String CCSF = "org.apache.commons.compress.compressors.CompressorStreamFactory"; /** * Non-instantiable. */ private CommonsCompressRuntime() { } /** * Returns {@code true} if the core Commons Compress class can be loaded * with the current class-loader, {@code false} otherwise. */ static boolean available() { try { Class.forName(CCSF, false, CommonsCompressRuntime.class.getClassLoader()); return true; } catch (ClassNotFoundException | LinkageError ex) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/CompressingEntity.java0100644 0000000 0000000 00000006656 00000250600 031123 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.io.IOFunction; import org.apache.hc.core5.util.Args; /** * Streaming wrapper that compresses the enclosed {@link HttpEntity} on write. *

* The actual compressor is supplied as an {@link IOFunction}<OutputStream,OutputStream> * and is resolved by the caller (for example via reflective factories). This keeps * compression back-ends fully optional and avoids hard classpath dependencies. *

*

* The entity reports the configured {@code Content-Encoding} token and streams * the content; length is unknown ({@code -1}), and the entity is chunked. *

* * @since 5.6 */ public final class CompressingEntity extends HttpEntityWrapper { private final IOFunction encoder; private final String coding; // lower-case token for header reporting public CompressingEntity( final HttpEntity src, final String coding, final IOFunction encoder) { super(src); this.encoder = Args.notNull(encoder, "Stream encoder"); this.coding = Args.notNull(coding, "Content coding").toLowerCase(java.util.Locale.ROOT); } @Override public String getContentEncoding() { return coding; } @Override public long getContentLength() { return -1; // streaming } @Override public boolean isChunked() { return true; } @Override public InputStream getContent() { throw new UnsupportedOperationException("Compressed entity is write-only"); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); final OutputStream wrapped = encoder.apply(out); try { super.writeTo(wrapped); } finally { // Close the wrapped stream to flush trailers/footers if any. try { wrapped.close(); } catch (final IOException ignore) { // best effort } } } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/ContentCodecRegistry.java0100644 0000000 0000000 00000013101 00000250600 031515 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.util.Arrays; import java.util.Collections; import java.util.EnumMap; import java.util.Map; import java.util.function.UnaryOperator; import java.util.zip.GZIPInputStream; import org.apache.hc.client5.http.entity.DeflateCompressingEntity; import org.apache.hc.client5.http.entity.DeflateInputStream; import org.apache.hc.client5.http.entity.GzipCompressingEntity; import org.apache.hc.client5.http.impl.Brotli4jRuntime; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpEntity; /** * Registry of encode/decode transformations for HTTP content codings. *

* Entries are wired once at class-load time and exposed via an unmodifiable map. * Built-in gzip/deflate are always available. Additional codecs are discovered * reflectively: *

*
    *
  • Commons Compress codecs, when the library and (if required) its helper JARs * are present.
    • *
  • Decode-only Brotli via brotli4j, when present on the classpath. This does * not affect the advertised {@code Accept-Encoding} unless an encoder is also * registered.
    • *
* * @since 5.6 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public final class ContentCodecRegistry { private static final Map REGISTRY = build(); private static Map build() { final Map m = new EnumMap<>(ContentCoding.class); m.put(ContentCoding.GZIP, new Codec(GzipCompressingEntity::new, ent -> new DecompressingEntity(ent, GZIPInputStream::new))); m.put(ContentCoding.DEFLATE, new Codec(DeflateCompressingEntity::new, ent -> new DecompressingEntity(ent, DeflateInputStream::new))); // 2) Commons-Compress (optional) — reflectively wired if (CommonsCompressRuntime.available()) { for (final ContentCoding c : Arrays.asList( ContentCoding.BROTLI, ContentCoding.ZSTD, ContentCoding.XZ, ContentCoding.LZMA, ContentCoding.LZ4_FRAMED, ContentCoding.LZ4_BLOCK, ContentCoding.BZIP2, ContentCoding.PACK200, ContentCoding.DEFLATE64)) { if (CommonsCompressCodecFactory.runtimeAvailable(c)) { m.put(c, new Codec( e -> new CompressingEntity(e, c.token(), CommonsCompressCodecFactory.encoder(c.token())), ent -> new DecompressingEntity(ent, CommonsCompressCodecFactory.decoder(c.token())))); } } } // 3) Native Brotli fallback (decode-only), no compile-time dep if (Brotli4jRuntime.available()) { m.put(ContentCoding.BROTLI, Codec.decodeOnly(ent -> new DecompressingEntity(ent, BrotliCodecFactory.decoder()))); } return Collections.unmodifiableMap(m); } public static HttpEntity wrap(final ContentCoding c, final HttpEntity src) { final Codec k = REGISTRY.get(c); return k != null && k.encoder != null ? k.encoder.apply(src) : null; } public static HttpEntity unwrap(final ContentCoding c, final HttpEntity src) { final Codec k = REGISTRY.get(c); return k != null && k.decoder != null ? k.decoder.apply(src) : null; } public static UnaryOperator decoder(final ContentCoding coding) { final Codec c = REGISTRY.get(coding); return c != null ? c.decoder : null; } public static UnaryOperator encoder(final ContentCoding coding) { final Codec c = REGISTRY.get(coding); return c != null ? c.encoder : null; } static final class Codec { final UnaryOperator encoder; final UnaryOperator decoder; Codec(final UnaryOperator enc, final UnaryOperator dec) { this.encoder = enc; this.decoder = dec; } static Codec encodeOnly(final UnaryOperator e) { return new Codec(e, null); } static Codec decodeOnly(final UnaryOperator d) { return new Codec(null, d); } } private ContentCodecRegistry() { } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/ContentCoding.java0100644 0000000 0000000 00000007472 00000250600 030170 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.util.Collections; import java.util.HashMap; import java.util.Locale; import java.util.Map; /** * Enumeration of the canonical IANA content-coding tokens supported by HttpClient for * HTTP request and response bodies. *

* Each constant corresponds to the standard token used in the {@code Content-Encoding} * and {@code Accept-Encoding} headers. Some codings (e.g. Brotli, Zstandard, XZ/LZMA) * may require additional helper libraries at runtime. * * @since 5.6 */ public enum ContentCoding { /** * GZIP compression format. */ GZIP("gzip"), /** * "deflate" compression format (zlib or raw). */ DEFLATE("deflate"), /** * Legacy alias for GZIP. */ X_GZIP("x-gzip"), // Optional codecs requiring Commons-Compress or native helpers /** * Brotli compression format. */ BROTLI("br"), /** * Zstandard compression format. */ ZSTD("zstd"), /** * XZ compression format. */ XZ("xz"), /** * LZMA compression format. */ LZMA("lzma"), /** * Framed LZ4 compression format. */ LZ4_FRAMED("lz4-framed"), /** * Block LZ4 compression format. */ LZ4_BLOCK("lz4-block"), /** * BZIP2 compression format. */ BZIP2("bzip2"), /** * Pack200 compression format. */ PACK200("pack200"), /** * Deflate64 compression format. */ DEFLATE64("deflate64"); private static final Map TOKEN_LOOKUP; static { final Map map = new HashMap<>(values().length, 1f); for (final ContentCoding contentCoding : values()) { map.put(contentCoding.token, contentCoding); } TOKEN_LOOKUP = Collections.unmodifiableMap(map); } private final String token; ContentCoding(final String token) { this.token = token; } /** * Returns the standard IANA token string for this content-coding. * * @return the lowercase token used in HTTP headers */ public String token() { return token; } /** * Lookup an enum by its token (case‐insensitive), or {@code null} if none matches. *

* This method is backed by a static, pre‐populated map so the lookup is O(1) * instead of O(n).

* * @param token the content‐coding token to look up * @return the matching enum constant, or {@code null} if none */ public static ContentCoding fromToken(final String token) { return token != null ? TOKEN_LOOKUP.get(token.toLowerCase(Locale.ROOT)) : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/compress/DecompressingEntity.java0100644 0000000 0000000 00000011667 00000250600 031432 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.compress; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.io.IOFunction; import org.apache.hc.core5.util.Args; public class DecompressingEntity extends HttpEntityWrapper { private static final int BUF_SIZE = 8 * 1024; // 8 KiB buffer private final IOFunction decoder; private volatile InputStream cached; public DecompressingEntity( final HttpEntity src, final IOFunction decoder) { super(src); this.decoder = Args.notNull(decoder, "Stream decoder"); } private InputStream getDecompressingStream() throws IOException { return new LazyDecompressingInputStream(super.getContent(), decoder); } /** * Returns the cached decoded stream, creating it once if necessary. */ @Override public InputStream getContent() throws IOException { if (!isStreaming()) { return getDecompressingStream(); } InputStream local = cached; if (local == null) { if (cached == null) { cached = getDecompressingStream(); } local = cached; } return local; } /** * Length is unknown after decompression. */ @Override public long getContentLength() { return -1; } /** * Content is no longer encoded */ @Override public String getContentEncoding() { return null; } /** * Streams the decoded bytes directly to {@code out}. */ @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); try (InputStream in = getContent()) { final byte[] buf = new byte[BUF_SIZE]; int len; while ((len = in.read(buf)) != -1) { out.write(buf, 0, len); } } } private static final class LazyDecompressingInputStream extends FilterInputStream { private final IOFunction decoder; private InputStream decompressedStream; private LazyDecompressingInputStream( final InputStream inputStream, final IOFunction decoder) { super(inputStream); this.decoder = decoder; } private InputStream getDecompressedStream() throws IOException { if (decompressedStream == null) { decompressedStream = decoder.apply(in); } return decompressedStream; } @Override public int read() throws IOException { return getDecompressedStream().read(); } @Override public int read(final byte[] b) throws IOException { return getDecompressedStream().read(b); } @Override public int read(final byte[] b, final int off, final int len) throws IOException { return getDecompressedStream().read(b, off, len); } @Override public long skip(final long n) throws IOException { return getDecompressedStream().skip(n); } @Override public int available() throws IOException { return getDecompressedStream().available(); } @Override public void close() throws IOException { final InputStream local = decompressedStream; if (local != null) { local.close(); } else { super.close(); } } } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/0040755 0000000 0000000 00000000000 00000250600 023654 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/AbstractContentBody.java0100644 0000000 0000000 00000005102 00000250600 030426 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.nio.charset.Charset; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * * @since 4.0 */ public abstract class AbstractContentBody implements ContentBody { private final ContentType contentType; /** * @since 4.3 */ public AbstractContentBody(final ContentType contentType) { super(); Args.notNull(contentType, "Content type"); this.contentType = contentType; } /** * @since 4.3 */ public ContentType getContentType() { return this.contentType; } @Override public String getMimeType() { return this.contentType.getMimeType(); } @Override public String getMediaType() { final String mimeType = this.contentType.getMimeType(); final int i = mimeType.indexOf('/'); if (i != -1) { return mimeType.substring(0, i); } return mimeType; } @Override public String getSubType() { final String mimeType = this.contentType.getMimeType(); final int i = mimeType.indexOf('/'); if (i != -1) { return mimeType.substring(i + 1); } return null; } @Override public String getCharset() { final Charset charset = this.contentType.getCharset(); return charset != null ? charset.name() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/AbstractMultipartFormat.java0100644 0000000 0000000 00000023242 00000250600 031335 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; /** * HttpMultipart represents a collection of MIME multipart encoded content bodies. * * @since 4.3 */ abstract class AbstractMultipartFormat { /** * The preamble to be included before the multipart content. */ private String preamble; /** * The epilogue to be included after the multipart content. */ private String epilogue; static ByteArrayBuffer encode( final Charset charset, final CharSequence string) { final ByteBuffer encoded = charset.encode(CharBuffer.wrap(string)); final ByteArrayBuffer bab = new ByteArrayBuffer(encoded.remaining()); bab.append(encoded.array(), encoded.arrayOffset() + encoded.position(), encoded.remaining()); return bab; } static void writeBytes( final ByteArrayBuffer b, final OutputStream out) throws IOException { out.write(b.array(), 0, b.length()); } static void writeBytes( final CharSequence s, final Charset charset, final OutputStream out) throws IOException { final ByteArrayBuffer b = encode(charset, s); writeBytes(b, out); } static void writeBytes( final CharSequence s, final OutputStream out) throws IOException { final ByteArrayBuffer b = encode(StandardCharsets.ISO_8859_1, s); writeBytes(b, out); } static boolean isLineBreak(final char ch) { return ch == '\r' || ch == '\n' || ch == '\f' || ch == 11; } static CharSequence stripLineBreaks(final CharSequence s) { if (s == null) { return null; } boolean requiresRewrite = false; int n = 0; for (; n < s.length(); n++) { final char ch = s.charAt(n); if (isLineBreak(ch)) { requiresRewrite = true; break; } } if (!requiresRewrite) { return s; } final StringBuilder buf = new StringBuilder(); buf.append(s, 0, n); for (; n < s.length(); n++) { final char ch = s.charAt(n); if (isLineBreak(ch)) { buf.append(' '); } else { buf.append(ch); } } return buf.toString(); } static void writeField( final MimeField field, final OutputStream out) throws IOException { writeBytes(stripLineBreaks(field.getName()), out); writeBytes(FIELD_SEP, out); writeBytes(stripLineBreaks(field.getBody()), out); writeBytes(CR_LF, out); } static void writeField( final MimeField field, final Charset charset, final OutputStream out) throws IOException { writeBytes(stripLineBreaks(field.getName()), charset, out); writeBytes(FIELD_SEP, out); writeBytes(stripLineBreaks(field.getBody()), charset, out); writeBytes(CR_LF, out); } static final ByteArrayBuffer FIELD_SEP = encode(StandardCharsets.ISO_8859_1, ": "); static final ByteArrayBuffer CR_LF = encode(StandardCharsets.ISO_8859_1, "\r\n"); static final ByteArrayBuffer TWO_HYPHENS = encode(StandardCharsets.ISO_8859_1, "--"); final Charset charset; final String boundary; /** * Creates an instance with the specified settings. * * @param charset the character set to use. May be {@code null}, in which case {@link StandardCharsets#ISO_8859_1} is used. * @param boundary to use - must not be {@code null} * @throws IllegalArgumentException if charset is null or boundary is null */ public AbstractMultipartFormat(final Charset charset, final String boundary) { super(); Args.notNull(boundary, "Multipart boundary"); this.charset = charset != null ? charset : StandardCharsets.ISO_8859_1; this.boundary = boundary; } /* */ /** * Constructs a new instance of {@code AbstractMultipartFormat} with the given charset, boundary, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param preamble the preamble string to use. Can be {@code null}. * @param epilogue the epilogue string to use. Can be {@code null}. * @throws IllegalArgumentException if the boundary string is {@code null}. */ public AbstractMultipartFormat(final Charset charset, final String boundary, final String preamble, final String epilogue) { super(); Args.notNull(boundary, "Multipart boundary"); this.charset = charset != null ? charset : StandardCharsets.ISO_8859_1; this.boundary = boundary; this.preamble = preamble; this.epilogue = epilogue; } public AbstractMultipartFormat(final String boundary) { this(null, boundary); } public abstract List getParts(); /** * Writes the multipart message to the specified output stream. *

* If {@code writeContent} is {@code true}, the content of each part will also be written. * *

If {@code preamble} is not {@code null}, it will be written before the first boundary. * If {@code epilogue} is not {@code null}, it will be written after the last boundary. * * @param out the output stream to write the message to. * @param writeContent whether to write the content of each part. * @throws IOException if an I/O error occurs. */ void doWriteTo( final OutputStream out, final boolean writeContent) throws IOException { final ByteArrayBuffer boundaryEncoded = encode(this.charset, this.boundary); if (this.preamble != null) { writeBytes(this.preamble, out); writeBytes(CR_LF, out); } for (final MultipartPart part : getParts()) { writeBytes(TWO_HYPHENS, out); writeBytes(boundaryEncoded, out); writeBytes(CR_LF, out); formatMultipartHeader(part, out); writeBytes(CR_LF, out); if (writeContent) { part.getBody().writeTo(out); } writeBytes(CR_LF, out); } writeBytes(TWO_HYPHENS, out); writeBytes(boundaryEncoded, out); writeBytes(TWO_HYPHENS, out); writeBytes(CR_LF, out); if (this.epilogue != null) { writeBytes(this.epilogue, out); writeBytes(CR_LF, out); } } /** * Write the multipart header fields; depends on the style. */ protected abstract void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException; /** * Writes out the content in the multipart/form encoding. This method * produces slightly different formatting depending on its compatibility * mode. */ public void writeTo(final OutputStream out) throws IOException { doWriteTo(out, true); } /** * Determines the total length of the multipart content (content length of * individual parts plus that of extra elements required to delimit the parts * from one another). If any of the @{link BodyPart}s contained in this object * is of a streaming entity of unknown length the total length is also unknown. *

* This method buffers only a small amount of data in order to determine the * total length of the entire entity. The content of individual parts is not * buffered. *

* * @return total length of the multipart entity if known, {@code -1} * otherwise. */ public long getTotalLength() { long contentLen = 0; for (final MultipartPart part : getParts()) { final ContentBody body = part.getBody(); final long len = body.getContentLength(); if (len >= 0) { contentLen += len; } else { return -1; } } final ByteArrayOutputStream out = new ByteArrayOutputStream(); try { doWriteTo(out, false); final byte[] extra = out.toByteArray(); return contentLen + extra.length; } catch (final IOException ex) { // Should never happen return -1; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ByteArrayBody.java0100644 0000000 0000000 00000005752 00000250600 027245 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by a byte array. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.1 */ public class ByteArrayBody extends AbstractContentBody { /** * The contents of the file contained in this part. */ private final byte[] data; /** * The name of the file contained in this part. */ private final String filename; /** * @since 4.3 */ public ByteArrayBody(final byte[] data, final ContentType contentType, final String filename) { super(contentType); this.data = Args.notNull(data, "data"); this.filename = filename; } /** * Public constructor that creates a new ByteArrayBody. * * @param contentType the {@link ContentType} * @param data the array of byte. * * @since 5.2 */ public ByteArrayBody(final byte[] data, final ContentType contentType) { this(data, contentType, null); } /** * Creates a new ByteArrayBody. * * @param data The contents of the file contained in this part. * @param filename The name of the file contained in this part. */ public ByteArrayBody(final byte[] data, final String filename) { this(data, ContentType.APPLICATION_OCTET_STREAM, filename); } @Override public String getFilename() { return filename; } @Override public void writeTo(final OutputStream out) throws IOException { out.write(data); } @Override public String getCharset() { return null; } @Override public long getContentLength() { return data.length; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ContentBody.java0100644 0000000 0000000 00000002664 00000250600 026754 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; /** * * @since 4.0 */ public interface ContentBody extends ContentDescriptor { String getFilename(); void writeTo(OutputStream out) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ContentDescriptor.java0100644 0000000 0000000 00000005645 00000250600 030177 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * Represents common content properties. */ public interface ContentDescriptor { /** * Returns the body descriptors MIME type. * @see #getMediaType() * @see #getSubType() * @return The MIME type, which has been parsed from the * content-type definition. Must not be null, but * "text/plain", if no content-type was specified. */ String getMimeType(); /** * Gets the defaulted MIME media type for this content. * For example {@code TEXT}, {@code IMAGE}, {@code MULTIPART} * @see #getMimeType() * @return the MIME media type when content-type specified, * otherwise the correct default ({@code TEXT}) */ String getMediaType(); /** * Gets the defaulted MIME sub type for this content. * @see #getMimeType() * @return the MIME media type when content-type is specified, * otherwise the correct default ({@code PLAIN}) */ String getSubType(); /** *

The body descriptors character set, defaulted appropriately for the MIME type.

*

* For {@code TEXT} types, this will be defaulted to {@code us-ascii}. * For other types, when the charset parameter is missing this property will be null. *

* @return Character set, which has been parsed from the * content-type definition. Not null for {@code TEXT} types, when unset will * be set to default {@code us-ascii}. For other types, when unset, * null will be returned. */ String getCharset(); /** * Returns the body descriptors content-length. * @return Content length, if known, or -1, to indicate the absence of a * content-length header. */ long getContentLength(); } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FileBody.java0100644 0000000 0000000 00000005774 00000250600 026226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by a file. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class FileBody extends AbstractContentBody { private final File file; private final String filename; public FileBody(final File file) { this(file, ContentType.DEFAULT_BINARY, file != null ? file.getName() : null); } /** * @since 4.3 */ public FileBody(final File file, final ContentType contentType, final String filename) { super(contentType); Args.notNull(file, "File"); this.file = file; this.filename = filename == null ? file.getName() : filename; } /** * @since 4.3 */ public FileBody(final File file, final ContentType contentType) { this(file, contentType, file != null ? file.getName() : null); } public InputStream getInputStream() throws IOException { return new FileInputStream(this.file); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); try (InputStream in = new FileInputStream(this.file)) { final byte[] tmp = new byte[4096]; int l; while ((l = in.read(tmp)) != -1) { out.write(tmp, 0, l); } out.flush(); } } @Override public long getContentLength() { return this.file.length(); } @Override public String getFilename() { return filename; } public File getFile() { return this.file; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FormBodyPart.java0100644 0000000 0000000 00000004017 00000250600 027066 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import org.apache.hc.core5.util.Args; /** * FormBodyPart class represents a content body that can be used as a part of multipart encoded * entities. This class automatically populates the header with standard fields based on * the content description of the enclosed body. * * @since 4.0 */ public class FormBodyPart extends MultipartPart { private final String name; FormBodyPart(final String name, final ContentBody body, final Header header) { super(body, header); Args.notNull(name, "Name"); Args.notNull(body, "Body"); this.name = name; } public String getName() { return this.name; } @Override public void addField(final String name, final String value) { Args.notNull(name, "Field name"); super.addField(name, value); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FormBodyPartBuilder.java0100644 0000000 0000000 00000020145 00000250600 030375 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.nio.charset.CharsetEncoder; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; /** * Builder for individual {@link org.apache.hc.client5.http.entity.mime.FormBodyPart}s. * * @since 4.4 */ public class FormBodyPartBuilder { private String name; private ContentBody body; private final Header header; /** * The multipart mode determining how filenames are encoded in the {@code Content-Disposition} * header, defaults to {@link HttpMultipartMode#STRICT}. * * @since 5.5 */ private HttpMultipartMode mode; /** * Encoder used to check if strings can be encoded in ISO-8859-1, supporting filename * compatibility determinations in multipart form data. */ private CharsetEncoder iso8859_1Encoder; /** * Creates a new builder instance with the specified name, content body, and multipart mode. * * @param name the name of the form field * @param body the content body of the part * @param mode the {@link HttpMultipartMode} to use, determining filename encoding behavior; * * @return a new {@code FormBodyPartBuilder} instance * @since 5.5 */ public static FormBodyPartBuilder create(final String name, final ContentBody body, final HttpMultipartMode mode) { return new FormBodyPartBuilder(name, body, mode); } public static FormBodyPartBuilder create(final String name, final ContentBody body) { return new FormBodyPartBuilder(name, body, HttpMultipartMode.STRICT); } public static FormBodyPartBuilder create() { return new FormBodyPartBuilder(); } FormBodyPartBuilder(final String name, final ContentBody body, final HttpMultipartMode mode) { this(); this.name = name; this.body = body; this.mode = mode != null ? mode : HttpMultipartMode.STRICT; } FormBodyPartBuilder() { this.header = new Header(); this.mode = HttpMultipartMode.STRICT; } public FormBodyPartBuilder setName(final String name) { this.name = name; return this; } public FormBodyPartBuilder setBody(final ContentBody body) { this.body = body; return this; } /** * @since 4.6 */ public FormBodyPartBuilder addField(final String name, final String value, final List parameters) { Args.notNull(name, "Field name"); this.header.addField(new MimeField(name, value, parameters)); return this; } public FormBodyPartBuilder addField(final String name, final String value) { Args.notNull(name, "Field name"); this.header.addField(new MimeField(name, value)); return this; } public FormBodyPartBuilder setField(final String name, final String value) { Args.notNull(name, "Field name"); this.header.setField(new MimeField(name, value)); return this; } public FormBodyPartBuilder removeFields(final String name) { Args.notNull(name, "Field name"); this.header.removeFields(name); return this; } /** * Determines whether the given string can be encoded in ISO-8859-1 without loss of data. * This is used to decide whether the {@code filename} parameter can be used as-is or if * the {@code filename*} parameter is needed for non-ISO-8859-1 characters. * * @param input the string to check, must not be {@code null} * @return {@code true} if the string can be encoded in ISO-8859-1, {@code false} otherwise * @since 5.5 */ private boolean canEncodeToISO8859_1(final String input) { if (iso8859_1Encoder == null) { iso8859_1Encoder = StandardCharsets.ISO_8859_1.newEncoder(); } return iso8859_1Encoder.canEncode(input); } /** * Encodes the given filename according to RFC 5987, prefixing it with {@code UTF-8''} and * applying percent-encoding to non-ASCII characters. This is used for the {@code filename*} * parameter in the {@code Content-Disposition} header when non-ISO-8859-1 characters are present. * * @param filename the filename to encode, must not be {@code null} * @return the RFC 5987-encoded string, e.g., {@code UTF-8''example%20text} * @since 5.5 */ private static String encodeRFC5987(final String filename) { return "UTF-8''" + PercentCodec.RFC5987.encode(filename); } public FormBodyPart build() { Asserts.notBlank(this.name, "Name"); Asserts.notNull(this.body, "Content body"); final Header headerCopy = new Header(); final List fields = this.header.getFields(); for (final MimeField field: fields) { headerCopy.addField(field); } if (headerCopy.getField(MimeConsts.CONTENT_DISPOSITION) == null) { final List fieldParameters = new ArrayList<>(); fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, this.name)); if (this.body.getFilename() != null) { final String filename = this.body.getFilename(); fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, filename)); // Add filename* only if non-ISO-8859-1 and not in LEGACY mode if (mode != HttpMultipartMode.LEGACY && !canEncodeToISO8859_1(filename)) { fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME_START, encodeRFC5987(filename))); } } headerCopy.addField(new MimeField(MimeConsts.CONTENT_DISPOSITION, "form-data", fieldParameters)); } if (headerCopy.getField(MimeConsts.CONTENT_TYPE) == null) { final ContentType contentType; if (body instanceof AbstractContentBody) { contentType = ((AbstractContentBody) body).getContentType(); } else { contentType = null; } if (contentType != null) { headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, contentType.toString())); } else { final StringBuilder buffer = new StringBuilder(); buffer.append(this.body.getMimeType()); // MimeType cannot be null if (this.body.getCharset() != null) { // charset may legitimately be null buffer.append("; charset="); buffer.append(this.body.getCharset()); } headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, buffer.toString())); } } return new FormBodyPart(this.name, this.body, headerCopy); } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/Header.java0100644 0000000 0000000 00000010477 00000250600 025715 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; /** * The header of a MIME entity. */ public class Header implements Iterable { private final List fields; private final Map> fieldMap; public Header() { super(); this.fields = new LinkedList<>(); this.fieldMap = new HashMap<>(); } public void addField(final MimeField field) { if (field == null) { return; } final String key = field.getName().toLowerCase(Locale.ROOT); final List values = this.fieldMap.computeIfAbsent(key, k -> new LinkedList<>()); values.add(field); this.fields.add(field); } public List getFields() { return new ArrayList<>(this.fields); } public MimeField getField(final String name) { if (name == null) { return null; } final String key = name.toLowerCase(Locale.ROOT); final List list = this.fieldMap.get(key); if (list != null && !list.isEmpty()) { return list.get(0); } return null; } public List getFields(final String name) { if (name == null) { return null; } final String key = name.toLowerCase(Locale.ROOT); final List list = this.fieldMap.get(key); if (list == null || list.isEmpty()) { return Collections.emptyList(); } return new ArrayList<>(list); } public int removeFields(final String name) { if (name == null) { return 0; } final String key = name.toLowerCase(Locale.ROOT); final List removed = fieldMap.remove(key); if (removed == null || removed.isEmpty()) { return 0; } this.fields.removeAll(removed); return removed.size(); } public void setField(final MimeField field) { if (field == null) { return; } final String key = field.getName().toLowerCase(Locale.ROOT); final List list = fieldMap.get(key); if (list == null || list.isEmpty()) { addField(field); return; } list.clear(); list.add(field); int firstOccurrence = -1; int index = 0; for (final Iterator it = this.fields.iterator(); it.hasNext(); index++) { final MimeField f = it.next(); if (f.getName().equalsIgnoreCase(field.getName())) { it.remove(); if (firstOccurrence == -1) { firstOccurrence = index; } } } this.fields.add(firstOccurrence, field); } @Override public Iterator iterator() { return Collections.unmodifiableList(fields).iterator(); } @Override public String toString() { return this.fields.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpMultipartMode.java0100644 0000000 0000000 00000003563 00000250600 030151 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * MIME compliance mode. * * @since 4.0 */ public enum HttpMultipartMode { /** * Legacy compatibility mode. *

* In this mode only the most essential fields are generated * such as Content-Type and Content-Disposition. */ LEGACY, /** * Strict MIME specification conformance. *

* Presently conforms to RFC 822, RFC 2045, RFC 2046. */ STRICT, /** * Extended MIME specification conformance. *

* In this mode header field values may contain international UTF-8 encoded * characters. *

* Presently conforms to RFC 6532 and RFC 7578. */ EXTENDED, } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpRFC6532Multipart.java0100644 0000000 0000000 00000006320 00000250600 030211 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; class HttpRFC6532Multipart extends AbstractMultipartFormat { private final List parts; /** * Constructs a new instance of {@code HttpRFC6532Multipart}. * * @param charset The charset to use for the message. * @param boundary The boundary string to use for the message. * @param parts The list of parts that make up the message. * @param preamble The preamble to include at the beginning of the message, or {@code null} if none. * @param epilogue The epilogue to include at the end of the message, or {@code null} if none. */ public HttpRFC6532Multipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue) { super(charset, boundary, preamble, epilogue); this.parts = parts; } /** * Constructs a new instance of {@code HttpRFC6532Multipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpRFC6532Multipart( final Charset charset, final String boundary, final List parts) { this(charset,boundary,parts,null, null); } @Override public List getParts() { return this.parts; } @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For RFC6532, we output all fields with UTF-8 encoding. final Header header = part.getHeader(); for (final MimeField field: header) { writeField(field, StandardCharsets.UTF_8, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpRFC7578Multipart.java0100644 0000000 0000000 00000013234 00000250600 030226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.net.PercentCodec; class HttpRFC7578Multipart extends AbstractMultipartFormat { private final List parts; private final HttpMultipartMode mode; /** * Constructs a new instance of {@code HttpRFC7578Multipart} with the given charset, boundary, parts, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. * @param preamble the optional preamble string to include before the first part. May be {@code null}. * @param epilogue the optional epilogue string to include after the last part. May be {@code null}. */ public HttpRFC7578Multipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue, final HttpMultipartMode mode) { super(charset, boundary, preamble, epilogue); this.parts = parts; this.mode = mode != null ? mode : HttpMultipartMode.STRICT; // Default to STRICT } /** * Constructs a new instance of {@code HttpRFC7578Multipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpRFC7578Multipart( final Charset charset, final String boundary, final List parts, final HttpMultipartMode mode) { this(charset,boundary,parts,null, null, mode); } @Override public List getParts() { return parts; } @Override protected void formatMultipartHeader(final MultipartPart part, final OutputStream out) throws IOException { for (final MimeField field: part.getHeader()) { if (MimeConsts.CONTENT_DISPOSITION.equalsIgnoreCase(field.getName())) { writeBytes(field.getName(), charset, out); writeBytes(FIELD_SEP, out); writeBytes(field.getValue(), out); final List parameters = field.getParameters(); for (int i = 0; i < parameters.size(); i++) { final NameValuePair parameter = parameters.get(i); final String name = parameter.getName(); final String value = parameter.getValue(); writeBytes("; ", out); writeBytes(name, out); writeBytes("=\"", out); if (value != null) { if (name.equalsIgnoreCase(MimeConsts.FIELD_PARAM_FILENAME_START)) { if (value.startsWith("UTF-8''")) { writeBytes(value, StandardCharsets.US_ASCII, out); } else { final StringBuilder sb = new StringBuilder(value.length() + 16); sb.append("UTF-8''"); PercentCodec.RFC5987.encode(sb, value); writeBytes(sb.toString(), StandardCharsets.US_ASCII, out); } } else if (name.equalsIgnoreCase(MimeConsts.FIELD_PARAM_FILENAME)) { if (mode == HttpMultipartMode.EXTENDED) { final StringBuilder sb = new StringBuilder(value.length() + 8); PercentCodec.RFC5987.encode(sb, value); writeBytes(sb.toString(), StandardCharsets.US_ASCII, out); } else { // Default to ISO-8859-1 for RFC 7578 compliance in STRICT/LEGACY writeBytes(value, StandardCharsets.ISO_8859_1, out); } } else { writeBytes(value, out); } } writeBytes("\"", out); } writeBytes(CR_LF, out); } else { writeField(field, charset, out); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpStrictMultipart.java0100644 0000000 0000000 00000006114 00000250600 030530 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.util.List; class HttpStrictMultipart extends AbstractMultipartFormat { private final List parts; /** * Constructs a new instance of {@code HttpStrictMultipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpStrictMultipart( final Charset charset, final String boundary, final List parts) { this(charset,boundary,parts,null, null); } /** * Constructs a new instance of {@code HttpStrictMultipart} with the given charset, boundary, parts, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. * @param preamble the preamble string to use. * @param epilogue the epilogue string to use. */ public HttpStrictMultipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue) { super(charset, boundary, preamble, epilogue); this.parts = parts; } @Override public List getParts() { return this.parts; } @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For strict, we output all fields with MIME-standard encoding. final Header header = part.getHeader(); for (final MimeField field: header) { writeField(field, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/InputStreamBody.java0100644 0000000 0000000 00000006234 00000250600 027612 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by an input stream. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class InputStreamBody extends AbstractContentBody { private final InputStream in; private final String filename; private final long contentLength; public InputStreamBody(final InputStream in, final String filename) { this(in, ContentType.DEFAULT_BINARY, filename); } /** * @since 4.3 */ public InputStreamBody(final InputStream in, final ContentType contentType, final String filename) { this(in, contentType, filename, -1); } /** * @since 4.6 */ public InputStreamBody(final InputStream in, final ContentType contentType, final String filename, final long contentLength) { super(contentType); Args.notNull(in, "Input stream"); this.in = in; this.filename = filename; this.contentLength = contentLength >= 0 ? contentLength : -1; } /** * @since 4.3 */ public InputStreamBody(final InputStream in, final ContentType contentType) { this(in, contentType, null); } public InputStream getInputStream() { return this.in; } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); try { final byte[] tmp = new byte[4096]; int l; while ((l = this.in.read(tmp)) != -1) { out.write(tmp, 0, l); } out.flush(); } finally { this.in.close(); } } @Override public long getContentLength() { return this.contentLength; } @Override public String getFilename() { return this.filename; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/LegacyMultipart.java0100644 0000000 0000000 00000005251 00000250600 027625 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.util.List; /** * HttpBrowserCompatibleMultipart represents a collection of MIME multipart encoded * content bodies. This class is emulates browser compatibility, e.g. IE 5 or earlier. * * @since 4.3 */ class LegacyMultipart extends AbstractMultipartFormat { private final List parts; public LegacyMultipart( final Charset charset, final String boundary, final List parts) { super(charset, boundary); this.parts = parts; } @Override public List getParts() { return this.parts; } /** * Write the multipart header fields; depends on the style. */ @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For browser-compatible, only write Content-Disposition // Use content charset final Header header = part.getHeader(); final MimeField cd = header.getField(MimeConsts.CONTENT_DISPOSITION); if (cd != null) { writeField(cd, this.charset, out); } final String filename = part.getBody().getFilename(); if (filename != null) { final MimeField ct = header.getField(MimeConsts.CONTENT_TYPE); writeField(ct, this.charset, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MimeConsts.java0100644 0000000 0000000 00000003077 00000250600 026604 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; final class MimeConsts { public static final String CONTENT_TYPE = "Content-Type"; public static final String CONTENT_DISPOSITION = "Content-Disposition"; public static final String FIELD_PARAM_NAME = "name"; public static final String FIELD_PARAM_FILENAME = "filename"; public static final String FIELD_PARAM_FILENAME_START = "filename*"; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MimeField.java0100644 0000000 0000000 00000010004 00000250600 026342 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.ArrayList; import java.util.Collections; import java.util.List; import org.apache.hc.core5.http.NameValuePair; /** * Minimal MIME field. * * @since 4.0 */ public class MimeField { private final String name; private final String value; private final List parameters; /** * Constructs a new instance. * * @param name the field name. * @param value the field value. */ public MimeField(final String name, final String value) { super(); this.name = name; this.value = value; this.parameters = Collections.emptyList(); } /** * Constructs a new instance. * * @param name the field name. * @param value the field value. * @param parameters the field parameters. * @since 4.6 */ public MimeField(final String name, final String value, final List parameters) { this.name = name; this.value = value; this.parameters = parameters != null ? Collections.unmodifiableList(new ArrayList<>(parameters)) : Collections.emptyList(); } /** * Constructs a new instance by copying another's properties. * * @param from the source field. */ public MimeField(final MimeField from) { this(from.name, from.value, from.parameters); } /** * Gets the field name. * * @return the field name. */ public String getName() { return this.name; } /** * Gets the field value. * * @return the field value. * @since 4.6 */ public String getValue() { return this.value; } /** * Converts this instance to a body String. * * @return this instance as a body String. */ public String getBody() { final StringBuilder sb = new StringBuilder(); sb.append(this.value); parameters.forEach(parameter -> { sb.append("; "); sb.append(parameter.getName()); sb.append("=\""); final String v = parameter.getValue(); for (int n = 0; n < v.length(); n++) { final char ch = v.charAt(n); if (ch == '"' || ch == '\\' ) { sb.append("\\"); } sb.append(ch); } sb.append("\""); }); return sb.toString(); } /** * Gets the field parameters. * * @return the field parameters. */ public List getParameters() { return this.parameters; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append(this.name); buffer.append(": "); buffer.append(this.getBody()); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartEntityBuilder.java0100644 0000000 0000000 00000031540 00000250600 031204 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.io.InputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.nio.file.Path; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.UUID; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Builder for multipart {@link HttpEntity}s. *

* This class constructs multipart entities with a boundary determined by either a random UUID * or an explicit boundary set via {@link #setBoundary(String)}. *

*

* IMPORTANT: it is responsibility of the caller to validate / sanitize content of body * parts. For instance, when using an explicit boundary, it's the caller's responsibility to * ensure the body parts do not contain the boundary value, which can prevent the consumer of * the entity from correctly parsing / processing the body parts. *

* * @since 5.0 */ public class MultipartEntityBuilder { private ContentType contentType; private HttpMultipartMode mode = HttpMultipartMode.STRICT; private String boundary; private Charset charset; private List multipartParts; private static final String BOUNDARY_PREFIX = "httpclient_boundary_"; /** * The logger for this class. */ private static final Logger LOG = LoggerFactory.getLogger(MultipartEntityBuilder.class); /** * The preamble of the multipart message. * This field stores the optional preamble that should be added at the beginning of the multipart message. * It can be {@code null} if no preamble is needed. */ private String preamble; /** * The epilogue of the multipart message. * This field stores the optional epilogue that should be added at the end of the multipart message. * It can be {@code null} if no epilogue is needed. */ private String epilogue; /** * An empty immutable {@code NameValuePair} array. */ private static final NameValuePair[] EMPTY_NAME_VALUE_ARRAY = {}; public static MultipartEntityBuilder create() { return new MultipartEntityBuilder(); } MultipartEntityBuilder() { } public MultipartEntityBuilder setMode(final HttpMultipartMode mode) { this.mode = mode; return this; } public MultipartEntityBuilder setLaxMode() { this.mode = HttpMultipartMode.LEGACY; return this; } public MultipartEntityBuilder setStrictMode() { this.mode = HttpMultipartMode.STRICT; return this; } /** * Sets a custom boundary string for the multipart entity. *

* If {@code null} is provided, the builder reverts to its default logic of using a random UUID. *

*

* IMPORTANT: when setting an explicit boundary, it is responsibility of the caller to validate / sanitize content * of body parts to ensure they do not contain the boundary value. *

* * @param boundary the boundary string, or {@code null} to use a random UUID. * @return this builder instance */ public MultipartEntityBuilder setBoundary(final String boundary) { this.boundary = boundary; return this; } /** * @since 4.4 */ public MultipartEntityBuilder setMimeSubtype(final String subType) { Args.notBlank(subType, "MIME subtype"); this.contentType = ContentType.create("multipart/" + subType); return this; } /** * @return this instance. * @since 4.5 */ public MultipartEntityBuilder setContentType(final ContentType contentType) { Args.notNull(contentType, "Content type"); this.contentType = contentType; return this; } /** * Add parameter to the current {@link ContentType}. * * @param parameter The name-value pair parameter to add to the {@link ContentType}. * @return this instance. * @since 5.2 */ public MultipartEntityBuilder addParameter(final BasicNameValuePair parameter) { this.contentType = contentType.withParameters(parameter); return this; } public MultipartEntityBuilder setCharset(final Charset charset) { this.charset = charset; return this; } /** * @since 4.4 */ public MultipartEntityBuilder addPart(final MultipartPart multipartPart) { if (multipartPart == null) { return this; } if (this.multipartParts == null) { this.multipartParts = new ArrayList<>(); } this.multipartParts.add(multipartPart); return this; } public MultipartEntityBuilder addPart(final String name, final ContentBody contentBody) { Args.notNull(name, "Name"); Args.notNull(contentBody, "Content body"); return addPart(FormBodyPartBuilder.create(name, contentBody).build()); } public MultipartEntityBuilder addTextBody( final String name, final String text, final ContentType contentType) { return addPart(name, new StringBody(text, contentType)); } public MultipartEntityBuilder addTextBody( final String name, final String text) { return addTextBody(name, text, ContentType.DEFAULT_TEXT); } public MultipartEntityBuilder addBinaryBody( final String name, final byte[] b, final ContentType contentType, final String filename) { return addPart(name, new ByteArrayBody(b, contentType, filename)); } public MultipartEntityBuilder addBinaryBody( final String name, final byte[] b) { return addPart(name, new ByteArrayBody(b, ContentType.DEFAULT_BINARY)); } public MultipartEntityBuilder addBinaryBody( final String name, final File file, final ContentType contentType, final String filename) { return addPart(name, new FileBody(file, contentType, filename)); } /** * Adds body with contents from the given source Path. * * @param name The part name. * @param path The source path. * @return {@code this} instance. * @since 5.6 */ public MultipartEntityBuilder addBinaryBody(final String name, final Path path) { return addBinaryBody(name, path, ContentType.DEFAULT_BINARY, path != null ? path.getFileName().toString() : null); } /** * Adds body with contents from the given source Path. * * @param name The part name. * @param path The source path. * @param contentType The content type. * @param fileName The file name to override the Path's file name. * @return {@code this} instance. * @since 5.6 */ public MultipartEntityBuilder addBinaryBody(final String name, final Path path, final ContentType contentType, final String fileName) { return addPart(name, new PathBody(path, contentType, fileName)); } public MultipartEntityBuilder addBinaryBody( final String name, final File file) { return addBinaryBody(name, file, ContentType.DEFAULT_BINARY, file != null ? file.getName() : null); } public MultipartEntityBuilder addBinaryBody( final String name, final InputStream stream, final ContentType contentType, final String filename) { return addPart(name, new InputStreamBody(stream, contentType, filename)); } public MultipartEntityBuilder addBinaryBody(final String name, final InputStream stream) { return addBinaryBody(name, stream, ContentType.DEFAULT_BINARY, null); } /** * Generates a random boundary using UUID. The UUID is a v4 random UUID generated from a cryptographically-secure * random source. *

* A cryptographically-secure random number source is used to generate the UUID, to avoid a malicious actor crafting * a body part that contains the boundary value to tamper with the entity structure. *

*/ private String getRandomBoundary() { return BOUNDARY_PREFIX + UUID.randomUUID(); } /** * Adds a preamble to the multipart entity being constructed. The preamble is the text that appears before the first * boundary delimiter. The preamble is optional and may be null. * * @param preamble The preamble text to add to the multipart entity * @return this instance. * * @since 5.3 */ public MultipartEntityBuilder addPreamble(final String preamble) { this.preamble = preamble; return this; } /** * Adds an epilogue to the multipart entity being constructed. The epilogue is the text that appears after the last * boundary delimiter. The epilogue is optional and may be null. * * @param epilogue The epilogue text to add to the multipart entity * @return this instance. * @since 5.3 */ public MultipartEntityBuilder addEpilogue(final String epilogue) { this.epilogue = epilogue; return this; } MultipartFormEntity buildEntity() { String boundaryCopy = boundary; if (boundaryCopy == null && contentType != null) { boundaryCopy = contentType.getParameter("boundary"); } if (boundaryCopy == null) { boundaryCopy = getRandomBoundary(); } Charset charsetCopy = charset; if (charsetCopy == null && contentType != null) { charsetCopy = contentType.getCharset(); } final NameValuePair[] params = new NameValuePair[]{new BasicNameValuePair("boundary", boundaryCopy)}; final ContentType contentTypeCopy; if (contentType != null) { contentTypeCopy = contentType.withParameters(params); } else { boolean formData = false; if (multipartParts != null) { for (final MultipartPart multipartPart : multipartParts) { if (multipartPart instanceof FormBodyPart) { formData = true; break; } } } if (formData) { contentTypeCopy = ContentType.MULTIPART_FORM_DATA.withParameters(params); } else { contentTypeCopy = ContentType.create("multipart/mixed", params); } } final List multipartPartsCopy = multipartParts != null ? new ArrayList<>(multipartParts) : Collections.emptyList(); final HttpMultipartMode modeCopy = mode != null ? mode : HttpMultipartMode.STRICT; final AbstractMultipartFormat form; switch (modeCopy) { case LEGACY: form = new LegacyMultipart(charsetCopy, boundaryCopy, multipartPartsCopy); break; case EXTENDED: if (contentTypeCopy.isSameMimeType(ContentType.MULTIPART_FORM_DATA)) { if (charsetCopy == null) { charsetCopy = StandardCharsets.UTF_8; } form = new HttpRFC7578Multipart(charsetCopy, boundaryCopy, multipartPartsCopy, preamble, epilogue, modeCopy); } else { form = new HttpRFC6532Multipart(charsetCopy, boundaryCopy, multipartPartsCopy, preamble, epilogue); } break; default: form = new HttpStrictMultipart(StandardCharsets.US_ASCII, boundaryCopy, multipartPartsCopy, preamble, epilogue); } return new MultipartFormEntity(form, contentTypeCopy, form.getTotalLength()); } public HttpEntity build() { return buildEntity(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartFormEntity.java0100644 0000000 0000000 00000007302 00000250600 030520 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.List; import java.util.Objects; import java.util.Set; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ContentTooLongException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; class MultipartFormEntity implements HttpEntity { private final AbstractMultipartFormat multipart; private final ContentType contentType; private final long contentLength; MultipartFormEntity( final AbstractMultipartFormat multipart, final ContentType contentType, final long contentLength) { super(); this.multipart = multipart; this.contentType = contentType; this.contentLength = contentLength; } AbstractMultipartFormat getMultipart() { return this.multipart; } @Override public boolean isRepeatable() { return this.contentLength != -1; } @Override public boolean isChunked() { return !isRepeatable(); } @Override public boolean isStreaming() { return !isRepeatable(); } @Override public long getContentLength() { return this.contentLength; } @Override public String getContentType() { return Objects.toString(contentType, null); } @Override public String getContentEncoding() { return null; } @Override public InputStream getContent() throws IOException { if (this.contentLength < 0) { throw new ContentTooLongException("Content length is unknown"); } else if (this.contentLength > 25 * 1024) { throw new ContentTooLongException("Content length is too long: " + this.contentLength); } final ByteArrayOutputStream outStream = new ByteArrayOutputStream(); writeTo(outStream); outStream.flush(); return new ByteArrayInputStream(outStream.toByteArray()); } @Override public void writeTo(final OutputStream outStream) throws IOException { this.multipart.writeTo(outStream); } @Override public Supplier> getTrailers() { return null; } @Override public Set getTrailerNames() { return null; } @Override public void close() throws IOException { } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartPart.java0100644 0000000 0000000 00000004072 00000250600 027327 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * MultipartPart class represents a content body that can be used as a part of multipart encoded * entities. This class automatically populates the header with standard fields based on * the content description of the enclosed body. * * @since 5.0 */ public class MultipartPart { private final Header header; private final ContentBody body; MultipartPart(final ContentBody body, final Header header) { super(); this.body = body; this.header = header != null ? header : new Header(); } public ContentBody getBody() { return this.body; } public Header getHeader() { return this.header; } void addField(final String name, final String value) { addField(new MimeField(name, value)); } void addField(final MimeField field) { this.header.addField(field); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartPartBuilder.java0100644 0000000 0000000 00000010324 00000250600 030633 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; /** * Builder for individual {@link MultipartPart}s. * * @since 4.4 */ public class MultipartPartBuilder { private ContentBody body; private final Header header; public static MultipartPartBuilder create(final ContentBody body) { return new MultipartPartBuilder(body); } public static MultipartPartBuilder create() { return new MultipartPartBuilder(); } MultipartPartBuilder(final ContentBody body) { this(); this.body = body; } MultipartPartBuilder() { this.header = new Header(); } public MultipartPartBuilder setBody(final ContentBody body) { this.body = body; return this; } public MultipartPartBuilder addHeader(final String name, final String value, final List parameters) { Args.notNull(name, "Header name"); this.header.addField(new MimeField(name, value, parameters)); return this; } public MultipartPartBuilder addHeader(final String name, final String value) { Args.notNull(name, "Header name"); this.header.addField(new MimeField(name, value)); return this; } public MultipartPartBuilder setHeader(final String name, final String value) { Args.notNull(name, "Header name"); this.header.setField(new MimeField(name, value)); return this; } public MultipartPartBuilder removeHeaders(final String name) { Args.notNull(name, "Header name"); this.header.removeFields(name); return this; } public MultipartPart build() { Asserts.notNull(this.body, "Content body"); final Header headerCopy = new Header(); final List fields = this.header.getFields(); for (final MimeField field: fields) { headerCopy.addField(field); } if (headerCopy.getField(MimeConsts.CONTENT_TYPE) == null) { final ContentType contentType; if (body instanceof AbstractContentBody) { contentType = ((AbstractContentBody) body).getContentType(); } else { contentType = null; } if (contentType != null) { headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, contentType.toString())); } else { final StringBuilder buffer = new StringBuilder(); buffer.append(this.body.getMimeType()); // MimeType cannot be null if (this.body.getCharset() != null) { // charset may legitimately be null buffer.append("; charset="); buffer.append(this.body.getCharset()); } headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, buffer.toString())); } } return new MultipartPart(this.body, headerCopy); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/PathBody.java0100644 0000000 0000000 00000007263 00000250600 026236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.UncheckedIOException; import java.nio.file.Files; import java.nio.file.Path; import java.util.Objects; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by an NIO {@link Path}. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 5.6 */ public class PathBody extends AbstractContentBody { private static String getFileName(final Path path) { return path != null ? Objects.toString(path.getFileName(), null) : null; } private final String fileName; private final Path path; /** * Constructs a new instance for a given Path. * * @param path the source Path. */ public PathBody(final Path path) { this(path, ContentType.DEFAULT_BINARY, getFileName(path)); } /** * Constructs a new instance for a given Path. * * @param path the source Path. * @param contentType the content type. */ public PathBody(final Path path, final ContentType contentType) { this(path, contentType, getFileName(path)); } /** * Constructs a new instance for a given Path. * * @param path the source Path. * @param contentType the content type. * @param fileName The file name to override the Path's file name. */ public PathBody(final Path path, final ContentType contentType, final String fileName) { super(contentType); this.path = Args.notNull(path, "path"); this.fileName = fileName == null ? getFileName(path) : fileName; } @Override public long getContentLength() { try { return Files.size(path); } catch (final IOException e) { throw new UncheckedIOException(e); } } @Override public String getFilename() { return fileName; } /** * Gets a new input stream. * * @return a new input stream. * @throws IOException if an I/O error occurs */ public InputStream getInputStream() throws IOException { return Files.newInputStream(path); } /** * Gets the source Path. * * @return the source Path. */ public Path getPath() { return path; } @Override public void writeTo(final OutputStream out) throws IOException { Files.copy(path, Args.notNull(out, "Output stream")); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/StringBody.java0100644 0000000 0000000 00000005230 00000250600 026600 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStream; import java.io.Reader; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Text body part backed by a byte array. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class StringBody extends AbstractContentBody { private final byte[] content; /** * @since 4.3 */ public StringBody(final String text, final ContentType contentType) { super(contentType); Args.notNull(text, "Text"); final Charset charset = contentType.getCharset(); this.content = text.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); } public Reader getReader() { final Charset charset = getContentType().getCharset(); return new InputStreamReader( new ByteArrayInputStream(this.content), charset != null ? charset : StandardCharsets.US_ASCII); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); out.write(this.content); } @Override public long getContentLength() { return this.content.length; } @Override public String getFilename() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/package-info.java0100644 0000000 0000000 00000002404 00000250600 027040 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * MIME coded HTTP entity implementations. */ package org.apache.hc.client5.http.entity.mime; httpclient5/src/main/java/org/apache/hc/client5/http/impl/0040755 0000000 0000000 00000000000 00000250600 022352 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/Brotli4jRuntime.java0100644 0000000 0000000 00000003754 00000250600 026260 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; @Internal @Contract(threading = ThreadingBehavior.STATELESS) public final class Brotli4jRuntime { private static final String BROTLI = "com.aayushatharva.brotli4j.Brotli4jLoader"; private Brotli4jRuntime() { } /** * @return {@code true} if {@code com.aayushatharva.brotli4j} can be loaded * by the current class loader; {@code false} otherwise */ public static boolean available() { try { Class.forName(BROTLI, false, Brotli4jRuntime.class.getClassLoader()); return true; } catch (ClassNotFoundException | LinkageError ex) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ChainElement.java0100644 0000000 0000000 00000002614 00000250600 025551 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; /** * Supported elements of request execution pipeline. * * @since 5.0 */ public enum ChainElement { REDIRECT, COMPRESS, BACK_OFF, RETRY, CACHING, PROTOCOL, CONNECT, MAIN_TRANSPORT } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnPoolSupport.java0100644 0000000 0000000 00000005512 00000250600 026341 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.util.Identifiable; /** * Connection pooling support methods. * * @since 5.0 */ @Internal public final class ConnPoolSupport { public static String getId(final Object object) { if (object == null) { return null; } return object instanceof Identifiable ? ((Identifiable) object).getId() : object.getClass().getSimpleName() + "-" + Integer.toHexString(System.identityHashCode(object)); } public static String formatStats( final HttpRoute route, final Object state, final ConnPoolControl connPool) { final StringBuilder buf = new StringBuilder(); buf.append("[route: ").append(route).append("]"); if (state != null) { buf.append("[state: ").append(state).append("]"); } final PoolStats totals = connPool.getTotalStats(); final PoolStats stats = connPool.getStats(route); buf.append("[total available: ").append(totals.getAvailable()).append("; "); buf.append("route allocated: ").append(stats.getLeased() + stats.getAvailable()); buf.append(" of ").append(stats.getMax()).append("; "); buf.append("total allocated: ").append(totals.getLeased() + totals.getAvailable()); buf.append(" of ").append(totals.getMax()).append("]"); return buf.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnectionHolder.java0100644 0000000 0000000 00000002707 00000250600 026455 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpConnection; /** * Internal interface to expose the underlying connection * @since 5.5 */ @Internal public interface ConnectionHolder { HttpConnection get(); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnectionShutdownException.java0100644 0000000 0000000 00000003201 00000250600 030720 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; /** * Signals that the connection has been shut down or released back to the * the connection pool * * @since 4.1 */ public class ConnectionShutdownException extends IllegalStateException { private static final long serialVersionUID = 5868657401162844497L; /** * Creates a new ConnectionShutdownException with a {@code null} detail message. */ public ConnectionShutdownException() { super(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ContentCodingSupport.java0100644 0000000 0000000 00000005432 00000250600 027351 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Locale; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.message.ParserCursor; /** * @since 5.6 */ @Internal public final class ContentCodingSupport { public static final int MAX_CODEC_LIST_LEN = 5; private ContentCodingSupport() { } public static List parseContentCodecs(final EntityDetails entityDetails) { if (entityDetails == null || entityDetails.getContentEncoding() == null) { return Collections.emptyList(); } final String contentEncoding = entityDetails.getContentEncoding(); final ParserCursor cursor = new ParserCursor(0, contentEncoding.length()); final List codecs = new ArrayList<>(); MessageSupport.parseTokens(contentEncoding, cursor, token -> { final String codec = token.toLowerCase(Locale.ROOT); if (!codec.isEmpty() && !"identity".equals(codec)) { codecs.add(codec); } }); return codecs; } public static void validate(final Collection codecList, final int maxCodecListLen) throws ProtocolException { if (maxCodecListLen > 0 && codecList.size() > maxCodecListLen) { throw new ProtocolException("Codec list exceeds maximum of " + maxCodecListLen + " elements"); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/CookieSpecSupport.java0100644 0000000 0000000 00000006606 00000250600 026643 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.client5.http.impl.cookie.IgnoreCookieSpecFactory; import org.apache.hc.client5.http.impl.cookie.RFC6265CookieSpecFactory; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; /** * Cookie support methods. * * @since 5.0 */ @Internal public final class CookieSpecSupport { /** * Creates a builder containing the default registry entries, using the provided public suffix matcher. */ public static RegistryBuilder createDefaultBuilder(final PublicSuffixMatcher publicSuffixMatcher) { return RegistryBuilder.create() .register(StandardCookieSpec.RELAXED, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.RELAXED, publicSuffixMatcher)) .register(StandardCookieSpec.STRICT, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.STRICT, publicSuffixMatcher)) .register(StandardCookieSpec.IGNORE, new IgnoreCookieSpecFactory()); } /** * Creates a builder containing the default registry entries with the default public suffix matcher. */ public static RegistryBuilder createDefaultBuilder() { return createDefaultBuilder(PublicSuffixMatcherLoader.getDefault()); } /** * Creates the default registry, using the default public suffix matcher. */ public static Lookup createDefault() { return createDefault(PublicSuffixMatcherLoader.getDefault()); } /** * Creates the default registry with the provided public suffix matcher */ public static Lookup createDefault(final PublicSuffixMatcher publicSuffixMatcher) { return createDefaultBuilder(publicSuffixMatcher).build(); } private CookieSpecSupport() { } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultAuthenticationStrategy.java0100644 0000000 0000000 00000012337 00000250600 031227 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default implementation of {@link AuthenticationStrategy} * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultAuthenticationStrategy implements AuthenticationStrategy { private static final Logger LOG = LoggerFactory.getLogger(DefaultAuthenticationStrategy.class); /** * Default instance of {@link DefaultAuthenticationStrategy}. */ public static final DefaultAuthenticationStrategy INSTANCE = new DefaultAuthenticationStrategy(); private static final List DEFAULT_SCHEME_PRIORITY = Collections.unmodifiableList(Arrays.asList( StandardAuthScheme.BEARER, StandardAuthScheme.DIGEST, StandardAuthScheme.BASIC)); protected List getSchemePriority() { return DEFAULT_SCHEME_PRIORITY; } @Override public List select( final ChallengeType challengeType, final Map challenges, final HttpContext context) { Args.notNull(challengeType, "ChallengeType"); Args.notNull(challenges, "Map of auth challenges"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final List options = new ArrayList<>(); final Lookup registry = clientContext.getAuthSchemeRegistry(); if (registry == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Auth scheme registry not set in the context", exchangeId); } return options; } final RequestConfig config = clientContext.getRequestConfigOrDefault(); Collection authPrefs = challengeType == ChallengeType.TARGET ? config.getTargetPreferredAuthSchemes() : config.getProxyPreferredAuthSchemes(); if (authPrefs == null) { authPrefs = getSchemePriority(); } if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication schemes in the order of preference: {}", exchangeId, authPrefs); } for (final String schemeName: authPrefs) { final AuthChallenge challenge = challenges.get(schemeName.toLowerCase(Locale.ROOT)); if (challenge != null) { final AuthSchemeFactory authSchemeFactory = registry.lookup(schemeName); if (authSchemeFactory == null) { if (LOG.isWarnEnabled()) { LOG.warn("{} Authentication scheme {} not supported", exchangeId, schemeName); // Try again } continue; } final AuthScheme authScheme = authSchemeFactory.create(context); options.add(authScheme); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Challenge for {} authentication scheme not available", exchangeId, schemeName); } } } return options; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultClientConnectionReuseStrategy.java0100644 0000000 0000000 00000004664 00000250600 032516 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.impl.DefaultConnectionReuseStrategy; import org.apache.hc.core5.http.protocol.HttpContext; /** * Extension of core {@link DefaultConnectionReuseStrategy} that treats * CONNECT method exchanges involved in proxy tunnelling as a special case. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultClientConnectionReuseStrategy extends DefaultConnectionReuseStrategy { /** * Default instance of {@link DefaultClientConnectionReuseStrategy}. */ public static final DefaultClientConnectionReuseStrategy INSTANCE = new DefaultClientConnectionReuseStrategy(); @Override public boolean keepAlive(final HttpRequest request, final HttpResponse response, final HttpContext context) { if (Method.CONNECT.isSame(request.getMethod()) && response.getCode() == HttpStatus.SC_OK) { return true; } return super.keepAlive(request, response, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultConnectionKeepAliveStrategy.java0100644 0000000 0000000 00000006465 00000250600 032142 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Default implementation of a strategy deciding duration * that a connection can remain idle. *

* The default implementation looks solely at the 'Keep-Alive' * header's timeout token. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultConnectionKeepAliveStrategy implements ConnectionKeepAliveStrategy { /** * Default instance of {@link DefaultConnectionKeepAliveStrategy}. */ public static final DefaultConnectionKeepAliveStrategy INSTANCE = new DefaultConnectionKeepAliveStrategy(); @Override public TimeValue getKeepAliveDuration(final HttpResponse response, final HttpContext context) { Args.notNull(response, "HTTP response"); final Iterator it = MessageSupport.iterate(response, HeaderElements.KEEP_ALIVE); while (it.hasNext()) { final HeaderElement he = it.next(); final String param = he.getName(); final String value = he.getValue(); if (value != null && param.equalsIgnoreCase("timeout")) { try { return TimeValue.ofSeconds(Long.parseLong(value)); } catch (final NumberFormatException ignore) { } } } final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); return requestConfig.getConnectionKeepAlive(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultHttpRequestRetryStrategy.java0100644 0000000 0000000 00000021640 00000250600 031563 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.io.IOException; import java.io.InterruptedIOException; import java.net.ConnectException; import java.net.NoRouteToHostException; import java.net.UnknownHostException; import java.time.Instant; import java.util.Arrays; import java.util.Collection; import java.util.HashSet; import java.util.Set; import javax.net.ssl.SSLException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Default implementation of the {@link HttpRequestRetryStrategy} interface. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpRequestRetryStrategy implements HttpRequestRetryStrategy { /** * Default instance of {@link DefaultHttpRequestRetryStrategy}. */ public static final DefaultHttpRequestRetryStrategy INSTANCE = new DefaultHttpRequestRetryStrategy(); /** * Maximum number of allowed retries */ private final int maxRetries; /** * Retry interval between subsequent retries */ private final TimeValue defaultRetryInterval; /** * Derived {@code IOExceptions} which shall not be retried */ private final Set> nonRetriableIOExceptionClasses; /** * HTTP status codes which shall be retried */ private final Set retriableCodes; protected DefaultHttpRequestRetryStrategy( final int maxRetries, final TimeValue defaultRetryInterval, final Collection> clazzes, final Collection codes) { Args.notNegative(maxRetries, "maxRetries"); Args.notNull(defaultRetryInterval, "defaultRetryInterval"); Args.check(TimeValue.isNonNegative(defaultRetryInterval), "Default retry interval is negative"); this.maxRetries = maxRetries; this.defaultRetryInterval = defaultRetryInterval; this.nonRetriableIOExceptionClasses = new HashSet<>(clazzes); this.retriableCodes = new HashSet<>(codes); } /** * Create the HTTP request retry strategy using the following list of * non-retriable I/O exception classes:
*
    *
  • InterruptedIOException
    • *
  • UnknownHostException
    • *
  • ConnectException
    • *
  • ConnectionClosedException
    • *
  • NoRouteToHostException
    • *
  • SSLException
    • *
* * and retriable HTTP status codes:
*
    *
  • SC_TOO_MANY_REQUESTS (429)
    • *
  • SC_SERVICE_UNAVAILABLE (503)
    • *
* * @param maxRetries how many times to retry; 0 means no retries * @param defaultRetryInterval the default retry interval between * subsequent retries if the {@code Retry-After} header is not set * or invalid. */ public DefaultHttpRequestRetryStrategy( final int maxRetries, final TimeValue defaultRetryInterval) { this(maxRetries, defaultRetryInterval, Arrays.asList( InterruptedIOException.class, UnknownHostException.class, ConnectException.class, ConnectionClosedException.class, NoRouteToHostException.class, SSLException.class), Arrays.asList( HttpStatus.SC_TOO_MANY_REQUESTS, HttpStatus.SC_SERVICE_UNAVAILABLE)); } /** * Create the HTTP request retry strategy with a max retry count of 1, * default retry interval of 1 second, and using the following list of * non-retriable I/O exception classes:
*
    *
  • InterruptedIOException
    • *
  • UnknownHostException
    • *
  • ConnectException
    • *
  • ConnectionClosedException
    • *
  • SSLException
    • *
* * and retriable HTTP status codes:
*
    *
  • SC_TOO_MANY_REQUESTS (429)
    • *
  • SC_SERVICE_UNAVAILABLE (503)
    • *
*/ public DefaultHttpRequestRetryStrategy() { this(1, TimeValue.ofSeconds(1L)); } @Override public boolean retryRequest( final HttpRequest request, final IOException exception, final int execCount, final HttpContext context) { Args.notNull(request, "request"); Args.notNull(exception, "exception"); if (execCount > this.maxRetries) { // Do not retry if over max retries return false; } if (this.nonRetriableIOExceptionClasses.contains(exception.getClass())) { return false; } for (final Class rejectException : this.nonRetriableIOExceptionClasses) { if (rejectException.isInstance(exception)) { return false; } } if (request instanceof CancellableDependency && ((CancellableDependency) request).isCancelled()) { return false; } // Retry if the request is considered idempotent return handleAsIdempotent(request); } @Override public boolean retryRequest( final HttpResponse response, final int execCount, final HttpContext context) { Args.notNull(response, "response"); if (context != null) { final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); if (responseTimeout != null && defaultRetryInterval.compareTo(responseTimeout) > 0) { return false; } } return execCount <= this.maxRetries && retriableCodes.contains(response.getCode()); } @Override public TimeValue getRetryInterval( final HttpResponse response, final int execCount, final HttpContext context) { Args.notNull(response, "response"); final Header header = response.getFirstHeader(HttpHeaders.RETRY_AFTER); TimeValue retryAfter = null; if (header != null) { final String value = header.getValue(); try { retryAfter = TimeValue.ofSeconds(Long.parseLong(value)); } catch (final NumberFormatException ignore) { final Instant retryAfterDate = DateUtils.parseStandardDate(value); if (retryAfterDate != null) { retryAfter = TimeValue.ofMilliseconds(retryAfterDate.toEpochMilli() - System.currentTimeMillis()); } } if (TimeValue.isPositive(retryAfter)) { return retryAfter; } } return this.defaultRetryInterval; } protected boolean handleAsIdempotent(final HttpRequest request) { return Method.isIdempotent(request.getMethod()); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultRedirectStrategy.java0100644 0000000 0000000 00000015630 00000250600 030010 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.URI; import java.net.URISyntaxException; import java.util.Iterator; import java.util.Locale; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link RedirectStrategy}. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultRedirectStrategy implements RedirectStrategy { private final SchemePortResolver schemePortResolver; /** * Default instance of {@link DefaultRedirectStrategy}. */ public static final DefaultRedirectStrategy INSTANCE = new DefaultRedirectStrategy(); /** * Creates a new {@code DefaultRedirectStrategy} using the given {@link SchemePortResolver}. * If {@code schemePortResolver} is {@code null}, this will default to * {@link DefaultSchemePortResolver#INSTANCE}. * * @param schemePortResolver the resolver to use for determining default ports * @since 5.6 */ public DefaultRedirectStrategy(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } /** * Creates a new {@code DefaultRedirectStrategy} with the default * {@link DefaultSchemePortResolver#INSTANCE}. * * @since 5.6 */ public DefaultRedirectStrategy() { this(null); } @Override public boolean isRedirectAllowed( final HttpHost currentTarget, final HttpHost newTarget, final HttpRequest redirect, final HttpContext context) { // If authority (host + effective port) differs, strip sensitive headers if (!isSameAuthority(currentTarget, newTarget)) { for (final Iterator
it = redirect.headerIterator(); it.hasNext(); ) { final Header header = it.next(); if (header.isSensitive() || header.getName().equalsIgnoreCase(HttpHeaders.AUTHORIZATION) || header.getName().equalsIgnoreCase(HttpHeaders.COOKIE)) { return false; } } } return true; } private boolean isSameAuthority(final HttpHost h1, final HttpHost h2) { if (h1 == null || h2 == null) { return false; } final String host1 = h1.getHostName(); final String host2 = h2.getHostName(); if (!host1.equalsIgnoreCase(host2)) { return false; } final int port1 = schemePortResolver.resolve(h1); final int port2 = schemePortResolver.resolve(h2); return port1 == port2; } @Override public boolean isRedirected( final HttpRequest request, final HttpResponse response, final HttpContext context) throws ProtocolException { Args.notNull(request, "HTTP request"); Args.notNull(response, "HTTP response"); if (!response.containsHeader(HttpHeaders.LOCATION)) { return false; } final int statusCode = response.getCode(); switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: case HttpStatus.SC_SEE_OTHER: case HttpStatus.SC_TEMPORARY_REDIRECT: case HttpStatus.SC_PERMANENT_REDIRECT: return true; default: return false; } } @Override public URI getLocationURI( final HttpRequest request, final HttpResponse response, final HttpContext context) throws HttpException { Args.notNull(request, "HTTP request"); Args.notNull(response, "HTTP response"); Args.notNull(context, "HTTP context"); //get the location header to find out where to redirect to final Header locationHeader = response.getFirstHeader(HttpHeaders.LOCATION); if (locationHeader == null) { throw new HttpException("Redirect location is missing"); } final String location = locationHeader.getValue(); URI uri = createLocationURI(location); try { if (!uri.isAbsolute()) { // Resolve location URI uri = URIUtils.resolve(request.getUri(), uri); } } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } return uri; } /** * @since 4.1 */ protected URI createLocationURI(final String location) throws ProtocolException { try { final URIBuilder b = new URIBuilder(new URI(location).normalize()); final String host = b.getHost(); if (host != null) { b.setHost(host.toLowerCase(Locale.ROOT)); } if (b.isPathEmpty()) { b.setPathSegments(""); } return b.build(); } catch (final URISyntaxException ex) { throw new ProtocolException("Invalid redirect URI: " + location, ex); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultSchemePortResolver.java0100644 0000000 0000000 00000004721 00000250600 030316 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; /** * Default {@link SchemePortResolver}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultSchemePortResolver implements SchemePortResolver { /** * Default instance of {@link DefaultSchemePortResolver}. */ public static final DefaultSchemePortResolver INSTANCE = new DefaultSchemePortResolver(); @Override public int resolve(final HttpHost host) { Args.notNull(host, "HTTP host"); return resolve(host.getSchemeName(), host); } @Override public int resolve(final String scheme, final NamedEndpoint endpoint) { Args.notNull(endpoint, "Endpoint"); final int port = endpoint.getPort(); if (port > 0) { return port; } if (URIScheme.HTTP.same(scheme)) { return 80; } else if (URIScheme.HTTPS.same(scheme)) { return 443; } else { return -1; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultUserTokenHandler.java0100644 0000000 0000000 00000010566 00000250600 027744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.security.Principal; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * Default implementation of {@link UserTokenHandler}. This class will use * an instance of {@link Principal} as a state object for HTTP connections, * if it can be obtained from the given execution context. This helps ensure * persistent connections created with a particular user identity within * a particular security context can be reused by the same user only. *

* DefaultUserTokenHandler will use the user principal of connection * based authentication schemes such as NTLM or that of the SSL session * with the client authentication turned on. If both are unavailable, * {@code null} token will be returned. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultUserTokenHandler implements UserTokenHandler { /** * Default instance of {@link DefaultUserTokenHandler}. */ public static final DefaultUserTokenHandler INSTANCE = new DefaultUserTokenHandler(); @Override public Object getUserToken(final HttpRoute route, final HttpContext context) { return getUserToken(route, null, context); } @Override public Object getUserToken(final HttpRoute route, final HttpRequest request, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); final HttpHost target = request != null ? new HttpHost(request.getScheme(), request.getAuthority()) : route.getTargetHost(); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); if (targetAuthExchange != null) { final Principal authPrincipal = getAuthPrincipal(targetAuthExchange); if (authPrincipal != null) { return authPrincipal; } } final HttpHost proxy = route.getProxyHost(); if (proxy != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(proxy); if (proxyAuthExchange != null) { final Principal authPrincipal = getAuthPrincipal(proxyAuthExchange); if (authPrincipal != null) { return authPrincipal; } } } final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { return sslSession.getLocalPrincipal(); } return null; } private static Principal getAuthPrincipal(final AuthExchange authExchange) { final AuthScheme scheme = authExchange.getAuthScheme(); if (scheme != null && scheme.isConnectionBased()) { return scheme.getPrincipal(); } return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ExecSupport.java0100644 0000000 0000000 00000003223 00000250600 025473 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; /** * Request execution support methods. * * @since 5.0 */ @Internal public final class ExecSupport { private static final PrefixedIncrementingId INCREMENTING_ID = new PrefixedIncrementingId("ex-"); public static long getNextExecNumber() { return INCREMENTING_ID.getNextNumber(); } public static String getNextExchangeId() { return INCREMENTING_ID.getNextId(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/IdleConnectionEvictor.java0100644 0000000 0000000 00000010343 00000250600 027444 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.ThreadFactory; import java.util.concurrent.TimeUnit; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * This class maintains a background thread to enforce an eviction policy for expired / idle * persistent connections kept alive in the connection pool. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class IdleConnectionEvictor { private static final TimeValue ONE_SECOND = TimeValue.ofSeconds(1L); private static final TimeValue ONE_MINUTE = TimeValue.ofMinutes(1L); private final ThreadFactory threadFactory; private final Thread thread; public IdleConnectionEvictor(final ConnPoolControl connectionManager, final ThreadFactory threadFactory, final TimeValue sleepTime, final TimeValue maxIdleTime) { Args.notNull(connectionManager, "Connection manager"); this.threadFactory = threadFactory != null ? threadFactory : new DefaultThreadFactory("idle-connection-evictor", true); final TimeValue localSleepTime = sleepTime != null ? sleepTime : calculateSleepTime(maxIdleTime); this.thread = this.threadFactory.newThread(() -> { try { while (!Thread.currentThread().isInterrupted()) { localSleepTime.sleep(); connectionManager.closeExpired(); if (maxIdleTime != null) { connectionManager.closeIdle(maxIdleTime); } } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); } catch (final Exception ignore) { } }); } public IdleConnectionEvictor(final ConnPoolControl connectionManager, final TimeValue sleepTime, final TimeValue maxIdleTime) { this(connectionManager, null, sleepTime, maxIdleTime); } public IdleConnectionEvictor(final ConnPoolControl connectionManager, final TimeValue maxIdleTime) { this(connectionManager, null, null, maxIdleTime); } public void start() { thread.start(); } public void shutdown() { thread.interrupt(); } public boolean isRunning() { return thread.isAlive(); } public void awaitTermination(final Timeout timeout) throws InterruptedException { thread.join(timeout != null ? timeout.toMilliseconds() : Long.MAX_VALUE); } static TimeValue calculateSleepTime(final TimeValue maxIdleTime) { if (maxIdleTime == null) { return ONE_MINUTE; } else { final TimeValue sleepTime = maxIdleTime.divide(10, TimeUnit.NANOSECONDS); return sleepTime.compareTo(ONE_SECOND) < 0 ? ONE_SECOND : sleepTime; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/InMemoryDnsResolver.java0100644 0000000 0000000 00000007243 00000250600 027146 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.Arrays; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * In-memory {@link DnsResolver} implementation. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class InMemoryDnsResolver implements DnsResolver { /** Logger associated to this class. */ private static final Logger LOG = LoggerFactory.getLogger(InMemoryDnsResolver.class); /** * In-memory collection that will hold the associations between a host name * and an array of InetAddress instances. */ private final Map dnsMap; /** * Builds a DNS resolver that will resolve the host names against a * collection held in-memory. */ public InMemoryDnsResolver() { dnsMap = new ConcurrentHashMap<>(); } /** * Associates the given array of IP addresses to the given host in this DNS overrider. * The IP addresses are assumed to be already resolved. * * @param host * The host name to be associated with the given IP. * @param ips * array of IP addresses to be resolved by this DNS overrider to the given * host name. */ public void add(final String host, final InetAddress... ips) { Args.notNull(host, "Host name"); Args.notNull(ips, "Array of IP addresses"); dnsMap.put(host, ips); } /** * {@inheritDoc} */ @Override public InetAddress[] resolve(final String host) throws UnknownHostException { final InetAddress[] resolvedAddresses = dnsMap.get(host); if (LOG.isInfoEnabled()) { LOG.info("Resolving {} to {}", host, Arrays.deepToString(resolvedAddresses)); } if (resolvedAddresses == null) { throw new UnknownHostException(host); } return resolvedAddresses; } @Override public String resolveCanonicalHostname(final String host) throws UnknownHostException { final InetAddress[] resolvedAddresses = resolve(host); if (resolvedAddresses.length > 0) { return resolvedAddresses[0].getCanonicalHostName(); } return host; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/LaxRedirectStrategy.java0100644 0000000 0000000 00000010412 00000250600 027141 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.classic.methods.HttpDelete; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpHead; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.protocol.HttpContext; /** * A lax implementation of the {@link RedirectStrategy} that automatically handles HTTP redirects * for HEAD, GET, POST, and DELETE requests based on the response status code. * *

This strategy relaxes the HTTP specification restrictions on automatic redirection of POST * requests, allowing redirects for these methods where the specification might otherwise prohibit * them. This can be useful in scenarios where a server indicates a redirect for a POST request * that the client should follow.

* *

This class is thread-safe and stateless, suitable for use across multiple threads * without additional synchronization.

* * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxRedirectStrategy extends DefaultRedirectStrategy { public static final LaxRedirectStrategy INSTANCE = new LaxRedirectStrategy(); private static final String[] REDIRECT_METHODS = new String[]{HttpGet.METHOD_NAME, HttpPost.METHOD_NAME, HttpHead.METHOD_NAME, HttpDelete.METHOD_NAME}; @Override public boolean isRedirected(final HttpRequest request, final HttpResponse response, final HttpContext context) { if (!response.containsHeader(HttpHeaders.LOCATION)) { return false; } final int statusCode = response.getCode(); final String method = request.getMethod(); final Header locationHeader = response.getFirstHeader("location"); switch (statusCode) { case HttpStatus.SC_MOVED_TEMPORARILY: return isRedirectable(method) && locationHeader != null; case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_TEMPORARY_REDIRECT: return isRedirectable(method); case HttpStatus.SC_SEE_OTHER: return true; default: return false; } } @Override public boolean isRedirectAllowed( final HttpHost currentTarget, final HttpHost newTarget, final HttpRequest redirect, final HttpContext context) { // Always allow, regardless of sensitive headers return true; } protected boolean isRedirectable(final String method) { for (final String m : REDIRECT_METHODS) { if (m.equalsIgnoreCase(method)) { return true; } } return false; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/MessageCopier.java0100644 0000000 0000000 00000002750 00000250600 025744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.HttpMessage; /** * Abstract HTTP message copier. * * @param The type of {@link HttpMessage}. * @since 5.0 * * @deprecated Use message builders. */ @Deprecated public interface MessageCopier { T copy(T object); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/NoopUserTokenHandler.java0100644 0000000 0000000 00000003712 00000250600 027266 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Noop implementation of {@link UserTokenHandler} that always returns {@code null}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NoopUserTokenHandler implements UserTokenHandler { /** * Default instance of {@link NoopUserTokenHandler}. */ public static final NoopUserTokenHandler INSTANCE = new NoopUserTokenHandler(); @Override public Object getUserToken(final HttpRoute route, final HttpContext context) { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/Operations.java0100644 0000000 0000000 00000007135 00000250600 025343 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import org.apache.hc.core5.concurrent.Cancellable; /** * Common cancellable operations. * * @since 5.0 */ public final class Operations { private final static Cancellable NOOP_CANCELLABLE = () -> false; /** * This class represents a {@link Future} in the completed state with a fixed result. * The outcome of the future cannot be altered and it cannot be cancelled. * * @param operation result representation. * * @deprecated Use {@link org.apache.hc.core5.concurrent.CompletedFuture}. */ @Deprecated public static class CompletedFuture implements Future { private final T result; public CompletedFuture(final T result) { this.result = result; } @Override public T get() throws InterruptedException, ExecutionException { return result; } @Override public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { return result; } @Override public boolean cancel(final boolean mayInterruptIfRunning) { return false; } @Override public boolean isCancelled() { return false; } @Override public boolean isDone() { return true; } } /** * Creates a {@link Cancellable} operation handle for an ongoing process * or operation that cannot be cancelled. Attempts to cancel the operation * with this handle will have no effect. * * @return the no-op cancellable operation handle. */ public static Cancellable nonCancellable() { return NOOP_CANCELLABLE; } /** * Creates a {@link Cancellable} operation handle for an ongoing process * or operation represented by a {@link Future}. * * @param future the result future * @return the cancellable operation handle. */ public static Cancellable cancellable(final Future future) { if (future == null) { return NOOP_CANCELLABLE; } if (future instanceof Cancellable) { return (Cancellable) future; } return () -> future.cancel(true); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/PrefixedIncrementingId.java0100644 0000000 0000000 00000007110 00000250600 027577 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.util.Args; /** * A thread safe incrementing identifier. * * @since 5.1.4 */ @Internal public final class PrefixedIncrementingId { private final AtomicLong count = new AtomicLong(0); private final String prefix0; private final String prefix1; private final String prefix2; private final String prefix3; private final String prefix4; private final String prefix5; private final String prefix6; private final String prefix7; private final String prefix8; private final String prefix9; /** * Creates an incrementing identifier. * @param prefix string prefix for generated IDs */ public PrefixedIncrementingId(final String prefix) { this.prefix0 = Args.notNull(prefix, "prefix"); this.prefix1 = prefix0 + '0'; this.prefix2 = prefix1 + '0'; this.prefix3 = prefix2 + '0'; this.prefix4 = prefix3 + '0'; this.prefix5 = prefix4 + '0'; this.prefix6 = prefix5 + '0'; this.prefix7 = prefix6 + '0'; this.prefix8 = prefix7 + '0'; this.prefix9 = prefix8 + '0'; } public long getNextNumber() { return count.incrementAndGet(); } public String getNextId() { return createId(count.incrementAndGet()); } /** * Create an ID from this instance's prefix and zero padded specified value. * * Hand rolled equivalent to `String.format("ex-%010d", value)` optimized to reduce * allocation and CPU overhead. */ String createId(final long value) { final String longString = Long.toString(value); switch (longString.length()) { case 1: return prefix9 + longString; case 2: return prefix8 + longString; case 3: return prefix7 + longString; case 4: return prefix6 + longString; case 5: return prefix5 + longString; case 6: return prefix4 + longString; case 7: return prefix3 + longString; case 8: return prefix2 + longString; case 9: return prefix1 + longString; default: return prefix0 + longString; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ProtocolSwitchStrategy.java0100644 0000000 0000000 00000014243 00000250600 027724 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpMessage; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.ProtocolVersionParser; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; /** * Protocol switch handler. * * @since 5.4 */ @Internal public final class ProtocolSwitchStrategy { private static final ProtocolVersionParser PROTOCOL_VERSION_PARSER = ProtocolVersionParser.INSTANCE; private static final Tokenizer TOKENIZER = Tokenizer.INSTANCE; private static final Tokenizer.Delimiter UPGRADE_TOKEN_DELIMITER = Tokenizer.delimiters(','); private static final Tokenizer.Delimiter LAX_PROTO_DELIMITER = Tokenizer.delimiters('/', ','); @FunctionalInterface private interface HeaderConsumer { void accept(CharSequence buffer, ParserCursor cursor) throws ProtocolException; } public ProtocolVersion switchProtocol(final HttpMessage response) throws ProtocolException { final AtomicReference tlsUpgrade = new AtomicReference<>(); parseHeaders(response, HttpHeaders.UPGRADE, (buffer, cursor) -> { final ProtocolVersion protocolVersion = parseProtocolVersion(buffer, cursor); if (protocolVersion != null) { if ("TLS".equalsIgnoreCase(protocolVersion.getProtocol())) { tlsUpgrade.set(protocolVersion); } else if (!protocolVersion.equals(HttpVersion.HTTP_1_1)) { throw new ProtocolException("Unsupported protocol or HTTP version: " + protocolVersion); } } }); final ProtocolVersion result = tlsUpgrade.get(); if (result != null) { return result; } else { throw new ProtocolException("Invalid protocol switch response: no TLS version found"); } } private ProtocolVersion parseProtocolVersion(final CharSequence buffer, final ParserCursor cursor) throws ProtocolException { TOKENIZER.skipWhiteSpace(buffer, cursor); final String proto = TOKENIZER.parseToken(buffer, cursor, LAX_PROTO_DELIMITER); if (!cursor.atEnd()) { final char ch = buffer.charAt(cursor.getPos()); if (ch == '/') { if (proto.isEmpty()) { throw new ParseException("Invalid protocol", buffer, cursor.getLowerBound(), cursor.getUpperBound(), cursor.getPos()); } cursor.updatePos(cursor.getPos() + 1); return PROTOCOL_VERSION_PARSER.parse(proto, null, buffer, cursor, UPGRADE_TOKEN_DELIMITER); } } if (proto.isEmpty()) { return null; } else if (proto.equalsIgnoreCase("TLS")) { return TLS.V_1_2.getVersion(); } else { throw new ProtocolException("Unsupported or invalid protocol: " + proto); } } private void parseHeaders(final HttpMessage message, final String name, final HeaderConsumer consumer) throws ProtocolException { final Iterator
it = message.headerIterator(name); while (it.hasNext()) { parseHeader(it.next(), consumer); } } private void parseHeader(final Header header, final HeaderConsumer consumer) throws ProtocolException { Args.notNull(header, "Header"); if (header instanceof FormattedHeader) { final CharArrayBuffer buf = ((FormattedHeader) header).getBuffer(); final ParserCursor cursor = new ParserCursor(0, buf.length()); cursor.updatePos(((FormattedHeader) header).getValuePos()); parseHeaderElements(buf, cursor, consumer); } else { final String value = header.getValue(); if (value == null) { return; } final ParserCursor cursor = new ParserCursor(0, value.length()); parseHeaderElements(value, cursor, consumer); } } private void parseHeaderElements(final CharSequence buffer, final ParserCursor cursor, final HeaderConsumer consumer) throws ProtocolException { while (!cursor.atEnd()) { consumer.accept(buffer, cursor); if (!cursor.atEnd()) { final char ch = buffer.charAt(cursor.getPos()); if (ch == ',') { cursor.updatePos(cursor.getPos() + 1); } } } } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/RequestCopier.java0100644 0000000 0000000 00000004416 00000250600 026011 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BasicHttpRequest; /** * {@link HttpRequest} copier. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.support.BasicRequestBuilder} */ @Deprecated public final class RequestCopier implements MessageCopier { /** * Default instance of {@link RequestCopier}. */ public static final RequestCopier INSTANCE = new RequestCopier(); @Override public HttpRequest copy(final HttpRequest original) { if (original == null) { return null; } final BasicHttpRequest copy = new BasicHttpRequest(original.getMethod(), null, original.getPath()); copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); copy.setVersion(original.getVersion()); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } return copy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/RequestSupport.java0100644 0000000 0000000 00000005112 00000250600 026236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.URISyntaxException; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.net.URIBuilder; /** * Protocol support methods. For internal use only. * * @since 5.2 */ @Internal public final class RequestSupport { public static String extractPathPrefix(final HttpRequest request) { final String path = request.getPath(); try { final URIBuilder uriBuilder = new URIBuilder(path); uriBuilder.setFragment(null); uriBuilder.clearParameters(); uriBuilder.optimize(); final List pathSegments = uriBuilder.getPathSegments(); if (!pathSegments.isEmpty()) { pathSegments.remove(pathSegments.size() - 1); } if (pathSegments.isEmpty()) { return "/"; } final StringBuilder buf = new StringBuilder(); buf.append('/'); for (final String pathSegment : pathSegments) { PercentCodec.encode(buf, pathSegment, StandardCharsets.US_ASCII); buf.append('/'); } return buf.toString(); } catch (final URISyntaxException ex) { return path; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ScramException.java0100644 0000000 0000000 00000005602 00000250600 026141 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.auth.AuthenticationException; /** * Represents an exception that occurs during SCRAM (Salted Challenge Response Authentication Mechanism) authentication. *

* SCRAM is a family of SASL mechanisms used for secure authentication. This exception is thrown when * an error or issue is encountered during the SCRAM authentication process. *

* * @since 5.6 */ public class ScramException extends AuthenticationException { private static final long serialVersionUID = 2491660491058647342L; /** * Constructs a new {@code ScramException} with {@code null} as its detail message. * The cause is not initialized and may be subsequently initialized by a call to {@link #initCause}. */ public ScramException() { super(); } /** * Constructs a new {@code ScramException} with the specified detail message. * The cause is not initialized and may be subsequently initialized by a call to {@link #initCause}. * * @param message the detail message, saved for later retrieval by the {@link #getMessage()} method. */ public ScramException(final String message) { super(message); } /** * Constructs a new {@code ScramException} with the specified detail message and cause. * * @param message the detail message, saved for later retrieval by the {@link #getMessage()} method. * @param cause the cause, saved for later retrieval by the {@link #getCause()} method. * A {@code null} value indicates that the cause is nonexistent or unknown. */ public ScramException(final String message, final Throwable cause) { super(message, cause); } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/StateHolder.java0100644 0000000 0000000 00000002643 00000250600 025435 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; /** * @param The type of object to store and restore. * @since 5.4 */ @Internal public interface StateHolder { T store(); void restore(T state); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/TunnelRefusedException.java0100644 0000000 0000000 00000004712 00000250600 027660 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.message.StatusLine; import org.conscrypt.Internal; /** * Signals that the tunnel request was rejected by the proxy host. * * @since 4.0 * * @deprecated Do not use/ */ @Deprecated public class TunnelRefusedException extends HttpException { private static final long serialVersionUID = -8646722842745617323L; private final HttpResponse response; /** * @deprecated Do not use. */ @Deprecated public TunnelRefusedException(final String message, final String responseMessage) { super(message); this.response = new BasicHttpResponse(500); } @Internal public TunnelRefusedException(final HttpResponse response) { super("CONNECT refused by proxy: " + new StatusLine(response)); this.response = response; } /** * @deprecated Use {@link #getResponse()}. */ @Deprecated public String getResponseMessage() { return "CONNECT refused by proxy: " + new StatusLine(response); } /** * @since 5.4 */ public HttpResponse getResponse() { return response; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/Wire.java0100644 0000000 0000000 00000012731 00000250600 024124 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.nio.ByteBuffer; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; @Internal public class Wire { private static final int MAX_STRING_BUILDER_SIZE = 2048; private static final ThreadLocal THREAD_LOCAL = new ThreadLocal<>(); /** * Returns a {@code StringBuilder} that this Layout implementation can use to write the formatted log event to. * * @return a {@code StringBuilder} */ private static StringBuilder getStringBuilder() { StringBuilder result = THREAD_LOCAL.get(); if (result == null) { result = new StringBuilder(MAX_STRING_BUILDER_SIZE); THREAD_LOCAL.set(result); } trimToMaxSize(result, MAX_STRING_BUILDER_SIZE); result.setLength(0); return result; } /** * Ensures that the char[] array of the specified StringBuilder does not exceed the specified number of characters. * This method is useful to ensure that excessively long char[] arrays are not kept in memory forever. * * @param stringBuilder the StringBuilder to check * @param maxSize the maximum number of characters the StringBuilder is allowed to have */ private static void trimToMaxSize(final StringBuilder stringBuilder, final int maxSize) { if (stringBuilder != null && stringBuilder.capacity() > maxSize) { stringBuilder.setLength(maxSize); stringBuilder.trimToSize(); } } private final Logger log; private final String id; public Wire(final Logger log, final String id) { super(); this.log = log; this.id = id; } private void wire(final String header, final byte[] b, final int pos, final int off) { final StringBuilder buffer = getStringBuilder(); for (int i = 0; i < off; i++) { final int ch = b[pos + i]; if (ch == 13) { buffer.append("[\\r]"); } else if (ch == 10) { buffer.append("[\\n]\""); buffer.insert(0, "\""); buffer.insert(0, header); log.debug("{} {}", this.id, buffer); buffer.setLength(0); } else if (ch < 32 || ch >= 127) { buffer.append("[0x"); buffer.append(Integer.toHexString(ch)); buffer.append("]"); } else { buffer.append((char) ch); } } if (buffer.length() > 0) { buffer.append('\"'); buffer.insert(0, '\"'); buffer.insert(0, header); log.debug("{} {}", this.id, buffer); } } public boolean isEnabled() { return log.isDebugEnabled(); } public void output(final byte[] b, final int pos, final int off) { Args.notNull(b, "Output"); wire(">> ", b, pos, off); } public void input(final byte[] b, final int pos, final int off) { Args.notNull(b, "Input"); wire("<< ", b, pos, off); } public void output(final byte[] b) { Args.notNull(b, "Output"); output(b, 0, b.length); } public void input(final byte[] b) { Args.notNull(b, "Input"); input(b, 0, b.length); } public void output(final int b) { output(new byte[] {(byte) b}); } public void input(final int b) { input(new byte[] {(byte) b}); } public void output(final String s) { Args.notNull(s, "Output"); output(s.getBytes()); } public void input(final String s) { Args.notNull(s, "Input"); input(s.getBytes()); } public void output(final ByteBuffer b) { Args.notNull(b, "Output"); if (b.hasArray()) { output(b.array(), b.arrayOffset() + b.position(), b.remaining()); } else { final byte[] tmp = new byte[b.remaining()]; b.get(tmp); output(tmp); } } public void input(final ByteBuffer b) { Args.notNull(b, "Input"); if (b.hasArray()) { input(b.array(), b.arrayOffset() + b.position(), b.remaining()); } else { final byte[] tmp = new byte[b.remaining()]; b.get(tmp); input(tmp); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ZstdRuntime.java0100644 0000000 0000000 00000004666 00000250600 025516 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Utility to detect availability of the Zstandard JNI runtime on the classpath. *

* Used by the async client implementation to conditionally register * zstd encoders/decoders without creating a hard dependency on {@code zstd-jni}. *

* *

This class performs a lightweight reflective check and intentionally avoids * linking to JNI classes at compile time to prevent {@link LinkageError}s when * the optional dependency is absent.

* * @since 5.6 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public final class ZstdRuntime { private static final String ZSTD = "com.github.luben.zstd.Zstd"; private ZstdRuntime() { } /** * @return {@code true} if {@code com.github.luben.zstd.Zstd} can be loaded * by the current class loader; {@code false} otherwise */ public static boolean available() { try { Class.forName(ZSTD, false, ZstdRuntime.class.getClassLoader()); return true; } catch (ClassNotFoundException | LinkageError ex) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/0040755 0000000 0000000 00000000000 00000250600 023467 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractHttpAsyncClientBase.java0100644 0000000 0000000 00000012633 00000250600 031667 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.net.SocketAddress; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; abstract class AbstractHttpAsyncClientBase extends CloseableHttpAsyncClient implements ConnectionInitiator { enum Status { READY, RUNNING, TERMINATED } private static final Logger LOG = LoggerFactory.getLogger(AbstractHttpAsyncClientBase.class); private final AsyncPushConsumerRegistry pushConsumerRegistry; private final DefaultConnectingIOReactor ioReactor; private final ExecutorService executorService; private final AtomicReference status; AbstractHttpAsyncClientBase( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory) { super(); this.ioReactor = ioReactor; this.pushConsumerRegistry = pushConsumerRegistry; this.executorService = Executors.newSingleThreadExecutor(threadFactory); this.status = new AtomicReference<>(Status.READY); } @Override public final void start() { if (status.compareAndSet(Status.READY, Status.RUNNING)) { executorService.execute(ioReactor::start); } } /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated @Override public void register(final String hostname, final String uriPattern, final Supplier supplier) { pushConsumerRegistry.register(hostname, uriPattern, supplier); } boolean isRunning() { return status.get() == Status.RUNNING; } @Override public Future connect( final NamedEndpoint remoteEndpoint, final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout timeout, final Object attachment, final FutureCallback callback) { return ioReactor.connect(remoteEndpoint, remoteAddress, localAddress, timeout, attachment, callback); } ConnectionInitiator getConnectionInitiator() { return ioReactor; } @Override public final IOReactorStatus getStatus() { return ioReactor.getStatus(); } @Override public final void awaitShutdown(final TimeValue waitTime) throws InterruptedException { ioReactor.awaitShutdown(waitTime); } @Override public final void initiateShutdown() { if (LOG.isDebugEnabled()) { LOG.debug("Initiating shutdown"); } ioReactor.initiateShutdown(); } void internalClose(final CloseMode closeMode) { } @Override public final void close(final CloseMode closeMode) { if (LOG.isDebugEnabled()) { LOG.debug("Shutdown {}", closeMode); } ioReactor.initiateShutdown(); ioReactor.close(closeMode); if (closeMode == CloseMode.GRACEFUL) { executorService.shutdown(); try { if (!executorService.awaitTermination(1, TimeUnit.SECONDS)) { executorService.shutdownNow(); } } catch (final InterruptedException ignore) { Thread.currentThread().interrupt(); } } else { executorService.shutdownNow(); } internalClose(closeMode); } @Override public void close() { close(CloseMode.GRACEFUL); } } ././@LongLink0100644 0000000 0000000 00000000150 00000250600 011605 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractMinimalHttpAsyncClientBase.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractMinimalHttpAsyncClientBase.j0100644 0000000 0000000 00000007434 00000250600 032511 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; abstract class AbstractMinimalHttpAsyncClientBase extends AbstractHttpAsyncClientBase { AbstractMinimalHttpAsyncClientBase( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory) { super(ioReactor, pushConsumerRegistry, threadFactory); } @Override protected Future doExecute( final HttpHost httpHost, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final ComplexFuture future = new ComplexFuture<>(callback); future.setDependency(execute(new BasicClientExchangeHandler<>( requestProducer, responseConsumer, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }), pushHandlerFactory, context)); return future; } public final Cancellable execute(final AsyncClientExchangeHandler exchangeHandler) { return execute(exchangeHandler, null, null); } public abstract Cancellable execute( AsyncClientExchangeHandler exchangeHandler, HandlerFactory pushHandlerFactory, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncConnectExec.java0100644 0000000 0000000 00000060300 00000250600 027522 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteTracker; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.routing.BasicRouteDirector; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * that is responsible for establishing connection to the target * origin server as specified by the current connection route. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncConnectExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncConnectExec.class); private final HttpProcessor proxyHttpProcessor; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthCacheKeeper authCacheKeeper; private final HttpRouteDirector routeDirector; public AsyncConnectExec( final HttpProcessor proxyHttpProcessor, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { Args.notNull(proxyHttpProcessor, "Proxy HTTP processor"); Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.proxyHttpProcessor = proxyHttpProcessor; this.proxyAuthStrategy = proxyAuthStrategy; this.authenticator = new AuthenticationHandler(); this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(schemePortResolver); this.routeDirector = BasicRouteDirector.INSTANCE; } static class State { State(final HttpRoute route) { tracker = new RouteTracker(route); } final RouteTracker tracker; volatile boolean challenged; volatile HttpResponse response; volatile boolean tunnelRefused; } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency cancellableDependency = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final State state = new State(route); if (!execRuntime.isEndpointAcquired()) { final Object userToken = clientContext.getUserToken(); if (LOG.isDebugEnabled()) { LOG.debug("{} acquiring connection with route {}", exchangeId, route); } cancellableDependency.setDependency(execRuntime.acquireEndpoint( exchangeId, route, userToken, clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { if (execRuntime.isEndpointConnected()) { try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } else { proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } else { if (execRuntime.isEndpointConnected()) { proceedConnected(request, entityProducer, scope, chain, asyncExecCallback); } else { proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } } private void proceedToNextHop( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { try { doProceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } catch (final RuntimeException ex) { asyncExecCallback.failed(ex); } } private void doProceedToNextHop( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final RouteTracker tracker = state.tracker; final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final AsyncExecRuntime execRuntime = scope.execRuntime; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final HttpRoute fact = tracker.toRoute(); final int step = routeDirector.nextStep(route, fact); switch (step) { case HttpRouteDirector.CONNECT_TARGET: operation.setDependency(execRuntime.connectEndpoint(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { tracker.connectTarget(route.isSecure()); if (LOG.isDebugEnabled()) { LOG.debug("{} connected to target", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); break; case HttpRouteDirector.CONNECT_PROXY: operation.setDependency(execRuntime.connectEndpoint(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { final HttpHost proxy = route.getProxyHost(); tracker.connectProxy(proxy, route.isSecure() && !route.isTunnelled()); if (LOG.isDebugEnabled()) { LOG.debug("{} connected to proxy", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); break; case HttpRouteDirector.TUNNEL_TARGET: final HttpHost proxy = route.getProxyHost(); final HttpHost target = route.getTargetHost(); if (LOG.isDebugEnabled()) { LOG.debug("{} create tunnel", exchangeId); } createTunnel(state, proxy, target, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse(final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (!execRuntime.isEndpointConnected()) { // Remote endpoint disconnected. Need to start over if (LOG.isDebugEnabled()) { LOG.debug("{} proxy disconnected", exchangeId); } state.tracker.reset(); } if (state.challenged) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy authentication required", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } else { if (state.tunnelRefused) { if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel refused", exchangeId); } asyncExecCallback.completed(); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel to target created", exchangeId); } tracker.tunnelTarget(false); proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } } @Override public void failed(final Exception cause) { execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } }); break; case HttpRouteDirector.TUNNEL_PROXY: // The most simple example for this case is a proxy chain // of two proxies, where P1 must be tunnelled to P2. // route: Source -> P1 -> P2 -> Target (3 hops) // fact: Source -> P1 -> Target (2 hops) asyncExecCallback.failed(new HttpException("Proxy chains are not supported")); break; case HttpRouteDirector.LAYER_PROTOCOL: execRuntime.upgradeTls(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime asyncExecRuntime) { if (LOG.isDebugEnabled()) { LOG.debug("{} upgraded to TLS", exchangeId); } tracker.layerProtocol(route.isSecure()); proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } }); break; case HttpRouteDirector.UNREACHABLE: asyncExecCallback.failed(new HttpException("Unable to establish route: " + "planned = " + route + "; current = " + fact)); break; case HttpRouteDirector.COMPLETE: if (LOG.isDebugEnabled()) { LOG.debug("{} route fully established", exchangeId); } proceedConnected(request, entityProducer, scope, chain, asyncExecCallback); break; default: throw new IllegalStateException("Unknown step indicator " + step + " from RouteDirector."); } } private void createTunnel( final State state, final HttpHost proxy, final HttpHost nextHop, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) { final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final String exchangeId = scope.exchangeId; final AuthExchange proxyAuthExchange = proxy != null ? clientContext.getAuthExchange(proxy) : new AuthExchange(); if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, clientContext); } final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } asyncExecCallback.failed(cause); } @Override public void cancel() { failed(new InterruptedIOException()); } @Override public void produceRequest(final RequestChannel requestChannel, final HttpContext httpContext) throws HttpException, IOException { final HttpRequest connect = new BasicHttpRequest(Method.CONNECT, nextHop, nextHop.toHostString()); connect.setVersion(HttpVersion.HTTP_1_1); proxyHttpProcessor.process(connect, null, clientContext); authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, proxyAuthExchange, clientContext); requestChannel.sendRequest(connect, null, clientContext); } @Override public void produce(final DataStreamChannel dataStreamChannel) throws IOException { } @Override public int available() { return 0; } @Override public void consumeInformation(final HttpResponse httpResponse, final HttpContext httpContext) throws HttpException, IOException { } @Override public void consumeResponse(final HttpResponse response, final EntityDetails entityDetails, final HttpContext httpContext) throws HttpException, IOException { clientContext.setResponse(response); proxyHttpProcessor.process(response, entityDetails, clientContext); final int status = response.getCode(); if (status < HttpStatus.SC_SUCCESS) { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } if (needAuthentication(proxyAuthExchange, proxy, response, clientContext)) { state.challenged = true; } else { state.challenged = false; if (status >= HttpStatus.SC_REDIRECTION) { state.tunnelRefused = true; entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); } else if (status == HttpStatus.SC_OK) { clientContext.setProtocolVersion(null); asyncExecCallback.completed(); } else { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } asyncExecCallback.completed(); } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } private boolean needAuthentication( final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean proxyAuthRequested = authenticator.isChallenged(proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } return updated; } } return false; } private void proceedConnected( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final AsyncExecRuntime execRuntime = scope.execRuntime; final HttpClientContext clientContext = scope.clientContext; final EndpointInfo endpointInfo = execRuntime.getEndpointInfo(); if (endpointInfo != null) { clientContext.setSSLSession(endpointInfo.getSslSession()); } try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncExecChainElement.java0100644 0000000 0000000 00000004661 00000250600 030475 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; class AsyncExecChainElement { private final AsyncExecChainHandler handler; private final AsyncExecChainElement next; AsyncExecChainElement(final AsyncExecChainHandler handler, final AsyncExecChainElement next) { this.handler = handler; this.next = next; } public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { handler.execute(request, entityProducer, scope, next != null ? next::execute : null, asyncExecCallback); } @Override public String toString() { return "{" + "handler=" + handler.getClass() + ", next=" + (next != null ? next.handler.getClass() : "null") + '}'; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncHttpRequestRetryExec.java0100644 0000000 0000000 00000023555 00000250600 031462 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.DiscardingEntityConsumer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request executor in the asynchronous request execution chain that is * responsible for making a decision whether a request that failed due to * an I/O exception or received a specific response from the target server should * be re-executed. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

*

* If this handler is active, pay particular attention to the placement * of other handlers within the handler chain relative to the retry handler. * Use {@link ChainElement#RETRY} as name when referring to this handler. *

*

* If a custom handler is placed before the retry handler, the handler will * see the initial request and the final outcome after the last retry. Elapsed time * will account for any delays imposed by the retry handler. *

* *

* A custom handler which is placed after the retry handler will be invoked for * each individual retry. Elapsed time will measure each individual http request, * without the delay imposed by the retry handler. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncHttpRequestRetryExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncHttpRequestRetryExec.class); private final HttpRequestRetryStrategy retryStrategy; public AsyncHttpRequestRetryExec(final HttpRequestRetryStrategy retryStrategy) { Args.notNull(retryStrategy, "retryStrategy"); this.retryStrategy = retryStrategy; } private static class State { volatile boolean retrying; volatile int status; volatile TimeValue delay; } private void internalExecute( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; chain.proceed(BasicRequestBuilder.copy(request).build(), entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { final HttpClientContext clientContext = scope.clientContext; if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } return asyncExecCallback.handleResponse(response, entityDetails); } state.retrying = retryStrategy.retryRequest(response, scope.execCount.get(), clientContext); if (state.retrying) { state.status = response.getCode(); state.delay = retryStrategy.getRetryInterval(response, scope.execCount.get(), clientContext); return new DiscardingEntityConsumer<>(); } return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (state.retrying) { final int execCount = scope.execCount.incrementAndGet(); if (entityProducer != null) { entityProducer.releaseResources(); } final HttpHost target = scope.route.getTargetHost(); final TimeValue delay = TimeValue.isPositive(state.delay) ? state.delay : TimeValue.ZERO_MILLISECONDS; if (LOG.isInfoEnabled()) { LOG.info("{} {} responded with status {}; " + "request will be automatically re-executed in {} (exec count {})", exchangeId, target, state.status, delay, execCount); } scope.scheduler.scheduleExecution( request, entityProducer, scope, (r, e, s, c) -> execute(r, e, s, chain, c), asyncExecCallback, delay); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { if (cause instanceof IOException) { final HttpHost target = scope.route.getTargetHost(); final HttpClientContext clientContext = scope.clientContext; if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } } else if (retryStrategy.retryRequest(request, (IOException) cause, scope.execCount.get(), clientContext)) { if (LOG.isDebugEnabled()) { LOG.debug("{} {}", exchangeId, cause.getMessage(), cause); } scope.execRuntime.discardEndpoint(); if (entityProducer != null) { entityProducer.releaseResources(); } state.retrying = true; final int execCount = scope.execCount.incrementAndGet(); state.delay = retryStrategy.getRetryInterval(request, (IOException) cause, execCount - 1, clientContext); final TimeValue delay = TimeValue.isPositive(state.delay) ? state.delay : TimeValue.ZERO_MILLISECONDS; if (LOG.isInfoEnabled()) { LOG.info("{} recoverable I/O exception ({}) caught when sending request to {};" + "request will be automatically re-executed in {} (exec count {})", exchangeId, cause.getClass().getName(), target, delay, execCount); } scope.scheduler.scheduleExecution( request, entityProducer, scope, (r, e, s, c) -> execute(r, e, s, chain, c), asyncExecCallback, delay); return; } } asyncExecCallback.failed(cause); } }); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final State state = new State(); state.retrying = false; internalExecute(state, request, entityProducer, scope, chain, asyncExecCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncProtocolExec.java0100644 0000000 0000000 00000040365 00000250600 027743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.Iterator; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * that is responsible for implementation of HTTP specification requirements. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncProtocolExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncProtocolExec.class); private final AuthenticationStrategy targetAuthStrategy; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final SchemePortResolver schemePortResolver; private final AuthCacheKeeper authCacheKeeper; AsyncProtocolExec( final AuthenticationStrategy targetAuthStrategy, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { this.targetAuthStrategy = Args.notNull(targetAuthStrategy, "Target authentication strategy"); this.proxyAuthStrategy = Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.authenticator = new AuthenticationHandler(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(this.schemePortResolver); } @Override public void execute( final HttpRequest userRequest, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { if (Method.CONNECT.isSame(userRequest.getMethod())) { throw new ProtocolException("Direct execution of CONNECT is not allowed"); } final HttpRoute route = scope.route; final HttpHost routeTarget = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); final HttpClientContext clientContext = scope.clientContext; final HttpRequest request; if (proxy != null && !route.isTunnelled()) { final BasicRequestBuilder requestBuilder = BasicRequestBuilder.copy(userRequest); if (requestBuilder.getAuthority() == null) { requestBuilder.setAuthority(new URIAuthority(routeTarget)); } requestBuilder.setAbsoluteRequestUri(true); request = requestBuilder.build(); } else { request = userRequest; } // Ensure the request has a scheme and an authority if (request.getScheme() == null) { request.setScheme(routeTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(routeTarget)); } final URIAuthority authority = request.getAuthority(); if (authority.getUserInfo() != null) { throw new ProtocolException("Request URI authority contains deprecated userinfo component"); } final HttpHost target = new HttpHost( request.getScheme(), authority.getHostName(), schemePortResolver.resolve(request.getScheme(), authority)); final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); final AuthExchange proxyAuthExchange = proxy != null ? clientContext.getAuthExchange(proxy) : new AuthExchange(); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() != null && !pathPrefix.startsWith(targetAuthExchange.getPathPrefix())) { // force re-authentication if the current path prefix does not match // that of the previous authentication exchange. targetAuthExchange.reset(); } if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(target, pathPrefix, targetAuthExchange, clientContext); if (proxy != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, clientContext); } } final AtomicBoolean challenged = new AtomicBoolean(false); internalExecute(target, pathPrefix, targetAuthExchange, proxyAuthExchange, challenged, request, entityProducer, scope, chain, asyncExecCallback); } private void internalExecute( final HttpHost target, final String pathPrefix, final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final AtomicBoolean challenged, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final HttpHost proxy = route.getProxyHost(); if (!request.containsHeader(HttpHeaders.AUTHORIZATION)) { if (LOG.isDebugEnabled()) { LOG.debug("{} target auth state: {}", exchangeId, targetAuthExchange.getState()); } authenticator.addAuthResponse(target, ChallengeType.TARGET, request, targetAuthExchange, clientContext); } if (!request.containsHeader(HttpHeaders.PROXY_AUTHORIZATION) && !route.isTunnelled()) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy auth state: {}", exchangeId, proxyAuthExchange.getState()); } authenticator.addAuthResponse(proxy, ChallengeType.PROXY, request, proxyAuthExchange, clientContext); } chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { if (Method.TRACE.isSame(request.getMethod())) { // Do not perform authentication for TRACE request return asyncExecCallback.handleResponse(response, entityDetails); } if (needAuthentication( targetAuthExchange, proxyAuthExchange, proxy != null ? proxy : target, target, pathPrefix, response, clientContext)) { challenged.set(true); return null; } challenged.set(false); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (!execRuntime.isEndpointConnected()) { if (proxyAuthExchange.getState() == AuthExchange.State.SUCCESS && proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } if (targetAuthExchange.getState() == AuthExchange.State.SUCCESS && targetAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); } } if (challenged.get()) { if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } asyncExecCallback.completed(); } else { // Reset request headers final HttpRequest original = scope.originalRequest; request.setHeaders(); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { request.addHeader(it.next()); } try { if (entityProducer != null) { entityProducer.releaseResources(); } internalExecute(target, pathPrefix, targetAuthExchange, proxyAuthExchange, challenged, request, entityProducer, scope, chain, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { if (cause instanceof IOException || cause instanceof RuntimeException) { for (final AuthExchange authExchange : clientContext.getAuthExchanges().values()) { if (authExchange.isConnectionBased()) { authExchange.reset(); } } } asyncExecCallback.failed(cause); } }); } private boolean needAuthentication( final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpHost target, final String pathPrefix, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean targetAuthRequested = authenticator.isChallenged( target, ChallengeType.TARGET, response, targetAuthExchange, context); final boolean targetMutualAuthRequired = authenticator.isChallengeExpected(targetAuthExchange); if (authCacheKeeper != null) { if (targetAuthRequested) { authCacheKeeper.updateOnChallenge(target, pathPrefix, targetAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(target, pathPrefix, targetAuthExchange, context); } } final boolean proxyAuthRequested = authenticator.isChallenged( proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } boolean targetNeedsAuth = false; boolean proxyNeedsAuth = false; if (targetAuthRequested || targetMutualAuthRequired) { targetNeedsAuth = authenticator.handleResponse(target, ChallengeType.TARGET, response, targetAuthStrategy, targetAuthExchange, context); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() == null) { targetAuthExchange.setPathPrefix(pathPrefix); } if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(target, pathPrefix, targetAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { proxyNeedsAuth = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } } return targetNeedsAuth || proxyNeedsAuth; } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncPushConsumerRegistry.java0100644 0000000 0000000 00000010242 00000250600 031510 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.Locale; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; @SuppressWarnings("deprecation") class AsyncPushConsumerRegistry { private final org.apache.hc.core5.http.protocol.UriPatternMatcher> primary; private final ConcurrentMap>> hostMap; public AsyncPushConsumerRegistry() { this.primary = new org.apache.hc.core5.http.protocol.UriPatternMatcher<>(); this.hostMap = new ConcurrentHashMap<>(); } private org.apache.hc.core5.http.protocol.UriPatternMatcher> getPatternMatcher(final String hostname) { if (hostname == null) { return primary; } final org.apache.hc.core5.http.protocol.UriPatternMatcher> hostMatcher = hostMap.get(hostname); if (hostMatcher != null) { return hostMatcher; } return primary; } public AsyncPushConsumer get(final HttpRequest request) { Args.notNull(request, "Request"); final URIAuthority authority = request.getAuthority(); final String key = authority != null ? authority.getHostName().toLowerCase(Locale.ROOT) : null; final org.apache.hc.core5.http.protocol.UriPatternMatcher> patternMatcher = getPatternMatcher(key); if (patternMatcher == null) { return null; } String path = request.getPath(); final int i = path.indexOf('?'); if (i != -1) { path = path.substring(0, i); } final Supplier supplier = patternMatcher.lookup(path); return supplier != null ? supplier.get() : null; } public void register(final String hostname, final String uriPattern, final Supplier supplier) { Args.notBlank(uriPattern, "URI pattern"); Args.notNull(supplier, "Supplier"); if (hostname == null) { primary.register(uriPattern, supplier); } else { final String key = hostname.toLowerCase(Locale.ROOT); org.apache.hc.core5.http.protocol.UriPatternMatcher> matcher = hostMap.get(key); if (matcher == null) { final org.apache.hc.core5.http.protocol.UriPatternMatcher> newMatcher = new org.apache.hc.core5.http.protocol.UriPatternMatcher<>(); matcher = hostMap.putIfAbsent(key, newMatcher); if (matcher == null) { matcher = newMatcher; } } matcher.register(uriPattern, supplier); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncRedirectExec.java0100644 0000000 0000000 00000032462 00000250600 027702 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.net.URI; import java.util.Objects; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * responsible for handling of request redirects. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncRedirectExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncRedirectExec.class); private final HttpRoutePlanner routePlanner; private final RedirectStrategy redirectStrategy; AsyncRedirectExec(final HttpRoutePlanner routePlanner, final RedirectStrategy redirectStrategy) { this.routePlanner = routePlanner; this.redirectStrategy = redirectStrategy; } private static class State { volatile URI redirectURI; volatile int maxRedirects; volatile int redirectCount; volatile HttpRequest currentRequest; volatile AsyncEntityProducer currentEntityProducer; volatile RedirectLocations redirectLocations; volatile AsyncExecChain.Scope currentScope; volatile boolean reroute; } private void internalExecute( final State state, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final HttpRequest request = state.currentRequest; final AsyncEntityProducer entityProducer = state.currentEntityProducer; final AsyncExecChain.Scope scope = state.currentScope; final HttpClientContext clientContext = scope.clientContext; final String exchangeId = scope.exchangeId; chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { state.redirectURI = null; final RequestConfig config = clientContext.getRequestConfigOrDefault(); if (config.isRedirectsEnabled() && redirectStrategy.isRedirected(request, response, clientContext)) { if (state.redirectCount >= state.maxRedirects) { throw new RedirectException("Maximum redirects (" + state.maxRedirects + ") exceeded"); } state.redirectCount++; final URI redirectUri = redirectStrategy.getLocationURI(request, response, clientContext); if (LOG.isDebugEnabled()) { LOG.debug("{} redirect requested to location '{}'", exchangeId, redirectUri); } if (!config.isCircularRedirectsAllowed()) { if (state.redirectLocations.contains(redirectUri)) { throw new CircularRedirectException("Circular redirect to '" + redirectUri + "'"); } } final AsyncExecChain.Scope currentScope = state.currentScope; final HttpHost newTarget = URIUtils.extractHost(redirectUri); if (newTarget == null) { throw new ProtocolException("Redirect URI does not specify a valid host name: " + redirectUri); } final int statusCode = response.getCode(); final BasicRequestBuilder redirectBuilder; switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: if (Method.POST.isSame(request.getMethod())) { redirectBuilder = BasicRequestBuilder.get(); state.currentEntityProducer = null; } else { redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } break; case HttpStatus.SC_SEE_OTHER: if (!Method.GET.isSame(request.getMethod()) && !Method.HEAD.isSame(request.getMethod())) { redirectBuilder = BasicRequestBuilder.get(); state.currentEntityProducer = null; } else { redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } break; default: redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } redirectBuilder.setUri(redirectUri); final BasicHttpRequest redirect = redirectBuilder.build(); final HttpRoute currentRoute = currentScope.route; final HttpHost currentHost = currentRoute.getTargetHost(); if (!redirectStrategy.isRedirectAllowed(currentHost, newTarget, redirect, clientContext)) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect due to safety restrictions", exchangeId); } return asyncExecCallback.handleResponse(response, entityDetails); } state.redirectLocations.add(redirectUri); state.reroute = false; state.redirectURI = redirectUri; state.currentRequest = redirect; final HttpRoute newRoute; if (!Objects.equals(currentHost, newTarget)) { newRoute = routePlanner.determineRoute(newTarget, clientContext); if (!Objects.equals(currentRoute, newRoute)) { state.reroute = true; final AuthExchange targetAuthExchange = clientContext.getAuthExchange(currentHost); if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); if (currentRoute.getProxyHost() != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(currentRoute.getProxyHost()); if (proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } } } } else { newRoute = currentRoute; } state.currentScope = new AsyncExecChain.Scope( scope.exchangeId, newRoute, BasicRequestBuilder.copy(redirect).build(), scope.cancellableDependency, scope.clientContext, scope.execRuntime, scope.scheduler, scope.execCount); if (LOG.isDebugEnabled()) { LOG.debug("{} redirecting to '{}' via {}", exchangeId, redirectUri, newRoute); } return null; } return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (state.redirectURI == null) { asyncExecCallback.completed(); } else { final AsyncEntityProducer entityProducer = state.currentEntityProducer; if (entityProducer != null) { entityProducer.releaseResources(); } if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect non-repeatable request", exchangeId); } asyncExecCallback.completed(); } else { try { if (state.reroute) { scope.execRuntime.releaseEndpoint(); } internalExecute(state, chain, asyncExecCallback); } catch (final IOException | HttpException ex) { asyncExecCallback.failed(ex); } } } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } }); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final HttpClientContext clientContext = scope.clientContext; RedirectLocations redirectLocations = clientContext.getRedirectLocations(); if (redirectLocations == null) { redirectLocations = new RedirectLocations(); clientContext.setRedirectLocations(redirectLocations); } redirectLocations.clear(); final RequestConfig config = clientContext.getRequestConfigOrDefault(); final State state = new State(); state.maxRedirects = config.getMaxRedirects() > 0 ? config.getMaxRedirects() : 50; state.redirectCount = 0; state.currentRequest = request; state.currentEntityProducer = entityProducer; state.redirectLocations = redirectLocations; state.currentScope = scope; internalExecute(state, chain, asyncExecCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/CloseableHttpAsyncClient.java0100644 0000000 0000000 00000014245 00000250600 031223 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.HttpAsyncClient; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Base implementation of {@link HttpAsyncClient} that also implements {@link ModalCloseable}. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class CloseableHttpAsyncClient implements HttpAsyncClient, ModalCloseable { public abstract void start(); public abstract IOReactorStatus getStatus(); public abstract void awaitShutdown(TimeValue waitTime) throws InterruptedException; public abstract void initiateShutdown(); protected abstract Future doExecute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback); public final Future execute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return doExecute(target, requestProducer, responseConsumer, pushHandlerFactory, context, callback); } @Override public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return doExecute(null, requestProducer, responseConsumer, pushHandlerFactory, context, callback); } public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return execute(requestProducer, responseConsumer, null, context, callback); } public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return execute(requestProducer, responseConsumer, null, callback); } public final Future execute( final SimpleHttpRequest request, final HttpContext context, final FutureCallback callback) { Args.notNull(request, "Request"); return execute(SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), context, callback); } public final Future execute( final SimpleHttpRequest request, final FutureCallback callback) { return execute(request, null, callback); } /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated public abstract void register(String hostname, String uriPattern, Supplier supplier); /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated public final void register(final String uriPattern, final Supplier supplier) { register(null, uriPattern, supplier); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/ContentCompressionAsyncExec.java0100644 0000000 0000000 00000021247 00000250600 031774 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.LinkedHashMap; import java.util.List; import java.util.Set; import java.util.function.UnaryOperator; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.methods.InflatingAsyncDataConsumer; import org.apache.hc.client5.http.async.methods.InflatingBrotliDataConsumer; import org.apache.hc.client5.http.async.methods.InflatingGzipDataConsumer; import org.apache.hc.client5.http.async.methods.InflatingZstdDataConsumer; import org.apache.hc.client5.http.entity.compress.ContentCoding; import org.apache.hc.client5.http.impl.Brotli4jRuntime; import org.apache.hc.client5.http.impl.ContentCodingSupport; import org.apache.hc.client5.http.impl.ZstdRuntime; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.util.Args; @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ContentCompressionAsyncExec implements AsyncExecChainHandler { private final Lookup> decoders; private final List acceptTokens; private final int maxCodecListLen; public ContentCompressionAsyncExec( final LinkedHashMap> decoderMap, final int maxCodecListLen) { Args.notEmpty(decoderMap, "Decoder map"); final RegistryBuilder> rb = RegistryBuilder.create(); decoderMap.forEach(rb::register); this.decoders = rb.build(); this.acceptTokens = new ArrayList<>(decoderMap.keySet()); this.maxCodecListLen = maxCodecListLen; } public ContentCompressionAsyncExec( final LinkedHashMap> decoderMap) { this(decoderMap, ContentCodingSupport.MAX_CODEC_LIST_LEN); } /** * Default: DEFLATE + GZIP (plus x-gzip alias). */ public ContentCompressionAsyncExec(final int maxCodecListLen) { final LinkedHashMap> map = new LinkedHashMap<>(); map.put(ContentCoding.DEFLATE.token(), d -> new InflatingAsyncDataConsumer(d, null)); map.put(ContentCoding.GZIP.token(), InflatingGzipDataConsumer::new); map.put(ContentCoding.X_GZIP.token(), InflatingGzipDataConsumer::new); final RegistryBuilder> rb = RegistryBuilder.>create() .register(ContentCoding.GZIP.token(), InflatingGzipDataConsumer::new) .register(ContentCoding.X_GZIP.token(), InflatingGzipDataConsumer::new) .register(ContentCoding.DEFLATE.token(), d -> new InflatingAsyncDataConsumer(d, null)); // Add zstd only when zstd-jni is present (no reflection needed) final List tokens = new ArrayList<>(Arrays.asList("gzip", "x-gzip", "deflate")); if (ZstdRuntime.available()) { rb.register(ContentCoding.ZSTD.token(), InflatingZstdDataConsumer::new); tokens.add("zstd"); } if (Brotli4jRuntime.available()) { rb.register(ContentCoding.BROTLI.token(), InflatingBrotliDataConsumer::new); tokens.add(ContentCoding.BROTLI.token()); } this.decoders = rb.build(); this.acceptTokens = tokens; this.maxCodecListLen = maxCodecListLen; } public ContentCompressionAsyncExec() { this(ContentCodingSupport.MAX_CODEC_LIST_LEN); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer producer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback cb) throws IOException, HttpException { final HttpClientContext ctx = scope != null ? scope.clientContext : HttpClientContext.create(); final boolean enabled = ctx.getRequestConfigOrDefault().isContentCompressionEnabled(); if (enabled && !request.containsHeader(HttpHeaders.ACCEPT_ENCODING)) { request.addHeader(MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, acceptTokens)); } chain.proceed(request, producer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse(final HttpResponse rsp, final EntityDetails details) throws HttpException, IOException { if (!enabled) { return cb.handleResponse(rsp, details); } final List codecs = ContentCodingSupport.parseContentCodecs(details); ContentCodingSupport.validate(codecs, maxCodecListLen); if (!codecs.isEmpty()) { AsyncDataConsumer downstream = cb.handleResponse(rsp, wrapEntityDetails(details)); for (int i = codecs.size() - 1; i >= 0; i--) { final String codec = codecs.get(i); final UnaryOperator op = decoders.lookup(codec); if (op != null) { downstream = op.apply(downstream); } else { throw new HttpException("Unsupported Content-Encoding: " + codec); } } return downstream; } return cb.handleResponse(rsp, details); } @Override public void handleInformationResponse(final HttpResponse r) throws HttpException, IOException { cb.handleInformationResponse(r); } @Override public void completed() { cb.completed(); } @Override public void failed(final Exception ex) { cb.failed(ex); } }); } private static EntityDetails wrapEntityDetails(final EntityDetails original) { return new EntityDetails() { @Override public long getContentLength() { return -1; } @Override public String getContentType() { return original.getContentType(); } @Override public String getContentEncoding() { return null; } @Override public boolean isChunked() { return true; } @Override public Set getTrailerNames() { return original.getTrailerNames(); } }; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/EarlyHintsAsyncExec.java0100644 0000000 0000000 00000010630 00000250600 030214 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.apache.hc.client5.http.EarlyHintsListener; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; /** * Execution chain handler that delivers {@code 103 Early Hints} * informational responses to a user-provided * {@link org.apache.hc.client5.http.EarlyHintsListener} * without affecting processing of the final (non-1xx) response. * *

This handler forwards each {@code 103} informational response to the * listener. All other responses (including the final response) are delegated * unchanged.

* *

For security and interoperability, applications typically act only on * headers considered safe in Early Hints (for example, {@code Link} with * {@code rel=preload} or {@code rel=preconnect}).

* * @see org.apache.hc.client5.http.EarlyHintsListener * @see org.apache.hc.core5.http.HttpStatus#SC_EARLY_HINTS * @see org.apache.hc.core5.http.nio.ResponseChannel#sendInformation(org.apache.hc.core5.http.HttpResponse, org.apache.hc.core5.http.protocol.HttpContext) * @since 5.6 */ public final class EarlyHintsAsyncExec implements AsyncExecChainHandler { private final EarlyHintsListener listener; public EarlyHintsAsyncExec(final EarlyHintsListener listener) { this.listener = listener; } @Override public void execute(final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback callback) throws HttpException, IOException { if (listener == null) { chain.proceed(request, entityProducer, scope, callback); return; } chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, java.io.IOException { if (response.getCode() == HttpStatus.SC_EARLY_HINTS) { listener.onEarlyHints(response, scope.clientContext); } callback.handleInformationResponse(response); } @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, java.io.IOException { return callback.handleResponse(response, entityDetails); } @Override public void completed() { callback.completed(); } @Override public void failed(final Exception cause) { callback.failed(cause); } }); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncClientBuilder.java0100644 0000000 0000000 00000112647 00000250600 030257 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.io.IOException; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedList; import java.util.List; import java.util.concurrent.ThreadFactory; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.ScramSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.nio.MultihomeConnectionInitiator; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.protocol.H2RequestPriority; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.IOSessionListener; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; /** * Builder for HTTP/2 only {@link CloseableHttpAsyncClient} instances. *

* Concurrent message exchanges with the same connection route executed * with these {@link CloseableHttpAsyncClient} instances will get * automatically multiplexed over a single physical HTTP/2 connection. *

*

* When a particular component is not explicitly set this class will * use its default implementation. *

* * @since 5.0 */ public class H2AsyncClientBuilder { private static class RequestInterceptorEntry { enum Position { FIRST, LAST } final RequestInterceptorEntry.Position position; final HttpRequestInterceptor interceptor; private RequestInterceptorEntry(final RequestInterceptorEntry.Position position, final HttpRequestInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ResponseInterceptorEntry { enum Position { FIRST, LAST } final ResponseInterceptorEntry.Position position; final HttpResponseInterceptor interceptor; private ResponseInterceptorEntry(final ResponseInterceptorEntry.Position position, final HttpResponseInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ExecInterceptorEntry { enum Position { BEFORE, AFTER, REPLACE, FIRST, LAST } final ExecInterceptorEntry.Position position; final String name; final AsyncExecChainHandler interceptor; final String existing; private ExecInterceptorEntry( final ExecInterceptorEntry.Position position, final String name, final AsyncExecChainHandler interceptor, final String existing) { this.position = position; this.name = name; this.interceptor = interceptor; this.existing = existing; } } private IOReactorConfig ioReactorConfig; private IOSessionListener ioSessionListener; private H2Config h2Config; private CharCodingConfig charCodingConfig; private SchemePortResolver schemePortResolver; private AuthenticationStrategy targetAuthStrategy; private AuthenticationStrategy proxyAuthStrategy; private LinkedList requestInterceptors; private LinkedList responseInterceptors; private LinkedList execInterceptors; private HttpRoutePlanner routePlanner; private RedirectStrategy redirectStrategy; private HttpRequestRetryStrategy retryStrategy; private Lookup authSchemeRegistry; private Lookup cookieSpecRegistry; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private String userAgent; private Collection defaultHeaders; private RequestConfig defaultRequestConfig; private Resolver connectionConfigResolver; private boolean evictIdleConnections; private TimeValue maxIdleTime; private boolean systemProperties; private boolean automaticRetriesDisabled; private boolean redirectHandlingDisabled; private boolean cookieManagementDisabled; private boolean authCachingDisabled; private DnsResolver dnsResolver; private TlsStrategy tlsStrategy; private ThreadFactory threadFactory; private List closeables; private Callback ioReactorExceptionCallback; private Decorator ioSessionDecorator; private boolean priorityHeaderDisabled; public static H2AsyncClientBuilder create() { return new H2AsyncClientBuilder(); } protected H2AsyncClientBuilder() { super(); } /** * Sets {@link H2Config} configuration. * * @return this instance. */ public final H2AsyncClientBuilder setH2Config(final H2Config h2Config) { this.h2Config = h2Config; return this; } /** * Sets {@link IOReactorConfig} configuration. * * @return this instance. */ public final H2AsyncClientBuilder setIOReactorConfig(final IOReactorConfig ioReactorConfig) { this.ioReactorConfig = ioReactorConfig; return this; } /** * Sets {@link IOSessionListener} listener. * * @return this instance. * @since 5.2 */ public final H2AsyncClientBuilder setIOSessionListener(final IOSessionListener ioSessionListener) { this.ioSessionListener = ioSessionListener; return this; } /** * Sets {@link CharCodingConfig} configuration. * * @return this instance. */ public final H2AsyncClientBuilder setCharCodingConfig(final CharCodingConfig charCodingConfig) { this.charCodingConfig = charCodingConfig; return this; } /** * Sets {@link AuthenticationStrategy} instance for target * host authentication. * * @return this instance. */ public final H2AsyncClientBuilder setTargetAuthenticationStrategy( final AuthenticationStrategy targetAuthStrategy) { this.targetAuthStrategy = targetAuthStrategy; return this; } /** * Sets {@link AuthenticationStrategy} instance for proxy * authentication. * * @return this instance. */ public final H2AsyncClientBuilder setProxyAuthenticationStrategy( final AuthenticationStrategy proxyAuthStrategy) { this.proxyAuthStrategy = proxyAuthStrategy; return this; } /** * Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception. * * @return this instance. * @since 5.2 */ public final H2AsyncClientBuilder setIoReactorExceptionCallback(final Callback ioReactorExceptionCallback) { this.ioReactorExceptionCallback = ioReactorExceptionCallback; return this; } /** * Sets the {@link IOSession} {@link Decorator} that will be use with the client's IOReactor. * * @return this instance. * @since 5.2 */ public final H2AsyncClientBuilder setIoSessionDecorator(final Decorator ioSessionDecorator) { this.ioSessionDecorator = ioSessionDecorator; return this; } /** * Disable installing the HTTP/2 Priority header interceptor by default. * @since 5.6 */ @Experimental public final H2AsyncClientBuilder disableRequestPriority() { this.priorityHeaderDisabled = true; return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final H2AsyncClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final H2AsyncClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Adds this execution interceptor before an existing interceptor. * * @return this instance. */ public final H2AsyncClientBuilder addExecInterceptorBefore(final String existing, final String name, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.BEFORE, name, interceptor, existing)); return this; } /** * Adds this execution interceptor after interceptor with the given name. * * @return this instance. */ public final H2AsyncClientBuilder addExecInterceptorAfter(final String existing, final String name, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.AFTER, name, interceptor, existing)); return this; } /** * Replace an existing interceptor with the given name with new interceptor. * * @return this instance. */ public final H2AsyncClientBuilder replaceExecInterceptor(final String existing, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.REPLACE, existing, interceptor, existing)); return this; } /** * Add an interceptor to the head of the processing list. * * @return this instance. */ public final H2AsyncClientBuilder addExecInterceptorFirst(final String name, final AsyncExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.FIRST, name, interceptor, null)); return this; } /** * Add an interceptor to the tail of the processing list. * * @return this instance. */ public final H2AsyncClientBuilder addExecInterceptorLast(final String name, final AsyncExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.LAST, name, interceptor, null)); return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final H2AsyncClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final H2AsyncClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Sets {@link HttpRequestRetryStrategy} instance. *

* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * method. *

* * @return this instance. */ public final H2AsyncClientBuilder setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) { this.retryStrategy = retryStrategy; return this; } /** * Sets {@link RedirectStrategy} instance. *

* Please note this value can be overridden by the {@link #disableRedirectHandling()} * method. *

* * @return this instance. */ public H2AsyncClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) { this.redirectStrategy = redirectStrategy; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final H2AsyncClientBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@link DnsResolver} instance. * * @return this instance. */ public final H2AsyncClientBuilder setDnsResolver(final DnsResolver dnsResolver) { this.dnsResolver = dnsResolver; return this; } /** * Sets {@link TlsStrategy} instance. * * @return this instance. */ public final H2AsyncClientBuilder setTlsStrategy(final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } /** * Sets {@link ThreadFactory} instance. * * @return this instance. */ public final H2AsyncClientBuilder setThreadFactory(final ThreadFactory threadFactory) { this.threadFactory = threadFactory; return this; } /** * Sets {@code User-Agent} value. * * @return this instance. */ public final H2AsyncClientBuilder setUserAgent(final String userAgent) { this.userAgent = userAgent; return this; } /** * Sets default request header values. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.defaultHeaders = defaultHeaders; return this; } /** * Sets {@link HttpRoutePlanner} instance. * * @return this instance. */ public final H2AsyncClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) { this.routePlanner = routePlanner; return this; } /** * Sets default {@link CredentialsProvider} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultCredentialsProvider(final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; return this; } /** * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * be used for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.authSchemeRegistry = authSchemeRegistry; return this; } /** * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry * which will be used for request execution if not explicitly set in the client * execution context. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultCookieSpecRegistry(final Lookup cookieSpecRegistry) { this.cookieSpecRegistry = cookieSpecRegistry; return this; } /** * Sets default {@link CookieStore} instance which will be used for * request execution if not explicitly set in the client execution context. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } /** * Sets default {@link RequestConfig} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final H2AsyncClientBuilder setDefaultRequestConfig(final RequestConfig config) { this.defaultRequestConfig = config; return this; } /** * Sets {@link Resolver} for {@link ConnectionConfig} on a per host basis. * * @return this instance. * @since 5.2 */ public final H2AsyncClientBuilder setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; return this; } /** * Sets the same {@link ConnectionConfig} for all hosts. * * @return this instance. * @since 5.2 */ public final H2AsyncClientBuilder setDefaultConnectionConfig(final ConnectionConfig connectionConfig) { this.connectionConfigResolver = host -> connectionConfig; return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final H2AsyncClientBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * Disables automatic redirect handling. * * @return this instance. */ public final H2AsyncClientBuilder disableRedirectHandling() { redirectHandlingDisabled = true; return this; } /** * Disables automatic request recovery and re-execution. * * @return this instance. */ public final H2AsyncClientBuilder disableAutomaticRetries() { automaticRetriesDisabled = true; return this; } /** * Disables state (cookie) management. * * @return this instance. */ public final H2AsyncClientBuilder disableCookieManagement() { this.cookieManagementDisabled = true; return this; } /** * Disables authentication scheme caching. * * @return this instance. */ public final H2AsyncClientBuilder disableAuthCaching() { this.authCachingDisabled = true; return this; } /** * Makes this instance of HttpClient proactively evict idle connections from the * connection pool using a background thread. *

* One MUST explicitly close HttpClient with {@link CloseableHttpAsyncClient#close()} * in order to stop and release the background thread. *

*

* Please note this method has no effect if the instance of HttpClient is configured to * use a shared connection manager. *

* * @param maxIdleTime maximum time persistent connections can stay idle while kept alive * in the connection pool. Connections whose inactivity period exceeds this value will * get closed and evicted from the pool. * * @return this instance. */ public final H2AsyncClientBuilder evictIdleConnections(final TimeValue maxIdleTime) { this.evictIdleConnections = true; this.maxIdleTime = maxIdleTime; return this; } /** * Request exec chain customization and extension. *

* For internal use. *

*/ @Internal protected void customizeExecChain(final NamedElementChain execChainDefinition) { } /** * Adds to the list of {@link Closeable} resources to be managed by the client. *

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } public CloseableHttpAsyncClient build() { AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = getProperty("http.agent", null); } if (userAgentCopy == null) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpAsyncClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (!priorityHeaderDisabled) { b.addLast(H2RequestPriority.INSTANCE); } b.addAll( new H2RequestTargetHost(), new RequestDefaultHeaders(defaultHeaders), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new H2RequestContent(), new H2RequestConnControl()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new H2AsyncMainClientExec(httpProcessor), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new AsyncConnectExec( new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); execChainDefinition.addFirst( new AsyncProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncHttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncRedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); final IOEventHandlerFactory ioEventHandlerFactory = new H2AsyncClientProtocolStarter( HttpProcessorBuilder.create().build(), (request, context) -> pushConsumerRegistry.get(request), h2Config != null ? h2Config : H2Config.DEFAULT, charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE); final DefaultConnectingIOReactor ioReactor = new DefaultConnectingIOReactor( ioEventHandlerFactory, ioReactorConfig != null ? ioReactorConfig : IOReactorConfig.DEFAULT, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-dispatch", true), ioSessionDecorator != null ? ioSessionDecorator : LoggingIOSessionDecorator.INSTANCE, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE, ioSessionListener, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE)); if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after H2AsyncMainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); AsyncExecChainElement execChain = null; while (current != null) { execChain = new AsyncExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .register(StandardAuthScheme.SCRAM_SHA_256, ScramSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null && !cookieManagementDisabled) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore cookieStoreCopy = this.cookieStore; if (cookieStoreCopy == null) { cookieStoreCopy = new BasicCookieStore(); } CredentialsProvider credentialsProviderCopy = this.credentialsProvider; if (credentialsProviderCopy == null) { if (systemProperties) { credentialsProviderCopy = new SystemDefaultCredentialsProvider(); } else { credentialsProviderCopy = new BasicCredentialsProvider(); } } TlsStrategy tlsStrategyCopy = this.tlsStrategy; if (tlsStrategyCopy == null) { if (systemProperties) { tlsStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } final MultihomeConnectionInitiator connectionInitiator = new MultihomeConnectionInitiator(ioReactor, dnsResolver); final InternalH2ConnPool connPool = new InternalH2ConnPool(connectionInitiator, host -> null, tlsStrategyCopy); connPool.setConnectionConfigResolver(connectionConfigResolver); List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictIdleConnections) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor(connPool, maxIdleTime != null ? maxIdleTime : TimeValue.ofSeconds(30L)); closeablesCopy.add(connectionEvictor::shutdown); connectionEvictor.start(); } closeablesCopy.add(connPool); return new InternalH2AsyncClient( ioReactor, execChain, pushConsumerRegistry, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-main", true), connPool, routePlannerCopy, cookieSpecRegistryCopy, authSchemeRegistryCopy, cookieStoreCopy, credentialsProviderCopy, defaultRequestConfig, closeablesCopy); } private static String getProperty(final String key, final String defaultValue) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key, defaultValue)); } static class IdleConnectionEvictor implements Closeable { private final Thread thread; public IdleConnectionEvictor(final InternalH2ConnPool connPool, final TimeValue maxIdleTime) { this.thread = new DefaultThreadFactory("idle-connection-evictor", true).newThread(() -> { try { while (!Thread.currentThread().isInterrupted()) { maxIdleTime.sleep(); connPool.closeIdle(maxIdleTime); } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); } catch (final Exception ignore) { } }); } public void start() { thread.start(); } public void shutdown() { thread.interrupt(); } @Override public void close() throws IOException { shutdown(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncClientProtocolStarter.java0100644 0000000 0000000 00000021566 00000250600 032036 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.List; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.frame.FramePrinter; import org.apache.hc.core5.http2.frame.RawFrame; import org.apache.hc.core5.http2.impl.nio.ClientH2PrefaceHandler; import org.apache.hc.core5.http2.impl.nio.ClientH2StreamMultiplexerFactory; import org.apache.hc.core5.http2.impl.nio.H2StreamListener; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class H2AsyncClientProtocolStarter implements IOEventHandlerFactory { private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger FRAME_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame"); private static final Logger FRAME_PAYLOAD_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame.payload"); private static final Logger FLOW_CTRL_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.flow"); private final HttpProcessor httpProcessor; private final HandlerFactory exchangeHandlerFactory; private final H2Config h2Config; private final CharCodingConfig charCodingConfig; private final Callback exceptionCallback; H2AsyncClientProtocolStarter( final HttpProcessor httpProcessor, final HandlerFactory exchangeHandlerFactory, final H2Config h2Config, final CharCodingConfig charCodingConfig, final Callback exceptionCallback) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP processor"); this.exchangeHandlerFactory = exchangeHandlerFactory; this.h2Config = h2Config != null ? h2Config : H2Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.exceptionCallback = exceptionCallback; } @Override public IOEventHandler createHandler(final ProtocolIOSession ioSession, final Object attachment) { if (HEADER_LOG.isDebugEnabled() || FRAME_LOG.isDebugEnabled() || FRAME_PAYLOAD_LOG.isDebugEnabled() || FLOW_CTRL_LOG.isDebugEnabled()) { final String id = ioSession.getId(); final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, new H2StreamListener() { final FramePrinter framePrinter = new FramePrinter(); private void logFrameInfo(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_LOG, prefix); framePrinter.printFrameInfo(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFramePayload(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_PAYLOAD_LOG, prefix); framePrinter.printPayload(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFlowControl(final String prefix, final int streamId, final int delta, final int actualSize) { FLOW_CTRL_LOG.debug("{} stream {} flow control {} -> {}", prefix, streamId, delta, actualSize); } @Override public void onHeaderInput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} << {}", id, headers.get(i)); } } } @Override public void onHeaderOutput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} >> {}", id, headers.get(i)); } } } @Override public void onFrameInput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " <<", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " <<", frame); } } @Override public void onFrameOutput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " >>", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " >>", frame); } } @Override public void onInputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " <<", streamId, delta, actualSize); } } @Override public void onOutputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " >>", streamId, delta, actualSize); } } }); return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); } final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, null); return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncMainClientExec.java0100644 0000000 0000000 00000020301 00000250600 030343 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last HTTP/2 request execution handler in the asynchronous * request execution chain that is responsible for execution of * request / response exchanges with the opposite endpoint. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public class H2AsyncMainClientExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(H2AsyncMainClientExec.class); private final HttpProcessor httpProcessor; H2AsyncMainClientExec(final HttpProcessor httpProcessor) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } @Override public void cancel() { failed(new InterruptedIOException()); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { clientContext.setRequest(request); clientContext.setRoute(route); httpProcessor.process(request, entityProducer, clientContext); channel.sendRequest(request, entityProducer, context); } @Override public int available() { return entityProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { entityProducer.produce(channel); } @Override public void consumeInformation(final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { clientContext.setResponse(response); httpProcessor.process(response, entityDetails, clientContext); entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); if (entityDetails == null) { execRuntime.validateConnection(); asyncExecCallback.completed(); } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } else { execRuntime.validateConnection(); } asyncExecCallback.completed(); } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientBuilder.java0100644 0000000 0000000 00000136466 00000250600 030732 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.net.ProxySelector; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedHashMap; import java.util.LinkedList; import java.util.List; import java.util.concurrent.ThreadFactory; import java.util.function.Function; import java.util.function.UnaryOperator; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.EarlyHintsListener; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultConnectionKeepAliveStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.DefaultUserTokenHandler; import org.apache.hc.client5.http.impl.IdleConnectionEvictor; import org.apache.hc.client5.http.impl.NoopUserTokenHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.ScramSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.impl.routing.SystemDefaultRoutePlanner; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.protocol.H2RequestPriority; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.RequestUpgrade; import org.apache.hc.client5.http.protocol.RequestValidateTrace; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.IOSessionListener; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; /** * Builder for {@link CloseableHttpAsyncClient} instances that can negotiate * the most optimal HTTP protocol version during the {@code TLS} handshake * with {@code ALPN} extension if supported by the Java runtime. *

* Concurrent message exchanges executed by {@link CloseableHttpAsyncClient} * instances created with this builder will get automatically assigned to * separate connections leased from the connection pool. *

*

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #build()}. *

*
    *
  • http.proxyHost
    • *
  • http.proxyPort
    • *
  • https.proxyHost
    • *
  • https.proxyPort
    • *
  • http.nonProxyHosts
    • *
  • http.keepAlive
    • *
  • http.agent
    • *
*

* Please note that some settings used by this class can be mutually * exclusive and may not apply when building {@link CloseableHttpAsyncClient} * instances. *

* * @since 5.0 */ public class HttpAsyncClientBuilder { private static class RequestInterceptorEntry { enum Position { FIRST, LAST } final RequestInterceptorEntry.Position position; final HttpRequestInterceptor interceptor; private RequestInterceptorEntry(final RequestInterceptorEntry.Position position, final HttpRequestInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ResponseInterceptorEntry { enum Position { FIRST, LAST } final ResponseInterceptorEntry.Position position; final HttpResponseInterceptor interceptor; private ResponseInterceptorEntry(final ResponseInterceptorEntry.Position position, final HttpResponseInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ExecInterceptorEntry { enum Position { BEFORE, AFTER, REPLACE, FIRST, LAST } final ExecInterceptorEntry.Position position; final String name; final AsyncExecChainHandler interceptor; final String existing; private ExecInterceptorEntry( final ExecInterceptorEntry.Position position, final String name, final AsyncExecChainHandler interceptor, final String existing) { this.position = position; this.name = name; this.interceptor = interceptor; this.existing = existing; } } /** * @deprecated TLS should be configured by the connection manager */ @Deprecated private TlsConfig tlsConfig; private AsyncClientConnectionManager connManager; private boolean connManagerShared; private IOReactorConfig ioReactorConfig; private IOSessionListener ioSessionListener; private Callback ioReactorExceptionCallback; private Http1Config h1Config; private H2Config h2Config; private CharCodingConfig charCodingConfig; private SchemePortResolver schemePortResolver; private ConnectionKeepAliveStrategy keepAliveStrategy; private UserTokenHandler userTokenHandler; private AuthenticationStrategy targetAuthStrategy; private AuthenticationStrategy proxyAuthStrategy; private Decorator ioSessionDecorator; private LinkedList requestInterceptors; private LinkedList responseInterceptors; private LinkedList execInterceptors; private HttpRoutePlanner routePlanner; private RedirectStrategy redirectStrategy; private HttpRequestRetryStrategy retryStrategy; private ConnectionReuseStrategy reuseStrategy; private Lookup authSchemeRegistry; private Lookup cookieSpecRegistry; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private String userAgent; private HttpHost proxy; private Collection defaultHeaders; private RequestConfig defaultRequestConfig; private boolean evictExpiredConnections; private boolean evictIdleConnections; private TimeValue maxIdleTime; private boolean systemProperties; private boolean automaticRetriesDisabled; private boolean redirectHandlingDisabled; private boolean cookieManagementDisabled; private boolean authCachingDisabled; private boolean connectionStateDisabled; private ThreadFactory threadFactory; private List closeables; private ProxySelector proxySelector; private EarlyHintsListener earlyHintsListener; private boolean priorityHeaderDisabled; /** * Maps {@code Content-Encoding} tokens to decoder factories in insertion order. */ private LinkedHashMap> contentDecoderMap; /** * When {@code true} the client skips all transparent response decompression. */ private boolean contentCompressionDisabled; public static HttpAsyncClientBuilder create() { return new HttpAsyncClientBuilder(); } protected HttpAsyncClientBuilder() { super(); } /** * Sets HTTP protocol version policy. * * @return this instance. * @deprecated Use {@link TlsConfig} and connection manager methods */ @Deprecated public final HttpAsyncClientBuilder setVersionPolicy(final HttpVersionPolicy versionPolicy) { this.tlsConfig = versionPolicy != null ? TlsConfig.custom().setVersionPolicy(versionPolicy).build() : null; return this; } /** * Sets {@link Http1Config} configuration. * * @return this instance. */ public final HttpAsyncClientBuilder setHttp1Config(final Http1Config h1Config) { this.h1Config = h1Config; return this; } /** * Sets {@link H2Config} configuration. * * @return this instance. */ public final HttpAsyncClientBuilder setH2Config(final H2Config h2Config) { this.h2Config = h2Config; return this; } /** * Sets {@link AsyncClientConnectionManager} instance. * * @return this instance. */ public final HttpAsyncClientBuilder setConnectionManager(final AsyncClientConnectionManager connManager) { this.connManager = connManager; return this; } /** * Defines the connection manager is to be shared by multiple * client instances. *

* If the connection manager is shared its life-cycle is expected * to be managed by the caller and it will not be shut down * if the client is closed. *

* * @param shared defines whether or not the connection manager can be shared * by multiple clients. * * @return this instance. */ public final HttpAsyncClientBuilder setConnectionManagerShared(final boolean shared) { this.connManagerShared = shared; return this; } /** * Sets {@link IOReactorConfig} configuration. * * @return this instance. */ public final HttpAsyncClientBuilder setIOReactorConfig(final IOReactorConfig ioReactorConfig) { this.ioReactorConfig = ioReactorConfig; return this; } /** * Sets {@link IOSessionListener} listener. * * @return this instance. * @since 5.2 */ public final HttpAsyncClientBuilder setIOSessionListener(final IOSessionListener ioSessionListener) { this.ioSessionListener = ioSessionListener; return this; } /** * Sets the callback that will be invoked when the client's IOReactor encounters an uncaught exception. * * @return this instance. * @since 5.1 */ public final HttpAsyncClientBuilder setIoReactorExceptionCallback(final Callback ioReactorExceptionCallback) { this.ioReactorExceptionCallback = ioReactorExceptionCallback; return this; } /** * Sets {@link CharCodingConfig} configuration. * * @return this instance. */ public final HttpAsyncClientBuilder setCharCodingConfig(final CharCodingConfig charCodingConfig) { this.charCodingConfig = charCodingConfig; return this; } /** * Sets {@link ConnectionReuseStrategy} instance. *

* Please note this strategy applies to HTTP/1.0 and HTTP/1.1 connections only *

* * @return this instance. */ public final HttpAsyncClientBuilder setConnectionReuseStrategy(final ConnectionReuseStrategy reuseStrategy) { this.reuseStrategy = reuseStrategy; return this; } /** * Sets {@link ConnectionKeepAliveStrategy} instance. * * @return this instance. */ public final HttpAsyncClientBuilder setKeepAliveStrategy(final ConnectionKeepAliveStrategy keepAliveStrategy) { this.keepAliveStrategy = keepAliveStrategy; return this; } /** * Sets {@link UserTokenHandler} instance. *

* Please note this value can be overridden by the {@link #disableConnectionState()} * method. *

* * @return this instance. */ public final HttpAsyncClientBuilder setUserTokenHandler(final UserTokenHandler userTokenHandler) { this.userTokenHandler = userTokenHandler; return this; } /** * Sets {@link AuthenticationStrategy} instance for target * host authentication. * * @return this instance. */ public final HttpAsyncClientBuilder setTargetAuthenticationStrategy( final AuthenticationStrategy targetAuthStrategy) { this.targetAuthStrategy = targetAuthStrategy; return this; } /** * Sets {@link AuthenticationStrategy} instance for proxy * authentication. * * @return this instance. */ public final HttpAsyncClientBuilder setProxyAuthenticationStrategy( final AuthenticationStrategy proxyAuthStrategy) { this.proxyAuthStrategy = proxyAuthStrategy; return this; } /** * Sets the {@link IOSession} {@link Decorator} that will be use with the client's IOReactor. * * @return this instance. * @since 5.2 */ public final HttpAsyncClientBuilder setIoSessionDecorator(final Decorator ioSessionDecorator) { this.ioSessionDecorator = ioSessionDecorator; return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Adds this execution interceptor before an existing interceptor. * * @return this instance. */ public final HttpAsyncClientBuilder addExecInterceptorBefore(final String existing, final String name, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.BEFORE, name, interceptor, existing)); return this; } /** * Adds this execution interceptor after interceptor with the given name. * * @return this instance. */ public final HttpAsyncClientBuilder addExecInterceptorAfter(final String existing, final String name, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.AFTER, name, interceptor, existing)); return this; } /** * Replace an existing interceptor with the given name with new interceptor. * * @return this instance. */ public final HttpAsyncClientBuilder replaceExecInterceptor(final String existing, final AsyncExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.REPLACE, existing, interceptor, existing)); return this; } /** * Add an interceptor to the head of the processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addExecInterceptorFirst(final String name, final AsyncExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.FIRST, name, interceptor, null)); return this; } /** * Add an interceptor to the tail of the processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addExecInterceptorLast(final String name, final AsyncExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.LAST, name, interceptor, null)); return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final HttpAsyncClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Sets {@link HttpRequestRetryStrategy} instance. *

* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * method. *

* * @return this instance. */ public final HttpAsyncClientBuilder setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) { this.retryStrategy = retryStrategy; return this; } /** * Sets {@link RedirectStrategy} instance. *

* Please note this value can be overridden by the {@link #disableRedirectHandling()} * method. *

* * @return this instance. */ public HttpAsyncClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) { this.redirectStrategy = redirectStrategy; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final HttpAsyncClientBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@link ThreadFactory} instance. * * @return this instance. */ public final HttpAsyncClientBuilder setThreadFactory(final ThreadFactory threadFactory) { this.threadFactory = threadFactory; return this; } /** * Sets {@code User-Agent} value. * * @return this instance. */ public final HttpAsyncClientBuilder setUserAgent(final String userAgent) { this.userAgent = userAgent; return this; } /** * Sets default request header values. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.defaultHeaders = defaultHeaders; return this; } /** * Sets the {@link ProxySelector} that will be used to select the proxies * to be used for establishing HTTP connections. If a non-null proxy selector is set, * it will take precedence over the proxy settings configured in the client. * * @param proxySelector the {@link ProxySelector} to be used, or null to use * the default system proxy selector. * @return this instance. */ public final HttpAsyncClientBuilder setProxySelector(final ProxySelector proxySelector) { this.proxySelector = proxySelector; return this; } /** * Sets default proxy value. *

* Please note this value can be overridden by the {@link #setRoutePlanner( * HttpRoutePlanner)} method. *

* @return this instance. */ public final HttpAsyncClientBuilder setProxy(final HttpHost proxy) { this.proxy = proxy; return this; } /** * Sets {@link HttpRoutePlanner} instance. * * @return this instance. */ public final HttpAsyncClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) { this.routePlanner = routePlanner; return this; } /** * Sets default {@link CredentialsProvider} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultCredentialsProvider(final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; return this; } /** * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * be used for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.authSchemeRegistry = authSchemeRegistry; return this; } /** * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry * which will be used for request execution if not explicitly set in the client * execution context. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultCookieSpecRegistry(final Lookup cookieSpecRegistry) { this.cookieSpecRegistry = cookieSpecRegistry; return this; } /** * Sets default {@link CookieStore} instance which will be used for * request execution if not explicitly set in the client execution context. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } /** * Sets default {@link RequestConfig} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpAsyncClientBuilder setDefaultRequestConfig(final RequestConfig config) { this.defaultRequestConfig = config; return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final HttpAsyncClientBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * Disables connection state tracking. * * @return this instance. */ public final HttpAsyncClientBuilder disableConnectionState() { connectionStateDisabled = true; return this; } /** * Disables automatic redirect handling. * * @return this instance. */ public final HttpAsyncClientBuilder disableRedirectHandling() { redirectHandlingDisabled = true; return this; } /** * Disables automatic request recovery and re-execution. * * @return this instance. */ public final HttpAsyncClientBuilder disableAutomaticRetries() { automaticRetriesDisabled = true; return this; } /** * Disables state (cookie) management. * * @return this instance. */ public final HttpAsyncClientBuilder disableCookieManagement() { this.cookieManagementDisabled = true; return this; } /** * Disables authentication scheme caching. * * @return this instance. */ public final HttpAsyncClientBuilder disableAuthCaching() { this.authCachingDisabled = true; return this; } /** * Makes this instance of HttpClient proactively evict expired connections from the * connection pool using a background thread. *

* One MUST explicitly close HttpClient with {@link CloseableHttpAsyncClient#close()} in order * to stop and release the background thread. *

* Please note this method has no effect if the instance of HttpClient is configured to * use a shared connection manager. * * @see #setConnectionManagerShared(boolean) * @see ConnPoolControl#closeExpired() * * @return this instance. */ public final HttpAsyncClientBuilder evictExpiredConnections() { evictExpiredConnections = true; return this; } /** * Makes this instance of HttpClient proactively evict idle connections from the * connection pool using a background thread. *

* One MUST explicitly close HttpClient with {@link CloseableHttpAsyncClient#close()} * in order to stop and release the background thread. *

* Please note this method has no effect if the instance of HttpClient is configured to * use a shared connection manager. * * @see #setConnectionManagerShared(boolean) * @see ConnPoolControl#closeIdle(TimeValue) * * @param maxIdleTime maximum time persistent connections can stay idle while kept alive * in the connection pool. Connections whose inactivity period exceeds this value will * get closed and evicted from the pool. * * @return this instance. */ public final HttpAsyncClientBuilder evictIdleConnections(final TimeValue maxIdleTime) { this.evictIdleConnections = true; this.maxIdleTime = Args.notNull(maxIdleTime, "Max idle time"); return this; } /** * Replaces the current decoder registry with {@code contentDecoderMap}. * *

The map’s insertion order defines the {@code Accept-Encoding} * preference list sent on every request.

* * @param contentDecoderMap a non-empty {@link LinkedHashMap} whose keys are * lower-case coding tokens and whose values create * a fresh wrapper consumer for each response * @return {@code this} builder instance * @since 5.6 */ public HttpAsyncClientBuilder setContentDecoderMap( final LinkedHashMap> contentDecoderMap) { this.contentDecoderMap = contentDecoderMap; return this; } /** * Disables transparent response decompression for the client produced by * this builder. * * @return {@code this} builder instance * @since 5.6 */ public HttpAsyncClientBuilder disableContentCompression() { this.contentCompressionDisabled = true; return this; } /** * Disable installing the HTTP/2 Priority header interceptor by default. * @since 5.6 */ @Experimental public final HttpAsyncClientBuilder disableRequestPriority() { this.priorityHeaderDisabled = true; return this; } /** * Registers a global {@link org.apache.hc.client5.http.EarlyHintsListener} * that will be notified when the client receives {@code 103 Early Hints} * informational responses for any request executed by the built client. * * @param listener the listener to receive {@code 103 Early Hints} events, * or {@code null} to remove the listener * @return this builder * @since 5.6 */ public final HttpAsyncClientBuilder setEarlyHintsListener(final EarlyHintsListener listener) { this.earlyHintsListener = listener; return this; } /** * Request exec chain customization and extension. *

* For internal use. *

*/ @Internal protected void customizeExecChain(final NamedElementChain execChainDefinition) { } /** * Adds to the list of {@link Closeable} resources to be managed by the client. *

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } @Internal protected Function contextAdaptor() { return HttpClientContext::castOrCreate; } @Internal public AsyncClientConnectionManager getConnManager() { return connManager; } @SuppressWarnings("deprecated") public CloseableHttpAsyncClient build() { AsyncClientConnectionManager connManagerCopy = this.connManager; if (connManagerCopy == null) { final PoolingAsyncClientConnectionManagerBuilder connectionManagerBuilder = PoolingAsyncClientConnectionManagerBuilder.create(); if (systemProperties) { connectionManagerBuilder.useSystemProperties(); } connManagerCopy = connectionManagerBuilder.build(); } ConnectionKeepAliveStrategy keepAliveStrategyCopy = this.keepAliveStrategy; if (keepAliveStrategyCopy == null) { keepAliveStrategyCopy = DefaultConnectionKeepAliveStrategy.INSTANCE; } UserTokenHandler userTokenHandlerCopy = this.userTokenHandler; if (userTokenHandlerCopy == null) { if (!connectionStateDisabled) { userTokenHandlerCopy = DefaultUserTokenHandler.INSTANCE; } else { userTokenHandlerCopy = NoopUserTokenHandler.INSTANCE; } } AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = getProperty("http.agent", null); } if (userAgentCopy == null) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpAsyncClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } b.addAll( new H2RequestTargetHost(), new RequestValidateTrace(), new RequestDefaultHeaders(defaultHeaders), new H2RequestContent(), new H2RequestConnControl(), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new RequestUpgrade()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (!priorityHeaderDisabled) { b.addLast(H2RequestPriority.INSTANCE); } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new HttpAsyncMainClientExec(httpProcessor, keepAliveStrategyCopy, userTokenHandlerCopy), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new AsyncConnectExec( new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); if (earlyHintsListener != null) { addExecInterceptorBefore(ChainElement.PROTOCOL.name(), "early-hints", new EarlyHintsAsyncExec(earlyHintsListener)); } execChainDefinition.addFirst( new AsyncProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncHttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } if (!contentCompressionDisabled) { if (contentDecoderMap != null && !contentDecoderMap.isEmpty()) { execChainDefinition.addFirst( new ContentCompressionAsyncExec(contentDecoderMap), ChainElement.COMPRESS.name()); } else { execChainDefinition.addFirst( new ContentCompressionAsyncExec(), ChainElement.COMPRESS.name()); } } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } if (proxy != null) { routePlannerCopy = new DefaultProxyRoutePlanner(proxy, schemePortResolverCopy); } else if (this.proxySelector != null) { routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, this.proxySelector); } else if (systemProperties) { final ProxySelector defaultProxySelector = AccessController.doPrivileged((PrivilegedAction) ProxySelector::getDefault); routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, defaultProxySelector); } else { routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncRedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (!this.connManagerShared) { if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictExpiredConnections || evictIdleConnections) { if (connManagerCopy instanceof ConnPoolControl) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl) connManagerCopy, null, evictIdleConnections ? maxIdleTime : null); closeablesCopy.add(connectionEvictor::shutdown); connectionEvictor.start(); } } closeablesCopy.add(connManagerCopy); } ConnectionReuseStrategy reuseStrategyCopy = this.reuseStrategy; if (reuseStrategyCopy == null) { if (systemProperties) { final String s = getProperty("http.keepAlive", "true"); if ("true".equalsIgnoreCase(s)) { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } else { reuseStrategyCopy = (request, response, context) -> false; } } else { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } } final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); final IOEventHandlerFactory ioEventHandlerFactory = new HttpAsyncClientProtocolNegotiationStarter( HttpProcessorBuilder.create().build(), (request, context) -> pushConsumerRegistry.get(request), h2Config != null ? h2Config : H2Config.DEFAULT, h1Config != null ? h1Config : Http1Config.DEFAULT, charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT, reuseStrategyCopy, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE); final DefaultConnectingIOReactor ioReactor = new DefaultConnectingIOReactor( ioEventHandlerFactory, ioReactorConfig != null ? ioReactorConfig : IOReactorConfig.DEFAULT, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-dispatch", true), ioSessionDecorator != null ? ioSessionDecorator : LoggingIOSessionDecorator.INSTANCE, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE, ioSessionListener, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE)); if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after HttpAsyncMainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); AsyncExecChainElement execChain = null; while (current != null) { execChain = new AsyncExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .register(StandardAuthScheme.SCRAM_SHA_256, ScramSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null && !cookieManagementDisabled) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore cookieStoreCopy = this.cookieStore; if (cookieStoreCopy == null) { cookieStoreCopy = new BasicCookieStore(); } CredentialsProvider credentialsProviderCopy = this.credentialsProvider; if (credentialsProviderCopy == null) { if (systemProperties) { credentialsProviderCopy = new SystemDefaultCredentialsProvider(); } else { credentialsProviderCopy = new BasicCredentialsProvider(); } } return new InternalHttpAsyncClient( ioReactor, execChain, pushConsumerRegistry, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-main", true), connManagerCopy, routePlannerCopy, tlsConfig, cookieSpecRegistryCopy, authSchemeRegistryCopy, cookieStoreCopy, credentialsProviderCopy, contextAdaptor(), defaultRequestConfig, closeablesCopy); } private String getProperty(final String key, final String defaultValue) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key, defaultValue)); } } ././@LongLink0100644 0000000 0000000 00000000157 00000250600 011614 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientProtocolNegotiationStarter.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientProtocolNegotiationSt0100644 0000000 0000000 00000034167 00000250600 032730 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.Http1StreamListener; import org.apache.hc.core5.http.impl.nio.ClientHttp1IOEventHandler; import org.apache.hc.core5.http.impl.nio.ClientHttp1StreamDuplexerFactory; import org.apache.hc.core5.http.impl.nio.DefaultHttpRequestWriterFactory; import org.apache.hc.core5.http.impl.nio.DefaultHttpResponseParserFactory; import org.apache.hc.core5.http.message.RequestLine; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.NHttpMessageParserFactory; import org.apache.hc.core5.http.nio.NHttpMessageWriterFactory; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.frame.FramePrinter; import org.apache.hc.core5.http2.frame.RawFrame; import org.apache.hc.core5.http2.impl.nio.ClientH2PrefaceHandler; import org.apache.hc.core5.http2.impl.nio.ClientH2StreamMultiplexerFactory; import org.apache.hc.core5.http2.impl.nio.ClientH2UpgradeHandler; import org.apache.hc.core5.http2.impl.nio.ClientHttp1UpgradeHandler; import org.apache.hc.core5.http2.impl.nio.H2StreamListener; import org.apache.hc.core5.http2.impl.nio.HttpProtocolNegotiator; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class HttpAsyncClientProtocolNegotiationStarter implements IOEventHandlerFactory { private static final Logger STREAM_LOG = LoggerFactory.getLogger(InternalHttpAsyncClient.class); private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger FRAME_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame"); private static final Logger FRAME_PAYLOAD_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame.payload"); private static final Logger FLOW_CTRL_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.flow"); private final HttpProcessor httpProcessor; private final HandlerFactory exchangeHandlerFactory; private final H2Config h2Config; private final Http1Config h1Config; private final CharCodingConfig charCodingConfig; private final ConnectionReuseStrategy http1ConnectionReuseStrategy; private final NHttpMessageParserFactory http1ResponseParserFactory; private final NHttpMessageWriterFactory http1RequestWriterFactory; private final Callback exceptionCallback; HttpAsyncClientProtocolNegotiationStarter( final HttpProcessor httpProcessor, final HandlerFactory exchangeHandlerFactory, final H2Config h2Config, final Http1Config h1Config, final CharCodingConfig charCodingConfig, final ConnectionReuseStrategy connectionReuseStrategy, final Callback exceptionCallback) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP processor"); this.exchangeHandlerFactory = exchangeHandlerFactory; this.h2Config = h2Config != null ? h2Config : H2Config.DEFAULT; this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.http1ConnectionReuseStrategy = connectionReuseStrategy != null ? connectionReuseStrategy : DefaultClientConnectionReuseStrategy.INSTANCE; this.http1ResponseParserFactory = new DefaultHttpResponseParserFactory(h1Config); this.http1RequestWriterFactory = DefaultHttpRequestWriterFactory.INSTANCE; this.exceptionCallback = exceptionCallback; } @Override public IOEventHandler createHandler(final ProtocolIOSession ioSession, final Object attachment) { final ClientHttp1StreamDuplexerFactory http1StreamHandlerFactory; final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory; if (STREAM_LOG.isDebugEnabled() || HEADER_LOG.isDebugEnabled() || FRAME_LOG.isDebugEnabled() || FRAME_PAYLOAD_LOG.isDebugEnabled() || FLOW_CTRL_LOG.isDebugEnabled()) { final String id = ioSession.getId(); http1StreamHandlerFactory = new ClientHttp1StreamDuplexerFactory( httpProcessor, h1Config, charCodingConfig, http1ConnectionReuseStrategy, http1ResponseParserFactory, http1RequestWriterFactory, new Http1StreamListener() { @Override public void onRequestHead(final HttpConnection connection, final HttpRequest request) { if (HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} >> {}", id, new RequestLine(request)); for (final Iterator
it = request.headerIterator(); it.hasNext(); ) { HEADER_LOG.debug("{} >> {}", id, it.next()); } } } @Override public void onResponseHead(final HttpConnection connection, final HttpResponse response) { if (HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} << {}", id, new StatusLine(response)); for (final Iterator
it = response.headerIterator(); it.hasNext(); ) { HEADER_LOG.debug("{} << {}", id, it.next()); } } } @Override public void onExchangeComplete(final HttpConnection connection, final boolean keepAlive) { if (STREAM_LOG.isDebugEnabled()) { if (keepAlive) { STREAM_LOG.debug("{} Connection is kept alive", id); } else { STREAM_LOG.debug("{} Connection is not kept alive", id); } } } }); http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, new H2StreamListener() { final FramePrinter framePrinter = new FramePrinter(); private void logFrameInfo(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_LOG, prefix); framePrinter.printFrameInfo(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFramePayload(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_PAYLOAD_LOG, prefix); framePrinter.printPayload(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFlowControl(final String prefix, final int streamId, final int delta, final int actualSize) { FLOW_CTRL_LOG.debug("{} stream {} flow control {} -> {}", prefix, streamId, delta, actualSize); } @Override public void onHeaderInput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} << {}", id, headers.get(i)); } } } @Override public void onHeaderOutput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} >> {}", id, headers.get(i)); } } } @Override public void onFrameInput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " <<", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " <<", frame); } } @Override public void onFrameOutput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " >>", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " >>", frame); } } @Override public void onInputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " <<", streamId, delta, actualSize); } } @Override public void onOutputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " >>", streamId, delta, actualSize); } } }); } else { http1StreamHandlerFactory = new ClientHttp1StreamDuplexerFactory( httpProcessor, h1Config, charCodingConfig, http1ConnectionReuseStrategy, http1ResponseParserFactory, http1RequestWriterFactory, null); http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, null); } ioSession.registerProtocol(ApplicationProtocol.HTTP_1_1.id, new ClientHttp1UpgradeHandler(http1StreamHandlerFactory)); ioSession.registerProtocol(ApplicationProtocol.HTTP_2.id, new ClientH2UpgradeHandler(http2StreamHandlerFactory, exceptionCallback)); final HttpVersionPolicy versionPolicy = attachment instanceof HttpVersionPolicy ? (HttpVersionPolicy) attachment : HttpVersionPolicy.NEGOTIATE; switch (versionPolicy) { case FORCE_HTTP_2: return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); case FORCE_HTTP_1: return new ClientHttp1IOEventHandler(http1StreamHandlerFactory.create(ioSession)); default: return new HttpProtocolNegotiator(ioSession, null); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClients.java0100644 0000000 0000000 00000037010 00000250600 027567 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.compat.ClassicToAsyncAdaptor; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.routing.RequestRouter; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; import org.apache.hc.core5.util.VersionInfo; /** * Factory methods for {@link CloseableHttpAsyncClient} instances. * * @since 5.0 */ public final class HttpAsyncClients { private HttpAsyncClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpAsyncClient} instances. */ public static HttpAsyncClientBuilder custom() { return HttpAsyncClientBuilder.create(); } /** * Creates {@link CloseableHttpAsyncClient} instance with default configuration. */ public static CloseableHttpAsyncClient createDefault() { return HttpAsyncClientBuilder.create().build(); } /** * Creates {@link CloseableHttpAsyncClient} instance with default * configuration and system properties. */ public static CloseableHttpAsyncClient createSystem() { return HttpAsyncClientBuilder.create().useSystemProperties().build(); } /** * Creates builder object for construction of custom HTTP/2 * {@link CloseableHttpAsyncClient} instances optimized for HTTP/2 protocol * and message multiplexing */ public static H2AsyncClientBuilder customHttp2() { return H2AsyncClientBuilder.create(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance with default configuration * optimized for HTTP/2 protocol and message multiplexing. */ public static CloseableHttpAsyncClient createHttp2Default() { return H2AsyncClientBuilder.create().build(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance with default configuration and * system properties optimized for HTTP/2 protocol and message multiplexing. */ public static CloseableHttpAsyncClient createHttp2System() { return H2AsyncClientBuilder.create().useSystemProperties().build(); } private static HttpProcessor createMinimalProtocolProcessor() { return new DefaultHttpProcessor( new H2RequestTargetHost(), new H2RequestContent(), new H2RequestConnControl(), new RequestUserAgent(VersionInfo.getSoftwareInfo( "Apache-HttpAsyncClient", "org.apache.hc.client5", HttpAsyncClients.class))); } private static MinimalHttpAsyncClient createMinimalHttpAsyncClientImpl( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr, final SchemePortResolver schemePortResolver, final TlsConfig tlsConfig) { return new MinimalHttpAsyncClient( eventHandlerFactory, pushConsumerRegistry, ioReactorConfig, new DefaultThreadFactory("httpclient-main", true), new DefaultThreadFactory("httpclient-dispatch", true), connmgr, schemePortResolver, tlsConfig); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @deprecated Use {@link #createMinimal(H2Config, Http1Config, IOReactorConfig, AsyncClientConnectionManager)} */ @Deprecated public static MinimalHttpAsyncClient createMinimal( final HttpVersionPolicy versionPolicy, final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttpAsyncClientImpl( new HttpAsyncClientProtocolNegotiationStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, h1Config, CharCodingConfig.DEFAULT, DefaultClientConnectionReuseStrategy.INSTANCE, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, connmgr, DefaultSchemePortResolver.INSTANCE, versionPolicy != null ? TlsConfig.custom().setVersionPolicy(versionPolicy).build() : null); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @since 5.2 */ public static MinimalHttpAsyncClient createMinimal( final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttpAsyncClientImpl( new HttpAsyncClientProtocolNegotiationStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, h1Config, CharCodingConfig.DEFAULT, DefaultClientConnectionReuseStrategy.INSTANCE, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, connmgr, DefaultSchemePortResolver.INSTANCE, null); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @deprecated Use {@link #createMinimal(H2Config, Http1Config, IOReactorConfig)} */ @Deprecated public static MinimalHttpAsyncClient createMinimal( final HttpVersionPolicy versionPolicy, final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig) { return createMinimal(versionPolicy, h2Config, h1Config, ioReactorConfig, PoolingAsyncClientConnectionManagerBuilder.create().build()); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal( final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig) { return createMinimal(h2Config, h1Config, ioReactorConfig, PoolingAsyncClientConnectionManagerBuilder.create().build()); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal(final H2Config h2Config, final Http1Config h1Config) { return createMinimal(HttpVersionPolicy.NEGOTIATE, h2Config, h1Config, IOReactorConfig.DEFAULT); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal() { return createMinimal(H2Config.DEFAULT, Http1Config.DEFAULT); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal(final AsyncClientConnectionManager connManager) { return createMinimal( HttpVersionPolicy.NEGOTIATE, H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT, connManager); } private static MinimalH2AsyncClient createMinimalHttp2AsyncClientImpl( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig ioReactorConfig, final DnsResolver dnsResolver, final TlsStrategy tlsStrategy) { return new MinimalH2AsyncClient( eventHandlerFactory, pushConsumerRegistry, ioReactorConfig, new DefaultThreadFactory("httpclient-main", true), new DefaultThreadFactory("httpclient-dispatch", true), dnsResolver, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig, final DnsResolver dnsResolver, final TlsStrategy tlsStrategy) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttp2AsyncClientImpl( new H2AsyncClientProtocolStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, CharCodingConfig.DEFAULT, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, dnsResolver, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig, final TlsStrategy tlsStrategy) { return createHttp2Minimal(h2Config, ioReactorConfig, SystemDefaultDnsResolver.INSTANCE, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig) { return createHttp2Minimal(h2Config, ioReactorConfig, DefaultClientTlsStrategy.createDefault()); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal(final H2Config h2Config) { return createHttp2Minimal(h2Config, IOReactorConfig.DEFAULT); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal() { return createHttp2Minimal(H2Config.DEFAULT); } /** * Creates {@link HandlerFactory} backed by a push {@link RequestRouter}. * * @since 5.4 */ public static HandlerFactory pushRouter(final RequestRouter> requestRouter) { return (request, context) -> { final Supplier supplier = requestRouter.resolve(request, context); return supplier != null ? supplier.get() : null; }; } /** * Creates an {@link CloseableHttpClient} facade backed by {@link CloseableHttpAsyncClient} * built internally and acting as a compatibility bridge between the classic APIs based * on the standard {@link java.io.InputStream} / {@link java.io.OutputStream} model * and the underlying asynchronous message transport. *

* This feature is considered experimental and may be discontinued in the future. * * @param client async client * @param operationTimeout maximum period an operation can block awaiting input / output. * * @since 5.5 */ @Experimental public static CloseableHttpClient classic(final CloseableHttpAsyncClient client, final Timeout operationTimeout) { client.start(); return new ClassicToAsyncAdaptor(client, operationTimeout); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java0100644 0000000 0000000 00000031212 00000250600 031014 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.impl.ProtocolSwitchStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last HTTP/1.1 request execution handler in the asynchronous * request execution chain that is responsible for execution of * request/response exchanges with the opposite endpoint. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal class HttpAsyncMainClientExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(HttpAsyncMainClientExec.class); private final HttpProcessor httpProcessor; private final ConnectionKeepAliveStrategy keepAliveStrategy; private final UserTokenHandler userTokenHandler; private final ProtocolSwitchStrategy protocolSwitchStrategy; HttpAsyncMainClientExec(final HttpProcessor httpProcessor, final ConnectionKeepAliveStrategy keepAliveStrategy, final UserTokenHandler userTokenHandler) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); this.keepAliveStrategy = keepAliveStrategy; this.userTokenHandler = userTokenHandler; this.protocolSwitchStrategy = new ProtocolSwitchStrategy(); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } final AtomicInteger messageCountDown = new AtomicInteger(2); final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } @Override public void cancel() { if (messageCountDown.get() > 0) { failed(new InterruptedIOException()); } } @Override public void produceRequest( final RequestChannel channel, final HttpContext context) throws HttpException, IOException { clientContext.setRoute(route); clientContext.setRequest(request); httpProcessor.process(request, entityProducer, clientContext); channel.sendRequest(request, entityProducer, context); if (entityProducer == null) { messageCountDown.decrementAndGet(); } } @Override public int available() { return entityProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { entityProducer.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { return channel.write(src); } @Override public void endStream(final List trailers) throws IOException { channel.endStream(trailers); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } @Override public void endStream() throws IOException { channel.endStream(); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) throws HttpException, IOException { if (response.getCode() == HttpStatus.SC_SWITCHING_PROTOCOLS) { final ProtocolVersion upgradeProtocol = protocolSwitchStrategy.switchProtocol(response); if (upgradeProtocol == null || !upgradeProtocol.getProtocol().equals("TLS")) { throw new ProtocolException("Failure switching protocols"); } if (LOG.isDebugEnabled()) { LOG.debug("Switching to {}", upgradeProtocol); } execRuntime.upgradeTls(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime result) { LOG.debug("Successfully switched to {}", upgradeProtocol); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } }); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { clientContext.setResponse(response); httpProcessor.process(response, entityDetails, clientContext); entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { messageCountDown.decrementAndGet(); } final TimeValue keepAliveDuration = keepAliveStrategy.getKeepAliveDuration(response, clientContext); Object userToken = clientContext.getUserToken(); if (userToken == null) { userToken = userTokenHandler.getUserToken(route, request, clientContext); clientContext.setUserToken(userToken); } execRuntime.markConnectionReusable(userToken, keepAliveDuration); if (entityDetails == null) { execRuntime.validateConnection(); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } else { execRuntime.validateConnection(); } if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalAbstractHttpAsyncClient.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalAbstractHttpAsyncClient.java0100644 0000000 0000000 00000047064 00000250600 032577 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.io.IOException; import java.util.List; import java.util.Set; import java.util.concurrent.CancellationException; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import java.util.function.Function; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; abstract class InternalAbstractHttpAsyncClient extends AbstractHttpAsyncClientBase { private final static ThreadFactory SCHEDULER_THREAD_FACTORY = new DefaultThreadFactory("Scheduled-executor", true); private static final Logger LOG = LoggerFactory.getLogger(InternalAbstractHttpAsyncClient.class); private final AsyncExecChainElement execChain; private final Lookup cookieSpecRegistry; private final Lookup authSchemeRegistry; private final CookieStore cookieStore; private final CredentialsProvider credentialsProvider; private final Function contextAdaptor; private final RequestConfig defaultConfig; private final ConcurrentLinkedQueue closeables; private final ScheduledExecutorService scheduledExecutorService; private final AsyncExecChain.Scheduler scheduler; InternalAbstractHttpAsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final AsyncExecChainElement execChain, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final Function contextAdaptor, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory); this.execChain = execChain; this.cookieSpecRegistry = cookieSpecRegistry; this.authSchemeRegistry = authSchemeRegistry; this.cookieStore = cookieStore; this.credentialsProvider = credentialsProvider; this.contextAdaptor = contextAdaptor; this.defaultConfig = defaultConfig; this.closeables = closeables != null ? new ConcurrentLinkedQueue<>(closeables) : null; this.scheduledExecutorService = Executors.newSingleThreadScheduledExecutor(SCHEDULER_THREAD_FACTORY); this.scheduler = new AsyncExecChain.Scheduler() { @Override public void scheduleExecution( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { executeScheduled(request, entityProducer, scope, execChain::execute, asyncExecCallback, delay); } @Override public void scheduleExecution( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { executeScheduled(request, entityProducer, scope, chain, asyncExecCallback, delay); } }; } @Override void internalClose(final CloseMode closeMode) { if (this.closeables != null) { Closeable closeable; while ((closeable = this.closeables.poll()) != null) { try { if (closeable instanceof ModalCloseable) { ((ModalCloseable) closeable).close(closeMode); } else { closeable.close(); } } catch (final IOException ex) { LOG.error(ex.getMessage(), ex); } } } final List runnables = this.scheduledExecutorService.shutdownNow(); for (final Runnable runnable: runnables) { if (runnable instanceof Cancellable) { ((Cancellable) runnable).cancel(); } } } private void setupContext(final HttpClientContext context) { if (context.getAuthSchemeRegistry() == null) { context.setAuthSchemeRegistry(authSchemeRegistry); } if (context.getCookieSpecRegistry() == null) { context.setCookieSpecRegistry(cookieSpecRegistry); } if (context.getCookieStore() == null) { context.setCookieStore(cookieStore); } if (context.getCredentialsProvider() == null) { context.setCredentialsProvider(credentialsProvider); } if (context.getRequestConfig() == null) { context.setRequestConfig(defaultConfig); } } abstract AsyncExecRuntime createAsyncExecRuntime(HandlerFactory pushHandlerFactory); abstract HttpRoute determineRoute(HttpHost httpHost, HttpRequest request, HttpClientContext clientContext) throws HttpException; @Override protected Future doExecute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final ComplexFuture future = new ComplexFuture<>(callback); try { if (!isRunning()) { throw new CancellationException("Request execution cancelled"); } final HttpClientContext clientContext = contextAdaptor.apply(context); requestProducer.sendRequest((request, entityDetails, c) -> { RequestConfig requestConfig = null; if (request instanceof Configurable) { requestConfig = ((Configurable) request).getConfig(); } if (requestConfig != null) { clientContext.setRequestConfig(requestConfig); } setupContext(clientContext); final HttpHost resolvedTarget = target != null ? target : RoutingSupport.determineHost(request); if (resolvedTarget != null) { if (request.getScheme() == null) { request.setScheme(resolvedTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(resolvedTarget)); } } final HttpRoute route = determineRoute( resolvedTarget, request, clientContext); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} preparing request execution", exchangeId); } final AsyncExecRuntime execRuntime = createAsyncExecRuntime(pushHandlerFactory); final AsyncExecChain.Scope scope = new AsyncExecChain.Scope(exchangeId, route, request, future, clientContext, execRuntime, scheduler, new AtomicInteger(1)); final AtomicBoolean outputTerminated = new AtomicBoolean(false); executeImmediate( BasicRequestBuilder.copy(request).build(), entityDetails != null ? new AsyncEntityProducer() { @Override public void releaseResources() { requestProducer.releaseResources(); } @Override public void failed(final Exception cause) { requestProducer.failed(cause); } @Override public boolean isRepeatable() { return requestProducer.isRepeatable(); } @Override public long getContentLength() { return entityDetails.getContentLength(); } @Override public String getContentType() { return entityDetails.getContentType(); } @Override public String getContentEncoding() { return entityDetails.getContentEncoding(); } @Override public boolean isChunked() { return entityDetails.isChunked(); } @Override public Set getTrailerNames() { return entityDetails.getTrailerNames(); } @Override public int available() { return requestProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (outputTerminated.get()) { channel.endStream(); return; } requestProducer.produce(channel); } } : null, scope, execChain::execute, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { outputTerminated.set(true); requestProducer.releaseResources(); } responseConsumer.consumeResponse(response, entityDetails, c, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }); return entityDetails != null ? responseConsumer : null; } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { responseConsumer.informationResponse(response, c); } @Override public void completed() { if (LOG.isDebugEnabled()) { LOG.debug("{} message exchange successfully completed", exchangeId); } try { execRuntime.releaseEndpoint(); } finally { responseConsumer.releaseResources(); requestProducer.releaseResources(); } } @Override public void failed(final Exception cause) { if (LOG.isDebugEnabled()) { LOG.debug("{} request failed: {}", exchangeId, cause.getMessage()); } try { execRuntime.discardEndpoint(); responseConsumer.failed(cause); } finally { try { future.failed(cause); } finally { responseConsumer.releaseResources(); requestProducer.releaseResources(); } } } }); }, clientContext); } catch (final HttpException | IOException | IllegalStateException ex) { future.failed(ex); } return future; } void executeImmediate( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { chain.proceed(request, entityProducer, scope, asyncExecCallback); } void executeScheduled( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { final ScheduledRequestExecution scheduledTask = new ScheduledRequestExecution( request, entityProducer, scope, chain, asyncExecCallback, delay); if (TimeValue.isPositive(delay)) { scheduledExecutorService.schedule(scheduledTask, delay.getDuration(), delay.getTimeUnit()); } else { scheduledExecutorService.execute(scheduledTask); } } class ScheduledRequestExecution implements Runnable, Cancellable { final HttpRequest request; final AsyncEntityProducer entityProducer; final AsyncExecChain.Scope scope; final AsyncExecChain chain; final AsyncExecCallback asyncExecCallback; final TimeValue delay; ScheduledRequestExecution(final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { this.request = request; this.entityProducer = entityProducer; this.scope = scope; this.chain = chain; this.asyncExecCallback = asyncExecCallback; this.delay = delay; } @Override public void run() { try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final Exception ex) { asyncExecCallback.failed(ex); } } @Override public boolean cancel() { asyncExecCallback.failed(new CancellationException("Request execution cancelled")); return true; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalH2AsyncClient.java0100644 0000000 0000000 00000011022 00000250600 030426 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.util.List; import java.util.concurrent.ThreadFactory; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal implementation of HTTP/2 only {@link CloseableHttpAsyncClient}. *

* Concurrent message exchanges with the same connection route executed by * this client will get automatically multiplexed over a single physical HTTP/2 * connection. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) @Internal public final class InternalH2AsyncClient extends InternalAbstractHttpAsyncClient { private static final Logger LOG = LoggerFactory.getLogger(InternalH2AsyncClient.class); private final HttpRoutePlanner routePlanner; private final InternalH2ConnPool connPool; InternalH2AsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncExecChainElement execChain, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final InternalH2ConnPool connPool, final HttpRoutePlanner routePlanner, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory, execChain, cookieSpecRegistry, authSchemeRegistry, cookieStore, credentialsProvider, HttpClientContext::castOrCreate, defaultConfig, closeables); this.connPool = connPool; this.routePlanner = routePlanner; } @Override AsyncExecRuntime createAsyncExecRuntime(final HandlerFactory pushHandlerFactory) { return new InternalH2AsyncExecRuntime(LOG, connPool, pushHandlerFactory); } @Override HttpRoute determineRoute(final HttpHost httpHost, final HttpRequest request, final HttpClientContext clientContext) throws HttpException { final HttpRoute route = routePlanner.determineRoute(httpHost, request, clientContext); if (route.isTunnelled()) { throw new HttpException("HTTP/2 tunneling not supported"); } return route; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalH2AsyncExecRuntime.java0100644 0000000 0000000 00000027452 00000250600 031456 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.InterruptedIOException; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalH2AsyncExecRuntime implements AsyncExecRuntime { private final Logger log; private final InternalH2ConnPool connPool; private final HandlerFactory pushHandlerFactory; private final AtomicReference sessionRef; private volatile boolean reusable; InternalH2AsyncExecRuntime( final Logger log, final InternalH2ConnPool connPool, final HandlerFactory pushHandlerFactory) { super(); this.log = log; this.connPool = connPool; this.pushHandlerFactory = pushHandlerFactory; this.sessionRef = new AtomicReference<>(); } @Override public boolean isEndpointAcquired() { return sessionRef.get() != null; } @Override public Cancellable acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context, final FutureCallback callback) { if (sessionRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectTimeout); } return Operations.cancellable(connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} acquired endpoint", id); } callback.completed(InternalH2AsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } callback.completed(this); return Operations.nonCancellable(); } private void closeEndpoint(final Endpoint endpoint) { endpoint.session.close(CloseMode.GRACEFUL); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } @Override public void releaseEndpoint() { final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null && !reusable) { closeEndpoint(endpoint); } } @Override public void discardEndpoint() { final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null) { closeEndpoint(endpoint); } } @Override public boolean validateConnection() { if (reusable) { final Endpoint endpoint = sessionRef.get(); return endpoint != null && endpoint.session.isOpen(); } final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null) { closeEndpoint(endpoint); } return false; } @Override public boolean isEndpointConnected() { final Endpoint endpoint = sessionRef.get(); return endpoint != null && endpoint.session.isOpen(); } Endpoint ensureValid() { final Endpoint endpoint = sessionRef.get(); if (endpoint == null) { throw new IllegalStateException("I/O session not acquired / already released"); } return endpoint; } @Override public Cancellable connectEndpoint( final HttpClientContext context, final FutureCallback callback) { final Endpoint endpoint = ensureValid(); if (endpoint.session.isOpen()) { callback.completed(this); return Operations.nonCancellable(); } final HttpRoute route = endpoint.route; final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } return Operations.cancellable(connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } callback.completed(InternalH2AsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } @Override public void disconnectEndpoint() { final Endpoint endpoint = sessionRef.get(); if (endpoint != null) { endpoint.session.close(CloseMode.GRACEFUL); } } @Override public void upgradeTls(final HttpClientContext context) { throw new UnsupportedOperationException(); } @Override public void upgradeTls(final HttpClientContext context, final FutureCallback callback) { throw new UnsupportedOperationException(); } @Override public EndpointInfo getEndpointInfo() { final Endpoint endpoint = sessionRef.get(); if (endpoint != null && endpoint.session.isOpen()) { if (endpoint.session instanceof TransportSecurityLayer) { final TlsDetails tlsDetails = ((TransportSecurityLayer) endpoint.session).getTlsDetails(); return new EndpointInfo(HttpVersion.HTTP_2, tlsDetails != null ? tlsDetails.getSSLSession() : null); } } return null; } @Override public Cancellable execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpClientContext context) { final ComplexCancellable complexCancellable = new ComplexCancellable(); final Endpoint endpoint = ensureValid(); final IOSession session = endpoint.session; if (session.isOpen()) { if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } context.setProtocolVersion(HttpVersion.HTTP_2); session.enqueue( new RequestExecutionCommand(exchangeHandler, pushHandlerFactory, complexCancellable, context), Command.Priority.NORMAL); } else { final HttpRoute route = endpoint.route; final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } context.setProtocolVersion(HttpVersion.HTTP_2); session.enqueue( new RequestExecutionCommand(exchangeHandler, pushHandlerFactory, complexCancellable, context), Command.Priority.NORMAL); } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.failed(new InterruptedIOException()); } }); } return complexCancellable; } @Override public void markConnectionReusable(final Object newState, final TimeValue newValidDuration) { throw new UnsupportedOperationException(); } @Override public void markConnectionNonReusable() { reusable = false; } static class Endpoint implements Identifiable { final HttpRoute route; final IOSession session; Endpoint(final HttpRoute route, final IOSession session) { this.route = route; this.session = session; } @Override public String getId() { return session.getId(); } } @Override public AsyncExecRuntime fork() { return new InternalH2AsyncExecRuntime(log, connPool, pushHandlerFactory); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalH2ConnPool.java0100644 0000000 0000000 00000022334 00000250600 027751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.net.InetSocketAddress; import java.util.concurrent.Future; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.nio.command.PingCommand; import org.apache.hc.core5.http2.nio.support.BasicPingHandler; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.AbstractIOSessionPool; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; class InternalH2ConnPool implements ModalCloseable { private final SessionPool sessionPool; private volatile Resolver connectionConfigResolver; InternalH2ConnPool(final ConnectionInitiator connectionInitiator, final Resolver addressResolver, final TlsStrategy tlsStrategy) { this.sessionPool = new SessionPool(connectionInitiator, addressResolver, tlsStrategy); } @Override public void close(final CloseMode closeMode) { sessionPool.close(closeMode); } @Override public void close() { sessionPool.close(); } private ConnectionConfig resolveConnectionConfig(final HttpHost httpHost) { final Resolver resolver = this.connectionConfigResolver; final ConnectionConfig connectionConfig = resolver != null ? resolver.resolve(httpHost) : null; return connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } public Future getSession( final HttpRoute route, final Timeout connectTimeout, final FutureCallback callback) { final ConnectionConfig connectionConfig = resolveConnectionConfig(route.getTargetHost()); return sessionPool.getSession( route, connectTimeout != null ? connectTimeout : connectionConfig.getConnectTimeout(), new CallbackContribution(callback) { @Override public void completed(final IOSession ioSession) { final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { ioSession.setSocketTimeout(socketTimeout); } callback.completed(ioSession); } }); } public void closeIdle(final TimeValue idleTime) { sessionPool.closeIdle(idleTime); } public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; } public TimeValue getValidateAfterInactivity() { return sessionPool.validateAfterInactivity; } public void setValidateAfterInactivity(final TimeValue timeValue) { sessionPool.validateAfterInactivity = timeValue; } static class SessionPool extends AbstractIOSessionPool { private final ConnectionInitiator connectionInitiator; private final Resolver addressResolver; private final TlsStrategy tlsStrategy; private volatile TimeValue validateAfterInactivity = TimeValue.NEG_ONE_MILLISECOND; SessionPool(final ConnectionInitiator connectionInitiator, final Resolver addressResolver, final TlsStrategy tlsStrategy) { this.connectionInitiator = connectionInitiator; this.addressResolver = addressResolver; this.tlsStrategy = tlsStrategy; } @Override protected Future connectSession(final HttpRoute route, final Timeout connectTimeout, final FutureCallback callback) { final HttpHost target = route.getTargetHost(); final InetSocketAddress localAddress = route.getLocalSocketAddress(); final InetSocketAddress remoteAddress = addressResolver.resolve(target); return connectionInitiator.connect( target, remoteAddress, localAddress, connectTimeout, null, new CallbackContribution(callback) { @Override public void completed(final IOSession ioSession) { if (tlsStrategy != null && URIScheme.HTTPS.same(target.getSchemeName()) && ioSession instanceof TransportSecurityLayer) { final NamedEndpoint tlsName = route.getTargetName() != null ? route.getTargetName() : target; tlsStrategy.upgrade( (TransportSecurityLayer) ioSession, tlsName, null, connectTimeout, new CallbackContribution(callback) { @Override public void completed(final TransportSecurityLayer transportSecurityLayer) { callback.completed(ioSession); } }); ioSession.setSocketTimeout(connectTimeout); } else { callback.completed(ioSession); } } }); } @Override protected void validateSession(final IOSession ioSession, final Callback callback) { if (ioSession.isOpen()) { final TimeValue timeValue = validateAfterInactivity; if (TimeValue.isNonNegative(timeValue)) { final long lastAccessTime = Math.min(ioSession.getLastReadTime(), ioSession.getLastWriteTime()); final long deadline = lastAccessTime + timeValue.toMilliseconds(); if (deadline <= System.currentTimeMillis()) { final Timeout socketTimeoutMillis = ioSession.getSocketTimeout(); ioSession.enqueue(new PingCommand(new BasicPingHandler(result -> { ioSession.setSocketTimeout(socketTimeoutMillis); callback.execute(result); })), Command.Priority.NORMAL); return; } } callback.execute(true); } else { callback.execute(false); } } @Override protected void closeSession(final IOSession ioSession, final CloseMode closeMode) { if (closeMode == CloseMode.GRACEFUL) { ioSession.enqueue(ShutdownCommand.GRACEFUL, Command.Priority.NORMAL); } else { ioSession.close(closeMode); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalHttpAsyncClient.java0100644 0000000 0000000 00000011646 00000250600 031110 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.util.List; import java.util.concurrent.ThreadFactory; import java.util.function.Function; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal implementation of {@link CloseableHttpAsyncClient} that can negotiate * the most optimal HTTP protocol version during during the {@code TLS} handshake * with {@code ALPN} extension if supported by the Java runtime. *

* Concurrent message exchanges executed by this client will get assigned to * separate connections leased from the connection pool. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) @Internal public final class InternalHttpAsyncClient extends InternalAbstractHttpAsyncClient { private static final Logger LOG = LoggerFactory.getLogger(InternalHttpAsyncClient.class); private final AsyncClientConnectionManager manager; private final HttpRoutePlanner routePlanner; private final TlsConfig tlsConfig; InternalHttpAsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncExecChainElement execChain, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final AsyncClientConnectionManager manager, final HttpRoutePlanner routePlanner, final TlsConfig tlsConfig, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final Function contextAdaptor, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory, execChain, cookieSpecRegistry, authSchemeRegistry, cookieStore, credentialsProvider, contextAdaptor, defaultConfig, closeables); this.manager = manager; this.routePlanner = routePlanner; this.tlsConfig = tlsConfig; } @Override AsyncExecRuntime createAsyncExecRuntime(final HandlerFactory pushHandlerFactory) { return new InternalHttpAsyncExecRuntime(LOG, manager, getConnectionInitiator(), pushHandlerFactory, tlsConfig); } @Override HttpRoute determineRoute(final HttpHost httpHost, final HttpRequest request, final HttpClientContext clientContext) throws HttpException { return routePlanner.determineRoute(httpHost, request, clientContext); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalHttpAsyncExecRuntime.java0100644 0000000 0000000 00000034055 00000250600 032121 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.InterruptedIOException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalHttpAsyncExecRuntime implements AsyncExecRuntime { static class ReUseData { final Object state; final TimeValue validDuration; ReUseData(final Object state, final TimeValue validDuration) { this.state = state; this.validDuration = validDuration; } } private final Logger log; private final AsyncClientConnectionManager manager; private final ConnectionInitiator connectionInitiator; private final HandlerFactory pushHandlerFactory; /** * @deprecated TLS should be configured by the connection manager */ @Deprecated private final TlsConfig tlsConfig; private final AtomicReference endpointRef; private final AtomicReference reuseDataRef; InternalHttpAsyncExecRuntime( final Logger log, final AsyncClientConnectionManager manager, final ConnectionInitiator connectionInitiator, final HandlerFactory pushHandlerFactory, final TlsConfig tlsConfig) { super(); this.log = log; this.manager = manager; this.connectionInitiator = connectionInitiator; this.pushHandlerFactory = pushHandlerFactory; this.tlsConfig = tlsConfig; this.endpointRef = new AtomicReference<>(); this.reuseDataRef = new AtomicReference<>(); } @Override public boolean isEndpointAcquired() { return endpointRef.get() != null; } @Override public Cancellable acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context, final FutureCallback callback) { if (endpointRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectionRequestTimeout); } return Operations.cancellable(manager.lease( id, route, object, connectionRequestTimeout, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { endpointRef.set(connectionEndpoint); if (log.isDebugEnabled()) { log.debug("{} acquired endpoint {}", id, ConnPoolSupport.getId(connectionEndpoint)); } callback.completed(InternalHttpAsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } callback.completed(this); return Operations.nonCancellable(); } private void discardEndpoint(final AsyncConnectionEndpoint endpoint) { try { endpoint.close(CloseMode.IMMEDIATE); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } finally { if (log.isDebugEnabled()) { log.debug("{} discarding endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, null, TimeValue.ZERO_MILLISECONDS); } } @Override public void releaseEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { final ReUseData reUseData = reuseDataRef.getAndSet(null); if (reUseData != null) { if (log.isDebugEnabled()) { log.debug("{} releasing valid endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, reUseData.state, reUseData.validDuration); } else { discardEndpoint(endpoint); } } } @Override public void discardEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } } @Override public boolean validateConnection() { if (reuseDataRef != null) { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } return false; } AsyncConnectionEndpoint ensureValid() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); if (endpoint == null) { throw new IllegalStateException("Endpoint not acquired / already released"); } return endpoint; } @Override public boolean isEndpointConnected() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } @Override public Cancellable connectEndpoint( final HttpClientContext context, final FutureCallback callback) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (endpoint.isConnected()) { callback.completed(this); return Operations.nonCancellable(); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } return Operations.cancellable(manager.connect( endpoint, connectionInitiator, connectTimeout, tlsConfig, context, new CallbackContribution(callback) { @Override public void completed(final AsyncConnectionEndpoint endpoint) { if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } if (callback != null) { callback.completed(InternalHttpAsyncExecRuntime.this); } } })); } @Override public void disconnectEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); if (endpoint != null) { endpoint.close(CloseMode.GRACEFUL); } } @Override public void upgradeTls(final HttpClientContext context) { upgradeTls(context, null); } @Override public void upgradeTls(final HttpClientContext context, final FutureCallback callback) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (log.isDebugEnabled()) { log.debug("{} upgrading endpoint", ConnPoolSupport.getId(endpoint)); } manager.upgrade(endpoint, tlsConfig, context, new CallbackContribution(callback) { @Override public void completed(final AsyncConnectionEndpoint endpoint) { if (callback != null) { callback.completed(InternalHttpAsyncExecRuntime.this); } } }); } @Override public EndpointInfo getEndpointInfo() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null ? endpoint.getInfo() : null; } private Cancellable doExecute( final String id, final AsyncConnectionEndpoint endpoint, final AsyncClientExchangeHandler exchangeHandler, final HttpClientContext context) { if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); final EndpointInfo endpointInfo = endpoint.getInfo(); final ProtocolVersion version = endpointInfo != null ? endpointInfo.getProtocol() : null; final boolean isH2 = version != null && version.greaterEquals(HttpVersion.HTTP_2); if (!isH2 && responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } endpoint.execute(id, exchangeHandler, pushHandlerFactory, context); if (requestConfig.isHardCancellationEnabled()) { return new Cancellable() { private final AtomicBoolean cancelled = new AtomicBoolean(); @Override public boolean cancel() { if (cancelled.compareAndSet(false, true)) { exchangeHandler.cancel(); return true; } return false; } }; } else { return Operations.nonCancellable(); } } @Override public Cancellable execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpClientContext context) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (endpoint.isConnected()) { return doExecute(id, endpoint, exchangeHandler, context); } else { final ComplexCancellable complexCancellable = new ComplexCancellable(); final Cancellable connectCancellable = connectEndpoint(context, new FutureCallback() { @Override public void completed(final AsyncExecRuntime runtime) { try { final Cancellable executeCancellable = doExecute(id, endpoint, exchangeHandler, context); complexCancellable.setDependency(executeCancellable); } catch (final RuntimeException ex) { failed(ex); } } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.failed(new InterruptedIOException()); } }); complexCancellable.setDependency(connectCancellable); return complexCancellable; } } @Override public void markConnectionReusable(final Object newState, final TimeValue newValidDuration) { reuseDataRef.set(new ReUseData(newState, newValidDuration)); } @Override public void markConnectionNonReusable() { reuseDataRef.set(null); } @Override public AsyncExecRuntime fork() { return new InternalHttpAsyncExecRuntime(log, manager, connectionInitiator, pushHandlerFactory, tlsConfig); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LogAppendable.java0100644 0000000 0000000 00000004615 00000250600 027032 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.slf4j.Logger; final class LogAppendable implements Appendable { private final Logger log; private final String prefix; private final StringBuilder buffer; public LogAppendable(final Logger log, final String prefix) { this.log = log; this.prefix = prefix; this.buffer = new StringBuilder(); } @Override public Appendable append(final CharSequence text) throws IOException { return append(text, 0, text.length()); } @Override public Appendable append(final CharSequence text, final int start, final int end) throws IOException { for (int i = start; i < end; i++) { append(text.charAt(i)); } return this; } @Override public Appendable append(final char ch) throws IOException { if (ch == '\n') { log.debug("{} {}", prefix, buffer); buffer.setLength(0); } else if (ch != '\r') { buffer.append(ch); } return this; } public void flush() { if (buffer.length() > 0) { log.debug("{} {}", prefix, buffer); buffer.setLength(0); } } } ././@LongLink0100644 0000000 0000000 00000000147 00000250600 011613 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingAsyncClientExchangeHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingAsyncClientExchangeHandler.ja0100644 0000000 0000000 00000014645 00000250600 032476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Identifiable; import org.slf4j.Logger; final class LoggingAsyncClientExchangeHandler implements AsyncClientExchangeHandler, Identifiable { private final Logger log; private final String exchangeId; private final AsyncClientExchangeHandler handler; LoggingAsyncClientExchangeHandler(final Logger log, final String exchangeId, final AsyncClientExchangeHandler handler) { this.log = log; this.exchangeId = exchangeId; this.handler = handler; } @Override public String getId() { return exchangeId; } @Override public void releaseResources() { handler.releaseResources(); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { handler.produceRequest((request, entityDetails, context1) -> { if (log.isDebugEnabled()) { log.debug("{} send request {} {}, {}", exchangeId, request.getMethod(), request.getRequestUri(), entityDetails != null ? "entity len " + entityDetails.getContentLength() : "null entity"); } channel.sendRequest(request, entityDetails, context1); }, context); } @Override public int available() { return handler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: produce request data", exchangeId); } handler.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: produce request data, len {} bytes", exchangeId, src.remaining()); } return channel.write(src); } @Override public void endStream() throws IOException { if (log.isDebugEnabled()) { log.debug("{}: end of request data", exchangeId); } channel.endStream(); } @Override public void endStream(final List trailers) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: end of request data", exchangeId); } channel.endStream(trailers); } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: information response {}", exchangeId, response.getCode()); } handler.consumeInformation(response, context); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: consume response {}, {}", exchangeId, response.getCode(), entityDetails != null ? "entity len " + entityDetails.getContentLength() : " null entity"); } handler.consumeResponse(response, entityDetails, context); } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { handler.updateCapacity(increment -> { if (log.isDebugEnabled()) { log.debug("{} capacity update {}", exchangeId, increment); } capacityChannel.update(increment); }); } @Override public void consume(final ByteBuffer src) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: consume response data, len {} bytes", exchangeId, src.remaining()); } handler.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: end of response data", exchangeId); } handler.streamEnd(trailers); } @Override public void failed(final Exception cause) { if (log.isDebugEnabled()) { log.debug("{}: execution failed: {}", exchangeId, cause.getMessage()); } handler.failed(cause); } @Override public void cancel() { if (log.isDebugEnabled()) { log.debug("{}: execution cancelled", exchangeId); } handler.cancel(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingExceptionCallback.java0100644 0000000 0000000 00000003435 00000250600 031216 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.core5.function.Callback; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class LoggingExceptionCallback implements Callback { /** * Singleton instance of LoggingExceptionCallback. */ static final LoggingExceptionCallback INSTANCE = new LoggingExceptionCallback(); private static final Logger LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.impl.async"); private LoggingExceptionCallback() { } @Override public void execute(final Exception ex) { LOG.error(ex.getMessage(), ex); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingIOSession.java0100644 0000000 0000000 00000023155 00000250600 027517 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.net.SocketAddress; import java.nio.ByteBuffer; import java.nio.channels.ByteChannel; import java.nio.channels.SelectionKey; import java.util.concurrent.locks.Lock; import org.apache.hc.core5.http.Chars; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class LoggingIOSession implements IOSession { private final Logger log; private final Logger wireLog; private final IOSession session; public LoggingIOSession(final IOSession session, final Logger log, final Logger wireLog) { super(); this.session = session; this.log = log; this.wireLog = wireLog; } @Override public String getId() { return session.getId(); } @Override public Lock getLock() { return session.getLock(); } @Override public boolean hasCommands() { return session.hasCommands(); } @Override public Command poll() { return session.poll(); } @Override public void enqueue(final Command command, final Command.Priority priority) { session.enqueue(command, priority); if (log.isDebugEnabled()) { log.debug("{} Enqueued {} with priority {}", session, command.getClass().getSimpleName(), priority); } } @Override public ByteChannel channel() { return session.channel(); } @Override public SocketAddress getLocalAddress() { return session.getLocalAddress(); } @Override public SocketAddress getRemoteAddress() { return session.getRemoteAddress(); } @Override public int getEventMask() { return session.getEventMask(); } private static String formatOps(final int ops) { final StringBuilder buffer = new StringBuilder(6); buffer.append('['); if ((ops & SelectionKey.OP_READ) > 0) { buffer.append('r'); } if ((ops & SelectionKey.OP_WRITE) > 0) { buffer.append('w'); } if ((ops & SelectionKey.OP_ACCEPT) > 0) { buffer.append('a'); } if ((ops & SelectionKey.OP_CONNECT) > 0) { buffer.append('c'); } buffer.append(']'); return buffer.toString(); } @Override public void setEventMask(final int ops) { session.setEventMask(ops); if (log.isDebugEnabled()) { log.debug("{} Event mask set {}", session, formatOps(ops)); } } @Override public void setEvent(final int op) { session.setEvent(op); if (log.isDebugEnabled()) { log.debug("{} Event set {}", session, formatOps(op)); } } @Override public void clearEvent(final int op) { session.clearEvent(op); if (log.isDebugEnabled()) { log.debug("{} Event cleared {}", session, formatOps(op)); } } @Override public boolean isOpen() { return session.isOpen(); } @Override public void close() { if (log.isDebugEnabled()) { log.debug("{} Close", session); } session.close(); } @Override public Status getStatus() { return session.getStatus(); } @Override public void close(final CloseMode closeMode) { if (log.isDebugEnabled()) { log.debug("{} Close {}", session, closeMode); } session.close(closeMode); } @Override public Timeout getSocketTimeout() { return session.getSocketTimeout(); } @Override public void setSocketTimeout(final Timeout timeout) { if (log.isDebugEnabled()) { log.debug("{} Set timeout {}", session, timeout); } session.setSocketTimeout(timeout); } @Override public long getLastReadTime() { return session.getLastReadTime(); } @Override public long getLastWriteTime() { return session.getLastWriteTime(); } @Override public void updateReadTime() { session.updateReadTime(); } @Override public void updateWriteTime() { session.updateWriteTime(); } @Override public long getLastEventTime() { return session.getLastEventTime(); } @Override public IOEventHandler getHandler() { return session.getHandler(); } @Override public void upgrade(final IOEventHandler handler) { Args.notNull(handler, "Protocol handler"); if (log.isDebugEnabled()) { log.debug("{} protocol upgrade {}", session, handler.getClass()); } session.upgrade(new IOEventHandler() { @Override public void connected(final IOSession protocolSession) throws IOException { handler.connected(protocolSession); } @Override public void inputReady(final IOSession protocolSession, final ByteBuffer src) throws IOException { if (src != null && wireLog.isDebugEnabled()) { final ByteBuffer b = src.duplicate(); logData(b, "<< "); } handler.inputReady(protocolSession, src); } @Override public void outputReady(final IOSession protocolSession) throws IOException { handler.outputReady(protocolSession); } @Override public void timeout(final IOSession protocolSession, final Timeout timeout) throws IOException { handler.timeout(protocolSession, timeout); } @Override public void exception(final IOSession protocolSession, final Exception cause) { handler.exception(protocolSession, cause); } @Override public void disconnected(final IOSession protocolSession) { handler.disconnected(protocolSession); } }); } void logData(final ByteBuffer data, final String prefix) { final byte[] line = new byte[16]; final StringBuilder buf = new StringBuilder(); while (data.hasRemaining()) { buf.setLength(0); buf.append(session).append(" ").append(prefix); final int chunk = Math.min(data.remaining(), line.length); data.get(line, 0, chunk); for (int i = 0; i < chunk; i++) { final char ch = (char) line[i]; if (ch > Chars.SP && ch < Chars.DEL) { buf.append(ch); } else if (Character.isWhitespace(ch)) { buf.append(' '); } else { buf.append('.'); } } for (int i = chunk; i < 17; i++) { buf.append(' '); } for (int i = 0; i < chunk; i++) { buf.append(' '); final int b = line[i] & 0xff; final String s = Integer.toHexString(b); if (s.length() == 1) { buf.append("0"); } buf.append(s); } wireLog.debug(buf.toString()); } } @Override public int read(final ByteBuffer dst) throws IOException { final int bytesRead = session.read(dst); if (log.isDebugEnabled()) { log.debug("{} {} bytes read", session, bytesRead); } if (bytesRead > 0 && wireLog.isDebugEnabled()) { final ByteBuffer b = dst.duplicate(); final int p = b.position(); b.limit(p); b.position(p - bytesRead); logData(b, "<< "); } return bytesRead; } @Override public int write(final ByteBuffer src) throws IOException { final int byteWritten = session.write(src); if (log.isDebugEnabled()) { log.debug("{} {} bytes written", session, byteWritten); } if (byteWritten > 0 && wireLog.isDebugEnabled()) { final ByteBuffer b = src.duplicate(); final int p = b.position(); b.limit(p); b.position(p - byteWritten); logData(b, ">> "); } return byteWritten; } @Override public String toString() { return session.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingIOSessionDecorator.java0100644 0000000 0000000 00000004111 00000250600 031351 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.reactor.IOSession; import org.slf4j.Logger; import org.slf4j.LoggerFactory; final class LoggingIOSessionDecorator implements Decorator { /** * Singleton instance of LoggingIOSessionDecorator. */ public final static LoggingIOSessionDecorator INSTANCE = new LoggingIOSessionDecorator(); private static final Logger WIRE_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.wire"); private LoggingIOSessionDecorator() { } @Override public IOSession decorate(final IOSession ioSession) { final Logger sessionLog = LoggerFactory.getLogger(ioSession.getClass()); if (sessionLog.isDebugEnabled() || WIRE_LOG.isDebugEnabled()) { return new LoggingIOSession(ioSession, sessionLog, WIRE_LOG); } return ioSession; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/MinimalH2AsyncClient.java0100644 0000000 0000000 00000030615 00000250600 030251 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CancellationException; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.impl.classic.RequestFailedException; import org.apache.hc.client5.http.impl.nio.MultihomeConnectionInitiator; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of HTTP/2 only {@link CloseableHttpAsyncClient}. This client * is optimized for HTTP/2 multiplexing message transport and does not support advanced * HTTP protocol functionality such as request execution via a proxy, state management, * authentication and request redirects. *

* Concurrent message exchanges with the same connection route executed by * this client will get automatically multiplexed over a single physical HTTP/2 * connection. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class MinimalH2AsyncClient extends AbstractMinimalHttpAsyncClientBase { private static final Logger LOG = LoggerFactory.getLogger(MinimalH2AsyncClient.class); private final InternalH2ConnPool connPool; private final ConnectionInitiator connectionInitiator; MinimalH2AsyncClient( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig reactorConfig, final ThreadFactory threadFactory, final ThreadFactory workerThreadFactory, final DnsResolver dnsResolver, final TlsStrategy tlsStrategy) { super(new DefaultConnectingIOReactor( eventHandlerFactory, reactorConfig, workerThreadFactory, LoggingIOSessionDecorator.INSTANCE, LoggingExceptionCallback.INSTANCE, null, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE)), pushConsumerRegistry, threadFactory); this.connectionInitiator = new MultihomeConnectionInitiator(getConnectionInitiator(), dnsResolver); this.connPool = new InternalH2ConnPool(this.connectionInitiator, object -> null, tlsStrategy); } @Override public Cancellable execute( final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { Args.notNull(exchangeHandler, "Message exchange handler"); final ComplexCancellable cancellable = new ComplexCancellable(); try { if (!isRunning()) { throw new CancellationException("Request execution cancelled"); } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); exchangeHandler.produceRequest((request, entityDetails, context1) -> { RequestConfig requestConfig = null; if (request instanceof Configurable) { requestConfig = ((Configurable) request).getConfig(); } if (requestConfig != null) { clientContext.setRequestConfig(requestConfig); } else { requestConfig = clientContext.getRequestConfigOrDefault(); } @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); final HttpHost target = new HttpHost(request.getScheme(), request.getAuthority()); final Future sessionFuture = connPool.getSession(new HttpRoute(target), connectTimeout, new FutureCallback() { @Override public void completed(final IOSession session) { final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { @Override public void releaseResources() { exchangeHandler.releaseResources(); } @Override public void failed(final Exception cause) { exchangeHandler.failed(cause); } @Override public void cancel() { failed(new RequestFailedException("Request aborted")); } @Override public void produceRequest( final RequestChannel channel, final HttpContext context1) throws HttpException, IOException { channel.sendRequest(request, entityDetails, context1); } @Override public int available() { return exchangeHandler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { exchangeHandler.produce(channel); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeInformation(response, context1); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeResponse(response, entityDetails, context1); } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { exchangeHandler.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { exchangeHandler.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { exchangeHandler.streamEnd(trailers); } }; if (LOG.isDebugEnabled()) { final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} executing message exchange {}", exchangeId, ConnPoolSupport.getId(session)); } session.enqueue( new RequestExecutionCommand( new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), pushHandlerFactory, cancellable, clientContext), Command.Priority.NORMAL); } else { session.enqueue( new RequestExecutionCommand( internalExchangeHandler, pushHandlerFactory, cancellable, clientContext), Command.Priority.NORMAL); } } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.cancel(); } }); cancellable.setDependency(() -> sessionFuture.cancel(true)); }, context); } catch (final HttpException | IOException | IllegalStateException ex) { exchangeHandler.failed(ex); } return cancellable; } /** * Sets {@link Resolver} for {@link ConnectionConfig} on a per host basis. * * @since 5.2 */ public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { connPool.setConnectionConfigResolver(connectionConfigResolver); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/MinimalHttpAsyncClient.java0100644 0000000 0000000 00000055724 00000250600 030727 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CancellationException; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.impl.classic.RequestFailedException; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of {@link CloseableHttpAsyncClient}. This client is * optimized for HTTP/1.1 and HTTP/2 message transport and does not support * advanced HTTP protocol functionality such as request execution via a proxy, * state management, authentication and request redirects. *

* Concurrent message exchanges executed by this client will get assigned to * separate connections leased from the connection pool. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class MinimalHttpAsyncClient extends AbstractMinimalHttpAsyncClientBase { private static final Logger LOG = LoggerFactory.getLogger(MinimalHttpAsyncClient.class); private final AsyncClientConnectionManager manager; private final SchemePortResolver schemePortResolver; private final TlsConfig tlsConfig; MinimalHttpAsyncClient( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig reactorConfig, final ThreadFactory threadFactory, final ThreadFactory workerThreadFactory, final AsyncClientConnectionManager manager, final SchemePortResolver schemePortResolver, final TlsConfig tlsConfig) { super(new DefaultConnectingIOReactor( eventHandlerFactory, reactorConfig, workerThreadFactory, LoggingIOSessionDecorator.INSTANCE, LoggingExceptionCallback.INSTANCE, null, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.NORMAL)), pushConsumerRegistry, threadFactory); this.manager = manager; this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.tlsConfig = tlsConfig; } private Future leaseEndpoint( final HttpHost host, final Timeout connectionRequestTimeout, final Timeout connectTimeout, final HttpClientContext clientContext, final FutureCallback callback) { final HttpRoute route = new HttpRoute(RoutingSupport.normalize(host, schemePortResolver)); final ComplexFuture resultFuture = new ComplexFuture<>(callback); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); final Future leaseFuture = manager.lease( exchangeId, route, null, connectionRequestTimeout, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { if (connectionEndpoint.isConnected()) { resultFuture.completed(connectionEndpoint); } else { final Future connectFuture = manager.connect( connectionEndpoint, getConnectionInitiator(), connectTimeout, tlsConfig, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint result) { resultFuture.completed(result); } @Override public void failed(final Exception ex) { try { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } finally { resultFuture.failed(ex); } } @Override public void cancelled() { try { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } finally { resultFuture.cancel(true); } } }); resultFuture.setDependency(connectFuture); } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } }); resultFuture.setDependency(leaseFuture); return resultFuture; } public Future lease( final HttpHost host, final FutureCallback callback) { return lease(host, null, callback); } public Future lease( final HttpHost host, final HttpContext context, final FutureCallback callback) { Args.notNull(host, "Host"); final BasicFuture future = new BasicFuture<>(callback); if (!isRunning()) { future.failed(new CancellationException("Connection lease cancelled")); return future; } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); leaseEndpoint( host, connectionRequestTimeout, connectTimeout, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint result) { future.completed(new InternalAsyncClientEndpoint(result)); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(true); } }); return future; } @Override public Cancellable execute( final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { final ComplexCancellable cancellable = new ComplexCancellable(); try { if (!isRunning()) { throw new CancellationException("Request execution cancelled"); } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); exchangeHandler.produceRequest((request, entityDetails, context1) -> { RequestConfig requestConfig = null; if (request instanceof Configurable) { requestConfig = ((Configurable) request).getConfig(); } if (requestConfig != null) { clientContext.setRequestConfig(requestConfig); } else { requestConfig = clientContext.getRequestConfigOrDefault(); } final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); final HttpHost target = new HttpHost(request.getScheme(), request.getAuthority()); final Future leaseFuture = leaseEndpoint( target, connectionRequestTimeout, connectTimeout, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { final InternalAsyncClientEndpoint endpoint = new InternalAsyncClientEndpoint(connectionEndpoint); final AtomicInteger messageCountDown = new AtomicInteger(2); final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { @Override public void releaseResources() { try { exchangeHandler.releaseResources(); } finally { endpoint.releaseAndDiscard(); } } @Override public void failed(final Exception cause) { try { exchangeHandler.failed(cause); } finally { endpoint.releaseAndDiscard(); } } @Override public void cancel() { failed(new RequestFailedException("Request aborted")); } @Override public void produceRequest( final RequestChannel channel, final HttpContext context1) throws HttpException, IOException { channel.sendRequest(request, entityDetails, context1); if (entityDetails == null) { messageCountDown.decrementAndGet(); } } @Override public int available() { return exchangeHandler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { exchangeHandler.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { return channel.write(src); } @Override public void endStream(final List trailers) throws IOException { channel.endStream(trailers); if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } @Override public void endStream() throws IOException { channel.endStream(); if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeInformation(response, context1); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeResponse(response, entityDetails, context1); if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { messageCountDown.decrementAndGet(); } if (entityDetails == null) { if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { exchangeHandler.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { exchangeHandler.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } exchangeHandler.streamEnd(trailers); } }; if (responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } endpoint.execute(internalExchangeHandler, pushHandlerFactory, clientContext); } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.cancel(); } }); cancellable.setDependency(() -> leaseFuture.cancel(true)); }, context); } catch (final HttpException | IOException | IllegalStateException ex) { exchangeHandler.failed(ex); } return cancellable; } private class InternalAsyncClientEndpoint extends AsyncClientEndpoint { private final AsyncConnectionEndpoint connectionEndpoint; private final AtomicBoolean released; InternalAsyncClientEndpoint(final AsyncConnectionEndpoint connectionEndpoint) { this.connectionEndpoint = connectionEndpoint; this.released = new AtomicBoolean(false); } boolean isReleased() { return released.get(); } @Override public boolean isConnected() { return !isReleased() && connectionEndpoint.isConnected(); } @Override public void execute( final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { Asserts.check(!released.get(), "Endpoint has already been released"); final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} executing message exchange {}", exchangeId, ConnPoolSupport.getId(connectionEndpoint)); connectionEndpoint.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, exchangeHandler), pushHandlerFactory, clientContext); } else { connectionEndpoint.execute(exchangeId, exchangeHandler, clientContext); } } public void setSocketTimeout(final Timeout timeout) { connectionEndpoint.setSocketTimeout(timeout); } @Override public void releaseAndReuse() { if (released.compareAndSet(false, true)) { manager.release(connectionEndpoint, null, TimeValue.NEG_ONE_MILLISECOND); } } @Override public void releaseAndDiscard() { if (released.compareAndSet(false, true)) { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/package-info.java0100644 0000000 0000000 00000002474 00000250600 026662 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Asynchronous HTTP client API implementation that supports both * HTTP/2 and HTTP/1.1 transport. */ package org.apache.hc.client5.http.impl.async; httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/0040755 0000000 0000000 00000000000 00000250600 023313 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthCacheKeeper.java0100644 0000000 0000000 00000014757 00000250600 027152 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Utility class that implements commons aspects of the client side authentication cache keeping. * * @since 5.2 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public final class AuthCacheKeeper { private static final Logger LOG = LoggerFactory.getLogger(AuthCacheKeeper.class); private final SchemePortResolver schemePortResolver; public AuthCacheKeeper(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; } public void updateOnChallenge(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { clearCache(host, pathPrefix, HttpClientContext.cast(context)); } public void updateOnNoChallenge(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.SUCCESS) { updateCache(host, pathPrefix, authExchange.getAuthScheme(), HttpClientContext.cast(context)); } } public void updateOnResponse(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.FAILURE) { clearCache(host, pathPrefix, HttpClientContext.cast(context)); } } public void loadPreemptively(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.UNCHALLENGED) { AuthScheme authScheme = loadFromCache(host, pathPrefix, HttpClientContext.cast(context)); if (authScheme == null && pathPrefix != null) { authScheme = loadFromCache(host, null, HttpClientContext.cast(context)); } if (authScheme != null) { authExchange.select(authScheme); } } } private AuthScheme loadFromCache(final HttpHost host, final String pathPrefix, final HttpClientContext clientContext) { final AuthCache authCache = clientContext.getAuthCache(); if (authCache != null) { final AuthScheme authScheme = authCache.get(host, pathPrefix); if (authScheme != null) { if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Re-using cached '{}' auth scheme for {}{}", exchangeId, authScheme.getName(), host, pathPrefix != null ? pathPrefix : ""); } return authScheme; } } return null; } private void updateCache(final HttpHost host, final String pathPrefix, final AuthScheme authScheme, final HttpClientContext clientContext) { final boolean cacheable = authScheme.getClass().getAnnotation(AuthStateCacheable.class) != null; if (cacheable) { AuthCache authCache = clientContext.getAuthCache(); if (authCache == null) { authCache = new BasicAuthCache(schemePortResolver); clientContext.setAuthCache(authCache); } if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Caching '{}' auth scheme for {}{}", exchangeId, authScheme.getName(), host, pathPrefix != null ? pathPrefix : ""); } authCache.put(host, pathPrefix, authScheme); } } private void clearCache(final HttpHost host, final String pathPrefix, final HttpClientContext clientContext) { final AuthCache authCache = clientContext.getAuthCache(); if (authCache != null) { if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Clearing cached auth scheme for {}{}", exchangeId, host, pathPrefix != null ? pathPrefix : ""); } authCache.remove(host, pathPrefix); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthChallengeParser.java0100644 0000000 0000000 00000017612 00000250600 030043 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * Authentication challenge parser. * * @since 5.0 */ public class AuthChallengeParser { /** * Default instance of {@link AuthChallengeParser}. */ public static final AuthChallengeParser INSTANCE = new AuthChallengeParser(); private final Tokenizer tokenParser = Tokenizer.INSTANCE; private final static char BLANK = ' '; private final static char COMMA_CHAR = ','; private final static char EQUAL_CHAR = '='; private static final Tokenizer.Delimiter TERMINATORS = Tokenizer.delimiters(BLANK, EQUAL_CHAR, COMMA_CHAR); private static final Tokenizer.Delimiter DELIMITER = Tokenizer.delimiters(COMMA_CHAR); private static final Tokenizer.Delimiter SPACE = Tokenizer.delimiters(BLANK); static class ChallengeInt { final String schemeName; final List params; ChallengeInt(final String schemeName) { this.schemeName = schemeName; this.params = new ArrayList<>(); } @Override public String toString() { return "ChallengeInternal{" + "schemeName='" + schemeName + '\'' + ", params=" + params + '}'; } } /** * Parses the given sequence of characters into a list of {@link AuthChallenge} elements. * * @param challengeType the type of challenge (target or proxy). * @param buffer the sequence of characters to be parsed. * @param cursor the parser cursor. * @return a list of auth challenge elements. */ public List parse( final ChallengeType challengeType, final CharSequence buffer, final ParserCursor cursor) throws ParseException { tokenParser.skipWhiteSpace(buffer, cursor); if (cursor.atEnd()) { throw new ParseException("Malformed auth challenge"); } final List internalChallenges = new ArrayList<>(); final String schemeName = tokenParser.parseToken(buffer, cursor, SPACE); if (TextUtils.isBlank(schemeName)) { throw new ParseException("Malformed auth challenge"); } ChallengeInt current = new ChallengeInt(schemeName); while (current != null) { internalChallenges.add(current); current = parseChallenge(buffer, cursor, current); } final List challenges = new ArrayList<>(internalChallenges.size()); for (final ChallengeInt internal : internalChallenges) { final List params = internal.params; String token68 = null; if (params.size() == 1) { final NameValuePair param = params.get(0); if (param.getValue() == null) { token68 = param.getName(); params.clear(); } } challenges.add( new AuthChallenge(challengeType, internal.schemeName, token68, !params.isEmpty() ? params : null)); } return challenges; } ChallengeInt parseChallenge( final CharSequence buffer, final ParserCursor cursor, final ChallengeInt currentChallenge) throws ParseException { for (;;) { tokenParser.skipWhiteSpace(buffer, cursor); if (cursor.atEnd()) { return null; } final String token = parseToken(buffer, cursor); if (TextUtils.isBlank(token)) { throw new ParseException("Malformed auth challenge"); } tokenParser.skipWhiteSpace(buffer, cursor); // it gets really messy here if (cursor.atEnd()) { // at the end of the header currentChallenge.params.add(new BasicNameValuePair(token, null)); } else { char ch = buffer.charAt(cursor.getPos()); if (ch == EQUAL_CHAR) { cursor.updatePos(cursor.getPos() + 1); final String value = tokenParser.parseValue(buffer, cursor, DELIMITER); tokenParser.skipWhiteSpace(buffer, cursor); if (!cursor.atEnd()) { ch = buffer.charAt(cursor.getPos()); if (ch == COMMA_CHAR) { cursor.updatePos(cursor.getPos() + 1); } } currentChallenge.params.add(new BasicNameValuePair(token, value)); } else if (ch == COMMA_CHAR) { cursor.updatePos(cursor.getPos() + 1); currentChallenge.params.add(new BasicNameValuePair(token, null)); } else { // the token represents new challenge if (currentChallenge.params.isEmpty()) { throw new ParseException("Malformed auth challenge"); } return new ChallengeInt(token); } } } } String parseToken(final CharSequence buf, final ParserCursor cursor) { final StringBuilder dst = new StringBuilder(); while (!cursor.atEnd()) { int pos = cursor.getPos(); char current = buf.charAt(pos); if (TERMINATORS.test(current)) { // Here it gets really ugly if (current == EQUAL_CHAR) { // it can be a start of a parameter value or token68 padding // Look ahead and see if there are more '=' or at end of buffer if (pos + 1 < cursor.getUpperBound() && buf.charAt(pos + 1) != EQUAL_CHAR) { break; } do { dst.append(current); pos++; cursor.updatePos(pos); if (cursor.atEnd()) { break; } current = buf.charAt(pos); } while (current == EQUAL_CHAR); } else { break; } } else { dst.append(current); cursor.updatePos(pos + 1); } } return dst.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthSchemeSupport.java0100644 0000000 0000000 00000003556 00000250600 027607 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.core5.annotation.Internal; /** * @since 5.2 */ @Internal public class AuthSchemeSupport { public static Charset parseCharset( final String charsetName, final Charset defaultCharset) throws AuthenticationException { try { return charsetName != null ? Charset.forName(charsetName) : defaultCharset; } catch (final UnsupportedCharsetException ex) { throw new AuthenticationException("Unsupported charset: " + charsetName); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthenticationHandler.java0100644 0000000 0000000 00000050551 00000250600 030436 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.ArrayList; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Queue; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHeaderValueParser; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Asserts; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal utility class that implements commons aspects of the client side * HTTP authentication. * * @since 5.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public class AuthenticationHandler { private static final Logger LOG = LoggerFactory.getLogger(AuthenticationHandler.class); private final AuthChallengeParser parser; public AuthenticationHandler() { this.parser = new AuthChallengeParser(); } /** * Determines whether the given response represents an authentication challenge, and updates * the {@link AuthExchange} state. * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param authExchange the current authentication exchange state. Gets updated. * @param context the current execution context. * @return {@code true} if the response message represents an authentication challenge, * {@code false} otherwise. */ public boolean isChallenged( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthExchange authExchange, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); if (checkChallenged(challengeType, response, clientContext)) { return true; } switch (authExchange.getState()) { case CHALLENGED: case HANDSHAKE: if (LOG.isDebugEnabled()) { // The mutual auth may still fail LOG.debug("{} Server has accepted authentication", clientContext.getExchangeId()); } authExchange.setState(AuthExchange.State.SUCCESS); break; case SUCCESS: break; default: authExchange.setState(AuthExchange.State.UNCHALLENGED); } return false; } /** * Determines whether the given response represents an authentication challenge * of challangeType, without changing the {@link AuthExchange} state. * * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param clientContext the current execution context. * @return {@code true} if the response message represents an authentication challenge, * {@code false} otherwise. */ private boolean checkChallenged( final ChallengeType challengeType, final HttpResponse response, final HttpClientContext clientContext) { final int challengeCode; switch (challengeType) { case TARGET: challengeCode = HttpStatus.SC_UNAUTHORIZED; break; case PROXY: challengeCode = HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED; break; default: throw new IllegalStateException("Unexpected challenge type: " + challengeType); } if (response.getCode() == challengeCode) { if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication required", clientContext.getExchangeId()); } return true; } return false; } /** * Determines if the scheme requires an auth challenge for responses that do not * have a challenge HTTP code. (i.e whether it needs a mutual authentication token) */ public boolean isChallengeExpected(final AuthExchange authExchange) { final AuthScheme authScheme = authExchange.getAuthScheme(); return authScheme != null && authScheme.isChallengeExpected(); } public Map extractChallengeMap( final ChallengeType challengeType, final HttpResponse response, final HttpClientContext context) { final Map challengeMap = new HashMap<>(); MessageSupport.parseHeaders( response, challengeType == ChallengeType.PROXY ? HttpHeaders.PROXY_AUTHENTICATE : HttpHeaders.WWW_AUTHENTICATE, (buffer, cursor) -> { try { final List authChallenges = parser.parse(challengeType, buffer, cursor); for (final AuthChallenge authChallenge : authChallenges) { final String schemeName = authChallenge.getSchemeName().toLowerCase(Locale.ROOT); if (!challengeMap.containsKey(schemeName)) { challengeMap.put(schemeName, authChallenge); } } } catch (final ParseException ex) { if (LOG.isWarnEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.warn("{} Malformed challenge", exchangeId); } } }); return challengeMap; } /** * Handles the response from the opposite endpoint and updates the {@link AuthExchange} * state based on the challenge presented in the response message using the given * {@link AuthenticationStrategy}. * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param authStrategy the authentication strategy. * @param authExchange the current authentication exchange state. * @param context the current execution context. * @return {@code true} if the request needs-to be re-sent, * {@code false} if the authentication is complete (successful or not). * * @throws AuthenticationException if the AuthScheme throws one. In most cases this indicates a * client side problem, as final server error responses are simply returned. * @throws MalformedChallengeException if the AuthScheme throws one. In most cases this indicates a * client side problem, as final server error responses are simply returned. */ public boolean handleResponse( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthenticationStrategy authStrategy, final AuthExchange authExchange, final HttpContext context) throws AuthenticationException, MalformedChallengeException { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final boolean challenged = checkChallenged(challengeType, response, clientContext); final boolean isChallengeExpected = isChallengeExpected(authExchange); if (LOG.isDebugEnabled()) { LOG.debug("{} {} requested authentication", exchangeId, host.toHostString()); } final Map challengeMap = extractChallengeMap(challengeType, response, clientContext); if (challengeMap.isEmpty() && !challenged && isChallengeExpected) { final AuthScheme authScheme = authExchange.getAuthScheme(); if (authScheme != null) { MessageSupport.parseHeaders( response, challengeType == ChallengeType.PROXY ? "Proxy-Authentication-Info" : "Authentication-Info", (buffer, cursor) -> { final String schemeName = authScheme.getName(); final List params = new ArrayList<>(); while (!cursor.atEnd()) { final NameValuePair param = BasicHeaderValueParser.INSTANCE.parseNameValuePair(buffer, cursor); params.add(param); if (!cursor.atEnd()) { final char ch = buffer.charAt(cursor.getPos()); if (ch == ',') { cursor.updatePos(cursor.getPos() + 1); } } } final AuthChallenge authChallenge = new AuthChallenge(challengeType, schemeName, null, params); challengeMap.put(schemeName.toLowerCase(Locale.ROOT), authChallenge); }); } } if (challengeMap.isEmpty()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Response contains no valid authentication challenges", exchangeId); } if (!isChallengeExpected) { authExchange.reset(); return false; } } switch (authExchange.getState()) { case FAILURE: return false; case SUCCESS: if (!isChallengeExpected) { authExchange.reset(); break; } // otherwise fall through case CHALLENGED: // fall through case HANDSHAKE: Asserts.notNull(authExchange.getAuthScheme(), "AuthScheme"); // fall through case UNCHALLENGED: final AuthScheme authScheme = authExchange.getAuthScheme(); // AuthScheme is only set if we have already sent an auth response, either // because we have received a challenge for it, or preemptively. if (authScheme != null) { final String schemeName = authScheme.getName(); final AuthChallenge challenge = challengeMap.get(schemeName.toLowerCase(Locale.ROOT)); if (challenge != null || isChallengeExpected) { if (LOG.isDebugEnabled()) { LOG.debug("{} Processing authentication challenge {}", exchangeId, challenge); } try { authScheme.processChallenge(host, challenged, challenge, clientContext); } catch (final AuthenticationException | MalformedChallengeException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Exception processing challenge {}", exchangeId, ex); } authExchange.reset(); authExchange.setState(AuthExchange.State.FAILURE); if (isChallengeExpected) { throw ex; } } if (authScheme.isChallengeComplete()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication failed", exchangeId); } authExchange.reset(); authExchange.setState(AuthExchange.State.FAILURE); return false; } if (!challenged) { // There are no more challanges sent after the 200 message, // and if we get here, then the mutual auth phase has succeeded. authExchange.setState(AuthExchange.State.SUCCESS); return false; } else { authExchange.setState(AuthExchange.State.HANDSHAKE); } return true; } authExchange.reset(); // Retry authentication with a different scheme } } // We reach this if we fell through above because the authScheme has not yet been set, or if // we receive a 401/407 response for an unexpected scheme. Normally this processes the first // 401/407 response final List preferredSchemes = authStrategy.select(challengeType, challengeMap, clientContext); final CredentialsProvider credsProvider = clientContext.getCredentialsProvider(); if (credsProvider == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Credentials provider not set in the context", exchangeId); } return false; } final Queue authOptions = new LinkedList<>(); if (LOG.isDebugEnabled()) { LOG.debug("{} Selecting authentication options", exchangeId); } for (final AuthScheme authScheme: preferredSchemes) { // We only respond to the first successfully processed challenge. However, the // original AuthScheme API does not really process the challenge at this point, // so we need to process/store each challenge here anyway. try { final String schemeName = authScheme.getName(); final AuthChallenge challenge = challengeMap.get(schemeName.toLowerCase(Locale.ROOT)); authScheme.processChallenge(host, challenged, challenge, clientContext); if (authScheme.isResponseReady(host, credsProvider, clientContext)) { authOptions.add(authScheme); } } catch (final AuthenticationException | MalformedChallengeException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Exception while processing Challange", ex); } } } if (!authOptions.isEmpty()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Selected authentication options: {}", exchangeId, authOptions); } authExchange.reset(); authExchange.setState(AuthExchange.State.CHALLENGED); authExchange.setOptions(authOptions); return true; } return false; } /** * Generates a response to the authentication challenge based on the actual {@link AuthExchange} state * and adds it to the given {@link HttpRequest} message . * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param request the request message head. * @param authExchange the current authentication exchange state. * @param context the current execution context. */ public void addAuthResponse( final HttpHost host, final ChallengeType challengeType, final HttpRequest request, final AuthExchange authExchange, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); AuthScheme authScheme = authExchange.getAuthScheme(); switch (authExchange.getState()) { case FAILURE: return; case SUCCESS: Asserts.notNull(authScheme, "AuthScheme"); if (authScheme.isConnectionBased()) { return; } break; case HANDSHAKE: Asserts.notNull(authScheme, "AuthScheme"); break; case CHALLENGED: final Queue authOptions = authExchange.getAuthOptions(); if (authOptions != null) { while (!authOptions.isEmpty()) { authScheme = authOptions.remove(); authExchange.select(authScheme); if (LOG.isDebugEnabled()) { LOG.debug("{} Generating response to an authentication challenge using {} scheme", exchangeId, authScheme.getName()); } try { final String authResponse = authScheme.generateAuthResponse(host, request, clientContext); if (authResponse != null) { final Header header = new BasicHeader( challengeType == ChallengeType.TARGET ? HttpHeaders.AUTHORIZATION : HttpHeaders.PROXY_AUTHORIZATION, authResponse); request.addHeader(header); } break; } catch (final AuthenticationException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} {} authentication error: {}", exchangeId, authScheme, ex.getMessage()); } } } return; } Asserts.notNull(authScheme, "AuthScheme"); default: } // This is the SUCCESS and HANDSHAKE states, same as the initial response. // This only happens if the handshake requires multiple requests, which is // unlikely in practice. if (authScheme != null) { try { final String authResponse = authScheme.generateAuthResponse(host, request, clientContext); final Header header = new BasicHeader( challengeType == ChallengeType.TARGET ? HttpHeaders.AUTHORIZATION : HttpHeaders.PROXY_AUTHORIZATION, authResponse); request.addHeader(header); } catch (final AuthenticationException ex) { if (LOG.isErrorEnabled()) { LOG.error("{} {} authentication error: {}", exchangeId, authScheme, ex.getMessage()); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicAuthCache.java0100644 0000000 0000000 00000016455 00000250600 026755 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.util.Locale; import java.util.Map; import java.util.Objects; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default implementation of {@link AuthCache}. This implements * expects {@link AuthScheme} to be {@link Serializable} * in order to be cacheable. *

* Instances of this class are thread safe as of version 4.4. *

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class BasicAuthCache implements AuthCache { private static final Logger LOG = LoggerFactory.getLogger(BasicAuthCache.class); static class Key { final String scheme; final String host; final int port; final String pathPrefix; Key(final String scheme, final String host, final int port, final String pathPrefix) { Args.notBlank(scheme, "Scheme"); Args.notBlank(host, "Scheme"); this.scheme = scheme.toLowerCase(Locale.ROOT); this.host = host.toLowerCase(Locale.ROOT); this.port = port; this.pathPrefix = pathPrefix; } @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof Key) { final Key that = (Key) obj; return this.scheme.equals(that.scheme) && this.host.equals(that.host) && this.port == that.port && Objects.equals(this.pathPrefix, that.pathPrefix); } return false; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.scheme); hash = LangUtils.hashCode(hash, this.host); hash = LangUtils.hashCode(hash, this.port); hash = LangUtils.hashCode(hash, this.pathPrefix); return hash; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append(scheme).append("://").append(host); if (port >= 0) { buf.append(":").append(port); } if (pathPrefix != null) { if (!pathPrefix.startsWith("/")) { buf.append("/"); } buf.append(pathPrefix); } return buf.toString(); } } static class AuthData { final Class clazz; final Object state; public AuthData(final Class clazz, final Object state) { this.clazz = clazz; this.state = state; } } private final Map map; private final SchemePortResolver schemePortResolver; /** * Default constructor. * * @since 4.3 */ public BasicAuthCache(final SchemePortResolver schemePortResolver) { super(); this.map = new ConcurrentHashMap<>(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } public BasicAuthCache() { this(null); } private Key key(final String scheme, final NamedEndpoint authority, final String pathPrefix) { return new Key(scheme, authority.getHostName(), schemePortResolver.resolve(scheme, authority), pathPrefix); } private AuthData data(final AuthScheme authScheme) { return new AuthData(authScheme.getClass(), ((StateHolder) authScheme).store()); } @Override public void put(final HttpHost host, final AuthScheme authScheme) { put(host, null, authScheme); } @Override public AuthScheme get(final HttpHost host) { return get(host, null); } @Override public void remove(final HttpHost host) { remove(host, null); } @Override public void put(final HttpHost host, final String pathPrefix, final AuthScheme authScheme) { Args.notNull(host, "HTTP host"); if (authScheme == null) { return; } if (authScheme instanceof StateHolder) { this.map.put(key(host.getSchemeName(), host, pathPrefix), data(authScheme)); } else { if (LOG.isDebugEnabled()) { LOG.debug("Auth scheme {} cannot be cached", authScheme.getClass()); } } } @Override @SuppressWarnings("unchecked") public AuthScheme get(final HttpHost host, final String pathPrefix) { Args.notNull(host, "HTTP host"); final AuthData authData = this.map.get(key(host.getSchemeName(), host, pathPrefix)); if (authData != null) { try { final AuthScheme authScheme = authData.clazz.newInstance(); ((StateHolder) authScheme).restore(authData.state); return authScheme; } catch (final IllegalAccessException | InstantiationException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Unexpected error while reading auth scheme state", ex); } } } return null; } @Override public void remove(final HttpHost host, final String pathPrefix) { Args.notNull(host, "HTTP host"); this.map.remove(key(host.getSchemeName(), host, pathPrefix)); } @Override public void clear() { this.map.clear(); } @Override public String toString() { return this.map.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicCredentialsProvider.java0100644 0000000 0000000 00000005151 00000250600 031067 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link CredentialsStore}. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicCredentialsProvider implements CredentialsStore { private final ConcurrentHashMap credMap; /** * Default constructor. */ public BasicCredentialsProvider() { super(); this.credMap = new ConcurrentHashMap<>(); } @Override public void setCredentials( final AuthScope authScope, final Credentials credentials) { Args.notNull(authScope, "Authentication scope"); credMap.put(authScope, credentials); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return CredentialsMatcher.matchCredentials(this.credMap, authScope); } @Override public void clear() { this.credMap.clear(); } @Override public String toString() { return credMap.keySet().toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicScheme.java0100644 0000000 0000000 00000022550 00000250600 026325 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.Principal; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.client5.http.utils.ByteArrayBuilder; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Basic authentication scheme. * * @since 4.0 */ @AuthStateCacheable public class BasicScheme implements AuthScheme, StateHolder, Serializable { private static final long serialVersionUID = -1931571557597830536L; private static final Logger LOG = LoggerFactory.getLogger(BasicScheme.class); private final Map paramMap; private transient ByteArrayBuilder buffer; private transient Base64 base64codec; private boolean complete; private UsernamePasswordCredentials credentials; /** * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicScheme()} instead. * * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. */ @Deprecated public BasicScheme(final Charset charset) { this.paramMap = new HashMap<>(); this.complete = false; } /** * Constructs a new BasicScheme with UTF-8 as the charset. * * @since 4.3 */ public BasicScheme() { this.paramMap = new HashMap<>(); this.complete = false; } public void initPreemptive(final Credentials credentials) { if (credentials != null) { Args.check(credentials instanceof UsernamePasswordCredentials, "Unsupported credential type: " + credentials.getClass()); this.credentials = (UsernamePasswordCredentials) credentials; this.complete = true; } else { this.credentials = null; } } @Override public String getName() { return StandardAuthScheme.BASIC; } @Override public boolean isConnectionBased() { return false; } @Override public String getRealm() { return this.paramMap.get("realm"); } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { this.paramMap.clear(); final List params = authChallenge.getParams(); if (params != null) { for (final NameValuePair param: params) { this.paramMap.put(param.getName().toLowerCase(Locale.ROOT), param.getValue()); } } this.complete = true; } @Override public boolean isChallengeComplete() { return this.complete; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final AuthScope authScope = new AuthScope(host, getRealm(), getName()); final Credentials credentials = credentialsProvider.getCredentials( authScope, context); if (credentials instanceof UsernamePasswordCredentials) { this.credentials = (UsernamePasswordCredentials) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } this.credentials = null; return false; } @Override public Principal getPrincipal() { return null; } private void validateUsername() throws AuthenticationException { if (credentials == null) { throw new AuthenticationException("User credentials not set"); } final String username = credentials.getUserName(); for (int i = 0; i < username.length(); i++) { final char ch = username.charAt(i); if (Character.isISOControl(ch)) { throw new AuthenticationException("Username must not contain any control characters"); } if (ch == ':') { throw new AuthenticationException("Username contains a colon character and is invalid"); } } } private void validatePassword() throws AuthenticationException { if (credentials == null) { throw new AuthenticationException("User credentials not set"); } final char[] password = credentials.getUserPassword(); if (password != null) { for (final char ch : password) { if (Character.isISOControl(ch)) { throw new AuthenticationException("Password must not contain any control characters"); } } } } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { validateUsername(); validatePassword(); if (this.buffer == null) { this.buffer = new ByteArrayBuilder(64); } else { this.buffer.reset(); } final Charset charset = AuthSchemeSupport.parseCharset(paramMap.get("charset"), StandardCharsets.UTF_8); this.buffer.charset(charset); this.buffer.append(this.credentials.getUserName()).append(":").append(this.credentials.getUserPassword()); if (this.base64codec == null) { this.base64codec = new Base64(); } final byte[] encodedCreds = this.base64codec.encode(this.buffer.toByteArray()); this.buffer.reset(); return StandardAuthScheme.BASIC + " " + new String(encodedCreds, 0, encodedCreds.length, StandardCharsets.US_ASCII); } @Override public State store() { if (complete) { return new State(new HashMap<>(paramMap), credentials); } return null; } @Override public void restore(final State state) { if (state != null) { paramMap.clear(); paramMap.putAll(state.params); credentials = state.credentials; complete = true; } } @Override public String toString() { return getName() + this.paramMap; } @Internal public static class State { final Map params; final UsernamePasswordCredentials credentials; State(final Map params, final UsernamePasswordCredentials credentials) { this.params = params; this.credentials = credentials; } @Override public String toString() { return "State{" + "params=" + params + '}'; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicSchemeFactory.java0100644 0000000 0000000 00000005723 00000250600 027660 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link BasicScheme} instances. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link BasicSchemeFactory with a null Charset}. */ public static final BasicSchemeFactory INSTANCE = new BasicSchemeFactory(); private final Charset charset; /** * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicSchemeFactory()} instead. * * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. */ @Deprecated public BasicSchemeFactory(final Charset charset) { super(); this.charset = StandardCharsets.UTF_8; // Always use UTF-8 } /** * Constructs a new {@link BasicSchemeFactory} with {@link StandardCharsets#UTF_8} as the charset. * This default setting aligns with standard practices for encoding credentials in Basic Authentication. */ public BasicSchemeFactory() { this.charset = StandardCharsets.UTF_8; } @Override public AuthScheme create(final HttpContext context) { return new BasicScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BearerScheme.java0100644 0000000 0000000 00000015442 00000250600 026506 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.security.Principal; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.BearerToken; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Bearer authentication scheme. * * @since 5.3 */ @AuthStateCacheable public class BearerScheme implements AuthScheme, StateHolder, Serializable { private static final Logger LOG = LoggerFactory.getLogger(BearerScheme.class); private final Map paramMap; private boolean complete; private BearerToken bearerToken; public BearerScheme() { this.paramMap = new HashMap<>(); this.complete = false; } @Override public String getName() { return StandardAuthScheme.BEARER; } @Override public boolean isConnectionBased() { return false; } @Override public String getRealm() { return this.paramMap.get("realm"); } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { this.paramMap.clear(); final List params = authChallenge.getParams(); if (params != null) { for (final NameValuePair param: params) { this.paramMap.put(param.getName().toLowerCase(Locale.ROOT), param.getValue()); } if (LOG.isDebugEnabled()) { final String error = paramMap.get("error"); if (error != null) { final StringBuilder buf = new StringBuilder(); buf.append(error); final String desc = paramMap.get("error_description"); final String uri = paramMap.get("error_uri"); if (desc != null || uri != null) { buf.append(" ("); buf.append(desc).append("; ").append(uri); buf.append(")"); } LOG.debug(buf.toString()); } } } this.complete = true; } @Override public boolean isChallengeComplete() { return this.complete; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "Credentials provider"); final AuthScope authScope = new AuthScope(host, getRealm(), getName()); final Credentials credentials = credentialsProvider.getCredentials(authScope, context); if (credentials instanceof BearerToken) { this.bearerToken = (BearerToken) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } this.bearerToken = null; return false; } @Override public Principal getPrincipal() { return null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { Asserts.notNull(bearerToken, "Bearer token"); return StandardAuthScheme.BEARER + " " + bearerToken.getToken(); } @Override public State store() { if (complete) { return new State(new HashMap<>(paramMap), bearerToken); } return null; } @Override public void restore(final State state) { if (state != null) { paramMap.clear(); paramMap.putAll(state.params); bearerToken = state.bearerToken; complete = true; } } @Override public String toString() { return getName() + this.paramMap; } @Internal public static class State { final Map params; final BearerToken bearerToken; State(final Map params, final BearerToken bearerToken) { this.params = params; this.bearerToken = bearerToken; } @Override public String toString() { return "State{" + "params=" + params + ", bearerToken=" + bearerToken + '}'; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BearerSchemeFactory.java0100644 0000000 0000000 00000004040 00000250600 030026 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link BearerScheme} instances. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BearerSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link BearerSchemeFactory}. */ public static final BearerSchemeFactory INSTANCE = new BearerSchemeFactory(); public BearerSchemeFactory() { super(); } @Override public AuthScheme create(final HttpContext context) { return new BearerScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/CredentialsMatcher.java0100644 0000000 0000000 00000004571 00000250600 027723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; final class CredentialsMatcher { /** * Find matching {@link Credentials credentials} for the given authentication scope. * * @param map the credentials hash map * @param authScope the {@link AuthScope authentication scope} * @return the credentials * */ static Credentials matchCredentials(final Map map, final AuthScope authScope) { // see if we get a direct hit Credentials creds = map.get(authScope); if (creds == null) { // Nope. // Do a full scan int bestMatchFactor = -1; AuthScope bestMatch = null; for (final AuthScope current: map.keySet()) { final int factor = authScope.match(current); if (factor > bestMatchFactor) { bestMatchFactor = factor; bestMatch = current; } } if (bestMatch != null) { creds = map.get(bestMatch); } } return creds; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/CredentialsProviderBuilder.java0100644 0000000 0000000 00000007161 00000250600 031437 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; /** * {@link CredentialsProvider} builder. * * @since 5.2 */ public final class CredentialsProviderBuilder { private final Map credMap; public static CredentialsProviderBuilder create() { return new CredentialsProviderBuilder(); } public CredentialsProviderBuilder() { super(); this.credMap = new HashMap<>(); } public CredentialsProviderBuilder add(final AuthScope authScope, final Credentials credentials) { Args.notNull(authScope, "Host"); credMap.put(authScope, credentials); return this; } public CredentialsProviderBuilder add(final AuthScope authScope, final String username, final char[] password) { Args.notNull(authScope, "Host"); credMap.put(authScope, new UsernamePasswordCredentials(username, password)); return this; } public CredentialsProviderBuilder add(final HttpHost httpHost, final Credentials credentials) { Args.notNull(httpHost, "Host"); credMap.put(new AuthScope(httpHost), credentials); return this; } public CredentialsProviderBuilder add(final HttpHost httpHost, final String username, final char[] password) { Args.notNull(httpHost, "Host"); credMap.put(new AuthScope(httpHost), new UsernamePasswordCredentials(username, password)); return this; } public CredentialsProvider build() { if (credMap.size() == 0) { return new BasicCredentialsProvider(); } else if (credMap.size() == 1) { final Map.Entry entry = credMap.entrySet().iterator().next(); return new SingleCredentialsProvider(entry.getKey(), entry.getValue()); } else { return new FixedCredentialsProvider(credMap); } } static class Entry { final AuthScope authScope; final Credentials credentials; Entry(final AuthScope authScope, final Credentials credentials) { this.authScope = authScope; this.credentials = credentials; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java0100644 0000000 0000000 00000064501 00000250600 026525 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.MessageDigest; import java.security.Principal; import java.security.SecureRandom; import java.util.ArrayList; import java.util.Formatter; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.ByteArrayBuilder; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicHeaderValueFormatter; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Digest authentication scheme. * Both MD5 (default) and MD5-sess are supported. * Currently only qop=auth or no qop is supported. qop=auth-int * is unsupported. If auth and auth-int are provided, auth is * used. *

* Since the digest username is included as clear text in the generated * Authentication header, the charset of the username must be compatible * with the HTTP element charset used by the connection. *

* * @since 4.0 */ public class DigestScheme implements AuthScheme, Serializable { private static final long serialVersionUID = 3883908186234566916L; private static final Logger LOG = LoggerFactory.getLogger(DigestScheme.class); /** * Hexa values used when creating 32 character long digest in HTTP DigestScheme * in case of authentication. * * @see #formatHex(byte[]) */ private static final char[] HEXADECIMAL = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' }; /** * Represent the possible values of quality of protection. */ private enum QualityOfProtection { UNKNOWN, MISSING, AUTH_INT, AUTH } private transient Charset defaultCharset; private final Map paramMap; private boolean complete; private transient ByteArrayBuilder buffer; /** * Flag indicating whether username hashing is supported. *

* This flag is used to determine if the server supports hashing of the username * as part of the Digest Access Authentication process. When set to {@code true}, * the client is expected to hash the username using the same algorithm used for * hashing the credentials. This is in accordance with Section 3.4.4 of RFC 7616. *

*

* The default value is {@code false}, indicating that username hashing is not * supported. If the server requires username hashing (indicated by the * {@code userhash} parameter in the a header set to {@code true}), * this flag should be set to {@code true} to comply with the server's requirements. *

*/ private boolean userhashSupported = false; private String lastNonce; private long nounceCount; private String cnonce; private byte[] a1; private byte[] a2; private UsernamePasswordCredentials credentials; public DigestScheme() { this.defaultCharset = StandardCharsets.UTF_8; this.paramMap = new HashMap<>(); this.complete = false; } /** * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7616 for HTTP Digest Access Authentication. Use the default constructor {@link #DigestScheme()} instead. * * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. */ @Deprecated public DigestScheme(final Charset charset) { this(); } public void initPreemptive(final Credentials credentials, final String cnonce, final String realm) { Args.notNull(credentials, "Credentials"); Args.check(credentials instanceof UsernamePasswordCredentials, "Unsupported credential type: " + credentials.getClass()); this.credentials = (UsernamePasswordCredentials) credentials; this.paramMap.put("cnonce", cnonce); this.paramMap.put("realm", realm); } @Override public String getName() { return StandardAuthScheme.DIGEST; } @Override public boolean isConnectionBased() { return false; } @Override public String getRealm() { return this.paramMap.get("realm"); } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { Args.notNull(authChallenge, "AuthChallenge"); this.paramMap.clear(); final List params = authChallenge.getParams(); if (params != null) { for (final NameValuePair param: params) { this.paramMap.put(param.getName().toLowerCase(Locale.ROOT), param.getValue()); } } if (this.paramMap.isEmpty()) { throw new MalformedChallengeException("Missing digest auth parameters"); } final String userHashValue = this.paramMap.get("userhash"); this.userhashSupported = "true".equalsIgnoreCase(userHashValue); this.complete = true; } @Override public boolean isChallengeComplete() { final String s = this.paramMap.get("stale"); return !"true".equalsIgnoreCase(s) && this.complete; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final AuthScope authScope = new AuthScope(host, getRealm(), getName()); final Credentials credentials = credentialsProvider.getCredentials( authScope, context); if (credentials instanceof UsernamePasswordCredentials) { this.credentials = (UsernamePasswordCredentials) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } this.credentials = null; return false; } @Override public Principal getPrincipal() { return null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { Args.notNull(request, "HTTP request"); if (this.paramMap.get("realm") == null) { throw new AuthenticationException("missing realm"); } if (this.paramMap.get("nonce") == null) { throw new AuthenticationException("missing nonce"); } if (context != null) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String nextNonce = clientContext.getNextNonce(); if (!TextUtils.isBlank(nextNonce)) { this.paramMap.put("nonce", nextNonce); clientContext.setNextNonce(null); } } return createDigestResponse(request); } private static MessageDigest createMessageDigest( final String digAlg) throws UnsupportedDigestAlgorithmException { try { return MessageDigest.getInstance(digAlg); } catch (final Exception e) { throw new UnsupportedDigestAlgorithmException( "Unsupported algorithm in HTTP Digest authentication: " + digAlg); } } private String createDigestResponse(final HttpRequest request) throws AuthenticationException { if (credentials == null) { throw new AuthenticationException("User credentials have not been provided"); } final String uri = request.getRequestUri(); final String method = request.getMethod(); final String realm = this.paramMap.get("realm"); final String nonce = this.paramMap.get("nonce"); final String opaque = this.paramMap.get("opaque"); final String algorithm = this.paramMap.get("algorithm"); final Set qopset = new HashSet<>(8); QualityOfProtection qop = QualityOfProtection.UNKNOWN; final String qoplist = this.paramMap.get("qop"); if (qoplist != null) { final StringTokenizer tok = new StringTokenizer(qoplist, ","); while (tok.hasMoreTokens()) { final String variant = tok.nextToken().trim(); qopset.add(variant.toLowerCase(Locale.ROOT)); } final HttpEntity entity = request instanceof ClassicHttpRequest ? ((ClassicHttpRequest) request).getEntity() : null; if (entity != null && qopset.contains("auth-int")) { qop = QualityOfProtection.AUTH_INT; } else if (qopset.contains("auth")) { qop = QualityOfProtection.AUTH; } else if (qopset.contains("auth-int")) { qop = QualityOfProtection.AUTH_INT; } } else { qop = QualityOfProtection.MISSING; } if (qop == QualityOfProtection.UNKNOWN) { throw new AuthenticationException("None of the qop methods is supported: " + qoplist); } final Charset charset = AuthSchemeSupport.parseCharset(paramMap.get("charset"), defaultCharset); // If an algorithm is not specified, default to MD5. DigestAlgorithm digAlg = null; final MessageDigest digester; try { digAlg = DigestAlgorithm.fromString(algorithm == null ? "MD5" : algorithm); digester = createMessageDigest(digAlg.getBaseAlgorithm()); } catch (final UnsupportedDigestAlgorithmException ex) { throw new AuthenticationException("Unsupported digest algorithm: " + digAlg); } if (nonce.equals(this.lastNonce)) { nounceCount++; } else { nounceCount = 1; cnonce = null; lastNonce = nonce; } final StringBuilder sb = new StringBuilder(8); try (final Formatter formatter = new Formatter(sb, Locale.ROOT)) { formatter.format("%08x", nounceCount); } final String nc = sb.toString(); if (cnonce == null) { cnonce = formatHex(createCnonce(digAlg)); } if (buffer == null) { buffer = new ByteArrayBuilder(128); } else { buffer.reset(); } buffer.charset(charset); a1 = null; a2 = null; // Extract username and username* String username = credentials.getUserName(); String encodedUsername = null; // Check if 'username' has invalid characters and use 'username*' if (username != null && containsInvalidABNFChars(username)) { encodedUsername = "UTF-8''" + PercentCodec.RFC5987.encode(username); } final String usernameForDigest; if (this.userhashSupported) { final String usernameRealm = username + ":" + realm; final byte[] hashedBytes = digester.digest(usernameRealm.getBytes(StandardCharsets.UTF_8)); usernameForDigest = formatHex(hashedBytes); // Use hashed username for digest username = usernameForDigest; } else if (encodedUsername != null) { usernameForDigest = encodedUsername; // Use encoded username for digest } else { usernameForDigest = username; // Use regular username for digest } // 3.2.2.2: Calculating digest if (digAlg.isSessionBased()) { // H( unq(username-value) ":" unq(realm-value) ":" passwd ) // ":" unq(nonce-value) // ":" unq(cnonce-value) // calculated one per session buffer.append(username).append(":").append(realm).append(":").append(credentials.getUserPassword()); final String checksum = formatHex(digester.digest(this.buffer.toByteArray())); buffer.reset(); buffer.append(checksum).append(":").append(nonce).append(":").append(cnonce); } else { // unq(username-value) ":" unq(realm-value) ":" passwd buffer.append(username).append(":").append(realm).append(":").append(credentials.getUserPassword()); } a1 = buffer.toByteArray(); final String hasha1 = formatHex(digester.digest(a1)); buffer.reset(); if (qop == QualityOfProtection.AUTH) { // Method ":" digest-uri-value a2 = buffer.append(method).append(":").append(uri).toByteArray(); } else if (qop == QualityOfProtection.AUTH_INT) { // Method ":" digest-uri-value ":" H(entity-body) final HttpEntity entity = request instanceof ClassicHttpRequest ? ((ClassicHttpRequest) request).getEntity() : null; if (entity != null && !entity.isRepeatable()) { // If the entity is not repeatable, try falling back onto QOP_AUTH if (qopset.contains("auth")) { qop = QualityOfProtection.AUTH; a2 = buffer.append(method).append(":").append(uri).toByteArray(); } else { throw new AuthenticationException("Qop auth-int cannot be used with " + "a non-repeatable entity"); } } else { final HttpEntityDigester entityDigester = new HttpEntityDigester(digester); try { if (entity != null) { entity.writeTo(entityDigester); } entityDigester.close(); } catch (final IOException ex) { throw new AuthenticationException("I/O error reading entity content", ex); } a2 = buffer.append(method).append(":").append(uri) .append(":").append(formatHex(entityDigester.getDigest())).toByteArray(); } } else { a2 = buffer.append(method).append(":").append(uri).toByteArray(); } final String hasha2 = formatHex(digester.digest(a2)); buffer.reset(); // 3.2.2.1 final byte[] digestInput; if (qop == QualityOfProtection.MISSING) { buffer.append(hasha1).append(":").append(nonce).append(":").append(hasha2); } else { buffer.append(hasha1).append(":").append(nonce).append(":").append(nc).append(":") .append(cnonce).append(":").append(qop == QualityOfProtection.AUTH_INT ? "auth-int" : "auth") .append(":").append(hasha2); } digestInput = buffer.toByteArray(); buffer.reset(); final String digest = formatHex(digester.digest(digestInput)); final CharArrayBuffer buffer = new CharArrayBuffer(128); buffer.append(StandardAuthScheme.DIGEST + " "); final List params = new ArrayList<>(20); if (this.userhashSupported) { // Use hashed username for the 'username' parameter params.add(new BasicNameValuePair("username", usernameForDigest)); params.add(new BasicNameValuePair("userhash", "true")); } else if (encodedUsername != null) { // Use encoded 'username*' parameter params.add(new BasicNameValuePair("username*", encodedUsername)); } else { // Use regular 'username' parameter params.add(new BasicNameValuePair("username", username)); } params.add(new BasicNameValuePair("realm", realm)); params.add(new BasicNameValuePair("nonce", nonce)); params.add(new BasicNameValuePair("uri", uri)); params.add(new BasicNameValuePair("response", digest)); if (qop != QualityOfProtection.MISSING) { params.add(new BasicNameValuePair("qop", qop == QualityOfProtection.AUTH_INT ? "auth-int" : "auth")); params.add(new BasicNameValuePair("nc", nc)); params.add(new BasicNameValuePair("cnonce", cnonce)); } if (algorithm != null) { params.add(new BasicNameValuePair("algorithm", algorithm)); } if (opaque != null) { params.add(new BasicNameValuePair("opaque", opaque)); } for (int i = 0; i < params.size(); i++) { final BasicNameValuePair param = params.get(i); if (i > 0) { buffer.append(", "); } final String name = param.getName(); final boolean noQuotes = "nc".equals(name) || "qop".equals(name) || "algorithm".equals(name); BasicHeaderValueFormatter.INSTANCE.formatNameValuePair(buffer, param, !noQuotes); } return buffer.toString(); } @Internal public String getNonce() { return lastNonce; } @Internal public long getNounceCount() { return nounceCount; } @Internal public String getCnonce() { return cnonce; } String getA1() { return a1 != null ? new String(a1, StandardCharsets.US_ASCII) : null; } String getA2() { return a2 != null ? new String(a2, StandardCharsets.US_ASCII) : null; } /** * Encodes a byte array digest into a hexadecimal string. *

* This method supports digests of various lengths, such as 16 bytes (128-bit) for MD5, * 32 bytes (256-bit) for SHA-256, and SHA-512/256. Each byte is converted to two * hexadecimal characters, so the resulting string length is twice the byte array length. *

* * @param binaryData the array containing the digest bytes * @return encoded hexadecimal string, or {@code null} if encoding failed */ static String formatHex(final byte[] binaryData) { final int n = binaryData.length; final char[] buffer = new char[n * 2]; for (int i = 0; i < n; i++) { final int low = binaryData[i] & 0x0f; final int high = (binaryData[i] & 0xf0) >> 4; buffer[i * 2] = HEXADECIMAL[high]; buffer[(i * 2) + 1] = HEXADECIMAL[low]; } return new String(buffer); } /** * Creates a random cnonce value based on the specified algorithm's expected entropy. * Adjusts the length of the byte array based on the algorithm to ensure sufficient entropy. * * @param algorithm the algorithm for which the cnonce is being generated (e.g., "MD5", "SHA-256", "SHA-512-256"). * @return The cnonce value as a byte array. * @since 5.5 */ static byte[] createCnonce(final DigestAlgorithm algorithm) { final SecureRandom rnd = new SecureRandom(); final int length; switch (algorithm.name().toUpperCase()) { case "SHA-256": case "SHA-512/256": length = 32; break; case "MD5": default: length = 16; break; } final byte[] tmp = new byte[length]; rnd.nextBytes(tmp); return tmp; } private void writeObject(final ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeUTF(defaultCharset.name()); } private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); this.defaultCharset = Charset.forName(in.readUTF()); } @Override public String toString() { return getName() + this.paramMap; } /** * Checks if a given string contains characters that are not allowed * in an ABNF quoted-string as per standard specifications. *

* The method checks for: * - Control characters (ASCII 0x00 to 0x1F and 0x7F). * - Characters outside the printable ASCII range (above 0x7E). * - Double quotes (") and backslashes (\), which are not allowed. *

* * @param value The string to be checked for invalid ABNF characters. * @return {@code true} if invalid characters are found, {@code false} otherwise. * @throws IllegalArgumentException if the input string is null. */ private boolean containsInvalidABNFChars(final String value) { if (value == null) { throw new IllegalArgumentException("Input string should not be null."); } for (int i = 0; i < value.length(); i++) { final char c = value.charAt(i); // Check for control characters and DEL if (c <= 0x1F || c == 0x7F) { return true; } // Check for characters outside the range 0x20 to 0x7E if (c > 0x7E) { return true; } // Exclude double quotes and backslash if (c == '"' || c == '\\') { return true; } } return false; } /** * Enum representing supported digest algorithms for HTTP Digest Authentication, * including session-based variants. */ private enum DigestAlgorithm { /** * MD5 digest algorithm. */ MD5("MD5", false), /** * MD5 digest algorithm with session-based variant. */ MD5_SESS("MD5", true), /** * SHA-256 digest algorithm. */ SHA_256("SHA-256", false), /** * SHA-256 digest algorithm with session-based variant. */ SHA_256_SESS("SHA-256", true), /** * SHA-512/256 digest algorithm. */ SHA_512_256("SHA-512/256", false), /** * SHA-512/256 digest algorithm with session-based variant. */ SHA_512_256_SESS("SHA-512/256", true); private final String baseAlgorithm; private final boolean sessionBased; /** * Constructor for {@code DigestAlgorithm}. * * @param baseAlgorithm the base name of the algorithm, e.g., "MD5" or "SHA-256" * @param sessionBased indicates if the algorithm is session-based (i.e., includes the "-sess" suffix) */ DigestAlgorithm(final String baseAlgorithm, final boolean sessionBased) { this.baseAlgorithm = baseAlgorithm; this.sessionBased = sessionBased; } /** * Retrieves the base algorithm name without session suffix. * * @return the base algorithm name */ private String getBaseAlgorithm() { return baseAlgorithm; } /** * Checks if the algorithm is session-based. * * @return {@code true} if the algorithm includes the "-sess" suffix, otherwise {@code false} */ private boolean isSessionBased() { return sessionBased; } /** * Maps a string representation of an algorithm to the corresponding enum constant. * * @param algorithm the algorithm name, e.g., "SHA-256" or "SHA-512-256-sess" * @return the corresponding {@code DigestAlgorithm} constant * @throws UnsupportedDigestAlgorithmException if the algorithm is unsupported */ private static DigestAlgorithm fromString(final String algorithm) { switch (algorithm.toUpperCase(Locale.ROOT)) { case "MD5": return MD5; case "MD5-SESS": return MD5_SESS; case "SHA-256": return SHA_256; case "SHA-256-SESS": return SHA_256_SESS; case "SHA-512/256": case "SHA-512-256": return SHA_512_256; case "SHA-512-256-SESS": return SHA_512_256_SESS; default: throw new UnsupportedDigestAlgorithmException("Unsupported digest algorithm: " + algorithm); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java0100644 0000000 0000000 00000005120 00000250600 030045 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link DigestScheme} instances. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DigestSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link DigestSchemeFactory}. */ public static final DigestSchemeFactory INSTANCE = new DigestSchemeFactory(); /** * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7616 for HTTP Digest Access Authentication. Use the default constructor {@link #DigestSchemeFactory()} instead. */ @Deprecated public DigestSchemeFactory(final Charset charset) { super(); } public DigestSchemeFactory() { } @Override public AuthScheme create(final HttpContext context) { return new DigestScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/FixedCredentialsProvider.java0100644 0000000 0000000 00000004115 00000250600 031104 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.Collections; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.core5.http.protocol.HttpContext; final class FixedCredentialsProvider implements CredentialsProvider { private final Map credMap; public FixedCredentialsProvider(final Map credMap) { super(); this.credMap = Collections.unmodifiableMap(new HashMap<>(credMap)); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return CredentialsMatcher.matchCredentials(this.credMap, authScope); } @Override public String toString() { return credMap.keySet().toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/GGSSchemeBase.java0100644 0000000 0000000 00000025354 00000250600 026524 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.net.UnknownHostException; import java.security.Principal; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.InvalidCredentialsException; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.ietf.jgss.GSSContext; import org.ietf.jgss.GSSCredential; import org.ietf.jgss.GSSException; import org.ietf.jgss.GSSManager; import org.ietf.jgss.GSSName; import org.ietf.jgss.Oid; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Common behavior for {@code GSS} based authentication schemes. * * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public abstract class GGSSchemeBase implements AuthScheme { enum State { UNINITIATED, CHALLENGE_RECEIVED, TOKEN_GENERATED, FAILED, } private static final Logger LOG = LoggerFactory.getLogger(GGSSchemeBase.class); private static final String NO_TOKEN = ""; private static final String KERBEROS_SCHEME = "HTTP"; private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** Authentication process state */ private State state; private GSSCredential gssCredential; private String challenge; private byte[] token; GGSSchemeBase(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config != null ? config : org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT; this.dnsResolver = dnsResolver != null ? dnsResolver : SystemDefaultDnsResolver.INSTANCE; this.state = State.UNINITIATED; } GGSSchemeBase(final org.apache.hc.client5.http.auth.KerberosConfig config) { this(config, SystemDefaultDnsResolver.INSTANCE); } GGSSchemeBase() { this(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); } @Override public String getRealm() { return null; } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { Args.notNull(authChallenge, "AuthChallenge"); this.challenge = authChallenge.getValue() != null ? authChallenge.getValue() : NO_TOKEN; if (state == State.UNINITIATED) { token = Base64.decodeBase64(challenge.getBytes()); state = State.CHALLENGE_RECEIVED; } else { if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Authentication already attempted", exchangeId); } state = State.FAILED; } } protected GSSManager getManager() { return GSSManager.getInstance(); } /** * @since 4.4 */ protected byte[] generateGSSToken( final byte[] input, final Oid oid, final String serviceName, final String authServer) throws GSSException { final GSSManager manager = getManager(); final GSSName serverName = manager.createName(serviceName + "@" + authServer, GSSName.NT_HOSTBASED_SERVICE); final GSSContext gssContext = createGSSContext(manager, oid, serverName, gssCredential); if (input != null) { return gssContext.initSecContext(input, 0, input.length); } return gssContext.initSecContext(new byte[] {}, 0, 0); } /** * @since 5.0 */ protected GSSContext createGSSContext( final GSSManager manager, final Oid oid, final GSSName serverName, final GSSCredential gssCredential) throws GSSException { final GSSContext gssContext = manager.createContext(serverName.canonicalize(oid), oid, gssCredential, GSSContext.DEFAULT_LIFETIME); gssContext.requestMutualAuth(true); if (config.getRequestDelegCreds() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DEFAULT) { gssContext.requestCredDeleg(config.getRequestDelegCreds() == org.apache.hc.client5.http.auth.KerberosConfig.Option.ENABLE); } return gssContext; } /** * @since 4.4 */ protected abstract byte[] generateToken(byte[] input, String serviceName, String authServer) throws GSSException; @Override public boolean isChallengeComplete() { return this.state == State.TOKEN_GENERATED || this.state == State.FAILED; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final Credentials credentials = credentialsProvider.getCredentials( new AuthScope(host, null, getName()), context); if (credentials instanceof org.apache.hc.client5.http.auth.KerberosCredentials) { this.gssCredential = ((org.apache.hc.client5.http.auth.KerberosCredentials) credentials).getGSSCredential(); } else { this.gssCredential = null; } return true; } @Override public Principal getPrincipal() { return null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { Args.notNull(host, "HTTP host"); Args.notNull(request, "HTTP request"); switch (state) { case UNINITIATED: throw new AuthenticationException(getName() + " authentication has not been initiated"); case FAILED: throw new AuthenticationException(getName() + " authentication has failed"); case CHALLENGE_RECEIVED: try { final String authServer; String hostname = host.getHostName(); if (config.getUseCanonicalHostname() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DISABLE) { try { hostname = dnsResolver.resolveCanonicalHostname(host.getHostName()); } catch (final UnknownHostException ignore) { } } if (config.getStripPort() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DISABLE) { authServer = hostname; } else { authServer = hostname + ":" + host.getPort(); } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} init {}", exchangeId, authServer); } token = generateToken(token, KERBEROS_SCHEME, authServer); state = State.TOKEN_GENERATED; } catch (final GSSException gsse) { state = State.FAILED; if (gsse.getMajor() == GSSException.DEFECTIVE_CREDENTIAL || gsse.getMajor() == GSSException.CREDENTIALS_EXPIRED) { throw new InvalidCredentialsException(gsse.getMessage(), gsse); } if (gsse.getMajor() == GSSException.NO_CRED ) { throw new InvalidCredentialsException(gsse.getMessage(), gsse); } if (gsse.getMajor() == GSSException.DEFECTIVE_TOKEN || gsse.getMajor() == GSSException.DUPLICATE_TOKEN || gsse.getMajor() == GSSException.OLD_TOKEN) { throw new AuthenticationException(gsse.getMessage(), gsse); } // other error throw new AuthenticationException(gsse.getMessage()); } case TOKEN_GENERATED: final Base64 codec = new Base64(0); final String tokenstr = new String(codec.encode(token)); if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Sending response '{}' back to the auth server", exchangeId, tokenstr); } return StandardAuthScheme.SPNEGO + " " + tokenstr; default: throw new IllegalStateException("Illegal state: " + state); } } @Override public String toString() { return getName() + "{" + this.state + " " + challenge + '}'; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/HttpAuthenticator.java0100644 0000000 0000000 00000006045 00000250600 027632 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; /** * @deprecated Do not use. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public final class HttpAuthenticator extends AuthenticationHandler { @Override public boolean isChallenged( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthExchange authExchange, final HttpContext context) { return super.isChallenged(host, challengeType, response, authExchange, context); } public boolean updateAuthState( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthenticationStrategy authStrategy, final AuthExchange authExchange, final HttpContext context) { try { return handleResponse(host, challengeType, response, authStrategy, authExchange, context); } catch (final ProtocolException ex) { return false; } } @Override public void addAuthResponse( final HttpHost host, final ChallengeType challengeType, final HttpRequest request, final AuthExchange authExchange, final HttpContext context) { super.addAuthResponse(host, challengeType, request, authExchange, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/HttpEntityDigester.java0100644 0000000 0000000 00000004523 00000250600 027762 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.IOException; import java.io.OutputStream; import java.security.MessageDigest; class HttpEntityDigester extends OutputStream { private final MessageDigest digester; private boolean closed; private byte[] digest; HttpEntityDigester(final MessageDigest digester) { super(); this.digester = digester; this.digester.reset(); } @Override public void write(final int b) throws IOException { if (this.closed) { throw new IOException("Stream has been already closed"); } this.digester.update((byte) b); } @Override public void write(final byte[] b, final int off, final int len) throws IOException { if (this.closed) { throw new IOException("Stream has been already closed"); } this.digester.update(b, off, len); } @Override public void close() throws IOException { if (this.closed) { return; } this.closed = true; this.digest = this.digester.digest(); super.close(); } public byte[] getDigest() { return this.digest; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosScheme.java0100644 0000000 0000000 00000005153 00000250600 027060 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.core5.annotation.Experimental; import org.ietf.jgss.GSSException; import org.ietf.jgss.Oid; /** * Kerberos authentication scheme. *

* Please note this class is considered experimental and may be discontinued or removed * in the future. *

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated @Experimental public class KerberosScheme extends GGSSchemeBase { private static final String KERBEROS_OID = "1.2.840.113554.1.2.2"; /** * @since 5.0 */ public KerberosScheme(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(config, dnsResolver); } public KerberosScheme() { super(); } @Override public String getName() { return StandardAuthScheme.KERBEROS; } @Override protected byte[] generateToken(final byte[] input, final String serviceName, final String authServer) throws GSSException { return generateGSSToken(input, new Oid(KERBEROS_OID), serviceName, authServer); } @Override public boolean isConnectionBased() { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosSchemeFactory.java0100644 0000000 0000000 00000005774 00000250600 030421 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link KerberosScheme} instances. *

* Please note this class is considered experimental and may be discontinued or removed * in the future. *

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) @Experimental public class KerberosSchemeFactory implements AuthSchemeFactory { /** * Singleton instance for the default configuration. */ public static final KerberosSchemeFactory DEFAULT = new KerberosSchemeFactory(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** * @since 5.0 */ public KerberosSchemeFactory(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config; this.dnsResolver = dnsResolver; } @Override public AuthScheme create(final HttpContext context) { return new KerberosScheme(this.config, this.dnsResolver); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngine.java0100644 0000000 0000000 00000005010 00000250600 026047 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; /** * Abstract NTLM authentication engine. The engine can be used to * generate Type1 messages and Type3 messages in response to a * Type2 challenge. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported */ @Deprecated public interface NTLMEngine { /** * Generates a Type1 message given the domain and workstation. * * @param domain Optional Windows domain name. Can be {@code null}. * @param workstation Optional Windows workstation name. Can be * {@code null}. * @return Type1 message * @throws NTLMEngineException */ String generateType1Msg( String domain, String workstation) throws NTLMEngineException; /** * Generates a Type3 message given the user credentials and the * authentication challenge. * * @param username Windows user name * @param password Password * @param domain Windows domain name * @param workstation Windows workstation name * @param challenge Type2 challenge. * @return Type3 response. * @throws NTLMEngineException */ String generateType3Msg( String username, char[] password, String domain, String workstation, String challenge) throws NTLMEngineException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngineException.java0100644 0000000 0000000 00000004325 00000250600 027736 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthenticationException; /** * Signals NTLM protocol failure. * * @since 4.0 * * @deprecated Do not use. */ @Deprecated public class NTLMEngineException extends AuthenticationException { private static final long serialVersionUID = 6027981323731768824L; public NTLMEngineException() { super(); } /** * Creates a new NTLMEngineException with the specified message. * * @param message the exception detail message */ public NTLMEngineException(final String message) { super(message); } /** * Creates a new NTLMEngineException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public NTLMEngineException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngineImpl.java0100644 0000000 0000000 00000237672 00000250600 026716 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.Key; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.cert.Certificate; import java.security.cert.CertificateEncodingException; import java.util.Arrays; import java.util.Locale; import java.util.Random; import javax.crypto.Cipher; import javax.crypto.spec.SecretKeySpec; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.client5.http.utils.ByteArrayBuilder; /** * Provides an implementation for NTLMv1, NTLMv2, and NTLM2 Session forms of the NTLM * authentication protocol. * * @since 4.1 * * @deprecated Do not use. */ @Deprecated final class NTLMEngineImpl implements NTLMEngine { /** Unicode encoding */ private static final Charset UNICODE_LITTLE_UNMARKED = Charset.forName("UnicodeLittleUnmarked"); /** Character encoding */ private static final Charset DEFAULT_CHARSET = StandardCharsets.US_ASCII; // Flags we use; descriptions according to: // http://davenport.sourceforge.net/ntlm.html // and // http://msdn.microsoft.com/en-us/library/cc236650%28v=prot.20%29.aspx // [MS-NLMP] section 2.2.2.5 static final int FLAG_REQUEST_UNICODE_ENCODING = 0x00000001; // Unicode string encoding requested static final int FLAG_REQUEST_OEM_ENCODING = 0x00000002; // OEM string encoding requested static final int FLAG_REQUEST_TARGET = 0x00000004; // Requests target field static final int FLAG_REQUEST_SIGN = 0x00000010; // Requests all messages have a signature attached, in NEGOTIATE message. static final int FLAG_REQUEST_SEAL = 0x00000020; // Request key exchange for message confidentiality in NEGOTIATE message. MUST be used in conjunction with 56BIT. static final int FLAG_REQUEST_LAN_MANAGER_KEY = 0x00000080; // Request Lan Manager key instead of user session key static final int FLAG_REQUEST_NTLMv1 = 0x00000200; // Request NTLMv1 security. MUST be set in NEGOTIATE and CHALLENGE both static final int FLAG_DOMAIN_PRESENT = 0x00001000; // Domain is present in message static final int FLAG_WORKSTATION_PRESENT = 0x00002000; // Workstation is present in message static final int FLAG_REQUEST_ALWAYS_SIGN = 0x00008000; // Requests a signature block on all messages. Overridden by REQUEST_SIGN and REQUEST_SEAL. static final int FLAG_REQUEST_NTLM2_SESSION = 0x00080000; // From server in challenge, requesting NTLM2 session security static final int FLAG_REQUEST_VERSION = 0x02000000; // Request protocol version static final int FLAG_TARGETINFO_PRESENT = 0x00800000; // From server in challenge message, indicating targetinfo is present static final int FLAG_REQUEST_128BIT_KEY_EXCH = 0x20000000; // Request explicit 128-bit key exchange static final int FLAG_REQUEST_EXPLICIT_KEY_EXCH = 0x40000000; // Request explicit key exchange static final int FLAG_REQUEST_56BIT_ENCRYPTION = 0x80000000; // Must be used in conjunction with SEAL // Attribute-value identifiers (AvId) // according to [MS-NLMP] section 2.2.2.1 static final int MSV_AV_EOL = 0x0000; // Indicates that this is the last AV_PAIR in the list. static final int MSV_AV_NB_COMPUTER_NAME = 0x0001; // The server's NetBIOS computer name. static final int MSV_AV_NB_DOMAIN_NAME = 0x0002; // The server's NetBIOS domain name. static final int MSV_AV_DNS_COMPUTER_NAME = 0x0003; // The fully qualified domain name (FQDN) of the computer. static final int MSV_AV_DNS_DOMAIN_NAME = 0x0004; // The FQDN of the domain. static final int MSV_AV_DNS_TREE_NAME = 0x0005; // The FQDN of the forest. static final int MSV_AV_FLAGS = 0x0006; // A 32-bit value indicating server or client configuration. static final int MSV_AV_TIMESTAMP = 0x0007; // server local time static final int MSV_AV_SINGLE_HOST = 0x0008; // A Single_Host_Data structure. static final int MSV_AV_TARGET_NAME = 0x0009; // The SPN of the target server. static final int MSV_AV_CHANNEL_BINDINGS = 0x000A; // A channel bindings hash. static final int MSV_AV_FLAGS_ACCOUNT_AUTH_CONSTAINED = 0x00000001; // Indicates to the client that the account authentication is constrained. static final int MSV_AV_FLAGS_MIC = 0x00000002; // Indicates that the client is providing message integrity in the MIC field in the AUTHENTICATE_MESSAGE. static final int MSV_AV_FLAGS_UNTRUSTED_TARGET_SPN = 0x00000004; // Indicates that the client is providing a target SPN generated from an untrusted source. /** Secure random generator */ private static final java.security.SecureRandom RND_GEN; static { java.security.SecureRandom rnd = null; try { rnd = java.security.SecureRandom.getInstance("SHA1PRNG"); } catch (final Exception ignore) { // ignore } RND_GEN = rnd; } /** The signature string as bytes in the default encoding */ private static final byte[] SIGNATURE = getNullTerminatedAsciiString("NTLMSSP"); // Key derivation magic strings for the SIGNKEY algorithm defined in // [MS-NLMP] section 3.4.5.2ASCII private static final byte[] SIGN_MAGIC_SERVER = getNullTerminatedAsciiString( "session key to server-to-client signing key magic constant"); private static final byte[] SIGN_MAGIC_CLIENT = getNullTerminatedAsciiString( "session key to client-to-server signing key magic constant"); private static final byte[] SEAL_MAGIC_SERVER = getNullTerminatedAsciiString( "session key to server-to-client sealing key magic constant"); private static final byte[] SEAL_MAGIC_CLIENT = getNullTerminatedAsciiString( "session key to client-to-server sealing key magic constant"); // prefix for GSS API channel binding private static final byte[] MAGIC_TLS_SERVER_ENDPOINT = "tls-server-end-point:".getBytes(StandardCharsets.US_ASCII); private static byte[] getNullTerminatedAsciiString( final String source ) { final byte[] bytesWithoutNull = source.getBytes(StandardCharsets.US_ASCII); final byte[] target = new byte[bytesWithoutNull.length + 1]; System.arraycopy(bytesWithoutNull, 0, target, 0, bytesWithoutNull.length); target[bytesWithoutNull.length] = (byte) 0x00; return target; } private static final String TYPE_1_MESSAGE = new Type1Message().getResponse(); NTLMEngineImpl() { } /** * Returns the response for the given message. * * @param message * the message that was received from the server. * @param username * the username to authenticate with. * @param password * the password to authenticate with. * @param host * The host. * @param domain * the NT domain to authenticate in. * @return The response. */ static String getResponseFor(final String message, final String username, final char[] password, final String host, final String domain) throws NTLMEngineException { final String response; if (message == null || message.trim().isEmpty()) { response = getType1Message(host, domain); } else { final Type2Message t2m = new Type2Message(message); response = getType3Message(username, password, host, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo()); } return response; } /** * Returns the response for the given message. * * @param message * the message that was received from the server. * @param username * the username to authenticate with. * @param password * the password to authenticate with. * @param host * The host. * @param domain * the NT domain to authenticate in. * @return The response. */ static String getResponseFor(final String message, final String username, final char[] password, final String host, final String domain, final Certificate peerServerCertificate) throws NTLMEngineException { final String response; if (message == null || message.trim().isEmpty()) { response = new Type1Message(host, domain).getResponse(); } else { final Type1Message t1m = new Type1Message(host, domain); final Type2Message t2m = new Type2Message(message); response = getType3Message(username, password, host, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo(), peerServerCertificate, t1m.getBytes(), t2m.getBytes()); } return response; } /** * Creates the first message (type 1 message) in the NTLM authentication * sequence. This message includes the user name, domain and host for the * authentication session. * * @param host * the computer name of the host requesting authentication. * @param domain * The domain to authenticate with. * @return String the message to add to the HTTP request header. */ static String getType1Message(final String host, final String domain) { // For compatibility reason do not include domain and host in type 1 message //return new Type1Message(domain, host).getResponse(); return TYPE_1_MESSAGE; } /** * Creates the type 3 message using the given server nonce. The type 3 * message includes all the information for authentication, host, domain, * username and the result of encrypting the nonce sent by the server using * the user's password as the key. * * @param user * The user name. This should not include the domain name. * @param password * The password. * @param host * The host that is originating the authentication request. * @param domain * The domain to authenticate within. * @param nonce * the 8 byte array the server sent. * @return The type 3 message. * @throws NTLMEngineException * If {@link Type3Message#Type3Message(String, String, String, char[], byte[], int, String, byte[])} fails. */ static String getType3Message(final String user, final char[] password, final String host, final String domain, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { return new Type3Message(domain, host, user, password, nonce, type2Flags, target, targetInformation).getResponse(); } /** * Creates the type 3 message using the given server nonce. The type 3 * message includes all the information for authentication, host, domain, * username and the result of encrypting the nonce sent by the server using * the user's password as the key. * * @param user * The user name. This should not include the domain name. * @param password * The password. * @param host * The host that is originating the authentication request. * @param domain * The domain to authenticate within. * @param nonce * the 8 byte array the server sent. * @return The type 3 message. */ static String getType3Message(final String user, final char[] password, final String host, final String domain, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { return new Type3Message(domain, host, user, password, nonce, type2Flags, target, targetInformation, peerServerCertificate, type1Message, type2Message).getResponse(); } private static int readULong(final byte[] src, final int index) { if (src.length < index + 4) { return 0; } return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8) | ((src[index + 2] & 0xff) << 16) | ((src[index + 3] & 0xff) << 24); } private static int readUShort(final byte[] src, final int index) { if (src.length < index + 2) { return 0; } return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8); } private static byte[] readSecurityBuffer(final byte[] src, final int index) { final int length = readUShort(src, index); final int offset = readULong(src, index + 4); if (src.length < offset + length) { return new byte[length]; } final byte[] buffer = new byte[length]; System.arraycopy(src, offset, buffer, 0, length); return buffer; } /** Calculate a challenge block */ private static byte[] makeRandomChallenge(final Random random) { final byte[] rval = new byte[8]; synchronized (random) { random.nextBytes(rval); } return rval; } /** Calculate a 16-byte secondary key */ private static byte[] makeSecondaryKey(final Random random) { final byte[] rval = new byte[16]; synchronized (random) { random.nextBytes(rval); } return rval; } static class CipherGen { final Random random; final long currentTime; final String domain; final String user; final char[] password; final byte[] challenge; final String target; final byte[] targetInformation; // Information we can generate but may be passed in (for testing) byte[] clientChallenge; byte[] clientChallenge2; byte[] secondaryKey; byte[] timestamp; // Stuff we always generate byte[] lmHash; byte[] lmResponse; byte[] ntlmHash; byte[] ntlmResponse; byte[] ntlmv2Hash; byte[] lmv2Hash; byte[] lmv2Response; byte[] ntlmv2Blob; byte[] ntlmv2Response; byte[] ntlm2SessionResponse; byte[] lm2SessionResponse; byte[] lmUserSessionKey; byte[] ntlmUserSessionKey; byte[] ntlmv2UserSessionKey; byte[] ntlm2SessionResponseUserSessionKey; byte[] lanManagerSessionKey; CipherGen(final Random random, final long currentTime, final String domain, final String user, final char[] password, final byte[] challenge, final String target, final byte[] targetInformation, final byte[] clientChallenge, final byte[] clientChallenge2, final byte[] secondaryKey, final byte[] timestamp) { this.random = random; this.currentTime = currentTime; this.domain = domain; this.target = target; this.user = user; this.password = password; this.challenge = challenge; this.targetInformation = targetInformation; this.clientChallenge = clientChallenge; this.clientChallenge2 = clientChallenge2; this.secondaryKey = secondaryKey; this.timestamp = timestamp; } CipherGen(final Random random, final long currentTime, final String domain, final String user, final char[] password, final byte[] challenge, final String target, final byte[] targetInformation) { this(random, currentTime, domain, user, password, challenge, target, targetInformation, null, null, null, null); } /** Calculate and return client challenge */ byte[] getClientChallenge() { if (clientChallenge == null) { clientChallenge = makeRandomChallenge(random); } return clientChallenge; } /** Calculate and return second client challenge */ byte[] getClientChallenge2() { if (clientChallenge2 == null) { clientChallenge2 = makeRandomChallenge(random); } return clientChallenge2; } /** Calculate and return random secondary key */ byte[] getSecondaryKey() { if (secondaryKey == null) { secondaryKey = makeSecondaryKey(random); } return secondaryKey; } /** Calculate and return the LMHash */ byte[] getLMHash() throws NTLMEngineException { if (lmHash == null) { lmHash = lmHash(password); } return lmHash; } /** Calculate and return the LMResponse */ byte[] getLMResponse() throws NTLMEngineException { if (lmResponse == null) { lmResponse = lmResponse(getLMHash(), challenge); } return lmResponse; } /** Calculate and return the NTLMHash */ byte[] getNTLMHash() { if (ntlmHash == null) { ntlmHash = ntlmHash(password); } return ntlmHash; } /** Calculate and return the NTLMResponse */ byte[] getNTLMResponse() throws NTLMEngineException { if (ntlmResponse == null) { ntlmResponse = lmResponse(getNTLMHash(), challenge); } return ntlmResponse; } /** Calculate the LMv2 hash */ byte[] getLMv2Hash() { if (lmv2Hash == null) { lmv2Hash = lmv2Hash(domain, user, getNTLMHash()); } return lmv2Hash; } /** Calculate the NTLMv2 hash */ byte[] getNTLMv2Hash() { if (ntlmv2Hash == null) { ntlmv2Hash = ntlmv2Hash(domain, user, getNTLMHash()); } return ntlmv2Hash; } /** Calculate a timestamp */ byte[] getTimestamp() { if (timestamp == null) { long time = this.currentTime; time += 11644473600000L; // milliseconds from January 1, 1601 -> epoch. time *= 10000; // tenths of a microsecond. // convert to little-endian byte array. timestamp = new byte[8]; for (int i = 0; i < 8; i++) { timestamp[i] = (byte) time; time >>>= 8; } } return timestamp; } /** Calculate the NTLMv2Blob */ byte[] getNTLMv2Blob() { if (ntlmv2Blob == null) { ntlmv2Blob = createBlob(getClientChallenge2(), targetInformation, getTimestamp()); } return ntlmv2Blob; } /** Calculate the NTLMv2Response */ byte[] getNTLMv2Response() { if (ntlmv2Response == null) { ntlmv2Response = lmv2Response(getNTLMv2Hash(), challenge, getNTLMv2Blob()); } return ntlmv2Response; } /** Calculate the LMv2Response */ byte[] getLMv2Response() { if (lmv2Response == null) { lmv2Response = lmv2Response(getLMv2Hash(), challenge, getClientChallenge()); } return lmv2Response; } /** Get NTLM2SessionResponse */ byte[] getNTLM2SessionResponse() throws NTLMEngineException { if (ntlm2SessionResponse == null) { ntlm2SessionResponse = ntlm2SessionResponse(getNTLMHash(), challenge, getClientChallenge()); } return ntlm2SessionResponse; } /** Calculate and return LM2 session response */ byte[] getLM2SessionResponse() { if (lm2SessionResponse == null) { final byte[] clntChallenge = getClientChallenge(); lm2SessionResponse = new byte[24]; System.arraycopy(clntChallenge, 0, lm2SessionResponse, 0, clntChallenge.length); Arrays.fill(lm2SessionResponse, clntChallenge.length, lm2SessionResponse.length, (byte) 0x00); } return lm2SessionResponse; } /** Get LMUserSessionKey */ byte[] getLMUserSessionKey() throws NTLMEngineException { if (lmUserSessionKey == null) { lmUserSessionKey = new byte[16]; System.arraycopy(getLMHash(), 0, lmUserSessionKey, 0, 8); Arrays.fill(lmUserSessionKey, 8, 16, (byte) 0x00); } return lmUserSessionKey; } /** Get NTLMUserSessionKey */ byte[] getNTLMUserSessionKey() { if (ntlmUserSessionKey == null) { final MD4 md4 = new MD4(); md4.update(getNTLMHash()); ntlmUserSessionKey = md4.getOutput(); } return ntlmUserSessionKey; } /** GetNTLMv2UserSessionKey */ byte[] getNTLMv2UserSessionKey() { if (ntlmv2UserSessionKey == null) { final byte[] ntlmv2hash = getNTLMv2Hash(); final byte[] truncatedResponse = new byte[16]; System.arraycopy(getNTLMv2Response(), 0, truncatedResponse, 0, 16); ntlmv2UserSessionKey = hmacMD5(truncatedResponse, ntlmv2hash); } return ntlmv2UserSessionKey; } /** Get NTLM2SessionResponseUserSessionKey */ byte[] getNTLM2SessionResponseUserSessionKey() { if (ntlm2SessionResponseUserSessionKey == null) { final byte[] ntlm2SessionResponseNonce = getLM2SessionResponse(); final byte[] sessionNonce = new byte[challenge.length + ntlm2SessionResponseNonce.length]; System.arraycopy(challenge, 0, sessionNonce, 0, challenge.length); System.arraycopy(ntlm2SessionResponseNonce, 0, sessionNonce, challenge.length, ntlm2SessionResponseNonce.length); ntlm2SessionResponseUserSessionKey = hmacMD5(sessionNonce,getNTLMUserSessionKey()); } return ntlm2SessionResponseUserSessionKey; } /** Get LAN Manager session key */ byte[] getLanManagerSessionKey() throws NTLMEngineException { if (lanManagerSessionKey == null) { try { final byte[] keyBytes = new byte[14]; System.arraycopy(getLMHash(), 0, keyBytes, 0, 8); Arrays.fill(keyBytes, 8, keyBytes.length, (byte)0xbd); final Key lowKey = createDESKey(keyBytes, 0); final Key highKey = createDESKey(keyBytes, 7); final byte[] truncatedResponse = new byte[8]; System.arraycopy(getLMResponse(), 0, truncatedResponse, 0, truncatedResponse.length); Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowPart = des.doFinal(truncatedResponse); des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highPart = des.doFinal(truncatedResponse); lanManagerSessionKey = new byte[16]; System.arraycopy(lowPart, 0, lanManagerSessionKey, 0, lowPart.length); System.arraycopy(highPart, 0, lanManagerSessionKey, lowPart.length, highPart.length); } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } return lanManagerSessionKey; } } /** Calculates HMAC-MD5 */ static byte[] hmacMD5(final byte[] value, final byte[] key) { final HMACMD5 hmacMD5 = new HMACMD5(key); hmacMD5.update(value); return hmacMD5.getOutput(); } /** Calculates RC4 */ static byte[] RC4(final byte[] value, final byte[] key) throws NTLMEngineException { try { final Cipher rc4 = Cipher.getInstance("RC4"); rc4.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key, "RC4")); return rc4.doFinal(value); } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Calculates the NTLM2 Session Response for the given challenge, using the * specified password and client challenge. * * @return The NTLM2 Session Response. This is placed in the NTLM response * field of the Type 3 message; the LM response field contains the * client challenge, null-padded to 24 bytes. */ static byte[] ntlm2SessionResponse(final byte[] ntlmHash, final byte[] challenge, final byte[] clientChallenge) throws NTLMEngineException { try { final MessageDigest md5 = getMD5(); md5.update(challenge); md5.update(clientChallenge); final byte[] digest = md5.digest(); final byte[] sessionHash = new byte[8]; System.arraycopy(digest, 0, sessionHash, 0, 8); return lmResponse(ntlmHash, sessionHash); } catch (final Exception e) { if (e instanceof NTLMEngineException) { throw (NTLMEngineException) e; } throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the LM Hash of the user's password. * * @param password * The password. * * @return The LM Hash of the given password, used in the calculation of the * LM Response. */ private static byte[] lmHash(final char[] password) throws NTLMEngineException { try { final char[] tmp = new char[password.length]; for (int i = 0; i < password.length; i++) { tmp[i] = Character.toUpperCase(password[i]); } final byte[] oemPassword = new ByteArrayBuilder().append(tmp).toByteArray(); final int length = Math.min(oemPassword.length, 14); final byte[] keyBytes = new byte[14]; System.arraycopy(oemPassword, 0, keyBytes, 0, length); final Key lowKey = createDESKey(keyBytes, 0); final Key highKey = createDESKey(keyBytes, 7); final byte[] magicConstant = "KGS!@#$%".getBytes(StandardCharsets.US_ASCII); final Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowHash = des.doFinal(magicConstant); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highHash = des.doFinal(magicConstant); final byte[] lmHash = new byte[16]; System.arraycopy(lowHash, 0, lmHash, 0, 8); System.arraycopy(highHash, 0, lmHash, 8, 8); return lmHash; } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the NTLM Hash of the user's password. * * @param password * The password. * * @return The NTLM Hash of the given password, used in the calculation of * the NTLM Response and the NTLMv2 and LMv2 Hashes. */ private static byte[] ntlmHash(final char[] password) { final byte[] unicodePassword = new ByteArrayBuilder() .charset(UNICODE_LITTLE_UNMARKED).append(password).toByteArray(); final MD4 md4 = new MD4(); md4.update(unicodePassword); return md4.getOutput(); } /** * Creates the LMv2 Hash of the user's password. * * @return The LMv2 Hash, used in the calculation of the NTLMv2 and LMv2 * Responses. */ private static byte[] lmv2Hash(final String domain, final String user, final byte[] ntlmHash) { final HMACMD5 hmacMD5 = new HMACMD5(ntlmHash); // Upper case username, upper case domain! hmacMD5.update(user.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); if (domain != null) { hmacMD5.update(domain.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); } return hmacMD5.getOutput(); } /** * Creates the NTLMv2 Hash of the user's password. * * @return The NTLMv2 Hash, used in the calculation of the NTLMv2 and LMv2 * Responses. */ private static byte[] ntlmv2Hash(final String domain, final String user, final byte[] ntlmHash) { final HMACMD5 hmacMD5 = new HMACMD5(ntlmHash); // Upper case username, mixed case target!! hmacMD5.update(user.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); if (domain != null) { hmacMD5.update(domain.getBytes(UNICODE_LITTLE_UNMARKED)); } return hmacMD5.getOutput(); } /** * Creates the LM Response from the given hash and Type 2 challenge. * * @param hash * The LM or NTLM Hash. * @param challenge * The server challenge from the Type 2 message. * * @return The response (either LM or NTLM, depending on the provided hash). */ private static byte[] lmResponse(final byte[] hash, final byte[] challenge) throws NTLMEngineException { try { final byte[] keyBytes = new byte[21]; System.arraycopy(hash, 0, keyBytes, 0, 16); final Key lowKey = createDESKey(keyBytes, 0); final Key middleKey = createDESKey(keyBytes, 7); final Key highKey = createDESKey(keyBytes, 14); final Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowResponse = des.doFinal(challenge); des.init(Cipher.ENCRYPT_MODE, middleKey); final byte[] middleResponse = des.doFinal(challenge); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highResponse = des.doFinal(challenge); final byte[] lmResponse = new byte[24]; System.arraycopy(lowResponse, 0, lmResponse, 0, 8); System.arraycopy(middleResponse, 0, lmResponse, 8, 8); System.arraycopy(highResponse, 0, lmResponse, 16, 8); return lmResponse; } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the LMv2 Response from the given hash, client data, and Type 2 * challenge. * * @param hash * The NTLMv2 Hash. * @param clientData * The client data (blob or client challenge). * @param challenge * The server challenge from the Type 2 message. * * @return The response (either NTLMv2 or LMv2, depending on the client * data). */ private static byte[] lmv2Response(final byte[] hash, final byte[] challenge, final byte[] clientData) { final HMACMD5 hmacMD5 = new HMACMD5(hash); hmacMD5.update(challenge); hmacMD5.update(clientData); final byte[] mac = hmacMD5.getOutput(); final byte[] lmv2Response = new byte[mac.length + clientData.length]; System.arraycopy(mac, 0, lmv2Response, 0, mac.length); System.arraycopy(clientData, 0, lmv2Response, mac.length, clientData.length); return lmv2Response; } enum Mode { CLIENT, SERVER } static class Handle { private final byte[] signingKey; private byte[] sealingKey; private final Cipher rc4; final Mode mode; final private boolean isConnection; int sequenceNumber; Handle( final byte[] exportedSessionKey, final Mode mode, final boolean isConnection ) throws NTLMEngineException { this.isConnection = isConnection; this.mode = mode; try { final MessageDigest signMd5 = getMD5(); final MessageDigest sealMd5 = getMD5(); signMd5.update( exportedSessionKey ); sealMd5.update( exportedSessionKey ); if ( mode == Mode.CLIENT ) { signMd5.update( SIGN_MAGIC_CLIENT ); sealMd5.update( SEAL_MAGIC_CLIENT ); } else { signMd5.update( SIGN_MAGIC_SERVER ); sealMd5.update( SEAL_MAGIC_SERVER ); } signingKey = signMd5.digest(); sealingKey = sealMd5.digest(); } catch ( final Exception e ) { throw new NTLMEngineException( e.getMessage(), e ); } rc4 = initCipher(); } byte[] getSigningKey() { return signingKey; } byte[] getSealingKey() { return sealingKey; } private Cipher initCipher() throws NTLMEngineException { final Cipher cipher; try { cipher = Cipher.getInstance( "RC4" ); if ( mode == Mode.CLIENT ) { cipher.init( Cipher.ENCRYPT_MODE, new SecretKeySpec( sealingKey, "RC4" ) ); } else { cipher.init( Cipher.DECRYPT_MODE, new SecretKeySpec( sealingKey, "RC4" ) ); } } catch ( final Exception e ) { throw new NTLMEngineException( e.getMessage(), e ); } return cipher; } private void advanceMessageSequence() throws NTLMEngineException { if ( !isConnection ) { final MessageDigest sealMd5 = getMD5(); sealMd5.update( sealingKey ); final byte[] seqNumBytes = new byte[4]; writeULong( seqNumBytes, sequenceNumber, 0 ); sealMd5.update( seqNumBytes ); sealingKey = sealMd5.digest(); initCipher(); } sequenceNumber++; } private byte[] encrypt( final byte[] data ) { return rc4.update( data ); } private byte[] decrypt( final byte[] data ) { return rc4.update( data ); } private byte[] computeSignature( final byte[] message ) { final byte[] sig = new byte[16]; // version sig[0] = 0x01; sig[1] = 0x00; sig[2] = 0x00; sig[3] = 0x00; // HMAC (first 8 bytes) final HMACMD5 hmacMD5 = new HMACMD5( signingKey ); hmacMD5.update( encodeLong( sequenceNumber ) ); hmacMD5.update( message ); final byte[] hmac = hmacMD5.getOutput(); final byte[] trimmedHmac = new byte[8]; System.arraycopy( hmac, 0, trimmedHmac, 0, 8 ); final byte[] encryptedHmac = encrypt( trimmedHmac ); System.arraycopy( encryptedHmac, 0, sig, 4, 8 ); // sequence number encodeLong( sig, 12, sequenceNumber ); return sig; } private boolean validateSignature( final byte[] signature, final byte[] message ) { final byte[] computedSignature = computeSignature( message ); // log.info( "SSSSS validateSignature("+seqNumber+")\n" // + " received: " + DebugUtil.dump( signature ) + "\n" // + " computed: " + DebugUtil.dump( computedSignature ) ); return MessageDigest.isEqual( signature, computedSignature ); } byte[] signAndEncryptMessage( final byte[] cleartextMessage ) throws NTLMEngineException { final byte[] encryptedMessage = encrypt( cleartextMessage ); final byte[] signature = computeSignature( cleartextMessage ); final byte[] outMessage = new byte[signature.length + encryptedMessage.length]; System.arraycopy( signature, 0, outMessage, 0, signature.length ); System.arraycopy( encryptedMessage, 0, outMessage, signature.length, encryptedMessage.length ); advanceMessageSequence(); return outMessage; } byte[] decryptAndVerifySignedMessage( final byte[] inMessage ) throws NTLMEngineException { final byte[] signature = new byte[16]; System.arraycopy( inMessage, 0, signature, 0, signature.length ); final byte[] encryptedMessage = new byte[inMessage.length - 16]; System.arraycopy( inMessage, 16, encryptedMessage, 0, encryptedMessage.length ); final byte[] cleartextMessage = decrypt( encryptedMessage ); if ( !validateSignature( signature, cleartextMessage ) ) { throw new NTLMEngineException( "Wrong signature" ); } advanceMessageSequence(); return cleartextMessage; } } private static byte[] encodeLong( final int value ) { final byte[] enc = new byte[4]; encodeLong( enc, 0, value ); return enc; } private static void encodeLong( final byte[] buf, final int offset, final int value ) { buf[offset + 0] = ( byte ) ( value & 0xff ); buf[offset + 1] = ( byte ) ( value >> 8 & 0xff ); buf[offset + 2] = ( byte ) ( value >> 16 & 0xff ); buf[offset + 3] = ( byte ) ( value >> 24 & 0xff ); } /** * Creates the NTLMv2 blob from the given target information block and * client challenge. * * @param targetInformation * The target information block from the Type 2 message. * @param clientChallenge * The random 8-byte client challenge. * * @return The blob, used in the calculation of the NTLMv2 Response. */ private static byte[] createBlob(final byte[] clientChallenge, final byte[] targetInformation, final byte[] timestamp) { final byte[] blobSignature = new byte[] { (byte) 0x01, (byte) 0x01, (byte) 0x00, (byte) 0x00 }; final byte[] reserved = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] unknown1 = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] unknown2 = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] blob = new byte[blobSignature.length + reserved.length + timestamp.length + 8 + unknown1.length + targetInformation.length + unknown2.length]; int offset = 0; System.arraycopy(blobSignature, 0, blob, offset, blobSignature.length); offset += blobSignature.length; System.arraycopy(reserved, 0, blob, offset, reserved.length); offset += reserved.length; System.arraycopy(timestamp, 0, blob, offset, timestamp.length); offset += timestamp.length; System.arraycopy(clientChallenge, 0, blob, offset, 8); offset += 8; System.arraycopy(unknown1, 0, blob, offset, unknown1.length); offset += unknown1.length; System.arraycopy(targetInformation, 0, blob, offset, targetInformation.length); offset += targetInformation.length; System.arraycopy(unknown2, 0, blob, offset, unknown2.length); offset += unknown2.length; return blob; } /** * Creates a DES encryption key from the given key material. * * @param bytes * A byte array containing the DES key material. * @param offset * The offset in the given byte array at which the 7-byte key * material starts. * * @return A DES encryption key created from the key material starting at * the specified offset in the given byte array. */ private static Key createDESKey(final byte[] bytes, final int offset) { final byte[] keyBytes = new byte[7]; System.arraycopy(bytes, offset, keyBytes, 0, 7); final byte[] material = new byte[8]; material[0] = keyBytes[0]; material[1] = (byte) (keyBytes[0] << 7 | (keyBytes[1] & 0xff) >>> 1); material[2] = (byte) (keyBytes[1] << 6 | (keyBytes[2] & 0xff) >>> 2); material[3] = (byte) (keyBytes[2] << 5 | (keyBytes[3] & 0xff) >>> 3); material[4] = (byte) (keyBytes[3] << 4 | (keyBytes[4] & 0xff) >>> 4); material[5] = (byte) (keyBytes[4] << 3 | (keyBytes[5] & 0xff) >>> 5); material[6] = (byte) (keyBytes[5] << 2 | (keyBytes[6] & 0xff) >>> 6); material[7] = (byte) (keyBytes[6] << 1); oddParity(material); return new SecretKeySpec(material, "DES"); } /** * Applies odd parity to the given byte array. * * @param bytes * The data whose parity bits are to be adjusted for odd parity. */ private static void oddParity(final byte[] bytes) { for (int i = 0; i < bytes.length; i++) { final byte b = bytes[i]; final boolean needsParity = (((b >>> 7) ^ (b >>> 6) ^ (b >>> 5) ^ (b >>> 4) ^ (b >>> 3) ^ (b >>> 2) ^ (b >>> 1)) & 0x01) == 0; if (needsParity) { bytes[i] |= (byte) 0x01; } else { bytes[i] &= (byte) 0xfe; } } } /** * Find the character set based on the flags. * @param flags is the flags. * @return the character set. */ private static Charset getCharset(final int flags) { if ((flags & FLAG_REQUEST_UNICODE_ENCODING) == 0) { return DEFAULT_CHARSET; } return UNICODE_LITTLE_UNMARKED; } /** NTLM message generation, base class */ static class NTLMMessage { /** The current response */ byte[] messageContents; /** The current output position */ int currentOutputPosition; /** Constructor to use when message contents are not yet known */ NTLMMessage() { } /** Constructor taking a string */ NTLMMessage(final String messageBody, final int expectedType) throws NTLMEngineException { this(Base64.decodeBase64(messageBody.getBytes(DEFAULT_CHARSET)), expectedType); } /** Constructor to use when message bytes are known */ NTLMMessage(final byte[] message, final int expectedType) throws NTLMEngineException { messageContents = message; // Look for NTLM message if (messageContents.length < SIGNATURE.length) { throw new NTLMEngineException("NTLM message decoding error - packet too short"); } int i = 0; while (i < SIGNATURE.length) { if (messageContents[i] != SIGNATURE[i]) { throw new NTLMEngineException( "NTLM message expected - instead got unrecognized bytes"); } i++; } // Check to be sure there's a type 2 message indicator next final int type = readULong(SIGNATURE.length); if (type != expectedType) { throw new NTLMEngineException("NTLM type " + expectedType + " message expected - instead got type " + type); } currentOutputPosition = messageContents.length; } /** * Get the length of the signature and flags, so calculations can adjust * offsets accordingly. */ int getPreambleLength() { return SIGNATURE.length + 4; } /** Get the message length */ int getMessageLength() { return currentOutputPosition; } /** Read a byte from a position within the message buffer */ byte readByte(final int position) throws NTLMEngineException { if (messageContents.length < position + 1) { throw new NTLMEngineException("NTLM: Message too short"); } return messageContents[position]; } /** Read a bunch of bytes from a position in the message buffer */ void readBytes(final byte[] buffer, final int position) throws NTLMEngineException { if (messageContents.length < position + buffer.length) { throw new NTLMEngineException("NTLM: Message too short"); } System.arraycopy(messageContents, position, buffer, 0, buffer.length); } /** Read a ushort from a position within the message buffer */ int readUShort(final int position) { return NTLMEngineImpl.readUShort(messageContents, position); } /** Read a ulong from a position within the message buffer */ int readULong(final int position) { return NTLMEngineImpl.readULong(messageContents, position); } /** Read a security buffer from a position within the message buffer */ byte[] readSecurityBuffer(final int position) { return NTLMEngineImpl.readSecurityBuffer(messageContents, position); } /** * Prepares the object to create a response of the given length. * * @param maxlength * the maximum length of the response to prepare, * including the type and the signature (which this method * adds). */ void prepareResponse(final int maxlength, final int messageType) { messageContents = new byte[maxlength]; currentOutputPosition = 0; addBytes(SIGNATURE); addULong(messageType); } /** * Adds the given byte to the response. * * @param b * the byte to add. */ void addByte(final byte b) { messageContents[currentOutputPosition] = b; currentOutputPosition++; } /** * Adds the given bytes to the response. * * @param bytes * the bytes to add. */ void addBytes(final byte[] bytes) { if (bytes == null) { return; } for (final byte b : bytes) { messageContents[currentOutputPosition] = b; currentOutputPosition++; } } /** Adds a USHORT to the response */ void addUShort(final int value) { addByte((byte) (value & 0xff)); addByte((byte) (value >> 8 & 0xff)); } /** Adds a ULong to the response */ void addULong(final int value) { addByte((byte) (value & 0xff)); addByte((byte) (value >> 8 & 0xff)); addByte((byte) (value >> 16 & 0xff)); addByte((byte) (value >> 24 & 0xff)); } /** * Returns the response that has been generated after shrinking the * array if required and base64 encodes the response. * * @return The response as above. */ String getResponse() { return new String(Base64.encodeBase64(getBytes()), StandardCharsets.US_ASCII); } byte[] getBytes() { if (messageContents == null) { buildMessage(); } if (messageContents.length > currentOutputPosition) { final byte[] tmp = new byte[currentOutputPosition]; System.arraycopy( messageContents, 0, tmp, 0, currentOutputPosition ); messageContents = tmp; } return messageContents; } void buildMessage() { throw new RuntimeException("Message builder not implemented for " + getClass().getName()); } } /** Type 1 message assembly class */ static class Type1Message extends NTLMMessage { private final byte[] hostBytes; private final byte[] domainBytes; private final int flags; Type1Message(final String domain, final String host) { this(domain, host, null); } Type1Message(final String domain, final String host, final Integer flags) { super(); this.flags = flags == null ? getDefaultFlags() : flags.intValue(); // See HTTPCLIENT-1662 final String unqualifiedHost = host; final String unqualifiedDomain = domain; hostBytes = unqualifiedHost != null ? unqualifiedHost.getBytes(UNICODE_LITTLE_UNMARKED) : null; domainBytes = unqualifiedDomain != null ? unqualifiedDomain.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED) : null; } Type1Message() { super(); hostBytes = null; domainBytes = null; flags = getDefaultFlags(); } private int getDefaultFlags() { return //FLAG_WORKSTATION_PRESENT | //FLAG_DOMAIN_PRESENT | // Required flags //FLAG_REQUEST_LAN_MANAGER_KEY | FLAG_REQUEST_NTLMv1 | FLAG_REQUEST_NTLM2_SESSION | // Protocol version request FLAG_REQUEST_VERSION | // Recommended privacy settings FLAG_REQUEST_ALWAYS_SIGN | //FLAG_REQUEST_SEAL | //FLAG_REQUEST_SIGN | // These must be set according to documentation, based on use of SEAL above FLAG_REQUEST_128BIT_KEY_EXCH | FLAG_REQUEST_56BIT_ENCRYPTION | //FLAG_REQUEST_EXPLICIT_KEY_EXCH | FLAG_REQUEST_UNICODE_ENCODING; } /** * Getting the response involves building the message before returning * it */ @Override void buildMessage() { int domainBytesLength = 0; if ( domainBytes != null ) { domainBytesLength = domainBytes.length; } int hostBytesLength = 0; if ( hostBytes != null ) { hostBytesLength = hostBytes.length; } // Now, build the message. Calculate its length first, including // signature or type. final int finalLength = 32 + 8 + hostBytesLength + domainBytesLength; // Set up the response. This will initialize the signature, message // type, and flags. prepareResponse(finalLength, 1); // Flags. These are the complete set of flags we support. addULong(flags); // Domain length (two times). addUShort(domainBytesLength); addUShort(domainBytesLength); // Domain offset. addULong(hostBytesLength + 32 + 8); // Host length (two times). addUShort(hostBytesLength); addUShort(hostBytesLength); // Host offset (always 32 + 8). addULong(32 + 8); // Version addUShort(0x0105); // Build addULong(2600); // NTLM revision addUShort(0x0f00); // Host (workstation) String. if (hostBytes != null) { addBytes(hostBytes); } // Domain String. if (domainBytes != null) { addBytes(domainBytes); } } } /** Type 2 message class */ static class Type2Message extends NTLMMessage { final byte[] challenge; String target; byte[] targetInfo; final int flags; Type2Message(final String messageBody) throws NTLMEngineException { this(Base64.decodeBase64(messageBody.getBytes(DEFAULT_CHARSET))); } Type2Message(final byte[] message) throws NTLMEngineException { super(message, 2); // Type 2 message is laid out as follows: // First 8 bytes: NTLMSSP[0] // Next 4 bytes: Ulong, value 2 // Next 8 bytes, starting at offset 12: target field (2 ushort lengths, 1 ulong offset) // Next 4 bytes, starting at offset 20: Flags, e.g. 0x22890235 // Next 8 bytes, starting at offset 24: Challenge // Next 8 bytes, starting at offset 32: ??? (8 bytes of zeros) // Next 8 bytes, starting at offset 40: targetinfo field (2 ushort lengths, 1 ulong offset) // Next 2 bytes, major/minor version number (e.g. 0x05 0x02) // Next 8 bytes, build number // Next 2 bytes, protocol version number (e.g. 0x00 0x0f) // Next, various text fields, and a ushort of value 0 at the end // Parse out the rest of the info we need from the message // The nonce is the 8 bytes starting from the byte in position 24. challenge = new byte[8]; readBytes(challenge, 24); flags = readULong(20); // Do the target! target = null; // The TARGET_DESIRED flag is said to not have understood semantics // in Type2 messages, so use the length of the packet to decide // how to proceed instead if (getMessageLength() >= 12 + 8) { final byte[] bytes = readSecurityBuffer(12); if (bytes.length != 0) { target = new String(bytes, getCharset(flags)); } } // Do the target info! targetInfo = null; // TARGET_DESIRED flag cannot be relied on, so use packet length if (getMessageLength() >= 40 + 8) { final byte[] bytes = readSecurityBuffer(40); if (bytes.length != 0) { targetInfo = bytes; } } } /** Retrieve the challenge */ byte[] getChallenge() { return challenge; } /** Retrieve the target */ String getTarget() { return target; } /** Retrieve the target info */ byte[] getTargetInfo() { return targetInfo; } /** Retrieve the response flags */ int getFlags() { return flags; } } /** Type 3 message assembly class */ static class Type3Message extends NTLMMessage { // For mic computation final byte[] type1Message; final byte[] type2Message; // Response flags from the type2 message final int type2Flags; final byte[] domainBytes; final byte[] hostBytes; final byte[] userBytes; byte[] lmResp; byte[] ntResp; final byte[] sessionKey; final byte[] exportedSessionKey; final boolean computeMic; /** More primitive constructor: don't include cert or previous messages. */ Type3Message(final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { this(domain, host, user, password, nonce, type2Flags, target, targetInformation, null, null, null); } /** More primitive constructor: don't include cert or previous messages. */ Type3Message(final Random random, final long currentTime, final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { this(random, currentTime, domain, host, user, password, nonce, type2Flags, target, targetInformation, null, null, null); } /** Constructor. Pass the arguments we will need */ Type3Message(final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { this(RND_GEN, System.currentTimeMillis(), domain, host, user, password, nonce, type2Flags, target, targetInformation, peerServerCertificate, type1Message, type2Message); } /** Constructor. Pass the arguments we will need */ Type3Message(final Random random, final long currentTime, final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { if (random == null) { throw new NTLMEngineException("Random generator not available"); } // Save the flags this.type2Flags = type2Flags; this.type1Message = type1Message; this.type2Message = type2Message; // All host name manipulations now take place in the credentials final String unqualifiedHost = host; // All domain name manipulations now take place in the credentials final String unqualifiedDomain = domain; byte[] responseTargetInformation = targetInformation; if (peerServerCertificate != null) { responseTargetInformation = addGssMicAvsToTargetInfo(targetInformation, peerServerCertificate); computeMic = true; } else { computeMic = false; } // Create a cipher generator class. Use domain BEFORE it gets modified! final CipherGen gen = new CipherGen(random, currentTime, unqualifiedDomain, user, password, nonce, target, responseTargetInformation); // Use the new code to calculate the responses, including v2 if that // seems warranted. byte[] userSessionKey; try { // This conditional may not work on Windows Server 2008 R2 and above, where it has not yet // been tested if ((type2Flags & FLAG_TARGETINFO_PRESENT) != 0 && targetInformation != null && target != null) { // NTLMv2 ntResp = gen.getNTLMv2Response(); lmResp = gen.getLMv2Response(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLMv2UserSessionKey(); } } else { // NTLMv1 if ((type2Flags & FLAG_REQUEST_NTLM2_SESSION) != 0) { // NTLM2 session stuff is requested ntResp = gen.getNTLM2SessionResponse(); lmResp = gen.getLM2SessionResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLM2SessionResponseUserSessionKey(); } } else { ntResp = gen.getNTLMResponse(); lmResp = gen.getLMResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLMUserSessionKey(); } } } } catch (final NTLMEngineException e) { // This likely means we couldn't find the MD4 hash algorithm - // fail back to just using LM ntResp = new byte[0]; lmResp = gen.getLMResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getLMUserSessionKey(); } } if ((type2Flags & FLAG_REQUEST_SIGN) != 0) { if ((type2Flags & FLAG_REQUEST_EXPLICIT_KEY_EXCH) != 0) { exportedSessionKey = gen.getSecondaryKey(); sessionKey = RC4(exportedSessionKey, userSessionKey); } else { sessionKey = userSessionKey; exportedSessionKey = sessionKey; } } else { if (computeMic) { throw new NTLMEngineException("Cannot sign/seal: no exported session key"); } sessionKey = null; exportedSessionKey = null; } final Charset charset = getCharset(type2Flags); hostBytes = unqualifiedHost != null ? unqualifiedHost.getBytes(charset) : null; domainBytes = unqualifiedDomain != null ? unqualifiedDomain .toUpperCase(Locale.ROOT).getBytes(charset) : null; userBytes = user.getBytes(charset); } byte[] getEncryptedRandomSessionKey() { return sessionKey; } byte[] getExportedSessionKey() { return exportedSessionKey; } /** Assemble the response */ @Override void buildMessage() { final int ntRespLen = ntResp.length; final int lmRespLen = lmResp.length; final int domainLen = domainBytes != null ? domainBytes.length : 0; final int hostLen = hostBytes != null ? hostBytes.length : 0; final int userLen = userBytes.length; final int sessionKeyLen; if (sessionKey != null) { sessionKeyLen = sessionKey.length; } else { sessionKeyLen = 0; } // Calculate the layout within the packet final int lmRespOffset = 72 + // allocate space for the version ( computeMic ? 16 : 0 ); // and MIC final int ntRespOffset = lmRespOffset + lmRespLen; final int domainOffset = ntRespOffset + ntRespLen; final int userOffset = domainOffset + domainLen; final int hostOffset = userOffset + userLen; final int sessionKeyOffset = hostOffset + hostLen; final int finalLength = sessionKeyOffset + sessionKeyLen; // Start the response. Length includes signature and type prepareResponse(finalLength, 3); // LM Resp Length (twice) addUShort(lmRespLen); addUShort(lmRespLen); // LM Resp Offset addULong(lmRespOffset); // NT Resp Length (twice) addUShort(ntRespLen); addUShort(ntRespLen); // NT Resp Offset addULong(ntRespOffset); // Domain length (twice) addUShort(domainLen); addUShort(domainLen); // Domain offset. addULong(domainOffset); // User Length (twice) addUShort(userLen); addUShort(userLen); // User offset addULong(userOffset); // Host length (twice) addUShort(hostLen); addUShort(hostLen); // Host offset addULong(hostOffset); // Session key length (twice) addUShort(sessionKeyLen); addUShort(sessionKeyLen); // Session key offset addULong(sessionKeyOffset); // Flags. addULong( /* //FLAG_WORKSTATION_PRESENT | //FLAG_DOMAIN_PRESENT | // Required flags (type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) | (type2Flags & FLAG_REQUEST_NTLMv1) | (type2Flags & FLAG_REQUEST_NTLM2_SESSION) | // Protocol version request FLAG_REQUEST_VERSION | // Recommended privacy settings (type2Flags & FLAG_REQUEST_ALWAYS_SIGN) | (type2Flags & FLAG_REQUEST_SEAL) | (type2Flags & FLAG_REQUEST_SIGN) | // These must be set according to documentation, based on use of SEAL above (type2Flags & FLAG_REQUEST_128BIT_KEY_EXCH) | (type2Flags & FLAG_REQUEST_56BIT_ENCRYPTION) | (type2Flags & FLAG_REQUEST_EXPLICIT_KEY_EXCH) | (type2Flags & FLAG_TARGETINFO_PRESENT) | (type2Flags & FLAG_REQUEST_UNICODE_ENCODING) | (type2Flags & FLAG_REQUEST_TARGET) */ type2Flags ); // Version addUShort(0x0105); // Build addULong(2600); // NTLM revision addUShort(0x0f00); int micPosition = -1; if ( computeMic ) { micPosition = currentOutputPosition; currentOutputPosition += 16; } // Add the actual data addBytes(lmResp); addBytes(ntResp); addBytes(domainBytes); addBytes(userBytes); addBytes(hostBytes); if (sessionKey != null) { addBytes(sessionKey); } // Write the mic back into its slot in the message if (computeMic) { // Computation of message integrity code (MIC) as specified in [MS-NLMP] section 3.2.5.1.2. final HMACMD5 hmacMD5 = new HMACMD5( exportedSessionKey ); hmacMD5.update( type1Message ); hmacMD5.update( type2Message ); hmacMD5.update( messageContents ); final byte[] mic = hmacMD5.getOutput(); System.arraycopy( mic, 0, messageContents, micPosition, mic.length ); } } /** * Add GSS channel binding hash and MIC flag to the targetInfo. * Looks like this is needed if we want to use exported session key for GSS wrapping. */ private byte[] addGssMicAvsToTargetInfo( final byte[] originalTargetInfo, final Certificate peerServerCertificate ) throws NTLMEngineException { final byte[] newTargetInfo = new byte[originalTargetInfo.length + 8 + 20]; final int appendLength = originalTargetInfo.length - 4; // last tag is MSV_AV_EOL, do not copy that System.arraycopy( originalTargetInfo, 0, newTargetInfo, 0, appendLength ); writeUShort( newTargetInfo, MSV_AV_FLAGS, appendLength ); writeUShort( newTargetInfo, 4, appendLength + 2 ); writeULong( newTargetInfo, MSV_AV_FLAGS_MIC, appendLength + 4 ); writeUShort( newTargetInfo, MSV_AV_CHANNEL_BINDINGS, appendLength + 8 ); writeUShort( newTargetInfo, 16, appendLength + 10 ); final byte[] channelBindingsHash; try { final byte[] certBytes = peerServerCertificate.getEncoded(); final MessageDigest sha256 = MessageDigest.getInstance( "SHA-256" ); final byte[] certHashBytes = sha256.digest( certBytes ); final byte[] channelBindingStruct = new byte[16 + 4 + MAGIC_TLS_SERVER_ENDPOINT.length + certHashBytes.length]; writeULong( channelBindingStruct, 0x00000035, 16 ); System.arraycopy( MAGIC_TLS_SERVER_ENDPOINT, 0, channelBindingStruct, 20, MAGIC_TLS_SERVER_ENDPOINT.length ); System.arraycopy( certHashBytes, 0, channelBindingStruct, 20 + MAGIC_TLS_SERVER_ENDPOINT.length, certHashBytes.length ); final MessageDigest md5 = getMD5(); channelBindingsHash = md5.digest( channelBindingStruct ); } catch (final CertificateEncodingException | NoSuchAlgorithmException e ) { throw new NTLMEngineException( e.getMessage(), e ); } System.arraycopy( channelBindingsHash, 0, newTargetInfo, appendLength + 12, 16 ); return newTargetInfo; } } static void writeUShort(final byte[] buffer, final int value, final int offset) { buffer[offset] = ( byte ) ( value & 0xff ); buffer[offset + 1] = ( byte ) ( value >> 8 & 0xff ); } static void writeULong(final byte[] buffer, final int value, final int offset) { buffer[offset] = (byte) (value & 0xff); buffer[offset + 1] = (byte) (value >> 8 & 0xff); buffer[offset + 2] = (byte) (value >> 16 & 0xff); buffer[offset + 3] = (byte) (value >> 24 & 0xff); } static int F(final int x, final int y, final int z) { return (x & y) | (~x & z); } static int G(final int x, final int y, final int z) { return (x & y) | (x & z) | (y & z); } static int H(final int x, final int y, final int z) { return x ^ y ^ z; } static int rotintlft(final int val, final int numbits) { return (val << numbits) | (val >>> (32 - numbits)); } static MessageDigest getMD5() { try { return MessageDigest.getInstance("MD5"); } catch (final NoSuchAlgorithmException ex) { throw new RuntimeException("MD5 message digest doesn't seem to exist - fatal error: " + ex.getMessage(), ex); } } /** * Cryptography support - MD4. The following class was based loosely on the * RFC and on code found at http://www.cs.umd.edu/~harry/jotp/src/md.java. * Code correctness was verified by looking at MD4.java from the jcifs * library (http://jcifs.samba.org). It was massaged extensively to the * final form found here by Karl Wright (kwright@metacarta.com). */ static class MD4 { int A = 0x67452301; int B = 0xefcdab89; int C = 0x98badcfe; int D = 0x10325476; long count; final byte[] dataBuffer = new byte[64]; MD4() { } void update(final byte[] input) { // We always deal with 512 bits at a time. Correspondingly, there is // a buffer 64 bytes long that we write data into until it gets // full. int curBufferPos = (int) (count & 63L); int inputIndex = 0; while (input.length - inputIndex + curBufferPos >= dataBuffer.length) { // We have enough data to do the next step. Do a partial copy // and a transform, updating inputIndex and curBufferPos // accordingly final int transferAmt = dataBuffer.length - curBufferPos; System.arraycopy(input, inputIndex, dataBuffer, curBufferPos, transferAmt); count += transferAmt; curBufferPos = 0; inputIndex += transferAmt; processBuffer(); } // If there's anything left, copy it into the buffer and leave it. // We know there's not enough left to process. if (inputIndex < input.length) { final int transferAmt = input.length - inputIndex; System.arraycopy(input, inputIndex, dataBuffer, curBufferPos, transferAmt); count += transferAmt; curBufferPos += transferAmt; } } byte[] getOutput() { // Feed pad/length data into engine. This must round out the input // to a multiple of 512 bits. final int bufferIndex = (int) (count & 63L); final int padLen = (bufferIndex < 56) ? (56 - bufferIndex) : (120 - bufferIndex); final byte[] postBytes = new byte[padLen + 8]; // Leading 0x80, specified amount of zero padding, then length in // bits. postBytes[0] = (byte) 0x80; // Fill out the last 8 bytes with the length for (int i = 0; i < 8; i++) { postBytes[padLen + i] = (byte) ((count * 8) >>> (8 * i)); } // Update the engine update(postBytes); // Calculate final result final byte[] result = new byte[16]; writeULong(result, A, 0); writeULong(result, B, 4); writeULong(result, C, 8); writeULong(result, D, 12); return result; } void processBuffer() { // Convert current buffer to 16 ulongs final int[] d = new int[16]; for (int i = 0; i < 16; i++) { d[i] = (dataBuffer[i * 4] & 0xff) + ((dataBuffer[i * 4 + 1] & 0xff) << 8) + ((dataBuffer[i * 4 + 2] & 0xff) << 16) + ((dataBuffer[i * 4 + 3] & 0xff) << 24); } // Do a round of processing final int AA = A; final int BB = B; final int CC = C; final int DD = D; round1(d); round2(d); round3(d); A += AA; B += BB; C += CC; D += DD; } void round1(final int[] d) { A = rotintlft(A + F(B, C, D) + d[0], 3); D = rotintlft(D + F(A, B, C) + d[1], 7); C = rotintlft(C + F(D, A, B) + d[2], 11); B = rotintlft(B + F(C, D, A) + d[3], 19); A = rotintlft(A + F(B, C, D) + d[4], 3); D = rotintlft(D + F(A, B, C) + d[5], 7); C = rotintlft(C + F(D, A, B) + d[6], 11); B = rotintlft(B + F(C, D, A) + d[7], 19); A = rotintlft(A + F(B, C, D) + d[8], 3); D = rotintlft(D + F(A, B, C) + d[9], 7); C = rotintlft(C + F(D, A, B) + d[10], 11); B = rotintlft(B + F(C, D, A) + d[11], 19); A = rotintlft(A + F(B, C, D) + d[12], 3); D = rotintlft(D + F(A, B, C) + d[13], 7); C = rotintlft(C + F(D, A, B) + d[14], 11); B = rotintlft(B + F(C, D, A) + d[15], 19); } void round2(final int[] d) { A = rotintlft(A + G(B, C, D) + d[0] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[4] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[8] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[12] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[1] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[5] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[9] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[13] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[2] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[6] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[10] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[14] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[3] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[7] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[11] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[15] + 0x5a827999, 13); } void round3(final int[] d) { A = rotintlft(A + H(B, C, D) + d[0] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[8] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[4] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[12] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[2] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[10] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[6] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[14] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[1] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[9] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[5] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[13] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[3] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[11] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[7] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[15] + 0x6ed9eba1, 15); } } /** * Cryptography support - HMACMD5 - algorithmically based on various web * resources by Karl Wright */ static class HMACMD5 { final byte[] ipad; final byte[] opad; final MessageDigest md5; HMACMD5(final byte[] input) { byte[] key = input; md5 = getMD5(); // Initialize the pad buffers with the key ipad = new byte[64]; opad = new byte[64]; int keyLength = key.length; if (keyLength > 64) { // Use MD5 of the key instead, as described in RFC 2104 md5.update(key); key = md5.digest(); keyLength = key.length; } int i = 0; while (i < keyLength) { ipad[i] = (byte) (key[i] ^ (byte) 0x36); opad[i] = (byte) (key[i] ^ (byte) 0x5c); i++; } while (i < 64) { ipad[i] = (byte) 0x36; opad[i] = (byte) 0x5c; i++; } // Very important: processChallenge the digest with the ipad buffer md5.reset(); md5.update(ipad); } /** Grab the current digest. This is the "answer". */ byte[] getOutput() { final byte[] digest = md5.digest(); md5.update(opad); return md5.digest(digest); } /** Update by adding a complete array */ void update(final byte[] input) { md5.update(input); } /** Update the algorithm */ void update(final byte[] input, final int offset, final int length) { md5.update(input, offset, length); } } @Override public String generateType1Msg( final String domain, final String workstation) throws NTLMEngineException { return getType1Message(workstation, domain); } @Override public String generateType3Msg( final String username, final char[] password, final String domain, final String workstation, final String challenge) throws NTLMEngineException { final Type2Message t2m = new Type2Message(challenge); return getType3Message( username, password, workstation, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo()); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMScheme.java0100644 0000000 0000000 00000015667 00000250600 026071 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.security.Principal; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * NTLM is a proprietary authentication scheme developed by Microsoft * and optimized for Windows platforms. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated public final class NTLMScheme implements AuthScheme { private static final Logger LOG = LoggerFactory.getLogger(NTLMScheme.class); enum State { UNINITIATED, CHALLENGE_RECEIVED, MSG_TYPE1_GENERATED, MSG_TYPE2_RECEIVED, MSG_TYPE3_GENERATED, FAILED, } private final NTLMEngine engine; private State state; private String challenge; private org.apache.hc.client5.http.auth.NTCredentials credentials; public NTLMScheme(final NTLMEngine engine) { super(); Args.notNull(engine, "NTLM engine"); this.engine = engine; this.state = State.UNINITIATED; } /** * @since 4.3 */ public NTLMScheme() { this(new NTLMEngineImpl()); } @Override public String getName() { return StandardAuthScheme.NTLM; } @Override public boolean isConnectionBased() { return true; } @Override public String getRealm() { return null; } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { Args.notNull(authChallenge, "AuthChallenge"); this.challenge = authChallenge.getValue(); if (this.challenge == null || this.challenge.isEmpty()) { if (this.state == State.UNINITIATED) { this.state = State.CHALLENGE_RECEIVED; } else { this.state = State.FAILED; } } else { if (this.state.compareTo(State.MSG_TYPE1_GENERATED) < 0) { this.state = State.FAILED; throw new MalformedChallengeException("Out of sequence NTLM response message"); } else if (this.state == State.MSG_TYPE1_GENERATED) { this.state = State.MSG_TYPE2_RECEIVED; } } } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final AuthScope authScope = new AuthScope(host, null, getName()); final Credentials credentials = credentialsProvider.getCredentials( authScope, context); if (credentials instanceof org.apache.hc.client5.http.auth.NTCredentials) { this.credentials = (org.apache.hc.client5.http.auth.NTCredentials) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } return false; } @Override public Principal getPrincipal() { return this.credentials != null ? this.credentials.getUserPrincipal() : null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { if (this.credentials == null) { throw new AuthenticationException("NT credentials not available"); } final String response; if (this.state == State.FAILED) { throw new AuthenticationException("NTLM authentication failed"); } else if (this.state == State.CHALLENGE_RECEIVED) { response = this.engine.generateType1Msg( this.credentials.getNetbiosDomain(), this.credentials.getWorkstation()); this.state = State.MSG_TYPE1_GENERATED; } else if (this.state == State.MSG_TYPE2_RECEIVED) { response = this.engine.generateType3Msg( this.credentials.getUserName(), this.credentials.getPassword(), this.credentials.getNetbiosDomain(), this.credentials.getWorkstation(), this.challenge); this.state = State.MSG_TYPE3_GENERATED; } else { throw new AuthenticationException("Unexpected state: " + this.state); } return StandardAuthScheme.NTLM + " " + response; } @Override public boolean isChallengeComplete() { return this.state == State.MSG_TYPE3_GENERATED || this.state == State.FAILED; } @Override public String toString() { return getName() + "{" + this.state + " " + challenge + '}'; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMSchemeFactory.java0100644 0000000 0000000 00000004367 00000250600 027414 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link NTLMScheme} instances configured to use the default {@link NTLMEngine} * implementation. * * @since 4.1 * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class NTLMSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link NTLMSchemeFactory}. */ public static final NTLMSchemeFactory INSTANCE = new NTLMSchemeFactory(); @Override public AuthScheme create(final HttpContext context) { return new NTLMScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SPNegoScheme.java0100644 0000000 0000000 00000005215 00000250600 026436 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.core5.annotation.Experimental; import org.ietf.jgss.GSSException; import org.ietf.jgss.Oid; /** * SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication * scheme. *

* Please note this class is considered experimental and may be discontinued or removed * in the future. *

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated @Experimental public class SPNegoScheme extends GGSSchemeBase { private static final String SPNEGO_OID = "1.3.6.1.5.5.2"; /** * @since 5.0 */ public SPNegoScheme(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(config, dnsResolver); } public SPNegoScheme() { super(); } @Override public String getName() { return StandardAuthScheme.SPNEGO; } @Override protected byte[] generateToken(final byte[] input, final String serviceName, final String authServer) throws GSSException { return generateGSSToken(input, new Oid(SPNEGO_OID), serviceName, authServer); } @Override public boolean isConnectionBased() { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SPNegoSchemeFactory.java0100644 0000000 0000000 00000005760 00000250600 027773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link SPNegoScheme} instances. *

* Please note this class is considered experimental and may be discontinued or removed * in the future. *

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) @Experimental public class SPNegoSchemeFactory implements AuthSchemeFactory { /** * Singleton instance for the default configuration. */ public static final SPNegoSchemeFactory DEFAULT = new SPNegoSchemeFactory(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** * @since 5.0 */ public SPNegoSchemeFactory(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config; this.dnsResolver = dnsResolver; } @Override public AuthScheme create(final HttpContext context) { return new SPNegoScheme(this.config, this.dnsResolver); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SaslPrep.java0100644 0000000 0000000 00000064636 00000250600 025723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.text.Normalizer; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Map; import java.util.SortedMap; import java.util.TreeMap; import org.apache.hc.client5.http.impl.ScramException; import org.conscrypt.Internal; @Internal class SaslPrep { public static final SaslPrep INSTANCE = new SaslPrep(); private static class CharClass { private final List tupleStart = new ArrayList<>(); private final List tupleCount = new ArrayList<>(); private static CharClass fromList(final int[] charMap) { final SortedMap mapping = new TreeMap<>(); for (final int j : charMap) { mapping.put(j, 1); } return new CharClass(mapping); } private static CharClass fromRanges(final int[] charMap) { // There must be an even number of tuples in RANGES tables. if ((charMap.length % 2) != 0) { throw new IllegalArgumentException("Invalid character list size"); } final SortedMap mapping = new TreeMap<>(); for (int i = 0; i < charMap.length; i += 2) { final int start = charMap[i]; final int end = charMap[i + 1]; final int count = end - start + 1; mapping.put(start, count); } return new CharClass(mapping); } private static CharClass fromClasses(final CharClass... classes) { final SortedMap mapping = new TreeMap<>(); for (final CharClass charClass : classes) { for (int i = 0; i < charClass.tupleStart.size(); ++i) { final int start = charClass.tupleStart.get(i); final int count = charClass.tupleCount.get(i); mapping.put(start, count); } } return new CharClass(mapping); } private CharClass(final SortedMap mappings) { for (final Map.Entry pair : mappings.entrySet()) { final int start = pair.getKey(); final int count = pair.getValue(); // Coalesce overlapping ranges. if (!tupleStart.isEmpty()) { final int prevIndex = tupleStart.size() - 1; final int prevStart = tupleStart.get(prevIndex); final int prevCount = tupleCount.get(prevIndex); if (prevStart + prevCount >= start) { final int endPos = start + count; final int newCount = endPos - prevStart; tupleCount.set(prevIndex, newCount); continue; } } tupleStart.add(start); tupleCount.add(count); } } private boolean isCharInClass(final int c) { final int pos = Collections.binarySearch(tupleStart, c); if (pos >= 0) { return true; } final int insertionPoint = -pos - 1; if (insertionPoint == 0) { return false; } // Otherwise, check if `c` lies within the preceding range. final int rangeIndex = insertionPoint - 1; final int rangeStart = tupleStart.get(rangeIndex); final int rangeCount = tupleCount.get(rangeIndex); // Check if `c` lies within this range. return c >= rangeStart && c < (rangeStart + rangeCount); } } /** * A.1 Unassigned code points in Unicode 3.2 */ private final CharClass A1 = CharClass.fromRanges(new int[]{ 0x0221, 0x0221, 0x0234, 0x024F, 0x02AE, 0x02AF, 0x02EF, 0x02FF, 0x0350, 0x035F, 0x0370, 0x0373, 0x0376, 0x0379, 0x037B, 0x037D, 0x037F, 0x0383, 0x038B, 0x038B, 0x038D, 0x038D, 0x03A2, 0x03A2, 0x03CF, 0x03CF, 0x03F7, 0x03FF, 0x0487, 0x0487, 0x04CF, 0x04CF, 0x04F6, 0x04F7, 0x04FA, 0x04FF, 0x0510, 0x0530, 0x0557, 0x0558, 0x0560, 0x0560, 0x0588, 0x0588, 0x058B, 0x0590, 0x05A2, 0x05A2, 0x05BA, 0x05BA, 0x05C5, 0x05CF, 0x05EB, 0x05EF, 0x05F5, 0x060B, 0x060D, 0x061A, 0x061C, 0x061E, 0x0620, 0x0620, 0x063B, 0x063F, 0x0656, 0x065F, 0x06EE, 0x06EF, 0x06FF, 0x06FF, 0x070E, 0x070E, 0x072D, 0x072F, 0x074B, 0x077F, 0x07B2, 0x0900, 0x0904, 0x0904, 0x093A, 0x093B, 0x094E, 0x094F, 0x0955, 0x0957, 0x0971, 0x0980, 0x0984, 0x0984, 0x098D, 0x098E, 0x0991, 0x0992, 0x09A9, 0x09A9, 0x09B1, 0x09B1, 0x09B3, 0x09B5, 0x09BA, 0x09BB, 0x09BD, 0x09BD, 0x09C5, 0x09C6, 0x09C9, 0x09CA, 0x09CE, 0x09D6, 0x09D8, 0x09DB, 0x09DE, 0x09DE, 0x09E4, 0x09E5, 0x09FB, 0x0A01, 0x0A03, 0x0A04, 0x0A0B, 0x0A0E, 0x0A11, 0x0A12, 0x0A29, 0x0A29, 0x0A31, 0x0A31, 0x0A34, 0x0A34, 0x0A37, 0x0A37, 0x0A3A, 0x0A3B, 0x0A3D, 0x0A3D, 0x0A43, 0x0A46, 0x0A49, 0x0A4A, 0x0A4E, 0x0A58, 0x0A5D, 0x0A5D, 0x0A5F, 0x0A65, 0x0A75, 0x0A80, 0x0A84, 0x0A84, 0x0A8C, 0x0A8C, 0x0A8E, 0x0A8E, 0x0A92, 0x0A92, 0x0AA9, 0x0AA9, 0x0AB1, 0x0AB1, 0x0AB4, 0x0AB4, 0x0ABA, 0x0ABB, 0x0AC6, 0x0AC6, 0x0ACA, 0x0ACA, 0x0ACE, 0x0ACF, 0x0AD1, 0x0ADF, 0x0AE1, 0x0AE5, 0x0AF0, 0x0B00, 0x0B04, 0x0B04, 0x0B0D, 0x0B0E, 0x0B11, 0x0B12, 0x0B29, 0x0B29, 0x0B31, 0x0B31, 0x0B34, 0x0B35, 0x0B3A, 0x0B3B, 0x0B44, 0x0B46, 0x0B49, 0x0B4A, 0x0B4E, 0x0B55, 0x0B58, 0x0B5B, 0x0B5E, 0x0B5E, 0x0B62, 0x0B65, 0x0B71, 0x0B81, 0x0B84, 0x0B84, 0x0B8B, 0x0B8D, 0x0B91, 0x0B91, 0x0B96, 0x0B98, 0x0B9B, 0x0B9B, 0x0B9D, 0x0B9D, 0x0BA0, 0x0BA2, 0x0BA5, 0x0BA7, 0x0BAB, 0x0BAD, 0x0BB6, 0x0BB6, 0x0BBA, 0x0BBD, 0x0BC3, 0x0BC5, 0x0BC9, 0x0BC9, 0x0BCE, 0x0BD6, 0x0BD8, 0x0BE6, 0x0BF3, 0x0C00, 0x0C04, 0x0C04, 0x0C0D, 0x0C0D, 0x0C11, 0x0C11, 0x0C29, 0x0C29, 0x0C34, 0x0C34, 0x0C3A, 0x0C3D, 0x0C45, 0x0C45, 0x0C49, 0x0C49, 0x0C4E, 0x0C54, 0x0C57, 0x0C5F, 0x0C62, 0x0C65, 0x0C70, 0x0C81, 0x0C84, 0x0C84, 0x0C8D, 0x0C8D, 0x0C91, 0x0C91, 0x0CA9, 0x0CA9, 0x0CB4, 0x0CB4, 0x0CBA, 0x0CBD, 0x0CC5, 0x0CC5, 0x0CC9, 0x0CC9, 0x0CCE, 0x0CD4, 0x0CD7, 0x0CDD, 0x0CDF, 0x0CDF, 0x0CE2, 0x0CE5, 0x0CF0, 0x0D01, 0x0D04, 0x0D04, 0x0D0D, 0x0D0D, 0x0D11, 0x0D11, 0x0D29, 0x0D29, 0x0D3A, 0x0D3D, 0x0D44, 0x0D45, 0x0D49, 0x0D49, 0x0D4E, 0x0D56, 0x0D58, 0x0D5F, 0x0D62, 0x0D65, 0x0D70, 0x0D81, 0x0D84, 0x0D84, 0x0D97, 0x0D99, 0x0DB2, 0x0DB2, 0x0DBC, 0x0DBC, 0x0DBE, 0x0DBF, 0x0DC7, 0x0DC9, 0x0DCB, 0x0DCE, 0x0DD5, 0x0DD5, 0x0DD7, 0x0DD7, 0x0DE0, 0x0DF1, 0x0DF5, 0x0E00, 0x0E3B, 0x0E3E, 0x0E5C, 0x0E80, 0x0E83, 0x0E83, 0x0E85, 0x0E86, 0x0E89, 0x0E89, 0x0E8B, 0x0E8C, 0x0E8E, 0x0E93, 0x0E98, 0x0E98, 0x0EA0, 0x0EA0, 0x0EA4, 0x0EA4, 0x0EA6, 0x0EA6, 0x0EA8, 0x0EA9, 0x0EAC, 0x0EAC, 0x0EBA, 0x0EBA, 0x0EBE, 0x0EBF, 0x0EC5, 0x0EC5, 0x0EC7, 0x0EC7, 0x0ECE, 0x0ECF, 0x0EDA, 0x0EDB, 0x0EDE, 0x0EFF, 0x0F48, 0x0F48, 0x0F6B, 0x0F70, 0x0F8C, 0x0F8F, 0x0F98, 0x0F98, 0x0FBD, 0x0FBD, 0x0FCD, 0x0FCE, 0x0FD0, 0x0FFF, 0x1022, 0x1022, 0x1028, 0x1028, 0x102B, 0x102B, 0x1033, 0x1035, 0x103A, 0x103F, 0x105A, 0x109F, 0x10C6, 0x10CF, 0x10F9, 0x10FA, 0x10FC, 0x10FF, 0x115A, 0x115E, 0x11A3, 0x11A7, 0x11FA, 0x11FF, 0x1207, 0x1207, 0x1247, 0x1247, 0x1249, 0x1249, 0x124E, 0x124F, 0x1257, 0x1257, 0x1259, 0x1259, 0x125E, 0x125F, 0x1287, 0x1287, 0x1289, 0x1289, 0x128E, 0x128F, 0x12AF, 0x12AF, 0x12B1, 0x12B1, 0x12B6, 0x12B7, 0x12BF, 0x12BF, 0x12C1, 0x12C1, 0x12C6, 0x12C7, 0x12CF, 0x12CF, 0x12D7, 0x12D7, 0x12EF, 0x12EF, 0x130F, 0x130F, 0x1311, 0x1311, 0x1316, 0x1317, 0x131F, 0x131F, 0x1347, 0x1347, 0x135B, 0x1360, 0x137D, 0x139F, 0x13F5, 0x1400, 0x1677, 0x167F, 0x169D, 0x169F, 0x16F1, 0x16FF, 0x170D, 0x170D, 0x1715, 0x171F, 0x1737, 0x173F, 0x1754, 0x175F, 0x176D, 0x176D, 0x1771, 0x1771, 0x1774, 0x177F, 0x17DD, 0x17DF, 0x17EA, 0x17FF, 0x180F, 0x180F, 0x181A, 0x181F, 0x1878, 0x187F, 0x18AA, 0x1DFF, 0x1E9C, 0x1E9F, 0x1EFA, 0x1EFF, 0x1F16, 0x1F17, 0x1F1E, 0x1F1F, 0x1F46, 0x1F47, 0x1F4E, 0x1F4F, 0x1F58, 0x1F58, 0x1F5A, 0x1F5A, 0x1F5C, 0x1F5C, 0x1F5E, 0x1F5E, 0x1F7E, 0x1F7F, 0x1FB5, 0x1FB5, 0x1FC5, 0x1FC5, 0x1FD4, 0x1FD5, 0x1FDC, 0x1FDC, 0x1FF0, 0x1FF1, 0x1FF5, 0x1FF5, 0x1FFF, 0x1FFF, 0x2053, 0x2056, 0x2058, 0x205E, 0x2064, 0x2069, 0x2072, 0x2073, 0x208F, 0x209F, 0x20B2, 0x20CF, 0x20EB, 0x20FF, 0x213B, 0x213C, 0x214C, 0x2152, 0x2184, 0x218F, 0x23CF, 0x23FF, 0x2427, 0x243F, 0x244B, 0x245F, 0x24FF, 0x24FF, 0x2614, 0x2615, 0x2618, 0x2618, 0x267E, 0x267F, 0x268A, 0x2700, 0x2705, 0x2705, 0x270A, 0x270B, 0x2728, 0x2728, 0x274C, 0x274C, 0x274E, 0x274E, 0x2753, 0x2755, 0x2757, 0x2757, 0x275F, 0x2760, 0x2795, 0x2797, 0x27B0, 0x27B0, 0x27BF, 0x27CF, 0x27EC, 0x27EF, 0x2B00, 0x2E7F, 0x2E9A, 0x2E9A, 0x2EF4, 0x2EFF, 0x2FD6, 0x2FEF, 0x2FFC, 0x2FFF, 0x3040, 0x3040, 0x3097, 0x3098, 0x3100, 0x3104, 0x312D, 0x3130, 0x318F, 0x318F, 0x31B8, 0x31EF, 0x321D, 0x321F, 0x3244, 0x3250, 0x327C, 0x327E, 0x32CC, 0x32CF, 0x32FF, 0x32FF, 0x3377, 0x337A, 0x33DE, 0x33DF, 0x33FF, 0x33FF, 0x4DB6, 0x4DFF, 0x9FA6, 0x9FFF, 0xA48D, 0xA48F, 0xA4C7, 0xABFF, 0xD7A4, 0xD7FF, 0xFA2E, 0xFA2F, 0xFA6B, 0xFAFF, 0xFB07, 0xFB12, 0xFB18, 0xFB1C, 0xFB37, 0xFB37, 0xFB3D, 0xFB3D, 0xFB3F, 0xFB3F, 0xFB42, 0xFB42, 0xFB45, 0xFB45, 0xFBB2, 0xFBD2, 0xFD40, 0xFD4F, 0xFD90, 0xFD91, 0xFDC8, 0xFDCF, 0xFDFD, 0xFDFF, 0xFE10, 0xFE1F, 0xFE24, 0xFE2F, 0xFE47, 0xFE48, 0xFE53, 0xFE53, 0xFE67, 0xFE67, 0xFE6C, 0xFE6F, 0xFE75, 0xFE75, 0xFEFD, 0xFEFE, 0xFF00, 0xFF00, 0xFFBF, 0xFFC1, 0xFFC8, 0xFFC9, 0xFFD0, 0xFFD1, 0xFFD8, 0xFFD9, 0xFFDD, 0xFFDF, 0xFFE7, 0xFFE7, 0xFFEF, 0xFFF8, 0x10000, 0x102FF, 0x1031F, 0x1031F, 0x10324, 0x1032F, 0x1034B, 0x103FF, 0x10426, 0x10427, 0x1044E, 0x1CFFF, 0x1D0F6, 0x1D0FF, 0x1D127, 0x1D129, 0x1D1DE, 0x1D3FF, 0x1D455, 0x1D455, 0x1D49D, 0x1D49D, 0x1D4A0, 0x1D4A1, 0x1D4A3, 0x1D4A4, 0x1D4A7, 0x1D4A8, 0x1D4AD, 0x1D4AD, 0x1D4BA, 0x1D4BA, 0x1D4BC, 0x1D4BC, 0x1D4C1, 0x1D4C1, 0x1D4C4, 0x1D4C4, 0x1D506, 0x1D506, 0x1D50B, 0x1D50C, 0x1D515, 0x1D515, 0x1D51D, 0x1D51D, 0x1D53A, 0x1D53A, 0x1D53F, 0x1D53F, 0x1D545, 0x1D545, 0x1D547, 0x1D549, 0x1D551, 0x1D551, 0x1D6A4, 0x1D6A7, 0x1D7CA, 0x1D7CD, 0x1D800, 0x1FFFD, 0x2A6D7, 0x2F7FF, 0x2FA1E, 0x2FFFD, 0x30000, 0x3FFFD, 0x40000, 0x4FFFD, 0x50000, 0x5FFFD, 0x60000, 0x6FFFD, 0x70000, 0x7FFFD, 0x80000, 0x8FFFD, 0x90000, 0x9FFFD, 0xA0000, 0xAFFFD, 0xB0000, 0xBFFFD, 0xC0000, 0xCFFFD, 0xD0000, 0xDFFFD, 0xE0000, 0xE0000, 0xE0002, 0xE001F, 0xE0080, 0xEFFFD, }); /** * B.1 Commonly mapped to nothing */ private final CharClass B1 = CharClass.fromList(new int[]{ 0x00AD, 0x034F, 0x1806, 0x180B, 0x180C, 0x180D, 0x200B, 0x200C, 0x200D, 0x2060, 0xFE00, 0xFE01, 0xFE02, 0xFE03, 0xFE04, 0xFE05, 0xFE06, 0xFE07, 0xFE08, 0xFE09, 0xFE0A, 0xFE0B, 0xFE0C, 0xFE0D, 0xFE0E, 0xFE0F, 0xFEFF, }); /** * C.1.1 ASCII space characters */ private final CharClass C11 = CharClass.fromList(new int[]{ 0x0020 }); /** * C.1.2 Non-ASCII space characters */ private final CharClass C12 = CharClass.fromList(new int[]{ 0x00A0, 0x1680, 0x2000, 0x2001, 0x2002, 0x2003, 0x2004, 0x2005, 0x2006, 0x2007, 0x2008, 0x2009, 0x200A, 0x200B, 0x202F, 0x205F, 0x3000, }); /** * C.2.1 ASCII control characters */ private final CharClass C21 = CharClass.fromList(new int[]{ 0x0000, 0x0001, 0x0002, 0x0003, 0x0004, 0x0005, 0x0006, 0x0007, 0x0008, 0x0009, 0x000A, 0x000B, 0x000C, 0x000D, 0x000E, 0x000F, 0x0010, 0x0011, 0x0012, 0x0013, 0x0014, 0x0015, 0x0016, 0x0017, 0x0018, 0x0019, 0x001A, 0x001B, 0x001C, 0x001D, 0x001E, 0x001F, 0x007F }); /** * C.2.2 Non-ASCII control characters */ private final CharClass C22 = CharClass.fromList(new int[]{ 0x0080, 0x0081, 0x0082, 0x0083, 0x0084, 0x0085, 0x0086, 0x0087, 0x0088, 0x0089, 0x008A, 0x008B, 0x008C, 0x008D, 0x008E, 0x008F, 0x0090, 0x0091, 0x0092, 0x0093, 0x0094, 0x0095, 0x0096, 0x0097, 0x0098, 0x0099, 0x009A, 0x009B, 0x009C, 0x009D, 0x009E, 0x009F, 0x06DD, 0x070F, 0x180E, 0x200C, 0x200D, 0x2028, 0x2029, 0x2060, 0x2061, 0x2062, 0x2063, 0x206A, 0x206B, 0x206C, 0x206D, 0x206E, 0x206F, 0xFEFF, 0xFFF9, 0xFFFA, 0xFFFB, 0xFFFC, 0x1D173, 0x1D174, 0x1D175, 0x1D176, 0x1D177, 0x1D178, 0x1D179, 0x1D17A, }); /** * C.3 Private use */ private final CharClass C3 = CharClass.fromRanges(new int[]{ 0xE000, 0xF8FF, 0xF0000, 0xFFFFD, 0x100000, 0x10FFFD, }); /** * C.4 Non-character code points */ private final CharClass C4 = CharClass.fromRanges(new int[]{ 0xFDD0, 0xFDEF, 0xFFFE, 0xFFFF, 0x1FFFE, 0x1FFFF, 0x2FFFE, 0x2FFFF, 0x3FFFE, 0x3FFFF, 0x4FFFE, 0x4FFFF, 0x5FFFE, 0x5FFFF, 0x6FFFE, 0x6FFFF, 0x7FFFE, 0x7FFFF, 0x8FFFE, 0x8FFFF, 0x9FFFE, 0x9FFFF, 0xAFFFE, 0xAFFFF, 0xBFFFE, 0xBFFFF, 0xCFFFE, 0xCFFFF, 0xDFFFE, 0xDFFFF, 0xEFFFE, 0xEFFFF, 0xFFFFE, 0xFFFFF, 0x10FFFE, 0x10FFFF, }); /** * C.5 Surrogate codes */ private final CharClass C5 = CharClass.fromRanges(new int[]{ 0xD800, 0xDFFF, }); /** * C.6 Inappropriate for plain text */ private final CharClass C6 = CharClass.fromList(new int[]{ 0xFFF9, 0xFFFA, 0xFFFB, 0xFFFC, 0xFFFD, }); /** * C.7 Inappropriate for canonical representation */ private final CharClass C7 = CharClass.fromList(new int[]{ 0x2FF0, 0x2FF1, 0x2FF2, 0x2FF3, 0x2FF4, 0x2FF5, 0x2FF6, 0x2FF7, 0x2FF8, 0x2FF9, 0x2FFA, 0x2FFB, }); /** * C.8 Change display properties or are deprecated */ private final CharClass C8 = CharClass.fromList(new int[]{ 0x0340, 0x0341, 0x200E, 0x200F, 0x202A, 0x202B, 0x202C, 0x202D, 0x202E, 0x206A, 0x206B, 0x206C, 0x206D, 0x206E, 0x206F, }); /** * C.9 Tagging characters (tuples) */ private final CharClass C9 = CharClass.fromRanges(new int[]{ 0xE0001, 0xE0001, 0xE0020, 0xE007F, }); /** * D.1 Characters with bidirectional property "R" or "AL" */ private final CharClass D1 = CharClass.fromRanges(new int[]{ 0x05BE, 0x05BE, 0x05C0, 0x05C0, 0x05C3, 0x05C3, 0x05D0, 0x05EA, 0x05F0, 0x05F4, 0x061B, 0x061B, 0x061F, 0x061F, 0x0621, 0x063A, 0x0640, 0x064A, 0x066D, 0x066F, 0x0671, 0x06D5, 0x06DD, 0x06DD, 0x06E5, 0x06E6, 0x06FA, 0x06FE, 0x0700, 0x070D, 0x0710, 0x0710, 0x0712, 0x072C, 0x0780, 0x07A5, 0x07B1, 0x07B1, 0x200F, 0x200F, 0xFB1D, 0xFB1D, 0xFB1F, 0xFB28, 0xFB2A, 0xFB36, 0xFB38, 0xFB3C, 0xFB3E, 0xFB3E, 0xFB40, 0xFB41, 0xFB43, 0xFB44, 0xFB46, 0xFBB1, 0xFBD3, 0xFD3D, 0xFD50, 0xFD8F, 0xFD92, 0xFDC7, 0xFDF0, 0xFDFC, 0xFE70, 0xFE74, 0xFE76, 0xFEFC, }); /** * D.2 Characters with bidirectional property "L" */ private final CharClass D2 = CharClass.fromRanges(new int[]{ 0x0041, 0x005A, 0x0061, 0x007A, 0x00AA, 0x00AA, 0x00B5, 0x00B5, 0x00BA, 0x00BA, 0x00C0, 0x00D6, 0x00D8, 0x00F6, 0x00F8, 0x0220, 0x0222, 0x0233, 0x0250, 0x02AD, 0x02B0, 0x02B8, 0x02BB, 0x02C1, 0x02D0, 0x02D1, 0x02E0, 0x02E4, 0x02EE, 0x02EE, 0x037A, 0x037A, 0x0386, 0x0386, 0x0388, 0x038A, 0x038C, 0x038C, 0x038E, 0x03A1, 0x03A3, 0x03CE, 0x03D0, 0x03F5, 0x0400, 0x0482, 0x048A, 0x04CE, 0x04D0, 0x04F5, 0x04F8, 0x04F9, 0x0500, 0x050F, 0x0531, 0x0556, 0x0559, 0x055F, 0x0561, 0x0587, 0x0589, 0x0589, 0x0903, 0x0903, 0x0905, 0x0939, 0x093D, 0x0940, 0x0949, 0x094C, 0x0950, 0x0950, 0x0958, 0x0961, 0x0964, 0x0970, 0x0982, 0x0983, 0x0985, 0x098C, 0x098F, 0x0990, 0x0993, 0x09A8, 0x09AA, 0x09B0, 0x09B2, 0x09B2, 0x09B6, 0x09B9, 0x09BE, 0x09C0, 0x09C7, 0x09C8, 0x09CB, 0x09CC, 0x09D7, 0x09D7, 0x09DC, 0x09DD, 0x09DF, 0x09E1, 0x09E6, 0x09F1, 0x09F4, 0x09FA, 0x0A05, 0x0A0A, 0x0A0F, 0x0A10, 0x0A13, 0x0A28, 0x0A2A, 0x0A30, 0x0A32, 0x0A33, 0x0A35, 0x0A36, 0x0A38, 0x0A39, 0x0A3E, 0x0A40, 0x0A59, 0x0A5C, 0x0A5E, 0x0A5E, 0x0A66, 0x0A6F, 0x0A72, 0x0A74, 0x0A83, 0x0A83, 0x0A85, 0x0A8B, 0x0A8D, 0x0A8D, 0x0A8F, 0x0A91, 0x0A93, 0x0AA8, 0x0AAA, 0x0AB0, 0x0AB2, 0x0AB3, 0x0AB5, 0x0AB9, 0x0ABD, 0x0AC0, 0x0AC9, 0x0AC9, 0x0ACB, 0x0ACC, 0x0AD0, 0x0AD0, 0x0AE0, 0x0AE0, 0x0AE6, 0x0AEF, 0x0B02, 0x0B03, 0x0B05, 0x0B0C, 0x0B0F, 0x0B10, 0x0B13, 0x0B28, 0x0B2A, 0x0B30, 0x0B32, 0x0B33, 0x0B36, 0x0B39, 0x0B3D, 0x0B3E, 0x0B40, 0x0B40, 0x0B47, 0x0B48, 0x0B4B, 0x0B4C, 0x0B57, 0x0B57, 0x0B5C, 0x0B5D, 0x0B5F, 0x0B61, 0x0B66, 0x0B70, 0x0B83, 0x0B83, 0x0B85, 0x0B8A, 0x0B8E, 0x0B90, 0x0B92, 0x0B95, 0x0B99, 0x0B9A, 0x0B9C, 0x0B9C, 0x0B9E, 0x0B9F, 0x0BA3, 0x0BA4, 0x0BA8, 0x0BAA, 0x0BAE, 0x0BB5, 0x0BB7, 0x0BB9, 0x0BBE, 0x0BBF, 0x0BC1, 0x0BC2, 0x0BC6, 0x0BC8, 0x0BCA, 0x0BCC, 0x0BD7, 0x0BD7, 0x0BE7, 0x0BF2, 0x0C01, 0x0C03, 0x0C05, 0x0C0C, 0x0C0E, 0x0C10, 0x0C12, 0x0C28, 0x0C2A, 0x0C33, 0x0C35, 0x0C39, 0x0C41, 0x0C44, 0x0C60, 0x0C61, 0x0C66, 0x0C6F, 0x0C82, 0x0C83, 0x0C85, 0x0C8C, 0x0C8E, 0x0C90, 0x0C92, 0x0CA8, 0x0CAA, 0x0CB3, 0x0CB5, 0x0CB9, 0x0CBE, 0x0CBE, 0x0CC0, 0x0CC4, 0x0CC7, 0x0CC8, 0x0CCA, 0x0CCB, 0x0CD5, 0x0CD6, 0x0CDE, 0x0CDE, 0x0CE0, 0x0CE1, 0x0CE6, 0x0CEF, 0x0D02, 0x0D03, 0x0D05, 0x0D0C, 0x0D0E, 0x0D10, 0x0D12, 0x0D28, 0x0D2A, 0x0D39, 0x0D3E, 0x0D40, 0x0D46, 0x0D48, 0x0D4A, 0x0D4C, 0x0D57, 0x0D57, 0x0D60, 0x0D61, 0x0D66, 0x0D6F, 0x0D82, 0x0D83, 0x0D85, 0x0D96, 0x0D9A, 0x0DB1, 0x0DB3, 0x0DBB, 0x0DBD, 0x0DBD, 0x0DC0, 0x0DC6, 0x0DCF, 0x0DD1, 0x0DD8, 0x0DDF, 0x0DF2, 0x0DF4, 0x0E01, 0x0E30, 0x0E32, 0x0E33, 0x0E40, 0x0E46, 0x0E4F, 0x0E5B, 0x0E81, 0x0E82, 0x0E84, 0x0E84, 0x0E87, 0x0E88, 0x0E8A, 0x0E8A, 0x0E8D, 0x0E8D, 0x0E94, 0x0E97, 0x0E99, 0x0E9F, 0x0EA1, 0x0EA3, 0x0EA5, 0x0EA5, 0x0EA7, 0x0EA7, 0x0EAA, 0x0EAB, 0x0EAD, 0x0EB0, 0x0EB2, 0x0EB3, 0x0EBD, 0x0EBD, 0x0EC0, 0x0EC4, 0x0EC6, 0x0EC6, 0x0ED0, 0x0ED9, 0x0EDC, 0x0EDD, 0x0F00, 0x0F17, 0x0F1A, 0x0F34, 0x0F36, 0x0F36, 0x0F38, 0x0F38, 0x0F3E, 0x0F47, 0x0F49, 0x0F6A, 0x0F7F, 0x0F7F, 0x0F85, 0x0F85, 0x0F88, 0x0F8B, 0x0FBE, 0x0FC5, 0x0FC7, 0x0FCC, 0x0FCF, 0x0FCF, 0x1000, 0x1021, 0x1023, 0x1027, 0x1029, 0x102A, 0x102C, 0x102C, 0x1031, 0x1031, 0x1038, 0x1038, 0x1040, 0x1057, 0x10A0, 0x10C5, 0x10D0, 0x10F8, 0x10FB, 0x10FB, 0x1100, 0x1159, 0x115F, 0x11A2, 0x11A8, 0x11F9, 0x1200, 0x1206, 0x1208, 0x1246, 0x1248, 0x1248, 0x124A, 0x124D, 0x1250, 0x1256, 0x1258, 0x1258, 0x125A, 0x125D, 0x1260, 0x1286, 0x1288, 0x1288, 0x128A, 0x128D, 0x1290, 0x12AE, 0x12B0, 0x12B0, 0x12B2, 0x12B5, 0x12B8, 0x12BE, 0x12C0, 0x12C0, 0x12C2, 0x12C5, 0x12C8, 0x12CE, 0x12D0, 0x12D6, 0x12D8, 0x12EE, 0x12F0, 0x130E, 0x1310, 0x1310, 0x1312, 0x1315, 0x1318, 0x131E, 0x1320, 0x1346, 0x1348, 0x135A, 0x1361, 0x137C, 0x13A0, 0x13F4, 0x1401, 0x1676, 0x1681, 0x169A, 0x16A0, 0x16F0, 0x1700, 0x170C, 0x170E, 0x1711, 0x1720, 0x1731, 0x1735, 0x1736, 0x1740, 0x1751, 0x1760, 0x176C, 0x176E, 0x1770, 0x1780, 0x17B6, 0x17BE, 0x17C5, 0x17C7, 0x17C8, 0x17D4, 0x17DA, 0x17DC, 0x17DC, 0x17E0, 0x17E9, 0x1810, 0x1819, 0x1820, 0x1877, 0x1880, 0x18A8, 0x1E00, 0x1E9B, 0x1EA0, 0x1EF9, 0x1F00, 0x1F15, 0x1F18, 0x1F1D, 0x1F20, 0x1F45, 0x1F48, 0x1F4D, 0x1F50, 0x1F57, 0x1F59, 0x1F59, 0x1F5B, 0x1F5B, 0x1F5D, 0x1F5D, 0x1F5F, 0x1F7D, 0x1F80, 0x1FB4, 0x1FB6, 0x1FBC, 0x1FBE, 0x1FBE, 0x1FC2, 0x1FC4, 0x1FC6, 0x1FCC, 0x1FD0, 0x1FD3, 0x1FD6, 0x1FDB, 0x1FE0, 0x1FEC, 0x1FF2, 0x1FF4, 0x1FF6, 0x1FFC, 0x200E, 0x200E, 0x2071, 0x2071, 0x207F, 0x207F, 0x2102, 0x2102, 0x2107, 0x2107, 0x210A, 0x2113, 0x2115, 0x2115, 0x2119, 0x211D, 0x2124, 0x2124, 0x2126, 0x2126, 0x2128, 0x2128, 0x212A, 0x212D, 0x212F, 0x2131, 0x2133, 0x2139, 0x213D, 0x213F, 0x2145, 0x2149, 0x2160, 0x2183, 0x2336, 0x237A, 0x2395, 0x2395, 0x249C, 0x24E9, 0x3005, 0x3007, 0x3021, 0x3029, 0x3031, 0x3035, 0x3038, 0x303C, 0x3041, 0x3096, 0x309D, 0x309F, 0x30A1, 0x30FA, 0x30FC, 0x30FF, 0x3105, 0x312C, 0x3131, 0x318E, 0x3190, 0x31B7, 0x31F0, 0x321C, 0x3220, 0x3243, 0x3260, 0x327B, 0x327F, 0x32B0, 0x32C0, 0x32CB, 0x32D0, 0x32FE, 0x3300, 0x3376, 0x337B, 0x33DD, 0x33E0, 0x33FE, 0x3400, 0x4DB5, 0x4E00, 0x9FA5, 0xA000, 0xA48C, 0xAC00, 0xD7A3, 0xD800, 0xFA2D, 0xFA30, 0xFA6A, 0xFB00, 0xFB06, 0xFB13, 0xFB17, 0xFF21, 0xFF3A, 0xFF41, 0xFF5A, 0xFF66, 0xFFBE, 0xFFC2, 0xFFC7, 0xFFCA, 0xFFCF, 0xFFD2, 0xFFD7, 0xFFDA, 0xFFDC, 0x10300, 0x1031E, 0x10320, 0x10323, 0x10330, 0x1034A, 0x10400, 0x10425, 0x10428, 0x1044D, 0x1D000, 0x1D0F5, 0x1D100, 0x1D126, 0x1D12A, 0x1D166, 0x1D16A, 0x1D172, 0x1D183, 0x1D184, 0x1D18C, 0x1D1A9, 0x1D1AE, 0x1D1DD, 0x1D400, 0x1D454, 0x1D456, 0x1D49C, 0x1D49E, 0x1D49F, 0x1D4A2, 0x1D4A2, 0x1D4A5, 0x1D4A6, 0x1D4A9, 0x1D4AC, 0x1D4AE, 0x1D4B9, 0x1D4BB, 0x1D4BB, 0x1D4BD, 0x1D4C0, 0x1D4C2, 0x1D4C3, 0x1D4C5, 0x1D505, 0x1D507, 0x1D50A, 0x1D50D, 0x1D514, 0x1D516, 0x1D51C, 0x1D51E, 0x1D539, 0x1D53B, 0x1D53E, 0x1D540, 0x1D544, 0x1D546, 0x1D546, 0x1D54A, 0x1D550, 0x1D552, 0x1D6A3, 0x1D6A8, 0x1D7C9, 0x20000, 0x2A6D6, 0x2F800, 0x2FA1D, 0xF0000, 0xFFFFD, 0x100000, 0x10FFFD, }); /** * rfc4013 2.3. Prohibited Output */ private final CharClass saslProhibited = CharClass.fromClasses(C21, C22, C3, C4, C5, C6, C7, C8, C9); private String applyMapTo(final String s, final CharClass mapFrom, final String mapTo) { final StringBuilder result = new StringBuilder(); for (int i = 0; i < s.length(); ) { final int c = Character.codePointAt(s, i); final int charCount = Character.charCount(c); if (mapFrom.isCharInClass(c)) result.append(mapTo); else result.append(s, i, i + charCount); i += charCount; } return result.toString(); } /** * Return the first character index in s which is in {@link CharClass}, or -1 if * no character is in the class. */ private int containsCharacterInClass(final String s, final CharClass charClass) { for (int i = 0; i < s.length(); ) { final int c = Character.codePointAt(s, i); if (charClass.isCharInClass(c)) return i; i += Character.charCount(c); } return -1; } private void verifyRTL(final String s) throws ScramException { final int containsRAL = containsCharacterInClass(s, D1); if (containsRAL != -1) { if (containsCharacterInClass(s, D2) != -1) { throw new ScramException("String contains both RandALCat and LCat characters, which is not allowed."); } if (containsRAL != 0) { throw new ScramException("String contains RandALCat character but does not start with one, which is required."); } // FIX: last code point, not last char final int lastCp = Character.codePointBefore(s, s.length()); if (!D1.isCharInClass(lastCp)) { throw new ScramException("String contains RandALCat character but does not end with one, which is required."); } } } /** * Apply SASLPrep and return the result. {@code} is treated as a stored string. */ public String prepAsStoredString(final String s) throws ScramException { final String copy = prepAsQueryString(s); final int idx = containsCharacterInClass(copy, A1); if (idx != -1) { throw new ScramException("Stored string contains an unassigned code point at index " + idx + "."); } return copy; } public String prepAsQueryString(final String s) throws ScramException { String copy = s; // 1) Map (REQUIRED) copy = applyMapTo(copy, B1, ""); // commonly mapped to nothing copy = applyMapTo(copy, C12, " "); // non-ASCII spaces → ASCII space // 2) Normalize (REQUIRED): NFKC (Compatibility Composition) if (!Normalizer.isNormalized(copy, Normalizer.Form.NFKC)) { copy = Normalizer.normalize(copy, Normalizer.Form.NFKC); } // 3) Prohibit (REQUIRED) final int bad = containsCharacterInClass(copy, saslProhibited); if (bad != -1) { throw new ScramException( "The string contains a prohibited character at index " + bad + ", which is not allowed per RFC 4013."); } // 4) BiDi (REQUIRED) — use last code point, not charAt verifyRTL(copy); // your version that uses codePointBefore() return copy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/ScramExtension.java0100644 0000000 0000000 00000004045 00000250600 027120 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.core5.http.protocol.HttpContext; /** * Extension hook for optional SCRAM attributes. * * @since 5.6 */ public interface ScramExtension { /** * Process an extension attribute. * * @param name attribute name * @param value attribute value or {@code null} * @param context HTTP context * @return true if processed, false to ignore * @throws AuthenticationException on processing error * @since 5.6 */ boolean process(String name, String value, HttpContext context) throws AuthenticationException; /** * Whether this extension supports the given attribute name. * * @param name attribute name * @return true if supported * @since 5.6 */ boolean supports(String name); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/ScramScheme.java0100644 0000000 0000000 00000067500 00000250600 026355 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.StandardCharsets; import java.security.GeneralSecurityException; import java.security.MessageDigest; import java.security.Principal; import java.security.SecureRandom; import java.util.Arrays; import java.util.Base64; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import javax.crypto.Mac; import javax.crypto.SecretKeyFactory; import javax.crypto.spec.PBEKeySpec; import javax.crypto.spec.SecretKeySpec; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Strict HTTP SCRAM client implementing {@code SCRAM-SHA-256} per RFC 7804 * with SCRAM core per RFC 5802/7677. *

HTTP SCRAM uses no channel binding (GS2 header {@code "n,,"}; {@code c=biws}).

*

Experimental: This API is work in progress and may change without notice in a future release.

* * @since 5.6 */ @Contract(threading = ThreadingBehavior.UNSAFE) @Experimental public final class ScramScheme implements AuthScheme { private static final Logger LOG = LoggerFactory.getLogger(ScramScheme.class); private static final int DEFAULT_WARN_MIN_ITERATIONS = 4096; private static final int DEFAULT_MAX_ITERATIONS_ALLOWED = 100000; // RFC 7804 / RFC 5802 fixed no-CB GS2 header and its base64 value for 'c=' private static final String GS2_HEADER = "n,,"; private static final String C_BIND_B64 = "biws"; // base64("n,,") private static final Base64.Encoder B64 = Base64.getEncoder().withoutPadding(); private static final Base64.Decoder B64D = Base64.getDecoder(); private enum State { INIT, ANNOUNCED, // after 401 challenge without data CLIENT_FIRST_SENT, // after Authorization with client-first SERVER_FIRST_RCVD, // after 401 with data (r,s,i) CLIENT_FINAL_SENT, // after Authorization with client-final (p=...) COMPLETE, // after 2xx with matching v FAILED } private final SecureRandom secureRandom; private final int warnMinIterations; private final int minIterationsRequired; private final int maxIterationsAllowed; private State state = State.INIT; private boolean complete; private String realm; private String sid; private String username; // SASLprep (query) private char[] password; // SASLprep (stored), zeroed after use private Principal principal; private String clientNonce; private String clientFirstBare; private String serverFirstRaw; private String serverNonce; private byte[] salt; private int iterations; // Expected server signature (raw bytes) for constant-time check on Authentication-Info // (may appear on any final response status code) private byte[] expectedV; /** * Default policy: warn if {@code i < 4096}, no hard enforcement; SHA-256 only. * * @since 5.6 */ public ScramScheme() { this(DEFAULT_WARN_MIN_ITERATIONS, 0, DEFAULT_MAX_ITERATIONS_ALLOWED, null); } /** * Constructor with custom iteration policy. * * @param warnMinIterations warn if iteration count is lower than this (0 disables warnings) * @param minIterationsRequired fail if iteration count is lower than this (0 disables enforcement) * @param rnd optional secure random source (null uses system default) * @since 5.6 */ public ScramScheme(final int warnMinIterations, final int minIterationsRequired, final SecureRandom rnd) { this(warnMinIterations, minIterationsRequired, DEFAULT_MAX_ITERATIONS_ALLOWED, rnd); } /** * Constructor with custom iteration policy. * * @param warnMinIterations warn if iteration count is lower than this (0 disables warnings) * @param minIterationsRequired fail if iteration count is lower than this (0 disables enforcement) * @param maxIterationsAllowed fail if iteration count is greater than this (must be positive) * @param rnd optional secure random source (null uses system default) * @since 5.6 */ public ScramScheme( final int warnMinIterations, final int minIterationsRequired, final int maxIterationsAllowed, final SecureRandom rnd) { this.warnMinIterations = Math.max(0, warnMinIterations); this.minIterationsRequired = Math.max(0, minIterationsRequired); this.maxIterationsAllowed = Args.positive(maxIterationsAllowed, "Max iterations allowed"); this.secureRandom = rnd != null ? rnd : new SecureRandom(); } /** * Returns textual designation of the scheme. * * @since 5.6 */ @Override public String getName() { return StandardAuthScheme.SCRAM_SHA_256; } /** * SCRAM is per-request (no connection binding). * * @since 5.6 */ @Override public boolean isConnectionBased() { return false; } /** * SCRAM must inspect final responses to verify {@code v=} in {@code Authentication-Info}. * * @since 5.6 */ @Override public boolean isChallengeExpected() { return true; } /** * Legacy entry point: wraps {@link AuthenticationException} as {@link MalformedChallengeException}. * * @since 5.6 */ @Override public void processChallenge(final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { try { processChallenge(null, true, authChallenge, context); } catch (final AuthenticationException ex) { throw new MalformedChallengeException(ex.getMessage(), ex); } } /** * Handles 401 challenges (with/without {@code data}) and final responses carrying * {@code Authentication-Info} (any status code). * * @since 5.6 */ @Override public void processChallenge( final HttpHost host, final boolean challenged, final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException, AuthenticationException { Args.notNull(context, "HTTP context"); if (authChallenge == null) { if (!challenged && this.state == State.CLIENT_FINAL_SENT) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new AuthenticationException("Missing SCRAM Authentication-Info"); } throw new MalformedChallengeException("Null SCRAM challenge"); } final Map params = toParamMap(authChallenge.getParams()); if (challenged) { // --- 401 path (WWW-Authenticate) --- final String scheme = authChallenge.getSchemeName(); if (scheme == null || !StandardAuthScheme.SCRAM_SHA_256.equalsIgnoreCase(scheme)) { throw new MalformedChallengeException("Unexpected scheme: " + scheme); } final String data = params.get("data"); if (data == null) { // initial announce (no data) this.realm = params.get("realm"); this.state = State.ANNOUNCED; this.complete = false; zeroAndClearExpectedV(); return; } final String sid = params.get("sid"); if (sid == null || sid.isEmpty()) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new MalformedChallengeException("SCRAM server-first missing sid"); } // server-first (data present) final String decoded; try { decoded = b64ToString(data); } catch (final MalformedChallengeException ex) { zeroAndClearExpectedV(); this.state = State.FAILED; throw ex; } this.serverFirstRaw = decoded; final Map attrs; try { attrs = parseAttrs(decoded); } catch (final MalformedChallengeException ex) { zeroAndClearExpectedV(); this.state = State.FAILED; throw ex; } final String r = attrs.get("r"); final String s = attrs.get("s"); final String i = attrs.get("i"); if (r == null || r.isEmpty() || s == null || s.isEmpty() || i == null || i.isEmpty()) { this.state = State.FAILED; throw new MalformedChallengeException("SCRAM server-first missing r/s/i"); } if (this.clientNonce == null || !r.startsWith(this.clientNonce)) { this.state = State.FAILED; throw new AuthenticationException("SCRAM server nonce does not start with client nonce"); } try { this.salt = B64D.decode(s); if (this.salt.length == 0) { throw new IllegalArgumentException("empty salt"); } } catch (final IllegalArgumentException e) { this.state = State.FAILED; throw new MalformedChallengeException("Invalid base64 salt", e); } try { this.iterations = Integer.parseInt(i); if (this.iterations <= 0) { throw new NumberFormatException("i<=0"); } } catch (final NumberFormatException e) { this.state = State.FAILED; throw new MalformedChallengeException("Invalid iteration count", e); } if (this.minIterationsRequired > 0 && this.iterations < this.minIterationsRequired) { this.state = State.FAILED; throw new AuthenticationException( "SCRAM iteration count below required minimum: " + this.iterations + " < " + this.minIterationsRequired); } if (this.iterations > this.maxIterationsAllowed) { this.state = State.FAILED; throw new AuthenticationException( "SCRAM iteration count above allowed maximum: " + this.iterations + " > " + this.maxIterationsAllowed); } if (this.warnMinIterations > 0 && this.iterations < this.warnMinIterations && LOG.isWarnEnabled()) { LOG.warn("SCRAM iteration count ({}) lower than recommended ({})", this.iterations, warnMinIterations); } this.sid = sid; this.serverNonce = r; this.state = State.SERVER_FIRST_RCVD; this.complete = false; zeroAndClearExpectedV(); return; } if (this.state != State.CLIENT_FINAL_SENT) { final State currentState = this.state; zeroAndClearExpectedV(); this.state = State.FAILED; throw new AuthenticationException("SCRAM final response out of sequence: " + currentState); } final String sid = params.get("sid"); if (sid == null || sid.isEmpty()) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new MalformedChallengeException("SCRAM Authentication-Info missing sid"); } if (this.sid == null || !this.sid.equals(sid)) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new AuthenticationException("SCRAM sid mismatch"); } // --- final-response path (Authentication-Info on any status) --- // For Authentication-Info, RFC 7804 does NOT mandate a scheme token; do NOT enforce scheme name here. final String data = params.get("data"); if (data == null) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new MalformedChallengeException("SCRAM Authentication-Info missing data"); } final String decoded; try { decoded = b64ToString(data); } catch (final MalformedChallengeException ex) { zeroAndClearExpectedV(); this.state = State.FAILED; throw ex; } final Map attrs; try { attrs = parseAttrs(decoded); } catch (final MalformedChallengeException ex) { zeroAndClearExpectedV(); this.state = State.FAILED; throw ex; } final String err = attrs.get("e"); if (err != null) { this.state = State.FAILED; if (err.isEmpty()) { throw new MalformedChallengeException("SCRAM server error attribute 'e' is empty"); } throw new AuthenticationException("SCRAM server error: " + err); } final String vB64 = attrs.get("v"); if (vB64 == null) { zeroAndClearExpectedV(); this.state = State.FAILED; throw new MalformedChallengeException("SCRAM Authentication-Info missing v"); } // compare 'v' in constant time; treat bad base64 for v as a signature mismatch (tests expect "signature") final byte[] expected = this.expectedV; this.expectedV = null; // clear reference early byte[] vBytes = null; boolean match; try { vBytes = B64D.decode(vB64); match = expected != null && MessageDigest.isEqual(expected, vBytes); } catch (final IllegalArgumentException e) { match = false; // invalid base64 for v -> treat as mismatch } finally { zero(vBytes); zero(expected); } if (!match) { this.state = State.FAILED; throw new MalformedChallengeException("SCRAM server signature mismatch"); } this.complete = true; this.state = State.COMPLETE; } /** * @since 5.6 */ @Override public boolean isChallengeComplete() { return this.state == State.FAILED; } /** * @since 5.6 */ @Override public String getRealm() { return this.realm; } /** * Allow response when: * - INIT (preemptive client-first) — only if creds have been prepared * - ANNOUNCED (401 without data) * - SERVER_FIRST_RCVD (ready to send client-final) * * @since 5.6 */ @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(credentialsProvider, "Credentials provider"); final HttpClientContext clientContext = HttpClientContext.cast(context); final AuthScope scope = new AuthScope(host, this.realm, getName()); final Credentials creds = credentialsProvider.getCredentials(scope, clientContext); if (!(creds instanceof UsernamePasswordCredentials)) { return false; } final UsernamePasswordCredentials up = (UsernamePasswordCredentials) creds; // SASLprep: username as query, password as stored final String preppedUser; final char[] passChars = up.getUserPassword() != null ? up.getUserPassword().clone() : null; try { preppedUser = SaslPrep.INSTANCE.prepAsQueryString(up.getUserName()); final String preppedPassStr = SaslPrep.INSTANCE.prepAsStoredString( passChars != null ? new String(passChars) : null); this.username = preppedUser; this.password = preppedPassStr != null ? preppedPassStr.toCharArray() : null; } catch (final Exception e) { throw new AuthenticationException("SASLprep failed", e); } finally { if (passChars != null) { Arrays.fill(passChars, '\0'); } } this.principal = new SimplePrincipal(this.username); switch (this.state) { case INIT: // allow preemptive case ANNOUNCED: case SERVER_FIRST_RCVD: return true; default: return false; } } /** * @since 5.6 */ @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { switch (this.state) { case INIT: // Allow preemptive only if credentials were prepared already if (this.username == null) { this.state = State.FAILED; throw new AuthenticationException("SCRAM state out of sequence: INIT without credentials"); } return buildClientFirst(); case ANNOUNCED: return buildClientFirst(); case SERVER_FIRST_RCVD: return buildClientFinalAndExpectV(); default: this.state = State.FAILED; throw new AuthenticationException("SCRAM state out of sequence: " + this.state); } } /** * Returns {@link Principal} whose credentials are used. * * @since 5.6 */ @Override public Principal getPrincipal() { return this.principal; } // ---------------- internals ---------------- private String buildClientFirst() { this.clientNonce = genNonce(); final String escUser = escapeUser(this.username); this.clientFirstBare = "n=" + escUser + ",r=" + this.clientNonce; // RFC 7804: data = base64(GS2 header + client-first-bare) final String data = stringToB64(GS2_HEADER + this.clientFirstBare); final StringBuilder sb = new StringBuilder(64); sb.append(StandardAuthScheme.SCRAM_SHA_256).append(' '); if (this.realm != null) { sb.append("realm=").append(quoteParam(this.realm)).append(", "); } sb.append("data=").append(quoteParam(data)); // quoted per RFC 7804 this.state = State.CLIENT_FIRST_SENT; this.complete = false; zeroAndClearExpectedV(); return sb.toString(); } private String buildClientFinalAndExpectV() throws AuthenticationException { byte[] salted = null, clientKey = null, storedKey = null, clientSignature = null, clientProof = null, serverKey = null, serverSignature = null; try { // HTTP SCRAM: no CB -> c=biws final String clientFinalNoProof = "c=" + C_BIND_B64 + ",r=" + this.serverNonce; final String authMessage = this.clientFirstBare + "," + this.serverFirstRaw + "," + clientFinalNoProof; salted = hiPBKDF2(this.password, this.salt, this.iterations, 32); clientKey = hmac(salted, "Client Key"); storedKey = sha256(clientKey); clientSignature = hmac(storedKey, authMessage); clientProof = xor(clientKey, clientSignature); final String pB64 = B64.encodeToString(clientProof); serverKey = hmac(salted, "Server Key"); serverSignature = hmac(serverKey, authMessage); // Stash expected v (raw) for constant-time check on 2xx zeroAndClearExpectedV(); this.expectedV = serverSignature.clone(); final String clientFinal = clientFinalNoProof + ",p=" + pB64; final String data = stringToB64(clientFinal); final StringBuilder sb = new StringBuilder(64); sb.append(StandardAuthScheme.SCRAM_SHA_256).append(' '); sb.append("sid=").append(quoteParam(this.sid)).append(", "); sb.append("data=").append(quoteParam(data)); // quoted this.state = State.CLIENT_FINAL_SENT; this.complete = false; return sb.toString(); } catch (final GeneralSecurityException e) { this.state = State.FAILED; throw new AuthenticationException("SCRAM crypto failure", e); } finally { if (this.password != null) { Arrays.fill(this.password, '\0'); this.password = null; } zero(salted); zero(clientKey); zero(storedKey); zero(clientSignature); zero(clientProof); zero(serverKey); // clone held in expectedV zero(serverSignature); } } private static void zero(final byte[] a) { if (a != null) { Arrays.fill(a, (byte) 0); } } private void zeroAndClearExpectedV() { if (this.expectedV != null) { zero(this.expectedV); this.expectedV = null; } } private static Map toParamMap(final List pairs) { final Map m = new HashMap<>(); if (pairs != null) { for (final NameValuePair p : pairs) { if (p != null && p.getName() != null) { m.put(p.getName().toLowerCase(Locale.ROOT), p.getValue()); } } } return m; } // Parse "k=v(,k=v)*" with RFC 5802 escapes: "=2C"/"=2c" -> ",", "=3D"/"=3d" -> "=" private static Map parseAttrs(final String s) throws MalformedChallengeException { final Map out = new LinkedHashMap<>(); int i = 0; while (i < s.length()) { if (i + 2 > s.length() || s.charAt(i + 1) != '=') { throw new MalformedChallengeException("Bad SCRAM attr at index " + i); } final String k = String.valueOf(s.charAt(i)); i += 2; final StringBuilder v = new StringBuilder(); while (i < s.length()) { final char c = s.charAt(i); if (c == ',') { i++; break; } if (c == '=' && i + 2 < s.length()) { final String esc = s.substring(i, i + 3); if ("=2C".equalsIgnoreCase(esc)) { v.append(','); i += 3; continue; } if ("=3D".equalsIgnoreCase(esc)) { v.append('='); i += 3; continue; } } v.append(c); i++; } out.put(k, v.toString()); } return out; } private String genNonce() { final byte[] buf = new byte[16]; this.secureRandom.nextBytes(buf); final StringBuilder sb = new StringBuilder(buf.length * 2); for (final byte b : buf) { final int v = b & 0xff; if (v < 0x10) { sb.append('0'); } sb.append(Integer.toHexString(v)); } return sb.toString(); } private static String escapeUser(final String user) { if (user == null) { // Defensive for tests that skip isResponseReady() before client-first return ""; } final StringBuilder sb = new StringBuilder(user.length() + 8); for (int i = 0; i < user.length(); i++) { final char c = user.charAt(i); if (c == ',') { sb.append("=2C"); } else if (c == '=') { sb.append("=3D"); } else { sb.append(c); } } return sb.toString(); } private static String quoteParam(final String v) { if (v == null) { return "\"\""; } final StringBuilder sb = new StringBuilder(v.length() + 2); sb.append('"'); for (int i = 0; i < v.length(); i++) { final char c = v.charAt(i); if (c == '\\' || c == '"') { sb.append('\\'); } sb.append(c); } sb.append('"'); return sb.toString(); } private static byte[] hiPBKDF2(final char[] password, final byte[] salt, final int iterations, final int dkLen) throws GeneralSecurityException { final PBEKeySpec spec = new PBEKeySpec(password, salt, iterations, dkLen * 8); return SecretKeyFactory.getInstance("PBKDF2WithHmacSHA256").generateSecret(spec).getEncoded(); } private static byte[] hmac(final byte[] key, final String msg) throws GeneralSecurityException { final Mac mac = Mac.getInstance("HmacSHA256"); mac.init(new SecretKeySpec(key, "HmacSHA256")); return mac.doFinal(msg.getBytes(StandardCharsets.UTF_8)); } private static byte[] sha256(final byte[] in) throws GeneralSecurityException { return MessageDigest.getInstance("SHA-256").digest(in); } private static byte[] xor(final byte[] a, final byte[] b) { final int len = Math.min(a.length, b.length); final byte[] out = new byte[len]; for (int i = 0; i < len; i++) { out[i] = (byte) (a[i] ^ b[i]); } return out; } private static String stringToB64(final String s) { return B64.encodeToString(s.getBytes(StandardCharsets.UTF_8)); } private static String b64ToString(final String b64) throws MalformedChallengeException { try { return new String(B64D.decode(b64), StandardCharsets.UTF_8); } catch (final IllegalArgumentException e) { throw new MalformedChallengeException("Bad base64 'data' value", e); } } private static final class SimplePrincipal implements Principal { private final String name; private SimplePrincipal(final String name) { this.name = name; } @Override public String getName() { return this.name; } @Override public String toString() { return this.name; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/ScramSchemeFactory.java0100644 0000000 0000000 00000004034 00000250600 027676 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.protocol.HttpContext; /** * Factory for creating instances of {@link ScramScheme}. * * @since 5.6 */ @Experimental public final class ScramSchemeFactory implements AuthSchemeFactory { /** * Singleton instance. */ public static final ScramSchemeFactory INSTANCE = new ScramSchemeFactory(); private ScramSchemeFactory() { } /** * Creates a new {@link ScramScheme}. * * @param context the HTTP context (unused) * @return a new {@link ScramScheme} instance * @since 5.6 */ @Override public AuthScheme create(final HttpContext context) { return new ScramScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SingleCredentialsProvider.java0100644 0000000 0000000 00000004553 00000250600 031274 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; final class SingleCredentialsProvider implements CredentialsProvider { private final AuthScope authScope; private final Credentials credentials; public SingleCredentialsProvider(final AuthScope authScope, final Credentials credentials) { super(); this.authScope = Args.notNull(authScope, "Auth scope"); this.credentials = credentials; } public SingleCredentialsProvider(final AuthScope authScope, final String username, final char[] password) { this(authScope, new UsernamePasswordCredentials(username, password)); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return this.authScope.match(authScope) >= 0 ? credentials : null; } @Override public String toString() { return authScope.toString(); } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SystemDefaultCredentialsProvider.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SystemDefaultCredentialsProvider.java0100644 0000000 0000000 00000016467 00000250600 032653 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.net.Authenticator; import java.net.MalformedURLException; import java.net.PasswordAuthentication; import java.net.URI; import java.net.URISyntaxException; import java.net.URL; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Implementation of {@link CredentialsStore} backed by standard * JRE {@link Authenticator}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) @SuppressWarnings("deprecation") public class SystemDefaultCredentialsProvider implements CredentialsStore { private final BasicCredentialsProvider internal; /** * Default constructor. */ public SystemDefaultCredentialsProvider() { super(); this.internal = new BasicCredentialsProvider(); } @Override public void setCredentials(final AuthScope authScope, final Credentials credentials) { internal.setCredentials(authScope, credentials); } private static PasswordAuthentication getSystemCreds( final String protocol, final AuthScope authScope, final Authenticator.RequestorType requestorType, final HttpClientContext context) { final HttpRequest request = context != null ? context.getRequest() : null; URL targetHostURL; try { final URI uri = request != null ? request.getUri() : null; targetHostURL = uri != null ? uri.toURL() : null; } catch (final URISyntaxException | MalformedURLException ignore) { targetHostURL = null; } // use null addr, because the authentication fails if it does not exactly match the expected realm's host return Authenticator.requestPasswordAuthentication( authScope.getHost(), null, authScope.getPort(), protocol, authScope.getRealm(), authScope.getSchemeName(), targetHostURL, requestorType); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { Args.notNull(authScope, "Auth scope"); final Credentials localcreds = internal.getCredentials(authScope, context); if (localcreds != null) { return localcreds; } final String host = authScope.getHost(); if (host != null) { final HttpClientContext clientContext = context != null ? HttpClientContext.cast(context) : null; final String protocol = authScope.getProtocol() != null ? authScope.getProtocol() : (authScope.getPort() == 443 ? URIScheme.HTTPS.id : URIScheme.HTTP.id); PasswordAuthentication systemcreds = getSystemCreds( protocol, authScope, Authenticator.RequestorType.SERVER, clientContext); if (systemcreds == null) { systemcreds = getSystemCreds( protocol, authScope, Authenticator.RequestorType.PROXY, clientContext); } if (systemcreds == null) { // Look for values given using http.proxyUser/http.proxyPassword or // https.proxyUser/https.proxyPassword. We cannot simply use the protocol from // the origin since a proxy retrieved from https.proxyHost/https.proxyPort will // still use http as protocol systemcreds = getProxyCredentials(URIScheme.HTTP.getId(), authScope); if (systemcreds == null) { systemcreds = getProxyCredentials(URIScheme.HTTPS.getId(), authScope); } } if (systemcreds != null) { final String domain = System.getProperty("http.auth.ntlm.domain"); if (domain != null) { return new org.apache.hc.client5.http.auth.NTCredentials( systemcreds.getUserName(), systemcreds.getPassword(), null, domain); } if (StandardAuthScheme.NTLM.equalsIgnoreCase(authScope.getSchemeName())) { // Domain may be specified in a fully qualified user name return new org.apache.hc.client5.http.auth.NTCredentials( systemcreds.getUserName(), systemcreds.getPassword(), null, null); } return new UsernamePasswordCredentials(systemcreds.getUserName(), systemcreds.getPassword()); } } return null; } private static PasswordAuthentication getProxyCredentials(final String protocol, final AuthScope authScope) { final String proxyHost = System.getProperty(protocol + ".proxyHost"); if (proxyHost == null) { return null; } final String proxyPort = System.getProperty(protocol + ".proxyPort"); if (proxyPort == null) { return null; } try { final AuthScope systemScope = new AuthScope(proxyHost, Integer.parseInt(proxyPort)); if (authScope.match(systemScope) >= 0) { final String proxyUser = System.getProperty(protocol + ".proxyUser"); if (proxyUser == null) { return null; } final String proxyPassword = System.getProperty(protocol + ".proxyPassword"); return new PasswordAuthentication(proxyUser, proxyPassword != null ? proxyPassword.toCharArray() : new char[] {}); } } catch (final NumberFormatException ignore) { } return null; } @Override public void clear() { internal.clear(); } } ././@LongLink0100644 0000000 0000000 00000000150 00000250600 011605 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/UnsupportedDigestAlgorithmException.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/UnsupportedDigestAlgorithmException.j0100644 0000000 0000000 00000004553 00000250600 032710 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; /** * Authentication credentials required to respond to a authentication * challenge are invalid * * @since 4.0 */ public class UnsupportedDigestAlgorithmException extends RuntimeException { private static final long serialVersionUID = 319558534317118022L; /** * Creates a new UnsupportedDigestAlgorithmException with a {@code null} detail message. */ public UnsupportedDigestAlgorithmException() { super(); } /** * Creates a new UnsupportedDigestAlgorithmException with the specified message. * * @param message the exception detail message */ public UnsupportedDigestAlgorithmException(final String message) { super(message); } /** * Creates a new UnsupportedDigestAlgorithmException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/package-info.java0100644 0000000 0000000 00000002413 00000250600 026477 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard and common HTTP authentication schemes. */ package org.apache.hc.client5.http.impl.auth; httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/0040755 0000000 0000000 00000000000 00000250600 023773 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AIMDBackoffManager.java0100644 0000000 0000000 00000007766 00000250600 030134 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; /** *

The {@code AIMDBackoffManager} applies an additive increase, * multiplicative decrease (AIMD) to managing a dynamic limit to * the number of connections allowed to a given host. You may want * to experiment with the settings for the cooldown periods and the * backoff factor to get the adaptive behavior you want.

* *

Generally speaking, shorter cooldowns will lead to more steady-state * variability but faster reaction times, while longer cooldowns * will lead to more stable equilibrium behavior but slower reaction * times.

* *

Similarly, higher backoff factors promote greater * utilization of available capacity at the expense of fairness * among clients. Lower backoff factors allow equal distribution of * capacity among clients (fairness) to happen faster, at the * expense of having more server capacity unused in the short term.

* * @since 4.2 */ @Contract(threading = ThreadingBehavior.SAFE) public class AIMDBackoffManager extends AbstractBackoff { /** * Constructs an {@code AIMDBackoffManager} with the specified * {@link ConnPoolControl} and {@link Clock}. *

* This constructor is primarily used for testing purposes, allowing the * injection of a custom {@link Clock} implementation. * * @param connPerRoute the {@link ConnPoolControl} that manages * per-host routing maximums */ public AIMDBackoffManager(final ConnPoolControl connPerRoute) { super(connPerRoute); } /** * Returns the backed-off pool size based on the current pool size. * The new pool size is calculated as the floor of (backoffFactor * curr). * * @param curr the current pool size * @return the backed-off pool size, with a minimum value of 1 */ @Override protected int getBackedOffPoolSize(final int curr) { if (curr <= 1) { return 1; } return (int) (Math.floor(getBackoffFactor().get() * curr)); } /** * Sets the factor to use when backing off; the new * per-host limit will be roughly the current max times * this factor. {@code Math.floor} is applied in the * case of non-integer outcomes to ensure we actually * decrease the pool size. Pool sizes are never decreased * below 1, however. Defaults to 0.5. * @param d must be between 0.0 and 1.0, exclusive. */ @Override public void setBackoffFactor(final double d) { Args.check(d > 0.0 && d < 1.0, "Backoff factor must be 0.0 < f < 1.0"); getBackoffFactor().set(d); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractBackoff.java0100644 0000000 0000000 00000025271 00000250600 027661 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; /** * AbstractBackoff is an abstract class that provides a common implementation for managing * backoff behavior in HttpClient connection pool. Subclasses should implement the specific * backoff algorithms by overriding the abstract methods. *

* This class provides common functionality for maintaining the route-wise backoff and probe * timestamps, as well as the cool-down period for each backoff attempt. *

* It also contains the basic structure of the backOff and probe methods, which use the route-wise * timestamps to determine if the backoff or probe should be applied, and then call the specific * algorithm implementation for calculating the new pool size. * * @since 5.3 */ public abstract class AbstractBackoff implements BackoffManager { private static final Logger LOG = LoggerFactory.getLogger(AbstractBackoff.class); /** * Connection pool control responsible for managing the maximum number of connections per HTTP route. */ private final ConnPoolControl connPerRoute; /** * A map that stores the last probe timestamp for each HTTP route. */ private final Map lastRouteProbes; /** * A map that stores the last backoff timestamp for each HTTP route. */ private final Map lastRouteBackoffs; /** * The cool-down period after which the backoff or probe process can be performed again. */ private final AtomicReference coolDown = new AtomicReference<>(TimeValue.ofSeconds(5L)); /** * The growth rate used in the exponential backoff algorithm. */ private final AtomicReference backoffFactor = new AtomicReference<>(0.5); /** * The per-host connection cap, as defined in RFC 2616 sec 8.1.4. */ private final AtomicInteger cap = new AtomicInteger(2); /** * The number of time intervals used in the exponential backoff algorithm. */ private final AtomicInteger timeInterval = new AtomicInteger(0); /** * Constructs a new ExponentialBackoffManager with the specified connection pool control. * * @param connPerRoute the connection pool control to be used for managing connections * @throws IllegalArgumentException if connPerRoute is null */ public AbstractBackoff(final ConnPoolControl connPerRoute) { this.connPerRoute = Args.notNull(connPerRoute, "Connection pool control"); this.lastRouteProbes = new ConcurrentHashMap<>(); this.lastRouteBackoffs = new ConcurrentHashMap<>(); } /** * Reduces the number of maximum allowed connections for the specified route based on the exponential backoff algorithm. * * @param route the HttpRoute for which the backoff needs to be applied */ @Override public void backOff(final HttpRoute route) { final int curr = connPerRoute.getMaxPerRoute(route); final Instant now = Instant.now(); lastRouteBackoffs.compute(route, (r, lastUpdate) -> { if (lastUpdate == null || now.isAfter(lastUpdate.plus(coolDown.get().toMilliseconds(), ChronoUnit.MILLIS))) { final int backedOffPoolSize = getBackedOffPoolSize(curr); // Exponential backoff connPerRoute.setMaxPerRoute(route, backedOffPoolSize); if (LOG.isDebugEnabled()) { LOG.debug("Backoff applied for route: {}, new max connections: {}", route, connPerRoute.getMaxPerRoute(route)); } return now; } return lastUpdate; }); } /** * Calculates the new pool size after applying the exponential backoff algorithm. * The new pool size is calculated using the formula: floor(curr / (1 + growthRate) ^ t), * where curr is the current pool size, growthRate is the exponential growth rate, and t is the time interval. * * @param curr the current pool size * @return the new pool size after applying the backoff */ protected abstract int getBackedOffPoolSize(int curr); /** * Increases the number of maximum allowed connections for the specified route after a successful connection has been established. * * @param route the HttpRoute for which the probe needs to be applied */ @Override public void probe(final HttpRoute route) { final int curr = connPerRoute.getMaxPerRoute(route); final int max = (curr >= cap.get()) ? cap.get() : curr + 1; final Instant now = Instant.now(); lastRouteProbes.compute(route, (r, lastProbe) -> { if (lastProbe == null || now.isAfter(lastProbe.plus(coolDown.get().toMilliseconds(), ChronoUnit.MILLIS))) { final Instant lastBackoff = lastRouteBackoffs.get(r); if (lastBackoff == null || now.isAfter(lastBackoff.plus(coolDown.get().toMilliseconds(), ChronoUnit.MILLIS))) { connPerRoute.setMaxPerRoute(route, max); if (LOG.isDebugEnabled()) { LOG.info("Probe applied for route: {}, new max connections: {}", route, connPerRoute.getMaxPerRoute(route)); } timeInterval.set(0); // Reset the time interval return now; } } return lastProbe; }); } /** * Retrieves the last update timestamp for the specified route from the provided updates map. * * @param updates the map containing update timestamps for HttpRoutes * @param route the HttpRoute for which the last update timestamp is needed * @return the last update timestamp for the specified route or 0L if not present in the map */ public long getLastUpdate(final Map updates, final HttpRoute route) { return updates.getOrDefault(route, 0L); } /** * Sets the per-host connection cap. * * @param cap the per-host connection cap to be set * @throws IllegalArgumentException if the cap is not positive */ public void setPerHostConnectionCap(final int cap) { Args.positive(cap, "Per host connection cap"); this.cap.set(cap); } /** * Sets the backoff factor for the backoff algorithm. * The backoff factor should be a value between 0.0 and 1.0. * The specific implementation of how the backoff factor is used should be provided by subclasses. * * @param d the backoff factor to be set */ abstract void setBackoffFactor(final double d); /** * Sets the cool-down time value for adjustments in pool sizes for a given host. This time value * allows enough time for the adjustments to take effect before further adjustments are made. * The cool-down time value must be positive and not null. * * @param coolDown the TimeValue representing the cool-down period between adjustments * @throws IllegalArgumentException if the provided cool-down time value is null or non-positive */ public void setCoolDown(final TimeValue coolDown) { Args.notNull(coolDown, "Cool down time value cannot be null"); Args.positive(coolDown.getDuration(), "coolDown"); this.coolDown.set(coolDown); } /** * Returns the connection pool control for managing the maximum number of connections per route. * * @return the connection pool control instance */ protected ConnPoolControl getConnPerRoute() { return connPerRoute; } /** * Returns the map containing the last probe times for each HttpRoute. * * @return the map of HttpRoute to Instant representing the last probe times */ protected Map getLastRouteProbes() { return lastRouteProbes; } /** * Returns the map containing the last backoff times for each HttpRoute. * * @return the map of HttpRoute to Instant representing the last backoff times */ protected Map getLastRouteBackoffs() { return lastRouteBackoffs; } /** * Returns the cool down period between backoff and probe operations as an AtomicReference of TimeValue. * * @return the AtomicReference containing the cool down period */ protected AtomicReference getCoolDown() { return coolDown; } /** * Returns the backoff factor as an AtomicReference of Double. * * @return the AtomicReference containing the backoff factor */ protected AtomicReference getBackoffFactor() { return backoffFactor; } /** * Returns the cap on the maximum number of connections per route as an AtomicInteger. * * @return the AtomicInteger containing the cap value */ protected AtomicInteger getCap() { return cap; } /** * Returns the time interval between backoff and probe operations as an AtomicInteger. * * @return the AtomicInteger containing the time interval */ protected AtomicInteger getTimeInterval() { return timeInterval; } } ././@LongLink0100644 0000000 0000000 00000000151 00000250600 011606 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractHttpClientResponseHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractHttpClientResponseHandler.0100644 0000000 0000000 00000006416 00000250600 032557 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; /** * A generic {@link HttpClientResponseHandler} that works with the response entity * for successful (2xx) responses. If the response code was >= 300, the response * body is consumed and an {@link HttpResponseException} is thrown. *

* If this is used with * {@link org.apache.hc.client5.http.classic.HttpClient#execute( * org.apache.hc.core5.http.ClassicHttpRequest, HttpClientResponseHandler)}, * HttpClient may handle redirects (3xx responses) internally. *

* * @param the type of the value determined by the response. * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class AbstractHttpClientResponseHandler implements HttpClientResponseHandler { /** * Read the entity from the response body and pass it to the entity handler * method if the response was successful (a 2xx status code). If no response * body exists, this returns null. If the response was unsuccessful (>= 300 * status code), throws an {@link HttpResponseException}. */ @Override public T handleResponse(final ClassicHttpResponse response) throws IOException { final HttpEntity entity = response.getEntity(); if (response.getCode() >= HttpStatus.SC_REDIRECTION) { EntityUtils.consume(entity); throw new HttpResponseException(response.getCode(), response.getReasonPhrase()); } return entity == null ? null : handleEntity(entity); } /** * Handle the response entity and transform it into the actual response * object. */ public abstract T handleEntity(HttpEntity entity) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/BackoffStrategyExec.java0100644 0000000 0000000 00000011317 00000250600 030521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * that is responsible for execution of an {@link ConnectionBackoffStrategy}. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class BackoffStrategyExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(BackoffStrategyExec.class); private final ConnectionBackoffStrategy connectionBackoffStrategy; private final BackoffManager backoffManager; /** * Constructs a {@code BackoffStrategyExec} with the specified * {@link ConnectionBackoffStrategy} and {@link BackoffManager}. * * @param connectionBackoffStrategy the strategy to determine whether * to backoff based on the response or exception * @param backoffManager the manager responsible for applying backoff * and probing actions to the HTTP routes */ public BackoffStrategyExec( final ConnectionBackoffStrategy connectionBackoffStrategy, final BackoffManager backoffManager) { super(); Args.notNull(connectionBackoffStrategy, "Connection backoff strategy"); Args.notNull(backoffManager, "Backoff manager"); this.connectionBackoffStrategy = connectionBackoffStrategy; this.backoffManager = backoffManager; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpRoute route = scope.route; final ClassicHttpResponse response; try { response = chain.proceed(request, scope); } catch (final IOException | HttpException ex) { if (this.connectionBackoffStrategy.shouldBackoff(ex)) { if (LOG.isDebugEnabled()) { LOG.debug("Backing off route {} due to exception: {}", route, ex.getMessage()); } this.backoffManager.backOff(route); } throw ex; } if (this.connectionBackoffStrategy.shouldBackoff(response)) { if (LOG.isDebugEnabled()) { LOG.debug("Backing off route {} due to response status: {}", route, response.getCode()); } this.backoffManager.backOff(route); } else { if (LOG.isDebugEnabled()) { LOG.debug("Probing route: {}", route); } this.backoffManager.probe(route); } return response; } } ././@LongLink0100644 0000000 0000000 00000000146 00000250600 011612 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/BasicHttpClientResponseHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/BasicHttpClientResponseHandler.jav0100644 0000000 0000000 00000005456 00000250600 032541 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.io.entity.EntityUtils; /** * A {@link org.apache.hc.core5.http.io.HttpClientResponseHandler} that returns * the response body as a String for successful (2xx) responses. If the response * code was >= 300, the response body is consumed * and an {@link org.apache.hc.client5.http.HttpResponseException} is thrown. *

* If this is used with * {@link org.apache.hc.client5.http.classic.HttpClient#execute( * org.apache.hc.core5.http.ClassicHttpRequest, * org.apache.hc.core5.http.io.HttpClientResponseHandler)}, * HttpClient may handle redirects (3xx responses) internally. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicHttpClientResponseHandler extends AbstractHttpClientResponseHandler { /** * Returns the entity as a body as a String. */ @Override public String handleEntity(final HttpEntity entity) throws IOException { try { return EntityUtils.toString(entity); } catch (final ParseException ex) { throw new ClientProtocolException(ex); } } @Override public String handleResponse(final ClassicHttpResponse response) throws IOException { return super.handleResponse(response); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ClassicRequestCopier.java0100644 0000000 0000000 00000004675 00000250600 030743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.Iterator; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; /** * {@link ClassicHttpRequest} copier. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.io.support.ClassicRequestBuilder} */ @Deprecated public final class ClassicRequestCopier implements org.apache.hc.client5.http.impl.MessageCopier { /** * Default instance of {@link ClassicRequestCopier}. */ public static final ClassicRequestCopier INSTANCE = new ClassicRequestCopier(); @Override public ClassicHttpRequest copy(final ClassicHttpRequest original) { if (original == null) { return null; } final BasicClassicHttpRequest copy = new BasicClassicHttpRequest(original.getMethod(), null, original.getPath()); copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); copy.setVersion(original.getVersion()); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } copy.setEntity(original.getEntity()); return copy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/Clock.java0100644 0000000 0000000 00000002617 00000250600 025674 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; interface Clock { /** * Returns the current time, expressed as the number of * milliseconds since the epoch. * @return current time */ long getCurrentTime(); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableDelegate.java0100644 0000000 0000000 00000003017 00000250600 030160 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.io.CloseMode; /** * @since 5.5 */ @Internal @FunctionalInterface public interface CloseableDelegate { void close(Closeable closeable, CloseMode closeMode) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableHttpClient.java0100644 0000000 0000000 00000030235 00000250600 030526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Base implementation of {@link HttpClient} that also implements {@link ModalCloseable}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class CloseableHttpClient implements HttpClient, ModalCloseable { private static final Logger LOG = LoggerFactory.getLogger(CloseableHttpClient.class); protected abstract CloseableHttpResponse doExecute(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException; private static HttpHost determineTarget(final ClassicHttpRequest request) throws ClientProtocolException { try { return RoutingSupport.determineHost(request); } catch (final HttpException ex) { throw new ClientProtocolException(ex); } } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { return doExecute(target, request, context); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final ClassicHttpRequest request, final HttpContext context) throws IOException { Args.notNull(request, "HTTP request"); return doExecute(determineTarget(request), request, context); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final ClassicHttpRequest request) throws IOException { return doExecute(determineTarget(request), request, null); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final HttpHost target, final ClassicHttpRequest request) throws IOException { return doExecute(target, request, null); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute(final ClassicHttpRequest request, final HttpClientResponseHandler responseHandler) throws IOException { return execute(request, null, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param request the request to execute * @param responseHandler the response handler * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler) throws IOException { final HttpHost target = determineTarget(request); return execute(target, request, context, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute(final HttpHost target, final ClassicHttpRequest request, final HttpClientResponseHandler responseHandler) throws IOException { return execute(target, request, null, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler) throws IOException { Args.notNull(responseHandler, "Response handler"); try (final ClassicHttpResponse response = doExecute(target, request, context)) { try { final T result = responseHandler.handleResponse(response); final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); return result; } catch (final HttpException t) { // Try to salvage the underlying connection in case of a protocol exception final HttpEntity entity = response.getEntity(); try { EntityUtils.consume(entity); } catch (final Exception t2) { // Log this exception. The original exception is more // important and will be thrown to the caller. LOG.warn("Error consuming content after an exception.", t2); } throw new ClientProtocolException(t); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableHttpResponse.java0100644 0000000 0000000 00000016032 00000250600 031105 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.Iterator; import java.util.Locale; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Args; /** * Provided for backward compatibility with HttpClient 4.x. * * @since 4.3 */ public final class CloseableHttpResponse implements ClassicHttpResponse, ModalCloseable { private final ClassicHttpResponse response; private final CloseableDelegate closeableDelegate; /** * @since 5.4 */ @Internal public static CloseableHttpResponse adapt(final ClassicHttpResponse response) { if (response == null) { return null; } return response instanceof CloseableHttpResponse ? (CloseableHttpResponse) response : new CloseableHttpResponse(response); } /** * @since 5.5 */ @Internal public static CloseableHttpResponse create(final ClassicHttpResponse response, final CloseableDelegate closeableDelegate) { if (response == null) { return null; } return new CloseableHttpResponse(response, closeableDelegate); } CloseableHttpResponse(final ClassicHttpResponse response) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = null; } CloseableHttpResponse(final ClassicHttpResponse response, final CloseableDelegate closeableDelegate) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = closeableDelegate; } CloseableHttpResponse(final ClassicHttpResponse response, final ExecRuntime execRuntime) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = (closeable, closeMode) -> { try { if (closeMode == CloseMode.GRACEFUL) { response.close(); } execRuntime.disconnectEndpoint(); } finally { execRuntime.discardEndpoint(); } }; } @Override public int getCode() { return response.getCode(); } @Override public HttpEntity getEntity() { return response.getEntity(); } @Override public boolean containsHeader(final String name) { return response.containsHeader(name); } @Override public void setVersion(final ProtocolVersion version) { response.setVersion(version); } @Override public void setCode(final int code) { response.setCode(code); } @Override public String getReasonPhrase() { return response.getReasonPhrase(); } @Override public int countHeaders(final String name) { return response.countHeaders(name); } @Override public void setEntity(final HttpEntity entity) { response.setEntity(entity); } @Override public ProtocolVersion getVersion() { return response.getVersion(); } @Override public void setReasonPhrase(final String reason) { response.setReasonPhrase(reason); } @Override public Header[] getHeaders(final String name) { return response.getHeaders(name); } @Override public void addHeader(final Header header) { response.addHeader(header); } @Override public Locale getLocale() { return response.getLocale(); } @Override public void addHeader(final String name, final Object value) { response.addHeader(name, value); } @Override public void setLocale(final Locale loc) { response.setLocale(loc); } @Override public Header getHeader(final String name) throws ProtocolException { return response.getHeader(name); } @Override public void setHeader(final Header header) { response.setHeader(header); } @Override public Header getFirstHeader(final String name) { return response.getFirstHeader(name); } @Override public void setHeader(final String name, final Object value) { response.setHeader(name, value); } @Override public void setHeaders(final Header... headers) { response.setHeaders(headers); } @Override public boolean removeHeader(final Header header) { return response.removeHeader(header); } @Override public boolean removeHeaders(final String name) { return response.removeHeaders(name); } @Override public Header getLastHeader(final String name) { return response.getLastHeader(name); } @Override public Header[] getHeaders() { return response.getHeaders(); } @Override public Iterator
headerIterator() { return response.headerIterator(); } @Override public Iterator
headerIterator(final String name) { return response.headerIterator(name); } private void doClose(final CloseMode closeMode) throws IOException { if (closeableDelegate != null) { closeableDelegate.close(response, closeMode); } else { response.close(); } } @Override public void close(final CloseMode closeMode) { try { doClose(closeMode); } catch (final IOException ignore) { } } @Override public void close() throws IOException { doClose(CloseMode.GRACEFUL); } @Override public String toString() { return response.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ConnectExec.java0100644 0000000 0000000 00000034330 00000250600 027034 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteTracker; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.routing.BasicRouteDirector; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * that is responsible for establishing connection to the target * origin server as specified by the current connection route. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ConnectExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(ConnectExec.class); private final ConnectionReuseStrategy reuseStrategy; private final HttpProcessor proxyHttpProcessor; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthCacheKeeper authCacheKeeper; private final HttpRouteDirector routeDirector; public ConnectExec( final ConnectionReuseStrategy reuseStrategy, final HttpProcessor proxyHttpProcessor, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { Args.notNull(reuseStrategy, "Connection reuse strategy"); Args.notNull(proxyHttpProcessor, "Proxy HTTP processor"); Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.reuseStrategy = reuseStrategy; this.proxyHttpProcessor = proxyHttpProcessor; this.proxyAuthStrategy = proxyAuthStrategy; this.authenticator = new AuthenticationHandler(); this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(schemePortResolver); this.routeDirector = BasicRouteDirector.INSTANCE; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; if (!execRuntime.isEndpointAcquired()) { final Object userToken = context.getUserToken(); if (LOG.isDebugEnabled()) { LOG.debug("{} acquiring connection with route {}", exchangeId, route); } execRuntime.acquireEndpoint(exchangeId, route, userToken, context); } try { if (!execRuntime.isEndpointConnected()) { if (LOG.isDebugEnabled()) { LOG.debug("{} opening connection {}", exchangeId, route); } final RouteTracker tracker = new RouteTracker(route); int step; do { final HttpRoute fact = tracker.toRoute(); step = this.routeDirector.nextStep(route, fact); switch (step) { case HttpRouteDirector.CONNECT_TARGET: execRuntime.connectEndpoint(context); tracker.connectTarget(route.isSecure()); break; case HttpRouteDirector.CONNECT_PROXY: execRuntime.connectEndpoint(context); final HttpHost proxy = route.getProxyHost(); tracker.connectProxy(proxy, route.isSecure() && !route.isTunnelled()); break; case HttpRouteDirector.TUNNEL_TARGET: { final ClassicHttpResponse finalResponse = createTunnelToTarget( exchangeId, route, request, execRuntime, context); if (finalResponse != null) { return finalResponse; } if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel to target created.", exchangeId); } tracker.tunnelTarget(false); } break; case HttpRouteDirector.TUNNEL_PROXY: { // Proxy chains are not supported by HttpClient. // Fail fast instead of attempting an untested tunnel to an intermediate proxy. throw new HttpException("Proxy chains are not supported."); } case HttpRouteDirector.LAYER_PROTOCOL: execRuntime.upgradeTls(context); tracker.layerProtocol(route.isSecure()); break; case HttpRouteDirector.UNREACHABLE: throw new HttpException("Unable to establish route: " + "planned = " + route + "; current = " + fact); case HttpRouteDirector.COMPLETE: break; default: throw new IllegalStateException("Unknown step indicator " + step + " from RouteDirector."); } } while (step > HttpRouteDirector.COMPLETE); } final EndpointInfo endpointInfo = execRuntime.getEndpointInfo(); if (endpointInfo != null) { context.setSSLSession(endpointInfo.getSslSession()); } return chain.proceed(request, scope); } catch (final IOException | HttpException | RuntimeException ex) { execRuntime.discardEndpoint(); throw ex; } } /** * Creates a tunnel to the target server. * The connection must be established to the (last) proxy. * A CONNECT request for tunnelling through the proxy will * be created and sent, the response received and checked. * This method does not processChallenge the connection with * information about the tunnel, that is left to the caller. */ private ClassicHttpResponse createTunnelToTarget( final String exchangeId, final HttpRoute route, final HttpRequest request, final ExecRuntime execRuntime, final HttpClientContext context) throws HttpException, IOException { final RequestConfig config = context.getRequestConfigOrDefault(); final HttpHost target = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); final AuthExchange proxyAuthExchange = context.getAuthExchange(proxy); if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, context); } ClassicHttpResponse response = null; final String authority = target.toHostString(); final ClassicHttpRequest connect = new BasicClassicHttpRequest(Method.CONNECT, target, authority); connect.setVersion(HttpVersion.HTTP_1_1); this.proxyHttpProcessor.process(connect, null, context); while (response == null) { connect.removeHeaders(HttpHeaders.PROXY_AUTHORIZATION); this.authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, proxyAuthExchange, context); response = execRuntime.execute(exchangeId, connect, context); this.proxyHttpProcessor.process(response, response.getEntity(), context); final int status = response.getCode(); if (status < HttpStatus.SC_SUCCESS) { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } if (config.isAuthenticationEnabled()) { final boolean proxyAuthRequested = authenticator.isChallenged(proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } if (updated) { // Retry request if (this.reuseStrategy.keepAlive(connect, response, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection kept alive", exchangeId); } // Consume response content final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); } else { execRuntime.disconnectEndpoint(); } response = null; } } } } final int status = response.getCode(); if (status == HttpStatus.SC_OK) { context.setProtocolVersion(null); } else { final HttpEntity entity = response.getEntity(); if (entity != null) { response.setEntity(new ByteArrayEntity( EntityUtils.toByteArray(entity, 4096), ContentType.parseLenient(entity.getContentType()))); execRuntime.discardEndpoint(); } return response; } return null; } /** * Creates a tunnel to an intermediate proxy. * This method is not implemented in this class. * It just throws an exception here. */ private boolean createTunnelToProxy( final HttpRoute route, final int hop, final HttpClientContext context) throws HttpException { // Have a look at createTunnelToTarget and replicate the parts // you need in a custom derived class. If your proxies don't require // authentication, it is not too hard. But for the stock version of // HttpClient, we cannot make such simplifying assumptions and would // have to include proxy authentication code. The HttpComponents team // is currently not in a position to support rarely used code of this // complexity. Feel free to submit patches that refactor the code in // createTunnelToTarget to facilitate re-use for proxy tunnelling. throw new HttpException("Proxy chains are not supported."); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ContentCompressionExec.java0100644 0000000 0000000 00000015404 00000250600 031300 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.ArrayList; import java.util.EnumMap; import java.util.List; import java.util.Map; import java.util.function.UnaryOperator; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.entity.compress.ContentCodecRegistry; import org.apache.hc.client5.http.entity.compress.ContentCoding; import org.apache.hc.client5.http.impl.ContentCodingSupport; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.Args; /** * Request execution handler in the classic request execution chain * that is responsible for automatic response content decompression. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ContentCompressionExec implements ExecChainHandler { private final Header acceptEncoding; private final Lookup> decoderRegistry; private final int maxCodecListLen; public ContentCompressionExec( final List acceptEncoding, final Lookup> decoderRegistry, final int maxCodecListLen) { this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, Args.notEmpty(acceptEncoding, "Encoding list")); this.decoderRegistry = Args.notNull(decoderRegistry, "Decoder register"); this.maxCodecListLen = maxCodecListLen; } public ContentCompressionExec( final List acceptEncoding, final Lookup> decoderRegistry) { this(acceptEncoding, decoderRegistry, ContentCodingSupport.MAX_CODEC_LIST_LEN); } public ContentCompressionExec(final int maxCodecListLen) { final Map> decoderMap = new EnumMap<>(ContentCoding.class); for (final ContentCoding c : ContentCoding.values()) { final UnaryOperator d = ContentCodecRegistry.decoder(c); if (d != null) { decoderMap.put(c, d); } } final RegistryBuilder> builder = RegistryBuilder.create(); final List acceptList = new ArrayList<>(decoderMap.size() + 1); decoderMap.forEach((coding, decoder) -> { acceptList.add(coding.token()); builder.register(coding.token(), decoder); }); /* x-gzip alias */ if (decoderMap.containsKey(ContentCoding.GZIP)) { acceptList.add(ContentCoding.X_GZIP.token()); builder.register(ContentCoding.X_GZIP.token(), decoderMap.get(ContentCoding.GZIP)); } this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, acceptList); this.decoderRegistry = builder.build(); this.maxCodecListLen = maxCodecListLen; } public ContentCompressionExec() { this(ContentCodingSupport.MAX_CODEC_LIST_LEN); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpClientContext clientContext = scope.clientContext; final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); /* Signal support for Accept-Encoding transfer encodings. */ if (!request.containsHeader(HttpHeaders.ACCEPT_ENCODING) && requestConfig.isContentCompressionEnabled()) { request.addHeader(acceptEncoding); } final ClassicHttpResponse response = chain.proceed(request, scope); final HttpEntity entity = response.getEntity(); // entity can be null in case of 304 Not Modified, 204 No Content or similar // check for zero length entity. if (requestConfig.isContentCompressionEnabled() && entity != null && entity.getContentLength() != 0) { final List codecs = ContentCodingSupport.parseContentCodecs(entity); ContentCodingSupport.validate(codecs, maxCodecListLen); if (!codecs.isEmpty()) { for (int i = codecs.size() - 1; i >= 0; i--) { final String codec = codecs.get(i); final UnaryOperator decoder = decoderRegistry.lookup(codec); if (decoder != null) { response.setEntity(decoder.apply(response.getEntity())); } else { throw new HttpException("Unsupported Content-Encoding: " + codec); } } } } return response; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/DefaultBackoffStrategy.java0100644 0000000 0000000 00000004275 00000250600 031226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.net.ConnectException; import java.net.SocketTimeoutException; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; /** * This {@link ConnectionBackoffStrategy} backs off either for a raw * network socket or connection timeout or if the server explicitly * sends a 429 (Too Many Requests) or a 503 (Service Unavailable) response. * * @since 4.2 */ @Experimental public class DefaultBackoffStrategy implements ConnectionBackoffStrategy { @Override public boolean shouldBackoff(final Throwable t) { return t instanceof SocketTimeoutException || t instanceof ConnectException; } @Override public boolean shouldBackoff(final HttpResponse response) { return response.getCode() == HttpStatus.SC_TOO_MANY_REQUESTS || response.getCode() == HttpStatus.SC_SERVICE_UNAVAILABLE; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ExecChainElement.java0100644 0000000 0000000 00000004336 00000250600 030002 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; class ExecChainElement { private final ExecChainHandler handler; private final ExecChainElement next; ExecChainElement(final ExecChainHandler handler, final ExecChainElement next) { this.handler = handler; this.next = next; } public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope) throws IOException, HttpException { return handler.execute(request, scope, next != null ? next::execute : null); } @Override public String toString() { return "{" + "handler=" + handler.getClass() + ", next=" + (next != null ? next.handler.getClass() : "null") + '}'; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ExponentialBackoffManager.java0100644 0000000 0000000 00000007474 00000250600 031704 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * A backoff manager implementation that uses an exponential backoff algorithm to adjust the maximum * number of connections per HTTP route. The algorithm reduces the number of connections in response * to adverse events, such as connection failures, and gradually increases the number of connections * when the route is operating without issues. * *

This implementation is specifically designed for managing connections in an HTTP route context * and provides methods for probing and backing off connections based on the performance of the route. * *

The exponential backoff algorithm is primarily implemented in the {@code getBackedOffPoolSize} * method, which calculates the new connection pool size based on the current pool size, growth rate, * and the number of time intervals. * * @since 5.3 */ public class ExponentialBackoffManager extends AbstractBackoff { private static final Logger LOG = LoggerFactory.getLogger(ExponentialBackoffManager.class); /** * Constructs a new ExponentialBackoffManager with the specified connection pool control. * * @param connPerRoute the connection pool control to be used for managing connections * @throws IllegalArgumentException if connPerRoute is null */ public ExponentialBackoffManager(final ConnPoolControl connPerRoute) { super(connPerRoute); } /** * Calculates the new pool size after applying the exponential backoff algorithm. * The new pool size is calculated using the formula: floor(curr / (1 + growthRate) ^ t), * where curr is the current pool size, growthRate is the exponential growth rate, and t is the time interval. * * @param curr the current pool size * @return the new pool size after applying the backoff */ @Override protected int getBackedOffPoolSize(final int curr) { if (curr <= 1) { return 1; } final int t = getTimeInterval().incrementAndGet(); final int result = Math.max(1, (int) Math.floor(curr / Math.pow(1 + getBackoffFactor().get(), t))); if (LOG.isDebugEnabled()) { LOG.debug("curr={}, t={}, growthRate={}, result={}", curr, t, getBackoffFactor().get(), result); } return result; } @Override public void setBackoffFactor(final double rate) { Args.check(rate > 0.0, "Growth rate must be greater than 0.0"); this.getBackoffFactor().set(rate); } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionMetrics.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionMetrics.java0100644 0000000 0000000 00000011534 00000250600 032675 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.atomic.AtomicLong; /** * Collection of different counters used to gather metrics for {@link FutureRequestExecutionService}. */ public final class FutureRequestExecutionMetrics { private final AtomicLong activeConnections = new AtomicLong(); private final AtomicLong scheduledConnections = new AtomicLong(); private final DurationCounter successfulConnections = new DurationCounter(); private final DurationCounter failedConnections = new DurationCounter(); private final DurationCounter requests = new DurationCounter(); private final DurationCounter tasks = new DurationCounter(); FutureRequestExecutionMetrics() { } AtomicLong getActiveConnections() { return activeConnections; } AtomicLong getScheduledConnections() { return scheduledConnections; } DurationCounter getSuccessfulConnections() { return successfulConnections; } DurationCounter getFailedConnections() { return failedConnections; } DurationCounter getRequests() { return requests; } DurationCounter getTasks() { return tasks; } public long getActiveConnectionCount() { return activeConnections.get(); } public long getScheduledConnectionCount() { return scheduledConnections.get(); } public long getSuccessfulConnectionCount() { return successfulConnections.count(); } public long getSuccessfulConnectionAverageDuration() { return successfulConnections.averageDuration(); } public long getFailedConnectionCount() { return failedConnections.count(); } public long getFailedConnectionAverageDuration() { return failedConnections.averageDuration(); } public long getRequestCount() { return requests.count(); } public long getRequestAverageDuration() { return requests.averageDuration(); } public long getTaskCount() { return tasks.count(); } public long getTaskAverageDuration() { return tasks.averageDuration(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("[activeConnections=").append(activeConnections) .append(", scheduledConnections=").append(scheduledConnections) .append(", successfulConnections=").append(successfulConnections) .append(", failedConnections=").append(failedConnections) .append(", requests=").append(requests) .append(", tasks=").append(tasks) .append("]"); return builder.toString(); } /** * A counter that can measure duration and number of events. */ static class DurationCounter { private final AtomicLong count = new AtomicLong(0); private final AtomicLong cumulativeDuration = new AtomicLong(0); public void increment(final long startTime) { count.incrementAndGet(); cumulativeDuration.addAndGet(System.currentTimeMillis() - startTime); } public long count() { return count.get(); } public long averageDuration() { final long counter = count.get(); return counter > 0 ? cumulativeDuration.get() / counter : 0; } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("[count=").append(count()) .append(", averageDuration=").append(averageDuration()) .append("]"); return builder.toString(); } } }././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionService.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionService.java0100644 0000000 0000000 00000013127 00000250600 032667 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.FutureTask; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; /** * This class schedules message execution execution and processing * as {@link FutureTask}s with the provided {@link ExecutorService}. */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class FutureRequestExecutionService implements Closeable { private final HttpClient httpclient; private final ExecutorService executorService; private final FutureRequestExecutionMetrics metrics = new FutureRequestExecutionMetrics(); private final AtomicBoolean closed = new AtomicBoolean(false); /** * Create a new FutureRequestExecutionService. * * @param httpClient * you should tune your httpclient instance to match your needs. You should * align the max number of connections in the pool and the number of threads * in the executor; it doesn't make sense to have more threads than connections * and if you have less connections than threads, the threads will just end up * blocking on getting a connection from the pool. * @param executorService * any executorService will do here. E.g. * {@link Executors#newFixedThreadPool(int)} */ public FutureRequestExecutionService( final HttpClient httpClient, final ExecutorService executorService) { this.httpclient = httpClient; this.executorService = executorService; } /** * Schedule a request for execution. * * @param * * @param request * request to execute * @param HttpClientResponseHandler * handler that will process the response. * @return HttpAsyncClientFutureTask for the scheduled request. */ public FutureTask execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler HttpClientResponseHandler) { return execute(request, context, HttpClientResponseHandler, null); } /** * Schedule a request for execution. * * @param * * @param request * request to execute * @param context * optional context; use null if not needed. * @param HttpClientResponseHandler * handler that will process the response. * @param callback * callback handler that will be called when the request is scheduled, * started, completed, failed, or cancelled. * @return HttpAsyncClientFutureTask for the scheduled request. */ public FutureTask execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler HttpClientResponseHandler, final FutureCallback callback) { if (closed.get()) { throw new IllegalStateException("Close has been called on this httpclient instance."); } metrics.getScheduledConnections().incrementAndGet(); final HttpRequestTaskCallable callable = new HttpRequestTaskCallable<>( httpclient, request, context, HttpClientResponseHandler, callback, metrics); final HttpRequestFutureTask httpRequestFutureTask = new HttpRequestFutureTask<>( request, callable); executorService.execute(httpRequestFutureTask); return httpRequestFutureTask; } /** * @return metrics gathered for this instance. * @see FutureRequestExecutionMetrics */ public FutureRequestExecutionMetrics metrics() { return metrics; } @Override public void close() throws IOException { closed.set(true); executorService.shutdownNow(); if (httpclient instanceof Closeable) { ((Closeable) httpclient).close(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClientBuilder.java0100644 0000000 0000000 00000125157 00000250600 030233 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.net.ProxySelector; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedHashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.function.Function; import java.util.function.UnaryOperator; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.entity.InputStreamFactory; import org.apache.hc.client5.http.entity.compress.DecompressingEntity; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultConnectionKeepAliveStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.DefaultUserTokenHandler; import org.apache.hc.client5.http.impl.IdleConnectionEvictor; import org.apache.hc.client5.http.impl.NoopUserTokenHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.ScramSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.impl.routing.SystemDefaultRoutePlanner; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.RequestUpgrade; import org.apache.hc.client5.http.protocol.RequestValidateTrace; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestContent; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.apache.hc.core5.util.VersionInfo; /** * Builder for {@link CloseableHttpClient} instances. *

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #build()}. *

*
    *
  • http.proxyHost
    • *
  • http.proxyPort
    • *
  • https.proxyHost
    • *
  • https.proxyPort
    • *
  • http.nonProxyHosts
    • *
  • https.proxyUser
    • *
  • http.proxyUser
    • *
  • https.proxyPassword
    • *
  • http.proxyPassword
    • *
  • http.keepAlive
    • *
  • http.agent
    • *
*

* Please note that some settings used by this class can be mutually * exclusive and may not apply when building {@link CloseableHttpClient} * instances. *

* * @since 4.3 */ public class HttpClientBuilder { private static class RequestInterceptorEntry { enum Position { FIRST, LAST } final RequestInterceptorEntry.Position position; final HttpRequestInterceptor interceptor; private RequestInterceptorEntry(final RequestInterceptorEntry.Position position, final HttpRequestInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ResponseInterceptorEntry { enum Position { FIRST, LAST } final ResponseInterceptorEntry.Position position; final HttpResponseInterceptor interceptor; private ResponseInterceptorEntry(final ResponseInterceptorEntry.Position position, final HttpResponseInterceptor interceptor) { this.position = position; this.interceptor = interceptor; } } private static class ExecInterceptorEntry { enum Position { BEFORE, AFTER, REPLACE, FIRST, LAST } final ExecInterceptorEntry.Position position; final String name; final ExecChainHandler interceptor; final String existing; private ExecInterceptorEntry( final ExecInterceptorEntry.Position position, final String name, final ExecChainHandler interceptor, final String existing) { this.position = position; this.name = name; this.interceptor = interceptor; this.existing = existing; } } private HttpRequestExecutor requestExec; private HttpClientConnectionManager connManager; private boolean connManagerShared; private SchemePortResolver schemePortResolver; private ConnectionReuseStrategy reuseStrategy; private ConnectionKeepAliveStrategy keepAliveStrategy; private AuthenticationStrategy targetAuthStrategy; private AuthenticationStrategy proxyAuthStrategy; private UserTokenHandler userTokenHandler; private LinkedList requestInterceptors; private LinkedList responseInterceptors; private LinkedList execInterceptors; private HttpRequestRetryStrategy retryStrategy; private HttpRoutePlanner routePlanner; private RedirectStrategy redirectStrategy; private ConnectionBackoffStrategy connectionBackoffStrategy; private BackoffManager backoffManager; private Lookup authSchemeRegistry; private Lookup cookieSpecRegistry; private LinkedHashMap contentDecoderMap; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private String userAgent; private HttpHost proxy; private Collection defaultHeaders; private RequestConfig defaultRequestConfig; private boolean evictExpiredConnections; private boolean evictIdleConnections; private TimeValue maxIdleTime; private boolean systemProperties; private boolean redirectHandlingDisabled; private boolean automaticRetriesDisabled; private boolean contentCompressionDisabled; private boolean cookieManagementDisabled; private boolean authCachingDisabled; private boolean connectionStateDisabled; private boolean defaultUserAgentDisabled; private ProxySelector proxySelector; private List closeables; public static HttpClientBuilder create() { return new HttpClientBuilder(); } protected HttpClientBuilder() { super(); } /** * Sets {@link HttpRequestExecutor} instance. * * @return this instance. */ public final HttpClientBuilder setRequestExecutor(final HttpRequestExecutor requestExec) { this.requestExec = requestExec; return this; } /** * Sets {@link HttpClientConnectionManager} instance. * * @return this instance. */ public final HttpClientBuilder setConnectionManager( final HttpClientConnectionManager connManager) { this.connManager = connManager; return this; } /** * Defines the connection manager is to be shared by multiple * client instances. *

* If the connection manager is shared its life-cycle is expected * to be managed by the caller and it will not be shut down * if the client is closed. *

* * @param shared defines whether or not the connection manager can be shared * by multiple clients. * @return this instance. * * @since 4.4 */ public final HttpClientBuilder setConnectionManagerShared( final boolean shared) { this.connManagerShared = shared; return this; } /** * Sets {@link ConnectionReuseStrategy} instance. * * @return this instance. */ public final HttpClientBuilder setConnectionReuseStrategy( final ConnectionReuseStrategy reuseStrategy) { this.reuseStrategy = reuseStrategy; return this; } /** * Sets {@link ConnectionKeepAliveStrategy} instance. * * @return this instance. */ public final HttpClientBuilder setKeepAliveStrategy( final ConnectionKeepAliveStrategy keepAliveStrategy) { this.keepAliveStrategy = keepAliveStrategy; return this; } /** * Sets {@link AuthenticationStrategy} instance for target * host authentication. * * @return this instance. */ public final HttpClientBuilder setTargetAuthenticationStrategy( final AuthenticationStrategy targetAuthStrategy) { this.targetAuthStrategy = targetAuthStrategy; return this; } /** * Sets {@link AuthenticationStrategy} instance for proxy * authentication. * * @return this instance. */ public final HttpClientBuilder setProxyAuthenticationStrategy( final AuthenticationStrategy proxyAuthStrategy) { this.proxyAuthStrategy = proxyAuthStrategy; return this; } /** * Sets {@link UserTokenHandler} instance. *

* Please note this value can be overridden by the {@link #disableConnectionState()} * method. *

* * @return this instance. */ public final HttpClientBuilder setUserTokenHandler(final UserTokenHandler userTokenHandler) { this.userTokenHandler = userTokenHandler; return this; } /** * Disables connection state tracking. * * @return this instance. */ public final HttpClientBuilder disableConnectionState() { connectionStateDisabled = true; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final HttpClientBuilder setSchemePortResolver( final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@code User-Agent} value. * * @return this instance. */ public final HttpClientBuilder setUserAgent(final String userAgent) { this.userAgent = userAgent; return this; } /** * Sets default request header values. * * @return this instance. */ public final HttpClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.defaultHeaders = defaultHeaders; return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final HttpClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final HttpClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (responseInterceptors == null) { responseInterceptors = new LinkedList<>(); } responseInterceptors.add(new ResponseInterceptorEntry(ResponseInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Adds this protocol interceptor to the head of the protocol processing list. * * @return this instance. */ public final HttpClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.FIRST, interceptor)); return this; } /** * Adds this protocol interceptor to the tail of the protocol processing list. * * @return this instance. */ public final HttpClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { Args.notNull(interceptor, "Interceptor"); if (requestInterceptors == null) { requestInterceptors = new LinkedList<>(); } requestInterceptors.add(new RequestInterceptorEntry(RequestInterceptorEntry.Position.LAST, interceptor)); return this; } /** * Adds this execution interceptor before an existing interceptor. * * @return this instance. */ public final HttpClientBuilder addExecInterceptorBefore(final String existing, final String name, final ExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.BEFORE, name, interceptor, existing)); return this; } /** * Adds this execution interceptor after interceptor with the given name. * * @return this instance. */ public final HttpClientBuilder addExecInterceptorAfter(final String existing, final String name, final ExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notBlank(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.AFTER, name, interceptor, existing)); return this; } /** * Replace an existing interceptor with the given name with new interceptor. * * @return this instance. */ public final HttpClientBuilder replaceExecInterceptor(final String existing, final ExecChainHandler interceptor) { Args.notBlank(existing, "Existing"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.REPLACE, existing, interceptor, existing)); return this; } /** * Add an interceptor to the head of the processing list. * * @return this instance. */ public final HttpClientBuilder addExecInterceptorFirst(final String name, final ExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.FIRST, name, interceptor, null)); return this; } /** * Add an interceptor to the tail of the processing list. * * @return this instance. */ public final HttpClientBuilder addExecInterceptorLast(final String name, final ExecChainHandler interceptor) { Args.notNull(name, "Name"); Args.notNull(interceptor, "Interceptor"); if (execInterceptors == null) { execInterceptors = new LinkedList<>(); } execInterceptors.add(new ExecInterceptorEntry(ExecInterceptorEntry.Position.LAST, name, interceptor, null)); return this; } /** * Disables state (cookie) management. * * @return this instance. */ public final HttpClientBuilder disableCookieManagement() { this.cookieManagementDisabled = true; return this; } /** * Disables automatic content decompression. * * @return this instance. */ public final HttpClientBuilder disableContentCompression() { contentCompressionDisabled = true; return this; } /** * Disables authentication scheme caching. * * @return this instance. */ public final HttpClientBuilder disableAuthCaching() { this.authCachingDisabled = true; return this; } /** * Sets {@link HttpRequestRetryStrategy} instance. *

* Please note this value can be overridden by the {@link #disableAutomaticRetries()} * method. *

* * @return this instance. */ public final HttpClientBuilder setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) { this.retryStrategy = retryStrategy; return this; } /** * Disables automatic request recovery and re-execution. * * @return this instance. */ public final HttpClientBuilder disableAutomaticRetries() { automaticRetriesDisabled = true; return this; } /** * Sets default proxy value. *

* Please note this value can be overridden by the {@link #setRoutePlanner( * org.apache.hc.client5.http.routing.HttpRoutePlanner)} method. *

* * @return this instance. */ public final HttpClientBuilder setProxy(final HttpHost proxy) { this.proxy = proxy; return this; } /** * Sets {@link HttpRoutePlanner} instance. */ public final HttpClientBuilder setRoutePlanner(final HttpRoutePlanner routePlanner) { this.routePlanner = routePlanner; return this; } /** * Sets {@link RedirectStrategy} instance. *

* Please note this value can be overridden by the {@link #disableRedirectHandling()} * method. *

* * @return this instance. */ public final HttpClientBuilder setRedirectStrategy(final RedirectStrategy redirectStrategy) { this.redirectStrategy = redirectStrategy; return this; } /** * Disables automatic redirect handling. * * @return this instance. */ public final HttpClientBuilder disableRedirectHandling() { redirectHandlingDisabled = true; return this; } /** * Sets {@link ConnectionBackoffStrategy} instance. * * @return this instance. */ public final HttpClientBuilder setConnectionBackoffStrategy( final ConnectionBackoffStrategy connectionBackoffStrategy) { this.connectionBackoffStrategy = connectionBackoffStrategy; return this; } /** * Sets {@link BackoffManager} instance. * * @return this instance. */ public final HttpClientBuilder setBackoffManager(final BackoffManager backoffManager) { this.backoffManager = backoffManager; return this; } /** * Sets default {@link CookieStore} instance which will be used for * request execution if not explicitly set in the client execution context. * * @return this instance. */ public final HttpClientBuilder setDefaultCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } /** * Sets default {@link CredentialsProvider} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpClientBuilder setDefaultCredentialsProvider( final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; return this; } /** * Sets default {@link org.apache.hc.client5.http.auth.AuthScheme} registry which will * be used for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpClientBuilder setDefaultAuthSchemeRegistry( final Lookup authSchemeRegistry) { this.authSchemeRegistry = authSchemeRegistry; return this; } /** * Sets default {@link org.apache.hc.client5.http.cookie.CookieSpec} registry which will * be used for request execution if not explicitly set in the client execution * context. * * @return this instance. * @see CookieSpecSupport */ public final HttpClientBuilder setDefaultCookieSpecRegistry( final Lookup cookieSpecRegistry) { this.cookieSpecRegistry = cookieSpecRegistry; return this; } /** * Sets a map of {@link org.apache.hc.client5.http.entity.InputStreamFactory}s * to be used for automatic content decompression. * * @return this instance. */ public final HttpClientBuilder setContentDecoderRegistry( final LinkedHashMap contentDecoderMap) { this.contentDecoderMap = contentDecoderMap; return this; } /** * Sets default {@link RequestConfig} instance which will be used * for request execution if not explicitly set in the client execution * context. * * @return this instance. */ public final HttpClientBuilder setDefaultRequestConfig(final RequestConfig config) { this.defaultRequestConfig = config; return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final HttpClientBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * Makes this instance of HttpClient proactively evict expired connections from the * connection pool using a background thread. *

* One MUST explicitly close HttpClient with {@link CloseableHttpClient#close()} in order * to stop and release the background thread. *

*

* Please note this method has no effect if the instance of HttpClient is configured to * use a shared connection manager. *

* * @return this instance. * @see #setConnectionManagerShared(boolean) * @see ConnPoolControl#closeExpired() * * @since 4.4 */ public final HttpClientBuilder evictExpiredConnections() { evictExpiredConnections = true; return this; } /** * Makes this instance of HttpClient proactively evict idle connections from the * connection pool using a background thread. *

* One MUST explicitly close HttpClient with {@link CloseableHttpClient#close()} in order * to stop and release the background thread. *

*

* Please note this method has no effect if the instance of HttpClient is configured to * use a shared connection manager. *

* * @see #setConnectionManagerShared(boolean) * @see ConnPoolControl#closeIdle(TimeValue) * * @param maxIdleTime maximum time persistent connections can stay idle while kept alive * in the connection pool. Connections whose inactivity period exceeds this value will * get closed and evicted from the pool. * * @return this instance. * @since 4.4 */ public final HttpClientBuilder evictIdleConnections(final TimeValue maxIdleTime) { this.evictIdleConnections = true; this.maxIdleTime = Args.notNull(maxIdleTime, "Max idle time"); return this; } /** * Disables the default user agent set by this builder if none has been provided by the user. * * @return this instance. * @since 4.5.7 */ public final HttpClientBuilder disableDefaultUserAgent() { this.defaultUserAgentDisabled = true; return this; } /** * Sets the {@link ProxySelector} that will be used to select the proxies * to be used for establishing HTTP connections. If a non-null proxy selector is set, * it will take precedence over the proxy settings configured in the client. * * @param proxySelector the {@link ProxySelector} to be used, or null to use * the default system proxy selector. * @return this instance. */ public final HttpClientBuilder setProxySelector(final ProxySelector proxySelector) { this.proxySelector = proxySelector; return this; } /** * Request exec chain customization and extension. *

* For internal use. *

*/ @Internal protected void customizeExecChain(final NamedElementChain execChainDefinition) { } /** * Adds to the list of {@link Closeable} resources to be managed by the client. *

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } @Internal public HttpClientConnectionManager getConnManager() { return connManager; } @Internal protected Function contextAdaptor() { return HttpClientContext::castOrCreate; } public CloseableHttpClient build() { // Create main request executor // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version HttpRequestExecutor requestExecCopy = this.requestExec; if (requestExecCopy == null) { requestExecCopy = new HttpRequestExecutor(); } HttpClientConnectionManager connManagerCopy = this.connManager; if (connManagerCopy == null) { final PoolingHttpClientConnectionManagerBuilder connectionManagerBuilder = PoolingHttpClientConnectionManagerBuilder.create(); if (systemProperties) { connectionManagerBuilder.useSystemProperties(); } connManagerCopy = connectionManagerBuilder.build(); } ConnectionReuseStrategy reuseStrategyCopy = this.reuseStrategy; if (reuseStrategyCopy == null) { if (systemProperties) { final String s = System.getProperty("http.keepAlive", "true"); if ("true".equalsIgnoreCase(s)) { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } else { reuseStrategyCopy = (request, response, context) -> false; } } else { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } } ConnectionKeepAliveStrategy keepAliveStrategyCopy = this.keepAliveStrategy; if (keepAliveStrategyCopy == null) { keepAliveStrategyCopy = DefaultConnectionKeepAliveStrategy.INSTANCE; } AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } UserTokenHandler userTokenHandlerCopy = this.userTokenHandler; if (userTokenHandlerCopy == null) { if (!connectionStateDisabled) { userTokenHandlerCopy = DefaultUserTokenHandler.INSTANCE; } else { userTokenHandlerCopy = NoopUserTokenHandler.INSTANCE; } } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = System.getProperty("http.agent"); } if (userAgentCopy == null && !defaultUserAgentDisabled) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } b.addAll( new RequestTargetHost(), new RequestValidateTrace(), new RequestDefaultHeaders(defaultHeaders), new RequestContent(), new RequestClientConnControl(), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new RequestUpgrade()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new MainClientExec(connManagerCopy, httpProcessor, reuseStrategyCopy, keepAliveStrategyCopy, userTokenHandlerCopy), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new ConnectExec( reuseStrategyCopy, new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); execChainDefinition.addFirst( new ProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); if (!contentCompressionDisabled) { // Custom decoder map supplied by the caller if (contentDecoderMap != null) { final List encodings = new ArrayList<>(contentDecoderMap.size()); final RegistryBuilder> b2 = RegistryBuilder.create(); for (final Map.Entry entry : contentDecoderMap.entrySet()) { final String token = entry.getKey(); final InputStreamFactory inputStreamFactory = entry.getValue(); encodings.add(token); b2.register(token, httpEntity -> new DecompressingEntity( httpEntity, inputStreamFactory::create)); } final Registry> decoderRegistry = b2.build(); execChainDefinition.addFirst( new ContentCompressionExec(encodings, decoderRegistry), ChainElement.COMPRESS.name()); } else { // Use the default decoders from ContentCodecRegistry execChainDefinition.addFirst( new ContentCompressionExec(), ChainElement.COMPRESS.name()); } } // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new HttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } if (proxy != null) { routePlannerCopy = new DefaultProxyRoutePlanner(proxy, schemePortResolverCopy); } else if (this.proxySelector != null) { routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, this.proxySelector); } else if (systemProperties) { final ProxySelector defaultProxySelector = AccessController.doPrivileged((PrivilegedAction) ProxySelector::getDefault); routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, defaultProxySelector); } else { routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new RedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } // Optionally, add connection back-off executor if (this.backoffManager != null && this.connectionBackoffStrategy != null) { execChainDefinition.addFirst(new BackoffStrategyExec(this.connectionBackoffStrategy, this.backoffManager), ChainElement.BACK_OFF.name()); } if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after MainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); ExecChainElement execChain = null; while (current != null) { execChain = new ExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .register(StandardAuthScheme.SCRAM_SHA_256, ScramSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null && !this.cookieManagementDisabled) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore defaultCookieStore = this.cookieStore; if (defaultCookieStore == null) { defaultCookieStore = new BasicCookieStore(); } CredentialsProvider defaultCredentialsProvider = this.credentialsProvider; if (defaultCredentialsProvider == null) { if (systemProperties) { defaultCredentialsProvider = new SystemDefaultCredentialsProvider(); } else { defaultCredentialsProvider = new BasicCredentialsProvider(); } } List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (!this.connManagerShared) { if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictExpiredConnections || evictIdleConnections) { if (connManagerCopy instanceof ConnPoolControl) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl) connManagerCopy, null, evictIdleConnections ? maxIdleTime : null); closeablesCopy.add(() -> { connectionEvictor.shutdown(); try { connectionEvictor.awaitTermination(Timeout.ofSeconds(1)); } catch (final InterruptedException interrupted) { Thread.currentThread().interrupt(); } }); connectionEvictor.start(); } } closeablesCopy.add(connManagerCopy); } return new InternalHttpClient( connManagerCopy, requestExecCopy, execChain, routePlannerCopy, cookieSpecRegistryCopy, authSchemeRegistryCopy, defaultCookieStore, defaultCredentialsProvider, contextAdaptor(), defaultRequestConfig != null ? defaultRequestConfig : RequestConfig.DEFAULT, closeablesCopy); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClients.java0100644 0000000 0000000 00000005371 00000250600 027102 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionManager; /** * Factory methods for {@link CloseableHttpClient} instances. * * @since 4.3 */ public final class HttpClients { private HttpClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpClient} instances. */ public static HttpClientBuilder custom() { return HttpClientBuilder.create(); } /** * Creates {@link CloseableHttpClient} instance with default * configuration. */ public static CloseableHttpClient createDefault() { return HttpClientBuilder.create().build(); } /** * Creates {@link CloseableHttpClient} instance with default * configuration based on system properties. */ public static CloseableHttpClient createSystem() { return HttpClientBuilder.create().useSystemProperties().build(); } /** * Creates {@link CloseableHttpClient} instance that implements * the most basic HTTP protocol support. */ public static MinimalHttpClient createMinimal() { return new MinimalHttpClient(new PoolingHttpClientConnectionManager()); } /** * Creates {@link CloseableHttpClient} instance that implements * the most basic HTTP protocol support. */ public static MinimalHttpClient createMinimal(final HttpClientConnectionManager connManager) { return new MinimalHttpClient(connManager); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestFutureTask.java0100644 0000000 0000000 00000006434 00000250600 031150 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.FutureTask; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.http.ClassicHttpRequest; final class HttpRequestFutureTask extends FutureTask { private final ClassicHttpRequest request; private final HttpRequestTaskCallable callable; HttpRequestFutureTask( final ClassicHttpRequest request, final HttpRequestTaskCallable httpCallable) { super(httpCallable); this.request = request; this.callable = httpCallable; } @Override public boolean cancel(final boolean mayInterruptIfRunning) { callable.cancel(); if (mayInterruptIfRunning && request instanceof Cancellable) { ((Cancellable) request).cancel(); } return super.cancel(mayInterruptIfRunning); } /** * @return the time in millis the task was scheduled. */ public long scheduledTime() { return callable.getScheduled(); } /** * @return the time in millis the task was started. */ public long startedTime() { return callable.getStarted(); } /** * @return the time in millis the task was finished/cancelled. */ public long endedTime() { if (isDone()) { return callable.getEnded(); } throw new IllegalStateException("Task is not done yet"); } /** * @return the time in millis it took to make the request (excluding the time it was * scheduled to be executed). */ public long requestDuration() { if (isDone()) { return endedTime() - startedTime(); } throw new IllegalStateException("Task is not done yet"); } /** * @return the time in millis it took to execute the task from the moment it was scheduled. */ public long taskDuration() { if (isDone()) { return endedTime() - scheduledTime(); } throw new IllegalStateException("Task is not done yet"); } @Override public String toString() { return request.toString(); } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestRetryExec.java0100644 0000000 0000000 00000020077 00000250600 030764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChain.Scope; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.NoHttpResponseException; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request executor in the request execution chain that is responsible for * making a decision whether a request that failed due to an I/O exception * or received a specific response from the target server should * be re-executed. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

*

* If this handler is active, pay particular attention to the placement * of other handlers within the handler chain relative to the retry handler. * Use {@link ChainElement#RETRY} as name when referring to this handler. *

*

* If a custom handler is placed before the retry handler, the handler will * see the initial request and the final outcome after the last retry. Elapsed time * will account for any delays imposed by the retry handler. *

* *

* A custom handler which is placed after the retry handler will be invoked for * each individual retry. Elapsed time will measure each individual http request, * without the delay imposed by the retry handler. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public class HttpRequestRetryExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(HttpRequestRetryExec.class); private final HttpRequestRetryStrategy retryStrategy; public HttpRequestRetryExec( final HttpRequestRetryStrategy retryStrategy) { Args.notNull(retryStrategy, "retryStrategy"); this.retryStrategy = retryStrategy; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "request"); Args.notNull(scope, "scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpHost target = route.getTargetHost(); final HttpClientContext context = scope.clientContext; ClassicHttpRequest currentRequest = request; for (int execCount = 1;; execCount++) { try { final ClassicHttpResponse response = chain.proceed(currentRequest, scope); try { final HttpEntity entity = request.getEntity(); if (entity != null && !entity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } return response; } if (retryStrategy.retryRequest(response, execCount, context)) { response.close(); final TimeValue delay = retryStrategy.getRetryInterval(response, execCount, context); if (LOG.isInfoEnabled()) { LOG.info("{} {} responded with status {}; " + "request will be automatically re-executed in {} (exec count {})", exchangeId, target, response.getCode(), delay, execCount + 1); } pause(delay); currentRequest = ClassicRequestBuilder.copy(scope.originalRequest).build(); } else { return response; } } catch (final RuntimeException ex) { response.close(); throw ex; } } catch (final IOException ex) { if (scope.execRuntime.isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } throw ex; } if (retryStrategy.retryRequest(request, ex, execCount, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} {}", exchangeId, ex.getMessage(), ex); } final TimeValue delay = retryStrategy.getRetryInterval(request, ex, execCount, context); if (LOG.isInfoEnabled()) { LOG.info("{} recoverable I/O exception ({}) caught when sending request to {};" + "request will be automatically re-executed in {} (exec count {})", exchangeId, ex.getClass().getName(), target, delay, execCount + 1); } pause(delay); currentRequest = ClassicRequestBuilder.copy(scope.originalRequest).build(); continue; } if (ex instanceof NoHttpResponseException) { final NoHttpResponseException updatedex = new NoHttpResponseException( target.toHostString() + " failed to respond"); updatedex.setStackTrace(ex.getStackTrace()); throw updatedex; } throw ex; } } } private static void pause(final TimeValue delay) throws InterruptedIOException { if (TimeValue.isPositive(delay)) { try { delay.sleep(); } catch (final InterruptedException e) { Thread.currentThread().interrupt(); throw new InterruptedIOException(); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestTaskCallable.java0100644 0000000 0000000 00000010425 00000250600 031370 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.Callable; import java.util.concurrent.CancellationException; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; class HttpRequestTaskCallable implements Callable { private final ClassicHttpRequest request; private final HttpClient httpclient; private final AtomicBoolean cancelled = new AtomicBoolean(false); private final long scheduled = System.currentTimeMillis(); private long started = -1; private long ended = -1; private final HttpContext context; private final HttpClientResponseHandler responseHandler; private final FutureCallback callback; private final FutureRequestExecutionMetrics metrics; HttpRequestTaskCallable( final HttpClient httpClient, final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler, final FutureCallback callback, final FutureRequestExecutionMetrics metrics) { this.httpclient = httpClient; this.responseHandler = responseHandler; this.request = request; this.context = context; this.callback = callback; this.metrics = metrics; } public long getScheduled() { return scheduled; } public long getStarted() { return started; } public long getEnded() { return ended; } @Override public V call() throws Exception { if (!cancelled.get()) { try { metrics.getActiveConnections().incrementAndGet(); started = System.currentTimeMillis(); try { metrics.getScheduledConnections().decrementAndGet(); final V result = httpclient.execute(request, context, responseHandler); ended = System.currentTimeMillis(); metrics.getSuccessfulConnections().increment(started); if (callback != null) { callback.completed(result); } return result; } catch (final Exception e) { metrics.getFailedConnections().increment(started); ended = System.currentTimeMillis(); if (callback != null) { callback.failed(e); } throw e; } } finally { metrics.getRequests().increment(started); metrics.getTasks().increment(started); metrics.getActiveConnections().decrementAndGet(); } } throw new CancellationException(); } public void cancel() { cancelled.set(true); if (callback != null) { callback.cancelled(); } } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/InternalExecRuntime.java0100644 0000000 0000000 00000027402 00000250600 030565 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionRequestTimeoutException; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpResponseInformationCallback; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalExecRuntime implements ExecRuntime, Cancellable { private final Logger log; private final HttpClientConnectionManager manager; private final HttpRequestExecutor requestExecutor; private final CancellableDependency cancellableDependency; private final AtomicReference endpointRef; private volatile boolean reusable; private volatile Object state; private volatile TimeValue validDuration; InternalExecRuntime( final Logger log, final HttpClientConnectionManager manager, final HttpRequestExecutor requestExecutor, final CancellableDependency cancellableDependency) { super(); this.log = log; this.manager = manager; this.requestExecutor = requestExecutor; this.cancellableDependency = cancellableDependency; this.endpointRef = new AtomicReference<>(); this.validDuration = TimeValue.NEG_ONE_MILLISECOND; } @Override public boolean isExecutionAborted() { return cancellableDependency != null && cancellableDependency.isCancelled(); } @Override public boolean isEndpointAcquired() { return endpointRef.get() != null; } @Override public void acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context) throws IOException { Args.notNull(route, "Route"); if (endpointRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectionRequestTimeout); } final LeaseRequest connRequest = manager.lease(id, route, connectionRequestTimeout, object); state = object; if (cancellableDependency != null) { cancellableDependency.setDependency(connRequest); } try { final ConnectionEndpoint connectionEndpoint = connRequest.get(connectionRequestTimeout); endpointRef.set(connectionEndpoint); reusable = connectionEndpoint.isConnected(); if (cancellableDependency != null) { cancellableDependency.setDependency(this); } if (log.isDebugEnabled()) { log.debug("{} acquired endpoint {}", id, ConnPoolSupport.getId(connectionEndpoint)); } } catch (final TimeoutException ex) { connRequest.cancel(); throw new ConnectionRequestTimeoutException(ex.getMessage()); } catch (final InterruptedException interrupted) { connRequest.cancel(); Thread.currentThread().interrupt(); throw new RequestFailedException("Request aborted", interrupted); } catch (final ExecutionException ex) { connRequest.cancel(); Throwable cause = ex.getCause(); if (cause == null) { cause = ex; } throw new RequestFailedException("Request execution failed", cause); } } else { throw new IllegalStateException("Endpoint already acquired"); } } ConnectionEndpoint ensureValid() { final ConnectionEndpoint endpoint = endpointRef.get(); if (endpoint == null) { throw new IllegalStateException("Endpoint not acquired / already released"); } return endpoint; } @Override public boolean isEndpointConnected() { final ConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } private void connectEndpoint(final ConnectionEndpoint endpoint, final HttpClientContext context) throws IOException { if (isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } manager.connect(endpoint, connectTimeout, context); if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } } @Override public void connectEndpoint(final HttpClientContext context) throws IOException { final ConnectionEndpoint endpoint = ensureValid(); if (!endpoint.isConnected()) { connectEndpoint(endpoint, context); } } @Override public void disconnectEndpoint() throws IOException { final ConnectionEndpoint endpoint = endpointRef.get(); if (endpoint != null) { endpoint.close(); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } } @Override public void upgradeTls(final HttpClientContext context) throws IOException { final ConnectionEndpoint endpoint = ensureValid(); if (log.isDebugEnabled()) { log.debug("{} upgrading endpoint", ConnPoolSupport.getId(endpoint)); } manager.upgrade(endpoint, context); } @Override public EndpointInfo getEndpointInfo() { final ConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null ? endpoint.getInfo() : null; } @Override public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final HttpClientContext context) throws IOException, HttpException { return execute(id, request, null, context); } @Override public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final HttpResponseInformationCallback informationCallback, final HttpClientContext context) throws IOException, HttpException { final ConnectionEndpoint endpoint = ensureValid(); if (!endpoint.isConnected()) { connectEndpoint(endpoint, context); } if (isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); if (responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } return endpoint.execute( id, request, (r, conn, c) -> requestExecutor.execute(r, conn, informationCallback, c), context); } @Override public boolean isConnectionReusable() { return reusable; } @Override public void markConnectionReusable(final Object state, final TimeValue validDuration) { this.reusable = true; this.state = state; this.validDuration = validDuration; } @Override public void markConnectionNonReusable() { reusable = false; } private void discardEndpoint(final ConnectionEndpoint endpoint) { try { endpoint.close(CloseMode.IMMEDIATE); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } finally { if (log.isDebugEnabled()) { log.debug("{} discarding endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, null, TimeValue.ZERO_MILLISECONDS); } } @Override public void releaseEndpoint() { final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { if (reusable) { if (log.isDebugEnabled()) { log.debug("{} releasing valid endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, state, validDuration); } else { discardEndpoint(endpoint); } } } @Override public void discardEndpoint() { final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } } @Override public boolean cancel() { final boolean alreadyReleased = endpointRef.get() == null; final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { if (log.isDebugEnabled()) { log.debug("{} cancel", ConnPoolSupport.getId(endpoint)); } discardEndpoint(endpoint); } return !alreadyReleased; } @Override public ExecRuntime fork(final CancellableDependency cancellableDependency) { return new InternalExecRuntime(log, manager, requestExecutor, cancellableDependency); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/InternalHttpClient.java0100644 0000000 0000000 00000022434 00000250600 030413 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import java.util.List; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.function.Function; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal implementation of {@link CloseableHttpClient}. *

* Concurrent message exchanges executed by this client will get assigned to * separate connections leased from the connection pool. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) @Internal class InternalHttpClient extends CloseableHttpClient implements Configurable { private static final Logger LOG = LoggerFactory.getLogger(InternalHttpClient.class); private final HttpClientConnectionManager connManager; private final HttpRequestExecutor requestExecutor; private final ExecChainElement execChain; private final HttpRoutePlanner routePlanner; private final Lookup cookieSpecRegistry; private final Lookup authSchemeRegistry; private final CookieStore cookieStore; private final CredentialsProvider credentialsProvider; private final Function contextAdaptor; private final RequestConfig defaultConfig; private final ConcurrentLinkedQueue closeables; public InternalHttpClient( final HttpClientConnectionManager connManager, final HttpRequestExecutor requestExecutor, final ExecChainElement execChain, final HttpRoutePlanner routePlanner, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final Function contextAdaptor, final RequestConfig defaultConfig, final List closeables) { super(); this.connManager = Args.notNull(connManager, "Connection manager"); this.requestExecutor = Args.notNull(requestExecutor, "Request executor"); this.execChain = Args.notNull(execChain, "Execution chain"); this.routePlanner = Args.notNull(routePlanner, "Route planner"); this.cookieSpecRegistry = cookieSpecRegistry; this.authSchemeRegistry = authSchemeRegistry; this.cookieStore = cookieStore; this.credentialsProvider = credentialsProvider; this.contextAdaptor = contextAdaptor; this.defaultConfig = defaultConfig; this.closeables = closeables != null ? new ConcurrentLinkedQueue<>(closeables) : null; } private HttpRoute determineRoute(final HttpHost target, final HttpRequest request, final HttpContext context) throws HttpException { return this.routePlanner.determineRoute(target, request, context); } private void setupContext(final HttpClientContext context) { if (context.getAuthSchemeRegistry() == null) { context.setAuthSchemeRegistry(this.authSchemeRegistry); } if (context.getCookieSpecRegistry() == null) { context.setCookieSpecRegistry(this.cookieSpecRegistry); } if (context.getCookieStore() == null) { context.setCookieStore(this.cookieStore); } if (context.getCredentialsProvider() == null) { context.setCredentialsProvider(this.credentialsProvider); } if (context.getRequestConfig() == null) { context.setRequestConfig(this.defaultConfig); } } @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { Args.notNull(request, "HTTP request"); try { final HttpClientContext localcontext = contextAdaptor.apply(context); RequestConfig config = null; if (request instanceof Configurable) { config = ((Configurable) request).getConfig(); } if (config != null) { localcontext.setRequestConfig(config); } setupContext(localcontext); final HttpHost resolvedTarget = target != null ? target : RoutingSupport.determineHost(request); if (resolvedTarget != null) { if (request.getScheme() == null) { request.setScheme(resolvedTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(resolvedTarget)); } } final HttpRoute route = determineRoute( resolvedTarget, request, localcontext); final String exchangeId = ExecSupport.getNextExchangeId(); localcontext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} preparing request execution", exchangeId); } final ExecRuntime execRuntime = new InternalExecRuntime(LOG, connManager, requestExecutor, request instanceof CancellableDependency ? (CancellableDependency) request : null); final ExecChain.Scope scope = new ExecChain.Scope(exchangeId, route, request, execRuntime, localcontext); final ClassicHttpResponse response = this.execChain.execute(ClassicRequestBuilder.copy(request).build(), scope); return CloseableHttpResponse.adapt(response); } catch (final HttpException httpException) { throw new ClientProtocolException(httpException.getMessage(), httpException); } } @Override public RequestConfig getConfig() { return this.defaultConfig; } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closeables != null) { Closeable closeable; while ((closeable = this.closeables.poll()) != null) { try { if (closeable instanceof ModalCloseable) { ((ModalCloseable) closeable).close(closeMode); } else { closeable.close(); } } catch (final IOException ex) { LOG.error(ex.getMessage(), ex); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/LinearBackoffManager.java0100644 0000000 0000000 00000022213 00000250600 030614 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.time.Duration; import java.time.Instant; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicInteger; /** * An implementation of {@link BackoffManager} that uses a linear backoff strategy to adjust the maximum number * of connections per route in an {@link org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager}. * This class is designed to be thread-safe and can be used in multi-threaded environments. *

* The linear backoff strategy increases or decreases the maximum number of connections per route by a fixed increment * when backing off or probing, respectively. The adjustments are made based on a cool-down period, during which no * further adjustments will be made. *

* The {@code LinearBackoffManager} is intended to be used with a {@link org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager}, * which provides the {@link ConnPoolControl} interface. This class interacts with the {@code PoolingHttpClientConnectionManager} * to adjust the maximum number of connections per route. *

* Example usage: * 

 * PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager();
 * LinearBackoffManager backoffManager = new LinearBackoffManager(connectionManager, 1);
 * // Use the backoffManager with the connectionManager in your application
 *
* * @see BackoffManager * @see ConnPoolControl * @see org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager * @since 5.3 */ @Contract(threading = ThreadingBehavior.SAFE) public class LinearBackoffManager extends AbstractBackoff { private static final Logger LOG = LoggerFactory.getLogger(LinearBackoffManager.class); /** * The backoff increment used when adjusting connection pool sizes. * The pool size will be increased or decreased by this value during the backoff process. * The increment must be positive. */ private final int increment; private final ConcurrentHashMap routeAttempts; /** * Constructs a new LinearBackoffManager with the specified connection pool control. * The backoff increment is set to {@code 1} by default. * * @param connPoolControl the connection pool control to be used by this LinearBackoffManager */ public LinearBackoffManager(final ConnPoolControl connPoolControl) { this(connPoolControl, 1); } /** * Constructs a new LinearBackoffManager with the specified connection pool control and backoff increment. * * @param connPoolControl the connection pool control to be used by this LinearBackoffManager * @param increment the backoff increment to be used when adjusting connection pool sizes * @throws IllegalArgumentException if connPoolControl is {@code null} or increment is not positive */ public LinearBackoffManager(final ConnPoolControl connPoolControl, final int increment) { super(connPoolControl); this.increment = Args.positive(increment, "Increment"); routeAttempts = new ConcurrentHashMap<>(); } @Override public void backOff(final HttpRoute route) { final Instant now = Instant.now(); if (shouldSkip(route, now)) { if (LOG.isDebugEnabled()) { LOG.debug("BackOff not applied for route: {}, cool-down period not elapsed", route); } return; } final AtomicInteger attempt = routeAttempts.compute(route, (r, oldValue) -> { if (oldValue == null) { return new AtomicInteger(1); } oldValue.incrementAndGet(); return oldValue; }); getLastRouteBackoffs().put(route, now); final int currentMax = getConnPerRoute().getMaxPerRoute(route); getConnPerRoute().setMaxPerRoute(route, getBackedOffPoolSize(currentMax)); attempt.incrementAndGet(); if (LOG.isDebugEnabled()) { LOG.debug("Backoff applied for route: {}, new max connections: {}", route, getConnPerRoute().getMaxPerRoute(route)); } } /** * Adjusts the maximum number of connections for the specified route, decreasing it by the increment value. * The method ensures that adjustments only happen after the cool-down period has passed since the last adjustment. * * @param route the HttpRoute for which the maximum number of connections will be decreased */ @Override public void probe(final HttpRoute route) { final Instant now = Instant.now(); if (shouldSkip(route, now)) { if (LOG.isDebugEnabled()) { LOG.debug("Probe not applied for route: {}, cool-down period not elapsed", route); } return; } routeAttempts.compute(route, (r, oldValue) -> { if (oldValue == null || oldValue.get() <= 1) { return null; } oldValue.decrementAndGet(); return oldValue; }); getLastRouteProbes().put(route, now); final int currentMax = getConnPerRoute().getMaxPerRoute(route); final int newMax = Math.max(currentMax - increment, getCap().get()); // Ensure the new max does not go below the cap getConnPerRoute().setMaxPerRoute(route, newMax); if (LOG.isDebugEnabled()) { LOG.debug("Probe applied for route: {}, new max connections: {}", route, getConnPerRoute().getMaxPerRoute(route)); } } /** * Determines whether an adjustment action (backoff or probe) should be skipped for the given HttpRoute based on the cool-down period. * If the time elapsed since the last successful probe or backoff for the given route is less than the cool-down * period, the method returns true. Otherwise, it returns false. *

* This method is used by both backOff() and probe() methods to enforce the cool-down period before making adjustments * to the connection pool size. * * @param route the {@link HttpRoute} to check * @param now the current {@link Instant} used to calculate the time since the last probe or backoff * @return true if the cool-down period has not elapsed since the last probe or backoff, false otherwise */ private boolean shouldSkip(final HttpRoute route, final Instant now) { final Instant lastProbe = getLastRouteProbes().getOrDefault(route, Instant.EPOCH); final Instant lastBackoff = getLastRouteBackoffs().getOrDefault(route, Instant.EPOCH); return Duration.between(lastProbe, now).compareTo(getCoolDown().get().toDuration()) < 0 || Duration.between(lastBackoff, now).compareTo(getCoolDown().get().toDuration()) < 0; } /** * Returns the new pool size after applying the linear backoff algorithm. * The new pool size is calculated by adding the increment value to the current pool size. * * @param curr the current pool size * @return the new pool size after applying the linear backoff */ @Override protected int getBackedOffPoolSize(final int curr) { return curr + increment; } /** * This method is not used in LinearBackoffManager's implementation. * It is provided to fulfill the interface requirement and for potential future extensions or modifications * of LinearBackoffManager that may use the backoff factor. * * @param d the backoff factor, not used in the current implementation */ @Override public void setBackoffFactor(final double d) { // Intentionally empty, as the backoff factor is not used in LinearBackoffManager } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/MainClientExec.java0100644 0000000 0000000 00000020671 00000250600 027471 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.ProtocolSwitchStrategy; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last request execution handler in the classic request execution * chain that is responsible for execution of request / response exchanges with * the opposite endpoint. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class MainClientExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(MainClientExec.class); private final HttpClientConnectionManager connectionManager; private final HttpProcessor httpProcessor; private final ConnectionReuseStrategy reuseStrategy; private final ConnectionKeepAliveStrategy keepAliveStrategy; private final UserTokenHandler userTokenHandler; private final ProtocolSwitchStrategy protocolSwitchStrategy; /** * @since 4.4 */ public MainClientExec( final HttpClientConnectionManager connectionManager, final HttpProcessor httpProcessor, final ConnectionReuseStrategy reuseStrategy, final ConnectionKeepAliveStrategy keepAliveStrategy, final UserTokenHandler userTokenHandler) { this.connectionManager = Args.notNull(connectionManager, "Connection manager"); this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); this.reuseStrategy = Args.notNull(reuseStrategy, "Connection reuse strategy"); this.keepAliveStrategy = Args.notNull(keepAliveStrategy, "Connection keep alive strategy"); this.userTokenHandler = Args.notNull(userTokenHandler, "User token handler"); this.protocolSwitchStrategy = new ProtocolSwitchStrategy(); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } try { // Run request protocol interceptors context.setRoute(route); context.setRequest(request); httpProcessor.process(request, request.getEntity(), context); final ClassicHttpResponse response = execRuntime.execute( exchangeId, request, (r, connection, c) -> { if (r.getCode() == HttpStatus.SC_SWITCHING_PROTOCOLS) { final ProtocolVersion upgradeProtocol = protocolSwitchStrategy.switchProtocol(r); if (upgradeProtocol == null || !upgradeProtocol.getProtocol().equals("TLS")) { throw new ProtocolException("Failure switching protocols"); } if (LOG.isDebugEnabled()) { LOG.debug("Switching to {}", upgradeProtocol); } try { execRuntime.upgradeTls(context); } catch (final IOException ex) { throw new HttpException("Failure upgrading to TLS", ex); } LOG.debug("Successfully switched to {}", upgradeProtocol); } }, context); context.setResponse(response); httpProcessor.process(response, response.getEntity(), context); Object userToken = context.getUserToken(); if (userToken == null) { userToken = userTokenHandler.getUserToken(route, request, context); context.setUserToken(userToken); } // The connection is in or can be brought to a re-usable state. if (reuseStrategy.keepAlive(request, response, context)) { // Set the idle duration of this connection final TimeValue duration = keepAliveStrategy.getKeepAliveDuration(response, context); if (LOG.isDebugEnabled()) { final String s; if (duration != null) { s = "for " + duration; } else { s = "indefinitely"; } LOG.debug("{} connection can be kept alive {}", exchangeId, s); } execRuntime.markConnectionReusable(userToken, duration); } else { execRuntime.markConnectionNonReusable(); } // check for entity, release connection if possible final HttpEntity entity = response.getEntity(); if (entity == null || !entity.isStreaming()) { // connection not needed and (assumed to be) in re-usable state execRuntime.releaseEndpoint(); return new CloseableHttpResponse(response); } return new CloseableHttpResponse(response, execRuntime); } catch (final ConnectionShutdownException ex) { final InterruptedIOException ioex = new InterruptedIOException( "Connection has been shut down"); ioex.initCause(ex); execRuntime.discardEndpoint(); throw ioex; } catch (final HttpException | RuntimeException | IOException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final Error error) { connectionManager.close(CloseMode.IMMEDIATE); throw error; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/MinimalHttpClient.java0100644 0000000 0000000 00000020546 00000250600 030227 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestContent; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of {@link CloseableHttpClient}. This client is * optimized for HTTP/1.1 message transport and does not support advanced * HTTP protocol functionality such as request execution via a proxy, state * management, authentication and request redirects. *

* Concurrent message exchanges executed by this client will get assigned to * separate connections leased from the connection pool. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class MinimalHttpClient extends CloseableHttpClient { private static final Logger LOG = LoggerFactory.getLogger(MinimalHttpClient.class); private final HttpClientConnectionManager connManager; private final ConnectionReuseStrategy reuseStrategy; private final SchemePortResolver schemePortResolver; private final HttpRequestExecutor requestExecutor; private final HttpProcessor httpProcessor; MinimalHttpClient(final HttpClientConnectionManager connManager) { super(); this.connManager = Args.notNull(connManager, "HTTP connection manager"); this.reuseStrategy = DefaultClientConnectionReuseStrategy.INSTANCE; this.schemePortResolver = DefaultSchemePortResolver.INSTANCE; this.requestExecutor = new HttpRequestExecutor(this.reuseStrategy); this.httpProcessor = new DefaultHttpProcessor( new RequestContent(), new RequestTargetHost(), new RequestClientConnControl(), new RequestUserAgent(VersionInfo.getSoftwareInfo( "Apache-HttpClient", "org.apache.hc.client5", getClass()))); } @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { Args.notNull(target, "Target host"); Args.notNull(request, "HTTP request"); if (request.getScheme() == null) { request.setScheme(target.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(target)); } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); RequestConfig config = null; if (request instanceof Configurable) { config = ((Configurable) request).getConfig(); } if (config != null) { clientContext.setRequestConfig(config); } final HttpRoute route = new HttpRoute(RoutingSupport.normalize(target, schemePortResolver)); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); final ExecRuntime execRuntime = new InternalExecRuntime(LOG, connManager, requestExecutor, request instanceof CancellableDependency ? (CancellableDependency) request : null); try { if (!execRuntime.isEndpointAcquired()) { execRuntime.acquireEndpoint(exchangeId, route, null, clientContext); } if (!execRuntime.isEndpointConnected()) { execRuntime.connectEndpoint(clientContext); } clientContext.setRequest(request); clientContext.setRoute(route); httpProcessor.process(request, request.getEntity(), clientContext); final ClassicHttpResponse response = execRuntime.execute(exchangeId, request, clientContext); httpProcessor.process(response, response.getEntity(), clientContext); if (reuseStrategy.keepAlive(request, response, clientContext)) { execRuntime.markConnectionReusable(null, TimeValue.NEG_ONE_MILLISECOND); } else { execRuntime.markConnectionNonReusable(); } // check for entity, release connection if possible final HttpEntity entity = response.getEntity(); if (entity == null || !entity.isStreaming()) { // connection not needed and (assumed to be) in re-usable state execRuntime.releaseEndpoint(); return new CloseableHttpResponse(response); } ResponseEntityProxy.enhance(response, execRuntime); return new CloseableHttpResponse(response, execRuntime); } catch (final ConnectionShutdownException ex) { final InterruptedIOException ioex = new InterruptedIOException("Connection has been shut down"); ioex.initCause(ex); execRuntime.discardEndpoint(); throw ioex; } catch (final HttpException httpException) { execRuntime.discardEndpoint(); throw new ClientProtocolException(httpException); } catch (final RuntimeException | IOException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final Error error) { connManager.close(CloseMode.IMMEDIATE); throw error; } } @Override public void close() throws IOException { this.connManager.close(); } @Override public void close(final CloseMode closeMode) { this.connManager.close(closeMode); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/NullBackoffStrategy.java0100644 0000000 0000000 00000003347 00000250600 030553 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.core5.http.HttpResponse; /** * This is a {@link ConnectionBackoffStrategy} that never backs off, * for compatibility with existing behavior. * * @since 4.2 */ public class NullBackoffStrategy implements ConnectionBackoffStrategy { @Override public boolean shouldBackoff(final Throwable t) { return false; } @Override public boolean shouldBackoff(final HttpResponse response) { return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ProtocolExec.java0100644 0000000 0000000 00000035335 00000250600 027252 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.Iterator; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * that is responsible for implementation of HTTP specification requirements. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ProtocolExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(ProtocolExec.class); private final AuthenticationStrategy targetAuthStrategy; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final SchemePortResolver schemePortResolver; private final AuthCacheKeeper authCacheKeeper; public ProtocolExec( final AuthenticationStrategy targetAuthStrategy, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { this.targetAuthStrategy = Args.notNull(targetAuthStrategy, "Target authentication strategy"); this.proxyAuthStrategy = Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.authenticator = new AuthenticationHandler(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(this.schemePortResolver); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest userRequest, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(userRequest, "HTTP request"); Args.notNull(scope, "Scope"); if (Method.CONNECT.isSame(userRequest.getMethod())) { throw new ProtocolException("Direct execution of CONNECT is not allowed"); } final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; final HttpHost routeTarget = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); try { final ClassicHttpRequest request; if (proxy != null && !route.isTunnelled()) { final ClassicRequestBuilder requestBuilder = ClassicRequestBuilder.copy(userRequest); if (requestBuilder.getAuthority() == null) { requestBuilder.setAuthority(new URIAuthority(routeTarget)); } requestBuilder.setAbsoluteRequestUri(true); request = requestBuilder.build(); } else { request = userRequest; } // Ensure the request has a scheme and an authority if (request.getScheme() == null) { request.setScheme(routeTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(routeTarget)); } final URIAuthority authority = request.getAuthority(); if (authority.getUserInfo() != null) { throw new ProtocolException("Request URI authority contains deprecated userinfo component"); } final HttpHost target = new HttpHost( request.getScheme(), authority.getHostName(), schemePortResolver.resolve(request.getScheme(), authority)); final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthExchange targetAuthExchange = context.getAuthExchange(target); final AuthExchange proxyAuthExchange = proxy != null ? context.getAuthExchange(proxy) : new AuthExchange(); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() != null && !pathPrefix.startsWith(targetAuthExchange.getPathPrefix())) { // force re-authentication if the current path prefix does not match // that of the previous authentication exchange. targetAuthExchange.reset(); } if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(target, pathPrefix, targetAuthExchange, context); if (proxy != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, context); } } RequestEntityProxy.enhance(request); for (;;) { if (!request.containsHeader(HttpHeaders.AUTHORIZATION)) { if (LOG.isDebugEnabled()) { LOG.debug("{} target auth state: {}", exchangeId, targetAuthExchange.getState()); } authenticator.addAuthResponse(target, ChallengeType.TARGET, request, targetAuthExchange, context); } if (!request.containsHeader(HttpHeaders.PROXY_AUTHORIZATION) && !route.isTunnelled()) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy auth state: {}", exchangeId, proxyAuthExchange.getState()); } authenticator.addAuthResponse(proxy, ChallengeType.PROXY, request, proxyAuthExchange, context); } // This is where the actual network communication happens (eventually) final ClassicHttpResponse response = chain.proceed(request, scope); if (Method.TRACE.isSame(request.getMethod())) { // Do not perform authentication for TRACE request ResponseEntityProxy.enhance(response, execRuntime); return response; } final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cannot retry non-repeatable request", exchangeId); } ResponseEntityProxy.enhance(response, execRuntime); return response; } if (needAuthentication( targetAuthExchange, proxyAuthExchange, proxy != null ? proxy : target, target, pathPrefix, response, context)) { // Make sure the response body is fully consumed, if present final HttpEntity responseEntity = response.getEntity(); if (execRuntime.isConnectionReusable()) { EntityUtils.consume(responseEntity); } else { execRuntime.disconnectEndpoint(); if (proxyAuthExchange.getState() == AuthExchange.State.SUCCESS && proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } if (targetAuthExchange.getState() == AuthExchange.State.SUCCESS && targetAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); } } // Reset request headers final ClassicHttpRequest original = scope.originalRequest; request.setHeaders(); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { request.addHeader(it.next()); } } else { ResponseEntityProxy.enhance(response, execRuntime); return response; } } } catch (final HttpException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final RuntimeException | IOException ex) { execRuntime.discardEndpoint(); for (final AuthExchange authExchange : context.getAuthExchanges().values()) { if (authExchange.isConnectionBased()) { authExchange.reset(); } } throw ex; } } private boolean needAuthentication( final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpHost target, final String pathPrefix, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean targetAuthRequested = authenticator.isChallenged( target, ChallengeType.TARGET, response, targetAuthExchange, context); final boolean targetMutualAuthRequired = authenticator.isChallengeExpected(targetAuthExchange); if (authCacheKeeper != null) { if (targetAuthRequested) { authCacheKeeper.updateOnChallenge(target, pathPrefix, targetAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(target, pathPrefix, targetAuthExchange, context); } } final boolean proxyAuthRequested = authenticator.isChallenged( proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } boolean targetNeedsAuth = false; boolean proxyNeedsAuth = false; if (targetAuthRequested || targetMutualAuthRequired) { targetNeedsAuth = authenticator.handleResponse(target, ChallengeType.TARGET, response, targetAuthStrategy, targetAuthExchange, context); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() == null) { targetAuthExchange.setPathPrefix(pathPrefix); } if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(target, pathPrefix, targetAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { proxyNeedsAuth = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } } return targetNeedsAuth || proxyNeedsAuth; } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ProxyClient.java0100644 0000000 0000000 00000022344 00000250600 027120 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.net.Socket; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.ScramSchemeFactory; import org.apache.hc.client5.http.impl.io.ManagedHttpClientConnectionFactory; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.util.Args; /** * ProxyClient can be used to establish a tunnel via an HTTP/1.1 proxy. */ public class ProxyClient { private final HttpConnectionFactory connFactory; private final RequestConfig requestConfig; private final HttpProcessor httpProcessor; private final HttpRequestExecutor requestExec; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthExchange proxyAuthExchange; private final Lookup authSchemeRegistry; private final ConnectionReuseStrategy reuseStrategy; /** * @since 5.0 */ public ProxyClient( final HttpConnectionFactory connFactory, final Http1Config h1Config, final CharCodingConfig charCodingConfig, final RequestConfig requestConfig) { super(); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.builder() .http1Config(h1Config) .charCodingConfig(charCodingConfig) .build(); this.requestConfig = requestConfig != null ? requestConfig : RequestConfig.DEFAULT; this.httpProcessor = new DefaultHttpProcessor( new RequestTargetHost(), new RequestClientConnControl(), new RequestUserAgent()); this.requestExec = new HttpRequestExecutor(); this.proxyAuthStrategy = new DefaultAuthenticationStrategy(); this.authenticator = new AuthenticationHandler(); this.proxyAuthExchange = new AuthExchange(); this.authSchemeRegistry = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.SCRAM_SHA_256, ScramSchemeFactory.INSTANCE) .build(); this.reuseStrategy = DefaultClientConnectionReuseStrategy.INSTANCE; } /** * @since 4.3 */ public ProxyClient(final RequestConfig requestConfig) { this(null, null, null, requestConfig); } public ProxyClient() { this(null, null, null, null); } public Socket tunnel( final HttpHost proxy, final HttpHost target, final Credentials credentials) throws IOException, HttpException { Args.notNull(proxy, "Proxy host"); Args.notNull(target, "Target host"); Args.notNull(credentials, "Credentials"); Args.check(target.getPort() > 0, "A valid port number must be provided for the tunnel CONNECT request."); final HttpRoute route = new HttpRoute( target, null, proxy, false, TunnelType.TUNNELLED, LayerType.PLAIN); final ManagedHttpClientConnection conn = this.connFactory.createConnection(null); final HttpClientContext context = HttpClientContext.create(); ClassicHttpResponse response; final ClassicHttpRequest connect = new BasicClassicHttpRequest(Method.CONNECT, proxy, target.toHostString()); final BasicCredentialsProvider credsProvider = new BasicCredentialsProvider(); credsProvider.setCredentials(new AuthScope(proxy), credentials); // Populate the execution context context.setRequest(connect); context.setRoute(route); context.setCredentialsProvider(credsProvider); context.setAuthSchemeRegistry(this.authSchemeRegistry); context.setRequestConfig(this.requestConfig); this.requestExec.preProcess(connect, this.httpProcessor, context); for (;;) { if (!conn.isOpen()) { final Socket socket = new Socket(proxy.getHostName(), proxy.getPort()); conn.bind(socket); } this.authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, this.proxyAuthExchange, context); response = this.requestExec.execute(connect, conn, context); final int status = response.getCode(); if (status < 200) { throw new HttpException("Unexpected response to CONNECT request: " + response); } if (this.authenticator.isChallenged(proxy, ChallengeType.PROXY, response, this.proxyAuthExchange, context) || authenticator.isChallengeExpected(proxyAuthExchange)) { if (this.authenticator.handleResponse(proxy, ChallengeType.PROXY, response, this.proxyAuthStrategy, this.proxyAuthExchange, context)) { // Retry request if (this.reuseStrategy.keepAlive(connect, response, context)) { // Consume response content final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); } else { conn.close(); } // discard previous auth header connect.removeHeaders(HttpHeaders.PROXY_AUTHORIZATION); } else { break; } } else { break; } } final int status = response.getCode(); if (status > 299) { EntityUtils.consume(response.getEntity()); conn.close(); throw new HttpException("Tunnel refused: " + new StatusLine(response)); } return conn.getSocket(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RedirectExec.java0100644 0000000 0000000 00000026145 00000250600 027211 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.net.URI; import java.util.Objects; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * responsible for handling of request redirects. *

* Further responsibilities such as communication with the opposite * endpoint is delegated to the next executor in the request execution * chain. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class RedirectExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(RedirectExec.class); private final RedirectStrategy redirectStrategy; private final HttpRoutePlanner routePlanner; public RedirectExec( final HttpRoutePlanner routePlanner, final RedirectStrategy redirectStrategy) { super(); Args.notNull(routePlanner, "HTTP route planner"); Args.notNull(redirectStrategy, "HTTP redirect strategy"); this.routePlanner = routePlanner; this.redirectStrategy = redirectStrategy; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpClientContext context = scope.clientContext; context.setRedirectLocations(null); final RequestConfig config = context.getRequestConfigOrDefault(); final int maxRedirects = config.getMaxRedirects() > 0 ? config.getMaxRedirects() : 50; ClassicHttpRequest currentRequest = request; ExecChain.Scope currentScope = scope; for (int redirectCount = 0;;) { final String exchangeId = currentScope.exchangeId; final ClassicHttpResponse response = chain.proceed(currentRequest, currentScope); try { if (config.isRedirectsEnabled() && this.redirectStrategy.isRedirected(request, response, context)) { final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect non-repeatable request", exchangeId); } return response; } if (redirectCount >= maxRedirects) { throw new RedirectException("Maximum redirects (" + maxRedirects + ") exceeded"); } redirectCount++; final URI redirectUri = this.redirectStrategy.getLocationURI(currentRequest, response, context); if (LOG.isDebugEnabled()) { LOG.debug("{} redirect requested to location '{}'", exchangeId, redirectUri); } final HttpHost newTarget = URIUtils.extractHost(redirectUri); if (newTarget == null) { throw new ProtocolException("Redirect URI does not specify a valid host name: " + redirectUri); } final RedirectLocations redirectLocations = context.getRedirectLocations(); if (!config.isCircularRedirectsAllowed()) { if (redirectLocations.contains(redirectUri)) { throw new CircularRedirectException("Circular redirect to '" + redirectUri + "'"); } } final int statusCode = response.getCode(); final ClassicRequestBuilder redirectBuilder; switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: if (Method.POST.isSame(request.getMethod())) { redirectBuilder = ClassicRequestBuilder.get(); } else { redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } break; case HttpStatus.SC_SEE_OTHER: if (!Method.GET.isSame(request.getMethod()) && !Method.HEAD.isSame(request.getMethod())) { redirectBuilder = ClassicRequestBuilder.get(); } else { redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } break; default: redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } redirectBuilder.setUri(redirectUri); final ClassicHttpRequest redirect = redirectBuilder.build(); final HttpRoute currentRoute = currentScope.route; final HttpHost currentHost = currentRoute.getTargetHost(); if (!redirectStrategy.isRedirectAllowed(currentHost, newTarget, redirect, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect due to safety restrictions", exchangeId); } return response; } redirectLocations.add(redirectUri); final HttpRoute newRoute; if (!Objects.equals(currentHost, newTarget)) { newRoute = this.routePlanner.determineRoute(newTarget, context); if (!Objects.equals(currentRoute, newRoute)) { if (LOG.isDebugEnabled()) { LOG.debug("{} new route required", exchangeId); } final AuthExchange targetAuthExchange = context.getAuthExchange(currentHost); if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); final HttpHost proxyHost = currentRoute.getProxyHost(); if (proxyHost != null) { final AuthExchange proxyAuthExchange = context.getAuthExchange(proxyHost); if (proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } } } } else { newRoute = currentRoute; } if (LOG.isDebugEnabled()) { LOG.debug("{} redirecting to '{}' via {}", exchangeId, redirectUri, newRoute); } currentScope = new ExecChain.Scope( scope.exchangeId, newRoute, ClassicRequestBuilder.copy(redirect).build(), scope.execRuntime, scope.clientContext); currentRequest = redirect; RequestEntityProxy.enhance(currentRequest); EntityUtils.consume(response.getEntity()); response.close(); } else { return response; } } catch (final RuntimeException | IOException ex) { response.close(); throw ex; } catch (final HttpException ex) { // Protocol exception related to a direct. // The underlying connection may still be salvaged. try { EntityUtils.consume(response.getEntity()); } catch (final IOException ioex) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while releasing connection", exchangeId, ioex); } } finally { response.close(); } throw ex; } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestAbortedException.java0100644 0000000 0000000 00000003343 00000250600 031446 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.InterruptedIOException; /** * Signals that the request has been aborted. * * @since 4.3 */ public class RequestAbortedException extends InterruptedIOException { private static final long serialVersionUID = 4973849966012490112L; public RequestAbortedException(final String message) { super(message); } public RequestAbortedException(final String message, final Throwable cause) { super(message); if (cause != null) { initCause(cause); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestEntityProxy.java0100644 0000000 0000000 00000007233 00000250600 030527 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.List; import java.util.Set; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; class RequestEntityProxy implements HttpEntity { static void enhance(final ClassicHttpRequest request) { final HttpEntity entity = request.getEntity(); if (entity != null && !entity.isRepeatable() && !isEnhanced(entity)) { request.setEntity(new RequestEntityProxy(entity)); } } static boolean isEnhanced(final HttpEntity entity) { return entity instanceof RequestEntityProxy; } private final HttpEntity original; private boolean consumed; RequestEntityProxy(final HttpEntity original) { super(); this.original = original; } public HttpEntity getOriginal() { return original; } public boolean isConsumed() { return consumed; } @Override public boolean isRepeatable() { return !consumed || original.isRepeatable(); } @Override public boolean isChunked() { return original.isChunked(); } @Override public long getContentLength() { return original.getContentLength(); } @Override public String getContentType() { return original.getContentType(); } @Override public String getContentEncoding() { return original.getContentEncoding(); } @Override public InputStream getContent() throws IOException, IllegalStateException { return original.getContent(); } @Override public void writeTo(final OutputStream outStream) throws IOException { consumed = true; original.writeTo(outStream); } @Override public boolean isStreaming() { return original.isStreaming(); } @Override public Supplier> getTrailers() { return original.getTrailers(); } @Override public Set getTrailerNames() { return original.getTrailerNames(); } @Override public void close() throws IOException { original.close(); } @Override public String toString() { final StringBuilder sb = new StringBuilder("RequestEntityProxy{"); sb.append(original); sb.append('}'); return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestFailedException.java0100644 0000000 0000000 00000003407 00000250600 031253 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.InterruptedIOException; /** * Signals that the request has been aborted or failed due to an expected condition. * * @since 5.0 */ public class RequestFailedException extends InterruptedIOException { private static final long serialVersionUID = 4973849966012490112L; public RequestFailedException(final String message) { super(message); } public RequestFailedException(final String message, final Throwable cause) { super(message); if (cause != null) { initCause(cause); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ResponseEntityProxy.java0100644 0000000 0000000 00000016413 00000250600 030675 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.SocketException; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.impl.io.ChunkedInputStream; import org.apache.hc.core5.http.io.EofSensorInputStream; import org.apache.hc.core5.http.io.EofSensorWatcher; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; class ResponseEntityProxy extends HttpEntityWrapper implements EofSensorWatcher { private final ExecRuntime execRuntime; public static void enhance(final ClassicHttpResponse response, final ExecRuntime execRuntime) { final HttpEntity entity = response.getEntity(); if (entity != null && entity.isStreaming() && execRuntime != null) { response.setEntity(new ResponseEntityProxy(entity, execRuntime)); } } ResponseEntityProxy(final HttpEntity entity, final ExecRuntime execRuntime) { super(entity); this.execRuntime = execRuntime; } private void cleanup() throws IOException { if (this.execRuntime != null) { if (this.execRuntime.isEndpointConnected()) { this.execRuntime.disconnectEndpoint(); } this.execRuntime.discardEndpoint(); } } private void discardConnection() { if (this.execRuntime != null) { this.execRuntime.discardEndpoint(); } } public void releaseConnection() { if (this.execRuntime != null) { this.execRuntime.releaseEndpoint(); } } @Override public boolean isRepeatable() { return false; } @Override public InputStream getContent() throws IOException { return new EofSensorInputStream(super.getContent(), this); } @Override public void writeTo(final OutputStream outStream) throws IOException { try { super.writeTo(outStream != null ? outStream : NullOutputStream.INSTANCE); releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } } @Override public boolean eofDetected(final InputStream wrapped) throws IOException { try { // there may be some cleanup required, such as // reading trailers after the response body: if (wrapped != null) { wrapped.close(); } releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } return false; } @Override public boolean streamClosed(final InputStream wrapped) throws IOException { try { final boolean open = execRuntime != null && execRuntime.isEndpointAcquired(); // this assumes that closing the stream will // consume the remainder of the response body: try { if (wrapped != null) { wrapped.close(); } releaseConnection(); } catch (final SocketException ex) { if (open) { throw ex; } } } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } return false; } @Override public boolean streamAbort(final InputStream wrapped) throws IOException { cleanup(); return false; } @Override public Supplier> getTrailers() { try { final InputStream underlyingStream = super.getContent(); return () -> { final Header[] footers; if (underlyingStream instanceof ChunkedInputStream) { final ChunkedInputStream chunkedInputStream = (ChunkedInputStream) underlyingStream; footers = chunkedInputStream.getFooters(); } else { footers = new Header[0]; } return Arrays.asList(footers); }; } catch (final IOException e) { throw new IllegalStateException("Unable to retrieve input stream", e); } } @Override public void close() throws IOException { try { // HttpEntity.close will close the underlying resource. Closing a reusable request stream results in // draining remaining data, allowing for connection reuse. super.close(); releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } } private static final class NullOutputStream extends OutputStream { private static final NullOutputStream INSTANCE = new NullOutputStream(); private NullOutputStream() { } @Override public void write(@SuppressWarnings("unused") final int byteValue) { // no-op } @Override public void write(@SuppressWarnings("unused") final byte[] buffer) { // no-op } @Override public void write( @SuppressWarnings("unused") final byte[] buffer, @SuppressWarnings("unused") final int off, @SuppressWarnings("unused") final int len) { // no-op } @Override public void flush() { // no-op } @Override public void close() { // no-op } @Override public String toString() { return "NullOutputStream{}"; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/SystemClock.java0100644 0000000 0000000 00000002535 00000250600 027100 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; class SystemClock implements Clock { @Override public long getCurrentTime() { return System.currentTimeMillis(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/package-info.java0100644 0000000 0000000 00000002677 00000250600 027173 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Classic HTTP client API implementation that supports HTTP/1.1 transport * only. This implementation is mostly API compatible with HttpClient 4.5. * Please use the asynchronous client API implementation for HTTP/2 transport. */ package org.apache.hc.client5.http.impl.classic; httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/0040755 0000000 0000000 00000000000 00000250600 023635 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncAdaptor.java0100644 0000000 0000000 00000011042 00000250600 030670 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InterruptedIOException; import java.util.concurrent.Future; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.support.classic.ClassicToAsyncRequestProducer; import org.apache.hc.core5.http.nio.support.classic.ClassicToAsyncResponseConsumer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Timeout; /** * {@link CloseableHttpClient} implementation backed by {@link CloseableHttpAsyncClient} * acting as a compatibility bridge with the classic APIs based on the standard * {@link java.io.InputStream} / {@link java.io.OutputStream} model. * * @since 5.5 */ @Experimental @Internal @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class ClassicToAsyncAdaptor extends CloseableHttpClient { private final CloseableHttpAsyncClient client; private final Timeout operationTimeout; public ClassicToAsyncAdaptor(final CloseableHttpAsyncClient client, final Timeout operationTimeout) { super(); this.client = client; this.operationTimeout = operationTimeout; } @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { final ClassicToAsyncRequestProducer requestProducer = new ClassicToAsyncRequestProducer(request, operationTimeout); final ClassicToAsyncResponseConsumer responseConsumer = new ClassicToAsyncResponseConsumer(operationTimeout); final Future resultFuture = client.execute(target, requestProducer, responseConsumer, null, context, null); if (request instanceof CancellableDependency) { ((CancellableDependency) request).setDependency(() -> resultFuture.cancel(true)); } try { requestProducer.blockWaiting().execute(); final ClassicHttpResponse response = responseConsumer.blockWaiting(); return CloseableHttpResponse.create(response, (closeable, closeMode) -> { try { if (closeMode == CloseMode.GRACEFUL) { closeable.close(); } } finally { resultFuture.cancel(true); } }); } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); throw new InterruptedIOException(); } } @Override public void close() throws IOException { client.close(); } @Override public void close(final CloseMode closeMode) { client.close(closeMode); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/0040755 0000000 0000000 00000000000 00000250600 023623 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieAttributeHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieAttributeHandler.java0100644 0000000 0000000 00000003776 00000250600 032557 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class AbstractCookieAttributeHandler implements CookieAttributeHandler { @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { // Do nothing } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { // Always match return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieSpec.java0100644 0000000 0000000 00000007776 00000250600 030214 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Asserts; /** * Abstract cookie specification which can delegate the job of parsing, * validation or matching cookie attributes to a number of arbitrary * {@link CookieAttributeHandler}s. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class AbstractCookieSpec implements CookieSpec { /** * Stores attribute name -> attribute handler mappings */ private final Map attribHandlerMap; /** * Default constructor * */ public AbstractCookieSpec() { super(); this.attribHandlerMap = new ConcurrentHashMap<>(10); } /** * @since 4.4 */ protected AbstractCookieSpec(final HashMap map) { super(); Asserts.notNull(map, "Attribute handler map"); this.attribHandlerMap = new ConcurrentHashMap<>(map); } /** * @since 4.4 */ protected AbstractCookieSpec(final CommonCookieAttributeHandler... handlers) { super(); this.attribHandlerMap = new ConcurrentHashMap<>(handlers.length); for (final CommonCookieAttributeHandler handler: handlers) { this.attribHandlerMap.put(handler.getAttributeName(), handler); } } /** * Finds an attribute handler {@link CookieAttributeHandler} for the * given attribute. Returns {@code null} if no attribute handler is * found for the specified attribute. * * @param name attribute name. e.g. Domain, Path, etc. * @return an attribute handler or {@code null} */ protected CookieAttributeHandler findAttribHandler(final String name) { return this.attribHandlerMap.get(name); } /** * Gets attribute handler {@link CookieAttributeHandler} for the * given attribute. * * @param name attribute name. e.g. Domain, Path, etc. * @throws IllegalStateException if handler not found for the * specified attribute. */ protected CookieAttributeHandler getAttribHandler(final String name) { final CookieAttributeHandler handler = findAttribHandler(name); Asserts.check(handler != null, "Handler not registered for " + name + " attribute"); return handler; } protected Collection getAttribHandlers() { return this.attribHandlerMap.values(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicClientCookie.java0100644 0000000 0000000 00000025040 00000250600 027776 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.io.Serializable; import java.time.Instant; import java.util.Date; import java.util.HashMap; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link SetCookie}. * * @since 4.0 */ public final class BasicClientCookie implements SetCookie, Cloneable, Serializable { private static final long serialVersionUID = -3869795591041535538L; /** * Default Constructor taking a name and a value. The value may be null. * * @param name The name. * @param value The value. */ public BasicClientCookie(final String name, final String value) { super(); Args.notNull(name, "Name"); this.name = name; this.attribs = new HashMap<>(); this.value = value; } /** * Returns the name. * * @return String name The name */ @Override public String getName() { return this.name; } /** * Returns the value. * * @return String value The current value. */ @Override public String getValue() { return this.value; } /** * Sets the value * * @param value */ @Override public void setValue(final String value) { this.value = value; } /** * Returns the expiration {@link Date} of the cookie, or {@code null} * if none exists. *

Note: the object returned by this method is * considered immutable. Changing it (e.g. using setTime()) could result * in undefined behaviour. Do so at your peril.

* @return Expiration {@link Date}, or {@code null}. * * @see #setExpiryDate(java.util.Date) * * @deprecated Use {@link #getExpiryInstant()} */ @Deprecated @Override public Date getExpiryDate() { return DateUtils.toDate(cookieExpiryDate); } /** * {@inheritDoc} */ @Override public Instant getExpiryInstant() { return cookieExpiryDate; } /** * Sets expiration date. *

Note: the object returned by this method is considered * immutable. Changing it (e.g. using setTime()) could result in undefined * behaviour. Do so at your peril.

* * @param expiryDate the {@link Date} after which this cookie is no longer valid. * * @deprecated Use {{@link #setExpiryDate(Instant)}} * */ @Deprecated @Override public void setExpiryDate (final Date expiryDate) { cookieExpiryDate = DateUtils.toInstant(expiryDate); } /** * Sets expiration date. *

Note: the object returned by this method is considered * immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at * your peril.

* * @param expiryInstant the {@link Instant} after which this cookie is no longer valid. * @see #getExpiryInstant() * @since 5.2 */ @Override public void setExpiryDate (final Instant expiryInstant) { cookieExpiryDate = expiryInstant; } /** * Returns {@code false} if the cookie should be discarded at the end * of the "session"; {@code true} otherwise. * * @return {@code false} if the cookie should be discarded at the end * of the "session"; {@code true} otherwise */ @Override public boolean isPersistent() { return null != cookieExpiryDate; } /** * Returns domain attribute of the cookie. * * @return the value of the domain attribute * * @see #setDomain(java.lang.String) */ @Override public String getDomain() { return cookieDomain; } /** * Sets the domain attribute. * * @param domain The value of the domain attribute * * @see #getDomain */ @Override public void setDomain(final String domain) { if (domain != null) { cookieDomain = domain.toLowerCase(Locale.ROOT); } else { cookieDomain = null; } } /** * Returns the path attribute of the cookie * * @return The value of the path attribute. * * @see #setPath(java.lang.String) */ @Override public String getPath() { return cookiePath; } /** * Sets the path attribute. * * @param path The value of the path attribute * * @see #getPath * */ @Override public void setPath(final String path) { cookiePath = path; } /** * @return {@code true} if this cookie should only be sent over secure connections. * @see #setSecure(boolean) */ @Override public boolean isSecure() { return isSecure; } /** * Sets the secure attribute of the cookie. *

* When {@code true} the cookie should only be sent * using a secure protocol (https). This should only be set when * the cookie's originating server used a secure protocol to set the * cookie's value. * * @param secure The value of the secure attribute * * @see #isSecure() */ @Override public void setSecure (final boolean secure) { isSecure = secure; } /** * Sets the http-only attribute of the cookie. * * @param httpOnly true if this cookie is to be marked as * {@code httpOnly}, false otherwise * * @since 5.2 */ @Override public void setHttpOnly(final boolean httpOnly) { this.httpOnly = httpOnly; } /** * Returns true if this cookie has expired. * @param date Current time * * @return {@code true} if the cookie has expired. * * @deprecated Use {@link #isExpired(Instant)} */ @Deprecated @Override public boolean isExpired(final Date date) { Args.notNull(date, "Date"); return cookieExpiryDate != null && cookieExpiryDate.compareTo(DateUtils.toInstant(date)) <= 0; } /** * Returns true if this cookie has expired. * @param instant Current time * * @return {@code true} if the cookie has expired. */ @Override public boolean isExpired(final Instant instant) { Args.notNull(instant, "Instant"); return cookieExpiryDate != null && cookieExpiryDate.compareTo(instant) <= 0; } /** * @since 4.4 * * @deprecated Use {@link #getCreationInstant()}. */ @Deprecated @Override public Date getCreationDate() { return DateUtils.toDate(creationDate); } /** * @since 5.2 */ @Override public Instant getCreationInstant() { return creationDate; } /** * @return true if this Cookie has been marked as {@code httpOnly}, false otherwise * @see #setHttpOnly(boolean) * @since 5.2 */ @Override public boolean isHttpOnly() { return httpOnly; } /** * @since 4.4 * @deprecated Use {@link #setCreationDate(Instant)} */ @Deprecated public void setCreationDate(final Date creationDate) { this.creationDate = DateUtils.toInstant(creationDate); } /** * @since 5.2 */ public void setCreationDate(final Instant creationDate) { this.creationDate = creationDate; } public void setAttribute(final String name, final String value) { this.attribs.put(name, value); } @Override public String getAttribute(final String name) { return this.attribs.get(name); } @Override public boolean containsAttribute(final String name) { return this.attribs.containsKey(name); } /** * @since 4.4 */ public boolean removeAttribute(final String name) { return this.attribs.remove(name) != null; } @Override public Object clone() throws CloneNotSupportedException { final BasicClientCookie clone = (BasicClientCookie) super.clone(); clone.attribs = new HashMap<>(this.attribs); return clone; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[name: "); buffer.append(this.name); buffer.append("; "); buffer.append("value: "); buffer.append(this.value); buffer.append("; "); buffer.append("domain: "); buffer.append(this.cookieDomain); buffer.append("; "); buffer.append("path: "); buffer.append(this.cookiePath); buffer.append("; "); buffer.append("expiry: "); buffer.append(this.cookieExpiryDate); buffer.append("]"); return buffer.toString(); } // ----------------------------------------------------- Instance Variables /** Cookie name */ private final String name; /** Cookie attributes as specified by the origin server */ private Map attribs; /** Cookie value */ private String value; /** Domain attribute. */ private String cookieDomain; /** Expiration {@link Instant}. */ private Instant cookieExpiryDate; /** Path attribute. */ private String cookiePath; /** My secure flag. */ private boolean isSecure; private Instant creationDate; /** The {@code httpOnly} flag. */ private boolean httpOnly; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicDomainHandler.java0100644 0000000 0000000 00000012456 00000250600 030142 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Locale; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieRestrictionViolationException; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.net.InetAddressUtils; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code domain} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicDomainHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicDomainHandler}. * * @since 5.2 */ public static final BasicDomainHandler INSTANCE = new BasicDomainHandler(); public BasicDomainHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { throw new MalformedCookieException("Blank or null value for domain attribute"); } // Ignore domain attributes ending with '.' per RFC 6265, 4.1.2.3 if (value.endsWith(".")) { return; } String domain = value; if (domain.startsWith(".")) { domain = domain.substring(1); } domain = domain.toLowerCase(Locale.ROOT); cookie.setDomain(domain); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); // Validate the cookies domain attribute. NOTE: Domains without // any dots are allowed to support hosts on private LANs that don't // have DNS names. Since they have no dots, to domain-match the // request-host and domain must be identical for the cookie to sent // back to the origin-server. final String host = origin.getHost(); final String domain = cookie.getDomain(); if (domain == null) { throw new CookieRestrictionViolationException("Cookie 'domain' may not be null"); } if (!host.equals(domain) && !domainMatch(domain, host)) { throw new CookieRestrictionViolationException( "Illegal 'domain' attribute \"" + domain + "\". Domain of origin: \"" + host + "\""); } } static boolean domainMatch(final String domain, final String host) { if (InetAddressUtils.isIPv4(host) || InetAddressUtils.isIPv6(host)) { return false; } final String normalizedDomain = domain.startsWith(".") ? domain.substring(1) : domain; if (host.endsWith(normalizedDomain)) { final int prefix = host.length() - normalizedDomain.length(); // Either a full match or a prefix ending with a '.' if (prefix == 0) { return true; } return prefix > 1 && host.charAt(prefix - 1) == '.'; } return false; } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); final String host = origin.getHost(); String domain = cookie.getDomain(); if (domain == null) { return false; } if (domain.startsWith(".")) { domain = domain.substring(1); } domain = domain.toLowerCase(Locale.ROOT); if (host.equals(domain)) { return true; } if (cookie.containsAttribute(Cookie.DOMAIN_ATTR)) { return domainMatch(domain, host); } return false; } @Override public String getAttributeName() { return Cookie.DOMAIN_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicExpiresHandler.java0100644 0000000 0000000 00000006722 00000250600 030351 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.time.format.DateTimeFormatter; import java.time.format.DateTimeFormatterBuilder; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code expires} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicExpiresHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** Valid date patterns */ private final DateTimeFormatter[] datePatterns; /** * @since 5.2 */ public BasicExpiresHandler(final DateTimeFormatter... datePatterns) { this.datePatterns = datePatterns; } /** * @deprecated Use {@link #BasicExpiresHandler(DateTimeFormatter...)} */ @Deprecated public BasicExpiresHandler(final String[] datePatterns) { Args.notNull(datePatterns, "Array of date patterns"); this.datePatterns = new DateTimeFormatter[datePatterns.length]; for (int i = 0; i < datePatterns.length; i++) { this.datePatterns[i] = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(datePatterns[i]) .toFormatter(); } } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (value == null) { throw new MalformedCookieException("Missing value for 'expires' attribute"); } final Instant expiry = DateUtils.parseDate(value, this.datePatterns); if (expiry == null) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } cookie.setExpiryDate(expiry); } @Override public String getAttributeName() { return Cookie.EXPIRES_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicHttpOnlyHandler.java0100644 0000000 0000000 00000005150 00000250600 030505 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code HttpOnly} attribute handler. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicHttpOnlyHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicHttpOnlyHandler}. * * @since 5.2 */ public static final BasicHttpOnlyHandler INSTANCE = new BasicHttpOnlyHandler(); public BasicHttpOnlyHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setHttpOnly(true); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { return true; } @Override public String getAttributeName() { return Cookie.HTTP_ONLY_ATTR; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicMaxAgeHandler.java0100644 0000000 0000000 00000005630 00000250600 030071 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code max-age} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicMaxAgeHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicMaxAgeHandler}. * * @since 5.2 */ public static final BasicMaxAgeHandler INSTANCE = new BasicMaxAgeHandler(); public BasicMaxAgeHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (value == null) { throw new MalformedCookieException("Missing value for 'max-age' attribute"); } final int age; try { age = Integer.parseInt(value); } catch (final NumberFormatException e) { throw new MalformedCookieException ("Invalid 'max-age' attribute: " + value); } if (age < 0) { throw new MalformedCookieException ("Negative 'max-age' attribute: " + value); } cookie.setExpiryDate(Instant.now().plusSeconds(age)); } @Override public String getAttributeName() { return Cookie.MAX_AGE_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicPathHandler.java0100644 0000000 0000000 00000007102 00000250600 027617 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code path} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicPathHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicPathHandler}. * * @since 5.2 */ public static final BasicPathHandler INSTANCE = new BasicPathHandler(); public BasicPathHandler() { super(); } @Override public void parse( final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setPath(!TextUtils.isBlank(value) ? value : "/"); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { } static boolean pathMatch(final String uriPath, final String cookiePath) { String normalizedCookiePath = cookiePath; if (normalizedCookiePath == null) { normalizedCookiePath = "/"; } if (normalizedCookiePath.length() > 1 && normalizedCookiePath.endsWith("/")) { normalizedCookiePath = normalizedCookiePath.substring(0, normalizedCookiePath.length() - 1); } if (uriPath.startsWith(normalizedCookiePath)) { if (normalizedCookiePath.equals("/")) { return true; } if (uriPath.length() == normalizedCookiePath.length()) { return true; } return uriPath.charAt(normalizedCookiePath.length()) == '/'; } return false; } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); return pathMatch(origin.getPath(), cookie.getPath()); } @Override public String getAttributeName() { return Cookie.PATH_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicSecureHandler.java0100644 0000000 0000000 00000005156 00000250600 030160 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code secure} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicSecureHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance BasicSecureHandler. * * @since 5.2 */ public static final BasicSecureHandler INSTANCE = new BasicSecureHandler(); public BasicSecureHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setSecure(true); } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); return !cookie.isSecure() || origin.isSecure(); } @Override public String getAttributeName() { return Cookie.SECURE_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/CookieSpecBase.java0100644 0000000 0000000 00000012002 00000250600 027275 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Locale; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; /** * Cookie management functions shared by all specification. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class CookieSpecBase extends AbstractCookieSpec { public CookieSpecBase() { super(); } /** * @since 4.4 */ protected CookieSpecBase(final HashMap map) { super(map); } /** * @since 4.4 */ protected CookieSpecBase(final CommonCookieAttributeHandler... handlers) { super(handlers); } protected static String getDefaultPath(final CookieOrigin origin) { String defaultPath = origin.getPath(); int lastSlashIndex = defaultPath.lastIndexOf('/'); if (lastSlashIndex >= 0) { if (lastSlashIndex == 0) { //Do not remove the very first slash lastSlashIndex = 1; } defaultPath = defaultPath.substring(0, lastSlashIndex); } return defaultPath; } protected static String getDefaultDomain(final CookieOrigin origin) { return origin.getHost(); } protected List parse(final HeaderElement[] elems, final CookieOrigin origin) throws MalformedCookieException { final List cookies = new ArrayList<>(elems.length); for (final HeaderElement headerelement : elems) { final String name = headerelement.getName(); final String value = headerelement.getValue(); if (name == null || name.isEmpty()) { throw new MalformedCookieException("Cookie name may not be empty"); } final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setPath(getDefaultPath(origin)); cookie.setDomain(getDefaultDomain(origin)); // cycle through the parameters final NameValuePair[] attribs = headerelement.getParameters(); for (int j = attribs.length - 1; j >= 0; j--) { final NameValuePair attrib = attribs[j]; final String s = attrib.getName().toLowerCase(Locale.ROOT); cookie.setAttribute(s, attrib.getValue()); final CookieAttributeHandler handler = findAttribHandler(s); if (handler != null) { handler.parse(cookie, attrib.getValue()); } } cookies.add(cookie); } return cookies; } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: getAttribHandlers()) { handler.validate(cookie, origin); } } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: getAttribHandlers()) { if (!handler.match(cookie, origin)) { return false; } } return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/IgnoreCookieSpecFactory.java0100644 0000000 0000000 00000004453 00000250600 031211 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link CookieSpecFactory} implementation that ignores all cookies. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class IgnoreCookieSpecFactory implements CookieSpecFactory { private volatile CookieSpec cookieSpec; private final ReentrantLock lock; public IgnoreCookieSpecFactory() { super(); this.lock = new ReentrantLock(); } @Override public CookieSpec create(final HttpContext context) { if (cookieSpec == null) { lock.lock(); try { if (cookieSpec == null) { this.cookieSpec = IgnoreSpecSpec.INSTANCE; } } finally { lock.unlock(); } } return this.cookieSpec; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/IgnoreSpecSpec.java0100644 0000000 0000000 00000004505 00000250600 027340 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Collections; import java.util.List; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; /** * CookieSpec that ignores all cookies * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class IgnoreSpecSpec extends CookieSpecBase { /** * Default instance of {@link IgnoreSpecSpec}. * * @since 5.2 */ public static final IgnoreSpecSpec INSTANCE = new IgnoreSpecSpec(); @Override public List parse(final Header header, final CookieOrigin origin) throws MalformedCookieException { return Collections.emptyList(); } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { return false; } @Override public List

formatCookies(final List cookies) { return Collections.emptyList(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/LaxExpiresHandler.java0100644 0000000 0000000 00000020541 00000250600 030047 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.time.Month; import java.time.ZoneId; import java.time.ZonedDateTime; import java.util.BitSet; import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * Cookie {@code expires} attribute handler conformant to the more relaxed interpretation * of HTTP state management. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxExpiresHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link LaxExpiresHandler}. * * @since 5.2 */ public static final LaxExpiresHandler INSTANCE = new LaxExpiresHandler(); private static final BitSet DELIMS; static { final BitSet bitSet = new BitSet(); bitSet.set(0x9); for (int b = 0x20; b <= 0x2f; b++) { bitSet.set(b); } for (int b = 0x3b; b <= 0x40; b++) { bitSet.set(b); } for (int b = 0x5b; b <= 0x60; b++) { bitSet.set(b); } for (int b = 0x7b; b <= 0x7e; b++) { bitSet.set(b); } DELIMS = bitSet; } private static final Map MONTHS; static { final ConcurrentHashMap map = new ConcurrentHashMap<>(12); map.put("jan", Month.JANUARY); map.put("feb", Month.FEBRUARY); map.put("mar", Month.MARCH); map.put("apr", Month.APRIL); map.put("may", Month.MAY); map.put("jun", Month.JUNE); map.put("jul", Month.JULY); map.put("aug", Month.AUGUST); map.put("sep", Month.SEPTEMBER); map.put("oct", Month.OCTOBER); map.put("nov", Month.NOVEMBER); map.put("dec", Month.DECEMBER); MONTHS = map; } private final static Pattern TIME_PATTERN = Pattern.compile( "^([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})([^0-9].*)?$"); private final static Pattern DAY_OF_MONTH_PATTERN = Pattern.compile( "^([0-9]{1,2})([^0-9].*)?$"); private final static Pattern MONTH_PATTERN = Pattern.compile( "^(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)(.*)?$", Pattern.CASE_INSENSITIVE); private final static Pattern YEAR_PATTERN = Pattern.compile( "^([0-9]{2,4})([^0-9].*)?$"); public LaxExpiresHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { return; } final Tokenizer.Cursor cursor = new Tokenizer.Cursor(0, value.length()); final StringBuilder content = new StringBuilder(); int second = 0, minute = 0, hour = 0, day = 0, year = 0; Month month = Month.JANUARY; boolean foundTime = false, foundDayOfMonth = false, foundMonth = false, foundYear = false; try { while (!cursor.atEnd()) { skipDelims(value, cursor); content.setLength(0); copyContent(value, cursor, content); if (content.length() == 0) { break; } if (!foundTime) { final Matcher matcher = TIME_PATTERN.matcher(content); if (matcher.matches()) { foundTime = true; hour = Integer.parseInt(matcher.group(1)); minute = Integer.parseInt(matcher.group(2)); second = Integer.parseInt(matcher.group(3)); continue; } } if (!foundDayOfMonth) { final Matcher matcher = DAY_OF_MONTH_PATTERN.matcher(content); if (matcher.matches()) { foundDayOfMonth = true; day = Integer.parseInt(matcher.group(1)); continue; } } if (!foundMonth) { final Matcher matcher = MONTH_PATTERN.matcher(content); if (matcher.matches()) { foundMonth = true; month = MONTHS.get(matcher.group(1).toLowerCase(Locale.ROOT)); continue; } } if (!foundYear) { final Matcher matcher = YEAR_PATTERN.matcher(content); if (matcher.matches()) { foundYear = true; year = Integer.parseInt(matcher.group(1)); continue; } } } } catch (final NumberFormatException ignore) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } if (!foundTime || !foundDayOfMonth || !foundMonth || !foundYear) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } if (year >= 70 && year <= 99) { year = 1900 + year; } if (year >= 0 && year <= 69) { year = 2000 + year; } if (day < 1 || day > 31 || year < 1601 || hour > 23 || minute > 59 || second > 59) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } final Instant expiryDate = ZonedDateTime.of(year, month.getValue(), day, hour, minute, second, 0, ZoneId.of("UTC")).toInstant(); cookie.setExpiryDate(expiryDate); } private void skipDelims(final CharSequence buf, final Tokenizer.Cursor cursor) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); for (int i = indexFrom; i < indexTo; i++) { final char current = buf.charAt(i); if (DELIMS.get(current)) { pos++; } else { break; } } cursor.updatePos(pos); } private void copyContent(final CharSequence buf, final Tokenizer.Cursor cursor, final StringBuilder dst) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); for (int i = indexFrom; i < indexTo; i++) { final char current = buf.charAt(i); if (DELIMS.get(current)) { break; } pos++; dst.append(current); } cursor.updatePos(pos); } @Override public String getAttributeName() { return Cookie.EXPIRES_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/LaxMaxAgeHandler.java0100644 0000000 0000000 00000006121 00000250600 027570 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code max-age} attribute handler conformant to the more relaxed interpretation * of HTTP state management. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxMaxAgeHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link LaxMaxAgeHandler}. * * @since 5.2 */ public static final LaxMaxAgeHandler INSTANCE = new LaxMaxAgeHandler(); private final static Pattern MAX_AGE_PATTERN = Pattern.compile("^\\-?[0-9]+$"); public LaxMaxAgeHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { return; } final Matcher matcher = MAX_AGE_PATTERN.matcher(value); if (matcher.matches()) { final int age; try { age = Integer.parseInt(value); } catch (final NumberFormatException e) { return; } final Instant expiryDate = age >= 0 ? Instant.now().plusSeconds(age) : Instant.EPOCH; cookie.setExpiryDate(expiryDate); } } @Override public String getAttributeName() { return Cookie.MAX_AGE_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/PublicSuffixDomainFilter.java0100644 0000000 0000000 00000013352 00000250600 031370 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.psl.PublicSuffixList; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Wraps a {@link org.apache.hc.client5.http.cookie.CookieAttributeHandler} and leverages * its match method to never match a suffix from a black list. May be used to provide * additional security for cross-site attack types by preventing cookies from apparent * domains that are not publicly available. * * @see PublicSuffixList * @see PublicSuffixMatcher * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class PublicSuffixDomainFilter implements CommonCookieAttributeHandler { private static final Logger LOG = LoggerFactory.getLogger(PublicSuffixDomainFilter.class); private final CommonCookieAttributeHandler handler; private final PublicSuffixMatcher publicSuffixMatcher; private final Map localDomainMap; private static Map createLocalDomainMap() { final ConcurrentHashMap map = new ConcurrentHashMap<>(); map.put(".localhost.", Boolean.TRUE); // RFC 6761 map.put(".test.", Boolean.TRUE); // RFC 6761 map.put(".local.", Boolean.TRUE); // RFC 6762 map.put(".local", Boolean.TRUE); map.put(".localdomain", Boolean.TRUE); return map; } public PublicSuffixDomainFilter( final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher) { this.handler = Args.notNull(handler, "Cookie handler"); this.publicSuffixMatcher = Args.notNull(publicSuffixMatcher, "Public suffix matcher"); this.localDomainMap = createLocalDomainMap(); } public PublicSuffixDomainFilter( final CommonCookieAttributeHandler handler, final PublicSuffixList suffixList) { Args.notNull(handler, "Cookie handler"); Args.notNull(suffixList, "Public suffix list"); this.handler = handler; this.publicSuffixMatcher = new PublicSuffixMatcher(suffixList.getRules(), suffixList.getExceptions()); this.localDomainMap = createLocalDomainMap(); } private boolean verifyHost(final String host) { if (this.publicSuffixMatcher.verify(host)) { return true; } else { if (LOG.isDebugEnabled()) { LOG.debug("Public Suffix List verification failed for host '{}'", host); } return false; } } /** * Never matches if the cookie's domain is from the blacklist. */ @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { final String host = cookie.getDomain(); if (host == null) { return false; } final int i = host.indexOf('.'); if (i >= 0) { final String domain = host.substring(i); if (!this.localDomainMap.containsKey(domain)) { if (!verifyHost(host)) { return false; } } } else { if (!host.equalsIgnoreCase(origin.getHost())) { if (!verifyHost(host)) { return false; } } } return handler.match(cookie, origin); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { handler.parse(cookie, value); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { handler.validate(cookie, origin); } @Override public String getAttributeName() { return handler.getAttributeName(); } public static CommonCookieAttributeHandler decorate( final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher) { Args.notNull(handler, "Cookie attribute handler"); return publicSuffixMatcher != null ? new PublicSuffixDomainFilter(handler, publicSuffixMatcher) : handler; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpec.java0100644 0000000 0000000 00000025101 00000250600 027364 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.util.ArrayList; import java.util.Collections; import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookiePriorityComparator; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BufferedHeader; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; /** * Cookie management functions shared by RFC 6265 compliant specification. * * @since 4.5 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265CookieSpec implements CookieSpec { private final static char PARAM_DELIMITER = ';'; private final static char COMMA_CHAR = ','; private final static char EQUAL_CHAR = '='; private final static char DQUOTE_CHAR = '"'; private final static char ESCAPE_CHAR = '\\'; // IMPORTANT! // These private static variables must be treated as immutable and never exposed outside this class private static final Tokenizer.Delimiter TOKEN_DELIMS = Tokenizer.delimiters(EQUAL_CHAR, PARAM_DELIMITER); private static final Tokenizer.Delimiter VALUE_DELIMS = Tokenizer.delimiters(PARAM_DELIMITER); private static final Tokenizer.Delimiter SPECIAL_CHARS = Tokenizer.delimiters(' ', DQUOTE_CHAR, COMMA_CHAR, PARAM_DELIMITER, ESCAPE_CHAR); private final CookieAttributeHandler[] attribHandlers; private final Map attribHandlerMap; private final Tokenizer tokenParser; protected RFC6265CookieSpec(final CommonCookieAttributeHandler... handlers) { super(); this.attribHandlers = handlers.clone(); this.attribHandlerMap = new ConcurrentHashMap<>(handlers.length); for (final CommonCookieAttributeHandler handler: handlers) { this.attribHandlerMap.put(handler.getAttributeName().toLowerCase(Locale.ROOT), handler); } this.tokenParser = Tokenizer.INSTANCE; } static String getDefaultPath(final CookieOrigin origin) { String defaultPath = origin.getPath(); int lastSlashIndex = defaultPath.lastIndexOf('/'); if (lastSlashIndex >= 0) { if (lastSlashIndex == 0) { //Do not remove the very first slash lastSlashIndex = 1; } defaultPath = defaultPath.substring(0, lastSlashIndex); } return defaultPath; } static String getDefaultDomain(final CookieOrigin origin) { return origin.getHost(); } @Override public final List parse(final Header header, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(header, "Header"); Args.notNull(origin, "Cookie origin"); if (!header.getName().equalsIgnoreCase("Set-Cookie")) { throw new MalformedCookieException("Unrecognized cookie header: '" + header + "'"); } final CharArrayBuffer buffer; final Tokenizer.Cursor cursor; if (header instanceof FormattedHeader) { buffer = ((FormattedHeader) header).getBuffer(); cursor = new Tokenizer.Cursor(((FormattedHeader) header).getValuePos(), buffer.length()); } else { final String s = header.getValue(); if (s == null) { throw new MalformedCookieException("Header value is null"); } buffer = new CharArrayBuffer(s.length()); buffer.append(s); cursor = new Tokenizer.Cursor(0, buffer.length()); } final String name = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS); if (name.isEmpty()) { return Collections.emptyList(); } if (cursor.atEnd()) { return Collections.emptyList(); } final int valueDelim = buffer.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (valueDelim != '=') { throw new MalformedCookieException("Cookie value is invalid: '" + header + "'"); } final String value = tokenParser.parseValue(buffer, cursor, VALUE_DELIMS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setPath(getDefaultPath(origin)); cookie.setDomain(getDefaultDomain(origin)); cookie.setCreationDate(Instant.now()); final Map attribMap = new LinkedHashMap<>(); while (!cursor.atEnd()) { final String paramName = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS) .toLowerCase(Locale.ROOT); String paramValue = null; if (!cursor.atEnd()) { final int paramDelim = buffer.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (paramDelim == EQUAL_CHAR) { paramValue = tokenParser.parseToken(buffer, cursor, VALUE_DELIMS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } } } cookie.setAttribute(paramName, paramValue); attribMap.put(paramName, paramValue); } // Ignore 'Expires' if 'Max-Age' is present if (attribMap.containsKey(Cookie.MAX_AGE_ATTR)) { attribMap.remove(Cookie.EXPIRES_ATTR); } for (final Map.Entry entry: attribMap.entrySet()) { final String paramName = entry.getKey(); final String paramValue = entry.getValue(); final CookieAttributeHandler handler = this.attribHandlerMap.get(paramName); if (handler != null) { handler.parse(cookie, paramValue); } } return Collections.singletonList(cookie); } @Override public final void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: this.attribHandlers) { handler.validate(cookie, origin); } } @Override public final boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: this.attribHandlers) { if (!handler.match(cookie, origin)) { return false; } } return true; } @Override public List
formatCookies(final List cookies) { Args.notEmpty(cookies, "List of cookies"); final List sortedCookies; if (cookies.size() > 1) { // Create a mutable copy and sort the copy. sortedCookies = new ArrayList<>(cookies); sortedCookies.sort(CookiePriorityComparator.INSTANCE); } else { sortedCookies = cookies; } final CharArrayBuffer buffer = new CharArrayBuffer(20 * sortedCookies.size()); buffer.append("Cookie"); buffer.append(": "); for (int n = 0; n < sortedCookies.size(); n++) { final Cookie cookie = sortedCookies.get(n); if (n > 0) { buffer.append(PARAM_DELIMITER); buffer.append(' '); } buffer.append(cookie.getName()); final String s = cookie.getValue(); if (s != null) { buffer.append(EQUAL_CHAR); if (containsSpecialChar(s)) { buffer.append(DQUOTE_CHAR); for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (ch == DQUOTE_CHAR || ch == ESCAPE_CHAR) { buffer.append(ESCAPE_CHAR); } buffer.append(ch); } buffer.append(DQUOTE_CHAR); } else { buffer.append(s); } } } final List
headers = new ArrayList<>(1); try { headers.add(new BufferedHeader(buffer)); } catch (final ParseException ignore) { // should never happen } return headers; } boolean containsSpecialChar(final CharSequence s) { return containsChars(s, SPECIAL_CHARS); } boolean containsChars(final CharSequence s, final Tokenizer.Delimiter chars) { for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (chars.test(ch)) { return true; } } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpecBase.java0100644 0000000 0000000 00000002701 00000250600 030160 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; class RFC6265CookieSpecBase extends RFC6265CookieSpec { RFC6265CookieSpecBase(final CommonCookieAttributeHandler... handlers) { super(handlers); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpecFactory.java0100644 0000000 0000000 00000013256 00000250600 030724 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link CookieSpecFactory} implementation that provides an instance of * RFC 6265 conformant cookie policy. The instance returned by this factory * can be shared by multiple threads. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265CookieSpecFactory implements CookieSpecFactory { private final ReentrantLock lock; public enum CompatibilityLevel { STRICT, RELAXED, IE_MEDIUM_SECURITY } private final CompatibilityLevel compatibilityLevel; private final PublicSuffixMatcher publicSuffixMatcher; private volatile CookieSpec cookieSpec; public RFC6265CookieSpecFactory( final CompatibilityLevel compatibilityLevel, final PublicSuffixMatcher publicSuffixMatcher) { super(); this.compatibilityLevel = compatibilityLevel != null ? compatibilityLevel : CompatibilityLevel.RELAXED; this.publicSuffixMatcher = publicSuffixMatcher; this.lock = new ReentrantLock(); } public RFC6265CookieSpecFactory(final PublicSuffixMatcher publicSuffixMatcher) { this(CompatibilityLevel.RELAXED, publicSuffixMatcher); } public RFC6265CookieSpecFactory() { this(CompatibilityLevel.RELAXED, null); } @Override public CookieSpec create(final HttpContext context) { if (cookieSpec == null) { lock.lock(); try { if (cookieSpec == null) { switch (this.compatibilityLevel) { case STRICT: this.cookieSpec = new RFC6265StrictSpec( BasicPathHandler.INSTANCE, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); break; case IE_MEDIUM_SECURITY: this.cookieSpec = new RFC6265LaxSpec( new BasicPathHandler() { @Override public void validate( final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { // No validation } }, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); break; default: this.cookieSpec = new RFC6265LaxSpec( BasicPathHandler.INSTANCE, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), LaxMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, LaxExpiresHandler.INSTANCE); } } } finally { lock.unlock(); } } return this.cookieSpec; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265LaxSpec.java0100644 0000000 0000000 00000004447 00000250600 026711 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Standard {@link org.apache.hc.client5.http.cookie.CookieSpec} implementation that enforces * a more relaxed interpretation of the HTTP state management specification (RFC 6265, section 5) * for interoperability with existing servers that do not conform to the well behaved profile * (RFC 6265, section 4). * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265LaxSpec extends RFC6265CookieSpecBase { public RFC6265LaxSpec() { super(BasicPathHandler.INSTANCE, BasicDomainHandler.INSTANCE, LaxMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, LaxExpiresHandler.INSTANCE); } RFC6265LaxSpec(final CommonCookieAttributeHandler... handlers) { super(handlers); } @Override public String toString() { return "rfc6265-lax"; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265StrictSpec.java0100644 0000000 0000000 00000004441 00000250600 027427 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Standard {@link org.apache.hc.client5.http.cookie.CookieSpec} implementation * that enforces syntax and semantics of the well-behaved profile of the HTTP * state management specification (RFC 6265, section 4). * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265StrictSpec extends RFC6265CookieSpecBase { public RFC6265StrictSpec() { super(BasicPathHandler.INSTANCE, BasicDomainHandler.INSTANCE, BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); } RFC6265StrictSpec(final CommonCookieAttributeHandler... handlers) { super(handlers); } @Override public String toString() { return "rfc6265-strict"; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/package-info.java0100644 0000000 0000000 00000002421 00000250600 027006 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard and common HTTP cookie management policies. */ package org.apache.hc.client5.http.impl.cookie; httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/0040755 0000000 0000000 00000000000 00000250600 022761 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/BasicHttpClientConnectionManager.java0100644 0000000 0000000 00000063556 00000250600 032173 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.time.Instant; import java.util.Objects; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * A connection manager for a single connection. This connection manager maintains only one active * connection. Even though this class is fully thread-safe it ought to be used by one execution * thread only, as only one thread a time can lease the connection at a time. *

* This connection manager will make an effort to reuse the connection for subsequent requests * with the same {@link HttpRoute route}. It will, however, close the existing connection and * open it for the given route, if the route of the persistent connection does not match that * of the connection request. If the connection has been already been allocated * {@link IllegalStateException} is thrown. *

*

* This connection manager implementation should be used inside an EJB container instead of * {@link PoolingHttpClientConnectionManager}. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicHttpClientConnectionManager implements HttpClientConnectionManager { private static final Logger LOG = LoggerFactory.getLogger(BasicHttpClientConnectionManager.class); private static final AtomicLong COUNT = new AtomicLong(0); private final HttpClientConnectionOperator connectionOperator; private final HttpConnectionFactory connFactory; private final String id; private final ReentrantLock lock; private ManagedHttpClientConnection conn; private HttpRoute route; private Object state; private long created; private long updated; private long expiry; private boolean leased; private SocketConfig socketConfig; private ConnectionConfig connectionConfig; private TlsConfig tlsConfig; private final AtomicBoolean closed; /** * @since 4.4 */ public BasicHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final HttpConnectionFactory connFactory) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.id = String.format("ep-%010d", COUNT.getAndIncrement()); this.expiry = Long.MAX_VALUE; this.socketConfig = SocketConfig.DEFAULT; this.connectionConfig = ConnectionConfig.DEFAULT; this.tlsConfig = TlsConfig.DEFAULT; this.closed = new AtomicBoolean(false); this.lock = new ReentrantLock(); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyRegistry, final HttpConnectionFactory connFactory) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(schemePortResolver, dnsResolver, tlsSocketStrategyRegistry), connFactory); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final Lookup tlsSocketStrategyRegistry, final HttpConnectionFactory connFactory) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(null, null, tlsSocketStrategyRegistry), connFactory); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final Lookup tlsSocketStrategyRegistry) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(null, null, tlsSocketStrategyRegistry), null); } /** * @deprecated Use {@link #create(SchemePortResolver, DnsResolver, Lookup, HttpConnectionFactory)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry, final HttpConnectionFactory connFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this(new DefaultHttpClientConnectionOperator( socketFactoryRegistry, schemePortResolver, dnsResolver), connFactory); } /** * @deprecated Use {@link #create(Lookup, HttpConnectionFactory)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, connFactory, null, null); } /** * @deprecated Use {@link #create(Lookup)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry) { this(socketFactoryRegistry, null, null, null); } public BasicHttpClientConnectionManager() { this(new DefaultHttpClientConnectionOperator(null, null, RegistryBuilder.create() .register(URIScheme.HTTPS.id, DefaultClientTlsStrategy.createDefault()) .build()), null); } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { closeConnection(closeMode); } } HttpRoute getRoute() { return route; } Object getState() { return state; } public SocketConfig getSocketConfig() { lock.lock(); try { return socketConfig; } finally { lock.unlock(); } } public void setSocketConfig(final SocketConfig socketConfig) { lock.lock(); try { this.socketConfig = socketConfig != null ? socketConfig : SocketConfig.DEFAULT; } finally { lock.unlock(); } } /** * @since 5.2 */ public ConnectionConfig getConnectionConfig() { lock.lock(); try { return connectionConfig; } finally { lock.unlock(); } } /** * @since 5.2 */ public void setConnectionConfig(final ConnectionConfig connectionConfig) { lock.lock(); try { this.connectionConfig = connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } finally { lock.unlock(); } } /** * @since 5.2 */ public TlsConfig getTlsConfig() { lock.lock(); try { return tlsConfig; } finally { lock.unlock(); } } /** * @since 5.2 */ public void setTlsConfig(final TlsConfig tlsConfig) { lock.lock(); try { this.tlsConfig = tlsConfig != null ? tlsConfig : TlsConfig.DEFAULT; } finally { lock.unlock(); } } public LeaseRequest lease(final String id, final HttpRoute route, final Object state) { return lease(id, route, Timeout.DISABLED, state); } @Override public LeaseRequest lease(final String id, final HttpRoute route, final Timeout requestTimeout, final Object state) { return new LeaseRequest() { @Override public ConnectionEndpoint get( final Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException { try { return new InternalConnectionEndpoint(route, getConnection(route, state)); } catch (final IOException ex) { throw new ExecutionException(ex.getMessage(), ex); } } @Override public boolean cancel() { return false; } }; } private void closeConnection(final CloseMode closeMode) { lock.lock(); try { if (this.conn != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Closing connection {}", id, closeMode); } this.conn.close(closeMode); this.conn = null; } } finally { lock.unlock(); } } private void checkExpiry() { if (this.conn != null && System.currentTimeMillis() >= this.expiry) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection expired @ {}", id, Instant.ofEpochMilli(this.expiry)); } closeConnection(CloseMode.GRACEFUL); } } private void validate() { if (this.conn != null) { final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (TimeValue.isNonNegative(timeToLive)) { final Deadline deadline = Deadline.calculate(created, timeToLive); if (deadline.isExpired()) { closeConnection(CloseMode.GRACEFUL); } } } if (this.conn != null) { final TimeValue timeValue = connectionConfig.getValidateAfterInactivity() != null ? connectionConfig.getValidateAfterInactivity() : TimeValue.ofSeconds(2); if (TimeValue.isNonNegative(timeValue)) { final Deadline deadline = Deadline.calculate(updated, timeValue); if (deadline.isExpired()) { boolean stale; try { stale = conn.isStale(); } catch (final IOException ignore) { stale = true; } if (stale) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(conn)); } closeConnection(CloseMode.GRACEFUL); } } } } } ManagedHttpClientConnection getConnection(final HttpRoute route, final Object state) throws IOException { lock.lock(); try { Asserts.check(!isClosed(), "Connection manager has been shut down"); if (LOG.isDebugEnabled()) { LOG.debug("{} Get connection for route {}", id, route); } Asserts.check(!this.leased, "Connection %s is still allocated", conn); if (!Objects.equals(this.route, route) || !Objects.equals(this.state, state)) { closeConnection(CloseMode.GRACEFUL); } this.route = route; this.state = state; checkExpiry(); validate(); if (this.conn == null) { this.conn = this.connFactory.createConnection(null); this.created = System.currentTimeMillis(); } else { this.conn.activate(); if (connectionConfig.getSocketTimeout() != null) { conn.setSocketTimeout(connectionConfig.getSocketTimeout()); } } this.leased = true; if (LOG.isDebugEnabled()) { LOG.debug("{} Using connection {}", id, conn); } return this.conn; } finally { lock.unlock(); } } private InternalConnectionEndpoint cast(final ConnectionEndpoint endpoint) { if (endpoint instanceof InternalConnectionEndpoint) { return (InternalConnectionEndpoint) endpoint; } throw new IllegalStateException("Unexpected endpoint class: " + endpoint.getClass()); } @Override public void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) { lock.lock(); try { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final ManagedHttpClientConnection conn = internalEndpoint.detach(); if (LOG.isDebugEnabled()) { LOG.debug("{} Releasing connection {}", id, conn); } if (isClosed()) { return; } try { if (keepAlive == null && conn != null) { conn.close(CloseMode.GRACEFUL); } this.updated = System.currentTimeMillis(); if (conn != null && conn.isOpen() && conn.isConsistent()) { this.state = state; conn.passivate(); if (TimeValue.isPositive(keepAlive)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection can be kept alive for {}", id, keepAlive); } this.expiry = this.updated + keepAlive.toMilliseconds(); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection can be kept alive indefinitely", id); } this.expiry = Long.MAX_VALUE; } } else { this.route = null; this.conn = null; this.expiry = Long.MAX_VALUE; if (LOG.isDebugEnabled()) { LOG.debug("{} Connection is not kept alive", id); } } } finally { this.leased = false; } } finally { lock.unlock(); } } @Override public void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException { lock.lock(); try { Args.notNull(endpoint, "Endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); if (internalEndpoint.isConnected()) { return; } final HttpRoute route = internalEndpoint.getRoute(); final HttpHost firstHop = route.getProxyHost() != null ? route.getProxyHost() : route.getTargetHost(); final Timeout connectTimeout = timeout != null ? Timeout.of(timeout.getDuration(), timeout.getTimeUnit()) : connectionConfig.getConnectTimeout(); final ManagedHttpClientConnection connection = internalEndpoint.getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting endpoint to {} ({})", ConnPoolSupport.getId(endpoint), firstHop, connectTimeout); } this.connectionOperator.connect( connection, firstHop, route.getTargetName(), route.getLocalSocketAddress(), connectTimeout, socketConfig, route.isTunnelled() ? null : tlsConfig, context); if (LOG.isDebugEnabled()) { LOG.debug("{} connected {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn)); } final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { connection.setSocketTimeout(socketTimeout); } } finally { lock.unlock(); } } @Override public void upgrade( final ConnectionEndpoint endpoint, final HttpContext context) throws IOException { lock.lock(); try { Args.notNull(endpoint, "Endpoint"); Args.notNull(route, "HTTP route"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final HttpRoute route = internalEndpoint.getRoute(); this.connectionOperator.upgrade( internalEndpoint.getConnection(), route.getTargetHost(), route.getTargetName(), tlsConfig, context); } finally { lock.unlock(); } } public void closeExpired() { lock.lock(); try { if (isClosed()) { return; } if (!this.leased) { checkExpiry(); } } finally { lock.unlock(); } } public void closeIdle(final TimeValue idleTime) { lock.lock(); try { Args.notNull(idleTime, "Idle time"); if (isClosed()) { return; } if (!this.leased) { long time = idleTime.toMilliseconds(); if (time < 0) { time = 0; } final long deadline = System.currentTimeMillis() - time; if (this.updated <= deadline) { closeConnection(CloseMode.GRACEFUL); } } } finally { lock.unlock(); } } /** * @see #setValidateAfterInactivity(TimeValue) * * @since 5.1 * * @deprecated Use {@link #getConnectionConfig()} */ @Deprecated public TimeValue getValidateAfterInactivity() { return connectionConfig.getValidateAfterInactivity(); } /** * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object)} leased} to the consumer. * Negative values passed to this method disable connection validation. This check helps * detect connections that have become stale (half-closed) while kept inactive in the pool. * * @since 5.1 * * @deprecated Use {@link #setConnectionConfig(ConnectionConfig)} */ @Deprecated public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) { this.connectionConfig = ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build(); } class InternalConnectionEndpoint extends ConnectionEndpoint implements ConnectionHolder, Identifiable { private final HttpRoute route; private final AtomicReference connRef; public InternalConnectionEndpoint(final HttpRoute route, final ManagedHttpClientConnection conn) { this.route = route; this.connRef = new AtomicReference<>(conn); } @Override public String getId() { return id; } HttpRoute getRoute() { return route; } ManagedHttpClientConnection getConnection() { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn == null) { throw new ConnectionShutdownException(); } return conn; } ManagedHttpClientConnection getValidatedConnection() { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn == null || !conn.isOpen()) { throw new ConnectionShutdownException(); } return conn; } ManagedHttpClientConnection detach() { return this.connRef.getAndSet(null); } @Override public boolean isConnected() { final ManagedHttpClientConnection conn = this.connRef.get(); return conn != null && conn.isOpen(); } @Override public void close(final CloseMode closeMode) { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn != null) { conn.close(closeMode); } } @Override public void close() throws IOException { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn != null) { conn.close(); } } @Override public void setSocketTimeout(final Timeout timeout) { getValidatedConnection().setSocketTimeout(timeout); } /** * @deprecated Use {@link #execute(String, ClassicHttpRequest, RequestExecutor, HttpContext)} */ @Deprecated @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final HttpRequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); if (LOG.isDebugEnabled()) { LOG.debug("{} Executing exchange {}", id, exchangeId); } return requestExecutor.execute(request, getValidatedConnection(), context); } /** * @since 5.4 */ @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); if (LOG.isDebugEnabled()) { LOG.debug("{} Executing exchange {}", id, exchangeId); } return requestExecutor.execute(request, getValidatedConnection(), context); } /** * @since 5.4 */ @Override public EndpointInfo getInfo() { final ManagedHttpClientConnection connection = this.connRef.get(); if (connection != null && connection.isOpen()) { return new EndpointInfo(connection.getProtocolVersion(), connection.getSSLSession()); } return null; } @Override public HttpConnection get() { return this.connRef.get(); } } /** * Method that can be called to determine whether the connection manager has been shut down and * is closed or not. * * @return {@code true} if the connection manager has been shut down and is closed, otherwise * return {@code false}. * @since 5.4 */ public boolean isClosed() { return this.closed.get(); } } ././@LongLink0100644 0000000 0000000 00000000146 00000250600 011612 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpClientConnectionOperator.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpClientConnectionOperator.jav0100644 0000000 0000000 00000045333 00000250600 032607 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.net.SocketAddress; import java.nio.file.Path; import java.util.Arrays; import java.util.Collections; import java.util.List; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.ConnectExceptionSupport; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.UnsupportedSchemeException; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.io.DetachedSocketFactory; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.socket.UnixDomainSocketFactory; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import jdk.net.ExtendedSocketOptions; import jdk.net.Sockets; /** * Default implementation of {@link HttpClientConnectionOperator} used as default in Http client, * when no instance provided by user to {@link BasicHttpClientConnectionManager} or {@link * PoolingHttpClientConnectionManager} constructor. * * @since 4.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpClientConnectionOperator implements HttpClientConnectionOperator { private static final Logger LOG = LoggerFactory.getLogger(DefaultHttpClientConnectionOperator.class); @SuppressWarnings("Since15") private static final boolean SUPPORTS_KEEPALIVE_OPTIONS = Sockets.supportedOptions(Socket.class) .containsAll(Arrays.asList(ExtendedSocketOptions.TCP_KEEPIDLE, ExtendedSocketOptions.TCP_KEEPINTERVAL, ExtendedSocketOptions.TCP_KEEPCOUNT)); static final DetachedSocketFactory PLAIN_SOCKET_FACTORY = socksProxy -> socksProxy == null ? new Socket() : new Socket(socksProxy); private final DetachedSocketFactory detachedSocketFactory; private final UnixDomainSocketFactory unixDomainSocketFactory = UnixDomainSocketFactory.getSocketFactory(); private final Lookup tlsSocketStrategyLookup; private final SchemePortResolver schemePortResolver; private final DnsResolver dnsResolver; /** * @deprecated Provided for backward compatibility */ @Deprecated static Lookup adapt(final Lookup lookup) { return name -> { final org.apache.hc.client5.http.socket.ConnectionSocketFactory sf = lookup.lookup(name); return sf instanceof org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory ? (socket, target, port, attachment, context) -> (SSLSocket) ((org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory) sf).createLayeredSocket(socket, target, port, attachment, context) : null; }; } public DefaultHttpClientConnectionOperator( final DetachedSocketFactory detachedSocketFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyLookup) { super(); this.detachedSocketFactory = Args.notNull(detachedSocketFactory, "Plain socket factory"); this.tlsSocketStrategyLookup = Args.notNull(tlsSocketStrategyLookup, "Socket factory registry"); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.dnsResolver = dnsResolver != null ? dnsResolver : SystemDefaultDnsResolver.INSTANCE; } /** * @deprecated Do not use. */ @Deprecated public DefaultHttpClientConnectionOperator( final Lookup socketFactoryRegistry, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this(PLAIN_SOCKET_FACTORY, schemePortResolver, dnsResolver, adapt(socketFactoryRegistry)); } public DefaultHttpClientConnectionOperator( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyLookup) { this(PLAIN_SOCKET_FACTORY, schemePortResolver, dnsResolver, tlsSocketStrategyLookup); } @Override public void connect( final ManagedHttpClientConnection conn, final HttpHost host, final InetSocketAddress localAddress, final TimeValue connectTimeout, final SocketConfig socketConfig, final HttpContext context) throws IOException { final Timeout timeout = connectTimeout != null ? Timeout.of(connectTimeout.getDuration(), connectTimeout.getTimeUnit()) : null; connect(conn, host, null, localAddress, timeout, socketConfig, null, context); } @Override public void connect( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final InetSocketAddress localAddress, final Timeout connectTimeout, final SocketConfig socketConfig, final Object attachment, final HttpContext context) throws IOException { connect(conn, endpointHost, endpointName, null, localAddress, connectTimeout, socketConfig, attachment, context); } @Override public void connect( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final Path unixDomainSocket, final InetSocketAddress localAddress, final Timeout connectTimeout, final SocketConfig socketConfig, final Object attachment, final HttpContext context) throws IOException { Args.notNull(conn, "Connection"); Args.notNull(endpointHost, "Host"); Args.notNull(socketConfig, "Socket config"); Args.notNull(context, "Context"); final SocketAddress socksProxyAddress = socketConfig.getSocksProxyAddress(); final Proxy socksProxy = socksProxyAddress != null ? new Proxy(Proxy.Type.SOCKS, socksProxyAddress) : null; if (unixDomainSocket != null) { connectToUnixDomainSocket(conn, endpointHost, endpointName, attachment, unixDomainSocket, connectTimeout, socketConfig, context); return; } final List remoteAddresses; if (endpointHost.getAddress() != null) { remoteAddresses = Collections.singletonList( new InetSocketAddress(endpointHost.getAddress(), this.schemePortResolver.resolve(endpointHost.getSchemeName(), endpointHost))); } else { final int port = this.schemePortResolver.resolve(endpointHost.getSchemeName(), endpointHost); remoteAddresses = this.dnsResolver.resolve(endpointHost.getHostName(), port); } for (int i = 0; i < remoteAddresses.size(); i++) { final InetSocketAddress remoteAddress = remoteAddresses.get(i); final boolean last = i == remoteAddresses.size() - 1; onBeforeSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting {}->{} ({})", endpointHost, localAddress, remoteAddress, connectTimeout); } final Socket socket = detachedSocketFactory.create(endpointHost.getSchemeName(), socksProxy); try { // Always bind to the local address if it's provided. if (localAddress != null) { socket.bind(localAddress); } conn.bind(socket); configureSocket(socket, socketConfig, true); socket.connect(remoteAddress, TimeValue.isPositive(connectTimeout) ? connectTimeout.toMillisecondsIntBound() : 0); conn.bind(socket); onAfterSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} connected {}->{}", ConnPoolSupport.getId(conn), endpointHost, conn.getLocalAddress(), conn.getRemoteAddress()); } final TlsSocketStrategy tlsSocketStrategy = tlsSocketStrategyLookup != null ? tlsSocketStrategyLookup.lookup(endpointHost.getSchemeName()) : null; if (tlsSocketStrategy != null) { upgradeToTls(conn, endpointHost, endpointName, connectTimeout, attachment, context, tlsSocketStrategy, socket); } return; } catch (final RuntimeException ex) { Closer.closeQuietly(socket); throw ex; } catch (final IOException ex) { Closer.closeQuietly(socket); if (last) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection to {} failed ({}); terminating operation", endpointHost, remoteAddress, ex.getClass()); } throw ConnectExceptionSupport.enhance(ex, endpointHost); } if (LOG.isDebugEnabled()) { LOG.debug("{} connection to {} failed ({}); retrying connection to the next address", endpointHost, remoteAddress, ex.getClass()); } } } } private void upgradeToTls(final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final Timeout connectTimeout, final Object attachment, final HttpContext context, final TlsSocketStrategy tlsSocketStrategy, final Socket socket) throws IOException { final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; onBeforeTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgrading to TLS", ConnPoolSupport.getId(conn), tlsName); } final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; final int soTimeout = socket.getSoTimeout(); final Timeout handshakeTimeout = tlsConfig.getHandshakeTimeout() != null ? tlsConfig.getHandshakeTimeout() : connectTimeout; if (handshakeTimeout != null) { socket.setSoTimeout(handshakeTimeout.toMillisecondsIntBound()); } final SSLSocket sslSocket = tlsSocketStrategy.upgrade(socket, tlsName.getHostName(), tlsName.getPort(), attachment, context); socket.setSoTimeout(soTimeout); conn.bind(sslSocket, socket); onAfterTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgraded to TLS", ConnPoolSupport.getId(conn), tlsName); } } private void connectToUnixDomainSocket( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final Object attachment, final Path unixDomainSocket, final Timeout connectTimeout, final SocketConfig socketConfig, final HttpContext context) throws IOException { onBeforeSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting to {} ({})", endpointHost, unixDomainSocket, connectTimeout); } final Socket newSocket = unixDomainSocketFactory.createSocket(); try { conn.bind(newSocket); final Socket socket = unixDomainSocketFactory.connectSocket(newSocket, unixDomainSocket, connectTimeout); configureSocket(socket, socketConfig, false); conn.bind(socket); onAfterSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} connected to {}", ConnPoolSupport.getId(conn), endpointHost, unixDomainSocket); } final TlsSocketStrategy tlsSocketStrategy = tlsSocketStrategyLookup != null ? tlsSocketStrategyLookup.lookup(endpointHost.getSchemeName()) : null; if (tlsSocketStrategy != null) { upgradeToTls(conn, endpointHost, endpointName, connectTimeout, attachment, context, tlsSocketStrategy, socket); } } catch (final RuntimeException ex) { Closer.closeQuietly(newSocket); throw ex; } catch (final IOException ex) { Closer.closeQuietly(newSocket); if (LOG.isDebugEnabled()) { LOG.debug("{} connection to {} failed ({}); terminating operation", endpointHost, unixDomainSocket, ex.getClass()); } throw ex; } } @SuppressWarnings("Since15") private static void configureSocket( final Socket socket, final SocketConfig socketConfig, final boolean isTcp ) throws IOException { final Timeout socketTimeout = socketConfig.getSoTimeout(); if (socketTimeout != null) { socket.setSoTimeout(socketTimeout.toMillisecondsIntBound()); } if (socketConfig.getRcvBufSize() > 0) { socket.setReceiveBufferSize(socketConfig.getRcvBufSize()); } if (socketConfig.getSndBufSize() > 0) { socket.setSendBufferSize(socketConfig.getSndBufSize()); } final int linger = socketConfig.getSoLinger().toMillisecondsIntBound(); if (linger >= 0) { socket.setSoLinger(true, linger); } if (isTcp) { socket.setReuseAddress(socketConfig.isSoReuseAddress()); socket.setTcpNoDelay(socketConfig.isTcpNoDelay()); socket.setKeepAlive(socketConfig.isSoKeepAlive()); if (SUPPORTS_KEEPALIVE_OPTIONS) { if (socketConfig.getTcpKeepIdle() > 0) { Sockets.setOption(socket, ExtendedSocketOptions.TCP_KEEPIDLE, socketConfig.getTcpKeepIdle()); } if (socketConfig.getTcpKeepInterval() > 0) { Sockets.setOption(socket, ExtendedSocketOptions.TCP_KEEPINTERVAL, socketConfig.getTcpKeepInterval()); } if (socketConfig.getTcpKeepCount() > 0) { Sockets.setOption(socket, ExtendedSocketOptions.TCP_KEEPCOUNT, socketConfig.getTcpKeepCount()); } } } } @Override public void upgrade( final ManagedHttpClientConnection conn, final HttpHost host, final HttpContext context) throws IOException { upgrade(conn, host, null, null, context); } @Override public void upgrade( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final Object attachment, final HttpContext context) throws IOException { final Socket socket = conn.getSocket(); if (socket == null) { throw new ConnectionClosedException("Connection is closed"); } final String newProtocol = URIScheme.HTTP.same(endpointHost.getSchemeName()) ? URIScheme.HTTPS.id : endpointHost.getSchemeName(); final TlsSocketStrategy tlsSocketStrategy = tlsSocketStrategyLookup != null ? tlsSocketStrategyLookup.lookup(newProtocol) : null; if (tlsSocketStrategy != null) { final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; onBeforeTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} upgrading to TLS {}:{}", ConnPoolSupport.getId(conn), tlsName.getHostName(), tlsName.getPort()); } final SSLSocket upgradedSocket = tlsSocketStrategy.upgrade(socket, tlsName.getHostName(), tlsName.getPort(), attachment, context); conn.bind(upgradedSocket, socket); onAfterTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} upgraded to TLS {}:{}", ConnPoolSupport.getId(conn), tlsName.getHostName(), tlsName.getPort()); } } else { throw new UnsupportedSchemeException(newProtocol + " protocol is not supported"); } } protected void onBeforeSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onBeforeTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpResponseParserFactory.java0100644 0000000 0000000 00000007614 00000250600 032301 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpResponseFactory; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory; import org.apache.hc.core5.http.io.HttpMessageParser; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.message.BasicLineParser; import org.apache.hc.core5.http.message.LineParser; /** * Default factory for response message parsers. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpResponseParserFactory implements HttpMessageParserFactory { /** * Default instance DefaultHttpResponseParserFactory. */ public static final DefaultHttpResponseParserFactory INSTANCE = new DefaultHttpResponseParserFactory(); private final Http1Config h1Config; private final LineParser lineParser; private final HttpResponseFactory responseFactory; /** * @since 5.4 */ public DefaultHttpResponseParserFactory( final Http1Config h1Config, final LineParser lineParser, final HttpResponseFactory responseFactory) { super(); this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.lineParser = lineParser != null ? lineParser : BasicLineParser.INSTANCE; this.responseFactory = responseFactory != null ? responseFactory : DefaultClassicHttpResponseFactory.INSTANCE; } /** * @since 5.4 */ public DefaultHttpResponseParserFactory(final Http1Config h1Config) { this(h1Config, null, null); } public DefaultHttpResponseParserFactory( final LineParser lineParser, final HttpResponseFactory responseFactory) { this(null, lineParser, responseFactory); } public DefaultHttpResponseParserFactory(final HttpResponseFactory responseFactory) { this(null, null, responseFactory); } public DefaultHttpResponseParserFactory() { this(null, null, null); } @Override public HttpMessageParser create() { return new LenientHttpResponseParser(this.lineParser, this.responseFactory, h1Config); } /** * @deprecated Use {@link #create()} */ @Deprecated @Override public HttpMessageParser create(final Http1Config h1Config) { return new LenientHttpResponseParser(this.lineParser, this.responseFactory, h1Config); } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultManagedHttpClientConnection.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultManagedHttpClientConnection.java0100644 0000000 0000000 00000020505 00000250600 032503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.InterruptedIOException; import java.net.Socket; import java.nio.charset.CharsetDecoder; import java.nio.charset.CharsetEncoder; import java.util.concurrent.atomic.AtomicBoolean; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentLengthStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultBHttpClientConnection; import org.apache.hc.core5.http.impl.io.SocketHolder; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.io.HttpMessageWriterFactory; import org.apache.hc.core5.http.io.ResponseOutOfOrderStrategy; import org.apache.hc.core5.http.message.RequestLine; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Internal public class DefaultManagedHttpClientConnection extends DefaultBHttpClientConnection implements ManagedHttpClientConnection, Identifiable { private static final Logger LOG = LoggerFactory.getLogger(DefaultManagedHttpClientConnection.class); private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger WIRE_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.wire"); private final String id; private final AtomicBoolean closed; private Timeout socketTimeout; public DefaultManagedHttpClientConnection( final String id, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final Http1Config h1Config, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { super( h1Config, charDecoder, charEncoder, incomingContentStrategy, outgoingContentStrategy, responseOutOfOrderStrategy, requestWriterFactory, responseParserFactory); this.id = id; this.closed = new AtomicBoolean(); } public DefaultManagedHttpClientConnection( final String id, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final Http1Config h1Config, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { this( id, charDecoder, charEncoder, h1Config, incomingContentStrategy, outgoingContentStrategy, null, requestWriterFactory, responseParserFactory); } public DefaultManagedHttpClientConnection(final String id) { this(id, null, null, null, null, null, null, null); } @Override public String getId() { return this.id; } @Override public void bind(final SocketHolder socketHolder) throws IOException { if (this.closed.get()) { final Socket socket = socketHolder.getSocket(); socket.close(); // allow this to throw... // ...but if it doesn't, explicitly throw one ourselves. throw new InterruptedIOException("Connection already shutdown"); } super.bind(socketHolder); socketTimeout = Timeout.ofMilliseconds(socketHolder.getSocket().getSoTimeout()); } @Override public Socket getSocket() { final SocketHolder socketHolder = getSocketHolder(); return socketHolder != null ? socketHolder.getSocket() : null; } @Override public SSLSession getSSLSession() { final Socket socket = getSocket(); if (socket instanceof SSLSocket) { return ((SSLSocket) socket).getSession(); } return null; } @Override public void close() throws IOException { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Close connection", this.id); } super.close(); } } @Override public void setSocketTimeout(final Timeout timeout) { if (LOG.isDebugEnabled()) { LOG.debug("{} set socket timeout to {}", this.id, timeout); } super.setSocketTimeout(timeout); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} close connection {}", this.id, closeMode); } super.close(closeMode); } } @Override public void bind(final Socket socket) throws IOException { super.bind(WIRE_LOG.isDebugEnabled() ? new LoggingSocketHolder(socket, this.id, WIRE_LOG) : new SocketHolder(socket)); socketTimeout = Timeout.ofMilliseconds(socket.getSoTimeout()); } @Override public void bind(final SSLSocket sslSocket, final Socket socket) throws IOException { super.bind(WIRE_LOG.isDebugEnabled() ? new LoggingSocketHolder(sslSocket, socket, this.id, WIRE_LOG) : new SocketHolder(sslSocket, socket)); socketTimeout = Timeout.ofMilliseconds(sslSocket.getSoTimeout()); } @Override protected void onResponseReceived(final ClassicHttpResponse response) { if (response != null && HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} << {}", this.id, new StatusLine(response)); final Header[] headers = response.getHeaders(); for (final Header header : headers) { HEADER_LOG.debug("{} << {}", this.id, header); } } } @Override protected void onRequestSubmitted(final ClassicHttpRequest request) { if (request != null && HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} >> {}", this.id, new RequestLine(request)); final Header[] headers = request.getHeaders(); for (final Header header : headers) { HEADER_LOG.debug("{} >> {}", this.id, header); } } } @Override public void passivate() { super.setSocketTimeout(Timeout.ZERO_MILLISECONDS); } @Override public void activate() { super.setSocketTimeout(socketTimeout); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LenientHttpResponseParser.java0100644 0000000 0000000 00000007022 00000250600 030754 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponseFactory; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParser; import org.apache.hc.core5.http.message.LineParser; import org.apache.hc.core5.util.CharArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Lenient HTTP response parser implementation that can skip malformed data until * a valid HTTP response message head is encountered. * * @since 4.2 */ public class LenientHttpResponseParser extends DefaultHttpResponseParser { private static final Logger LOG = LoggerFactory.getLogger(LenientHttpResponseParser.class); /** * Creates new instance of DefaultHttpResponseParser. * * @param lineParser the line parser. If {@code null} * {@link org.apache.hc.core5.http.message.BasicLineParser#INSTANCE} will be used. * @param responseFactory HTTP response factory. If {@code null} * {@link org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory#INSTANCE} * will be used. * @param h1Config HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used. * * @since 4.3 */ public LenientHttpResponseParser( final LineParser lineParser, final HttpResponseFactory responseFactory, final Http1Config h1Config) { super(h1Config, lineParser, responseFactory); } /** * Creates new instance of DefaultHttpResponseParser. * * @param h1Config HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used. * * @since 4.3 */ public LenientHttpResponseParser(final Http1Config h1Config) { this(null, null, h1Config); } @Override protected ClassicHttpResponse createMessage(final CharArrayBuffer buffer) throws IOException { try { return super.createMessage(buffer); } catch (final HttpException ex) { if (LOG.isDebugEnabled()) { LOG.debug("Garbage in response: {}", buffer); } return null; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingInputStream.java0100644 0000000 0000000 00000007363 00000250600 027414 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import org.apache.hc.client5.http.impl.Wire; /** * Delegates {@link InputStream} calls and logs to a {@link Wire}. */ class LoggingInputStream extends FilterInputStream { private final Wire wire; LoggingInputStream(final InputStream in, final Wire wire) { super(in); this.wire = wire; } @Override public int read() throws IOException { try { final int b = in.read(); if (b == -1) { wire.input("end of stream"); } else { wire.input(b); } return b; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public int read(final byte[] b) throws IOException { try { final int bytesRead = in.read(b); if (bytesRead == -1) { wire.input("end of stream"); } else if (bytesRead > 0) { wire.input(b, 0, bytesRead); } return bytesRead; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public int read(final byte[] b, final int off, final int len) throws IOException { try { final int bytesRead = in.read(b, off, len); if (bytesRead == -1) { wire.input("end of stream"); } else if (bytesRead > 0) { wire.input(b, off, bytesRead); } return bytesRead; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public long skip(final long n) throws IOException { try { return in.skip(n); } catch (final IOException ex) { wire.input("[skip] I/O error: " + ex.getMessage()); throw ex; } } @Override public int available() throws IOException { try { return in.available(); } catch (final IOException ex) { wire.input("[available] I/O error: " + ex.getMessage()); throw ex; } } @Override public void close() throws IOException { try { in.close(); } catch (final IOException ex) { wire.input("[close] I/O error: " + ex.getMessage()); throw ex; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingOutputStream.java0100644 0000000 0000000 00000005664 00000250600 027617 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.OutputStream; import org.apache.hc.client5.http.impl.Wire; class LoggingOutputStream extends OutputStream { private final OutputStream out; private final Wire wire; public LoggingOutputStream(final OutputStream out, final Wire wire) { super(); this.out = out; this.wire = wire; } @Override public void write(final int b) throws IOException { try { out.write(b); wire.output(b); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void write(final byte[] b) throws IOException { try { wire.output(b); out.write(b); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void write(final byte[] b, final int off, final int len) throws IOException { try { wire.output(b, off, len); out.write(b, off, len); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void flush() throws IOException { try { out.flush(); } catch (final IOException ex) { wire.output("[flush] I/O error: " + ex.getMessage()); throw ex; } } @Override public void close() throws IOException { try { out.close(); } catch (final IOException ex) { wire.output("[close] I/O error: " + ex.getMessage()); throw ex; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingSocketHolder.java0100644 0000000 0000000 00000004370 00000250600 027522 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.Socket; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.impl.Wire; import org.apache.hc.core5.http.impl.io.SocketHolder; import org.slf4j.Logger; class LoggingSocketHolder extends SocketHolder { private final Wire wire; public LoggingSocketHolder(final Socket socket, final String id, final Logger log) { super(socket); this.wire = new Wire(log, id); } LoggingSocketHolder(final SSLSocket sslSocket, final Socket baseSocket, final String id, final Logger log) { super(sslSocket, baseSocket); this.wire = new Wire(log, id); } @Override protected InputStream getInputStream(final Socket socket) throws IOException { return new LoggingInputStream(super.getInputStream(socket), wire); } @Override protected OutputStream getOutputStream(final Socket socket) throws IOException { return new LoggingOutputStream(super.getOutputStream(socket), wire); } } ././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/ManagedHttpClientConnectionFactory.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/ManagedHttpClientConnectionFactory.java0100644 0000000 0000000 00000025017 00000250600 032531 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.net.Socket; import java.nio.charset.Charset; import java.nio.charset.CharsetDecoder; import java.nio.charset.CharsetEncoder; import java.nio.charset.CodingErrorAction; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentLengthStrategy; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.DefaultContentLengthStrategy; import org.apache.hc.core5.http.impl.io.DefaultHttpRequestWriterFactory; import org.apache.hc.core5.http.impl.io.NoResponseOutOfOrderStrategy; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.io.HttpMessageWriterFactory; import org.apache.hc.core5.http.io.ResponseOutOfOrderStrategy; /** * Factory for {@link ManagedHttpClientConnection} instances. * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ManagedHttpClientConnectionFactory implements HttpConnectionFactory { private static final AtomicLong COUNTER = new AtomicLong(); /** * Default instance of {@link ManagedHttpClientConnectionFactory}. */ public static final ManagedHttpClientConnectionFactory INSTANCE = new ManagedHttpClientConnectionFactory(); private final Http1Config h1Config; private final CharCodingConfig charCodingConfig; private final HttpMessageWriterFactory requestWriterFactory; private final HttpMessageParserFactory responseParserFactory; private final ContentLengthStrategy incomingContentStrategy; private final ContentLengthStrategy outgoingContentStrategy; private final ResponseOutOfOrderStrategy responseOutOfOrderStrategy; private ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy) { this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.requestWriterFactory = requestWriterFactory != null ? requestWriterFactory : new DefaultHttpRequestWriterFactory(this.h1Config); this.responseParserFactory = responseParserFactory != null ? responseParserFactory : new DefaultHttpResponseParserFactory(this.h1Config); this.incomingContentStrategy = incomingContentStrategy != null ? incomingContentStrategy : DefaultContentLengthStrategy.INSTANCE; this.outgoingContentStrategy = outgoingContentStrategy != null ? outgoingContentStrategy : DefaultContentLengthStrategy.INSTANCE; this.responseOutOfOrderStrategy = responseOutOfOrderStrategy != null ? responseOutOfOrderStrategy : NoResponseOutOfOrderStrategy.INSTANCE; } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy) { this( h1Config, charCodingConfig, requestWriterFactory, responseParserFactory, incomingContentStrategy, outgoingContentStrategy, null); } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { this(h1Config, charCodingConfig, requestWriterFactory, responseParserFactory, null, null); } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageParserFactory responseParserFactory) { this(h1Config, charCodingConfig, null, responseParserFactory); } public ManagedHttpClientConnectionFactory() { this(null, null, null); } @Override public ManagedHttpClientConnection createConnection(final Socket socket) throws IOException { CharsetDecoder charDecoder = null; CharsetEncoder charEncoder = null; final Charset charset = this.charCodingConfig.getCharset(); final CodingErrorAction malformedInputAction = this.charCodingConfig.getMalformedInputAction() != null ? this.charCodingConfig.getMalformedInputAction() : CodingErrorAction.REPORT; final CodingErrorAction unmappableInputAction = this.charCodingConfig.getUnmappableInputAction() != null ? this.charCodingConfig.getUnmappableInputAction() : CodingErrorAction.REPORT; if (charset != null) { charDecoder = charset.newDecoder(); charDecoder.onMalformedInput(malformedInputAction); charDecoder.onUnmappableCharacter(unmappableInputAction); charEncoder = charset.newEncoder(); charEncoder.onMalformedInput(malformedInputAction); charEncoder.onUnmappableCharacter(unmappableInputAction); } final String id = "http-outgoing-" + COUNTER.getAndIncrement(); final DefaultManagedHttpClientConnection conn = new DefaultManagedHttpClientConnection( id, charDecoder, charEncoder, h1Config, incomingContentStrategy, outgoingContentStrategy, responseOutOfOrderStrategy, requestWriterFactory, responseParserFactory); if (socket != null) { conn.bind(socket); } return conn; } /** * Create a new {@link Builder}. * * @since 5.1 */ public static Builder builder() { return new Builder(); } /** * Builder for {@link ManagedHttpClientConnectionFactory}. * * @since 5.1 */ public static final class Builder { private Http1Config http1Config; private CharCodingConfig charCodingConfig; private ContentLengthStrategy incomingContentLengthStrategy; private ContentLengthStrategy outgoingContentLengthStrategy; private ResponseOutOfOrderStrategy responseOutOfOrderStrategy; private HttpMessageWriterFactory requestWriterFactory; private HttpMessageParserFactory responseParserFactory; private Builder() { } public Builder http1Config(final Http1Config http1Config) { this.http1Config = http1Config; return this; } public Builder charCodingConfig(final CharCodingConfig charCodingConfig) { this.charCodingConfig = charCodingConfig; return this; } public Builder incomingContentLengthStrategy(final ContentLengthStrategy incomingContentLengthStrategy) { this.incomingContentLengthStrategy = incomingContentLengthStrategy; return this; } public Builder outgoingContentLengthStrategy(final ContentLengthStrategy outgoingContentLengthStrategy) { this.outgoingContentLengthStrategy = outgoingContentLengthStrategy; return this; } public Builder responseOutOfOrderStrategy(final ResponseOutOfOrderStrategy responseOutOfOrderStrategy) { this.responseOutOfOrderStrategy = responseOutOfOrderStrategy; return this; } public Builder requestWriterFactory( final HttpMessageWriterFactory requestWriterFactory) { this.requestWriterFactory = requestWriterFactory; return this; } public Builder responseParserFactory( final HttpMessageParserFactory responseParserFactory) { this.responseParserFactory = responseParserFactory; return this; } public ManagedHttpClientConnectionFactory build() { return new ManagedHttpClientConnectionFactory( http1Config, charCodingConfig, requestWriterFactory, responseParserFactory, incomingContentLengthStrategy, outgoingContentLengthStrategy, responseOutOfOrderStrategy); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/OffLockDisposalCallback.java0100644 0000000 0000000 00000004276 00000250600 030271 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.pool.DisposalCallback; @Internal final class OffLockDisposalCallback implements DisposalCallback { private final DisposalCallback delegate; private final Queue gracefulQueue = new ConcurrentLinkedQueue<>(); OffLockDisposalCallback(final DisposalCallback delegate) { this.delegate = delegate; } @Override public void execute(final T closeable, final CloseMode mode) { if (mode == CloseMode.IMMEDIATE) { delegate.execute(closeable, CloseMode.IMMEDIATE); } else { gracefulQueue.offer(closeable); } } void drain() { for (T c; (c = gracefulQueue.poll()) != null; ) { delegate.execute(c, CloseMode.GRACEFUL); } } }././@LongLink0100644 0000000 0000000 00000000145 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java0100644 0000000 0000000 00000111363 00000250600 032547 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.nio.file.Path; import java.util.Set; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.PrefixedIncrementingId; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.DefaultDisposalCallback; import org.apache.hc.core5.pool.DisposalCallback; import org.apache.hc.core5.pool.LaxConnPool; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.pool.RouteSegmentedConnPool; import org.apache.hc.core5.pool.StrictConnPool; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@code PoolingHttpClientConnectionManager} maintains a pool of * {@link ManagedHttpClientConnection}s and is able to service connection requests * from multiple execution threads. Connections are pooled on a per route * basis. A request for a route which already the manager has persistent * connections for available in the pool will be serviced by leasing * a connection from the pool rather than creating a new connection. *

* {@code PoolingHttpClientConnectionManager} maintains a maximum limit of connections * per route and in total. Connection limits, however, can be adjusted * using {@link ConnPoolControl} methods. *

* Total time to live (TTL) set at construction time defines maximum life span * of persistent connections regardless of their expiration setting. No persistent * connection will be re-used past its TTL value. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class PoolingHttpClientConnectionManager implements HttpClientConnectionManager, ConnPoolControl { private static final Logger LOG = LoggerFactory.getLogger(PoolingHttpClientConnectionManager.class); private final DisposalCallback defaultDisposal; private final OffLockDisposalCallback offLockDisposer; public static final int DEFAULT_MAX_TOTAL_CONNECTIONS = 25; public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 5; private final HttpClientConnectionOperator connectionOperator; private final ManagedConnPool pool; private final HttpConnectionFactory connFactory; private final AtomicBoolean closed; private volatile Resolver socketConfigResolver; private volatile Resolver connectionConfigResolver; private volatile Resolver tlsConfigResolver; public PoolingHttpClientConnectionManager() { this(new DefaultHttpClientConnectionOperator(null, null, RegistryBuilder.create() .register(URIScheme.HTTPS.id, DefaultClientTlsStrategy.createDefault()) .build()), PoolConcurrencyPolicy.STRICT, PoolReusePolicy.LIFO, TimeValue.NEG_ONE_MILLISECOND, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry) { this(socketFactoryRegistry, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, PoolConcurrencyPolicy.STRICT, TimeValue.NEG_ONE_MILLISECOND, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, poolConcurrencyPolicy, PoolReusePolicy.LIFO, timeToLive, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive) { this(socketFactoryRegistry, poolConcurrencyPolicy, poolReusePolicy, timeToLive, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, poolConcurrencyPolicy, poolReusePolicy, timeToLive, null, null, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final HttpConnectionFactory connFactory) { this(new DefaultHttpClientConnectionOperator(socketFactoryRegistry, schemePortResolver, dnsResolver), poolConcurrencyPolicy, poolReusePolicy, timeToLive, connFactory); } @Internal public PoolingHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { this(httpClientConnectionOperator,poolConcurrencyPolicy,poolReusePolicy,timeToLive,connFactory,false); } @Internal public PoolingHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory, final boolean offLockDisposalEnabled) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); this.defaultDisposal = new DefaultDisposalCallback<>(); this.offLockDisposer = offLockDisposalEnabled ? new OffLockDisposalCallback<>(this.defaultDisposal) : null; final DisposalCallback callbackForPool = offLockDisposalEnabled ? this.offLockDisposer : this.defaultDisposal; switch (poolConcurrencyPolicy != null ? poolConcurrencyPolicy : PoolConcurrencyPolicy.STRICT) { case STRICT: this.pool = new StrictConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, DEFAULT_MAX_TOTAL_CONNECTIONS, timeToLive, poolReusePolicy, callbackForPool, null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; case LAX: this.pool = new LaxConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, timeToLive, poolReusePolicy, callbackForPool, null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; case OFFLOCK: this.pool = new RouteSegmentedConnPool<>( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, DEFAULT_MAX_TOTAL_CONNECTIONS, timeToLive, poolReusePolicy, new DefaultDisposalCallback<>()); break; default: throw new IllegalArgumentException("Unexpected PoolConcurrencyPolicy value: " + poolConcurrencyPolicy); } this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.closed = new AtomicBoolean(false); } @Internal protected PoolingHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final ManagedConnPool pool, final HttpConnectionFactory connFactory) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); this.pool = Args.notNull(pool, "Connection pool"); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.closed = new AtomicBoolean(false); this.defaultDisposal = null; this.offLockDisposer = null; } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("Shutdown connection pool {}", closeMode); } this.pool.close(closeMode); drainDisposals(); LOG.debug("Connection pool shut down"); } } private InternalConnectionEndpoint cast(final ConnectionEndpoint endpoint) { if (endpoint instanceof InternalConnectionEndpoint) { return (InternalConnectionEndpoint) endpoint; } throw new IllegalStateException("Unexpected endpoint class: " + endpoint.getClass()); } private SocketConfig resolveSocketConfig(final HttpRoute route) { final Resolver resolver = this.socketConfigResolver; final SocketConfig socketConfig = resolver != null ? resolver.resolve(route) : null; return socketConfig != null ? socketConfig : SocketConfig.DEFAULT; } private ConnectionConfig resolveConnectionConfig(final HttpRoute route) { final Resolver resolver = this.connectionConfigResolver; final ConnectionConfig connectionConfig = resolver != null ? resolver.resolve(route) : null; return connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } private TlsConfig resolveTlsConfig(final HttpHost host) { final Resolver resolver = this.tlsConfigResolver; final TlsConfig tlsConfig = resolver != null ? resolver.resolve(host) : null; return tlsConfig != null ? tlsConfig : TlsConfig.DEFAULT; } private TimeValue resolveValidateAfterInactivity(final ConnectionConfig connectionConfig) { final TimeValue timeValue = connectionConfig.getValidateAfterInactivity(); return timeValue != null ? timeValue : TimeValue.ofSeconds(2); } public LeaseRequest lease(final String id, final HttpRoute route, final Object state) { return lease(id, route, Timeout.DISABLED, state); } @Override public LeaseRequest lease( final String id, final HttpRoute route, final Timeout requestTimeout, final Object state) { Args.notNull(route, "HTTP route"); if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease request ({}) {}", id, requestTimeout, ConnPoolSupport.formatStats(route, state, pool)); } final Future> leaseFuture = this.pool.lease(route, state, requestTimeout, null); return new LeaseRequest() { // Using a ReentrantLock specific to each LeaseRequest instance to maintain the original // synchronization semantics. This ensures that each LeaseRequest has its own unique lock. private final ReentrantLock lock = new ReentrantLock(); private volatile ConnectionEndpoint endpoint; @Override public ConnectionEndpoint get( final Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException { lock.lock(); try { Args.notNull(timeout, "Operation timeout"); if (this.endpoint != null) { return this.endpoint; } final PoolEntry poolEntry; try { poolEntry = leaseFuture.get(timeout.getDuration(), timeout.getTimeUnit()); } catch (final TimeoutException ex) { leaseFuture.cancel(true); throw ex; } if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint leased {}", id, ConnPoolSupport.formatStats(route, state, pool)); } final ConnectionConfig connectionConfig = resolveConnectionConfig(route); try { if (poolEntry.hasConnection()) { final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (TimeValue.isNonNegative(timeToLive)) { if (timeToLive.getDuration() == 0 || Deadline.calculate(poolEntry.getCreated(), timeToLive).isExpired()) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } } if (poolEntry.hasConnection()) { final TimeValue idleTimeout = connectionConfig.getIdleTimeout(); if (TimeValue.isPositive(idleTimeout)) { if (Deadline.calculate(poolEntry.getUpdated(), idleTimeout).isExpired()) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } } if (poolEntry.hasConnection()) { final TimeValue timeValue = resolveValidateAfterInactivity(connectionConfig); if (TimeValue.isNonNegative(timeValue)) { if (timeValue.getDuration() == 0 || Deadline.calculate(poolEntry.getUpdated(), timeValue).isExpired()) { final ManagedHttpClientConnection conn = poolEntry.getConnection(); boolean stale; try { stale = conn.isStale(); } catch (final IOException ignore) { stale = true; } if (stale) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(conn)); } poolEntry.discardConnection(CloseMode.IMMEDIATE); } } } } // Single drain point under the lease lock. drainDisposals(); final ManagedHttpClientConnection conn = poolEntry.getConnection(); if (conn != null) { conn.activate(); if (connectionConfig.getSocketTimeout() != null) { conn.setSocketTimeout(connectionConfig.getSocketTimeout()); } } else { poolEntry.assignConnection(connFactory.createConnection(null)); } this.endpoint = new InternalConnectionEndpoint(poolEntry); if (LOG.isDebugEnabled()) { LOG.debug("{} acquired {}", id, ConnPoolSupport.getId(endpoint)); } return this.endpoint; } catch (final Exception ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease failed", id); } pool.release(poolEntry, false); throw new ExecutionException(ex.getMessage(), ex); } } finally { lock.unlock(); } } @Override public boolean cancel() { return leaseFuture.cancel(true); } }; } @Override public void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) { Args.notNull(endpoint, "Managed endpoint"); final PoolEntry entry = cast(endpoint).detach(); if (entry == null) { return; } if (LOG.isDebugEnabled()) { LOG.debug("{} releasing endpoint", ConnPoolSupport.getId(endpoint)); } if (this.isClosed()) { return; } final ManagedHttpClientConnection conn = entry.getConnection(); if (conn != null && keepAlive == null) { conn.close(CloseMode.GRACEFUL); } boolean reusable = conn != null && conn.isOpen() && conn.isConsistent(); try { if (reusable) { entry.updateState(state); entry.updateExpiry(keepAlive); conn.passivate(); if (LOG.isDebugEnabled()) { final String s; if (TimeValue.isPositive(keepAlive)) { s = "for " + keepAlive; } else { s = "indefinitely"; } LOG.debug("{} connection {} can be kept alive {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn), s); } } else { if (LOG.isDebugEnabled()) { if (conn != null && !conn.isConsistent()) { LOG.debug("{} connection is in an inconsistent state and cannot be kept alive", ConnPoolSupport.getId(endpoint)); } else { LOG.debug("{} connection is not kept alive", ConnPoolSupport.getId(endpoint)); } } } } catch (final RuntimeException ex) { reusable = false; throw ex; } finally { this.pool.release(entry, reusable); if (LOG.isDebugEnabled()) { LOG.debug("{} connection released {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.formatStats(entry.getRoute(), entry.getState(), pool)); } drainDisposals(); } } @Override public void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); if (internalEndpoint.isConnected()) { return; } final PoolEntry poolEntry = internalEndpoint.getPoolEntry(); if (!poolEntry.hasConnection()) { poolEntry.assignConnection(connFactory.createConnection(null)); } final HttpRoute route = poolEntry.getRoute(); final Path unixDomainSocket = route.getUnixDomainSocket(); final HttpHost firstHop = route.getProxyHost() != null ? route.getProxyHost() : route.getTargetHost(); final SocketConfig socketConfig = resolveSocketConfig(route); final ConnectionConfig connectionConfig = resolveConnectionConfig(route); final Timeout connectTimeout = timeout != null ? Timeout.of(timeout.getDuration(), timeout.getTimeUnit()) : connectionConfig.getConnectTimeout(); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting endpoint to {} ({})", ConnPoolSupport.getId(endpoint), firstHop, connectTimeout); } final ManagedHttpClientConnection conn = poolEntry.getConnection(); this.connectionOperator.connect( conn, firstHop, route.getTargetName(), unixDomainSocket, route.getLocalSocketAddress(), connectTimeout, socketConfig, route.isTunnelled() ? null : resolveTlsConfig(route.getTargetHost()), context); if (LOG.isDebugEnabled()) { LOG.debug("{} connected {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn)); } final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { conn.setSocketTimeout(socketTimeout); } } @Override public void upgrade(final ConnectionEndpoint endpoint, final HttpContext context) throws IOException { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final PoolEntry poolEntry = internalEndpoint.getValidatedPoolEntry(); final HttpRoute route = poolEntry.getRoute(); final HttpHost target = route.getTargetHost(); final TlsConfig tlsConfig = resolveTlsConfig(target); this.connectionOperator.upgrade( poolEntry.getConnection(), target, route.getTargetName(), tlsConfig, context); } @Override public void closeIdle(final TimeValue idleTime) { Args.notNull(idleTime, "Idle time"); if (LOG.isDebugEnabled()) { LOG.debug("Closing connections idle longer than {}", idleTime); } if (isClosed()) { return; } this.pool.closeIdle(idleTime); drainDisposals(); } @Override public void closeExpired() { if (isClosed()) { return; } LOG.debug("Closing expired connections"); this.pool.closeExpired(); drainDisposals(); } @Override public Set getRoutes() { return this.pool.getRoutes(); } @Override public int getMaxTotal() { return this.pool.getMaxTotal(); } @Override public void setMaxTotal(final int max) { this.pool.setMaxTotal(max); } @Override public int getDefaultMaxPerRoute() { return this.pool.getDefaultMaxPerRoute(); } @Override public void setDefaultMaxPerRoute(final int max) { this.pool.setDefaultMaxPerRoute(max); } @Override public int getMaxPerRoute(final HttpRoute route) { return this.pool.getMaxPerRoute(route); } @Override public void setMaxPerRoute(final HttpRoute route, final int max) { this.pool.setMaxPerRoute(route, max); } @Override public PoolStats getTotalStats() { return this.pool.getTotalStats(); } @Override public PoolStats getStats(final HttpRoute route) { return this.pool.getStats(route); } /** * Sets the same {@link SocketConfig} for all routes */ public void setDefaultSocketConfig(final SocketConfig config) { this.socketConfigResolver = route -> config; } /** * Sets {@link Resolver} of {@link SocketConfig} on a per route basis. * * @since 5.2 */ public void setSocketConfigResolver(final Resolver socketConfigResolver) { this.socketConfigResolver = socketConfigResolver; } /** * Sets the same {@link ConnectionConfig} for all routes * * @since 5.2 */ public void setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @since 5.2 */ public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; } /** * Sets the same {@link ConnectionConfig} for all hosts * * @since 5.2 */ public void setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @since 5.2 */ public void setTlsConfigResolver(final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; } void closeIfExpired(final PoolEntry entry) { final long now = System.currentTimeMillis(); if (entry.getExpiryDeadline().isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } else { final ConnectionConfig connectionConfig = resolveConnectionConfig(entry.getRoute()); final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (timeToLive != null && Deadline.calculate(entry.getCreated(), timeToLive).isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } } } /** * @deprecated Use custom {@link #setConnectionConfigResolver(Resolver)} */ @Deprecated public SocketConfig getDefaultSocketConfig() { return SocketConfig.DEFAULT; } /** * @since 4.4 * * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public TimeValue getValidateAfterInactivity() { return ConnectionConfig.DEFAULT.getValidateAfterInactivity(); } /** * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object)} leased} to the consumer. * Negative values passed to this method disable connection validation. This check helps * detect connections that have become stale (half-closed) while kept inactive in the pool. * * @since 4.4 * * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); } private static final PrefixedIncrementingId INCREMENTING_ID = new PrefixedIncrementingId("ep-"); static class InternalConnectionEndpoint extends ConnectionEndpoint implements ConnectionHolder, Identifiable { private final AtomicReference> poolEntryRef; private final String id; InternalConnectionEndpoint( final PoolEntry poolEntry) { this.poolEntryRef = new AtomicReference<>(poolEntry); this.id = INCREMENTING_ID.getNextId(); } @Override public String getId() { return id; } PoolEntry getPoolEntry() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry == null) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry getValidatedPoolEntry() { final PoolEntry poolEntry = getPoolEntry(); final ManagedHttpClientConnection connection = poolEntry.getConnection(); if (connection == null || !connection.isOpen()) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry detach() { return poolEntryRef.getAndSet(null); } @Override public void close(final CloseMode closeMode) { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { poolEntry.discardConnection(closeMode); } } @Override public void close() throws IOException { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } @Override public boolean isConnected() { final PoolEntry poolEntry = getPoolEntry(); final ManagedHttpClientConnection connection = poolEntry.getConnection(); return connection != null && connection.isOpen(); } @Override public void setSocketTimeout(final Timeout timeout) { getValidatedPoolEntry().getConnection().setSocketTimeout(timeout); } /** * @deprecated Use {@link #execute(String, ClassicHttpRequest, RequestExecutor, HttpContext)} */ @Deprecated @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final HttpRequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); final ManagedHttpClientConnection connection = getValidatedPoolEntry().getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} executing exchange {} over {}", id, exchangeId, ConnPoolSupport.getId(connection)); } return requestExecutor.execute(request, connection, context); } /** * @since 5.4 */ @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); final ManagedHttpClientConnection connection = getValidatedPoolEntry().getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} executing exchange {} over {}", id, exchangeId, ConnPoolSupport.getId(connection)); } return requestExecutor.execute(request, connection, context); } /** * @since 5.4 */ @Override public EndpointInfo getInfo() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { final ManagedHttpClientConnection connection = poolEntry.getConnection(); if (connection != null && connection.isOpen()) { return new EndpointInfo(connection.getProtocolVersion(), connection.getSSLSession()); } } return null; } @Override public HttpConnection get() { final PoolEntry poolEntry = poolEntryRef.get(); return poolEntry != null ? poolEntry.getConnection() : null; } } /** * Returns whether this connection manager has been shut down. * * @since 5.4 */ public boolean isClosed() { return this.closed.get(); } private void drainDisposals() { if (offLockDisposer != null) { offLockDisposer.drain(); } } } ././@LongLink0100644 0000000 0000000 00000000154 00000250600 011611 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuild0100644 0000000 0000000 00000030755 00000250600 032614 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.util.TimeValue; /** * Builder for {@link PoolingHttpClientConnectionManager} instances. *

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #build()}. *

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @since 5.0 */ public class PoolingHttpClientConnectionManagerBuilder { private HttpConnectionFactory connectionFactory; private TlsSocketStrategy tlsSocketStrategy; private SchemePortResolver schemePortResolver; private DnsResolver dnsResolver; private PoolConcurrencyPolicy poolConcurrencyPolicy; private PoolReusePolicy poolReusePolicy; private Resolver socketConfigResolver; private Resolver connectionConfigResolver; private Resolver tlsConfigResolver; private boolean systemProperties; private int maxConnTotal; private int maxConnPerRoute; private boolean offLockDisposalEnabled; public static PoolingHttpClientConnectionManagerBuilder create() { return new PoolingHttpClientConnectionManagerBuilder(); } @Internal protected PoolingHttpClientConnectionManagerBuilder() { super(); } /** * Sets {@link HttpConnectionFactory} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setConnectionFactory( final HttpConnectionFactory connectionFactory) { this.connectionFactory = connectionFactory; return this; } /** * Sets {@link org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory} instance. * * @return this instance. * @deprecated Use {@link #setTlsSocketStrategy(TlsSocketStrategy)} */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setSSLSocketFactory( final org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory sslSocketFactory) { this.tlsSocketStrategy = (socket, target, port, attachment, context) -> (SSLSocket) sslSocketFactory.createLayeredSocket(socket, target, port, context); return this; } /** * Sets {@link TlsSocketStrategy} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setTlsSocketStrategy(final TlsSocketStrategy tlsSocketStrategy) { this.tlsSocketStrategy = tlsSocketStrategy; return this; } /** * Sets {@link DnsResolver} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setDnsResolver(final DnsResolver dnsResolver) { this.dnsResolver = dnsResolver; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@link PoolConcurrencyPolicy} value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setPoolConcurrencyPolicy(final PoolConcurrencyPolicy poolConcurrencyPolicy) { this.poolConcurrencyPolicy = poolConcurrencyPolicy; return this; } /** * Sets {@link PoolReusePolicy} value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setConnPoolPolicy(final PoolReusePolicy poolReusePolicy) { this.poolReusePolicy = poolReusePolicy; return this; } /** * Sets maximum total connection value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setMaxConnTotal(final int maxConnTotal) { this.maxConnTotal = maxConnTotal; return this; } /** * Sets maximum connection per route value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setMaxConnPerRoute(final int maxConnPerRoute) { this.maxConnPerRoute = maxConnPerRoute; return this; } /** * Sets the same {@link SocketConfig} for all routes. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setDefaultSocketConfig(final SocketConfig config) { this.socketConfigResolver = route -> config; return this; } /** * Sets {@link Resolver} of {@link SocketConfig} on a per route basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setSocketConfigResolver( final Resolver socketConfigResolver) { this.socketConfigResolver = socketConfigResolver; return this; } /** * Sets the same {@link ConnectionConfig} for all routes. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; return this; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setConnectionConfigResolver( final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; return this; } /** * Sets the same {@link TlsConfig} for all hosts. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; return this; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setTlsConfigResolver( final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; return this; } /** * Sets maximum time to live for persistent connections * * @return this instance. * @deprecated Use {@link #setDefaultConnectionConfig(ConnectionConfig)}. */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setConnectionTimeToLive(final TimeValue timeToLive) { setDefaultConnectionConfig(ConnectionConfig.custom() .setTimeToLive(timeToLive) .build()); return this; } /** * Sets period after inactivity after which persistent * connections must be checked to ensure they are still valid. * * @return this instance. * @deprecated Use {@link #setDefaultConnectionConfig(ConnectionConfig)}. */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * Enable/disable off-lock disposal. * @since 5.6 */ @Experimental public final PoolingHttpClientConnectionManagerBuilder setOffLockDisposalEnabled(final boolean enabled) { this.offLockDisposalEnabled = enabled; return this; } @Internal protected HttpClientConnectionOperator createConnectionOperator( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final TlsSocketStrategy tlsSocketStrategy) { return new DefaultHttpClientConnectionOperator(schemePortResolver, dnsResolver, RegistryBuilder.create() .register(URIScheme.HTTPS.id, tlsSocketStrategy) .build()); } public PoolingHttpClientConnectionManager build() { final TlsSocketStrategy tlsSocketStrategyCopy; if (tlsSocketStrategy != null) { tlsSocketStrategyCopy = tlsSocketStrategy; } else { if (systemProperties) { tlsSocketStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsSocketStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } final PoolingHttpClientConnectionManager poolingmgr = new PoolingHttpClientConnectionManager( createConnectionOperator(schemePortResolver, dnsResolver, tlsSocketStrategyCopy), poolConcurrencyPolicy, poolReusePolicy, null, connectionFactory, offLockDisposalEnabled); poolingmgr.setSocketConfigResolver(socketConfigResolver); poolingmgr.setConnectionConfigResolver(connectionConfigResolver); poolingmgr.setTlsConfigResolver(tlsConfigResolver); if (maxConnTotal > 0) { poolingmgr.setMaxTotal(maxConnTotal); } if (maxConnPerRoute > 0) { poolingmgr.setDefaultMaxPerRoute(maxConnPerRoute); } return poolingmgr; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/package-info.java0100644 0000000 0000000 00000002460 00000250600 026147 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection management functions based the classic * connection management APIs. */ package org.apache.hc.client5.http.impl.io; httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/0040755 0000000 0000000 00000000000 00000250600 023137 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000150 00000250600 011605 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/DefaultAsyncClientConnectionOperator.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/DefaultAsyncClientConnectionOperator.j0100644 0000000 0000000 00000031741 00000250600 032572 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.lang.reflect.Method; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.nio.file.Path; import java.util.concurrent.Future; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UnsupportedSchemeException; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.nio.AsyncClientConnectionOperator; import org.apache.hc.client5.http.nio.ManagedAsyncClientConnection; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.concurrent.FutureContribution; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Internal public class DefaultAsyncClientConnectionOperator implements AsyncClientConnectionOperator { private static final Logger LOG = LoggerFactory.getLogger(DefaultAsyncClientConnectionOperator.class); private final SchemePortResolver schemePortResolver; private final MultihomeIOSessionRequester sessionRequester; private final Lookup tlsStrategyLookup; /** * Constructs a new {@code DefaultAsyncClientConnectionOperator}. * *

Note: this class is marked {@code @Internal}; rely on it * only if you are prepared for incompatible changes in a future major * release. Typical client code should use the high-level builders in * {@code HttpAsyncClients} instead.

*/ protected DefaultAsyncClientConnectionOperator( final Lookup tlsStrategyLookup, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this.tlsStrategyLookup = Args.notNull(tlsStrategyLookup, "TLS strategy lookup"); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.sessionRequester = new MultihomeIOSessionRequester(dnsResolver); } @Override public Future connect( final ConnectionInitiator connectionInitiator, final HttpHost host, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final FutureCallback callback) { return connect(connectionInitiator, host, null, localAddress, connectTimeout, attachment, null, callback); } @Override public Future connect( final ConnectionInitiator connectionInitiator, final HttpHost endpointHost, final NamedEndpoint endpointName, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final HttpContext context, final FutureCallback callback) { return connect(connectionInitiator, endpointHost, null, endpointName, localAddress, connectTimeout, attachment, context, callback); } @Override public Future connect( final ConnectionInitiator connectionInitiator, final HttpHost endpointHost, final Path unixDomainSocket, final NamedEndpoint endpointName, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final HttpContext context, final FutureCallback callback) { Args.notNull(connectionInitiator, "Connection initiator"); Args.notNull(endpointHost, "Host"); final ComplexFuture future = new ComplexFuture<>(callback); final HttpHost remoteEndpoint = RoutingSupport.normalize(endpointHost, schemePortResolver); final SocketAddress remoteAddress; if (unixDomainSocket == null) { final InetAddress remoteInetAddress = endpointHost.getAddress(); remoteAddress = remoteInetAddress != null ? new InetSocketAddress(remoteInetAddress, remoteEndpoint.getPort()) : null; } else { remoteAddress = createUnixSocketAddress(unixDomainSocket); } final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; onBeforeSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting {}->{} ({})", endpointHost, localAddress, remoteAddress, connectTimeout); } final Future sessionFuture = sessionRequester.connect( connectionInitiator, remoteEndpoint, remoteAddress, localAddress, connectTimeout, tlsConfig.getHttpVersionPolicy(), new FutureCallback() { @Override public void completed(final IOSession session) { final DefaultManagedAsyncClientConnection connection = new DefaultManagedAsyncClientConnection(session); onAfterSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} connected {}->{}", ConnPoolSupport.getId(connection), endpointHost, connection.getLocalAddress(), connection.getRemoteAddress()); } final TlsStrategy tlsStrategy = tlsStrategyLookup != null ? tlsStrategyLookup.lookup(endpointHost.getSchemeName()) : null; if (tlsStrategy != null) { try { final Timeout socketTimeout = connection.getSocketTimeout(); final Timeout handshakeTimeout = tlsConfig.getHandshakeTimeout() != null ? tlsConfig.getHandshakeTimeout() : connectTimeout; final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; onBeforeTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgrading to TLS", ConnPoolSupport.getId(connection), tlsName); } tlsStrategy.upgrade( connection, tlsName, attachment, handshakeTimeout, new FutureContribution(future) { @Override public void completed(final TransportSecurityLayer transportSecurityLayer) { connection.setSocketTimeout(socketTimeout); future.completed(connection); onAfterTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgraded to TLS", ConnPoolSupport.getId(connection), tlsName); } } }); } catch (final Exception ex) { future.failed(ex); } } else { future.completed(connection); } } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }); future.setDependency(sessionFuture); return future; } // The IOReactor does not support AFUNIXSocketChannel from JUnixSocket, so if a Unix domain socket was configured, // we must use JEP 380 sockets and addresses. private static SocketAddress createUnixSocketAddress(final Path socketPath) { try { final Class addressClass = Class.forName("java.net.UnixDomainSocketAddress"); final Method ofMethod = addressClass.getMethod("of", Path.class); return (SocketAddress) ofMethod.invoke(null, socketPath); } catch (final ReflectiveOperationException ex) { throw new UnsupportedOperationException("Async Unix domain socket support requires Java 16 or later", ex); } } @Override public void upgrade( final ManagedAsyncClientConnection connection, final HttpHost host, final Object attachment) { upgrade(connection, host, null, attachment, null, null); } @Override public void upgrade( final ManagedAsyncClientConnection connection, final HttpHost endpointHost, final NamedEndpoint endpointName, final Object attachment, final HttpContext context, final FutureCallback callback) { final String newProtocol = URIScheme.HTTP.same(endpointHost.getSchemeName()) ? URIScheme.HTTPS.id : endpointHost.getSchemeName(); final TlsStrategy tlsStrategy = tlsStrategyLookup != null ? tlsStrategyLookup.lookup(newProtocol) : null; if (tlsStrategy != null) { final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgrading to TLS", ConnPoolSupport.getId(connection), tlsName); } tlsStrategy.upgrade( connection, tlsName, attachment, null, new CallbackContribution(callback) { @Override public void completed(final TransportSecurityLayer transportSecurityLayer) { if (callback != null) { callback.completed(connection); } } }); } else { callback.failed(new UnsupportedSchemeException(newProtocol + " protocol is not supported")); } } protected void onBeforeSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onBeforeTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } } ././@LongLink0100644 0000000 0000000 00000000147 00000250600 011613 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/DefaultManagedAsyncClientConnection.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/DefaultManagedAsyncClientConnection.ja0100644 0000000 0000000 00000017573 00000250600 032503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.io.IOException; import java.net.SocketAddress; import java.util.concurrent.atomic.AtomicBoolean; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.nio.ManagedAsyncClientConnection; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.SSLSessionInitializer; import org.apache.hc.core5.reactor.ssl.SSLSessionVerifier; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Internal public class DefaultManagedAsyncClientConnection implements ManagedAsyncClientConnection, Identifiable { private static final Logger LOG = LoggerFactory.getLogger(DefaultManagedAsyncClientConnection.class); private final IOSession ioSession; private final Timeout socketTimeout; private final AtomicBoolean closed; public DefaultManagedAsyncClientConnection(final IOSession ioSession) { this.ioSession = ioSession; this.socketTimeout = ioSession.getSocketTimeout(); this.closed = new AtomicBoolean(); } @Override public String getId() { return ioSession.getId(); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Shutdown connection {}", getId(), closeMode); } ioSession.close(closeMode); } } @Override public void close() throws IOException { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Close connection", getId()); } ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE); } } @Override public boolean isOpen() { final IOSession ioSession = this.ioSession; if (ioSession.isOpen()) { final IOEventHandler handler = ioSession.getHandler(); if (handler instanceof HttpConnection) { return ((HttpConnection) handler).isOpen(); } return true; } else { return false; } } @Override public void setSocketTimeout(final Timeout timeout) { ioSession.setSocketTimeout(timeout); } @Override public Timeout getSocketTimeout() { return ioSession.getSocketTimeout(); } @Override public SocketAddress getRemoteAddress() { return ioSession.getRemoteAddress(); } @Override public SocketAddress getLocalAddress() { return ioSession.getLocalAddress(); } @Override public EndpointDetails getEndpointDetails() { final IOEventHandler handler = ioSession.getHandler(); if (handler instanceof HttpConnection) { return ((HttpConnection) handler).getEndpointDetails(); } return null; } @Override public ProtocolVersion getProtocolVersion() { final IOEventHandler handler = ioSession.getHandler(); if (handler instanceof HttpConnection) { final ProtocolVersion version = ((HttpConnection) handler).getProtocolVersion(); if (version != null) { return version; } } return HttpVersion.DEFAULT; } @Override public void startTls( final SSLContext sslContext, final NamedEndpoint endpoint, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout, final FutureCallback callback) throws UnsupportedOperationException { if (LOG.isDebugEnabled()) { LOG.debug("{} start TLS", getId()); } if (ioSession instanceof TransportSecurityLayer) { ((TransportSecurityLayer) ioSession).startTls(sslContext, endpoint, sslBufferMode, initializer, verifier, handshakeTimeout, callback); } else { throw new UnsupportedOperationException("TLS upgrade not supported"); } } @Override public void startTls( final SSLContext sslContext, final NamedEndpoint endpoint, final SSLBufferMode sslBufferMode, final SSLSessionInitializer initializer, final SSLSessionVerifier verifier, final Timeout handshakeTimeout) throws UnsupportedOperationException { startTls(sslContext, endpoint, sslBufferMode, initializer, verifier, handshakeTimeout, null); } @Override public TlsDetails getTlsDetails() { return ioSession instanceof TransportSecurityLayer ? ((TransportSecurityLayer) ioSession).getTlsDetails() : null; } @Override public SSLSession getSSLSession() { final TlsDetails tlsDetails = getTlsDetails(); return tlsDetails != null ? tlsDetails.getSSLSession() : null; } @Override public void submitCommand(final Command command, final Command.Priority priority) { if (LOG.isDebugEnabled()) { LOG.debug("{} {} with {} priority", getId(), command.getClass().getSimpleName(), priority); } ioSession.enqueue(command, Command.Priority.IMMEDIATE); } @Override public void passivate() { ioSession.setSocketTimeout(Timeout.ZERO_MILLISECONDS); } @Override public void activate() { ioSession.setSocketTimeout(socketTimeout); } @Override public void switchProtocol(final String protocolId, final FutureCallback callback) throws UnsupportedOperationException { if (ioSession instanceof ProtocolIOSession) { ((ProtocolIOSession) ioSession).switchProtocol(protocolId, callback); } else { throw new UnsupportedOperationException("Protocol switch not supported"); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/H2SharingConnPool.java0100644 0000000 0000000 00000025733 00000250600 027246 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.io.IOException; import java.util.Comparator; import java.util.HashMap; import java.util.Map; import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.CompletedFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Experimental connections pool implementation that acts as a caching facade in front of * a standard {@link ManagedConnPool} and shares already leased connections to multiplex * message exchanges over active HTTP/2 connections. * @param route * @param connection object * * @since 5.5 */ @Contract(threading = ThreadingBehavior.SAFE) @Experimental public class H2SharingConnPool implements ManagedConnPool { private static final Logger LOG = LoggerFactory.getLogger(H2SharingConnPool.class); private final ManagedConnPool pool; private final ConcurrentMap> perRouteCache; private final AtomicBoolean closed; public H2SharingConnPool(final ManagedConnPool pool) { this.pool = Args.notNull(pool, "Connection pool"); this.perRouteCache = new ConcurrentHashMap<>(); this.closed = new AtomicBoolean(); } @Override public void close(final CloseMode closeMode) { if (closed.compareAndSet(false, true)) { perRouteCache.clear(); pool.close(closeMode); } } @Override public void close() throws IOException { if (closed.compareAndSet(false, true)) { perRouteCache.clear(); pool.close(); } } PerRoutePool getPerRoutePool(final T route) { return perRouteCache.computeIfAbsent(route, r -> new PerRoutePool<>()); } @Override public Future> lease(final T route, final Object state, final Timeout requestTimeout, final FutureCallback> callback) { Asserts.check(!closed.get(), "Connection pool shut down"); if (state == null) { final PerRoutePool perRoutePool = perRouteCache.get(route); if (perRoutePool != null) { final PoolEntry entry = perRoutePool.lease(); if (entry != null) { if (LOG.isDebugEnabled()) { LOG.debug("Sharing connection {} for message exchange multiplexing (lease count = {})", ConnPoolSupport.getId(entry.getConnection()), perRoutePool.getCount(entry)); } final Future> future = new CompletedFuture<>(entry); if (callback != null) { callback.completed(entry); } return future; } } } LOG.debug("No shared connection available"); return pool.lease(route, state, requestTimeout, new CallbackContribution>(callback) { @Override public void completed(final PoolEntry entry) { if (state == null) { final C connection = entry.getConnection(); final ProtocolVersion ver = connection != null ? connection.getProtocolVersion() : null; if (ver == HttpVersion.HTTP_2_0) { final PerRoutePool perRoutePool = getPerRoutePool(route); final long count = perRoutePool.track(entry); if (LOG.isDebugEnabled()) { LOG.debug("Connection {} can be shared for message exchange multiplexing (lease count = {})", ConnPoolSupport.getId(entry.getConnection()), count); } } } if (callback != null) { callback.completed(entry); } } }); } @Override public void release(final PoolEntry entry, final boolean reusable) { if (entry == null) { return; } if (closed.get()) { pool.release(entry, reusable); return; } final T route = entry.getRoute(); final PerRoutePool perRoutePool = perRouteCache.get(route); if (perRoutePool != null) { final long count = perRoutePool.release(entry, reusable); if (count > 0) { if (LOG.isDebugEnabled()) { LOG.debug("Connection {} is being shared for message exchange multiplexing (lease count = {})", ConnPoolSupport.getId(entry.getConnection()), count); } return; } } if (LOG.isDebugEnabled()) { LOG.debug("Releasing connection {} back to the pool", ConnPoolSupport.getId(entry.getConnection())); } pool.release(entry, reusable); } @Override public void setMaxTotal(final int max) { pool.setMaxTotal(max); } @Override public int getMaxTotal() { return pool.getMaxTotal(); } @Override public void setDefaultMaxPerRoute(final int max) { pool.setDefaultMaxPerRoute(max); } @Override public int getDefaultMaxPerRoute() { return pool.getDefaultMaxPerRoute(); } @Override public void setMaxPerRoute(final T route, final int max) { pool.setMaxPerRoute(route, max); } @Override public int getMaxPerRoute(final T route) { return pool.getMaxPerRoute(route); } @Override public void closeIdle(final TimeValue idleTime) { pool.closeIdle(idleTime); } @Override public void closeExpired() { pool.closeExpired(); } @Override public Set getRoutes() { return pool.getRoutes(); } @Override public PoolStats getTotalStats() { return pool.getTotalStats(); } @Override public PoolStats getStats(final T route) { return pool.getStats(route); } @Override public String toString() { return pool.toString(); } static class PerRoutePool { private final Map, AtomicLong> entryMap; private final Lock lock; PerRoutePool() { this.entryMap = new HashMap<>(); this.lock = new ReentrantLock(); } AtomicLong getCounter(final PoolEntry entry) { return entryMap.computeIfAbsent(entry, e -> new AtomicLong()); } long track(final PoolEntry entry) { lock.lock(); try { final AtomicLong counter = getCounter(entry); return counter.incrementAndGet(); } finally { lock.unlock(); } } PoolEntry lease() { lock.lock(); try { return entryMap.entrySet().stream() .filter(e -> { final C conn = e.getKey().getConnection(); return conn != null && conn.isOpen(); }) .min(Comparator.comparingLong(e -> e.getValue().get())) .map(e -> { e.getValue().incrementAndGet(); return e.getKey(); }) .orElse(null); } finally { lock.unlock(); } } long release(final PoolEntry entry, final boolean reusable) { lock.lock(); try { if (!reusable) { entry.discardConnection(CloseMode.GRACEFUL); } final AtomicLong counter = entryMap.compute(entry, (e, c) -> { if (c == null) { return null; } final long count = c.decrementAndGet(); return count > 0 ? c : null; }); return counter != null ? counter.get() : 0L; } finally { lock.unlock(); } } long getCount(final PoolEntry entry) { lock.lock(); try { final AtomicLong counter = entryMap.get(entry); return counter == null ? 0L : counter.get(); } finally { lock.unlock(); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/MultihomeConnectionInitiator.java0100644 0000000 0000000 00000006531 00000250600 031652 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.net.SocketAddress; import java.util.concurrent.Future; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; /** * Multi-home DNS aware implementation of {@link ConnectionInitiator}. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class MultihomeConnectionInitiator implements ConnectionInitiator { private final ConnectionInitiator connectionInitiator; private final MultihomeIOSessionRequester sessionRequester; public MultihomeConnectionInitiator( final ConnectionInitiator connectionInitiator, final DnsResolver dnsResolver) { this.connectionInitiator = Args.notNull(connectionInitiator, "Connection initiator"); this.sessionRequester = new MultihomeIOSessionRequester(dnsResolver); } @Override public Future connect( final NamedEndpoint remoteEndpoint, final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final FutureCallback callback) { Args.notNull(remoteEndpoint, "Remote endpoint"); return sessionRequester.connect(connectionInitiator, remoteEndpoint, remoteAddress, localAddress, connectTimeout, attachment, callback); } public Future connect( final NamedEndpoint remoteEndpoint, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final FutureCallback callback) { Args.notNull(remoteEndpoint, "Remote endpoint"); return sessionRequester.connect(connectionInitiator, remoteEndpoint, localAddress, connectTimeout, attachment, callback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/MultihomeIOSessionRequester.java0100644 0000000 0000000 00000022310 00000250600 031434 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.io.IOException; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.SocketAddress; import java.net.UnknownHostException; import java.util.List; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.ConnectExceptionSupport; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; final class MultihomeIOSessionRequester { private static final Logger LOG = LoggerFactory.getLogger(MultihomeIOSessionRequester.class); private final DnsResolver dnsResolver; MultihomeIOSessionRequester(final DnsResolver dnsResolver) { this.dnsResolver = dnsResolver != null ? dnsResolver : SystemDefaultDnsResolver.INSTANCE; } public Future connect( final ConnectionInitiator connectionInitiator, final NamedEndpoint remoteEndpoint, final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final FutureCallback callback) { final ComplexFuture future = new ComplexFuture<>(callback); if (remoteAddress != null) { if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connecting {} to {} ({})", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), localAddress, remoteAddress, connectTimeout); } final Future sessionFuture = connectionInitiator.connect(remoteEndpoint, remoteAddress, localAddress, connectTimeout, attachment, new FutureCallback() { @Override public void completed(final IOSession session) { future.completed(session); } @Override public void failed(final Exception cause) { if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connection to {} failed ({}); terminating operation", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), remoteAddress, cause.getClass()); } if (cause instanceof IOException) { future.failed(ConnectExceptionSupport.enhance((IOException) cause, remoteEndpoint, (remoteAddress instanceof InetSocketAddress) ? new InetAddress[] { ((InetSocketAddress) remoteAddress).getAddress() } : new InetAddress[] {})); } else { future.failed(cause); } } @Override public void cancelled() { future.cancel(); } }); future.setDependency(sessionFuture); return future; } if (LOG.isDebugEnabled()) { LOG.debug("{} resolving remote address", remoteEndpoint.getHostName()); } final List remoteAddresses; try { remoteAddresses = dnsResolver.resolve(remoteEndpoint.getHostName(), remoteEndpoint.getPort()); if (remoteAddresses == null || remoteAddresses.isEmpty()) { throw new UnknownHostException(remoteEndpoint.getHostName()); } } catch (final UnknownHostException ex) { future.failed(ex); return future; } if (LOG.isDebugEnabled()) { LOG.debug("{} resolved to {}", remoteEndpoint.getHostName(), remoteAddresses); } final Runnable runnable = new Runnable() { private final AtomicInteger attempt = new AtomicInteger(0); void executeNext() { final int index = attempt.getAndIncrement(); final InetSocketAddress remoteAddress = remoteAddresses.get(index); if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connecting {}->{} ({})", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), localAddress, remoteAddress, connectTimeout); } final Future sessionFuture = connectionInitiator.connect( remoteEndpoint, remoteAddress, localAddress, connectTimeout, attachment, new FutureCallback() { @Override public void completed(final IOSession session) { if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connected {}->{} as {}", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), localAddress, remoteAddress, session.getId()); } future.completed(session); } @Override public void failed(final Exception cause) { if (attempt.get() >= remoteAddresses.size()) { if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connection to {} failed ({}); terminating operation", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), remoteAddress, cause.getClass()); } if (cause instanceof IOException) { final InetAddress[] addresses = remoteAddresses.stream() .filter(addr -> addr instanceof InetSocketAddress) .map(addr -> ((InetSocketAddress) addr).getAddress()) .toArray(InetAddress[]::new); future.failed(ConnectExceptionSupport.enhance((IOException) cause, remoteEndpoint, addresses)); } else { future.failed(cause); } } else { if (LOG.isDebugEnabled()) { LOG.debug("{}:{} connection to {} failed ({}); retrying connection to the next address", remoteEndpoint.getHostName(), remoteEndpoint.getPort(), remoteAddress, cause.getClass()); } executeNext(); } } @Override public void cancelled() { future.cancel(); } }); future.setDependency(sessionFuture); } @Override public void run() { executeNext(); } }; runnable.run(); return future; } public Future connect( final ConnectionInitiator connectionInitiator, final NamedEndpoint remoteEndpoint, final SocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final FutureCallback callback) { return connect(connectionInitiator, remoteEndpoint, null, localAddress, connectTimeout, attachment, callback); } } ././@LongLink0100644 0000000 0000000 00000000147 00000250600 011613 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.ja0100644 0000000 0000000 00000110070 00000250600 032526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.nio.file.Path; import java.util.Set; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.PrefixedIncrementingId; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncClientConnectionOperator; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.nio.ManagedAsyncClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.http.nio.command.StaleCheckCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.nio.command.PingCommand; import org.apache.hc.core5.http2.nio.support.BasicPingHandler; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.DefaultDisposalCallback; import org.apache.hc.core5.pool.LaxConnPool; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.pool.RouteSegmentedConnPool; import org.apache.hc.core5.pool.StrictConnPool; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@code PoolingAsyncClientConnectionManager} maintains a pool of non-blocking * {@link org.apache.hc.core5.http.HttpConnection}s and is able to service * connection requests from multiple execution threads. Connections are pooled * on a per route basis. A request for a route which already the manager has * persistent connections for available in the pool will be services by leasing * a connection from the pool rather than creating a new connection. *

* {@code PoolingAsyncClientConnectionManager} maintains a maximum limit * of connection on a per route basis and in total. Connection limits * can be adjusted using {@link ConnPoolControl} methods. *

* Total time to live (TTL) set at construction time defines maximum life span * of persistent connections regardless of their expiration setting. No persistent * connection will be re-used past its TTL value. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class PoolingAsyncClientConnectionManager implements AsyncClientConnectionManager, ConnPoolControl { private static final Logger LOG = LoggerFactory.getLogger(PoolingAsyncClientConnectionManager.class); public static final int DEFAULT_MAX_TOTAL_CONNECTIONS = 25; public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 5; private final ManagedConnPool pool; private final AsyncClientConnectionOperator connectionOperator; private final AtomicBoolean closed; private volatile Resolver connectionConfigResolver; private volatile Resolver tlsConfigResolver; public PoolingAsyncClientConnectionManager() { this(RegistryBuilder.create() .register(URIScheme.HTTPS.getId(), DefaultClientTlsStrategy.createDefault()) .build()); } public PoolingAsyncClientConnectionManager(final Lookup tlsStrategyLookup) { this(tlsStrategyLookup, PoolConcurrencyPolicy.STRICT, TimeValue.NEG_ONE_MILLISECOND); } public PoolingAsyncClientConnectionManager( final Lookup tlsStrategyLookup, final PoolConcurrencyPolicy poolConcurrencyPolicy, final TimeValue timeToLive) { this(tlsStrategyLookup, poolConcurrencyPolicy, PoolReusePolicy.LIFO, timeToLive); } public PoolingAsyncClientConnectionManager( final Lookup tlsStrategyLookup, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive) { this(tlsStrategyLookup, poolConcurrencyPolicy, poolReusePolicy, timeToLive, null, null); } public PoolingAsyncClientConnectionManager( final Lookup tlsStrategyLookup, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this(new DefaultAsyncClientConnectionOperator(tlsStrategyLookup, schemePortResolver, dnsResolver), poolConcurrencyPolicy, poolReusePolicy, timeToLive, false); } @Internal public PoolingAsyncClientConnectionManager( final AsyncClientConnectionOperator connectionOperator, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final boolean messageMultiplexing) { this.connectionOperator = Args.notNull(connectionOperator, "Connection operator"); final ManagedConnPool managedConnPool; switch (poolConcurrencyPolicy != null ? poolConcurrencyPolicy : PoolConcurrencyPolicy.STRICT) { case STRICT: managedConnPool = new StrictConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, DEFAULT_MAX_TOTAL_CONNECTIONS, timeToLive, poolReusePolicy, new DefaultDisposalCallback<>(), null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; case LAX: managedConnPool = new LaxConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, timeToLive, poolReusePolicy, null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; case OFFLOCK: managedConnPool = new RouteSegmentedConnPool<>( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, DEFAULT_MAX_TOTAL_CONNECTIONS, timeToLive, poolReusePolicy, new DefaultDisposalCallback<>()); break; default: throw new IllegalArgumentException("Unexpected PoolConcurrencyPolicy value: " + poolConcurrencyPolicy); } this.pool = messageMultiplexing ? new H2SharingConnPool<>(managedConnPool) : managedConnPool; this.closed = new AtomicBoolean(false); } @Internal protected PoolingAsyncClientConnectionManager( final ManagedConnPool pool, final AsyncClientConnectionOperator connectionOperator) { this.connectionOperator = Args.notNull(connectionOperator, "Connection operator"); this.pool = Args.notNull(pool, "Connection pool"); this.closed = new AtomicBoolean(false); } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("Shutdown connection pool {}", closeMode); } this.pool.close(closeMode); LOG.debug("Connection pool shut down"); } } private InternalConnectionEndpoint cast(final AsyncConnectionEndpoint endpoint) { if (endpoint instanceof InternalConnectionEndpoint) { return (InternalConnectionEndpoint) endpoint; } throw new IllegalStateException("Unexpected endpoint class: " + endpoint.getClass()); } private ConnectionConfig resolveConnectionConfig(final HttpRoute route) { final Resolver resolver = this.connectionConfigResolver; final ConnectionConfig connectionConfig = resolver != null ? resolver.resolve(route) : null; return connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } private TlsConfig resolveTlsConfig(final HttpHost host) { final Resolver resolver = this.tlsConfigResolver; TlsConfig tlsConfig = resolver != null ? resolver.resolve(host) : null; if (tlsConfig == null) { tlsConfig = TlsConfig.DEFAULT; } if (URIScheme.HTTP.same(host.getSchemeName()) && tlsConfig.getHttpVersionPolicy() == HttpVersionPolicy.NEGOTIATE) { // Plain HTTP does not support protocol negotiation. // Fall back to HTTP/1.1 tlsConfig = TlsConfig.copy(tlsConfig) .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_1) .build(); } return tlsConfig; } @Override public Future lease( final String id, final HttpRoute route, final Object state, final Timeout requestTimeout, final FutureCallback callback) { if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease request ({}) {}", id, requestTimeout, ConnPoolSupport.formatStats(route, state, pool)); } return new Future() { final ConnectionConfig connectionConfig = resolveConnectionConfig(route); final BasicFuture resultFuture = new BasicFuture<>(callback); final Future> leaseFuture = pool.lease( route, state, requestTimeout, new FutureCallback>() { @Override public void completed(final PoolEntry poolEntry) { if (poolEntry.hasConnection()) { final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (TimeValue.isNonNegative(timeToLive)) { if (timeToLive.getDuration() == 0 || Deadline.calculate(poolEntry.getCreated(), timeToLive).isExpired()) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } } if (poolEntry.hasConnection()) { final TimeValue idleTimeout = connectionConfig.getIdleTimeout(); if (TimeValue.isPositive(idleTimeout)) { if (Deadline.calculate(poolEntry.getUpdated(), idleTimeout).isExpired()) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } } if (poolEntry.hasConnection()) { final ManagedAsyncClientConnection connection = poolEntry.getConnection(); final TimeValue timeValue = connectionConfig.getValidateAfterInactivity(); if (connection.isOpen() && TimeValue.isNonNegative(timeValue)) { if (timeValue.getDuration() == 0 || Deadline.calculate(poolEntry.getUpdated(), timeValue).isExpired()) { final ProtocolVersion protocolVersion = connection.getProtocolVersion(); if (protocolVersion != null && protocolVersion.greaterEquals(HttpVersion.HTTP_2_0)) { connection.submitCommand(new PingCommand(new BasicPingHandler(result -> { if (result == null || !result) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(connection)); } poolEntry.discardConnection(CloseMode.GRACEFUL); } leaseCompleted(poolEntry); })), Command.Priority.IMMEDIATE); return; } else { connection.submitCommand(new StaleCheckCommand(result -> { if (!Boolean.TRUE.equals(result)) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(connection)); } poolEntry.discardConnection(CloseMode.GRACEFUL); } leaseCompleted(poolEntry); }), Command.Priority.IMMEDIATE); return; } } } } leaseCompleted(poolEntry); } void leaseCompleted(final PoolEntry poolEntry) { final ManagedAsyncClientConnection connection = poolEntry.getConnection(); if (connection != null) { connection.activate(); if (connectionConfig.getSocketTimeout() != null) { connection.setSocketTimeout(connectionConfig.getSocketTimeout()); } } if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint leased {}", id, ConnPoolSupport.formatStats(route, state, pool)); } final AsyncConnectionEndpoint endpoint = new InternalConnectionEndpoint(poolEntry); if (LOG.isDebugEnabled()) { LOG.debug("{} acquired {}", id, ConnPoolSupport.getId(endpoint)); } resultFuture.completed(endpoint); } @Override public void failed(final Exception ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease failed", id); } resultFuture.failed(ex); } @Override public void cancelled() { if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease cancelled", id); } resultFuture.cancel(); } }); @Override public AsyncConnectionEndpoint get() throws InterruptedException, ExecutionException { return resultFuture.get(); } @Override public AsyncConnectionEndpoint get( final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { return resultFuture.get(timeout, unit); } @Override public boolean cancel(final boolean mayInterruptIfRunning) { return leaseFuture.cancel(mayInterruptIfRunning); } @Override public boolean isDone() { return resultFuture.isDone(); } @Override public boolean isCancelled() { return resultFuture.isCancelled(); } }; } @Override public void release(final AsyncConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) { Args.notNull(endpoint, "Managed endpoint"); Args.notNull(keepAlive, "Keep-alive time"); final PoolEntry entry = cast(endpoint).detach(); if (entry == null) { return; } if (LOG.isDebugEnabled()) { LOG.debug("{} releasing endpoint", ConnPoolSupport.getId(endpoint)); } if (this.isClosed()) { return; } final ManagedAsyncClientConnection connection = entry.getConnection(); boolean reusable = connection != null && connection.isOpen(); try { if (reusable) { entry.updateState(state); entry.updateExpiry(keepAlive); connection.passivate(); if (LOG.isDebugEnabled()) { final String s; if (TimeValue.isPositive(keepAlive)) { s = "for " + keepAlive; } else { s = "indefinitely"; } LOG.debug("{} connection {} can be kept alive {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(connection), s); } } } catch (final RuntimeException ex) { reusable = false; throw ex; } finally { pool.release(entry, reusable); if (LOG.isDebugEnabled()) { LOG.debug("{} connection released {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.formatStats(entry.getRoute(), entry.getState(), pool)); } } } @Override public Future connect( final AsyncConnectionEndpoint endpoint, final ConnectionInitiator connectionInitiator, final Timeout timeout, final Object attachment, final HttpContext context, final FutureCallback callback) { Args.notNull(endpoint, "Endpoint"); Args.notNull(connectionInitiator, "Connection initiator"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final ComplexFuture resultFuture = new ComplexFuture<>(callback); if (internalEndpoint.isConnected()) { resultFuture.completed(endpoint); return resultFuture; } final PoolEntry poolEntry = internalEndpoint.getPoolEntry(); final HttpRoute route = poolEntry.getRoute(); final Path unixDomainSocket = route.getUnixDomainSocket(); final HttpHost firstHop = route.getProxyHost() != null ? route.getProxyHost() : route.getTargetHost(); final ConnectionConfig connectionConfig = resolveConnectionConfig(route); final Timeout connectTimeout = timeout != null ? timeout : connectionConfig.getConnectTimeout(); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting endpoint to {} ({})", ConnPoolSupport.getId(endpoint), firstHop, connectTimeout); } final Object connectAttachment; if (route.isTunnelled()) { connectAttachment = null; } else if (attachment instanceof TlsConfig) { connectAttachment = attachment; } else { connectAttachment = resolveTlsConfig(route.getTargetHost()); } final Future connectFuture = connectionOperator.connect( connectionInitiator, firstHop, unixDomainSocket, route.getTargetName(), route.getLocalSocketAddress(), connectTimeout, connectAttachment, context, new FutureCallback() { @Override public void completed(final ManagedAsyncClientConnection connection) { try { if (LOG.isDebugEnabled()) { LOG.debug("{} connected {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(connection)); } final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { connection.setSocketTimeout(socketTimeout); } poolEntry.assignConnection(connection); resultFuture.completed(internalEndpoint); } catch (final RuntimeException ex) { resultFuture.failed(ex); } } @Override public void failed(final Exception ex) { resultFuture.failed(ex); } @Override public void cancelled() { resultFuture.cancel(); } }); resultFuture.setDependency(connectFuture); return resultFuture; } @Override public void upgrade( final AsyncConnectionEndpoint endpoint, final Object attachment, final HttpContext context, final FutureCallback callback) { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final PoolEntry poolEntry = internalEndpoint.getValidatedPoolEntry(); final HttpRoute route = poolEntry.getRoute(); final HttpHost target = route.getTargetHost(); connectionOperator.upgrade( poolEntry.getConnection(), target, route.getTargetName(), attachment != null ? attachment : resolveTlsConfig(target), context, new CallbackContribution(callback) { @Override public void completed(final ManagedAsyncClientConnection connection) { if (LOG.isDebugEnabled()) { LOG.debug("{} upgraded {}", ConnPoolSupport.getId(internalEndpoint), ConnPoolSupport.getId(connection)); } final TlsDetails tlsDetails = connection.getTlsDetails(); if (tlsDetails != null && ApplicationProtocol.HTTP_2.id.equals(tlsDetails.getApplicationProtocol())) { connection.switchProtocol(ApplicationProtocol.HTTP_2.id, new CallbackContribution(callback) { @Override public void completed(final ProtocolIOSession protocolIOSession) { if (callback != null) { callback.completed(endpoint); } } }); } else { if (callback != null) { callback.completed(endpoint); } } } }); } @Override public void upgrade(final AsyncConnectionEndpoint endpoint, final Object attachment, final HttpContext context) { upgrade(endpoint, attachment, context, null); } @Override public Set getRoutes() { return pool.getRoutes(); } @Override public void setMaxTotal(final int max) { pool.setMaxTotal(max); } @Override public int getMaxTotal() { return pool.getMaxTotal(); } @Override public void setDefaultMaxPerRoute(final int max) { pool.setDefaultMaxPerRoute(max); } @Override public int getDefaultMaxPerRoute() { return pool.getDefaultMaxPerRoute(); } @Override public void setMaxPerRoute(final HttpRoute route, final int max) { pool.setMaxPerRoute(route, max); } @Override public int getMaxPerRoute(final HttpRoute route) { return pool.getMaxPerRoute(route); } @Override public void closeIdle(final TimeValue idletime) { if (isClosed()) { return; } pool.closeIdle(idletime); } @Override public void closeExpired() { if (isClosed()) { return; } pool.closeExpired(); } @Override public PoolStats getTotalStats() { return pool.getTotalStats(); } @Override public PoolStats getStats(final HttpRoute route) { return pool.getStats(route); } /** * Sets the same {@link ConnectionConfig} for all routes * * @since 5.2 */ public void setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @since 5.2 */ public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; } /** * Sets the same {@link ConnectionConfig} for all hosts * * @since 5.2 */ public void setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @since 5.2 */ public void setTlsConfigResolver(final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; } void closeIfExpired(final PoolEntry entry) { final long now = System.currentTimeMillis(); if (entry.getExpiryDeadline().isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } else { final ConnectionConfig connectionConfig = resolveConnectionConfig(entry.getRoute()); final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (timeToLive != null && Deadline.calculate(entry.getCreated(), timeToLive).isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } } } /** * @deprecated Use custom {@link #setConnectionConfigResolver(Resolver)} */ @Deprecated public TimeValue getValidateAfterInactivity() { return ConnectionConfig.DEFAULT.getValidateAfterInactivity(); } /** * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object, Timeout, * FutureCallback)} leased} to the consumer. Negative values passed * to this method disable connection validation. This check helps detect connections * that have become stale (half-closed) while kept inactive in the pool. * * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); } private static final PrefixedIncrementingId INCREMENTING_ID = new PrefixedIncrementingId("ep-"); static class InternalConnectionEndpoint extends AsyncConnectionEndpoint implements ConnectionHolder, Identifiable { private final AtomicReference> poolEntryRef; private final String id; InternalConnectionEndpoint(final PoolEntry poolEntry) { this.poolEntryRef = new AtomicReference<>(poolEntry); this.id = INCREMENTING_ID.getNextId(); } @Override public String getId() { return id; } PoolEntry getPoolEntry() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry == null) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry getValidatedPoolEntry() { final PoolEntry poolEntry = getPoolEntry(); if (poolEntry.getConnection() == null) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry detach() { return poolEntryRef.getAndSet(null); } @Override public void close(final CloseMode closeMode) { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} close {}", id, closeMode); } poolEntry.discardConnection(closeMode); } } @Override public boolean isConnected() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry == null) { return false; } final ManagedAsyncClientConnection connection = poolEntry.getConnection(); if (connection == null) { return false; } if (!connection.isOpen()) { poolEntry.discardConnection(CloseMode.IMMEDIATE); return false; } return true; } @Override public void setSocketTimeout(final Timeout timeout) { getValidatedPoolEntry().getConnection().setSocketTimeout(timeout); } @Override public void execute( final String exchangeId, final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { final ManagedAsyncClientConnection connection = getValidatedPoolEntry().getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} executing exchange {} over {}", id, exchangeId, ConnPoolSupport.getId(connection)); } context.setProtocolVersion(connection.getProtocolVersion()); connection.submitCommand( new RequestExecutionCommand(exchangeHandler, pushHandlerFactory, context), Command.Priority.NORMAL); } @Override public EndpointInfo getInfo() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { final ManagedAsyncClientConnection connection = poolEntry.getConnection(); if (connection != null && connection.isOpen()) { final TlsDetails tlsDetails = connection.getTlsDetails(); return new EndpointInfo(connection.getProtocolVersion(), tlsDetails != null ? tlsDetails.getSSLSession() : null); } } return null; } @Override public HttpConnection get() { final PoolEntry poolEntry = poolEntryRef.get(); return poolEntry != null ? poolEntry.getConnection() : null; } } /** * Method that can be called to determine whether the connection manager has been shut down and * is closed or not. * * @return {@code true} if the connection manager has been shut down and is closed, otherwise * return {@code false}. * @since 5.4 */ public boolean isClosed() { return this.closed.get(); } } ././@LongLink0100644 0000000 0000000 00000000156 00000250600 011613 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBui0100644 0000000 0000000 00000026413 00000250600 032604 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.nio.AsyncClientConnectionOperator; import org.apache.hc.client5.http.ssl.ConscryptClientTlsStrategy; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.util.ReflectionUtils; import org.apache.hc.core5.util.TimeValue; /** * Builder for {@link PoolingAsyncClientConnectionManager} instances. *

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #build()}. *

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @since 5.0 */ public class PoolingAsyncClientConnectionManagerBuilder { private TlsStrategy tlsStrategy; private SchemePortResolver schemePortResolver; private DnsResolver dnsResolver; private PoolConcurrencyPolicy poolConcurrencyPolicy; private PoolReusePolicy poolReusePolicy; private boolean systemProperties; private int maxConnTotal; private int maxConnPerRoute; private Resolver connectionConfigResolver; private Resolver tlsConfigResolver; private boolean messageMultiplexing; public static PoolingAsyncClientConnectionManagerBuilder create() { return new PoolingAsyncClientConnectionManagerBuilder(); } @Internal protected PoolingAsyncClientConnectionManagerBuilder() { super(); } /** * Sets {@link TlsStrategy} instance for TLS connections. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setTlsStrategy( final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } /** * Sets {@link DnsResolver} instance. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setDnsResolver(final DnsResolver dnsResolver) { this.dnsResolver = dnsResolver; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@link PoolConcurrencyPolicy} value. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setPoolConcurrencyPolicy(final PoolConcurrencyPolicy poolConcurrencyPolicy) { this.poolConcurrencyPolicy = poolConcurrencyPolicy; return this; } /** * Sets {@link PoolReusePolicy} value. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setConnPoolPolicy(final PoolReusePolicy poolReusePolicy) { this.poolReusePolicy = poolReusePolicy; return this; } /** * Sets maximum total connection value. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setMaxConnTotal(final int maxConnTotal) { this.maxConnTotal = maxConnTotal; return this; } /** * Sets maximum connection per route value. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder setMaxConnPerRoute(final int maxConnPerRoute) { this.maxConnPerRoute = maxConnPerRoute; return this; } /** * Sets the same {@link ConnectionConfig} for all routes. * * @return this instance. * @since 5.2 */ public final PoolingAsyncClientConnectionManagerBuilder setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; return this; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @return this instance. * @since 5.2 */ public final PoolingAsyncClientConnectionManagerBuilder setConnectionConfigResolver( final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; return this; } /** * Sets the same {@link TlsConfig} for all hosts. * * @return this instance. * @since 5.2 */ public final PoolingAsyncClientConnectionManagerBuilder setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; return this; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @return this instance. * @since 5.2 */ public final PoolingAsyncClientConnectionManagerBuilder setTlsConfigResolver( final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; return this; } /** * Sets maximum time to live for persistent connections * * @return this instance. * @deprecated Use {@link #setDefaultConnectionConfig(ConnectionConfig)} */ @Deprecated public final PoolingAsyncClientConnectionManagerBuilder setConnectionTimeToLive(final TimeValue timeToLive) { setDefaultConnectionConfig(ConnectionConfig.custom() .setTimeToLive(timeToLive) .build()); return this; } /** * Sets period after inactivity after which persistent * connections must be checked to ensure they are still valid. * * @return this instance. * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public final PoolingAsyncClientConnectionManagerBuilder setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final PoolingAsyncClientConnectionManagerBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * Use experimental connections pool implementation that acts as a caching facade * in front of a standard connection pool and shares already leased connections * to multiplex message exchanges over active HTTP/2 connections. *

* Please note this flag has no effect on HTTP/1.1 and HTTP/1.0 connections. *

* This feature is considered experimenal * * @since 5.5 * @return this instance. */ @Experimental public final PoolingAsyncClientConnectionManagerBuilder setMessageMultiplexing(final boolean messageMultiplexing) { this.messageMultiplexing = messageMultiplexing; return this; } @Internal protected AsyncClientConnectionOperator createConnectionOperator( final TlsStrategy tlsStrategy, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { return new DefaultAsyncClientConnectionOperator( RegistryBuilder.create() .register(URIScheme.HTTPS.getId(), tlsStrategy) .build(), schemePortResolver, dnsResolver); } public PoolingAsyncClientConnectionManager build() { final TlsStrategy tlsStrategyCopy; if (tlsStrategy != null) { tlsStrategyCopy = tlsStrategy; } else { if (ReflectionUtils.determineJRELevel() <= 8 && ConscryptClientTlsStrategy.isSupported()) { if (systemProperties) { tlsStrategyCopy = ConscryptClientTlsStrategy.getSystemDefault(); } else { tlsStrategyCopy = ConscryptClientTlsStrategy.getDefault(); } } else { if (systemProperties) { tlsStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } } final PoolingAsyncClientConnectionManager poolingmgr = new PoolingAsyncClientConnectionManager( createConnectionOperator(tlsStrategyCopy, schemePortResolver, dnsResolver), poolConcurrencyPolicy, poolReusePolicy, null, messageMultiplexing); poolingmgr.setConnectionConfigResolver(connectionConfigResolver); poolingmgr.setTlsConfigResolver(tlsConfigResolver); if (maxConnTotal > 0) { poolingmgr.setMaxTotal(maxConnTotal); } if (maxConnPerRoute > 0) { poolingmgr.setDefaultMaxPerRoute(maxConnPerRoute); } return poolingmgr; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/package-info.java0100644 0000000 0000000 00000002466 00000250600 026333 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection management functions based the asynchronous * connection management APIs. */ package org.apache.hc.client5.http.impl.nio; httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/0040755 0000000 0000000 00000000000 00000250600 024041 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/BasicRouteDirector.java0100644 0000000 0000000 00000014234 00000250600 030441 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Basic {@link HttpRouteDirector} implementation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicRouteDirector implements HttpRouteDirector { /** * Default instance of {@link BasicRouteDirector}. * * @since 5.2 */ public static final BasicRouteDirector INSTANCE = new BasicRouteDirector(); /** * Provides the next step. * * @param plan the planned route * @param fact the currently established route, or * {@code null} if nothing is established * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure. * 0 is for success, a negative value for failure. */ @Override public int nextStep(final RouteInfo plan, final RouteInfo fact) { Args.notNull(plan, "Planned route"); int step = UNREACHABLE; if (fact == null || fact.getHopCount() < 1) { step = firstStep(plan); } else if (plan.getHopCount() > 1) { step = proxiedStep(plan, fact); } else { step = directStep(plan, fact); } return step; } // nextStep /** * Determines the first step to establish a route. * * @param plan the planned route * * @return the first step */ protected int firstStep(final RouteInfo plan) { return (plan.getHopCount() > 1) ? CONNECT_PROXY : CONNECT_TARGET; } /** * Determines the next step to establish a direct connection. * * @param plan the planned route * @param fact the currently established route * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure */ protected int directStep(final RouteInfo plan, final RouteInfo fact) { if (fact.getHopCount() > 1) { return UNREACHABLE; } if (!plan.getTargetHost().equals(fact.getTargetHost())) { return UNREACHABLE; // If the security is too low, we could now suggest to layer // a secure protocol on the direct connection. Layering on direct // connections has not been supported in HttpClient 3.x, we don't // consider it here until there is a real-life use case for it. } // Should we tolerate if security is better than planned? // (plan.isSecure() && !fact.isSecure()) if (plan.isSecure() != fact.isSecure()) { return UNREACHABLE; } // Local address has to match only if the plan specifies one. if (plan.getLocalAddress() != null && !plan.getLocalAddress().equals(fact.getLocalAddress())) { return UNREACHABLE; } return COMPLETE; } /** * Determines the next step to establish a connection via proxy. * * @param plan the planned route * @param fact the currently established route * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure */ protected int proxiedStep(final RouteInfo plan, final RouteInfo fact) { if (fact.getHopCount() <= 1) { return UNREACHABLE; } if (!plan.getTargetHost().equals(fact.getTargetHost())) { return UNREACHABLE; } final int phc = plan.getHopCount(); final int fhc = fact.getHopCount(); if (phc < fhc) { return UNREACHABLE; } for (int i = 0; i < fhc - 1; i++) { if (!plan.getHopTarget(i).equals(fact.getHopTarget(i))) { return UNREACHABLE; } } // now we know that the target matches and proxies so far are the same if (phc > fhc) { return TUNNEL_PROXY; // need to extend the proxy chain } // proxy chain and target are the same, check tunnelling and layering if (fact.isTunnelled() && !plan.isTunnelled() || fact.isLayered() && !plan.isLayered()) { return UNREACHABLE; } if (plan.isTunnelled() && !fact.isTunnelled()) { return TUNNEL_TARGET; } if (plan.isLayered() && !fact.isLayered()) { return LAYER_PROTOCOL; } // tunnel and layering are the same, remains to check the security // Should we tolerate if security is better than planned? // (plan.isSecure() && !fact.isSecure()) if (plan.isSecure() != fact.isSecure()) { return UNREACHABLE; } return COMPLETE; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DefaultProxyRoutePlanner.java0100644 0000000 0000000 00000004467 00000250600 031701 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Implementation of an {@link org.apache.hc.client5.http.routing.HttpRoutePlanner} * that routes requests through a default proxy. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultProxyRoutePlanner extends DefaultRoutePlanner { private final HttpHost proxy; public DefaultProxyRoutePlanner(final HttpHost proxy, final SchemePortResolver schemePortResolver) { super(schemePortResolver); this.proxy = Args.notNull(proxy, "Proxy host"); } public DefaultProxyRoutePlanner(final HttpHost proxy) { this(proxy, null); } @Override protected HttpHost determineProxy( final HttpHost target, final HttpContext context) throws HttpException { return proxy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DefaultRoutePlanner.java0100644 0000000 0000000 00000012677 00000250600 030641 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetAddress; import java.nio.file.Path; import java.util.Objects; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.net.URIAuthority; /** * Default implementation of an {@link HttpRoutePlanner}. It will not make use of * any Java system properties, nor of system or browser proxy settings. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultRoutePlanner implements HttpRoutePlanner { private final SchemePortResolver schemePortResolver; public DefaultRoutePlanner(final SchemePortResolver schemePortResolver) { super(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } private static boolean sameNamedEndpoint(final NamedEndpoint n1, final NamedEndpoint n2) { if (n1 == null || n2 == null) { return false; } return Objects.equals(n1.getHostName(), n2.getHostName()) && n1.getPort() == n2.getPort(); } @Override public final HttpRoute determineRoute(final HttpHost host, final HttpRequest request, final HttpContext context) throws HttpException { if (host == null) { throw new ProtocolException("Target host is not specified"); } final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig config = clientContext.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") HttpHost proxy = config.getProxy(); if (proxy == null) { proxy = determineProxy(host, context); } final HttpHost target = RoutingSupport.normalize(host, schemePortResolver); if (target.getPort() < 0) { throw new ProtocolException("Unroutable protocol scheme: " + target); } final boolean secure = URIScheme.HTTPS.same(target.getSchemeName()); final URIAuthority authority; if (secure && request != null && !sameNamedEndpoint(request.getAuthority(), host)) { authority = request.getAuthority(); } else { authority = null; } final Path unixDomainSocket = config.getUnixDomainSocket(); if (unixDomainSocket != null) { if (proxy != null) { throw new UnsupportedOperationException("Proxies are not supported over Unix domain sockets"); } return new HttpRoute(target, secure, unixDomainSocket); } final InetAddress inetAddress = determineLocalAddress(target, context); if (proxy == null) { return new HttpRoute(target, authority, inetAddress, secure); } return new HttpRoute(target, authority, inetAddress, proxy, secure); } @Override public final HttpRoute determineRoute(final HttpHost host, final HttpContext context) throws HttpException { return determineRoute(host, null, context); } /** * This implementation returns null. * * @throws HttpException may be thrown if overridden */ protected HttpHost determineProxy( final HttpHost target, final HttpContext context) throws HttpException { return null; } /** * This implementation returns null. * * @throws HttpException may be thrown if overridden */ protected InetAddress determineLocalAddress( final HttpHost firstHop, final HttpContext context) throws HttpException { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DistributedProxySelector.java0100644 0000000 0000000 00000016566 00000250600 031744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.IOException; import java.net.Proxy; import java.net.ProxySelector; import java.net.SocketAddress; import java.net.URI; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.concurrent.atomic.AtomicInteger; /** * A DistributedProxySelector is a custom {@link ProxySelector} implementation that * delegates proxy selection to a list of underlying ProxySelectors in a * distributed manner. It ensures that proxy selection is load-balanced * across the available ProxySelectors, and provides thread safety by * maintaining separate states for each thread. * *

The DistributedProxySelector class maintains a list of ProxySelectors, * a {@link ThreadLocal} variable for the current {@link ProxySelector}, and an {@link AtomicInteger} * to keep track of the shared index across all threads. When the select() * method is called, it delegates the proxy selection to the current * ProxySelector or the next available one in the list if the current one * returns an empty proxy list. Any exceptions that occur during proxy * selection are caught and ignored, and the next ProxySelector is tried. * *

The connectFailed() method notifies the active {@link ProxySelector} of a * connection failure, allowing the underlying ProxySelector to handle * connection failures according to its own logic. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.SAFE) public class DistributedProxySelector extends ProxySelector { private static final Logger LOG = LoggerFactory.getLogger(DistributedProxySelector.class); /** * A list of {@link ProxySelector} instances to be used by the DistributedProxySelector * for selecting proxies. */ private final List selectors; /** * A {@link ThreadLocal} variable holding the current {@link ProxySelector} for each thread, * ensuring thread safety when accessing the current {@link ProxySelector}. */ private final ThreadLocal currentSelector; /** * An {@link AtomicInteger} representing the shared index across all threads for * maintaining the current position in the list of ProxySelectors, ensuring * proper distribution of {@link ProxySelector} usage. */ private final AtomicInteger sharedIndex; /** * Constructs a DistributedProxySelector with the given list of {@link ProxySelector}. * The constructor initializes the currentSelector as a {@link ThreadLocal}, and * the sharedIndex as an {@link AtomicInteger}. * * @param selectors the list of ProxySelectors to use. * @throws IllegalArgumentException if the list is null or empty. */ public DistributedProxySelector(final List selectors) { if (selectors == null || selectors.isEmpty()) { throw new IllegalArgumentException("At least one ProxySelector is required"); } this.selectors = new ArrayList<>(selectors); this.currentSelector = new ThreadLocal<>(); this.sharedIndex = new AtomicInteger(); } /** * Selects a list of proxies for the given {@link URI} by delegating to the current * {@link ProxySelector} or the next available {@link ProxySelector} in the list if the current * one returns an empty proxy list. If an {@link Exception} occurs, it will be caught * and ignored, and the next {@link ProxySelector} will be tried. * * @param uri the {@link URI} to select a proxy for. * @return a list of proxies for the given {@link URI}. */ @Override public List select(final URI uri) { List result = Collections.emptyList(); ProxySelector selector; for (int i = 0; i < selectors.size(); i++) { selector = nextSelector(); if (LOG.isDebugEnabled()) { LOG.debug("Selecting next proxy selector for URI {}: {}", uri, selector); } try { currentSelector.set(selector); result = currentSelector.get().select(uri); if (!result.isEmpty()) { break; } } catch (final Exception e) { // ignore and try the next selector if (LOG.isDebugEnabled()) { LOG.debug("Exception caught while selecting proxy for URI {}: {}", uri, e.getMessage()); } } finally { currentSelector.remove(); } } return result; } /** * Notifies the active {@link ProxySelector} of a connection failure. This method * retrieves the current {@link ProxySelector} from the {@link ThreadLocal} variable and * delegates the handling of the connection failure to the underlying * ProxySelector's connectFailed() method. After handling the connection * failure, the current ProxySelector is removed from the {@link ThreadLocal} variable. * * @param uri the {@link URI} that failed to connect. * @param sa the {@link SocketAddress} of the proxy that failed to connect. * @param ioe the {@link IOException} that resulted from the failed connection. */ @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { final ProxySelector selector = currentSelector.get(); if (selector != null) { selector.connectFailed(uri, sa, ioe); currentSelector.remove(); if (LOG.isDebugEnabled()) { LOG.debug("Removed the current ProxySelector for URI {}: {}", uri, selector); } } } /** * Retrieves the next available {@link ProxySelector} in the list of selectors, * incrementing the shared index atomically to ensure proper distribution * across different threads. * * @return the next {@link ProxySelector} in the list. */ private ProxySelector nextSelector() { final int nextIndex = sharedIndex.getAndUpdate(i -> (i + 1) % selectors.size()); return selectors.get(nextIndex); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/SystemDefaultRoutePlanner.java0100644 0000000 0000000 00000011660 00000250600 032035 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.ProxySelector; import java.net.URI; import java.net.URISyntaxException; import java.util.List; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link org.apache.hc.client5.http.routing.HttpRoutePlanner} implementation * based on {@link ProxySelector}. By default, this class will pick up * the proxy settings of the JVM, either from system properties * or from the browser running the application. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class SystemDefaultRoutePlanner extends DefaultRoutePlanner { private final ProxySelector proxySelector; /** * @param proxySelector the proxy selector, or {@code null} for the system default */ public SystemDefaultRoutePlanner( final SchemePortResolver schemePortResolver, final ProxySelector proxySelector) { super(schemePortResolver); this.proxySelector = proxySelector; } /** * @param proxySelector the proxy selector, or {@code null} for the system default */ public SystemDefaultRoutePlanner(final ProxySelector proxySelector) { this(null, proxySelector); } @Override protected HttpHost determineProxy(final HttpHost target, final HttpContext context) throws HttpException { final URI targetURI; try { targetURI = new URI(target.toURI()); } catch (final URISyntaxException ex) { throw new HttpException("Cannot convert host to URI: " + target, ex); } ProxySelector proxySelectorInstance = this.proxySelector; if (proxySelectorInstance == null) { proxySelectorInstance = ProxySelector.getDefault(); } if (proxySelectorInstance == null) { //The proxy selector can be "unset", so we must be able to deal with a null selector return null; } final List proxies = proxySelectorInstance.select(targetURI); final Proxy p = chooseProxy(proxies); HttpHost result = null; if (p.type() == Proxy.Type.HTTP) { // convert the socket address to an HttpHost if (!(p.address() instanceof InetSocketAddress)) { throw new HttpException("Unable to handle non-Inet proxy address: " + p.address()); } final InetSocketAddress isa = (InetSocketAddress) p.address(); // assume default scheme (http) result = new HttpHost(null, isa.getAddress(), isa.getHostString(), isa.getPort()); } return result; } private Proxy chooseProxy(final List proxies) { Proxy result = null; // check the list for one we can use for (int i = 0; result == null && i < proxies.size(); i++) { final Proxy p = proxies.get(i); switch (p.type()) { case DIRECT: case HTTP: result = p; break; case SOCKS: // SOCKS hosts are not handled on the route level. // The socket may make use of the SOCKS host though. break; } } if (result == null) { //@@@ log as warning or info that only a socks proxy is available? // result can only be null if all proxies are socks proxies // socks proxies are not handled on the route planning level result = Proxy.NO_PROXY; } return result; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/package-info.java0100644 0000000 0000000 00000002425 00000250600 027230 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard client connection routing API implementations. */ package org.apache.hc.client5.http.impl.routing; httpclient5/src/main/java/org/apache/hc/client5/http/io/0040755 0000000 0000000 00000000000 00000250600 022020 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/io/ConnectionEndpoint.java0100644 0000000 0000000 00000010170 00000250600 026457 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpClientConnection; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Timeout; /** * Client endpoint leased from a connection manager. Client points can be used * to execute HTTP requests. *

* Once the endpoint is no longer needed it MUST be released with {@link #close(org.apache.hc.core5.io.CloseMode)} )}. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class ConnectionEndpoint implements ModalCloseable { /** * @deprecated Use {@link #execute(String, ClassicHttpRequest, RequestExecutor, HttpContext)} */ @Deprecated public abstract ClassicHttpResponse execute( String id, ClassicHttpRequest request, HttpRequestExecutor executor, HttpContext context) throws IOException, HttpException; /** * Executes HTTP request using the provided request executor. *

* Once the endpoint is no longer needed it MUST be released with {@link #close(org.apache.hc.core5.io.CloseMode)}. *

* * @param id unique operation ID or {@code null}. * @param request the request message. * @param requestExecutor the request executor. * @param context the execution context. * * @since 5.4 */ // In the next major release this method must be made abstract. public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { return requestExecutor.execute(request,null, context); } /** * Determines if the connection to the remote endpoint is still open and valid. */ public abstract boolean isConnected(); /** * Sets the socket timeout value. * * @param timeout timeout value */ public abstract void setSocketTimeout(Timeout timeout); /** * Returns information about the endpoint or {@code null} when not connected. * * @since 5.4 */ public EndpointInfo getInfo() { return null; } /** * @since 5.4 */ @Internal public interface RequestExecutor { ClassicHttpResponse execute( ClassicHttpRequest request, HttpClientConnection conn, HttpContext context) throws IOException, HttpException; } } httpclient5/src/main/java/org/apache/hc/client5/http/io/DetachedSocketFactory.java0100644 0000000 0000000 00000003370 00000250600 027065 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.Proxy; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * @since 5.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public interface DetachedSocketFactory { Socket create(Proxy proxy) throws IOException; /** * @since 5.5 */ default Socket create(String schemeName, Proxy proxy) throws IOException { return create(proxy); } } httpclient5/src/main/java/org/apache/hc/client5/http/io/HttpClientConnectionManager.java0100644 0000000 0000000 00000011246 00000250600 030255 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Represents a manager of persistent client connections. *

* The purpose of an HTTP connection manager is to serve as a factory for new * HTTP connections, manage persistent connections and synchronize access to * persistent connections making sure that only one thread of execution can * have access to a connection at a time. *

*

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 4.3 */ public interface HttpClientConnectionManager extends ModalCloseable { /** * Returns a {@link LeaseRequest} object which can be used to obtain * a {@link ConnectionEndpoint} to cancel the request by calling * {@link LeaseRequest#cancel()}. *

* Please note that newly allocated endpoints can be leased * {@link ConnectionEndpoint#isConnected() disconnected}. The consumer of the endpoint * is responsible for fully establishing the route to the endpoint target * by calling {@link #connect(ConnectionEndpoint, TimeValue, HttpContext)} * in order to connect directly to the target or to the first proxy hop, * and optionally calling {@link #upgrade(ConnectionEndpoint, HttpContext)} method * to upgrade the underlying transport to Transport Layer Security after having * executed a {@code CONNECT} method to all intermediate proxy hops. * * @param id unique operation ID or {@code null}. * @param route HTTP route of the requested connection. * @param requestTimeout lease request timeout. * @param state expected state of the connection or {@code null} * if the connection is not expected to carry any state. * @since 5.0 */ LeaseRequest lease(String id, HttpRoute route, Timeout requestTimeout, Object state); /** * Releases the endpoint back to the manager making it potentially * re-usable by other consumers. Optionally, the maximum period * of how long the manager should keep the connection alive can be * defined using {@code validDuration} and {@code timeUnit} * parameters. * * @param endpoint the managed endpoint. * @param newState the new connection state of {@code null} if state-less. * @param validDuration the duration of time this connection is valid for reuse. */ void release(ConnectionEndpoint endpoint, Object newState, TimeValue validDuration); /** * Connects the endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param endpoint the managed endpoint. * @param connectTimeout connect timeout. * @param context the actual HTTP context. */ void connect(ConnectionEndpoint endpoint, TimeValue connectTimeout, HttpContext context) throws IOException; /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param context the actual HTTP context. */ void upgrade(ConnectionEndpoint endpoint, HttpContext context) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/io/HttpClientConnectionOperator.java0100644 0000000 0000000 00000014522 00000250600 030476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.InetSocketAddress; import java.nio.file.Path; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Connection operator that performs connection connect and upgrade operations. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public interface HttpClientConnectionOperator { /** * Connect the given managed connection to the remote endpoint. * * @param conn the managed connection. * @param host the address of the opposite endpoint. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param socketConfig the socket configuration. * @param context the execution context. */ void connect( ManagedHttpClientConnection conn, HttpHost host, InetSocketAddress localAddress, TimeValue connectTimeout, SocketConfig socketConfig, HttpContext context) throws IOException; /** * Connect the given managed connection to the remote endpoint. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param socketConfig the socket configuration. * @param attachment connect request attachment. * @param context the execution context. * * @since 5.4 */ default void connect( ManagedHttpClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, InetSocketAddress localAddress, Timeout connectTimeout, SocketConfig socketConfig, Object attachment, HttpContext context) throws IOException { connect(conn, endpointHost, localAddress, connectTimeout, socketConfig, context); } /** * Connect the given managed connection to the remote endpoint. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param unixDomainSocket the path to the Unix domain socket, or {@code null} if none. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param socketConfig the socket configuration. * @param attachment connect request attachment. * @param context the execution context. * * @since 5.6 */ default void connect( ManagedHttpClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, Path unixDomainSocket, InetSocketAddress localAddress, Timeout connectTimeout, SocketConfig socketConfig, Object attachment, HttpContext context) throws IOException { if (unixDomainSocket != null) { throw new UnsupportedOperationException(getClass().getName() + " does not support Unix domain sockets"); } connect(conn, endpointHost, localAddress, connectTimeout, socketConfig, context); } /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param host the address of the opposite endpoint with TLS security. * @param context the execution context. */ void upgrade( ManagedHttpClientConnection conn, HttpHost host, HttpContext context) throws IOException; /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param attachment connect request attachment. * @param context the execution context. * * @since 5.2 */ default void upgrade( ManagedHttpClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, Object attachment, HttpContext context) throws IOException { upgrade(conn, endpointHost, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/io/LeaseRequest.java0100644 0000000 0000000 00000004671 00000250600 025272 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.util.Timeout; /** * Represents a request for a {@link ConnectionEndpoint} whose life cycle * is managed by a connection manager. * * @since 5.0 */ public interface LeaseRequest extends Cancellable { /** * Returns {@link ConnectionEndpoint} within a given time. * This method will block until a connection becomes available, * the timeout expires, or the connection manager is shut down. * Timeouts are handled with millisecond precision. * * If {@link #cancel()} is called while this is blocking or * before this began, an {@link InterruptedException} will * be thrown. * * @param timeout the operation timeout. * * @return a connection that can be used to communicate * along the given route * * @throws TimeoutException * in case of a timeout * @throws InterruptedException * if the calling thread is interrupted while waiting */ ConnectionEndpoint get(Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException; }httpclient5/src/main/java/org/apache/hc/client5/http/io/ManagedHttpClientConnection.java0100644 0000000 0000000 00000006610 00000250600 030236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.Socket; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.io.HttpClientConnection; /** * Represents a managed connection whose state and life cycle is managed by * a connection manager. This interface extends {@link HttpClientConnection} * with methods to bind the connection to an arbitrary socket and * to obtain SSL session details. * * @since 4.3 */ @Internal public interface ManagedHttpClientConnection extends HttpClientConnection { /** * Binds this connection to the given socket. The connection * is considered open if it is bound and the underlying socket * is connection to a remote host. * * @param socket the socket to bind the connection to. */ void bind(Socket socket) throws IOException; /** * Binds this connection to the SSL given socket and the underlying network * socket. The connection is considered open if it is bound, the underlying * network socket is connection to a remote host and the SSL socket is * fully initialized (TLS handshake has been successfully executed). * * @param sslSocket the SSL socket to bind the connection to. * @param socket the underlying network socket of the SSL socket. * * @since 5.4 */ default void bind(SSLSocket sslSocket, Socket socket) throws IOException { bind(sslSocket); } /** * Returns the underlying socket. */ Socket getSocket(); /** * Obtains the SSL session of the underlying connection, if any. * If this connection is open, and the underlying socket is an * {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of * that socket is obtained. This is a potentially blocking operation. * * @return the underlying SSL session if available, * {@code null} otherwise */ @Override SSLSession getSSLSession(); /** * Puts the connection into idle mode. * * @since 5.0 */ void passivate(); /** * Restores the connection from idle mode. * * @since 5.0 */ void activate(); } httpclient5/src/main/java/org/apache/hc/client5/http/io/package-info.java0100644 0000000 0000000 00000002431 00000250600 025204 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Connection management APIs based on the classic (blocking) I/O model. */ package org.apache.hc.client5.http.io; httpclient5/src/main/java/org/apache/hc/client5/http/nio/0040755 0000000 0000000 00000000000 00000250600 022176 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncClientConnectionManager.java0100644 0000000 0000000 00000014363 00000250600 030574 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.util.concurrent.Future; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Represents a manager of persistent non-blocking client connections. *

* The purpose of an HTTP connection manager is to serve as a factory for new * HTTP connections, manage persistent connections and synchronize access to * persistent connections making sure that only one thread of execution can * have access to a connection at a time. *

*

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public interface AsyncClientConnectionManager extends ModalCloseable { /** * Returns a {@link Future} object which can be used to obtain * an {@link AsyncConnectionEndpoint} or to cancel the request by calling * {@link Future#cancel(boolean)}. *

* Please note that newly allocated endpoints can be leased * {@link AsyncConnectionEndpoint#isConnected() disconnected}. The consumer * of the endpoint is responsible for fully establishing the route to * the endpoint target by calling {@link #connect(AsyncConnectionEndpoint, * ConnectionInitiator, Timeout, Object, HttpContext, FutureCallback)} * in order to connect directly to the target or to the first proxy hop, * and optionally calling {@link #upgrade(AsyncConnectionEndpoint, Object, HttpContext)} * method to upgrade the underlying transport to Transport Layer Security * after having executed a {@code CONNECT} method to all intermediate * proxy hops. * * @param id unique operation ID or {@code null}. * @param route HTTP route of the requested connection. * @param state expected state of the connection or {@code null} * if the connection is not expected to carry any state. * @param requestTimeout lease request timeout. * @param callback result callback. */ Future lease( String id, HttpRoute route, Object state, Timeout requestTimeout, FutureCallback callback); /** * Releases the endpoint back to the manager making it potentially * re-usable by other consumers. Optionally, the maximum period * of how long the manager should keep the connection alive can be * defined using {@code validDuration} and {@code timeUnit} * parameters. * * @param endpoint the managed endpoint. * @param newState the new connection state of {@code null} if state-less. * @param validDuration the duration of time this connection is valid for reuse. */ void release(AsyncConnectionEndpoint endpoint, Object newState, TimeValue validDuration); /** * Connects the endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param endpoint the managed endpoint. * @param connectTimeout connect timeout. * @param context the actual HTTP context. * @param attachment connect request attachment. * @param callback result callback. */ Future connect( AsyncConnectionEndpoint endpoint, ConnectionInitiator connectionInitiator, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback); /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param attachment the attachment the upgrade attachment object. * @param context the actual HTTP context. */ void upgrade( AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context); /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param attachment the attachment the upgrade attachment object. * @param context the actual HTTP context. * @param callback result callback. * * @since 5.2 */ default void upgrade( AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context, FutureCallback callback) { upgrade(endpoint, attachment, context); if (callback != null) { callback.completed(endpoint); } } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncClientConnectionOperator.java0100644 0000000 0000000 00000016533 00000250600 031016 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.net.SocketAddress; import java.nio.file.Path; import java.util.concurrent.Future; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.Timeout; /** * Connection operator that performs connection connect and upgrade operations. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public interface AsyncClientConnectionOperator { /** * Initiates operation to create a connection to the remote endpoint using * the provided {@link ConnectionInitiator}. * * @param connectionInitiator the connection initiator. * @param host the address of the opposite endpoint. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param callback the future result callback. */ Future connect( ConnectionInitiator connectionInitiator, HttpHost host, SocketAddress localAddress, Timeout connectTimeout, Object attachment, FutureCallback callback); /** * Initiates operation to create a connection to the remote endpoint using * the provided {@link ConnectionInitiator}. * * @param connectionInitiator the connection initiator. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param context the execution context. * @param callback the future result callback. * @since 5.4 */ default Future connect( ConnectionInitiator connectionInitiator, HttpHost endpointHost, NamedEndpoint endpointName, SocketAddress localAddress, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback) { return connect(connectionInitiator, endpointHost, localAddress, connectTimeout, attachment, callback); } /** * Initiates operation to create a connection to the remote endpoint using * the provided {@link ConnectionInitiator}. * * @param connectionInitiator the connection initiator. * @param endpointHost the address of the remote endpoint. * @param unixDomainSocket the path to the UDS through which to connect, or {@code null}. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param context the execution context. * @param callback the future result callback. * @since 5.6 */ default Future connect( ConnectionInitiator connectionInitiator, HttpHost endpointHost, Path unixDomainSocket, NamedEndpoint endpointName, SocketAddress localAddress, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback) { if (unixDomainSocket != null) { throw new UnsupportedOperationException(getClass().getName() + " does not support Unix domain sockets"); } return connect(connectionInitiator, endpointHost, localAddress, connectTimeout, attachment, callback); } /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param host the address of the opposite endpoint with TLS security. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. */ void upgrade(ManagedAsyncClientConnection conn, HttpHost host, Object attachment); /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param context the execution context. * @param callback the future result callback. * @since 5.4 */ default void upgrade( ManagedAsyncClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, Object attachment, HttpContext context, FutureCallback callback) { upgrade(conn, endpointHost, attachment); if (callback != null) { callback.completed(conn); } } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncConnectionEndpoint.java0100644 0000000 0000000 00000017661 00000250600 027647 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.io.IOException; import java.util.concurrent.Future; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Timeout; /** * Client connection endpoint that can be used to execute message exchanges. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class AsyncConnectionEndpoint implements ModalCloseable { /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the message exchange handler. * @param pushHandlerFactory the push handler factory. * @param context the execution context. */ public abstract void execute( String id, AsyncClientExchangeHandler exchangeHandler, HandlerFactory pushHandlerFactory, HttpContext context); /** * Determines if the connection to the remote endpoint is still open and valid. */ public abstract boolean isConnected(); /** * Sets socket timeout. * * @param timeout the socket timeout. */ public abstract void setSocketTimeout(Timeout timeout); @Override public final void close() throws IOException { close(CloseMode.GRACEFUL); } /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the message exchange handler. * @param context the execution context. */ public void execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpContext context) { execute(id, exchangeHandler, null, context); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param pushHandlerFactory the push handler factory. * @param context the execution context. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final BasicFuture future = new BasicFuture<>(callback); execute(id, new BasicClientExchangeHandler<>(requestProducer, responseConsumer, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }), pushHandlerFactory, context != null ? context : HttpCoreContext.create()); return future; } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param context the execution context. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HttpContext context, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, null, context, callback); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param pushHandlerFactory the push handler factory. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, pushHandlerFactory, null, callback); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, null, null, callback); } /** * Returns information about the endpoint or {@code null} when not connected. * * @since 5.4 */ public EndpointInfo getInfo() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/ManagedAsyncClientConnection.java0100644 0000000 0000000 00000005250 00000250600 030551 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; /** * Represents a managed asynchronous connection whose state and life cycle * is managed by a connection manager. * * @since 5.0 */ @Internal public interface ManagedAsyncClientConnection extends HttpConnection, TransportSecurityLayer { /** * Submits the given command for execution. * * @param command the command to be executed. * @param priority the command priority. */ void submitCommand(Command command, Command.Priority priority); /** * Puts the connection into idle mode. */ void passivate(); /** * Restores the connection from idle mode. */ void activate(); /** * Switches this I/O session to the application protocol with the given ID. * @param protocolId the application protocol ID * @param callback the result callback * @throws UnsupportedOperationException if application protocol switch * is not supported. * * @since 5.2 */ default void switchProtocol(String protocolId, FutureCallback callback) throws UnsupportedOperationException { throw new UnsupportedOperationException("Protocol switch not supported"); } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/package-info.java0100644 0000000 0000000 00000002424 00000250600 025364 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Connection management APIs based on the asynchronous I/O model. */ package org.apache.hc.client5.http.nio; httpclient5/src/main/java/org/apache/hc/client5/http/protocol/0040755 0000000 0000000 00000000000 00000250600 023252 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/protocol/H2RequestPriority.java0100644 0000000 0000000 00000007305 00000250600 027503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http2.priority.PriorityFormatter; import org.apache.hc.core5.http2.priority.PriorityValue; import org.apache.hc.core5.util.Args; /** * Adds the {@code Priority} request header to HTTP/2+ requests when a per-request * priority is configured. *

* The priority is taken from {@link RequestConfig#getH2Priority()}. If a {@code Priority} * header is already present on the request, it is left unchanged. If formatting the * configured value yields an empty string (e.g., because it encodes protocol defaults), * the header is not added. * * @since 5.6 */ @Experimental @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class H2RequestPriority implements HttpRequestInterceptor { /** * Singleton instance. */ public static final H2RequestPriority INSTANCE = new H2RequestPriority(); @Override public void process( final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext httpClientContext = HttpClientContext.cast(context); final ProtocolVersion pv = httpClientContext.getProtocolVersion(); if (pv.compareToVersion(HttpVersion.HTTP_2) < 0) { return; // only for HTTP/2+ } final Header existing = request.getFirstHeader(HttpHeaders.PRIORITY); if (existing != null) { return; } final RequestConfig requestConfig = httpClientContext.getRequestConfigOrDefault(); final PriorityValue pri = requestConfig.getH2Priority(); if (pri == null || PriorityValue.defaults().equals(pri)) { return; } request.addHeader(PriorityFormatter.formatHeader(pri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/HttpClientContext.java0100644 0000000 0000000 00000052553 00000250600 027547 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.util.HashMap; import java.util.Map; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; /** * Client execution {@link HttpContext}. This class can be re-used for * multiple consecutive logically related request executions that represent * a single communication session. This context may not be used concurrently. *

* IMPORTANT: This class is NOT thread-safe and MUST NOT be used concurrently by * multiple message exchanges. * * @since 4.3 */ public class HttpClientContext extends HttpCoreContext { /** * @deprecated Use getter methods */ @Deprecated public static final String HTTP_ROUTE = "http.route"; /** * @deprecated Use getter methods */ @Deprecated public static final String REDIRECT_LOCATIONS = "http.protocol.redirect-locations"; /** * @deprecated Use getter methods */ @Deprecated public static final String COOKIESPEC_REGISTRY = "http.cookiespec-registry"; /** * @deprecated Use getter methods */ @Deprecated public static final String COOKIE_SPEC = "http.cookie-spec"; /** * @deprecated Use getter methods */ @Deprecated public static final String COOKIE_ORIGIN = "http.cookie-origin"; /** * @deprecated Use getter methods */ @Deprecated public static final String COOKIE_STORE = "http.cookie-store"; /** * @deprecated Use getter methods */ @Deprecated public static final String CREDS_PROVIDER = "http.auth.credentials-provider"; /** * @deprecated Use getter methods */ @Deprecated public static final String AUTH_CACHE = "http.auth.auth-cache"; /** * @deprecated Use getter methods */ @Deprecated public static final String AUTH_EXCHANGE_MAP = "http.auth.exchanges"; /** * @deprecated Use getter methods */ @Deprecated public static final String USER_TOKEN = "http.user-token"; /** * @deprecated Use getter methods */ @Deprecated public static final String AUTHSCHEME_REGISTRY = "http.authscheme-registry"; /** * @deprecated Use getter methods */ @Deprecated public static final String REQUEST_CONFIG = "http.request-config"; /** * @deprecated Use getter methods */ @Deprecated public static final String EXCHANGE_ID = "http.exchange-id"; /** * @deprecated Use {@link #castOrCreate(HttpContext)}. */ @Deprecated public static HttpClientContext adapt(final HttpContext context) { if (context == null) { return new HttpClientContext(); } if (context instanceof HttpClientContext) { return (HttpClientContext) context; } return new HttpClientContext(context); } /** * Casts the given generic {@link HttpContext} as {@link HttpClientContext}. * * @since 5.4 */ public static HttpClientContext cast(final HttpContext context) { if (context == null) { return null; } if (context instanceof HttpClientContext) { return (HttpClientContext) context; } return new Delegate(context); } /** * Casts the given generic {@link HttpContext} as {@link HttpClientContext} or * creates new {@link HttpClientContext} if the given context is null. * * @since 5.4 */ public static HttpClientContext castOrCreate(final HttpContext context) { return context != null ? cast(context) : create(); } public static HttpClientContext create() { return new HttpClientContext(); } private HttpRoute route; private RedirectLocations redirectLocations; private CookieSpec cookieSpec; private CookieOrigin cookieOrigin; private Map authExchangeMap; private String exchangeId; private Lookup cookieSpecFactoryLookup; private Lookup authSchemeFactoryLookup; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private AuthCache authCache; private Object userToken; private RequestConfig requestConfig; /** * Stores the {@code nextnonce} value provided by the server in an HTTP response. *

* In the context of HTTP Digest Access Authentication, the {@code nextnonce} parameter * is used by the client in subsequent requests to ensure one-time or session-bound usage * of nonce values, enhancing security by preventing replay attacks. *

*

* This field is set by an interceptor or other component that processes the server's * response containing the {@code Authentication-Info} header. Once used, this value * may be cleared from the context to avoid reuse. *

* * @since 5.5 */ private String nextNonce; public HttpClientContext(final HttpContext context) { super(context); } public HttpClientContext() { super(); } /** * Represents current route used to execute message exchanges. *

* This context attribute is expected to be populated by the protocol handler. */ public RouteInfo getHttpRoute() { return route; } /** * @since 5.4 */ @Internal public void setRoute(final HttpRoute route) { this.route = route; } /** * Represents a collection of all redirects executed in the context of request execution. *

* This context attribute is expected to be populated by the protocol handler. */ public RedirectLocations getRedirectLocations() { if (this.redirectLocations == null) { this.redirectLocations = new RedirectLocations(); } return this.redirectLocations; } /** * @since 5.4 */ @Internal public void setRedirectLocations(final RedirectLocations redirectLocations) { this.redirectLocations = redirectLocations; } /** * Represents a {@link CookieStore} used in the context of the request execution. *

* This context attribute can be set by the caller. */ public CookieStore getCookieStore() { return cookieStore; } public void setCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; } /** * Represents a {@link CookieSpec} chosen in the context of request execution. *

* This context attribute is expected to be populated by the protocol handler. */ public CookieSpec getCookieSpec() { return cookieSpec; } /** * @since 5.4 */ @Internal public void setCookieSpec(final CookieSpec cookieSpec) { this.cookieSpec = cookieSpec; } /** * Represents a {@link CookieOrigin} produced in the context of request execution. *

* This context attribute is expected to be populated by the protocol handler. */ public CookieOrigin getCookieOrigin() { return cookieOrigin; } /** * @since 5.4 */ @Internal public void setCookieOrigin(final CookieOrigin cookieOrigin) { this.cookieOrigin = cookieOrigin; } /** * Represents a {@link CookieSpecFactory} registry used in the context of the request execution. *

* This context attribute can be set by the caller. */ public Lookup getCookieSpecRegistry() { return cookieSpecFactoryLookup; } public void setCookieSpecRegistry(final Lookup lookup) { this.cookieSpecFactoryLookup = lookup; } /** * Represents a {@link AuthSchemeFactory} registry used in the context of the request execution. *

* This context attribute can be set by the caller. */ public Lookup getAuthSchemeRegistry() { return authSchemeFactoryLookup; } public void setAuthSchemeRegistry(final Lookup lookup) { this.authSchemeFactoryLookup = lookup; } /** * Represents a {@link CredentialsProvider} registry used in the context of the request execution. *

* This context attribute can be set by the caller. */ public CredentialsProvider getCredentialsProvider() { return credentialsProvider; } public void setCredentialsProvider(final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; } /** * Represents a {@link AuthCache} used in the context of the request execution. *

* This context attribute can be set by the caller. */ public AuthCache getAuthCache() { return authCache; } public void setAuthCache(final AuthCache authCache) { this.authCache = authCache; } /** * Represents a map of {@link AuthExchange}s performed in the context of the request * execution. *

* This context attribute is expected to be populated by the protocol handler. * * @since 5.0 */ public Map getAuthExchanges() { if (authExchangeMap == null) { authExchangeMap = new HashMap<>(); } return authExchangeMap; } /** * @since 5.0 */ public AuthExchange getAuthExchange(final HttpHost host) { return getAuthExchanges().computeIfAbsent(host, k -> new AuthExchange()); } /** * @since 5.0 */ public void setAuthExchange(final HttpHost host, final AuthExchange authExchange) { getAuthExchanges().put(host, authExchange); } /** * @since 5.0 */ public void resetAuthExchange(final HttpHost host, final AuthScheme authScheme) { final AuthExchange authExchange = new AuthExchange(); authExchange.select(authScheme); getAuthExchanges().put(host, authExchange); } /** * @deprecated Use {@link #getUserToken()} */ @Deprecated @SuppressWarnings("unchecked") public T getUserToken(final Class clazz) { return (T) getUserToken(); } /** * Represents an arbitrary user token that identifies the user in the context * of the request execution. *

* This context attribute can be set by the caller. */ public Object getUserToken() { return userToken; } public void setUserToken(final Object userToken) { this.userToken = userToken; } /** * Represents an {@link RequestConfig used} in the context of the request execution. *

* This context attribute can be set by the caller. */ public RequestConfig getRequestConfig() { return requestConfig; } /** * Returns {@link RequestConfig} set in the context or {@link RequestConfig#DEFAULT} * if not explicitly set in the context. * * @since 5.4 */ public final RequestConfig getRequestConfigOrDefault() { final RequestConfig requestConfig = getRequestConfig(); return requestConfig != null ? requestConfig : RequestConfig.DEFAULT; } public void setRequestConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; } /** * Represents an identifier generated for the current message exchange executed * in the given context. *

* This context attribute is expected to be populated by the protocol handler. * @since 5.1 */ public String getExchangeId() { return exchangeId; } /** * @since 5.1 */ public void setExchangeId(final String exchangeId) { this.exchangeId = exchangeId; } /** * Retrieves the stored {@code nextnonce} value. * * @return the {@code nextnonce} parameter value, or {@code null} if not set * @since 5.5 */ @Internal public String getNextNonce() { return nextNonce; } /** * Sets the {@code nextnonce} value directly as an instance attribute. * * @param nextNonce the nonce value to set * @since 5.5 */ @Internal public void setNextNonce(final String nextNonce) { this.nextNonce = nextNonce; } /** * Internal adaptor class that delegates all its method calls to a plain {@link HttpContext}. * To be removed in the future. */ @SuppressWarnings("deprecation") @Internal static class Delegate extends HttpClientContext { private final HttpContext httpContext; Delegate(final HttpContext httpContext) { super(null); this.httpContext = httpContext; } T getAttr(final String id, final Class clazz) { final Object obj = httpContext.getAttribute(id); if (obj == null) { return null; } return clazz.cast(obj); } @Override public RouteInfo getHttpRoute() { return getAttr(HTTP_ROUTE, RouteInfo.class); } @Override public void setRoute(final HttpRoute route) { httpContext.setAttribute(HTTP_ROUTE, route); } @Override public RedirectLocations getRedirectLocations() { RedirectLocations redirectLocations = getAttr(REDIRECT_LOCATIONS, RedirectLocations.class); if (redirectLocations == null) { redirectLocations = new RedirectLocations(); httpContext.setAttribute(REDIRECT_LOCATIONS, redirectLocations); } return redirectLocations; } @Override public void setRedirectLocations(final RedirectLocations redirectLocations) { httpContext.setAttribute(REDIRECT_LOCATIONS, redirectLocations); } @Override public CookieStore getCookieStore() { return getAttr(COOKIE_STORE, CookieStore.class); } @Override public void setCookieStore(final CookieStore cookieStore) { httpContext.setAttribute(COOKIE_STORE, cookieStore); } @Override public CookieSpec getCookieSpec() { return getAttr(COOKIE_SPEC, CookieSpec.class); } @Override public void setCookieSpec(final CookieSpec cookieSpec) { httpContext.setAttribute(COOKIE_SPEC, cookieSpec); } @Override public CookieOrigin getCookieOrigin() { return getAttr(COOKIE_ORIGIN, CookieOrigin.class); } @Override public void setCookieOrigin(final CookieOrigin cookieOrigin) { httpContext.setAttribute(COOKIE_ORIGIN, cookieOrigin); } @Override public Lookup getCookieSpecRegistry() { return getAttr(COOKIESPEC_REGISTRY, Lookup.class); } @Override public void setCookieSpecRegistry(final Lookup lookup) { httpContext.setAttribute(COOKIESPEC_REGISTRY, lookup); } @Override public Lookup getAuthSchemeRegistry() { return getAttr(AUTHSCHEME_REGISTRY, Lookup.class); } @Override public void setAuthSchemeRegistry(final Lookup lookup) { httpContext.setAttribute(AUTHSCHEME_REGISTRY, lookup); } @Override public CredentialsProvider getCredentialsProvider() { return getAttr(CREDS_PROVIDER, CredentialsProvider.class); } @Override public void setCredentialsProvider(final CredentialsProvider credentialsProvider) { httpContext.setAttribute(CREDS_PROVIDER, credentialsProvider); } @Override public AuthCache getAuthCache() { return getAttr(AUTH_CACHE, AuthCache.class); } @Override public void setAuthCache(final AuthCache authCache) { httpContext.setAttribute(AUTH_CACHE, authCache); } @Override public Map getAuthExchanges() { Map map = getAttr(AUTH_EXCHANGE_MAP, Map.class); if (map == null) { map = new HashMap<>(); httpContext.setAttribute(AUTH_EXCHANGE_MAP, map); } return map; } @Override public Object getUserToken() { return httpContext.getAttribute(USER_TOKEN); } @Override public void setUserToken(final Object userToken) { httpContext.setAttribute(USER_TOKEN, userToken); } @Override public RequestConfig getRequestConfig() { return getAttr(REQUEST_CONFIG, RequestConfig.class); } @Override public void setRequestConfig(final RequestConfig requestConfig) { httpContext.setAttribute(REQUEST_CONFIG, requestConfig); } @Override public String getExchangeId() { return getAttr(EXCHANGE_ID, String.class); } @Override public void setExchangeId(final String exchangeId) { httpContext.setAttribute(EXCHANGE_ID, exchangeId); } @Override public HttpRequest getRequest() { return getAttr(HttpCoreContext.HTTP_REQUEST, HttpRequest.class); } @Override public void setRequest(final HttpRequest request) { httpContext.setAttribute(HttpCoreContext.HTTP_REQUEST, request); } @Override public HttpResponse getResponse() { return getAttr(HttpCoreContext.HTTP_RESPONSE, HttpResponse.class); } @Override public void setResponse(final HttpResponse response) { httpContext.setAttribute(HttpCoreContext.HTTP_RESPONSE, response); } @Override public EndpointDetails getEndpointDetails() { return getAttr(HttpCoreContext.CONNECTION_ENDPOINT, EndpointDetails.class); } @Override public void setEndpointDetails(final EndpointDetails endpointDetails) { httpContext.setAttribute(CONNECTION_ENDPOINT, endpointDetails); } @Override public SSLSession getSSLSession() { return getAttr(HttpCoreContext.SSL_SESSION, SSLSession.class); } @Override public void setSSLSession(final SSLSession sslSession) { httpContext.setAttribute(HttpCoreContext.SSL_SESSION, sslSession); } @Override public ProtocolVersion getProtocolVersion() { return httpContext.getProtocolVersion(); } @Override public void setProtocolVersion(final ProtocolVersion version) { httpContext.setProtocolVersion(version); } @Override public Object getAttribute(final String id) { return httpContext.getAttribute(id); } @Override public Object setAttribute(final String id, final Object obj) { return httpContext.setAttribute(id, obj); } @Override public Object removeAttribute(final String id) { return httpContext.removeAttribute(id); } @Override public T getAttribute(final String id, final Class clazz) { return getAttr(id, clazz); } @Override public String toString() { return httpContext.toString(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/NextNonceInterceptor.java0100644 0000000 0000000 00000015574 00000250600 030246 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * {@code NextNonceInterceptor} is an HTTP response interceptor that extracts the {@code nextnonce} * parameter from the {@code Authentication-Info} header of an HTTP response. This parameter is used * in HTTP Digest Access Authentication to provide an additional nonce value that the client is expected * to use in subsequent authentication requests. By retrieving and storing this {@code nextnonce} value, * the interceptor facilitates one-time nonce implementations and prevents replay attacks by ensuring that * each request/response interaction includes a fresh nonce. *

* If present, the extracted {@code nextnonce} value is stored in the {@link HttpContext} under the attribute * {@code auth-nextnonce}, allowing it to be accessed in subsequent requests. If the header does not contain * the {@code nextnonce} parameter, no context attribute is set. *

* *

This implementation adheres to the HTTP/1.1 specification, particularly focusing on the {@code Digest} * scheme as defined in HTTP Digest Authentication, and parses header tokens using the {@link Tokenizer} * utility class for robust token parsing.

* *

In the context of HTTP Digest Access Authentication, the {@code nextnonce} parameter is * a critical part of the security mechanism, designed to mitigate replay attacks and enhance mutual * authentication security. It provides the server with the ability to set and enforce single-use or * session-bound nonces, prompting the client to use the provided {@code nextnonce} in its next request. * This setup helps secure communication by forcing new cryptographic material in each transaction. *

* *

This interceptor is stateless and thread-safe, making it suitable for use across multiple * threads and HTTP requests. It should be registered with the HTTP client to enable support * for advanced authentication mechanisms that require tracking of nonce values.

* * @since 5.5 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NextNonceInterceptor implements HttpResponseInterceptor { public static final HttpResponseInterceptor INSTANCE = new NextNonceInterceptor(); private final Tokenizer tokenParser = Tokenizer.INSTANCE; private static final String AUTHENTICATION_INFO_HEADER = "Authentication-Info"; private static final Tokenizer.Delimiter TOKEN_DELIMS = Tokenizer.delimiters('=', ','); private static final Tokenizer.Delimiter VALUE_DELIMS = Tokenizer.delimiters(','); /** * Processes the HTTP response and extracts the {@code nextnonce} parameter from the * {@code Authentication-Info} header if available, storing it in the provided {@code context}. * * @param response the HTTP response containing the {@code Authentication-Info} header * @param entity the response entity, ignored by this interceptor * @param context the HTTP context in which to store the {@code nextnonce} parameter * @throws NullPointerException if either {@code response} or {@code context} is null */ @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) { Args.notNull(response, "HTTP response"); Args.notNull(context, "HTTP context"); final Header header = response.getFirstHeader(AUTHENTICATION_INFO_HEADER); if (header != null) { final String nextNonce; if (header instanceof FormattedHeader) { final CharSequence buf = ((FormattedHeader) header).getBuffer(); final ParserCursor cursor = new ParserCursor(((FormattedHeader) header).getValuePos(), buf.length()); nextNonce = parseNextNonce(buf, cursor); } else { final CharSequence headerValue = header.getValue(); final ParserCursor cursor = new ParserCursor(0, headerValue.length()); nextNonce = parseNextNonce(headerValue, cursor); } if (!TextUtils.isBlank(nextNonce)) { HttpClientContext.castOrCreate(context).setNextNonce(nextNonce); } } } /** * Parses the {@code Authentication-Info} header content represented by a {@link CharArrayBuffer} * to extract the {@code nextnonce} parameter. * * @param buffer the {@link CharArrayBuffer} containing the value of the {@code Authentication-Info} header * @param cursor the {@link ParserCursor} used to navigate through the buffer content * @return the extracted {@code nextnonce} parameter value, or {@code null} if the parameter is not found */ private String parseNextNonce(final CharSequence buffer, final ParserCursor cursor) { while (!cursor.atEnd()) { final String name = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS); if ("nextnonce".equals(name)) { cursor.updatePos(cursor.getPos() + 1); return tokenParser.parseValue(buffer, cursor, VALUE_DELIMS); } if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } } return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RedirectLocations.java0100644 0000000 0000000 00000006201 00000250600 027526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.net.URI; import java.util.ArrayList; import java.util.HashSet; import java.util.List; import java.util.Set; /** * This class represents a collection of {@link URI}s used * as redirect locations. * * @since 4.0 */ public final class RedirectLocations { private final Set unique; private final List all; /** * Constructs a new instance. */ public RedirectLocations() { super(); this.unique = new HashSet<>(); this.all = new ArrayList<>(); } /** * Test if the URI is present in the collection. */ public boolean contains(final URI uri) { return this.unique.contains(uri); } /** * Adds a new URI to the collection. */ public void add(final URI uri) { this.unique.add(uri); this.all.add(uri); } /** * Returns all redirect {@link URI}s in the order they were added to the collection. * * @return list of all URIs * * @since 4.1 */ public List getAll() { return new ArrayList<>(this.all); } /** * Returns the URI at the specified position in this list. * * @param index * index of the location to return * @return the URI at the specified position in this list * @throws IndexOutOfBoundsException * if the index is out of range ( * {@code index < 0 || index >= size()}) * @since 4.3 */ public URI get(final int index) { return this.all.get(index); } /** * Returns the number of elements in this list. If this list contains more * than {@code Integer.MAX_VALUE} elements, returns * {@code Integer.MAX_VALUE}. * * @return the number of elements in this list * @since 4.3 */ public int size() { return this.all.size(); } public void clear() { unique.clear(); all.clear(); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RedirectStrategy.java0100644 0000000 0000000 00000006422 00000250600 027402 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.net.URI; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; /** * A strategy for determining if an HTTP request should be redirected to * a new location in response to an HTTP response received from the target * server. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface RedirectStrategy { /** * Determines if a request should be redirected to a new location * given the response from the target server. * * @param request the executed request * @param response the response received from the target server * @param context the context for the request execution * @return {@code true} if the request should be redirected, {@code false} * otherwise */ boolean isRedirected( HttpRequest request, HttpResponse response, HttpContext context) throws HttpException; URI getLocationURI( final HttpRequest request, final HttpResponse response, final HttpContext context) throws HttpException; /** * Determines if the given redirect should be executed or the redirect response * should be returned to the caller without further processing. *

* It is legal for this method implementation to modify the redirect request * in order to make it suitable for redirect execution. *

* * @since 5.4 */ default boolean isRedirectAllowed( HttpHost currentTarget, HttpHost newTarget, HttpRequest redirect, HttpContext context) { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java0100644 0000000 0000000 00000020766 00000250600 027503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.time.Instant; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request interceptor that matches cookies available in the current * {@link CookieStore} to the request being executed and generates * corresponding {@code Cookie} request headers. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestAddCookies implements HttpRequestInterceptor { /** * Default instance of {@link RequestAddCookies}. * * @since 5.2 */ public static final RequestAddCookies INSTANCE = new RequestAddCookies(); private static final Logger LOG = LoggerFactory.getLogger(RequestAddCookies.class); private static String normalizeRequestPath(final String rawPath) { if (TextUtils.isBlank(rawPath)) { return "/"; } int end = rawPath.length(); final int queryIndex = rawPath.indexOf('?'); if (queryIndex >= 0) { end = queryIndex; } final int fragmentIndex = rawPath.indexOf('#'); if (fragmentIndex >= 0 && fragmentIndex < end) { end = fragmentIndex; } if (end == 0) { return "/"; } if (end == rawPath.length()) { return rawPath; } return rawPath.substring(0, end); } public RequestAddCookies() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method) || Method.TRACE.isSame(method)) { return; } // Check if a Cookie header is already present if (request.containsHeader(HttpHeaders.COOKIE)) { if (LOG.isDebugEnabled()) { LOG.debug("Skipping cookie addition, Cookie header already present in the request"); } // Skip adding cookies if the Cookie header is already present return; } final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain cookie store final CookieStore cookieStore = clientContext.getCookieStore(); if (cookieStore == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie store not specified in HTTP context", exchangeId); } return; } // Obtain the registry of cookie specs final Lookup registry = clientContext.getCookieSpecRegistry(); if (registry == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} CookieSpec registry not specified in HTTP context", exchangeId); } return; } // Obtain the route (required) final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection route not set in the context", exchangeId); } return; } final RequestConfig config = clientContext.getRequestConfigOrDefault(); String cookieSpecName = config.getCookieSpec(); if (cookieSpecName == null) { cookieSpecName = StandardCookieSpec.STRICT; } if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie spec selected: {}", exchangeId, cookieSpecName); } final URIAuthority authority = request.getAuthority(); final String path = normalizeRequestPath(request.getPath()); String hostName = authority != null ? authority.getHostName() : null; if (hostName == null) { hostName = route.getTargetHost().getHostName(); } int port = authority != null ? authority.getPort() : -1; if (port < 0) { port = route.getTargetHost().getPort(); } final CookieOrigin cookieOrigin = new CookieOrigin(hostName, port, path, route.isSecure()); // Get an instance of the selected cookie policy final CookieSpecFactory factory = registry.lookup(cookieSpecName); if (factory == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Unsupported cookie spec: {}", exchangeId, cookieSpecName); } return; } final CookieSpec cookieSpec = factory.create(clientContext); // Get all cookies available in the HTTP state final List cookies = cookieStore.getCookies(); // Find cookies matching the given origin final List matchedCookies = new ArrayList<>(); final Instant now = Instant.now(); boolean expired = false; for (final Cookie cookie : cookies) { if (!cookie.isExpired(now)) { if (cookieSpec.match(cookie, cookieOrigin)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie {} match {}", exchangeId, cookie, cookieOrigin); } matchedCookies.add(cookie); } } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie {} expired", exchangeId, cookie); } expired = true; } } // Per RFC 6265, 5.3 // The user agent must evict all expired cookies if, at any time, an expired cookie // exists in the cookie store if (expired) { cookieStore.clearExpired(now); } // Generate Cookie request headers if (!matchedCookies.isEmpty()) { final List
headers = cookieSpec.formatCookies(matchedCookies); for (final Header header : headers) { request.addHeader(header); } } // Stick the CookieSpec and CookieOrigin instances to the HTTP context // so they could be obtained by the response interceptor clientContext.setCookieSpec(cookieSpec); clientContext.setCookieOrigin(cookieOrigin); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAuthCache.java0100644 0000000 0000000 00000012147 00000250600 027315 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request interceptor that can preemptively authenticate against known hosts, * if there is a cached {@link AuthScheme} instance in the local * {@link AuthCache} associated with the given target or proxy host. * * @since 4.1 * * @deprecated Do not use. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class RequestAuthCache implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestAuthCache.class); public RequestAuthCache() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final AuthCache authCache = clientContext.getAuthCache(); if (authCache == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Auth cache not set in the context", exchangeId); } return; } final CredentialsProvider credsProvider = clientContext.getCredentialsProvider(); if (credsProvider == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Credentials provider not set in the context", exchangeId); } return; } final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Route info not set in the context", exchangeId); } return; } final HttpHost target = new HttpHost(request.getScheme(), request.getAuthority()); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); if (targetAuthExchange.getState() == AuthExchange.State.UNCHALLENGED) { final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthScheme authScheme = authCache.get(target, pathPrefix); if (authScheme != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Re-using cached '{}' auth scheme for {}", exchangeId, authScheme.getName(), target); } targetAuthExchange.select(authScheme); } } final HttpHost proxy = route.getProxyHost(); if (proxy != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(proxy); if (proxyAuthExchange.getState() == AuthExchange.State.UNCHALLENGED) { final AuthScheme authScheme = authCache.get(proxy, null); if (authScheme != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Re-using cached '{}' auth scheme for {}", exchangeId, authScheme.getName(), proxy); } proxyAuthExchange.select(authScheme); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestClientConnControl.java0100644 0000000 0000000 00000006564 00000250600 031073 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This protocol interceptor is responsible for adding the {@code Connection} * header to the outgoing requests, which is essential for managing persistence * of {@code HTTP/1.0} connections. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestClientConnControl implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestClientConnControl.class); public RequestClientConnControl() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method)) { return; } final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain the client connection (required) final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection route not set in the context", exchangeId); } return; } if (route.getHopCount() == 1 || route.isTunnelled()) { if (!request.containsHeader(HttpHeaders.CONNECTION)) { request.addHeader(HttpHeaders.CONNECTION, HeaderElements.KEEP_ALIVE); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestDefaultHeaders.java0100644 0000000 0000000 00000006024 00000250600 030345 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.util.Collection; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Request interceptor that adds default request headers. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestDefaultHeaders implements HttpRequestInterceptor { /** * Default instance of {@link RequestDefaultHeaders}. * * @since 5.2 */ public static final RequestDefaultHeaders INSTANCE = new RequestDefaultHeaders(); private final Collection defaultHeaders; /** * @since 4.3 */ public RequestDefaultHeaders(final Collection defaultHeaders) { super(); this.defaultHeaders = defaultHeaders; } public RequestDefaultHeaders() { this(null); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method)) { return; } if (this.defaultHeaders != null) { for (final Header defHeader : this.defaultHeaders) { if (!request.containsHeader(defHeader.getName())) { request.addHeader(defHeader); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestExpectContinue.java0100644 0000000 0000000 00000006400 00000250600 030420 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * RequestExpectContinue is responsible for enabling the 'expect-continue' * handshake by adding {@code Expect} header. *

* This interceptor takes into account {@link RequestConfig#isExpectContinueEnabled()} * setting. *

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestExpectContinue implements HttpRequestInterceptor { public RequestExpectContinue() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); if (!request.containsHeader(HttpHeaders.EXPECT)) { final HttpClientContext clientContext = HttpClientContext.cast(context); final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : clientContext.getProtocolVersion(); // Do not send the expect header if request body is known to be empty if (entity != null && entity.getContentLength() != 0 && !version.lessEquals(HttpVersion.HTTP_1_0)) { final RequestConfig config = clientContext.getRequestConfigOrDefault(); if (config.isExpectContinueEnabled()) { request.addHeader(HttpHeaders.EXPECT, HeaderElements.CONTINUE); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestIfRange.java0100644 0000000 0000000 00000013272 00000250600 027003 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.time.Instant; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.client5.http.validator.ValidatorType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** *

* The {@code RequestIfRange} interceptor ensures that the request adheres to the RFC guidelines for the 'If-Range' header. * The "If-Range" header field is used in conjunction with the Range header to conditionally request parts of a representation. * If the validator given in the "If-Range" header matches the current validator for the representation, then the server should respond with the specified range of the document. * If they do not match, the server should return the entire representation. *

* *

* Key points: *

*
    *
  • A client MUST NOT generate an If-Range header field in a request that does not contain a Range header field.
    • *
  • An origin server MUST ignore an If-Range header field received in a request for a target resource that does not support Range requests.
    • *
  • A client MUST NOT generate an If-Range header field containing an entity tag that is marked as weak.
    • *
  • A client MUST NOT generate an If-Range header field containing an HTTP-date unless the client has no entity tag for the corresponding representation and the date is a strong validator.
    • *
  • A server that receives an If-Range header field on a Range request MUST evaluate the condition before performing the method.
    • *
* * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class RequestIfRange implements HttpRequestInterceptor { /** * Default instance of {@link RequestIfRange}. * * @since 5.4 */ public static final RequestIfRange INSTANCE = new RequestIfRange(); public RequestIfRange() { super(); } /** * Processes the given request to ensure it adheres to the RFC guidelines for the 'If-Range' header. * * @param request The HTTP request to be processed. * @param entity The entity details of the request. * @param context The HTTP context. * @throws HttpException If the request does not adhere to the RFC guidelines. * @throws IOException If an I/O error occurs. */ @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final Header ifRangeHeader = request.getFirstHeader(HttpHeaders.IF_RANGE); // If there's no If-Range header, just return if (ifRangeHeader == null) { return; } // If there's an If-Range header but no Range header, throw an exception if (!request.containsHeader(HttpHeaders.RANGE)) { throw new ProtocolException("Request with 'If-Range' header must also contain a 'Range' header."); } final ETag eTag = ETag.get(request); // If there's a weak ETag in the If-Range header, throw an exception if (eTag != null && eTag.getType() == ValidatorType.WEAK) { throw new ProtocolException("'If-Range' header must not contain a weak entity tag."); } final Instant dateInstant = DateUtils.parseStandardDate(request, HttpHeaders.DATE); if (dateInstant == null) { return; } final Instant lastModifiedInstant = DateUtils.parseStandardDate(request, HttpHeaders.LAST_MODIFIED); if (lastModifiedInstant == null) { // If there's no Last-Modified header, we exit early because we can't deduce that it is strong. return; } // If the difference between the Last-Modified and Date headers is less than 1 second, throw an exception if (lastModifiedInstant.plusSeconds(1).isAfter(dateInstant) && eTag != null) { throw new ProtocolException("'If-Range' header with a Date must be a strong validator."); } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestUpgrade.java0100644 0000000 0000000 00000007172 00000250600 027061 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class RequestUpgrade implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestUpgrade.class); public RequestUpgrade() { } @Override public void process( final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); if (requestConfig.isProtocolUpgradeEnabled()) { final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : clientContext.getProtocolVersion(); if (!request.containsHeader(HttpHeaders.UPGRADE) && !request.containsHeader(HttpHeaders.CONNECTION) && version.getMajor() == 1 && version.getMinor() >= 1) { if (LOG.isDebugEnabled()) { LOG.debug("Connection is upgradable: protocol version = {}", version); } final String method = request.getMethod(); if ((Method.OPTIONS.isSame(method) || Method.HEAD.isSame(method) || Method.GET.isSame(method)) && clientContext.getSSLSession() == null) { LOG.debug("Connection is upgradable to TLS: method = {}", method); request.addHeader(HttpHeaders.UPGRADE, "TLS/1.2"); request.addHeader(HttpHeaders.CONNECTION, HttpHeaders.UPGRADE); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestValidateTrace.java0100644 0000000 0000000 00000012442 00000250600 030176 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * RequestTraceInterceptor * *

This class serves as an interceptor for HTTP TRACE requests, ensuring they adhere to specific security and protocol guidelines.

* *

Responsibilities:

*
    *
  • Validates TRACE requests by checking for sensitive headers such as {@code Authorization} and {@code Cookie}.
    • *
  • Ensures that TRACE requests do not contain a request body, throwing a {@link ProtocolException} if a body is present.
    • *
* *

Thread Safety: This class is stateless and therefore thread-safe, as indicated by its {@code ThreadingBehavior.STATELESS} annotation.

* *

Interceptor Behavior:

*
    *
  • If the HTTP method is TRACE, the interceptor throws a {@link ProtocolException} if any {@code Authorization} or {@code Cookie} headers are present to prevent sensitive data leakage.
    • *
  • If a TRACE request contains a body, a {@link ProtocolException} is thrown.
    • *
* * @version 5.4 * @see HttpRequestInterceptor * @see HttpException * @see IOException * @see ProtocolException * @see Method#TRACE * @see HttpHeaders#AUTHORIZATION * @see HttpHeaders#COOKIE */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestValidateTrace implements HttpRequestInterceptor { /** * Default instance of {@link RequestValidateTrace}. */ public static final HttpRequestInterceptor INSTANCE = new RequestValidateTrace(); /** * Default constructor. */ public RequestValidateTrace() { super(); } /** * Processes an incoming HTTP request. If the request is of type TRACE, it performs the following actions: *
    *
  • Throws a {@link ProtocolException} if the request contains an {@code Authorization} header to prevent sensitive data leakage.
    • *
  • Throws a {@link ProtocolException} if the request contains a {@code Cookie} header to prevent sensitive data leakage.
    • *
  • Throws a {@link ProtocolException} if the request contains a body.
    • *
* * @param request The incoming HTTP request. Cannot be {@code null}. * @param entity Details of the request entity. Can be {@code null}. * @param context The HTTP context. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); // Check if the request method is TRACE if (Method.TRACE.isSame(request.getMethod())) { // A client MUST NOT send content in a TRACE request. if (entity != null) { throw new ProtocolException("TRACE request MUST NOT contain a request body."); } // Check for sensitive headers final Header authHeader = request.getHeader(HttpHeaders.AUTHORIZATION); if (authHeader != null) { throw new ProtocolException("TRACE request MUST NOT contain an Authorization header."); } // Check for cookies final Header cookieHeader = request.getHeader(HttpHeaders.COOKIE); if (cookieHeader != null) { throw new ProtocolException("TRACE request MUST NOT contain a Cookie header."); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/ResponseProcessCookies.java0100644 0000000 0000000 00000014335 00000250600 030572 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Response interceptor that populates the current {@link CookieStore} with data * contained in response cookies received in the given the HTTP response. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ResponseProcessCookies implements HttpResponseInterceptor { /** * Default instance of {@link ResponseProcessCookies}. * * @since 5.2 */ public static final ResponseProcessCookies INSTANCE = new ResponseProcessCookies(); private static final Logger LOG = LoggerFactory.getLogger(ResponseProcessCookies.class); public ResponseProcessCookies() { super(); } @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(response, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain actual CookieSpec instance final CookieSpec cookieSpec = clientContext.getCookieSpec(); if (cookieSpec == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie spec not specified in HTTP context", exchangeId); } return; } // Obtain cookie store final CookieStore cookieStore = clientContext.getCookieStore(); if (cookieStore == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie store not specified in HTTP context", exchangeId); } return; } // Obtain actual CookieOrigin instance final CookieOrigin cookieOrigin = clientContext.getCookieOrigin(); if (cookieOrigin == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie origin not specified in HTTP context", exchangeId); } return; } final Iterator
it = response.headerIterator(HttpHeaders.SET_COOKIE); processCookies(exchangeId, it, cookieSpec, cookieOrigin, cookieStore); } private void processCookies( final String exchangeId, final Iterator
iterator, final CookieSpec cookieSpec, final CookieOrigin cookieOrigin, final CookieStore cookieStore) { while (iterator.hasNext()) { final Header header = iterator.next(); try { final List cookies = cookieSpec.parse(header, cookieOrigin); for (final Cookie cookie : cookies) { try { cookieSpec.validate(cookie, cookieOrigin); cookieStore.addCookie(cookie); if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie accepted [{}]", exchangeId, formatCookie(cookie)); } } catch (final MalformedCookieException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} Cookie rejected [{}] {}", exchangeId, formatCookie(cookie), ex.getMessage()); } } } } catch (final MalformedCookieException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} Invalid cookie header: \"{}\". {}", exchangeId, header, ex.getMessage()); } } } } private static String formatCookie(final Cookie cookie) { final StringBuilder buf = new StringBuilder(); buf.append(cookie.getName()); buf.append("=\""); String v = cookie.getValue(); if (v != null) { if (v.length() > 100) { v = v.substring(0, 100) + "..."; } buf.append(v); } buf.append("\""); buf.append(", domain:"); buf.append(cookie.getDomain()); buf.append(", path:"); buf.append(cookie.getPath()); buf.append(", expiry:"); buf.append(cookie.getExpiryInstant()); return buf.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/package-info.java0100644 0000000 0000000 00000002532 00000250600 026440 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP protocol interceptors that enable advanced functionality * such as HTTP state management and authentication state caching. */ package org.apache.hc.client5.http.protocol; httpclient5/src/main/java/org/apache/hc/client5/http/psl/0040755 0000000 0000000 00000000000 00000250600 022207 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/psl/DomainType.java0100644 0000000 0000000 00000002531 00000250600 025121 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; /** * Domain types differentiated by Mozilla Public Suffix List. * * @since 4.5 */ public enum DomainType { UNKNOWN, ICANN, PRIVATE } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixList.java0100644 0000000 0000000 00000005316 00000250600 026313 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.util.Collections; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Public suffix is a set of DNS names or wildcards concatenated with dots. It represents * the part of a domain name which is not under the control of the individual registrant *

* An up-to-date list of suffixes can be obtained from * publicsuffix.org *

* * @since 4.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class PublicSuffixList { private final DomainType type; private final List rules; private final List exceptions; /** * @since 4.5 */ public PublicSuffixList(final DomainType type, final List rules, final List exceptions) { this.type = Args.notNull(type, "Domain type"); this.rules = Collections.unmodifiableList(Args.notNull(rules, "Domain suffix rules")); this.exceptions = Collections.unmodifiableList(exceptions != null ? exceptions : Collections.emptyList()); } public PublicSuffixList(final List rules, final List exceptions) { this(DomainType.UNKNOWN, rules, exceptions); } /** * @since 4.5 */ public DomainType getType() { return type; } public List getRules() { return rules; } public List getExceptions() { return exceptions; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixListParser.java0100644 0000000 0000000 00000013755 00000250600 027476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.BufferedReader; import java.io.IOException; import java.io.Reader; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Parses the list from publicsuffix.org * and configures a PublicSuffixFilter. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class PublicSuffixListParser { /** * Default instance of {@link PublicSuffixListParser}. * * @since 5.2 */ public static final PublicSuffixListParser INSTANCE = new PublicSuffixListParser(); public PublicSuffixListParser() { } /** * Parses the public suffix list format. *

* When creating the reader from the file, make sure to use the correct encoding * (the original list is in UTF-8). * * @param reader the data reader. The caller is responsible for closing the reader. * @throws java.io.IOException on error while reading from list */ public PublicSuffixList parse(final Reader reader) throws IOException { final List rules = new ArrayList<>(); final List exceptions = new ArrayList<>(); final BufferedReader r = new BufferedReader(reader); String line; while ((line = r.readLine()) != null) { if (line.isEmpty()) { continue; } if (line.startsWith("//")) { continue; //entire lines can also be commented using // } if (line.startsWith(".")) { line = line.substring(1); // A leading dot is optional } // An exclamation mark (!) at the start of a rule marks an exception to a previous wildcard rule final boolean isException = line.startsWith("!"); if (isException) { line = line.substring(1); } if (isException) { exceptions.add(line); } else { rules.add(line); } } return new PublicSuffixList(DomainType.UNKNOWN, rules, exceptions); } /** * Parses the public suffix list format by domain type (currently supported ICANN and PRIVATE). *

* When creating the reader from the file, make sure to use the correct encoding * (the original list is in UTF-8). * * @param reader the data reader. The caller is responsible for closing the reader. * @throws java.io.IOException on error while reading from list * * @since 4.5 */ public List parseByType(final Reader reader) throws IOException { final List result = new ArrayList<>(2); final BufferedReader r = new BufferedReader(reader); DomainType domainType = null; List rules = null; List exceptions = null; String line; while ((line = r.readLine()) != null) { if (line.isEmpty()) { continue; } if (line.startsWith("//")) { if (domainType == null) { if (line.contains("===BEGIN ICANN DOMAINS===")) { domainType = DomainType.ICANN; } else if (line.contains("===BEGIN PRIVATE DOMAINS===")) { domainType = DomainType.PRIVATE; } } else { if (line.contains("===END ICANN DOMAINS===") || line.contains("===END PRIVATE DOMAINS===")) { if (rules != null) { result.add(new PublicSuffixList(domainType, rules, exceptions)); } domainType = null; rules = null; exceptions = null; } } continue; //entire lines can also be commented using // } if (domainType == null) { continue; } if (line.startsWith(".")) { line = line.substring(1); // A leading dot is optional } // An exclamation mark (!) at the start of a rule marks an exception to a previous wildcard rule final boolean isException = line.startsWith("!"); if (isException) { line = line.substring(1); } if (isException) { if (exceptions == null) { exceptions = new ArrayList<>(); } exceptions.add(line); } else { if (rules == null) { rules = new ArrayList<>(); } rules.add(line); } } return result; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixMatcher.java0100644 0000000 0000000 00000022752 00000250600 026766 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.net.IDN; import java.util.Collection; import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.utils.DnsUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Utility class that can test if DNS names match the content of the Public Suffix List. *

* An up-to-date list of suffixes can be obtained from * publicsuffix.org *

* * @see PublicSuffixList * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public final class PublicSuffixMatcher { private final Map rules; private final Map exceptions; public PublicSuffixMatcher(final Collection rules, final Collection exceptions) { this(DomainType.UNKNOWN, rules, exceptions); } /** * @since 4.5 */ public PublicSuffixMatcher( final DomainType domainType, final Collection rules, final Collection exceptions) { Args.notNull(domainType, "Domain type"); Args.notNull(rules, "Domain suffix rules"); this.rules = new ConcurrentHashMap<>(rules.size()); for (final String rule: rules) { this.rules.put(rule, domainType); } this.exceptions = new ConcurrentHashMap<>(); if (exceptions != null) { for (final String exception: exceptions) { this.exceptions.put(exception, domainType); } } } /** * @since 4.5 */ public PublicSuffixMatcher(final Collection lists) { Args.notNull(lists, "Domain suffix lists"); this.rules = new ConcurrentHashMap<>(); this.exceptions = new ConcurrentHashMap<>(); for (final PublicSuffixList list: lists) { final DomainType domainType = list.getType(); final List rules = list.getRules(); for (final String rule: rules) { this.rules.put(rule, domainType); } final List exceptions = list.getExceptions(); if (exceptions != null) { for (final String exception: exceptions) { this.exceptions.put(exception, domainType); } } } } private static DomainType findEntry(final Map map, final String rule) { if (map == null) { return null; } return map.get(rule); } private static boolean match(final DomainType domainType, final DomainType expectedType) { return domainType != null && (expectedType == null || domainType.equals(expectedType)); } /** * Returns registrable part of the domain for the given domain name or {@code null} * if given domain represents a public suffix. * * @param domain * @return domain root */ public String getDomainRoot(final String domain) { return getDomainRoot(domain, null); } /** * Returns registrable part of the domain for the given domain name or {@code null} * if given domain represents a public suffix. * * @param domain * @param expectedType expected domain type or {@code null} if any. * @return domain root * @since 4.5 */ public String getDomainRoot(final String domain, final DomainType expectedType) { if (domain == null) { return null; } if (domain.startsWith(".")) { return null; } String normalized = DnsUtils.normalize(domain); final boolean punyCoded = normalized.contains("xn-"); if (punyCoded) { normalized = IDN.toUnicode(normalized); } final DomainRootInfo match = resolveDomainRoot(normalized, expectedType); String domainRoot = match != null ? match.root : null; if (domainRoot != null && punyCoded) { domainRoot = IDN.toASCII(domainRoot); } return domainRoot; } static final class DomainRootInfo { final String root; final String matchingKey; final DomainType domainType; DomainRootInfo(final String root, final String matchingKey, final DomainType domainType) { this.root = root; this.matchingKey = matchingKey; this.domainType = domainType; } } DomainRootInfo resolveDomainRoot(final String domain, final DomainType expectedType) { String segment = domain; String result = null; while (segment != null) { // An exception rule takes priority over any other matching rule. final String key = segment; final DomainType exceptionRule = findEntry(exceptions, key); if (match(exceptionRule, expectedType)) { return new DomainRootInfo(segment, key, exceptionRule); } final DomainType domainRule = findEntry(rules, key); if (match(domainRule, expectedType)) { return new DomainRootInfo(result, key, domainRule); } final int nextdot = segment.indexOf('.'); final String nextSegment = nextdot != -1 ? segment.substring(nextdot + 1) : null; // look for wildcard entries final String wildcardKey = (nextSegment == null) ? "*" : "*." + nextSegment; final DomainType wildcardDomainRule = findEntry(rules, wildcardKey); if (match(wildcardDomainRule, expectedType)) { return new DomainRootInfo(result, wildcardKey, wildcardDomainRule); } // If we're out of segments, and we're not looking for a specific type of entry, // apply the default `*` rule. // This wildcard rule means any final segment in a domain is a public suffix, // so the current `result` is the desired public suffix plus 1 if (nextSegment == null && (expectedType == null || expectedType == DomainType.UNKNOWN)) { return new DomainRootInfo(result, null, null); } result = segment; segment = nextSegment; } // If no expectations then this result is good. if (expectedType == null || expectedType == DomainType.UNKNOWN) { return new DomainRootInfo(result, null, null); } // If we did have expectations apparently there was no match return null; } /** * Tests whether the given domain matches any of the entries from the public suffix list. */ public boolean matches(final String domain) { return matches(domain, null); } /** * Tests whether the given domain matches any of entry from the public suffix list. * * @param domain * @param expectedType expected domain type or {@code null} if any. * @return {@code true} if the given domain matches any of the public suffixes. * * @since 4.5 */ public boolean matches(final String domain, final DomainType expectedType) { if (domain == null) { return false; } final String domainRoot = getDomainRoot( domain.startsWith(".") ? domain.substring(1) : domain, expectedType); return domainRoot == null; } /** * Verifies if the given domain does not represent a public domain root and is * allowed to set cookies, have an identity represented by a certificate, etc. *

* This method tolerates a leading dot in the domain name, for example '.example.com' * which will be automatically stripped. *

* * @since 5.5 */ public boolean verify(final String domain) { if (domain == null) { return false; } return verifyInternal(domain.startsWith(".") ? domain.substring(1) : domain); } @Internal public boolean verifyInternal(final String domain) { final DomainRootInfo domainRootInfo = resolveDomainRoot(domain, null); if (domainRootInfo == null) { return false; } return domainRootInfo.root != null || domainRootInfo.domainType == DomainType.PRIVATE && domainRootInfo.matchingKey != null; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixMatcherLoader.java0100644 0000000 0000000 00000007523 00000250600 030114 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.net.URL; import java.nio.charset.StandardCharsets; import java.util.Collections; import java.util.List; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@link PublicSuffixMatcher} loader. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public final class PublicSuffixMatcherLoader { private static final String PUBLIC_SUFFIX_LIST = "/org/publicsuffix/list/effective_tld_names.dat"; private static final Logger LOG = LoggerFactory.getLogger(PublicSuffixMatcherLoader.class); private static final ReentrantLock lock = new ReentrantLock(); private static PublicSuffixMatcher load(final InputStream in) throws IOException { final List lists = PublicSuffixListParser.INSTANCE.parseByType( new InputStreamReader(in, StandardCharsets.UTF_8)); return new PublicSuffixMatcher(lists); } public static PublicSuffixMatcher load(final URL url) throws IOException { Args.notNull(url, "URL"); try (InputStream in = url.openStream()) { return load(in); } } public static PublicSuffixMatcher load(final File file) throws IOException { Args.notNull(file, "File"); try (InputStream in = new FileInputStream(file)) { return load(in); } } private static volatile PublicSuffixMatcher DEFAULT_INSTANCE; public static PublicSuffixMatcher getDefault() { if (DEFAULT_INSTANCE == null) { lock.lock(); try { if (DEFAULT_INSTANCE == null) { final URL url = PublicSuffixMatcherLoader.class.getResource(PUBLIC_SUFFIX_LIST); if (url != null) { try { DEFAULT_INSTANCE = load(url); } catch (final IOException ex) { // Should never happen LOG.warn("Failure loading public suffix list from default resource", ex); } } else { DEFAULT_INSTANCE = new PublicSuffixMatcher(DomainType.ICANN, Collections.singletonList("com"), null); } } } finally { lock.unlock(); } } return DEFAULT_INSTANCE; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/package-info.java0100644 0000000 0000000 00000002440 00000250600 025373 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Public Suffix List support classes. */ package org.apache.hc.client5.http.psl; httpclient5/src/main/java/org/apache/hc/client5/http/routing/0040755 0000000 0000000 00000000000 00000250600 023100 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/routing/HttpRouteDirector.java0100644 0000000 0000000 00000005215 00000250600 027375 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Provides directions on establishing a route. * Implementations of this interface compare a planned route with * a tracked route and indicate the next step required. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRouteDirector { /** Indicates that the route can not be established at all. */ int UNREACHABLE = -1; /** Indicates that the route is complete. */ int COMPLETE = 0; /** Step: open connection to target. */ int CONNECT_TARGET = 1; /** Step: open connection to proxy. */ int CONNECT_PROXY = 2; /** Step: tunnel through proxy to target. */ int TUNNEL_TARGET = 3; /** Step: tunnel through proxy to other proxy. */ int TUNNEL_PROXY = 4; /** Step: layer protocol (over tunnel). */ int LAYER_PROTOCOL = 5; /** * Provides the next step. * * @param plan the planned route * @param fact the currently established route, or * {@code null} if nothing is established * * @return one of the constants defined in this interface, indicating * either the next step to perform, or success, or failure. * 0 is for success, a negative value for failure. */ int nextStep(RouteInfo plan, RouteInfo fact); } httpclient5/src/main/java/org/apache/hc/client5/http/routing/HttpRoutePlanner.java0100644 0000000 0000000 00000006174 00000250600 027226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * Encapsulates logic to compute a {@link HttpRoute} to a target host. * Implementations may for example be based on parameters, or on the * standard Java system properties. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRoutePlanner { /** * Determines the route for the given host. * * @param target the target host for the request. * @param context the context to use for the subsequent execution. * Implementations may accept {@code null}. * * @return the route that the request should take * * @throws HttpException in case of a problem */ HttpRoute determineRoute(HttpHost target, HttpContext context) throws HttpException; /** * Determines the route for the given host. * * @param target the target host for the request. * @param request the request message. Can be {@code null} if not given / known. * @param context the context to use for the subsequent execution. * Implementations may accept {@code null}. * * @return the route that the request should take * @throws HttpException in case of a problem. * * @since 5.4 */ default HttpRoute determineRoute(HttpHost target, HttpRequest request, HttpContext context) throws HttpException { return determineRoute(target, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/routing/RoutingSupport.java0100644 0000000 0000000 00000006236 00000250600 026773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import java.net.URI; import java.net.URISyntaxException; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.net.URIAuthority; public final class RoutingSupport { public static HttpHost determineHost(final HttpRequest request) throws HttpException { if (request == null) { return null; } final URIAuthority authority = request.getAuthority(); if (authority != null) { final String scheme = request.getScheme(); if (scheme == null) { throw new ProtocolException("Protocol scheme is not specified"); } return new HttpHost(scheme, authority); } try { final URI requestURI = request.getUri(); if (requestURI.isAbsolute()) { final HttpHost httpHost = URIUtils.extractHost(requestURI); if (httpHost == null) { throw new ProtocolException("URI does not specify a valid host name: " + requestURI); } return httpHost; } } catch (final URISyntaxException ignore) { } return null; } public static HttpHost normalize(final HttpHost host, final SchemePortResolver schemePortResolver) { if (host == null) { return null; } if (host.getPort() < 0) { final int port = (schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE).resolve(host); if (port > 0) { return new HttpHost(host.getSchemeName(), host.getAddress(), host.getHostName(), port); } } return host; } } httpclient5/src/main/java/org/apache/hc/client5/http/routing/package-info.java0100644 0000000 0000000 00000002370 00000250600 026266 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection routing APIs. */ package org.apache.hc.client5.http.routing; httpclient5/src/main/java/org/apache/hc/client5/http/socket/0040755 0000000 0000000 00000000000 00000250600 022701 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/socket/ConnectionSocketFactory.java0100644 0000000 0000000 00000011732 00000250600 030345 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * A factory for creating and connecting connection sockets. * * @deprecated Do not use. */ @Contract(threading = ThreadingBehavior.STATELESS) @Deprecated public interface ConnectionSocketFactory { /** * Creates new, unconnected socket. The socket should subsequently be passed to * {@link #connectSocket(TimeValue, Socket, HttpHost, InetSocketAddress, InetSocketAddress, * HttpContext) connectSocket} method. */ Socket createSocket(HttpContext context) throws IOException; /** * Creates new, unconnected socket via a proxy (generally SOCKS is expected). * The socket should subsequently be passed to {@link #connectSocket(TimeValue, Socket, * HttpHost, InetSocketAddress, InetSocketAddress, HttpContext) connectSocket} method. * * @since 5.2 */ @Internal default Socket createSocket(Proxy proxy, HttpContext context) throws IOException { return createSocket(context); } /** * Connects the socket to the target host with the given resolved remote address. * * @param connectTimeout connect timeout. * @param socket the socket to connect, as obtained from {@link #createSocket(HttpContext)}. * {@code null} indicates that a new socket should be created and connected. * @param host target host as specified by the caller (end user). * @param remoteAddress the resolved remote address to connect to. * @param localAddress the local address to bind the socket to, or {@code null} for any. * @param context the actual HTTP context. * * @return the connected socket. The returned object may be different * from the {@code sock} argument if this factory supports * a layered protocol. * * @throws IOException if an I/O error occurs */ Socket connectSocket( TimeValue connectTimeout, Socket socket, HttpHost host, InetSocketAddress remoteAddress, InetSocketAddress localAddress, HttpContext context) throws IOException; /** * Connects the socket to the target host with the given resolved remote address. * * @param socket the socket to connect, as obtained from {@link #createSocket(HttpContext)}. * {@code null} indicates that a new socket should be created and connected. * @param host target host as specified by the caller (end user). * @param remoteAddress the resolved remote address to connect to. * @param localAddress the local address to bind the socket to, or {@code null} for any. * @param connectTimeout connect timeout. * @param attachment connect request attachment. * @param context the actual HTTP context. * * @return the connected socket. The returned object may be different * from the {@code sock} argument if this factory supports * a layered protocol. * * @throws IOException if an I/O error occurs * * @since 5.2 */ default Socket connectSocket( Socket socket, HttpHost host, InetSocketAddress remoteAddress, InetSocketAddress localAddress, Timeout connectTimeout, Object attachment, HttpContext context) throws IOException { return connectSocket(connectTimeout, socket, host, remoteAddress, localAddress, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/Jep380SocketChannelAdapter.java0100644 0000000 0000000 00000006002 00000250600 030453 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.Socket; import java.net.SocketAddress; import java.net.SocketException; import java.nio.channels.SocketChannel; final class Jep380SocketChannelAdapter extends Socket { private final SocketChannel channel; private final Jep380SocketChannelImplAdapter adapter; Jep380SocketChannelAdapter(final SocketChannel channel) throws IOException { this(channel, new Jep380SocketChannelImplAdapter(channel)); } private Jep380SocketChannelAdapter(final SocketChannel channel, final Jep380SocketChannelImplAdapter adapter) { this.channel = channel; this.adapter = adapter; } @Override public void connect(final SocketAddress endpoint, final int timeout) throws IOException { channel.connect(endpoint); channel.configureBlocking(false); } @Override public void connect(final SocketAddress endpoint) throws IOException { channel.connect(endpoint); channel.configureBlocking(false); } @Override public boolean isConnected() { return channel.isConnected(); } @Override public InputStream getInputStream() throws IOException { return adapter.getInputStream(); } @Override public OutputStream getOutputStream() throws IOException { return adapter.getOutputStream(); } @Override public boolean isClosed() { return !channel.isOpen(); } @Override public void close() throws IOException { adapter.close(); } @Override public int getSoTimeout() throws SocketException { return adapter.soTimeoutMs; } @Override public void setSoTimeout(final int timeout) throws SocketException { adapter.soTimeoutMs = timeout; } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/Jep380SocketChannelImplAdapter.java0100644 0000000 0000000 00000016660 00000250600 031310 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.UncheckedIOException; import java.net.InetAddress; import java.net.SocketAddress; import java.net.SocketException; import java.net.SocketImpl; import java.net.SocketOptions; import java.net.SocketTimeoutException; import java.net.StandardSocketOptions; import java.nio.ByteBuffer; import java.nio.channels.SelectionKey; import java.nio.channels.Selector; import java.nio.channels.SocketChannel; final class Jep380SocketChannelImplAdapter extends SocketImpl { private final SocketChannel channel; volatile int soTimeoutMs = 0; public Jep380SocketChannelImplAdapter(final SocketChannel channel) throws IOException { this.channel = channel; } @Override protected void close() throws IOException { channel.close(); } @Override protected InputStream getInputStream() throws IOException { return new InputStreamAdapter(); } @Override protected OutputStream getOutputStream() throws IOException { return new OutputStreamAdapter(); } @Override public Object getOption(final int optID) throws SocketException { try { switch (optID) { case SocketOptions.SO_TIMEOUT: return soTimeoutMs; case SocketOptions.SO_RCVBUF: return channel.getOption(StandardSocketOptions.SO_RCVBUF); case SocketOptions.SO_SNDBUF: return channel.getOption(StandardSocketOptions.SO_SNDBUF); } } catch (final IOException ex) { throw new UncheckedIOException(ex); } throw new UnsupportedOperationException("getOption: " + optID); } @Override public void setOption(final int optID, final Object value) throws SocketException { try { switch (optID) { case SocketOptions.SO_TIMEOUT: soTimeoutMs = (Integer) value; return; case SocketOptions.SO_RCVBUF: channel.setOption(StandardSocketOptions.SO_RCVBUF, (Integer) value); return; case SocketOptions.SO_SNDBUF: channel.setOption(StandardSocketOptions.SO_SNDBUF, (Integer) value); return; } } catch (final IOException ex) { throw new RuntimeException(ex); } throw new UnsupportedOperationException(); } @Override protected void accept(final SocketImpl s) throws IOException { throw new UnsupportedOperationException(); } @Override protected int available() throws IOException { throw new UnsupportedOperationException(); } @Override protected void bind(final InetAddress host, final int port) throws IOException { throw new UnsupportedOperationException(); } @Override protected void connect(final String host, final int port) throws IOException { throw new UnsupportedOperationException(); } @Override protected void connect(final InetAddress address, final int port) throws IOException { throw new UnsupportedOperationException(); } @Override protected void connect(final SocketAddress address, final int timeout) throws IOException { throw new UnsupportedOperationException(); } @Override protected void create(final boolean stream) throws IOException { throw new UnsupportedOperationException(); } @Override protected void listen(final int backlog) throws IOException { throw new UnsupportedOperationException(); } @Override protected void sendUrgentData(final int data) throws IOException { throw new UnsupportedOperationException(); } private class InputStreamAdapter extends InputStream { private final Selector sel; private final SelectionKey key; private InputStreamAdapter() throws IOException { this.sel = Selector.open(); this.key = channel.register(sel, SelectionKey.OP_READ); } @Override public int read() throws IOException { final byte[] b = new byte[1]; final int n = read(b, 0, 1); return (n == -1) ? -1 : (b[0] & 0xFF); } @Override public int read(final byte[] b) throws IOException { return read(b, 0, b.length); } @Override public int read(final byte[] b, final int off, final int len) throws IOException { final ByteBuffer buf = ByteBuffer.wrap(b, off, len); if (sel.select(soTimeoutMs) == 0) { throw new SocketTimeoutException(); } final int read = channel.read(buf); sel.selectedKeys().clear(); return read; } @Override public void close() throws IOException { key.cancel(); sel.close(); channel.close(); } } private class OutputStreamAdapter extends OutputStream { private final Selector sel; private final SelectionKey key; private OutputStreamAdapter() throws IOException { this.sel = Selector.open(); this.key = channel.register(sel, SelectionKey.OP_WRITE); } @Override public void write(final int b) throws IOException { write(new byte[]{ (byte) b}); } @Override public void write(final byte[] b) throws IOException { write(b, 0, b.length); } @Override public void write(final byte[] b, final int off, final int len) throws IOException { final ByteBuffer buf = ByteBuffer.wrap(b, off, len); while (buf.hasRemaining()) { final int n = channel.write(buf); if (n == 0) { if (sel.select(60_000) == 0) { throw new SocketTimeoutException("write timed out"); } sel.selectedKeys().clear(); } } } @Override public void close() throws IOException { key.cancel(); sel.close(); channel.close(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/LayeredConnectionSocketFactory.java0100644 0000000 0000000 00000006344 00000250600 031656 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Extended {@link ConnectionSocketFactory} interface for layered sockets such as SSL/TLS. * * @deprecated Use {@link org.apache.hc.client5.http.ssl.TlsSocketStrategy}. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory { /** * Returns a socket connected to the given host that is layered over an * existing socket. Used primarily for creating secure sockets through * proxies. * * @param socket the existing socket * @param target the name of the target host. * @param port the port to connect to on the target host. * @param context the actual HTTP context. * * @return Socket a new socket * * @throws IOException if an I/O error occurs while creating the socket */ Socket createLayeredSocket( Socket socket, String target, int port, HttpContext context) throws IOException; /** * Returns a socket connected to the given host that is layered over an * existing socket. Used primarily for creating secure sockets through * proxies. * * @param socket the existing socket * @param target the name of the target host. * @param port the port to connect to on the target host. * @param context the actual HTTP context. * @param attachment connect request attachment. * * @return Socket a new socket * * @throws IOException if an I/O error occurs while creating the socket * * @since 5.2 */ default Socket createLayeredSocket( Socket socket, String target, int port, Object attachment, HttpContext context) throws IOException { return createLayeredSocket(socket, target, port, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/PlainConnectionSocketFactory.java0100644 0000000 0000000 00000010571 00000250600 031331 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.security.AccessController; import java.security.PrivilegedActionException; import java.security.PrivilegedExceptionAction; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; /** * The default class for creating plain (unencrypted) sockets. * * @deprecated Use {@link org.apache.hc.client5.http.io.DetachedSocketFactory}. * Please note this interface is considered internal. * * @see org.apache.hc.client5.http.impl.io.DefaultHttpClientConnectionOperator * @see org.apache.hc.client5.http.io.DetachedSocketFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class PlainConnectionSocketFactory implements ConnectionSocketFactory { /** * Default instance of {@link PlainConnectionSocketFactory}. */ public static final PlainConnectionSocketFactory INSTANCE = new PlainConnectionSocketFactory(); public static PlainConnectionSocketFactory getSocketFactory() { return INSTANCE; } public PlainConnectionSocketFactory() { super(); } @Override public Socket createSocket(final Proxy proxy, final HttpContext context) throws IOException { return proxy != null ? new Socket(proxy) : createSocket(context); } @Override public Socket createSocket(final HttpContext context) throws IOException { return new Socket(); } @Override public Socket connectSocket( final TimeValue connectTimeout, final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final HttpContext context) throws IOException { final Socket sock = socket != null ? socket : createSocket(context); if (localAddress != null) { sock.bind(localAddress); } try { // Run this under a doPrivileged to support lib users that run under a SecurityManager this allows granting connect permissions // only to this library try { AccessController.doPrivileged((PrivilegedExceptionAction) () -> { sock.connect(remoteAddress, TimeValue.isPositive(connectTimeout) ? connectTimeout.toMillisecondsIntBound() : 0); return null; }); } catch (final PrivilegedActionException e) { Asserts.check(e.getCause() instanceof IOException, "method contract violation only checked exceptions are wrapped: " + e.getCause()); // only checked exceptions are wrapped - error and RTExceptions are rethrown by doPrivileged throw (IOException) e.getCause(); } } catch (final IOException ex) { Closer.closeQuietly(sock); throw ex; } return sock; } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/UnixDomainSocketFactory.java0100644 0000000 0000000 00000016602 00000250600 030322 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.IOException; import java.lang.reflect.Method; import java.net.ProtocolFamily; import java.net.Socket; import java.net.SocketAddress; import java.net.StandardProtocolFamily; import java.nio.channels.SocketChannel; import java.nio.file.Path; /** * A factory for Unix domain sockets. *

* This implementation supports both the JDK16+ standard library implementation (JEP 380) and the JUnixSocket library. * It will automatically detect which implementation is available and use it; if both are available, the standard * library implementation is preferred. *

* * @since 5.6 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class UnixDomainSocketFactory { private static final Logger LOG = LoggerFactory.getLogger(UnixDomainSocketFactory.class); private static final String JDK_UNIX_SOCKET_ADDRESS_CLASS = "java.net.UnixDomainSocketAddress"; private static final String JUNIXSOCKET_SOCKET_CLASS = "org.newsclub.net.unix.AFUNIXSocket"; private static final String JUNIXSOCKET_ADDRESS_CLASS = "org.newsclub.net.unix.AFUNIXSocketAddress"; private enum Implementation { JDK, JUNIXSOCKET, NONE } private static final Implementation IMPLEMENTATION = detectImplementation(); private static Implementation detectImplementation() { try { Class.forName(JDK_UNIX_SOCKET_ADDRESS_CLASS); LOG.debug("Using JDK Unix Domain Socket implementation"); return Implementation.JDK; } catch (final ClassNotFoundException e) { try { Class.forName(JUNIXSOCKET_SOCKET_CLASS); LOG.debug("Using JUnixSocket Unix Domain Socket implementation"); return Implementation.JUNIXSOCKET; } catch (final ClassNotFoundException e2) { LOG.debug("No Unix Domain Socket implementation found"); return Implementation.NONE; } } } /** * Checks if Unix Domain Socket support is available. * * @return true if Unix Domain Socket support is available, false otherwise */ public static boolean isAvailable() { return IMPLEMENTATION != Implementation.NONE; } /** * Default instance of {@link UnixDomainSocketFactory}. */ private static final UnixDomainSocketFactory INSTANCE = new UnixDomainSocketFactory(); /** * Gets the singleton instance of {@link UnixDomainSocketFactory}. * * @return the singleton instance */ public static UnixDomainSocketFactory getSocketFactory() { return INSTANCE; } public SocketAddress createSocketAddress(final Path socketPath) { if (!isAvailable()) { throw new UnsupportedOperationException("Unix Domain Socket support is not available"); } Args.notNull(socketPath, "Unix domain socket path"); try { if (IMPLEMENTATION == Implementation.JDK) { // JDK implementation final Class addressClass = Class.forName(JDK_UNIX_SOCKET_ADDRESS_CLASS); final Method ofMethod = addressClass.getMethod("of", Path.class); return (SocketAddress) ofMethod.invoke(null, socketPath); } else { // JUnixSocket implementation final Class addressClass = Class.forName(JUNIXSOCKET_ADDRESS_CLASS); final Method ofMethod = addressClass.getMethod("of", Path.class); return (SocketAddress) ofMethod.invoke(null, socketPath); } } catch (final ReflectiveOperationException ex) { throw new RuntimeException("Could not create UDS SocketAddress", ex); } } public Socket createSocket() throws IOException { if (!isAvailable()) { throw new UnsupportedOperationException("Unix Domain Socket support is not available"); } try { if (IMPLEMENTATION == Implementation.JDK) { // Java 16+ only supports UDS through the SocketChannel API, but the sync client is coupled to the // legacy Socket API. To facilitate this, we use an adapter, similar to the one provided by JUnixSocket. try { final SocketChannel channel = (SocketChannel) SocketChannel.class.getMethod("open", ProtocolFamily.class) .invoke(null, StandardProtocolFamily.valueOf("UNIX")); return new Jep380SocketChannelAdapter(channel); } catch (final ReflectiveOperationException ex) { throw new UnsupportedOperationException("JEP 380 Unix domain sockets are not supported; use " + "JUnixSocket", ex); } } else { // JUnixSocket implementation final Class socketClass = Class.forName(JUNIXSOCKET_SOCKET_CLASS); final Method newInstanceMethod = socketClass.getMethod("newInstance"); return (Socket) newInstanceMethod.invoke(null); } } catch (final Exception e) { throw new IOException("Failed to create Unix domain socket", e); } } public Socket connectSocket( final Socket socket, final Path socketPath, final TimeValue connectTimeout ) throws IOException { Args.notNull(socketPath, "Unix domain socket path"); final Socket sock = socket != null ? socket : createSocket(); final SocketAddress address = createSocketAddress(socketPath); final int connTimeoutMs = TimeValue.isPositive(connectTimeout) ? connectTimeout.toMillisecondsIntBound() : 0; try { sock.connect(address, connTimeoutMs); return sock; } catch (final IOException ex) { try { sock.close(); } catch (final IOException ignore) { } throw ex; } } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/package-info.java0100644 0000000 0000000 00000002366 00000250600 026074 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection socket APIs. */ package org.apache.hc.client5.http.socket; httpclient5/src/main/java/org/apache/hc/client5/http/ssl/0040755 0000000 0000000 00000000000 00000250600 022212 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/ssl/AbstractClientTlsStrategy.java0100644 0000000 0000000 00000037070 00000250600 030171 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.IOException; import java.net.Socket; import java.net.SocketAddress; import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; import java.util.Objects; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLException; import javax.net.ssl.SSLHandshakeException; import javax.net.ssl.SSLParameters; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.http.ssl.TlsCiphers; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.http2.ssl.H2TlsSupport; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Contract(threading = ThreadingBehavior.STATELESS) abstract class AbstractClientTlsStrategy implements TlsStrategy, TlsSocketStrategy { private static final Logger LOG = LoggerFactory.getLogger(AbstractClientTlsStrategy.class); private final SSLContext sslContext; private final String[] supportedProtocols; private final String[] supportedCipherSuites; private final SSLBufferMode sslBufferManagement; private final HostnameVerificationPolicy hostnameVerificationPolicy; private final HostnameVerifier hostnameVerifier; AbstractClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(); this.sslContext = Args.notNull(sslContext, "SSL context"); this.supportedProtocols = supportedProtocols; this.supportedCipherSuites = supportedCipherSuites; this.sslBufferManagement = sslBufferManagement != null ? sslBufferManagement : SSLBufferMode.STATIC; this.hostnameVerificationPolicy = hostnameVerificationPolicy != null ? hostnameVerificationPolicy : (hostnameVerifier != null ? HostnameVerificationPolicy.BOTH : HostnameVerificationPolicy.BUILTIN); this.hostnameVerifier = hostnameVerifier; } /** * @deprecated use {@link #upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)} */ @Deprecated @Override public boolean upgrade( final TransportSecurityLayer tlsSession, final HttpHost host, final SocketAddress localAddress, final SocketAddress remoteAddress, final Object attachment, final Timeout handshakeTimeout) { upgrade(tlsSession, host, attachment, handshakeTimeout, null); return true; } @Override public void upgrade( final TransportSecurityLayer tlsSession, final NamedEndpoint endpoint, final Object attachment, final Timeout handshakeTimeout, final FutureCallback callback) { tlsSession.startTls(sslContext, endpoint, sslBufferManagement, (e, sslEngine) -> { final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; final HttpVersionPolicy versionPolicy = tlsConfig.getHttpVersionPolicy(); final SSLParameters sslParameters = sslEngine.getSSLParameters(); final String[] supportedProtocols = tlsConfig.getSupportedProtocols(); if (supportedProtocols != null) { sslParameters.setProtocols(supportedProtocols); } else if (this.supportedProtocols != null) { sslParameters.setProtocols(this.supportedProtocols); } else if (versionPolicy != HttpVersionPolicy.FORCE_HTTP_1) { sslParameters.setProtocols(TLS.excludeWeak(sslParameters.getProtocols())); } final String[] supportedCipherSuites = tlsConfig.getSupportedCipherSuites(); if (supportedCipherSuites != null) { sslParameters.setCipherSuites(supportedCipherSuites); } else if (this.supportedCipherSuites != null) { sslParameters.setCipherSuites(this.supportedCipherSuites); } else if (versionPolicy == HttpVersionPolicy.FORCE_HTTP_2) { sslParameters.setCipherSuites(TlsCiphers.excludeH2Blacklisted(sslParameters.getCipherSuites())); } if (versionPolicy != HttpVersionPolicy.FORCE_HTTP_1) { H2TlsSupport.setEnableRetransmissions(sslParameters, false); } applyParameters(sslEngine, sslParameters, H2TlsSupport.selectApplicationProtocols(versionPolicy)); if (hostnameVerificationPolicy == HostnameVerificationPolicy.BUILTIN || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH) { sslParameters.setEndpointIdentificationAlgorithm(URIScheme.HTTPS.id); } initializeEngine(sslEngine); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", Arrays.asList(sslEngine.getEnabledProtocols())); LOG.debug("Enabled cipher suites: {}", Arrays.asList(sslEngine.getEnabledCipherSuites())); LOG.debug("Starting handshake ({})", handshakeTimeout); } }, (e, sslEngine) -> { verifySession(endpoint.getHostName(), sslEngine.getSession()); final TlsDetails tlsDetails = createTlsDetails(sslEngine); final String negotiatedCipherSuite = sslEngine.getSession().getCipherSuite(); if (tlsDetails != null && ApplicationProtocol.HTTP_2.id.equals(tlsDetails.getApplicationProtocol())) { if (TlsCiphers.isH2Blacklisted(negotiatedCipherSuite)) { throw new SSLHandshakeException("Cipher suite `" + negotiatedCipherSuite + "` does not provide adequate security for HTTP/2"); } } return tlsDetails; }, handshakeTimeout, callback); } abstract void applyParameters(SSLEngine sslEngine, SSLParameters sslParameters, String[] appProtocols); abstract TlsDetails createTlsDetails(SSLEngine sslEngine); protected void initializeEngine(final SSLEngine sslEngine) { } protected void initializeSocket(final SSLSocket socket) { } protected void verifySession( final String hostname, final SSLSession sslsession) throws SSLException { verifySession(hostname, sslsession, hostnameVerificationPolicy == HostnameVerificationPolicy.CLIENT || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH ? hostnameVerifier : null); } @Override public SSLSocket upgrade(final Socket socket, final String target, final int port, final Object attachment, final HttpContext context) throws IOException { final SSLSocket upgradedSocket = (SSLSocket) sslContext.getSocketFactory().createSocket( socket, target, port, false); try { executeHandshake(upgradedSocket, target, attachment); return upgradedSocket; } catch (IOException | RuntimeException ex) { Closer.closeQuietly(upgradedSocket); throw ex; } } private void executeHandshake( final SSLSocket upgradedSocket, final String target, final Object attachment) throws IOException { final SSLParameters sslParameters = upgradedSocket.getSSLParameters(); if (supportedProtocols != null) { sslParameters.setProtocols(supportedProtocols); } else { sslParameters.setProtocols(TLS.excludeWeak(upgradedSocket.getEnabledProtocols())); } if (supportedCipherSuites != null) { sslParameters.setCipherSuites(supportedCipherSuites); } else { sslParameters.setCipherSuites(TlsCiphers.excludeWeak(upgradedSocket.getEnabledCipherSuites())); } if (hostnameVerificationPolicy == HostnameVerificationPolicy.BUILTIN || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH) { sslParameters.setEndpointIdentificationAlgorithm(URIScheme.HTTPS.id); } upgradedSocket.setSSLParameters(sslParameters); initializeSocket(upgradedSocket); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", (Object) upgradedSocket.getEnabledProtocols()); LOG.debug("Enabled cipher suites: {}", (Object) upgradedSocket.getEnabledCipherSuites()); } upgradedSocket.startHandshake(); verifySession(target, upgradedSocket.getSession()); } void verifySession( final String hostname, final SSLSession sslsession, final HostnameVerifier hostnameVerifier) throws SSLException { if (LOG.isDebugEnabled()) { LOG.debug("Secure session established"); LOG.debug(" negotiated protocol: {}", sslsession.getProtocol()); LOG.debug(" negotiated cipher suite: {}", sslsession.getCipherSuite()); try { final Certificate[] certs = sslsession.getPeerCertificates(); final Certificate cert = certs[0]; if (cert instanceof X509Certificate) { final X509Certificate x509 = (X509Certificate) cert; final X500Principal peer = x509.getSubjectX500Principal(); LOG.debug("Peer principal: {}", toEscapedString(peer)); final Collection> altNames1 = x509.getSubjectAlternativeNames(); if (altNames1 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames1) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" peer alternative names: {}", altNames); } final X500Principal issuer = x509.getIssuerX500Principal(); LOG.debug("Issuer principal: {}", toEscapedString(issuer)); final Collection> altNames2 = x509.getIssuerAlternativeNames(); if (altNames2 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames2) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" issuer alternative names: {}", altNames); } } } catch (final Exception ignore) { } } if (hostnameVerifier != null) { final Certificate[] certs = sslsession.getPeerCertificates(); if (certs.length < 1) { throw new SSLPeerUnverifiedException("Peer certificate chain is empty"); } final Certificate peerCertificate = certs[0]; final X509Certificate x509Certificate; if (peerCertificate instanceof X509Certificate) { x509Certificate = (X509Certificate) peerCertificate; } else { throw new SSLPeerUnverifiedException("Unexpected certificate type: " + peerCertificate.getType()); } if (hostnameVerifier instanceof HttpClientHostnameVerifier) { ((HttpClientHostnameVerifier) hostnameVerifier).verify(hostname, x509Certificate); } else if (!hostnameVerifier.verify(hostname, sslsession)) { final List subjectAlts = DefaultHostnameVerifier.getSubjectAltNames(x509Certificate); throw new SSLPeerUnverifiedException("Certificate for <" + hostname + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } } } /** * Converts an X500Principal to a cleaned string by escaping control characters. *

* This method processes the RFC2253 format of the X500Principal and escapes * any ISO control characters to avoid issues in logging or other outputs. * Control characters are replaced with their escaped hexadecimal representation. *

* *

Note: For testing purposes, this method is package-private * to allow access within the same package. This allows tests to verify the correct * behavior of the escaping process.

* * @param principal the X500Principal to escape * @return the escaped string representation of the X500Principal */ @Internal String toEscapedString(final X500Principal principal) { final String principalValue = principal.getName(X500Principal.RFC2253); final StringBuilder sanitizedPrincipal = new StringBuilder(principalValue.length()); for (final char c : principalValue.toCharArray()) { if (Character.isISOControl(c)) { sanitizedPrincipal.append(String.format("\\x%02x", (int) c)); } else { sanitizedPrincipal.append(c); } } return sanitizedPrincipal.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/ClientTlsStrategyBuilder.java0100644 0000000 0000000 00000016641 00000250600 030015 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import org.apache.hc.core5.function.Factory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; /** * Builder for client TLS strategy instances. *

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #buildAsync()} or {@link #buildClassic()}. *

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @since 5.0 */ public class ClientTlsStrategyBuilder { public static ClientTlsStrategyBuilder create() { return new ClientTlsStrategyBuilder(); } private SSLContext sslContext; private String[] tlsVersions; private String[] ciphers; private SSLBufferMode sslBufferMode; private HostnameVerificationPolicy hostnameVerificationPolicy; private HostnameVerifier hostnameVerifier; private boolean systemProperties; /** * Sets {@link SSLContext} instance. * * @return this instance. */ public ClientTlsStrategyBuilder setSslContext(final SSLContext sslContext) { this.sslContext = sslContext; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final ClientTlsStrategyBuilder setTlsVersions(final String... tlslVersions) { this.tlsVersions = tlslVersions; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final ClientTlsStrategyBuilder setTlsVersions(final TLS... tlslVersions) { this.tlsVersions = new String[tlslVersions.length]; for (int i = 0; i < tlslVersions.length; i++) { this.tlsVersions[i] = tlslVersions[i].id; } return this; } /** * Sets enabled ciphers. * * @return this instance. */ public final ClientTlsStrategyBuilder setCiphers(final String... ciphers) { this.ciphers = ciphers; return this; } /** * Sets {@link SSLBufferMode} value. * * @return this instance. */ public ClientTlsStrategyBuilder setSslBufferMode(final SSLBufferMode sslBufferMode) { this.sslBufferMode = sslBufferMode; return this; } /** * Sets {@link HostnameVerificationPolicy} value. * * @deprecated Use #setHostVerificationPolicy */ @Deprecated public void setHostnameVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) { this.hostnameVerificationPolicy = hostnameVerificationPolicy; } /** * Sets {@link HostnameVerificationPolicy} value. * * @since 5.5 */ public ClientTlsStrategyBuilder setHostVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) { this.hostnameVerificationPolicy = hostnameVerificationPolicy; return this; } /** * Sets {@link HostnameVerifier} instance. * * @return this instance. */ public ClientTlsStrategyBuilder setHostnameVerifier(final HostnameVerifier hostnameVerifier) { this.hostnameVerifier = hostnameVerifier; return this; } /** * Sets {@link TlsDetails} {@link Factory} instance. * * @return this instance. * @deprecated Do not use. This method has no effect. */ @Deprecated public ClientTlsStrategyBuilder setTlsDetailsFactory(final Factory tlsDetailsFactory) { return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final ClientTlsStrategyBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * @deprecated Use {@link #buildAsync()} or {@link #buildClassic()}. */ @Deprecated public TlsStrategy build() { return buildImpl(); } /** * @since 5.5 */ public TlsStrategy buildAsync() { return buildImpl(); } /** * @since 5.5 */ public TlsSocketStrategy buildClassic() { return buildImpl(); } private DefaultClientTlsStrategy buildImpl() { final SSLContext sslContextCopy; if (sslContext != null) { sslContextCopy = sslContext; } else { sslContextCopy = systemProperties ? SSLContexts.createSystemDefault() : SSLContexts.createDefault(); } final String[] tlsVersionsCopy; if (tlsVersions != null) { tlsVersionsCopy = tlsVersions; } else { tlsVersionsCopy = systemProperties ? HttpsSupport.getSystemProtocols() : null; } final String[] ciphersCopy; if (ciphers != null) { ciphersCopy = ciphers; } else { ciphersCopy = systemProperties ? HttpsSupport.getSystemCipherSuits() : null; } final HostnameVerificationPolicy hostnameVerificationPolicyCopy = hostnameVerificationPolicy != null ? hostnameVerificationPolicy : (hostnameVerifier == null ? HostnameVerificationPolicy.BUILTIN : HostnameVerificationPolicy.BOTH); return new DefaultClientTlsStrategy( sslContextCopy, tlsVersionsCopy, ciphersCopy, sslBufferMode != null ? sslBufferMode : SSLBufferMode.STATIC, hostnameVerificationPolicyCopy, hostnameVerifier); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/ConscryptClientTlsStrategy.java0100644 0000000 0000000 00000012506 00000250600 030407 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLParameters; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; import org.conscrypt.Conscrypt; /** * TLS upgrade strategy for non-blocking client connections using Conscrypt TLS library. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ConscryptClientTlsStrategy extends AbstractClientTlsStrategy { public static TlsStrategy getDefault() { return new ConscryptClientTlsStrategy( SSLContexts.createDefault(), HostnameVerificationPolicy.BUILTIN, null); } public static TlsStrategy getSystemDefault() { return new ConscryptClientTlsStrategy( SSLContexts.createSystemDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), SSLBufferMode.STATIC, HostnameVerificationPolicy.BUILTIN, null); } public ConscryptClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier) { this(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, HostnameVerificationPolicy.CLIENT, hostnameVerifier); } /** * @since 5.4 */ public ConscryptClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, hostnameVerificationPolicy, hostnameVerifier); } public ConscryptClientTlsStrategy( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerifier); } /** * @since 5.4 */ public ConscryptClientTlsStrategy( final SSLContext sslContext, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerificationPolicy, hostnameVerifier); } public ConscryptClientTlsStrategy(final SSLContext sslContext) { this(sslContext, null); } @Override void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { if (Conscrypt.isConscrypt(sslEngine)) { sslEngine.setSSLParameters(sslParameters); Conscrypt.setApplicationProtocols(sslEngine, appProtocols); } else { sslParameters.setApplicationProtocols(appProtocols); sslEngine.setSSLParameters(sslParameters); } } @Override TlsDetails createTlsDetails(final SSLEngine sslEngine) { if (Conscrypt.isConscrypt(sslEngine)) { return new TlsDetails(sslEngine.getSession(), Conscrypt.getApplicationProtocol(sslEngine)); } return null; } public static boolean isSupported() { try { final Class clazz = Class.forName("org.conscrypt.Conscrypt"); final Method method = clazz.getMethod("isAvailable"); return ((Boolean) method.invoke(null)).booleanValue(); } catch (final ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DefaultClientTlsStrategy.java0100644 0000000 0000000 00000013457 00000250600 030015 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLParameters; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Factory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; /** * TLS upgrade strategy for non-blocking client connections. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultClientTlsStrategy extends AbstractClientTlsStrategy { /** * @since 5.4 */ public static DefaultClientTlsStrategy createDefault() { return new DefaultClientTlsStrategy( SSLContexts.createDefault(), HostnameVerificationPolicy.BUILTIN, null); } /** * @since 5.4 */ public static DefaultClientTlsStrategy createSystemDefault() { return new DefaultClientTlsStrategy( SSLContexts.createSystemDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), SSLBufferMode.STATIC, HostnameVerificationPolicy.BUILTIN, null); } /** * @deprecated Use {@link #createDefault()}. */ @Deprecated public static TlsStrategy getDefault() { return createDefault(); } /** * @deprecated Use {@link #createSystemDefault()}. */ @Deprecated public static TlsStrategy getSystemDefault() { return createSystemDefault(); } /** * @deprecated To be removed. */ @Deprecated private Factory tlsDetailsFactory; /** * @deprecated Use {@link DefaultClientTlsStrategy#DefaultClientTlsStrategy(SSLContext, String[], String[], SSLBufferMode, HostnameVerifier)} */ @Deprecated public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier, final Factory tlsDetailsFactory) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, HostnameVerificationPolicy.CLIENT, hostnameVerifier); this.tlsDetailsFactory = tlsDetailsFactory; } /** * @since 5.4 */ public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, hostnameVerificationPolicy, hostnameVerifier); } public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier) { this(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, null, hostnameVerifier); } public DefaultClientTlsStrategy( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerifier); } /** * @since 5.4 */ public DefaultClientTlsStrategy( final SSLContext sslContext, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerificationPolicy, hostnameVerifier); } public DefaultClientTlsStrategy(final SSLContext sslContext) { this(sslContext, null); } @Override @SuppressWarnings("Since15") void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { sslParameters.setApplicationProtocols(appProtocols); sslEngine.setSSLParameters(sslParameters); } @Override @SuppressWarnings("deprecated") TlsDetails createTlsDetails(final SSLEngine sslEngine) { return tlsDetailsFactory != null ? tlsDetailsFactory.create(sslEngine) : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DefaultHostnameVerifier.java0100644 0000000 0000000 00000034766 00000250600 027651 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.net.InetAddress; import java.net.UnknownHostException; import java.security.cert.Certificate; import java.security.cert.CertificateParsingException; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.LinkedList; import java.util.List; import javax.net.ssl.SSLException; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DnsUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.net.InetAddressUtils; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default {@link javax.net.ssl.HostnameVerifier} implementation. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class DefaultHostnameVerifier implements HttpClientHostnameVerifier { enum HostNameType { IPv4(7), IPv6(7), DNS(2); final int subjectType; HostNameType(final int subjectType) { this.subjectType = subjectType; } } private static final Logger LOG = LoggerFactory.getLogger(DefaultHostnameVerifier.class); private final PublicSuffixMatcher publicSuffixMatcher; /** * Constructs new instance with a PublicSuffixMatcher. * * @param publicSuffixMatcher a PublicSuffixMatcher. */ public DefaultHostnameVerifier(final PublicSuffixMatcher publicSuffixMatcher) { this.publicSuffixMatcher = publicSuffixMatcher; } /** * Constructs new instance without a PublicSuffixMatcher. */ public DefaultHostnameVerifier() { this(null); } @Override public boolean verify(final String host, final SSLSession session) { try { final Certificate[] certs = session.getPeerCertificates(); final X509Certificate x509 = (X509Certificate) certs[0]; verify(host, x509); return true; } catch (final SSLException ex) { if (LOG.isDebugEnabled()) { LOG.debug(ex.getMessage(), ex); } return false; } } @Override public void verify(final String host, final X509Certificate cert) throws SSLException { final HostNameType hostType = determineHostFormat(host); switch (hostType) { case IPv4: matchIPAddress(host, getSubjectAltNames(cert, SubjectName.IP)); break; case IPv6: matchIPv6Address(host, getSubjectAltNames(cert, SubjectName.IP)); break; default: final List subjectAlts = getSubjectAltNames(cert, SubjectName.DNS); if (subjectAlts.isEmpty()) { // CN matching has been deprecated by rfc2818 and can be used // as fallback only when no subjectAlts of type SubjectName.DNS are available matchCN(host, cert, this.publicSuffixMatcher); } else { matchDNSName(host, subjectAlts, this.publicSuffixMatcher); } } } static void matchIPAddress(final String host, final List subjectAlts) throws SSLPeerUnverifiedException { for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.IP) { if (host.equals(subjectAlt.getValue())) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchIPv6Address(final String host, final List subjectAlts) throws SSLPeerUnverifiedException { final String normalisedHost = normaliseAddress(host); for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.IP) { final String normalizedSubjectAlt = normaliseAddress(subjectAlt.getValue()); if (normalisedHost.equals(normalizedSubjectAlt)) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchDNSName(final String host, final List subjectAlts, final PublicSuffixMatcher publicSuffixMatcher) throws SSLPeerUnverifiedException { final String normalizedHost = DnsUtils.normalizeUnicode(host); for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.DNS) { final String normalizedSubjectAlt = DnsUtils.normalizeUnicode(subjectAlt.getValue()); if (matchIdentity(normalizedHost, normalizedSubjectAlt, publicSuffixMatcher, true)) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchCN(final String host, final X509Certificate cert, final PublicSuffixMatcher publicSuffixMatcher) throws SSLException { final X500Principal subjectPrincipal = cert.getSubjectX500Principal(); final String cn = extractCN(subjectPrincipal.getName(X500Principal.RFC2253)); if (cn == null) { throw new SSLPeerUnverifiedException("Certificate subject for <" + host + "> doesn't contain " + "a common name and does not have alternative names"); } final String normalizedHost = DnsUtils.normalizeUnicode(host); final String normalizedCn = DnsUtils.normalizeUnicode(cn); if (!matchIdentity(normalizedHost, normalizedCn, publicSuffixMatcher, true)) { throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match " + "common name of the certificate subject: " + cn); } } static List parseFQDN(final CharSequence s) { if (s == null) { return null; } final LinkedList elements = new LinkedList<>(); int pos = 0; for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (ch == '.') { elements.addFirst(s.subSequence(pos, i)); pos = i + 1; } } elements.addFirst(s.subSequence(pos, s.length())); return elements; } static boolean matchDomainRoot(final String host, final String domainRoot) { if (domainRoot == null) { return false; } final List hostElements = parseFQDN(host); final List rootElements = parseFQDN(domainRoot); if (hostElements.size() >= rootElements.size()) { for (int i = 0; i < rootElements.size(); i++) { final CharSequence s1 = rootElements.get(i); final CharSequence s2 = hostElements.get(i); if (!s1.equals(s2)) { return false; } } return true; } return false; } static boolean matchIdentity(final String host, final String identity, final PublicSuffixMatcher publicSuffixMatcher, final boolean strict) { if (publicSuffixMatcher != null && host.contains(".")) { if (!publicSuffixMatcher.verifyInternal(identity)) { if (LOG.isDebugEnabled()) { LOG.debug("Public Suffix List verification failed for identity '{}'", identity); } return false; } } // RFC 2818, 3.1. Server Identity // "...Names may contain the wildcard // character * which is considered to match any single domain name // component or component fragment..." // Based on this statement presuming only singular wildcard is legal final int asteriskIdx = identity.indexOf('*'); if (asteriskIdx != -1) { final String prefix = identity.substring(0, asteriskIdx); final String suffix = identity.substring(asteriskIdx + 1); if (!prefix.isEmpty() && !host.startsWith(prefix)) { return false; } if (!suffix.isEmpty() && !host.endsWith(suffix)) { return false; } // Additional sanity checks on content selected by wildcard can be done here if (strict) { final String remainder = host.substring( prefix.length(), host.length() - suffix.length() ); return !remainder.contains("."); } return true; } // Direct Unicode comparison return host.equalsIgnoreCase(identity); } static String extractCN(final String subjectPrincipal) throws SSLException { if (subjectPrincipal == null) { return null; } final List attributes = DistinguishedNameParser.INSTANCE.parse(subjectPrincipal); for (final NameValuePair attribute: attributes) { if (TextUtils.isBlank(attribute.getName()) || attribute.getValue() == null) { throw new SSLException(subjectPrincipal + " is not a valid X500 distinguished name"); } if (attribute.getName().equalsIgnoreCase("cn")) { return attribute.getValue(); } } return null; } static HostNameType determineHostFormat(final String host) { if (InetAddressUtils.isIPv4(host)) { return HostNameType.IPv4; } String s = host; if (s.startsWith("[") && s.endsWith("]")) { s = host.substring(1, host.length() - 1); } if (InetAddressUtils.isIPv6(s)) { return HostNameType.IPv6; } return HostNameType.DNS; } static List getSubjectAltNames(final X509Certificate cert) { return getSubjectAltNames(cert, -1); } static List getSubjectAltNames(final X509Certificate cert, final int subjectName) { try { final Collection> entries = cert.getSubjectAlternativeNames(); if (entries == null) { return Collections.emptyList(); } final List result = new ArrayList<>(); for (final List entry : entries) { final Integer type = entry.size() >= 2 ? (Integer) entry.get(0) : null; if (type != null) { if (type == subjectName || -1 == subjectName) { final Object o = entry.get(1); if (o instanceof String) { result.add(new SubjectName((String) o, type)); } else if (o instanceof byte[]) { final byte[] bytes = (byte[]) o; if (type == SubjectName.IP) { if (bytes.length == 4) { result.add(new SubjectName(byteArrayToIp(bytes), type)); // IPv4 } else if (bytes.length == 16) { result.add(new SubjectName(byteArrayToIPv6(bytes), type)); // IPv6 } } } } } } return result; } catch (final CertificateParsingException ignore) { return Collections.emptyList(); } } /* * Normalize IPv6 or DNS name. */ static String normaliseAddress(final String hostname) { if (hostname == null) { return hostname; } try { final InetAddress inetAddress = InetAddress.getByName(hostname); return inetAddress.getHostAddress(); } catch (final UnknownHostException unexpected) { // Should not happen, because we check for IPv6 address above return hostname; } } private static String byteArrayToIp(final byte[] bytes) { if (bytes.length != 4) { throw new IllegalArgumentException("Invalid byte array length for IPv4 address"); } return (bytes[0] & 0xFF) + "." + (bytes[1] & 0xFF) + "." + (bytes[2] & 0xFF) + "." + (bytes[3] & 0xFF); } private static String byteArrayToIPv6(final byte[] bytes) { if (bytes.length != 16) { throw new IllegalArgumentException("Invalid byte array length for IPv6 address"); } final StringBuilder sb = new StringBuilder(); for (int i = 0; i < bytes.length; i += 2) { sb.append(String.format("%02x%02x", bytes[i], bytes[i + 1])); if (i < bytes.length - 2) { sb.append(":"); } } return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DistinguishedNameParser.java0100644 0000000 0000000 00000011611 00000250600 027633 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; final class DistinguishedNameParser { /** * Default instance of {@link DistinguishedNameParser}. */ public final static DistinguishedNameParser INSTANCE = new DistinguishedNameParser(); private static final Tokenizer.Delimiter EQUAL_OR_COMMA_OR_PLUS = Tokenizer.delimiters('=', ',', '+'); private static final Tokenizer.Delimiter COMMA_OR_PLUS = Tokenizer.delimiters(',', '+'); private final Tokenizer tokenParser = new InternalTokenParser(); private DistinguishedNameParser() { // empty } private String parseToken(final CharArrayBuffer buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters) { return tokenParser.parseToken(buf, cursor, delimiters); } private String parseValue(final CharArrayBuffer buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters) { return tokenParser.parseValue(buf, cursor, delimiters); } private NameValuePair parseParameter(final CharArrayBuffer buf, final Tokenizer.Cursor cursor) { final String name = parseToken(buf, cursor, EQUAL_OR_COMMA_OR_PLUS); if (cursor.atEnd()) { return new BasicNameValuePair(name, null); } final int delim = buf.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (delim == ',') { return new BasicNameValuePair(name, null); } final String value = parseValue(buf, cursor, COMMA_OR_PLUS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } return new BasicNameValuePair(name, value); } List parse(final CharArrayBuffer buf, final Tokenizer.Cursor cursor) { final List params = new ArrayList<>(); tokenParser.skipWhiteSpace(buf, cursor); while (!cursor.atEnd()) { final NameValuePair param = parseParameter(buf, cursor); params.add(param); } return params; } List parse(final String s) { if (s == null) { return null; } final CharArrayBuffer buffer = new CharArrayBuffer(s.length()); buffer.append(s); final Tokenizer.Cursor cursor = new Tokenizer.Cursor(0, s.length()); return parse(buffer, cursor); } static class InternalTokenParser extends Tokenizer { @Override public void copyUnquotedContent( final CharSequence buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters, final StringBuilder dst) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); boolean escaped = false; for (int i = indexFrom; i < indexTo; i++, pos++) { final char current = buf.charAt(i); if (escaped) { dst.append(current); escaped = false; } else { if (delimiters != null && delimiters.test(current) || Tokenizer.isWhitespace(current) || current == '\"') { break; } else if (current == '\\') { escaped = true; } else { dst.append(current); } } } cursor.updatePos(pos); } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HostnameVerificationPolicy.java0100644 0000000 0000000 00000003347 00000250600 030362 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; /** * Hostname verification policy. * * @see javax.net.ssl.HostnameVerifier * @see DefaultHostnameVerifier * * @since 5.4 */ public enum HostnameVerificationPolicy { /** * Hostname verification is delegated to the JSSE provider, usually executed during the TLS handshake. */ BUILTIN, /** * Hostname verification is executed by HttpClient post TLS handshake. */ CLIENT, /** * Hostname verification is executed by the JSSE provider and by HttpClient post TLS handshake. */ BOTH } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HttpClientHostnameVerifier.java0100644 0000000 0000000 00000003631 00000250600 030326 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.cert.X509Certificate; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Extended {@link HostnameVerifier} interface. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpClientHostnameVerifier extends HostnameVerifier { /** * Verifies the supplied server {@link X509Certificate} and ensures it matches * the original host name. * * @param host the original host name. * @param cert the server certificate; */ void verify(String host, X509Certificate cert) throws SSLException; } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HttpsSupport.java0100644 0000000 0000000 00000004340 00000250600 025552 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.AccessController; import java.security.PrivilegedAction; import javax.net.ssl.HostnameVerifier; import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader; import org.apache.hc.core5.util.TextUtils; /** * HTTPS configuration support methods. * * @since 5.0 */ public final class HttpsSupport { private static String[] split(final String s) { if (TextUtils.isBlank(s)) { return null; } return s.split(" *, *"); } private static String getProperty(final String key) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key)); } public static String[] getSystemProtocols() { return split(getProperty("https.protocols")); } public static String[] getSystemCipherSuits() { return split(getProperty("https.cipherSuites")); } public static HostnameVerifier getDefaultHostnameVerifier() { return new DefaultHostnameVerifier(PublicSuffixMatcherLoader.getDefault()); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/NoopHostnameVerifier.java0100644 0000000 0000000 00000004000 00000250600 027152 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLSession; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * The NO_OP HostnameVerifier essentially turns hostname verification * off. This implementation is a no-op, and never throws the SSLException. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NoopHostnameVerifier implements HostnameVerifier { /** * Default instance of {@link NoopHostnameVerifier}. */ public static final NoopHostnameVerifier INSTANCE = new NoopHostnameVerifier(); @Override public boolean verify(final String s, final SSLSession sslSession) { return true; } @Override public final String toString() { return "NO_OP"; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SSLConnectionSocketFactory.java0100644 0000000 0000000 00000046057 00000250600 030250 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.IOException; import java.io.InputStream; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.net.SocketAddress; import java.security.AccessController; import java.security.PrivilegedActionException; import java.security.PrivilegedExceptionAction; import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Objects; import java.util.regex.Pattern; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLException; import javax.net.ssl.SSLHandshakeException; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.http.ssl.TlsCiphers; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.ssl.SSLContexts; import org.apache.hc.core5.ssl.SSLInitializationException; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Layered socket factory for TLS/SSL connections. *

* SSLSocketFactory can be used to validate the identity of the HTTPS server against a list of * trusted certificates and to authenticate to the HTTPS server using a private key. * * @deprecated Use {@link DefaultClientTlsStrategy}. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class SSLConnectionSocketFactory implements org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory { private static final String WEAK_KEY_EXCHANGES = "^(TLS|SSL)_(NULL|ECDH_anon|DH_anon|DH_anon_EXPORT|DHE_RSA_EXPORT|DHE_DSS_EXPORT|" + "DSS_EXPORT|DH_DSS_EXPORT|DH_RSA_EXPORT|RSA_EXPORT|KRB5_EXPORT)_(.*)"; private static final String WEAK_CIPHERS = "^(TLS|SSL)_(.*)_WITH_(NULL|DES_CBC|DES40_CBC|DES_CBC_40|3DES_EDE_CBC|RC4_128|RC4_40|RC2_CBC_40)_(.*)"; private static final List WEAK_CIPHER_SUITE_PATTERNS = Collections.unmodifiableList(Arrays.asList( Pattern.compile(WEAK_KEY_EXCHANGES, Pattern.CASE_INSENSITIVE), Pattern.compile(WEAK_CIPHERS, Pattern.CASE_INSENSITIVE))); private static final Logger LOG = LoggerFactory.getLogger(SSLConnectionSocketFactory.class); /** * Obtains default SSL socket factory with an SSL context based on the standard JSSE * trust material ({@code cacerts} file in the security properties directory). * System properties are not taken into consideration. * * @return default SSL socket factory */ public static SSLConnectionSocketFactory getSocketFactory() throws SSLInitializationException { return new SSLConnectionSocketFactory(SSLContexts.createDefault(), HttpsSupport.getDefaultHostnameVerifier()); } /** * Obtains default SSL socket factory with an SSL context based on system properties * as described in * * Java™ Secure Socket Extension (JSSE) Reference Guide. * * @return default system SSL socket factory */ public static SSLConnectionSocketFactory getSystemSocketFactory() throws SSLInitializationException { return new SSLConnectionSocketFactory( (javax.net.ssl.SSLSocketFactory) javax.net.ssl.SSLSocketFactory.getDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), HttpsSupport.getDefaultHostnameVerifier()); } static boolean isWeakCipherSuite(final String cipherSuite) { for (final Pattern pattern : WEAK_CIPHER_SUITE_PATTERNS) { if (pattern.matcher(cipherSuite).matches()) { return true; } } return false; } private final javax.net.ssl.SSLSocketFactory socketFactory; private final HostnameVerifier hostnameVerifier; private final String[] supportedProtocols; private final String[] supportedCipherSuites; public SSLConnectionSocketFactory(final SSLContext sslContext) { this(sslContext, HttpsSupport.getDefaultHostnameVerifier()); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(Args.notNull(sslContext, "SSL context").getSocketFactory(), null, null, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final HostnameVerifier hostnameVerifier) { this(Args.notNull(sslContext, "SSL context").getSocketFactory(), supportedProtocols, supportedCipherSuites, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final javax.net.ssl.SSLSocketFactory socketFactory, final HostnameVerifier hostnameVerifier) { this(socketFactory, null, null, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final javax.net.ssl.SSLSocketFactory socketFactory, final String[] supportedProtocols, final String[] supportedCipherSuites, final HostnameVerifier hostnameVerifier) { this.socketFactory = Args.notNull(socketFactory, "SSL socket factory"); this.supportedProtocols = supportedProtocols; this.supportedCipherSuites = supportedCipherSuites; this.hostnameVerifier = hostnameVerifier != null ? hostnameVerifier : HttpsSupport.getDefaultHostnameVerifier(); } /** * @deprecated Use {@link #prepareSocket(SSLSocket, HttpContext)} */ @Deprecated protected void prepareSocket(final SSLSocket socket) throws IOException { } /** * Performs any custom initialization for a newly created SSLSocket * (before the SSL handshake happens). * * The default implementation is a no-op, but could be overridden to, e.g., * call {@link javax.net.ssl.SSLSocket#setEnabledCipherSuites(String[])}. * @throws IOException may be thrown if overridden */ @SuppressWarnings("deprecation") protected void prepareSocket(final SSLSocket socket, final HttpContext context) throws IOException { prepareSocket(socket); } @Override public Socket createSocket(final HttpContext context) throws IOException { return new Socket(); } @Override public Socket createSocket(final Proxy proxy, final HttpContext context) throws IOException { return proxy != null ? new Socket(proxy) : createSocket(context); } @Override public Socket connectSocket( final TimeValue connectTimeout, final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final HttpContext context) throws IOException { final Timeout timeout = connectTimeout != null ? Timeout.of(connectTimeout.getDuration(), connectTimeout.getTimeUnit()) : null; return connectSocket(socket, host, remoteAddress, localAddress, timeout, timeout, context); } @Override public Socket connectSocket( final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final HttpContext context) throws IOException { Args.notNull(host, "HTTP host"); Args.notNull(remoteAddress, "Remote address"); final Socket sock = socket != null ? socket : createSocket(context); if (localAddress != null) { sock.bind(localAddress); } try { connectSocket(sock, remoteAddress, connectTimeout, context); } catch (final IOException ex) { Closer.closeQuietly(sock); throw ex; } // Setup SSL layering if necessary if (sock instanceof SSLSocket) { final SSLSocket sslsock = (SSLSocket) sock; executeHandshake(sslsock, host.getHostName(), attachment, context); return sock; } return createLayeredSocket(sock, host.getHostName(), remoteAddress.getPort(), attachment, context); } /** * Connects the socket to the target host with the given resolved remote address using * {@link Socket#connect(SocketAddress, int)}. This method may be overridden to customize * how precisely {@link Socket#connect(SocketAddress, int)} is handled without impacting * other connection establishment code within {@link #executeHandshake(SSLSocket, String, Object, HttpContext)}, * for example. * * @param sock the socket to connect. * @param remoteAddress the resolved remote address to connect to. * @param connectTimeout connect timeout. * @param context the actual HTTP context. * @throws IOException if an I/O error occurs */ protected void connectSocket( final Socket sock, final InetSocketAddress remoteAddress, final Timeout connectTimeout, final HttpContext context) throws IOException { Args.notNull(sock, "Socket"); Args.notNull(remoteAddress, "Remote address"); if (LOG.isDebugEnabled()) { LOG.debug("Connecting socket to {} with timeout {}", remoteAddress, connectTimeout); } // Run this under a doPrivileged to support lib users that run under a SecurityManager this allows granting connect permissions // only to this library try { AccessController.doPrivileged((PrivilegedExceptionAction) () -> { sock.connect(remoteAddress, Timeout.defaultsToDisabled(connectTimeout).toMillisecondsIntBound()); return null; }); } catch (final PrivilegedActionException e) { Asserts.check(e.getCause() instanceof IOException, "method contract violation only checked exceptions are wrapped: " + e.getCause()); // only checked exceptions are wrapped - error and RTExceptions are rethrown by doPrivileged throw (IOException) e.getCause(); } } @Override public Socket createLayeredSocket( final Socket socket, final String target, final int port, final HttpContext context) throws IOException { return createLayeredSocket(socket, target, port, null, context); } @Override public Socket createLayeredSocket( final Socket socket, final String target, final int port, final Object attachment, final HttpContext context) throws IOException { final SSLSocket sslsock = (SSLSocket) this.socketFactory.createSocket( socket, target, port, true); executeHandshake(sslsock, target, attachment, context); return sslsock; } private void executeHandshake( final SSLSocket sslsock, final String target, final Object attachment, final HttpContext context) throws IOException { final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; if (supportedProtocols != null) { sslsock.setEnabledProtocols(supportedProtocols); } else { sslsock.setEnabledProtocols(TLS.excludeWeak(sslsock.getEnabledProtocols())); } if (supportedCipherSuites != null) { sslsock.setEnabledCipherSuites(supportedCipherSuites); } else { sslsock.setEnabledCipherSuites(TlsCiphers.excludeWeak(sslsock.getEnabledCipherSuites())); } final Timeout handshakeTimeout = tlsConfig.getHandshakeTimeout(); if (handshakeTimeout != null) { sslsock.setSoTimeout(handshakeTimeout.toMillisecondsIntBound()); } prepareSocket(sslsock, context); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", (Object) sslsock.getEnabledProtocols()); LOG.debug("Enabled cipher suites: {}", (Object) sslsock.getEnabledCipherSuites()); LOG.debug("Starting handshake ({})", handshakeTimeout); } sslsock.startHandshake(); verifyHostname(sslsock, target); } private void verifyHostname(final SSLSocket sslsock, final String hostname) throws IOException { try { SSLSession session = sslsock.getSession(); if (session == null) { // In our experience this only happens under IBM 1.4.x when // spurious (unrelated) certificates show up in the server' // chain. Hopefully this will unearth the real problem: final InputStream in = sslsock.getInputStream(); in.available(); // If ssl.getInputStream().available() didn't cause an // exception, maybe at least now the session is available? session = sslsock.getSession(); if (session == null) { // If it's still null, probably a startHandshake() will // unearth the real problem. sslsock.startHandshake(); session = sslsock.getSession(); } } if (session == null) { throw new SSLHandshakeException("SSL session not available"); } verifySession(hostname, session); } catch (final IOException iox) { // close the socket before re-throwing the exception Closer.closeQuietly(sslsock); throw iox; } } protected void verifySession( final String hostname, final SSLSession sslSession) throws SSLException { verifySession(hostname, sslSession, hostnameVerifier); } void verifySession( final String hostname, final SSLSession sslsession, final HostnameVerifier hostnameVerifier) throws SSLException { if (LOG.isDebugEnabled()) { LOG.debug("Secure session established"); LOG.debug(" negotiated protocol: {}", sslsession.getProtocol()); LOG.debug(" negotiated cipher suite: {}", sslsession.getCipherSuite()); try { final Certificate[] certs = sslsession.getPeerCertificates(); final Certificate cert = certs[0]; if (cert instanceof X509Certificate) { final X509Certificate x509 = (X509Certificate) cert; final X500Principal peer = x509.getSubjectX500Principal(); LOG.debug(" peer principal: {}", peer); final Collection> altNames1 = x509.getSubjectAlternativeNames(); if (altNames1 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames1) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" peer alternative names: {}", altNames); } final X500Principal issuer = x509.getIssuerX500Principal(); LOG.debug(" issuer principal: {}", issuer); final Collection> altNames2 = x509.getIssuerAlternativeNames(); if (altNames2 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames2) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" issuer alternative names: {}", altNames); } } } catch (final Exception ignore) { } } if (hostnameVerifier != null) { final Certificate[] certs = sslsession.getPeerCertificates(); if (certs.length < 1) { throw new SSLPeerUnverifiedException("Peer certificate chain is empty"); } final Certificate peerCertificate = certs[0]; final X509Certificate x509Certificate; if (peerCertificate instanceof X509Certificate) { x509Certificate = (X509Certificate) peerCertificate; } else { throw new SSLPeerUnverifiedException("Unexpected certificate type: " + peerCertificate.getType()); } if (hostnameVerifier instanceof HttpClientHostnameVerifier) { ((HttpClientHostnameVerifier) hostnameVerifier).verify(hostname, x509Certificate); } else if (!hostnameVerifier.verify(hostname, sslsession)) { final List subjectAlts = DefaultHostnameVerifier.getSubjectAltNames(x509Certificate); throw new SSLPeerUnverifiedException("Certificate for <" + hostname + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SSLConnectionSocketFactoryBuilder.java0100644 0000000 0000000 00000012745 00000250600 031554 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.ssl.SSLContexts; /** * Builder for {@link SSLConnectionSocketFactory} instances. *

* When a particular component is not explicitly set this class will * use its default implementation. System properties will be taken * into account when configuring the default implementations when * {@link #useSystemProperties()} method is called prior to calling * {@link #build()}. *

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @deprecated Use {@link DefaultClientTlsStrategy} */ @Deprecated public class SSLConnectionSocketFactoryBuilder { public static SSLConnectionSocketFactoryBuilder create() { return new SSLConnectionSocketFactoryBuilder(); } private SSLContext sslContext; private String[] tlsVersions; private String[] ciphers; private HostnameVerifier hostnameVerifier; private boolean systemProperties; /** * Sets {@link SSLContext} instance. * * @return this instance. */ public SSLConnectionSocketFactoryBuilder setSslContext(final SSLContext sslContext) { this.sslContext = sslContext; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setTlsVersions(final String... tlslVersions) { this.tlsVersions = tlslVersions; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setTlsVersions(final TLS... tlslVersions) { this.tlsVersions = new String[tlslVersions.length]; for (int i = 0; i < tlslVersions.length; i++) { this.tlsVersions[i] = tlslVersions[i].id; } return this; } /** * Sets enabled ciphers. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setCiphers(final String... ciphers) { this.ciphers = ciphers; return this; } /** * Sets {@link HostnameVerifier} instance. * * @return this instance. */ public SSLConnectionSocketFactoryBuilder setHostnameVerifier(final HostnameVerifier hostnameVerifier) { this.hostnameVerifier = hostnameVerifier; return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder useSystemProperties() { this.systemProperties = true; return this; } public SSLConnectionSocketFactory build() { final javax.net.ssl.SSLSocketFactory socketFactory; if (sslContext != null) { socketFactory = sslContext.getSocketFactory(); } else { if (systemProperties) { socketFactory = (javax.net.ssl.SSLSocketFactory) javax.net.ssl.SSLSocketFactory.getDefault(); } else { socketFactory = SSLContexts.createDefault().getSocketFactory(); } } final String[] tlsVersionsCopy; if (tlsVersions != null) { tlsVersionsCopy = tlsVersions; } else { tlsVersionsCopy = systemProperties ? HttpsSupport.getSystemProtocols() : null; } final String[] ciphersCopy; if (ciphers != null) { ciphersCopy = ciphers; } else { ciphersCopy = systemProperties ? HttpsSupport.getSystemCipherSuits() : null; } return new SSLConnectionSocketFactory( socketFactory, tlsVersionsCopy, ciphersCopy, hostnameVerifier != null ? hostnameVerifier : HttpsSupport.getDefaultHostnameVerifier()); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SpkiPinningClientTlsStrategy.java0100644 0000000 0000000 00000031123 00000250600 030650 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.net.IDN; import java.security.MessageDigest; import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Base64; import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Locale; import java.util.Objects; import java.util.Set; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLException; import javax.net.ssl.SSLSession; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** *

SPKI pinning decorator for client-side TLS.

* *

This strategy enforces one or more {@code sha256/} pins for a given * host or single-label wildcard (e.g. {@code *.example.com}) after the standard * trust manager and hostname verification succeed. Pins are matched against the * {@code SubjectPublicKeyInfo} (SPKI) of any certificate in the peer chain.

* *

Host matching is performed on the IDNA ASCII (Punycode) lowercase form. * Wildcards are single-label only (e.g. {@code *.example.com} matches * {@code a.example.com} but not {@code a.b.example.com}).

* *

Warning: Certificate pinning increases operational risk. * Always ship at least two pins (active + backup) and keep * normal PKI + hostname verification enabled.

* *

Thread-safety: immutable and thread-safe.

* * @since 5.6 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class SpkiPinningClientTlsStrategy extends DefaultClientTlsStrategy { private static final String PIN_PREFIX = "sha256/"; private static final int SHA256_LEN = 32; /** * Byte-array key with constant-time equality for use in sets/maps. */ private static final class ByteArrayKey { final byte[] v; private final int hash; ByteArrayKey(final byte[] v) { this.v = Objects.requireNonNull(v, "bytes"); int h = 1; for (int i = 0; i < v.length; i++) { h = 31 * h + (v[i] & 0xff); } this.hash = h; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (!(o instanceof ByteArrayKey)) { return false; } return MessageDigest.isEqual(v, ((ByteArrayKey) o).v); } @Override public int hashCode() { return hash; } } /** * Match rule for a host or single-label wildcard. */ private static final class Rule { final String pattern; // normalized: IDNA ASCII + lowercase final boolean wildcard; // true if pattern starts with "*." final String tail; // for wildcard, ".example.com"; otherwise null final Set pins; // unmodifiable set of 32-byte SHA-256 hashes Rule(final String pattern, final Set pins) { if (pattern == null) { throw new IllegalArgumentException("Host pattern must not be null"); } final String norm; try { norm = IDN.toASCII(pattern).toLowerCase(Locale.ROOT); } catch (final IllegalArgumentException e) { throw new IllegalArgumentException("Invalid IDN host pattern: " + pattern, e); } if (norm.isEmpty()) { throw new IllegalArgumentException("Empty host pattern"); } final boolean wc = norm.startsWith("*."); if (wc && norm.indexOf('.', 2) < 0) { // require "*.