diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml new file mode 100644 index 0000000000..2586cf3c6f --- /dev/null +++ b/.github/workflows/builds.yml @@ -0,0 +1,59 @@ +name: Build Check + +on: + schedule: + - cron: '0 12 * * *' + +jobs: + Verify: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Grant Permission + run: chmod +x ./mvnw + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Verify + run: ./mvnw -B -ntp clean verify -DskipTests -Dgpg.skip=true + + RunOnLinux: + runs-on: ubuntu-latest + needs: Verify + steps: + - uses: actions/checkout@v4 + - name: Grant Permission + run: chmod +x ./mvnw + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw -B -ntp test + + RunOnMacOs: + runs-on: macos-latest + needs: Verify + steps: + - uses: actions/checkout@v4 + - name: Grant Permission + run: chmod +x ./mvnw + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw -B -ntp test + + RunOnWindows: + runs-on: windows-latest + needs: Verify + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw.cmd -B -ntp test diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 0000000000..1f49d31122 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,55 @@ +# This workflow is designed to build PRs for AHC. Note that it does not actually publish AHC, just builds and test it. +# Docs: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven + +name: Build PR + +on: + push: + branches: + - main + pull_request: + + workflow_dispatch: + inputs: + name: + description: 'Github Actions' + required: true + default: 'Github Actions' + +jobs: + RunOnLinux: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Grant Permission + run: sudo chmod +x ./mvnw + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw -B -ntp clean test + + RunOnMacOs: + runs-on: macos-latest + steps: + - uses: actions/checkout@v4 + - name: Grant Permission + run: sudo chmod +x ./mvnw + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw -B -ntp clean test + + RunOnWindows: + runs-on: windows-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + - name: Run Tests + run: ./mvnw.cmd -B -ntp clean test diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000000..b175fa865c --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,52 @@ +name: Release + +on: + workflow_dispatch: + inputs: + name: + description: 'Github Actions - Release' + required: true + default: 'Github Actions - Release' + +jobs: + + Publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Grant Permission + run: sudo chmod +x ./mvnw + + - uses: actions/setup-java@v4 + with: + distribution: 'corretto' + java-version: '11' + + - name: Remove old Maven Settings + run: rm -f /home/runner/.m2/settings.xml + + - name: Maven Settings + uses: s4u/maven-settings-action@v3.1.0 + with: + servers: | + [{ + "id": "ossrh", + "username": "${{ secrets.OSSRH_USERNAME }}", + "password": "${{ secrets.OSSRH_PASSWORD }}" + }] + + - name: Import GPG + uses: crazy-max/ghaction-import-gpg@v6.3.0 + with: + gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} + passphrase: ${{ secrets.GPG_PASSPHRASE }} + + - name: Build + run: mvn -ntp -B clean verify install -DskipTests + + - name: Publish to Maven Central + env: + GPG_KEY_NAME: ${{ secrets.GPG_KEY_NAME }} + GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} + run: mvn -ntp -B deploy -DskipTests -Dgpg.keyname=${GPG_KEY_NAME} -Dgpg.passphrase=${GPG_PASSPHRASE} diff --git a/.gitignore b/.gitignore index 6f4c9fc7f7..d424b2597a 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ nbproject .DS_Store target test-output -/META-INF/MANIFEST.MF +MANIFEST.MF work atlassian-ide-plugin.xml +/bom/.flattened-pom.xml diff --git a/.mvn/jvm.config b/.mvn/jvm.config new file mode 100644 index 0000000000..32599cefea --- /dev/null +++ b/.mvn/jvm.config @@ -0,0 +1,10 @@ +--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED +--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED +--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED +--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000000..c1dd12f176 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000000..4a95a1367b --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000000..d548766a4e --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,29 @@ +## From 2.2 to 2.3 + +* New `isFilterInsecureCipherSuites` config to disable unsecure and weak ciphers filtering performed internally in Netty. + +## From 2.1 to 2.2 + +* New [Typesafe config](https://github.com/lightbend/config) extra module +* new `enableWebSocketCompression` config to enable per-message and per-frame WebSocket compression extension + +## From 2.0 to 2.1 + +* AHC 2.1 targets Netty 4.1. +* `org.asynchttpclient.HttpResponseHeaders` was [dropped](https://github.com/AsyncHttpClient/async-http-client/commit/f4786f3ac7699f8f8664e7c7db0b7097585a0786) in favor + of `io.netty.handler.codec.http.HttpHeaders`. +* `org.asynchttpclient.cookie.Cookie` was [dropped](https://github.com/AsyncHttpClient/async-http-client/commit/a6d659ea0cc11fa5131304d8a04a7ba89c7a66af) in favor + of `io.netty.handler.codec.http.cookie.Cookie` as AHC's cookie parsers were contributed to Netty. +* AHC now has a RFC6265 `CookieStore` that is enabled by default. Implementation can be changed in `AsyncHttpClientConfig`. +* `AsyncHttpClient` now exposes stats with `getClientStats`. +* `AsyncHandlerExtensions` was [dropped](https://github.com/AsyncHttpClient/async-http-client/commit/1972c9b9984d6d9f9faca6edd4f2159013205aea) in favor of default methods + in `AsyncHandler`. +* `WebSocket` and `WebSocketListener` methods were renamed to mention frames +* `AsyncHttpClientConfig` various changes: + * new `getCookieStore` now lets you configure a CookieStore (enabled by default) + * new `isAggregateWebSocketFrameFragments` now lets you disable WebSocket fragmented frames aggregation + * new `isUseLaxCookieEncoder` lets you loosen cookie chars validation + * `isAcceptAnyCertificate` was dropped, as it didn't do what its name stated + * new `isUseInsecureTrustManager` lets you use a permissive TrustManager, that would typically let you accept self-signed certificates + * new `isDisableHttpsEndpointIdentificationAlgorithm` disables setting `HTTPS` algorithm on the SSLEngines, typically disables SNI and HTTPS hostname verification + * new `isAggregateWebSocketFrameFragments` lets you disable fragmented WebSocket frames aggregation diff --git a/LICENSE-2.0.txt b/LICENSE-2.0.txt deleted file mode 100644 index d645695673..0000000000 --- a/LICENSE-2.0.txt +++ /dev/null @@ -1,202 +0,0 @@ - - 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 - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000..85a16d3d06 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,13 @@ + Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSES/LICENSE.zstd-jni.txt b/LICENSES/LICENSE.zstd-jni.txt new file mode 100644 index 0000000000..66abb8ae78 --- /dev/null +++ b/LICENSES/LICENSE.zstd-jni.txt @@ -0,0 +1,26 @@ +Zstd-jni: JNI bindings to Zstd Library + +Copyright (c) 2015-present, Luben Karavelov/ All rights reserved. + +BSD License + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this + list of conditions and the following disclaimer in the documentation and/or + other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 9231cfa00d..0272134ed1 100644 --- a/README.md +++ b/README.md @@ -1,155 +1,263 @@ -Async Http Client ------------------ +# Async Http Client +[![Build](https://github.com/AsyncHttpClient/async-http-client/actions/workflows/builds.yml/badge.svg)](https://github.com/AsyncHttpClient/async-http-client/actions/workflows/builds.yml) +![Maven Central](https://img.shields.io/maven-central/v/org.asynchttpclient/async-http-client) -Getting started [PDF](http://is.gd/kexrN) [HTML](http://is.gd/ja6My) +Follow [@AsyncHttpClient](https://twitter.com/AsyncHttpClient) on Twitter. -Async Http Client library purpose is to allow Java applications to easily execute HTTP requests and asynchronously process the HTTP responses. The library also supports the WebSocket Protocol. The Async HTTP Client library is simple to use. First, in order to add it to your Maven project, simply add this dependency: +The AsyncHttpClient (AHC) library allows Java applications to easily execute HTTP requests and asynchronously process HTTP responses. +The library also supports the WebSocket Protocol. - - com.ning - async-http-client - 1.7.0 - +It's built on top of [Netty](https://github.com/netty/netty). It's compiled with Java 11. -You can also download the artifact +## Installation -[Maven Search](http://search.maven.org) +Binaries are deployed on Maven Central. +Add a dependency on the main AsyncHttpClient artifact: -Then in your code you can simply do ([Javadoc](http://sonatype.github.com/async-http-client/apidocs/index.html)) +Maven: +```xml + + + org.asynchttpclient + async-http-client + 3.0.2 + + +``` - import com.ning.http.client.*; - import java.util.concurrent.Future; +Gradle: +```groovy +dependencies { + implementation 'org.asynchttpclient:async-http-client:3.0.2' +} +``` - AsyncHttpClient asyncHttpClient = new AsyncHttpClient(); - Future f = asyncHttpClient.prepareGet("http://www.ning.com/").execute(); - Response r = f.get(); +### Dsl -You can also accomplish asynchronous operation without using a Future if you want to receive and process the response in your handler: +Import the Dsl helpers to use convenient methods to bootstrap components: - import com.ning.http.client.*; - import java.util.concurrent.Future; +```java +import static org.asynchttpclient.Dsl.*; +``` - AsyncHttpClient asyncHttpClient = new AsyncHttpClient(); - asyncHttpClient.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler(){ - - @Override - public Response onCompleted(Response response) throws Exception{ - // Do something with the Response - // ... - return response; - } - - @Override - public void onThrowable(Throwable t){ - // Something wrong happened. - } - }); +### Client + +```java +import static org.asynchttpclient.Dsl.*; + +AsyncHttpClient asyncHttpClient=asyncHttpClient(); +``` + +AsyncHttpClient instances must be closed (call the `close` method) once you're done with them, typically when shutting down your application. +If you don't, you'll experience threads hanging and resource leaks. + +AsyncHttpClient instances are intended to be global resources that share the same lifecycle as the application. +Typically, AHC will usually underperform if you create a new client for each request, as it will create new threads and connection pools for each. +It's possible to create shared resources (EventLoop and Timer) beforehand and pass them to multiple client instances in the config. You'll then be responsible for closing +those shared resources. + +## Configuration + +Finally, you can also configure the AsyncHttpClient instance via its AsyncHttpClientConfig object: + +```java +import static org.asynchttpclient.Dsl.*; + +AsyncHttpClient c=asyncHttpClient(config().setProxyServer(proxyServer("127.0.0.1",38080))); +``` + +## HTTP + +### Sending Requests + +### Basics + +AHC provides 2 APIs for defining requests: bound and unbound. +`AsyncHttpClient` and Dsl` provide methods for standard HTTP methods (POST, PUT, etc) but you can also pass a custom one. + +```java +import org.asynchttpclient.*; + +// bound +Future whenResponse=asyncHttpClient.prepareGet("http://www.example.com/").execute(); + +// unbound + Request request=get("http://www.example.com/").build(); + Future whenResponse=asyncHttpClient.executeRequest(request); +``` + +#### Setting Request Body + +Use the `setBody` method to add a body to the request. + +This body can be of type: + +* `java.io.File` +* `byte[]` +* `List` +* `String` +* `java.nio.ByteBuffer` +* `java.io.InputStream` +* `Publisher` +* `org.asynchttpclient.request.body.generator.BodyGenerator` + +`BodyGenerator` is a generic abstraction that let you create request bodies on the fly. +Have a look at `FeedableBodyGenerator` if you're looking for a way to pass requests chunks on the fly. -You can also mix Future with AsyncHandler to only retrieve part of the asynchronous response +#### Multipart - import com.ning.http.client.*; - import java.util.concurrent.Future; +Use the `addBodyPart` method to add a multipart part to the request. - AsyncHttpClient asyncHttpClient = new AsyncHttpClient(); - Future f = asyncHttpClient.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler(){ +This part can be of type: + +* `ByteArrayPart` +* `FilePart` +* `InputStreamPart` +* `StringPart` + +### Dealing with Responses + +#### Blocking on the Future + +`execute` methods return a `java.util.concurrent.Future`. You can simply block the calling thread to get the response. + +```java +Future whenResponse=asyncHttpClient.prepareGet("http://www.example.com/").execute(); + Response response=whenResponse.get(); +``` + +This is useful for debugging but you'll most likely hurt performance or create bugs when running such code on production. +The point of using a non blocking client is to *NOT BLOCK* the calling thread! + +### Setting callbacks on the ListenableFuture + +`execute` methods actually return a `org.asynchttpclient.ListenableFuture` similar to Guava's. +You can configure listeners to be notified of the Future's completion. + +```java + ListenableFuture whenResponse = ???; + Runnable callback = () - > { + try { + Response response = whenResponse.get(); + System.out.println(response); + } catch (InterruptedException | ExecutionException e) { + e.printStackTrace(); + } + }; + + java.util.concurrent.Executor executor = ???; + whenResponse.addListener(() - > ??? , executor); +``` + +If the `executor` parameter is null, callback will be executed in the IO thread. +You *MUST NEVER PERFORM BLOCKING* operations in there, typically sending another request and block on a future. + +#### Using custom AsyncHandlers + +`execute` methods can take an `org.asynchttpclient.AsyncHandler` to be notified on the different events, such as receiving the status, the headers and body chunks. +When you don't specify one, AHC will use a `org.asynchttpclient.AsyncCompletionHandler`; + +`AsyncHandler` methods can let you abort processing early (return `AsyncHandler.State.ABORT`) and can let you return a computation result from `onCompleted` that will be used +as the Future's result. +See `AsyncCompletionHandler` implementation as an example. + +The below sample just capture the response status and skips processing the response body chunks. + +Note that returning `ABORT` closes the underlying connection. + +```java +import static org.asynchttpclient.Dsl.*; + +import org.asynchttpclient.*; +import io.netty.handler.codec.http.HttpHeaders; + +Future whenStatusCode = asyncHttpClient.prepareGet("http://www.example.com/") + .execute(new AsyncHandler () { + private Integer status; + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) throws Exception { + status = responseStatus.getStatusCode(); + return State.ABORT; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) throws Exception { + return State.ABORT; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { + return State.ABORT; + } - @Override - public Integer onCompleted(Response response) throws Exception{ - // Do something with the Response - return response.getStatusCode(); - } + @Override + public Integer onCompleted() throws Exception{ + return status; + } - @Override - public void onThrowable(Throwable t){ - // Something wrong happened. - } - }); - - int statuѕCode = f.get(); - - You have full control on the Response life cycle, so you can decide at any moment to stop processing what the server is sending back: - - import com.ning.http.client.*; - import java.util.concurrent.Future; - - AsyncHttpClient c = new AsyncHttpClient(); - Future f = c.prepareGet("http://www.ning.com/").execute(new AsyncHandler() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onStatusReceived(HttpResponseStatus status) throws Exception { - int statusCode = status.getStatusCode(); - // The Status have been read - // If you don't want to read the headers,body or stop processing the response - return STATE.ABORT; - } - - @Override - public STATE onHeadersReceived(HttpResponseHeaders h) throws Exception { - Headers headers = h.getHeaders(); - // The headers have been read - // If you don't want to read the body, or stop processing the response - return STATE.ABORT; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - builder.append(new String(bodyPart.getBodyPartBytes())); - return STATE.CONTINUE - } - - @Override - public String onCompleted() throws Exception { - // Will be invoked once the response has been fully read or a ResponseComplete exception - // has been thrown. - return builder.toString(); - } - - @Override - public void onThrowable(Throwable t) { - } - }); - - String bodyResponse = f.get(); - -Finally, you can also configure the AsyncHttpClient via it's AsyncHttpClientConfig object: - - AsyncHttpClientConfig cf = new AsyncHttpClientConfig.Builder() - .setProxyServer(new ProxyServer("127.0.0.1", 38080)).build(); - AsyncHttpClient c = new AsyncHttpClient(cf); - -Async Http Client also support WebSocket by simply doing: - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - } - - @Override - public void onOpen(WebSocket websocket) { - websocket.sendTextMessage("...").sendBinaryMessage("..."); - } - - @Override - public void onClose(.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - } + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(); + } + }); + + Integer statusCode = whenStatusCode.get(); +``` + +#### Using Continuations + +`ListenableFuture` has a `toCompletableFuture` method that returns a `CompletableFuture`. +Beware that canceling this `CompletableFuture` won't properly cancel the ongoing request. +There's a very good chance we'll return a `CompletionStage` instead in the next release. + +```java +CompletableFuture whenResponse=asyncHttpClient + .prepareGet("http://www.example.com/") + .execute() + .toCompletableFuture() + .exceptionally(t->{ /* Something wrong happened... */ }) + .thenApply(response->{ /* Do something with the Response */ return resp;}); + whenResponse.join(); // wait for completion +``` + +You may get the complete maven project for this simple demo +from [org.asynchttpclient.example](https://github.com/AsyncHttpClient/async-http-client/tree/master/example/src/main/java/org/asynchttpclient/example) + +## WebSocket + +Async Http Client also supports WebSocket. +You need to pass a `WebSocketUpgradeHandler` where you would register a `WebSocketListener`. + +```java +WebSocket websocket = c.prepareGet("ws://demos.kaazing.com/echo") + .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener( + new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + websocket.sendTextFrame("...").sendTextFrame("..."); + } + + @Override + public void onClose(WebSocket websocket) { + // ... + } + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + System.out.println(payload); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + } }).build()).get(); +``` -The library uses Java non blocking I/O for supporting asynchronous operations. The default asynchronous provider is build on top of [Netty](http://www.jboss.org/netty), but the library exposes a configurable provider SPI which allows to easily plug in other frameworks like [Grizzly](http://grizzly.java.net) - - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient client = new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); +## User Group Keep up to date on the library development by joining the Asynchronous HTTP Client discussion group -[Google Group](http://groups.google.com/group/asynchttpclient) - -or follow us on [Twitter](http://twitter.com/jfarcand) - +[GitHub Discussions](https://github.com/AsyncHttpClient/async-http-client/discussions) diff --git a/client/pom.xml b/client/pom.xml new file mode 100644 index 0000000000..733f20b517 --- /dev/null +++ b/client/pom.xml @@ -0,0 +1,192 @@ + + + + + org.asynchttpclient + async-http-client-project + 3.0.2 + + + 4.0.0 + async-http-client + AHC/Client + The Async Http Client (AHC) classes. + + + org.asynchttpclient.client + + 11.0.24 + 10.1.40 + 2.18.0 + 4.11.0 + 3.0 + 2.1.0 + + + + + hyperxpro + Aayush Atharva + aayush@shieldblaze.com + + + + + + + commons-fileupload + commons-fileupload + 1.5 + test + + + + + javax.portlet + portlet-api + 3.0.1 + test + + + + org.apache.kerby + kerb-simplekdc + ${kerby.version} + test + + + org.jboss.xnio + xnio-api + + + + + + ch.qos.logback + logback-classic + ${logback.version} + test + + + + + org.junit.jupiter + junit-jupiter-api + test + + + + + org.junit.jupiter + junit-jupiter-engine + test + + + + + org.junit.jupiter + junit-jupiter-params + test + + + + io.github.nettyplus + netty-leak-detector-junit-extension + test + + + + org.eclipse.jetty + jetty-servlet + ${jetty.version} + test + + + + org.eclipse.jetty + jetty-servlets + ${jetty.version} + test + + + + org.eclipse.jetty + jetty-security + ${jetty.version} + test + + + + org.eclipse.jetty + jetty-proxy + ${jetty.version} + test + + + + + org.eclipse.jetty.websocket + websocket-jetty-server + ${jetty.version} + test + + + + org.eclipse.jetty.websocket + websocket-servlet + ${jetty.version} + test + + + + org.apache.tomcat.embed + tomcat-embed-core + ${tomcat.version} + test + + + + commons-io + commons-io + ${commons-io.version} + test + + + + org.mockito + mockito-core + ${mockito.version} + test + + + + org.hamcrest + hamcrest + ${hamcrest.version} + test + + + + + io.github.artsok + rerunner-jupiter + 2.1.6 + test + + + diff --git a/client/src/main/java/org/asynchttpclient/AsyncCompletionHandler.java b/client/src/main/java/org/asynchttpclient/AsyncCompletionHandler.java new file mode 100644 index 0000000000..63335cb29a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/AsyncCompletionHandler.java @@ -0,0 +1,126 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.handler.ProgressAsyncHandler; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.InputStream; +import java.util.concurrent.Future; + +/** + * An {@link AsyncHandler} augmented with an {@link #onCompleted(Response)} + * convenience method which gets called when the {@link Response} processing is + * finished. This class also implements the {@link ProgressAsyncHandler} + * callback, all doing nothing except returning + * {@link AsyncHandler.State#CONTINUE} + * + * @param Type of the value that will be returned by the associated + * {@link Future} + */ +public abstract class AsyncCompletionHandler implements ProgressAsyncHandler { + + private static final Logger LOGGER = LoggerFactory.getLogger(AsyncCompletionHandler.class); + private final Response.ResponseBuilder builder = new Response.ResponseBuilder(); + + @Override + public State onStatusReceived(HttpResponseStatus status) throws Exception { + builder.reset(); + builder.accumulate(status); + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) throws Exception { + builder.accumulate(headers); + return State.CONTINUE; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) throws Exception { + builder.accumulate(content); + return State.CONTINUE; + } + + @Override + public State onTrailingHeadersReceived(HttpHeaders headers) throws Exception { + builder.accumulate(headers); + return State.CONTINUE; + } + + @Override + public final @Nullable T onCompleted() throws Exception { + return onCompleted(builder.build()); + } + + @Override + public void onThrowable(Throwable t) { + LOGGER.debug(t.getMessage(), t); + } + + /** + * Invoked once the HTTP response processing is finished. + * + * @param response The {@link Response} + * @return T Value that will be returned by the associated + * {@link Future} + * @throws Exception if something wrong happens + */ + public abstract @Nullable T onCompleted(@Nullable Response response) throws Exception; + + /** + * Invoked when the HTTP headers have been fully written on the I/O socket. + * + * @return a {@link AsyncHandler.State} telling to CONTINUE + * or ABORT the current processing. + */ + @Override + public State onHeadersWritten() { + return State.CONTINUE; + } + + /** + * Invoked when the content (a {@link File}, {@link String}) or + * {@link InputStream} has been fully written on the I/O socket. + * + * @return a {@link AsyncHandler.State} telling to CONTINUE + * or ABORT the current processing. + */ + @Override + public State onContentWritten() { + return State.CONTINUE; + } + + /** + * Invoked when the I/O operation associated with the {@link Request} body as + * been progressed. + * + * @param amount The amount of bytes to transfer + * @param current The amount of bytes transferred + * @param total The total number of bytes transferred + * @return a {@link AsyncHandler.State} telling to CONTINUE + * or ABORT the current processing. + */ + @Override + public State onContentWriteProgress(long amount, long current, long total) { + return State.CONTINUE; + } +} diff --git a/src/main/java/com/ning/http/client/AsyncCompletionHandlerBase.java b/client/src/main/java/org/asynchttpclient/AsyncCompletionHandlerBase.java similarity index 59% rename from src/main/java/com/ning/http/client/AsyncCompletionHandlerBase.java rename to client/src/main/java/org/asynchttpclient/AsyncCompletionHandlerBase.java index 434d086e70..25fc9da185 100644 --- a/src/main/java/com/ning/http/client/AsyncCompletionHandlerBase.java +++ b/client/src/main/java/org/asynchttpclient/AsyncCompletionHandlerBase.java @@ -1,7 +1,7 @@ /* * Copyright 2010 Ning, Inc. * - * Ning licenses this file to you under the Apache License, version 2.0 + * This program is licensed to you under the Apache License, version 2.0 * (the "License"); you may not use this file except in compliance with the * License. You may obtain a copy of the License at: * @@ -14,30 +14,18 @@ * under the License. * */ -package com.ning.http.client; +package org.asynchttpclient; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; + +import org.jetbrains.annotations.Nullable; /** * Simple {@link AsyncHandler} of type {@link Response} */ public class AsyncCompletionHandlerBase extends AsyncCompletionHandler { - private final Logger log = LoggerFactory.getLogger(AsyncCompletionHandlerBase.class); - /** - * {@inheritDoc} - */ @Override - public Response onCompleted(Response response) throws Exception { + public @Nullable Response onCompleted(@Nullable Response response) throws Exception { return response; } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void onThrowable(Throwable t) { - log.debug(t.getMessage(), t); - } } diff --git a/client/src/main/java/org/asynchttpclient/AsyncHandler.java b/client/src/main/java/org/asynchttpclient/AsyncHandler.java new file mode 100644 index 0000000000..22451fe097 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/AsyncHandler.java @@ -0,0 +1,256 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.netty.request.NettyRequest; +import org.jetbrains.annotations.Nullable; + +import javax.net.ssl.SSLSession; +import java.net.InetSocketAddress; +import java.util.List; +import java.util.concurrent.Future; + + +/** + * An asynchronous handler or callback which gets invoked as soon as some data is available when + * processing an asynchronous response. + *
+ * Callback methods get invoked in the following order: + *
    + *
  1. {@link #onStatusReceived(HttpResponseStatus)},
  2. + *
  3. {@link #onHeadersReceived(HttpHeaders)},
  4. + *
  5. {@link #onBodyPartReceived(HttpResponseBodyPart)}, which could be invoked multiple times,
  6. + *
  7. {@link #onTrailingHeadersReceived(HttpHeaders)}, which is only invoked if trailing HTTP headers are received
  8. + *
  9. {@link #onCompleted()}, once the response has been fully read.
  10. + *
+ *
+ * Returning a {@link AsyncHandler.State#ABORT} from any of those callback methods will interrupt asynchronous response + * processing. After that, only {@link #onCompleted()} is going to be called. + *
+ * AsyncHandlers aren't thread safe. Hence, you should avoid re-using the same instance when doing concurrent requests. + * As an example, the following may produce unexpected results: + *
+ *   AsyncHandler ah = new AsyncHandler() {....};
+ *   AsyncHttpClient client = new AsyncHttpClient();
+ *   client.prepareGet("http://.../").execute(ah);
+ *   client.prepareGet("http://.../").execute(ah);
+ * 
+ * It is recommended to create a new instance instead. + *

+ * Do NOT perform any blocking operations in any of these methods. A typical example would be trying to send another + * request and calling get() on its future. + * There's a chance you might end up in a deadlock. + * If you really need to perform a blocking operation, execute it in a different dedicated thread pool. + * + * @param Type of object returned by the {@link Future#get} + */ +public interface AsyncHandler { + + /** + * Invoked as soon as the HTTP status line has been received + * + * @param responseStatus the status code and test of the response + * @return a {@link State} telling to CONTINUE or ABORT the current processing. + * @throws Exception if something wrong happens + */ + State onStatusReceived(HttpResponseStatus responseStatus) throws Exception; + + /** + * Invoked as soon as the HTTP headers have been received. + * + * @param headers the HTTP headers. + * @return a {@link State} telling to CONTINUE or ABORT the current processing. + * @throws Exception if something wrong happens + */ + State onHeadersReceived(HttpHeaders headers) throws Exception; + + /** + * Invoked as soon as some response body part are received. Could be invoked many times. + * Beware that, depending on the provider (Netty) this can be notified with empty body parts. + * + * @param bodyPart response's body part. + * @return a {@link State} telling to CONTINUE or ABORT the current processing. Aborting will also close the connection. + * @throws Exception if something wrong happens + */ + State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception; + + /** + * Invoked when trailing headers have been received. + * + * @param headers the trailing HTTP headers. + * @return a {@link State} telling to CONTINUE or ABORT the current processing. + * @throws Exception if something wrong happens + */ + default State onTrailingHeadersReceived(HttpHeaders headers) throws Exception { + return State.CONTINUE; + } + + /** + * Invoked when an unexpected exception occurs during the processing of the response. The exception may have been + * produced by implementation of onXXXReceived method invocation. + * + * @param t a {@link Throwable} + */ + void onThrowable(Throwable t); + + /** + * Invoked once the HTTP response processing is finished. + *
+ * Gets always invoked as last callback method. + * + * @return T Value that will be returned by the associated {@link Future} + * @throws Exception if something wrong happens + */ + @Nullable + T onCompleted() throws Exception; + + /** + * Notify the callback before hostname resolution + * + * @param name the name to be resolved + */ + default void onHostnameResolutionAttempt(String name) { + } + + // ////////// DNS ///////////////// + + /** + * Notify the callback after hostname resolution was successful. + * + * @param name the name to be resolved + * @param addresses the resolved addresses + */ + default void onHostnameResolutionSuccess(String name, List addresses) { + } + + /** + * Notify the callback after hostname resolution failed. + * + * @param name the name to be resolved + * @param cause the failure cause + */ + default void onHostnameResolutionFailure(String name, Throwable cause) { + } + + // ////////////// TCP CONNECT //////// + + /** + * Notify the callback when trying to open a new connection. + *

+ * Might be called several times if the name was resolved to multiple addresses, and we failed to connect to the first(s) one(s). + * + * @param remoteAddress the address we try to connect to + */ + default void onTcpConnectAttempt(InetSocketAddress remoteAddress) { + } + + /** + * Notify the callback after a successful connect + * + * @param remoteAddress the address we try to connect to + * @param connection the connection + */ + default void onTcpConnectSuccess(InetSocketAddress remoteAddress, Channel connection) { + } + + /** + * Notify the callback after a failed connect. + *

+ * Might be called several times, or be followed by onTcpConnectSuccess when the name was resolved to multiple addresses. + * + * @param remoteAddress the address we try to connect to + * @param cause the cause of the failure + */ + default void onTcpConnectFailure(InetSocketAddress remoteAddress, Throwable cause) { + } + + // ////////////// TLS /////////////// + + /** + * Notify the callback before TLS handshake + */ + default void onTlsHandshakeAttempt() { + } + + /** + * Notify the callback after the TLS was successful + */ + default void onTlsHandshakeSuccess(SSLSession sslSession) { + } + + /** + * Notify the callback after the TLS failed + * + * @param cause the cause of the failure + */ + default void onTlsHandshakeFailure(Throwable cause) { + } + + // /////////// POOLING ///////////// + + /** + * Notify the callback when trying to fetch a connection from the pool. + */ + default void onConnectionPoolAttempt() { + } + + /** + * Notify the callback when a new connection was successfully fetched from the pool. + * + * @param connection the connection + */ + default void onConnectionPooled(Channel connection) { + } + + /** + * Notify the callback when trying to offer a connection to the pool. + * + * @param connection the connection + */ + default void onConnectionOffer(Channel connection) { + } + + // //////////// SENDING ////////////// + + /** + * Notify the callback when a request is being written on the channel. If the original request causes multiple requests to be sent, for example, because of authorization or + * retry, it will be notified multiple times. + * + * @param request the real request object as passed to the provider + */ + default void onRequestSend(NettyRequest request) { + } + + /** + * Notify the callback every time a request is being retried. + */ + default void onRetry() { + } + + enum State { + + /** + * Stop the processing. + */ + ABORT, + /** + * Continue the processing + */ + CONTINUE + } +} diff --git a/client/src/main/java/org/asynchttpclient/AsyncHttpClient.java b/client/src/main/java/org/asynchttpclient/AsyncHttpClient.java new file mode 100755 index 0000000000..01a3ecf734 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/AsyncHttpClient.java @@ -0,0 +1,302 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import java.io.Closeable; +import java.util.concurrent.Future; +import java.util.function.Predicate; + +/** + * This class support asynchronous and synchronous HTTP requests. + *
+ * To execute a synchronous HTTP request, you just need to do + *

+ *    AsyncHttpClient c = new AsyncHttpClient();
+ *    Future<Response> f = c.prepareGet(TARGET_URL).execute();
+ * 
+ *
+ * The code above will block until the response is fully received. To execute an asynchronous HTTP request, you + * create an {@link AsyncHandler} or its abstract implementation, {@link AsyncCompletionHandler} + *
+ *
+ *       AsyncHttpClient c = new AsyncHttpClient();
+ *       Future<Response> f = c.prepareGet(TARGET_URL).execute(new AsyncCompletionHandler<Response>() {
+ *
+ *          @Override
+ *          public Response onCompleted(Response response) throws IOException {
+ *               // Do something
+ *              return response;
+ *          }
+ *
+ *          @Override
+ *          public void onThrowable(Throwable t) {
+ *          }
+ *      });
+ *      Response response = f.get();
+ *
+ *      // We are just interested in retrieving the status code.
+ *     Future<Integer> f = c.prepareGet(TARGET_URL).execute(new AsyncCompletionHandler<Integer>() {
+ *
+ *          @Override
+ *          public Integer onCompleted(Response response) throws IOException {
+ *               // Do something
+ *              return response.getStatusCode();
+ *          }
+ *
+ *          @Override
+ *          public void onThrowable(Throwable t) {
+ *          }
+ *      });
+ *      Integer statusCode = f.get();
+ * 
+ * The {@link AsyncCompletionHandler#onCompleted(Response)} method will be invoked once the http response has been fully read. + * The {@link Response} object includes the http headers and the response body. Note that the entire response will be buffered in memory. + *
+ * You can also have more control about how the response is asynchronously processed by using an {@link AsyncHandler} + *
+ *      AsyncHttpClient c = new AsyncHttpClient();
+ *      Future<String> f = c.prepareGet(TARGET_URL).execute(new AsyncHandler<String>() {
+ *          private StringBuilder builder = new StringBuilder();
+ *
+ *          @Override
+ *          public STATE onStatusReceived(HttpResponseStatus s) throws Exception {
+ *               // return STATE.CONTINUE or STATE.ABORT
+ *               return STATE.CONTINUE
+ *          }
+ *
+ *          @Override
+ *          public STATE onHeadersReceived(HttpResponseHeaders bodyPart) throws Exception {
+ *               // return STATE.CONTINUE or STATE.ABORT
+ *               return STATE.CONTINUE
+ *
+ *          }
+ *          @Override
+ *
+ *          public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception {
+ *               builder.append(new String(bodyPart));
+ *               // return STATE.CONTINUE or STATE.ABORT
+ *               return STATE.CONTINUE
+ *          }
+ *
+ *          @Override
+ *          public String onCompleted() throws Exception {
+ *               // Will be invoked once the response has been fully read or a ResponseComplete exception
+ *               // has been thrown.
+ *               return builder.toString();
+ *          }
+ *
+ *          @Override
+ *          public void onThrowable(Throwable t) {
+ *          }
+ *      });
+ *
+ *      String bodyResponse = f.get();
+ * 
+ * You can asynchronously process the response status, headers and body and decide when to + * stop processing the response by returning a new {@link AsyncHandler.State#ABORT} at any moment. + *

+ * This class can also be used without the need of {@link AsyncHandler}. + *
+ *

+ *      AsyncHttpClient c = new AsyncHttpClient();
+ *      Future<Response> f = c.prepareGet(TARGET_URL).execute();
+ *      Response r = f.get();
+ * 
+ *

+ * Finally, you can configure the AsyncHttpClient using an {@link DefaultAsyncHttpClientConfig} instance. + *
+ *

+ *      AsyncHttpClient c = new AsyncHttpClient(new DefaultAsyncHttpClientConfig.Builder().setRequestTimeout(...).build());
+ *      Future<Response> f = c.prepareGet(TARGET_URL).execute();
+ *      Response r = f.get();
+ * 
+ *
+ * An instance of this class will cache every HTTP 1.1 connection and close them when the {@link DefaultAsyncHttpClientConfig#getReadTimeout()} + * expires. This object can hold many persistent connections to different hosts. + */ +public interface AsyncHttpClient extends Closeable { + + /** + * Return true if closed + * + * @return true if closed + */ + boolean isClosed(); + + /** + * Set default signature calculator to use for requests built by this client instance + * + * @param signatureCalculator a signature calculator + * @return {@link RequestBuilder} + */ + AsyncHttpClient setSignatureCalculator(SignatureCalculator signatureCalculator); + + /** + * Prepare an HTTP client request. + * + * @param method HTTP request method type. MUST BE in upper case + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepare(String method, String url); + + + /** + * Prepare an HTTP client GET request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareGet(String url); + + /** + * Prepare an HTTP client CONNECT request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareConnect(String url); + + /** + * Prepare an HTTP client OPTIONS request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareOptions(String url); + + /** + * Prepare an HTTP client HEAD request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareHead(String url); + + /** + * Prepare an HTTP client POST request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder preparePost(String url); + + /** + * Prepare an HTTP client PUT request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder preparePut(String url); + + /** + * Prepare an HTTP client DELETE request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareDelete(String url); + + /** + * Prepare an HTTP client PATCH request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder preparePatch(String url); + + /** + * Prepare an HTTP client TRACE request. + * + * @param url A well-formed URL. + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareTrace(String url); + + /** + * Construct a {@link RequestBuilder} using a {@link Request} + * + * @param request a {@link Request} + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareRequest(Request request); + + /** + * Construct a {@link RequestBuilder} using a {@link RequestBuilder} + * + * @param requestBuilder a {@link RequestBuilder} + * @return {@link RequestBuilder} + */ + BoundRequestBuilder prepareRequest(RequestBuilder requestBuilder); + + /** + * Execute an HTTP request. + * + * @param request {@link Request} + * @param handler an instance of {@link AsyncHandler} + * @param Type of the value that will be returned by the associated {@link Future} + * @return a {@link Future} of type T + */ + ListenableFuture executeRequest(Request request, AsyncHandler handler); + + /** + * Execute an HTTP request. + * + * @param requestBuilder {@link RequestBuilder} + * @param handler an instance of {@link AsyncHandler} + * @param Type of the value that will be returned by the associated {@link Future} + * @return a {@link Future} of type T + */ + ListenableFuture executeRequest(RequestBuilder requestBuilder, AsyncHandler handler); + + /** + * Execute an HTTP request. + * + * @param request {@link Request} + * @return a {@link Future} of type Response + */ + ListenableFuture executeRequest(Request request); + + /** + * Execute an HTTP request. + * + * @param requestBuilder {@link RequestBuilder} + * @return a {@link Future} of type Response + */ + ListenableFuture executeRequest(RequestBuilder requestBuilder); + + /*** + * Return details about pooled connections. + * + * @return a {@link ClientStats} + */ + ClientStats getClientStats(); + + /** + * Flush ChannelPool partitions based on a predicate + * + * @param predicate the predicate + */ + void flushChannelPoolPartitions(Predicate predicate); + + /** + * Return the config associated to this client. + * + * @return the config associated to this client. + */ + AsyncHttpClientConfig getConfig(); +} diff --git a/client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java b/client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java new file mode 100644 index 0000000000..954628b3d4 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java @@ -0,0 +1,403 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.Channel; +import io.netty.channel.ChannelOption; +import io.netty.channel.EventLoopGroup; +import io.netty.handler.ssl.SslContext; +import io.netty.util.HashedWheelTimer; +import io.netty.util.Timer; +import org.asynchttpclient.channel.ChannelPool; +import org.asynchttpclient.channel.KeepAliveStrategy; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.filter.IOExceptionFilter; +import org.asynchttpclient.filter.RequestFilter; +import org.asynchttpclient.filter.ResponseFilter; +import org.asynchttpclient.netty.EagerResponseBodyPart; +import org.asynchttpclient.netty.LazyResponseBodyPart; +import org.asynchttpclient.netty.channel.ConnectionSemaphoreFactory; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.proxy.ProxyServerSelector; +import org.jetbrains.annotations.Nullable; + +import java.io.IOException; +import java.time.Duration; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ThreadFactory; +import java.util.function.Consumer; + +public interface AsyncHttpClientConfig { + + /** + * @return the version of AHC + */ + String getAhcVersion(); + + /** + * Return the name of {@link AsyncHttpClient}, which is used for thread naming and debugging. + * + * @return the name. + */ + String getThreadPoolName(); + + /** + * Return the maximum number of connections an {@link AsyncHttpClient} can handle. + * + * @return the maximum number of connections an {@link AsyncHttpClient} can handle. + */ + int getMaxConnections(); + + /** + * Return the maximum number of connections per hosts an {@link AsyncHttpClient} can handle. + * + * @return the maximum number of connections per host an {@link AsyncHttpClient} can handle. + */ + int getMaxConnectionsPerHost(); + + /** + * Return the maximum duration in milliseconds an {@link AsyncHttpClient} can wait to acquire a free channel + * + * @return Return the maximum duration in milliseconds an {@link AsyncHttpClient} can wait to acquire a free channel + */ + int getAcquireFreeChannelTimeout(); + + + /** + * Return the maximum time an {@link AsyncHttpClient} can wait when connecting to a remote host + * + * @return the maximum time an {@link AsyncHttpClient} can wait when connecting to a remote host + */ + Duration getConnectTimeout(); + + /** + * Return the maximum time an {@link AsyncHttpClient} can stay idle. + * + * @return the maximum time an {@link AsyncHttpClient} can stay idle. + */ + Duration getReadTimeout(); + + /** + * Return the maximum time an {@link AsyncHttpClient} will keep connection in pool. + * + * @return the maximum time an {@link AsyncHttpClient} will keep connection in pool. + */ + Duration getPooledConnectionIdleTimeout(); + + /** + * @return the period to clean the pool of dead and idle connections. + */ + Duration getConnectionPoolCleanerPeriod(); + + /** + * Return the maximum time an {@link AsyncHttpClient} waits until the response is completed. + * + * @return the maximum time an {@link AsyncHttpClient} waits until the response is completed. + */ + Duration getRequestTimeout(); + + /** + * Is HTTP redirect enabled + * + * @return true if enabled. + */ + boolean isFollowRedirect(); + + /** + * Get the maximum number of HTTP redirect + * + * @return the maximum number of HTTP redirect + */ + int getMaxRedirects(); + + /** + * Is the {@link ChannelPool} support enabled. + * + * @return true if keep-alive is enabled + */ + boolean isKeepAlive(); + + /** + * Return the USER_AGENT header value + * + * @return the USER_AGENT header value + */ + String getUserAgent(); + + /** + * Is HTTP compression enforced. + * + * @return true if compression is enforced + */ + boolean isCompressionEnforced(); + + /** + * If automatic content decompression is enabled. + * + * @return true if content decompression is enabled + */ + boolean isEnableAutomaticDecompression(); + + /** + * Return the {@link ThreadFactory} an {@link AsyncHttpClient} use for handling asynchronous response. + * + * @return the {@link ThreadFactory} an {@link AsyncHttpClient} use for handling asynchronous response. If no {@link ThreadFactory} has been explicitly + * provided, this method will return {@code null} + */ + @Nullable + ThreadFactory getThreadFactory(); + + /** + * An instance of {@link ProxyServer} used by an {@link AsyncHttpClient} + * + * @return instance of {@link ProxyServer} + */ + ProxyServerSelector getProxyServerSelector(); + + /** + * Return an instance of {@link SslContext} used for SSL connection. + * + * @return an instance of {@link SslContext} used for SSL connection. + */ + @Nullable + SslContext getSslContext(); + + /** + * Return the current {@link Realm} + * + * @return the current {@link Realm} + */ + @Nullable + Realm getRealm(); + + /** + * Return the list of {@link RequestFilter} + * + * @return Unmodifiable list of {@link RequestFilter} + */ + List getRequestFilters(); + + /** + * Return the list of {@link ResponseFilter} + * + * @return Unmodifiable list of {@link ResponseFilter} + */ + List getResponseFilters(); + + /** + * Return the list of {@link IOException} + * + * @return Unmodifiable list of {@link IOException} + */ + List getIoExceptionFilters(); + + /** + * Return cookie store that is used to store and retrieve cookies + * + * @return {@link CookieStore} object + */ + CookieStore getCookieStore(); + + /** + * Return the delay in milliseconds to evict expired cookies from {@linkplain CookieStore} + * + * @return the delay in milliseconds to evict expired cookies from {@linkplain CookieStore} + */ + int expiredCookieEvictionDelay(); + + /** + * Return the number of time the library will retry when an {@link IOException} is throw by the remote server + * + * @return the number of time the library will retry when an {@link IOException} is throw by the remote server + */ + int getMaxRequestRetry(); + + /** + * @return the disableUrlEncodingForBoundRequests + */ + boolean isDisableUrlEncodingForBoundRequests(); + + /** + * @return true if AHC is to use a LAX cookie encoder, e.g. accept illegal chars in cookie value + */ + boolean isUseLaxCookieEncoder(); + + /** + * In the case of a POST/Redirect/Get scenario where the server uses a 302 for the redirect, should AHC respond to the redirect with a GET or whatever the original method was. + * Unless configured otherwise, for a 302, AHC, will use a GET for this case. + * + * @return {@code true} if strict 302 handling is to be used, otherwise {@code false}. + */ + boolean isStrict302Handling(); + + /** + * @return the maximum time an {@link AsyncHttpClient} will keep connection in the pool, or negative value to keep connection while possible. + */ + Duration getConnectionTtl(); + + boolean isUseOpenSsl(); + + boolean isUseInsecureTrustManager(); + + /** + * @return true to disable all HTTPS behaviors AT ONCE, such as hostname verification and SNI + */ + boolean isDisableHttpsEndpointIdentificationAlgorithm(); + + /** + * @return the array of enabled protocols + */ + @Nullable + String[] getEnabledProtocols(); + + /** + * @return the array of enabled cipher suites + */ + @Nullable + String[] getEnabledCipherSuites(); + + /** + * @return if insecure cipher suites must be filtered out (only used when not explicitly passing enabled cipher suites) + */ + boolean isFilterInsecureCipherSuites(); + + /** + * @return the size of the SSL session cache, 0 means using the default value + */ + int getSslSessionCacheSize(); + + /** + * @return the SSL session timeout in seconds, 0 means using the default value + */ + int getSslSessionTimeout(); + + int getHttpClientCodecMaxInitialLineLength(); + + int getHttpClientCodecMaxHeaderSize(); + + int getHttpClientCodecMaxChunkSize(); + + int getHttpClientCodecInitialBufferSize(); + + boolean isDisableZeroCopy(); + + int getHandshakeTimeout(); + + @Nullable + SslEngineFactory getSslEngineFactory(); + + int getChunkedFileChunkSize(); + + int getWebSocketMaxBufferSize(); + + int getWebSocketMaxFrameSize(); + + boolean isKeepEncodingHeader(); + + Duration getShutdownQuietPeriod(); + + Duration getShutdownTimeout(); + + Map, Object> getChannelOptions(); + + @Nullable + EventLoopGroup getEventLoopGroup(); + + boolean isUseNativeTransport(); + + boolean isUseOnlyEpollNativeTransport(); + + @Nullable + Consumer getHttpAdditionalChannelInitializer(); + + @Nullable + Consumer getWsAdditionalChannelInitializer(); + + ResponseBodyPartFactory getResponseBodyPartFactory(); + + @Nullable + ChannelPool getChannelPool(); + + @Nullable + ConnectionSemaphoreFactory getConnectionSemaphoreFactory(); + + @Nullable + Timer getNettyTimer(); + + /** + * @return the duration between tick of {@link HashedWheelTimer} + */ + long getHashedWheelTimerTickDuration(); + + /** + * @return the size of the hashed wheel {@link HashedWheelTimer} + */ + int getHashedWheelTimerSize(); + + KeepAliveStrategy getKeepAliveStrategy(); + + boolean isValidateResponseHeaders(); + + boolean isAggregateWebSocketFrameFragments(); + + boolean isEnableWebSocketCompression(); + + boolean isTcpNoDelay(); + + boolean isSoReuseAddress(); + + boolean isSoKeepAlive(); + + int getSoLinger(); + + int getSoSndBuf(); + + int getSoRcvBuf(); + + @Nullable + ByteBufAllocator getAllocator(); + + int getIoThreadsCount(); + + /** + * Indicates whether the Authorization header should be stripped during redirects to a different domain. + * + * @return true if the Authorization header should be stripped, false otherwise. + */ + boolean isStripAuthorizationOnRedirect(); + + enum ResponseBodyPartFactory { + + EAGER { + @Override + public HttpResponseBodyPart newResponseBodyPart(ByteBuf buf, boolean last) { + return new EagerResponseBodyPart(buf, last); + } + }, + + LAZY { + @Override + public HttpResponseBodyPart newResponseBodyPart(ByteBuf buf, boolean last) { + return new LazyResponseBodyPart(buf, last); + } + }; + + public abstract HttpResponseBodyPart newResponseBodyPart(ByteBuf buf, boolean last); + } +} diff --git a/client/src/main/java/org/asynchttpclient/AsyncHttpClientState.java b/client/src/main/java/org/asynchttpclient/AsyncHttpClientState.java new file mode 100644 index 0000000000..5916d69f0c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/AsyncHttpClientState.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import java.util.concurrent.atomic.AtomicBoolean; + +public class AsyncHttpClientState { + + private final AtomicBoolean closed; + + AsyncHttpClientState(AtomicBoolean closed) { + this.closed = closed; + } + + public boolean isClosed() { + return closed.get(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/BoundRequestBuilder.java b/client/src/main/java/org/asynchttpclient/BoundRequestBuilder.java new file mode 100644 index 0000000000..99b3cc5d06 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/BoundRequestBuilder.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +public class BoundRequestBuilder extends RequestBuilderBase { + + private final AsyncHttpClient client; + + public BoundRequestBuilder(AsyncHttpClient client, String method, boolean isDisableUrlEncoding, boolean validateHeaders) { + super(method, isDisableUrlEncoding, validateHeaders); + this.client = client; + } + + public BoundRequestBuilder(AsyncHttpClient client, String method, boolean isDisableUrlEncoding) { + super(method, isDisableUrlEncoding); + this.client = client; + } + + public BoundRequestBuilder(AsyncHttpClient client, Request prototype) { + super(prototype); + this.client = client; + } + + public ListenableFuture execute(AsyncHandler handler) { + return client.executeRequest(build(), handler); + } + + public ListenableFuture execute() { + return client.executeRequest(build(), new AsyncCompletionHandlerBase()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/ClientStats.java b/client/src/main/java/org/asynchttpclient/ClientStats.java new file mode 100644 index 0000000000..eef529221d --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ClientStats.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import java.util.Collections; +import java.util.Map; +import java.util.Objects; + +/** + * A record class representing the state of a (@link org.asynchttpclient.AsyncHttpClient). + */ +public class ClientStats { + + private final Map statsPerHost; + + public ClientStats(Map statsPerHost) { + this.statsPerHost = Collections.unmodifiableMap(statsPerHost); + } + + /** + * @return A map from hostname to statistics on that host's connections. + * The returned map is unmodifiable. + */ + public Map getStatsPerHost() { + return statsPerHost; + } + + /** + * @return The sum of {@link #getTotalActiveConnectionCount()} and {@link #getTotalIdleConnectionCount()}, + * a long representing the total number of connections in the connection pool. + */ + public long getTotalConnectionCount() { + return statsPerHost + .values() + .stream() + .mapToLong(HostStats::getHostConnectionCount) + .sum(); + } + + /** + * @return A long representing the number of active connections in the connection pool. + */ + public long getTotalActiveConnectionCount() { + return statsPerHost + .values() + .stream() + .mapToLong(HostStats::getHostActiveConnectionCount) + .sum(); + } + + /** + * @return A long representing the number of idle connections in the connection pool. + */ + public long getTotalIdleConnectionCount() { + return statsPerHost + .values() + .stream() + .mapToLong(HostStats::getHostIdleConnectionCount) + .sum(); + } + + @Override + public String toString() { + return "There are " + getTotalConnectionCount() + + " total connections, " + getTotalActiveConnectionCount() + + " are active and " + getTotalIdleConnectionCount() + " are idle."; + } + + @Override + public boolean equals(final Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + final ClientStats that = (ClientStats) o; + return Objects.equals(statsPerHost, that.statsPerHost); + } + + @Override + public int hashCode() { + return Objects.hashCode(statsPerHost); + } +} diff --git a/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClient.java b/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClient.java new file mode 100644 index 0000000000..3b417a5a39 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClient.java @@ -0,0 +1,344 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import io.netty.channel.EventLoopGroup; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.util.HashedWheelTimer; +import io.netty.util.Timer; +import io.netty.util.concurrent.DefaultThreadFactory; +import org.asynchttpclient.channel.ChannelPool; +import org.asynchttpclient.cookie.CookieEvictionTask; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.exception.FilterException; +import org.asynchttpclient.filter.FilterContext; +import org.asynchttpclient.filter.RequestFilter; +import org.asynchttpclient.handler.resumable.ResumableAsyncHandler; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.List; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.function.Predicate; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.HttpConstants.Methods.CONNECT; +import static org.asynchttpclient.util.HttpConstants.Methods.DELETE; +import static org.asynchttpclient.util.HttpConstants.Methods.GET; +import static org.asynchttpclient.util.HttpConstants.Methods.HEAD; +import static org.asynchttpclient.util.HttpConstants.Methods.OPTIONS; +import static org.asynchttpclient.util.HttpConstants.Methods.PATCH; +import static org.asynchttpclient.util.HttpConstants.Methods.POST; +import static org.asynchttpclient.util.HttpConstants.Methods.PUT; +import static org.asynchttpclient.util.HttpConstants.Methods.TRACE; + +/** + * Default and threadsafe implementation of {@link AsyncHttpClient}. + */ +public class DefaultAsyncHttpClient implements AsyncHttpClient { + + private static final Logger LOGGER = LoggerFactory.getLogger(DefaultAsyncHttpClient.class); + private final AsyncHttpClientConfig config; + private final boolean noRequestFilters; + private final AtomicBoolean closed = new AtomicBoolean(false); + private final ChannelManager channelManager; + private final NettyRequestSender requestSender; + private final boolean allowStopNettyTimer; + private final Timer nettyTimer; + + /** + * Default signature calculator to use for all requests constructed by this + * client instance. + */ + private @Nullable SignatureCalculator signatureCalculator; + + /** + * Create a new HTTP Asynchronous Client using the default + * {@link DefaultAsyncHttpClientConfig} configuration. The default + * {@link AsyncHttpClient} that will be used will be based on the classpath + * configuration. + *

+ * If none of those providers are found, then the engine will throw an + * IllegalStateException. + */ + public DefaultAsyncHttpClient() { + this(new DefaultAsyncHttpClientConfig.Builder().build()); + } + + /** + * Create a new HTTP Asynchronous Client using the specified + * {@link DefaultAsyncHttpClientConfig} configuration. This configuration + * will be passed to the default {@link AsyncHttpClient} that will be + * selected based on the classpath configuration. + * + * @param config a {@link DefaultAsyncHttpClientConfig} + */ + public DefaultAsyncHttpClient(AsyncHttpClientConfig config) { + + this.config = config; + noRequestFilters = config.getRequestFilters().isEmpty(); + final Timer configTimer = config.getNettyTimer(); + if (configTimer == null) { + allowStopNettyTimer = true; + nettyTimer = newNettyTimer(config); + } else { + allowStopNettyTimer = false; + nettyTimer = configTimer; + } + + channelManager = new ChannelManager(config, nettyTimer); + requestSender = new NettyRequestSender(config, channelManager, nettyTimer, new AsyncHttpClientState(closed)); + channelManager.configureBootstraps(requestSender); + + CookieStore cookieStore = config.getCookieStore(); + if (cookieStore != null) { + int cookieStoreCount = config.getCookieStore().incrementAndGet(); + if ( + allowStopNettyTimer // timer is not shared + || cookieStoreCount == 1 // this is the first AHC instance for the shared (user-provided) timer + ) { + nettyTimer.newTimeout(new CookieEvictionTask(config.expiredCookieEvictionDelay(), cookieStore), + config.expiredCookieEvictionDelay(), TimeUnit.MILLISECONDS); + } + } + } + + // Visible for testing + ChannelManager channelManager() { + return channelManager; + } + + private static Timer newNettyTimer(AsyncHttpClientConfig config) { + ThreadFactory threadFactory = config.getThreadFactory() != null ? config.getThreadFactory() : new DefaultThreadFactory(config.getThreadPoolName() + "-timer"); + HashedWheelTimer timer = new HashedWheelTimer(threadFactory, config.getHashedWheelTimerTickDuration(), TimeUnit.MILLISECONDS, config.getHashedWheelTimerSize()); + timer.start(); + return timer; + } + + @Override + public void close() { + if (closed.compareAndSet(false, true)) { + try { + channelManager.close(); + } catch (Throwable t) { + LOGGER.warn("Unexpected error on ChannelManager close", t); + } + CookieStore cookieStore = config.getCookieStore(); + if (cookieStore != null) { + cookieStore.decrementAndGet(); + } + if (allowStopNettyTimer) { + try { + nettyTimer.stop(); + } catch (Throwable t) { + LOGGER.warn("Unexpected error on HashedWheelTimer close", t); + } + } + } + } + + @Override + public boolean isClosed() { + return closed.get(); + } + + @Override + public DefaultAsyncHttpClient setSignatureCalculator(SignatureCalculator signatureCalculator) { + this.signatureCalculator = signatureCalculator; + return this; + } + + @Override + public BoundRequestBuilder prepare(String method, String url) { + return requestBuilder(method, url); + } + + @Override + public BoundRequestBuilder prepareGet(String url) { + return requestBuilder(GET, url); + } + + @Override + public BoundRequestBuilder prepareConnect(String url) { + return requestBuilder(CONNECT, url); + } + + @Override + public BoundRequestBuilder prepareOptions(String url) { + return requestBuilder(OPTIONS, url); + } + + @Override + public BoundRequestBuilder prepareHead(String url) { + return requestBuilder(HEAD, url); + } + + @Override + public BoundRequestBuilder preparePost(String url) { + return requestBuilder(POST, url); + } + + @Override + public BoundRequestBuilder preparePut(String url) { + return requestBuilder(PUT, url); + } + + @Override + public BoundRequestBuilder prepareDelete(String url) { + return requestBuilder(DELETE, url); + } + + @Override + public BoundRequestBuilder preparePatch(String url) { + return requestBuilder(PATCH, url); + } + + @Override + public BoundRequestBuilder prepareTrace(String url) { + return requestBuilder(TRACE, url); + } + + @Override + public BoundRequestBuilder prepareRequest(Request request) { + return requestBuilder(request); + } + + @Override + public BoundRequestBuilder prepareRequest(RequestBuilder requestBuilder) { + return prepareRequest(requestBuilder.build()); + } + + @Override + public ListenableFuture executeRequest(Request request, AsyncHandler handler) { + if (config.getCookieStore() != null) { + try { + List cookies = config.getCookieStore().get(request.getUri()); + if (!cookies.isEmpty()) { + RequestBuilder requestBuilder = request.toBuilder(); + for (Cookie cookie : cookies) { + requestBuilder.addCookieIfUnset(cookie); + } + request = requestBuilder.build(); + } + } catch (Exception e) { + handler.onThrowable(e); + return new ListenableFuture.CompletedFailure<>("Failed to set cookies of request", e); + } + } + + if (noRequestFilters) { + return execute(request, handler); + } else { + FilterContext fc = new FilterContext.FilterContextBuilder<>(handler, request).build(); + try { + fc = preProcessRequest(fc); + } catch (Exception e) { + handler.onThrowable(e); + return new ListenableFuture.CompletedFailure<>("preProcessRequest failed", e); + } + + return execute(fc.getRequest(), fc.getAsyncHandler()); + } + } + + @Override + public ListenableFuture executeRequest(RequestBuilder requestBuilder, AsyncHandler handler) { + return executeRequest(requestBuilder.build(), handler); + } + + @Override + public ListenableFuture executeRequest(Request request) { + return executeRequest(request, new AsyncCompletionHandlerBase()); + } + + @Override + public ListenableFuture executeRequest(RequestBuilder requestBuilder) { + return executeRequest(requestBuilder.build()); + } + + private ListenableFuture execute(Request request, final AsyncHandler asyncHandler) { + try { + return requestSender.sendRequest(request, asyncHandler, null); + } catch (Exception e) { + asyncHandler.onThrowable(e); + return new ListenableFuture.CompletedFailure<>(e); + } + } + + /** + * Configure and execute the associated {@link RequestFilter}. This class + * may decorate the {@link Request} and {@link AsyncHandler} + * + * @param fc {@link FilterContext} + * @return {@link FilterContext} + */ + private FilterContext preProcessRequest(FilterContext fc) throws FilterException { + for (RequestFilter asyncFilter : config.getRequestFilters()) { + fc = asyncFilter.filter(fc); + requireNonNull(fc, "filterContext"); + } + + Request request = fc.getRequest(); + if (fc.getAsyncHandler() instanceof ResumableAsyncHandler) { + request = ((ResumableAsyncHandler) fc.getAsyncHandler()).adjustRequestRange(request); + } + + if (request.getRangeOffset() != 0) { + RequestBuilder builder = request.toBuilder(); + builder.setHeader("Range", "bytes=" + request.getRangeOffset() + '-'); + request = builder.build(); + } + fc = new FilterContext.FilterContextBuilder<>(fc).request(request).build(); + return fc; + } + + public ChannelPool getChannelPool() { + return channelManager.getChannelPool(); + } + + public EventLoopGroup getEventLoopGroup() { + return channelManager.getEventLoopGroup(); + } + + @Override + public ClientStats getClientStats() { + return channelManager.getClientStats(); + } + + @Override + public void flushChannelPoolPartitions(Predicate predicate) { + getChannelPool().flushPartitions(predicate); + } + + protected BoundRequestBuilder requestBuilder(String method, String url) { + return new BoundRequestBuilder(this, method, config.isDisableUrlEncodingForBoundRequests()).setUrl(url).setSignatureCalculator(signatureCalculator); + } + + protected BoundRequestBuilder requestBuilder(Request prototype) { + return new BoundRequestBuilder(this, prototype).setSignatureCalculator(signatureCalculator); + } + + @Override + public AsyncHttpClientConfig getConfig() { + return config; + } +} diff --git a/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java b/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java new file mode 100644 index 0000000000..1c7dbf37f8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java @@ -0,0 +1,1523 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.Channel; +import io.netty.channel.ChannelOption; +import io.netty.channel.EventLoopGroup; +import io.netty.handler.ssl.SslContext; +import io.netty.util.Timer; +import org.asynchttpclient.channel.ChannelPool; +import org.asynchttpclient.channel.DefaultKeepAliveStrategy; +import org.asynchttpclient.channel.KeepAliveStrategy; +import org.asynchttpclient.config.AsyncHttpClientConfigDefaults; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.cookie.ThreadSafeCookieStore; +import org.asynchttpclient.filter.IOExceptionFilter; +import org.asynchttpclient.filter.RequestFilter; +import org.asynchttpclient.filter.ResponseFilter; +import org.asynchttpclient.netty.channel.ConnectionSemaphoreFactory; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.proxy.ProxyServerSelector; +import org.asynchttpclient.util.ProxyUtils; +import org.jetbrains.annotations.Nullable; + +import java.time.Duration; +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ThreadFactory; +import java.util.function.Consumer; + +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultAcquireFreeChannelTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultAggregateWebSocketFrameFragments; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultChunkedFileChunkSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultCompressionEnforced; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultConnectTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultConnectionPoolCleanerPeriod; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultConnectionTtl; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultDisableHttpsEndpointIdentificationAlgorithm; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultDisableUrlEncodingForBoundRequests; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultDisableZeroCopy; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultEnableAutomaticDecompression; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultEnableWebSocketCompression; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultEnabledCipherSuites; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultEnabledProtocols; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultExpiredCookieEvictionDelay; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultFilterInsecureCipherSuites; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultFollowRedirect; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHandshakeTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHashedWheelTimerSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHashedWheelTimerTickDuration; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHttpClientCodecInitialBufferSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHttpClientCodecMaxChunkSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHttpClientCodecMaxHeaderSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultHttpClientCodecMaxInitialLineLength; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultIoThreadsCount; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultKeepAlive; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultKeepEncodingHeader; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultMaxConnections; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultMaxConnectionsPerHost; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultMaxRedirects; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultMaxRequestRetry; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultPooledConnectionIdleTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultReadTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultRequestTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultShutdownQuietPeriod; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultShutdownTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSoKeepAlive; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSoLinger; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSoRcvBuf; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSoReuseAddress; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSoSndBuf; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSslSessionCacheSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultSslSessionTimeout; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultStrict302Handling; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultTcpNoDelay; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultThreadPoolName; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseInsecureTrustManager; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseLaxCookieEncoder; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseNativeTransport; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseOnlyEpollNativeTransport; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseOpenSsl; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseProxyProperties; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUseProxySelector; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUserAgent; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultValidateResponseHeaders; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultWebSocketMaxBufferSize; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultWebSocketMaxFrameSize; + +/** + * Configuration class to use with a {@link AsyncHttpClient}. System property can be also used to configure this object default behavior by doing:
+ * -Dorg.asynchttpclient.nameOfTheProperty + * + * @see AsyncHttpClientConfig for documentation + */ +public class DefaultAsyncHttpClientConfig implements AsyncHttpClientConfig { + + // http + private final boolean followRedirect; + private final int maxRedirects; + private final boolean strict302Handling; + private final boolean compressionEnforced; + + private final boolean enableAutomaticDecompression; + private final String userAgent; + private final @Nullable Realm realm; + private final int maxRequestRetry; + private final boolean disableUrlEncodingForBoundRequests; + private final boolean useLaxCookieEncoder; + private final boolean disableZeroCopy; + private final boolean keepEncodingHeader; + private final ProxyServerSelector proxyServerSelector; + private final boolean validateResponseHeaders; + private final boolean stripAuthorizationOnRedirect; + + // websockets + private final boolean aggregateWebSocketFrameFragments; + private final boolean enablewebSocketCompression; + private final int webSocketMaxBufferSize; + private final int webSocketMaxFrameSize; + + // timeouts + private final Duration connectTimeout; + private final Duration requestTimeout; + private final Duration readTimeout; + private final Duration shutdownQuietPeriod; + private final Duration shutdownTimeout; + + // keep-alive + private final boolean keepAlive; + private final Duration pooledConnectionIdleTimeout; + private final Duration connectionPoolCleanerPeriod; + private final Duration connectionTtl; + private final int maxConnections; + private final int maxConnectionsPerHost; + private final int acquireFreeChannelTimeout; + private final @Nullable ChannelPool channelPool; + private final @Nullable ConnectionSemaphoreFactory connectionSemaphoreFactory; + private final KeepAliveStrategy keepAliveStrategy; + + // ssl + private final boolean useOpenSsl; + private final boolean useInsecureTrustManager; + private final boolean disableHttpsEndpointIdentificationAlgorithm; + private final int handshakeTimeout; + private final @Nullable String[] enabledProtocols; + private final @Nullable String[] enabledCipherSuites; + private final boolean filterInsecureCipherSuites; + private final int sslSessionCacheSize; + private final int sslSessionTimeout; + private final @Nullable SslContext sslContext; + private final @Nullable SslEngineFactory sslEngineFactory; + + // filters + private final List requestFilters; + private final List responseFilters; + private final List ioExceptionFilters; + + // cookie store + private final CookieStore cookieStore; + private final int expiredCookieEvictionDelay; + + // internals + private final String threadPoolName; + private final int httpClientCodecMaxInitialLineLength; + private final int httpClientCodecMaxHeaderSize; + private final int httpClientCodecMaxChunkSize; + private final int httpClientCodecInitialBufferSize; + private final int chunkedFileChunkSize; + private final Map, Object> channelOptions; + private final @Nullable EventLoopGroup eventLoopGroup; + private final boolean useNativeTransport; + private final boolean useOnlyEpollNativeTransport; + private final @Nullable ByteBufAllocator allocator; + private final boolean tcpNoDelay; + private final boolean soReuseAddress; + private final boolean soKeepAlive; + private final int soLinger; + private final int soSndBuf; + private final int soRcvBuf; + private final @Nullable Timer nettyTimer; + private final @Nullable ThreadFactory threadFactory; + private final @Nullable Consumer httpAdditionalChannelInitializer; + private final @Nullable Consumer wsAdditionalChannelInitializer; + private final ResponseBodyPartFactory responseBodyPartFactory; + private final int ioThreadsCount; + private final long hashedWheelTimerTickDuration; + private final int hashedWheelTimerSize; + + private DefaultAsyncHttpClientConfig(// http + boolean followRedirect, + int maxRedirects, + boolean strict302Handling, + boolean compressionEnforced, + boolean enableAutomaticDecompression, + String userAgent, + @Nullable Realm realm, + int maxRequestRetry, + boolean disableUrlEncodingForBoundRequests, + boolean useLaxCookieEncoder, + boolean disableZeroCopy, + boolean keepEncodingHeader, + ProxyServerSelector proxyServerSelector, + boolean validateResponseHeaders, + boolean aggregateWebSocketFrameFragments, + boolean enablewebSocketCompression, + boolean stripAuthorizationOnRedirect, + + // timeouts + Duration connectTimeout, + Duration requestTimeout, + Duration readTimeout, + Duration shutdownQuietPeriod, + Duration shutdownTimeout, + + // keep-alive + boolean keepAlive, + Duration pooledConnectionIdleTimeout, + Duration connectionPoolCleanerPeriod, + Duration connectionTtl, + int maxConnections, + int maxConnectionsPerHost, + int acquireFreeChannelTimeout, + @Nullable ChannelPool channelPool, + @Nullable ConnectionSemaphoreFactory connectionSemaphoreFactory, + KeepAliveStrategy keepAliveStrategy, + + // ssl + boolean useOpenSsl, + boolean useInsecureTrustManager, + boolean disableHttpsEndpointIdentificationAlgorithm, + int handshakeTimeout, + @Nullable String[] enabledProtocols, + @Nullable String[] enabledCipherSuites, + boolean filterInsecureCipherSuites, + int sslSessionCacheSize, + int sslSessionTimeout, + @Nullable SslContext sslContext, + @Nullable SslEngineFactory sslEngineFactory, + + // filters + List requestFilters, + List responseFilters, + List ioExceptionFilters, + + // cookie store + CookieStore cookieStore, + int expiredCookieEvictionDelay, + + // tuning + boolean tcpNoDelay, + boolean soReuseAddress, + boolean soKeepAlive, + int soLinger, + int soSndBuf, + int soRcvBuf, + + // internals + String threadPoolName, + int httpClientCodecMaxInitialLineLength, + int httpClientCodecMaxHeaderSize, + int httpClientCodecMaxChunkSize, + int httpClientCodecInitialBufferSize, + int chunkedFileChunkSize, + int webSocketMaxBufferSize, + int webSocketMaxFrameSize, + Map, Object> channelOptions, + @Nullable EventLoopGroup eventLoopGroup, + boolean useNativeTransport, + boolean useOnlyEpollNativeTransport, + @Nullable ByteBufAllocator allocator, + @Nullable Timer nettyTimer, + @Nullable ThreadFactory threadFactory, + @Nullable Consumer httpAdditionalChannelInitializer, + @Nullable Consumer wsAdditionalChannelInitializer, + ResponseBodyPartFactory responseBodyPartFactory, + int ioThreadsCount, + long hashedWheelTimerTickDuration, + int hashedWheelTimerSize) { + + // http + this.followRedirect = followRedirect; + this.maxRedirects = maxRedirects; + this.strict302Handling = strict302Handling; + this.compressionEnforced = compressionEnforced; + this.enableAutomaticDecompression = enableAutomaticDecompression; + this.userAgent = userAgent; + this.realm = realm; + this.maxRequestRetry = maxRequestRetry; + this.disableUrlEncodingForBoundRequests = disableUrlEncodingForBoundRequests; + this.useLaxCookieEncoder = useLaxCookieEncoder; + this.disableZeroCopy = disableZeroCopy; + this.keepEncodingHeader = keepEncodingHeader; + this.proxyServerSelector = proxyServerSelector; + this.validateResponseHeaders = validateResponseHeaders; + this.stripAuthorizationOnRedirect = stripAuthorizationOnRedirect; + + // websocket + this.aggregateWebSocketFrameFragments = aggregateWebSocketFrameFragments; + this.enablewebSocketCompression = enablewebSocketCompression; + this.webSocketMaxBufferSize = webSocketMaxBufferSize; + this.webSocketMaxFrameSize = webSocketMaxFrameSize; + + // timeouts + this.connectTimeout = connectTimeout; + this.requestTimeout = requestTimeout; + this.readTimeout = readTimeout; + this.shutdownQuietPeriod = shutdownQuietPeriod; + this.shutdownTimeout = shutdownTimeout; + + // keep-alive + this.keepAlive = keepAlive; + this.pooledConnectionIdleTimeout = pooledConnectionIdleTimeout; + this.connectionPoolCleanerPeriod = connectionPoolCleanerPeriod; + this.connectionTtl = connectionTtl; + this.maxConnections = maxConnections; + this.maxConnectionsPerHost = maxConnectionsPerHost; + this.acquireFreeChannelTimeout = acquireFreeChannelTimeout; + this.channelPool = channelPool; + this.connectionSemaphoreFactory = connectionSemaphoreFactory; + this.keepAliveStrategy = keepAliveStrategy; + + // ssl + this.useOpenSsl = useOpenSsl; + this.useInsecureTrustManager = useInsecureTrustManager; + this.disableHttpsEndpointIdentificationAlgorithm = disableHttpsEndpointIdentificationAlgorithm; + this.handshakeTimeout = handshakeTimeout; + this.enabledProtocols = enabledProtocols; + this.enabledCipherSuites = enabledCipherSuites; + this.filterInsecureCipherSuites = filterInsecureCipherSuites; + this.sslSessionCacheSize = sslSessionCacheSize; + this.sslSessionTimeout = sslSessionTimeout; + this.sslContext = sslContext; + this.sslEngineFactory = sslEngineFactory; + + // filters + this.requestFilters = requestFilters; + this.responseFilters = responseFilters; + this.ioExceptionFilters = ioExceptionFilters; + + // cookie store + this.cookieStore = cookieStore; + this.expiredCookieEvictionDelay = expiredCookieEvictionDelay; + + // tuning + this.tcpNoDelay = tcpNoDelay; + this.soReuseAddress = soReuseAddress; + this.soKeepAlive = soKeepAlive; + this.soLinger = soLinger; + this.soSndBuf = soSndBuf; + this.soRcvBuf = soRcvBuf; + + // internals + this.threadPoolName = threadPoolName; + this.httpClientCodecMaxInitialLineLength = httpClientCodecMaxInitialLineLength; + this.httpClientCodecMaxHeaderSize = httpClientCodecMaxHeaderSize; + this.httpClientCodecMaxChunkSize = httpClientCodecMaxChunkSize; + this.httpClientCodecInitialBufferSize = httpClientCodecInitialBufferSize; + this.chunkedFileChunkSize = chunkedFileChunkSize; + this.channelOptions = channelOptions; + this.eventLoopGroup = eventLoopGroup; + this.useNativeTransport = useNativeTransport; + this.useOnlyEpollNativeTransport = useOnlyEpollNativeTransport; + + if (useOnlyEpollNativeTransport && !useNativeTransport) { + throw new IllegalArgumentException("Native Transport must be enabled to use Epoll Native Transport only"); + } + + this.allocator = allocator; + this.nettyTimer = nettyTimer; + this.threadFactory = threadFactory; + this.httpAdditionalChannelInitializer = httpAdditionalChannelInitializer; + this.wsAdditionalChannelInitializer = wsAdditionalChannelInitializer; + this.responseBodyPartFactory = responseBodyPartFactory; + this.ioThreadsCount = ioThreadsCount; + this.hashedWheelTimerTickDuration = hashedWheelTimerTickDuration; + this.hashedWheelTimerSize = hashedWheelTimerSize; + } + + @Override + public String getAhcVersion() { + return AsyncHttpClientConfigDefaults.AHC_VERSION; + } + + // http + @Override + public boolean isFollowRedirect() { + return followRedirect; + } + + @Override + public int getMaxRedirects() { + return maxRedirects; + } + + @Override + public boolean isStrict302Handling() { + return strict302Handling; + } + + @Override + public boolean isCompressionEnforced() { + return compressionEnforced; + } + + @Override + public boolean isEnableAutomaticDecompression() { + return enableAutomaticDecompression; + } + + @Override + public String getUserAgent() { + return userAgent; + } + + @Override + public @Nullable Realm getRealm() { + return realm; + } + + @Override + public int getMaxRequestRetry() { + return maxRequestRetry; + } + + @Override + public boolean isDisableUrlEncodingForBoundRequests() { + return disableUrlEncodingForBoundRequests; + } + + @Override + public boolean isUseLaxCookieEncoder() { + return useLaxCookieEncoder; + } + + @Override + public boolean isDisableZeroCopy() { + return disableZeroCopy; + } + + @Override + public boolean isKeepEncodingHeader() { + return keepEncodingHeader; + } + + @Override + public ProxyServerSelector getProxyServerSelector() { + return proxyServerSelector; + } + + // websocket + @Override + public boolean isAggregateWebSocketFrameFragments() { + return aggregateWebSocketFrameFragments; + } + + @Override + public boolean isEnableWebSocketCompression() { + return enablewebSocketCompression; + } + + @Override + public int getWebSocketMaxBufferSize() { + return webSocketMaxBufferSize; + } + + @Override + public int getWebSocketMaxFrameSize() { + return webSocketMaxFrameSize; + } + + // timeouts + @Override + public Duration getConnectTimeout() { + return connectTimeout; + } + + @Override + public Duration getRequestTimeout() { + return requestTimeout; + } + + @Override + public Duration getReadTimeout() { + return readTimeout; + } + + @Override + public Duration getShutdownQuietPeriod() { + return shutdownQuietPeriod; + } + + @Override + public Duration getShutdownTimeout() { + return shutdownTimeout; + } + + // keep-alive + @Override + public boolean isKeepAlive() { + return keepAlive; + } + + @Override + public Duration getPooledConnectionIdleTimeout() { + return pooledConnectionIdleTimeout; + } + + @Override + public Duration getConnectionPoolCleanerPeriod() { + return connectionPoolCleanerPeriod; + } + + @Override + public Duration getConnectionTtl() { + return connectionTtl; + } + + @Override + public int getMaxConnections() { + return maxConnections; + } + + @Override + public int getMaxConnectionsPerHost() { + return maxConnectionsPerHost; + } + + @Override + public int getAcquireFreeChannelTimeout() { + return acquireFreeChannelTimeout; + } + + @Override + public @Nullable ChannelPool getChannelPool() { + return channelPool; + } + + @Override + public @Nullable ConnectionSemaphoreFactory getConnectionSemaphoreFactory() { + return connectionSemaphoreFactory; + } + + @Override + public KeepAliveStrategy getKeepAliveStrategy() { + return keepAliveStrategy; + } + + @Override + public boolean isValidateResponseHeaders() { + return validateResponseHeaders; + } + + @Override + public boolean isStripAuthorizationOnRedirect() { + return stripAuthorizationOnRedirect; + } + + // ssl + @Override + public boolean isUseOpenSsl() { + return useOpenSsl; + } + + @Override + public boolean isUseInsecureTrustManager() { + return useInsecureTrustManager; + } + + @Override + public boolean isDisableHttpsEndpointIdentificationAlgorithm() { + return disableHttpsEndpointIdentificationAlgorithm; + } + + @Override + public int getHandshakeTimeout() { + return handshakeTimeout; + } + + @Override + public @Nullable String[] getEnabledProtocols() { + return enabledProtocols; + } + + @Override + public @Nullable String[] getEnabledCipherSuites() { + return enabledCipherSuites; + } + + @Override + public boolean isFilterInsecureCipherSuites() { + return filterInsecureCipherSuites; + } + + @Override + public int getSslSessionCacheSize() { + return sslSessionCacheSize; + } + + @Override + public int getSslSessionTimeout() { + return sslSessionTimeout; + } + + @Override + public @Nullable SslContext getSslContext() { + return sslContext; + } + + @Override + public @Nullable SslEngineFactory getSslEngineFactory() { + return sslEngineFactory; + } + + // filters + @Override + public List getRequestFilters() { + return requestFilters; + } + + @Override + public List getResponseFilters() { + return responseFilters; + } + + @Override + public List getIoExceptionFilters() { + return ioExceptionFilters; + } + + // cookie store + @Override + public CookieStore getCookieStore() { + return cookieStore; + } + + @Override + public int expiredCookieEvictionDelay() { + return expiredCookieEvictionDelay; + } + + // tuning + @Override + public boolean isTcpNoDelay() { + return tcpNoDelay; + } + + @Override + public boolean isSoReuseAddress() { + return soReuseAddress; + } + + @Override + public boolean isSoKeepAlive() { + return soKeepAlive; + } + + @Override + public int getSoLinger() { + return soLinger; + } + + @Override + public int getSoSndBuf() { + return soSndBuf; + } + + @Override + public int getSoRcvBuf() { + return soRcvBuf; + } + + // internals + @Override + public String getThreadPoolName() { + return threadPoolName; + } + + @Override + public int getHttpClientCodecMaxInitialLineLength() { + return httpClientCodecMaxInitialLineLength; + } + + @Override + public int getHttpClientCodecMaxHeaderSize() { + return httpClientCodecMaxHeaderSize; + } + + @Override + public int getHttpClientCodecMaxChunkSize() { + return httpClientCodecMaxChunkSize; + } + + @Override + public int getHttpClientCodecInitialBufferSize() { + return httpClientCodecInitialBufferSize; + } + + @Override + public int getChunkedFileChunkSize() { + return chunkedFileChunkSize; + } + + @Override + public Map, Object> getChannelOptions() { + return channelOptions; + } + + @Override + public @Nullable EventLoopGroup getEventLoopGroup() { + return eventLoopGroup; + } + + @Override + public boolean isUseNativeTransport() { + return useNativeTransport; + } + + @Override + public boolean isUseOnlyEpollNativeTransport() { + return useOnlyEpollNativeTransport; + } + + @Override + public @Nullable ByteBufAllocator getAllocator() { + return allocator; + } + + @Override + public @Nullable Timer getNettyTimer() { + return nettyTimer; + } + + @Override + public long getHashedWheelTimerTickDuration() { + return hashedWheelTimerTickDuration; + } + + @Override + public int getHashedWheelTimerSize() { + return hashedWheelTimerSize; + } + + @Override + public @Nullable ThreadFactory getThreadFactory() { + return threadFactory; + } + + @Override + public @Nullable Consumer getHttpAdditionalChannelInitializer() { + return httpAdditionalChannelInitializer; + } + + @Override + public @Nullable Consumer getWsAdditionalChannelInitializer() { + return wsAdditionalChannelInitializer; + } + + @Override + public ResponseBodyPartFactory getResponseBodyPartFactory() { + return responseBodyPartFactory; + } + + @Override + public int getIoThreadsCount() { + return ioThreadsCount; + } + + /** + * Builder for an {@link AsyncHttpClient} + */ + public static class Builder { + + // filters + private final List requestFilters = new LinkedList<>(); + private final List responseFilters = new LinkedList<>(); + private final List ioExceptionFilters = new LinkedList<>(); + // http + private boolean followRedirect = defaultFollowRedirect(); + private int maxRedirects = defaultMaxRedirects(); + private boolean strict302Handling = defaultStrict302Handling(); + private boolean compressionEnforced = defaultCompressionEnforced(); + private boolean enableAutomaticDecompression = defaultEnableAutomaticDecompression(); + private String userAgent = defaultUserAgent(); + private @Nullable Realm realm; + private int maxRequestRetry = defaultMaxRequestRetry(); + private boolean disableUrlEncodingForBoundRequests = defaultDisableUrlEncodingForBoundRequests(); + private boolean useLaxCookieEncoder = defaultUseLaxCookieEncoder(); + private boolean disableZeroCopy = defaultDisableZeroCopy(); + private boolean keepEncodingHeader = defaultKeepEncodingHeader(); + private @Nullable ProxyServerSelector proxyServerSelector; + private boolean useProxySelector = defaultUseProxySelector(); + private boolean useProxyProperties = defaultUseProxyProperties(); + private boolean validateResponseHeaders = defaultValidateResponseHeaders(); + private boolean stripAuthorizationOnRedirect = false; // default value + + // websocket + private boolean aggregateWebSocketFrameFragments = defaultAggregateWebSocketFrameFragments(); + private boolean enablewebSocketCompression = defaultEnableWebSocketCompression(); + private int webSocketMaxBufferSize = defaultWebSocketMaxBufferSize(); + private int webSocketMaxFrameSize = defaultWebSocketMaxFrameSize(); + + // timeouts + private Duration connectTimeout = defaultConnectTimeout(); + private Duration requestTimeout = defaultRequestTimeout(); + private Duration readTimeout = defaultReadTimeout(); + private Duration shutdownQuietPeriod = defaultShutdownQuietPeriod(); + private Duration shutdownTimeout = defaultShutdownTimeout(); + + // keep-alive + private boolean keepAlive = defaultKeepAlive(); + private Duration pooledConnectionIdleTimeout = defaultPooledConnectionIdleTimeout(); + private Duration connectionPoolCleanerPeriod = defaultConnectionPoolCleanerPeriod(); + private Duration connectionTtl = defaultConnectionTtl(); + private int maxConnections = defaultMaxConnections(); + private int maxConnectionsPerHost = defaultMaxConnectionsPerHost(); + private int acquireFreeChannelTimeout = defaultAcquireFreeChannelTimeout(); + private @Nullable ChannelPool channelPool; + private @Nullable ConnectionSemaphoreFactory connectionSemaphoreFactory; + private KeepAliveStrategy keepAliveStrategy = new DefaultKeepAliveStrategy(); + + // ssl + private boolean useOpenSsl = defaultUseOpenSsl(); + private boolean useInsecureTrustManager = defaultUseInsecureTrustManager(); + private boolean disableHttpsEndpointIdentificationAlgorithm = defaultDisableHttpsEndpointIdentificationAlgorithm(); + private int handshakeTimeout = defaultHandshakeTimeout(); + private @Nullable String[] enabledProtocols = defaultEnabledProtocols(); + private @Nullable String[] enabledCipherSuites = defaultEnabledCipherSuites(); + private boolean filterInsecureCipherSuites = defaultFilterInsecureCipherSuites(); + private int sslSessionCacheSize = defaultSslSessionCacheSize(); + private int sslSessionTimeout = defaultSslSessionTimeout(); + private @Nullable SslContext sslContext; + private @Nullable SslEngineFactory sslEngineFactory; + + // cookie store + private CookieStore cookieStore = new ThreadSafeCookieStore(); + private int expiredCookieEvictionDelay = defaultExpiredCookieEvictionDelay(); + + // tuning + private boolean tcpNoDelay = defaultTcpNoDelay(); + private boolean soReuseAddress = defaultSoReuseAddress(); + private boolean soKeepAlive = defaultSoKeepAlive(); + private int soLinger = defaultSoLinger(); + private int soSndBuf = defaultSoSndBuf(); + private int soRcvBuf = defaultSoRcvBuf(); + + // internals + private String threadPoolName = defaultThreadPoolName(); + private int httpClientCodecMaxInitialLineLength = defaultHttpClientCodecMaxInitialLineLength(); + private int httpClientCodecMaxHeaderSize = defaultHttpClientCodecMaxHeaderSize(); + private int httpClientCodecMaxChunkSize = defaultHttpClientCodecMaxChunkSize(); + private int httpClientCodecInitialBufferSize = defaultHttpClientCodecInitialBufferSize(); + private int chunkedFileChunkSize = defaultChunkedFileChunkSize(); + private boolean useNativeTransport = defaultUseNativeTransport(); + private boolean useOnlyEpollNativeTransport = defaultUseOnlyEpollNativeTransport(); + private @Nullable ByteBufAllocator allocator; + private final Map, Object> channelOptions = new HashMap<>(); + private @Nullable EventLoopGroup eventLoopGroup; + private @Nullable Timer nettyTimer; + private @Nullable ThreadFactory threadFactory; + private @Nullable Consumer httpAdditionalChannelInitializer; + private @Nullable Consumer wsAdditionalChannelInitializer; + private ResponseBodyPartFactory responseBodyPartFactory = ResponseBodyPartFactory.EAGER; + private int ioThreadsCount = defaultIoThreadsCount(); + private long hashedWheelTickDuration = defaultHashedWheelTimerTickDuration(); + private int hashedWheelSize = defaultHashedWheelTimerSize(); + + public Builder() { + } + + public Builder(AsyncHttpClientConfig config) { + // http + followRedirect = config.isFollowRedirect(); + maxRedirects = config.getMaxRedirects(); + strict302Handling = config.isStrict302Handling(); + compressionEnforced = config.isCompressionEnforced(); + enableAutomaticDecompression = config.isEnableAutomaticDecompression(); + userAgent = config.getUserAgent(); + realm = config.getRealm(); + maxRequestRetry = config.getMaxRequestRetry(); + disableUrlEncodingForBoundRequests = config.isDisableUrlEncodingForBoundRequests(); + useLaxCookieEncoder = config.isUseLaxCookieEncoder(); + disableZeroCopy = config.isDisableZeroCopy(); + keepEncodingHeader = config.isKeepEncodingHeader(); + proxyServerSelector = config.getProxyServerSelector(); + validateResponseHeaders = config.isValidateResponseHeaders(); + stripAuthorizationOnRedirect = config.isStripAuthorizationOnRedirect(); + + // websocket + aggregateWebSocketFrameFragments = config.isAggregateWebSocketFrameFragments(); + enablewebSocketCompression = config.isEnableWebSocketCompression(); + webSocketMaxBufferSize = config.getWebSocketMaxBufferSize(); + webSocketMaxFrameSize = config.getWebSocketMaxFrameSize(); + + // timeouts + connectTimeout = config.getConnectTimeout(); + requestTimeout = config.getRequestTimeout(); + readTimeout = config.getReadTimeout(); + shutdownQuietPeriod = config.getShutdownQuietPeriod(); + shutdownTimeout = config.getShutdownTimeout(); + + // keep-alive + keepAlive = config.isKeepAlive(); + pooledConnectionIdleTimeout = config.getPooledConnectionIdleTimeout(); + connectionPoolCleanerPeriod = config.getConnectionPoolCleanerPeriod(); + connectionTtl = config.getConnectionTtl(); + maxConnections = config.getMaxConnections(); + maxConnectionsPerHost = config.getMaxConnectionsPerHost(); + channelPool = config.getChannelPool(); + connectionSemaphoreFactory = config.getConnectionSemaphoreFactory(); + keepAliveStrategy = config.getKeepAliveStrategy(); + acquireFreeChannelTimeout = config.getAcquireFreeChannelTimeout(); + + // ssl + useOpenSsl = config.isUseOpenSsl(); + useInsecureTrustManager = config.isUseInsecureTrustManager(); + disableHttpsEndpointIdentificationAlgorithm = config.isDisableHttpsEndpointIdentificationAlgorithm(); + handshakeTimeout = config.getHandshakeTimeout(); + enabledProtocols = config.getEnabledProtocols(); + enabledCipherSuites = config.getEnabledCipherSuites(); + filterInsecureCipherSuites = config.isFilterInsecureCipherSuites(); + sslSessionCacheSize = config.getSslSessionCacheSize(); + sslSessionTimeout = config.getSslSessionTimeout(); + sslContext = config.getSslContext(); + sslEngineFactory = config.getSslEngineFactory(); + + // filters + requestFilters.addAll(config.getRequestFilters()); + responseFilters.addAll(config.getResponseFilters()); + ioExceptionFilters.addAll(config.getIoExceptionFilters()); + + // cookie store + cookieStore = config.getCookieStore(); + expiredCookieEvictionDelay = config.expiredCookieEvictionDelay(); + + // tuning + tcpNoDelay = config.isTcpNoDelay(); + soReuseAddress = config.isSoReuseAddress(); + soKeepAlive = config.isSoKeepAlive(); + soLinger = config.getSoLinger(); + soSndBuf = config.getSoSndBuf(); + soRcvBuf = config.getSoRcvBuf(); + + // internals + threadPoolName = config.getThreadPoolName(); + httpClientCodecMaxInitialLineLength = config.getHttpClientCodecMaxInitialLineLength(); + httpClientCodecMaxHeaderSize = config.getHttpClientCodecMaxHeaderSize(); + httpClientCodecMaxChunkSize = config.getHttpClientCodecMaxChunkSize(); + httpClientCodecInitialBufferSize = config.getHttpClientCodecInitialBufferSize(); + chunkedFileChunkSize = config.getChunkedFileChunkSize(); + channelOptions.putAll(config.getChannelOptions()); + eventLoopGroup = config.getEventLoopGroup(); + useNativeTransport = config.isUseNativeTransport(); + useOnlyEpollNativeTransport = config.isUseOnlyEpollNativeTransport(); + + allocator = config.getAllocator(); + nettyTimer = config.getNettyTimer(); + threadFactory = config.getThreadFactory(); + httpAdditionalChannelInitializer = config.getHttpAdditionalChannelInitializer(); + wsAdditionalChannelInitializer = config.getWsAdditionalChannelInitializer(); + responseBodyPartFactory = config.getResponseBodyPartFactory(); + ioThreadsCount = config.getIoThreadsCount(); + hashedWheelTickDuration = config.getHashedWheelTimerTickDuration(); + hashedWheelSize = config.getHashedWheelTimerSize(); + } + + // http + public Builder setFollowRedirect(boolean followRedirect) { + this.followRedirect = followRedirect; + return this; + } + + public Builder setMaxRedirects(int maxRedirects) { + this.maxRedirects = maxRedirects; + return this; + } + + public Builder setStrict302Handling(final boolean strict302Handling) { + this.strict302Handling = strict302Handling; + return this; + } + + /** + * If true, AHC will add Accept-Encoding HTTP header to each request + *

+ * If false (default), AHC will either leave AcceptEncoding header as is + * (if enableAutomaticDecompression is false) or will remove unsupported + * algorithms (if enableAutomaticDecompression is true) + */ + public Builder setCompressionEnforced(boolean compressionEnforced) { + this.compressionEnforced = compressionEnforced; + return this; + } + + /* + * If true (default), AHC will add a Netty HttpContentDecompressor, so compressed + * content will automatically get decompressed. + * + * If set to false, response will be delivered as is received. Decompression must + * be done by calling code. + */ + public Builder setEnableAutomaticDecompression(boolean enable) { + enableAutomaticDecompression = enable; + return this; + } + + public Builder setUserAgent(String userAgent) { + this.userAgent = userAgent; + return this; + } + + public Builder setRealm(Realm realm) { + this.realm = realm; + return this; + } + + public Builder setRealm(Realm.Builder realmBuilder) { + realm = realmBuilder.build(); + return this; + } + + public Builder setMaxRequestRetry(int maxRequestRetry) { + this.maxRequestRetry = maxRequestRetry; + return this; + } + + public Builder setDisableUrlEncodingForBoundRequests(boolean disableUrlEncodingForBoundRequests) { + this.disableUrlEncodingForBoundRequests = disableUrlEncodingForBoundRequests; + return this; + } + + public Builder setUseLaxCookieEncoder(boolean useLaxCookieEncoder) { + this.useLaxCookieEncoder = useLaxCookieEncoder; + return this; + } + + public Builder setDisableZeroCopy(boolean disableZeroCopy) { + this.disableZeroCopy = disableZeroCopy; + return this; + } + + public Builder setKeepEncodingHeader(boolean keepEncodingHeader) { + this.keepEncodingHeader = keepEncodingHeader; + return this; + } + + public Builder setProxyServerSelector(ProxyServerSelector proxyServerSelector) { + this.proxyServerSelector = proxyServerSelector; + return this; + } + + public Builder setValidateResponseHeaders(boolean validateResponseHeaders) { + this.validateResponseHeaders = validateResponseHeaders; + return this; + } + + public Builder setProxyServer(ProxyServer proxyServer) { + proxyServerSelector = uri -> proxyServer; + return this; + } + + public Builder setProxyServer(ProxyServer.Builder proxyServerBuilder) { + return setProxyServer(proxyServerBuilder.build()); + } + + public Builder setUseProxySelector(boolean useProxySelector) { + this.useProxySelector = useProxySelector; + return this; + } + + public Builder setUseProxyProperties(boolean useProxyProperties) { + this.useProxyProperties = useProxyProperties; + return this; + } + + public Builder setStripAuthorizationOnRedirect(boolean value) { + stripAuthorizationOnRedirect = value; + return this; + } + + // websocket + public Builder setAggregateWebSocketFrameFragments(boolean aggregateWebSocketFrameFragments) { + this.aggregateWebSocketFrameFragments = aggregateWebSocketFrameFragments; + return this; + } + + public Builder setEnablewebSocketCompression(boolean enablewebSocketCompression) { + this.enablewebSocketCompression = enablewebSocketCompression; + return this; + } + + public Builder setWebSocketMaxBufferSize(int webSocketMaxBufferSize) { + this.webSocketMaxBufferSize = webSocketMaxBufferSize; + return this; + } + + public Builder setWebSocketMaxFrameSize(int webSocketMaxFrameSize) { + this.webSocketMaxFrameSize = webSocketMaxFrameSize; + return this; + } + + // timeouts + public Builder setConnectTimeout(Duration connectTimeout) { + this.connectTimeout = connectTimeout; + return this; + } + + public Builder setRequestTimeout(Duration requestTimeout) { + this.requestTimeout = requestTimeout; + return this; + } + + public Builder setReadTimeout(Duration readTimeout) { + this.readTimeout = readTimeout; + return this; + } + + public Builder setShutdownQuietPeriod(Duration shutdownQuietPeriod) { + this.shutdownQuietPeriod = shutdownQuietPeriod; + return this; + } + + public Builder setShutdownTimeout(Duration shutdownTimeout) { + this.shutdownTimeout = shutdownTimeout; + return this; + } + + // keep-alive + public Builder setKeepAlive(boolean keepAlive) { + this.keepAlive = keepAlive; + return this; + } + + public Builder setPooledConnectionIdleTimeout(Duration pooledConnectionIdleTimeout) { + this.pooledConnectionIdleTimeout = pooledConnectionIdleTimeout; + return this; + } + + public Builder setConnectionPoolCleanerPeriod(Duration connectionPoolCleanerPeriod) { + this.connectionPoolCleanerPeriod = connectionPoolCleanerPeriod; + return this; + } + + public Builder setConnectionTtl(Duration connectionTtl) { + this.connectionTtl = connectionTtl; + return this; + } + + public Builder setMaxConnections(int maxConnections) { + this.maxConnections = maxConnections; + return this; + } + + public Builder setMaxConnectionsPerHost(int maxConnectionsPerHost) { + this.maxConnectionsPerHost = maxConnectionsPerHost; + return this; + } + + /** + * Sets the maximum duration in milliseconds to acquire a free channel to send a request + * + * @param acquireFreeChannelTimeout maximum duration in milliseconds to acquire a free channel to send a request + * @return the same builder instance + */ + public Builder setAcquireFreeChannelTimeout(int acquireFreeChannelTimeout) { + this.acquireFreeChannelTimeout = acquireFreeChannelTimeout; + return this; + } + + public Builder setChannelPool(ChannelPool channelPool) { + this.channelPool = channelPool; + return this; + } + + public Builder setConnectionSemaphoreFactory(ConnectionSemaphoreFactory connectionSemaphoreFactory) { + this.connectionSemaphoreFactory = connectionSemaphoreFactory; + return this; + } + + public Builder setKeepAliveStrategy(KeepAliveStrategy keepAliveStrategy) { + this.keepAliveStrategy = keepAliveStrategy; + return this; + } + + // ssl + public Builder setUseOpenSsl(boolean useOpenSsl) { + this.useOpenSsl = useOpenSsl; + return this; + } + + public Builder setUseInsecureTrustManager(boolean useInsecureTrustManager) { + this.useInsecureTrustManager = useInsecureTrustManager; + return this; + } + + public Builder setDisableHttpsEndpointIdentificationAlgorithm(boolean disableHttpsEndpointIdentificationAlgorithm) { + this.disableHttpsEndpointIdentificationAlgorithm = disableHttpsEndpointIdentificationAlgorithm; + return this; + } + + public Builder setHandshakeTimeout(int handshakeTimeout) { + this.handshakeTimeout = handshakeTimeout; + return this; + } + + public Builder setEnabledProtocols(String[] enabledProtocols) { + this.enabledProtocols = enabledProtocols; + return this; + } + + public Builder setEnabledCipherSuites(String[] enabledCipherSuites) { + this.enabledCipherSuites = enabledCipherSuites; + return this; + } + + public Builder setFilterInsecureCipherSuites(boolean filterInsecureCipherSuites) { + this.filterInsecureCipherSuites = filterInsecureCipherSuites; + return this; + } + + public Builder setSslSessionCacheSize(Integer sslSessionCacheSize) { + this.sslSessionCacheSize = sslSessionCacheSize; + return this; + } + + public Builder setSslSessionTimeout(Integer sslSessionTimeout) { + this.sslSessionTimeout = sslSessionTimeout; + return this; + } + + public Builder setSslContext(final SslContext sslContext) { + this.sslContext = sslContext; + return this; + } + + public Builder setSslEngineFactory(SslEngineFactory sslEngineFactory) { + this.sslEngineFactory = sslEngineFactory; + return this; + } + + // filters + public Builder addRequestFilter(RequestFilter requestFilter) { + requestFilters.add(requestFilter); + return this; + } + + public Builder removeRequestFilter(RequestFilter requestFilter) { + requestFilters.remove(requestFilter); + return this; + } + + public Builder addResponseFilter(ResponseFilter responseFilter) { + responseFilters.add(responseFilter); + return this; + } + + public Builder removeResponseFilter(ResponseFilter responseFilter) { + responseFilters.remove(responseFilter); + return this; + } + + public Builder addIOExceptionFilter(IOExceptionFilter ioExceptionFilter) { + ioExceptionFilters.add(ioExceptionFilter); + return this; + } + + public Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter) { + ioExceptionFilters.remove(ioExceptionFilter); + return this; + } + + // cookie store + public Builder setCookieStore(CookieStore cookieStore) { + this.cookieStore = cookieStore; + return this; + } + + public Builder setExpiredCookieEvictionDelay(int expiredCookieEvictionDelay) { + this.expiredCookieEvictionDelay = expiredCookieEvictionDelay; + return this; + } + + // tuning + public Builder setTcpNoDelay(boolean tcpNoDelay) { + this.tcpNoDelay = tcpNoDelay; + return this; + } + + public Builder setSoReuseAddress(boolean soReuseAddress) { + this.soReuseAddress = soReuseAddress; + return this; + } + + public Builder setSoKeepAlive(boolean soKeepAlive) { + this.soKeepAlive = soKeepAlive; + return this; + } + + public Builder setSoLinger(int soLinger) { + this.soLinger = soLinger; + return this; + } + + public Builder setSoSndBuf(int soSndBuf) { + this.soSndBuf = soSndBuf; + return this; + } + + public Builder setSoRcvBuf(int soRcvBuf) { + this.soRcvBuf = soRcvBuf; + return this; + } + + // internals + public Builder setThreadPoolName(String threadPoolName) { + this.threadPoolName = threadPoolName; + return this; + } + + public Builder setHttpClientCodecMaxInitialLineLength(int httpClientCodecMaxInitialLineLength) { + this.httpClientCodecMaxInitialLineLength = httpClientCodecMaxInitialLineLength; + return this; + } + + public Builder setHttpClientCodecMaxHeaderSize(int httpClientCodecMaxHeaderSize) { + this.httpClientCodecMaxHeaderSize = httpClientCodecMaxHeaderSize; + return this; + } + + public Builder setHttpClientCodecMaxChunkSize(int httpClientCodecMaxChunkSize) { + this.httpClientCodecMaxChunkSize = httpClientCodecMaxChunkSize; + return this; + } + + public Builder setHttpClientCodecInitialBufferSize(int httpClientCodecInitialBufferSize) { + this.httpClientCodecInitialBufferSize = httpClientCodecInitialBufferSize; + return this; + } + + public Builder setChunkedFileChunkSize(int chunkedFileChunkSize) { + this.chunkedFileChunkSize = chunkedFileChunkSize; + return this; + } + + public Builder setHashedWheelTickDuration(long hashedWheelTickDuration) { + this.hashedWheelTickDuration = hashedWheelTickDuration; + return this; + } + + public Builder setHashedWheelSize(int hashedWheelSize) { + this.hashedWheelSize = hashedWheelSize; + return this; + } + + @SuppressWarnings("unchecked") + public Builder addChannelOption(ChannelOption name, T value) { + channelOptions.put((ChannelOption) name, value); + return this; + } + + public Builder setEventLoopGroup(EventLoopGroup eventLoopGroup) { + this.eventLoopGroup = eventLoopGroup; + return this; + } + + public Builder setUseNativeTransport(boolean useNativeTransport) { + this.useNativeTransport = useNativeTransport; + return this; + } + + public Builder setUseOnlyEpollNativeTransport(boolean useOnlyEpollNativeTransport) { + this.useOnlyEpollNativeTransport = useOnlyEpollNativeTransport; + return this; + } + + public Builder setAllocator(ByteBufAllocator allocator) { + this.allocator = allocator; + return this; + } + + public Builder setNettyTimer(Timer nettyTimer) { + this.nettyTimer = nettyTimer; + return this; + } + + public Builder setThreadFactory(ThreadFactory threadFactory) { + this.threadFactory = threadFactory; + return this; + } + + public Builder setHttpAdditionalChannelInitializer(Consumer httpAdditionalChannelInitializer) { + this.httpAdditionalChannelInitializer = httpAdditionalChannelInitializer; + return this; + } + + public Builder setWsAdditionalChannelInitializer(Consumer wsAdditionalChannelInitializer) { + this.wsAdditionalChannelInitializer = wsAdditionalChannelInitializer; + return this; + } + + public Builder setResponseBodyPartFactory(ResponseBodyPartFactory responseBodyPartFactory) { + this.responseBodyPartFactory = responseBodyPartFactory; + return this; + } + + public Builder setIoThreadsCount(int ioThreadsCount) { + this.ioThreadsCount = ioThreadsCount; + return this; + } + + private ProxyServerSelector resolveProxyServerSelector() { + if (proxyServerSelector != null) { + return proxyServerSelector; + } + + if (useProxySelector) { + return ProxyUtils.getJdkDefaultProxyServerSelector(); + } + + if (useProxyProperties) { + return ProxyUtils.createProxyServerSelector(System.getProperties()); + } + + return ProxyServerSelector.NO_PROXY_SELECTOR; + } + + public DefaultAsyncHttpClientConfig build() { + + return new DefaultAsyncHttpClientConfig( + followRedirect, + maxRedirects, + strict302Handling, + compressionEnforced, + enableAutomaticDecompression, + userAgent, + realm, + maxRequestRetry, + disableUrlEncodingForBoundRequests, + useLaxCookieEncoder, + disableZeroCopy, + keepEncodingHeader, + resolveProxyServerSelector(), + validateResponseHeaders, + aggregateWebSocketFrameFragments, + enablewebSocketCompression, + stripAuthorizationOnRedirect, + connectTimeout, + requestTimeout, + readTimeout, + shutdownQuietPeriod, + shutdownTimeout, + keepAlive, + pooledConnectionIdleTimeout, + connectionPoolCleanerPeriod, + connectionTtl, + maxConnections, + maxConnectionsPerHost, + acquireFreeChannelTimeout, + channelPool, + connectionSemaphoreFactory, + keepAliveStrategy, + useOpenSsl, + useInsecureTrustManager, + disableHttpsEndpointIdentificationAlgorithm, + handshakeTimeout, + enabledProtocols, + enabledCipherSuites, + filterInsecureCipherSuites, + sslSessionCacheSize, + sslSessionTimeout, + sslContext, + sslEngineFactory, + requestFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(requestFilters), + responseFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(responseFilters), + ioExceptionFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(ioExceptionFilters), + cookieStore, + expiredCookieEvictionDelay, + tcpNoDelay, + soReuseAddress, + soKeepAlive, + soLinger, + soSndBuf, + soRcvBuf, + threadPoolName, + httpClientCodecMaxInitialLineLength, + httpClientCodecMaxHeaderSize, + httpClientCodecMaxChunkSize, + httpClientCodecInitialBufferSize, + chunkedFileChunkSize, + webSocketMaxBufferSize, + webSocketMaxFrameSize, + channelOptions.isEmpty() ? Collections.emptyMap() : Collections.unmodifiableMap(channelOptions), + eventLoopGroup, + useNativeTransport, + useOnlyEpollNativeTransport, + allocator, + nettyTimer, + threadFactory, + httpAdditionalChannelInitializer, + wsAdditionalChannelInitializer, + responseBodyPartFactory, + ioThreadsCount, + hashedWheelTickDuration, + hashedWheelSize); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/DefaultRequest.java b/client/src/main/java/org/asynchttpclient/DefaultRequest.java new file mode 100644 index 0000000000..09c615d2a2 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/DefaultRequest.java @@ -0,0 +1,311 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.resolver.NameResolver; +import org.asynchttpclient.channel.ChannelPoolPartitioning; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.request.body.generator.BodyGenerator; +import org.asynchttpclient.request.body.multipart.Part; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.io.File; +import java.io.InputStream; +import java.net.InetAddress; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public class DefaultRequest implements Request { + + public final @Nullable ProxyServer proxyServer; + private final String method; + private final Uri uri; + private final @Nullable InetAddress address; + private final @Nullable InetAddress localAddress; + private final HttpHeaders headers; + private final List cookies; + private final byte @Nullable [] byteData; + private final @Nullable List compositeByteData; + private final @Nullable String stringData; + private final @Nullable ByteBuffer byteBufferData; + private final @Nullable ByteBuf byteBufData; + private final @Nullable InputStream streamData; + private final @Nullable BodyGenerator bodyGenerator; + private final List formParams; + private final List bodyParts; + private final @Nullable String virtualHost; + private final @Nullable Realm realm; + private final @Nullable File file; + private final @Nullable Boolean followRedirect; + private final Duration requestTimeout; + private final Duration readTimeout; + private final long rangeOffset; + private final @Nullable Charset charset; + private final ChannelPoolPartitioning channelPoolPartitioning; + private final NameResolver nameResolver; + + // lazily loaded + private @Nullable List queryParams; + + public DefaultRequest(String method, + Uri uri, + @Nullable InetAddress address, + @Nullable InetAddress localAddress, + HttpHeaders headers, + List cookies, + byte @Nullable [] byteData, + @Nullable List compositeByteData, + @Nullable String stringData, + @Nullable ByteBuffer byteBufferData, + @Nullable ByteBuf byteBufData, + @Nullable InputStream streamData, + @Nullable BodyGenerator bodyGenerator, + List formParams, + List bodyParts, + @Nullable String virtualHost, + @Nullable ProxyServer proxyServer, + @Nullable Realm realm, + @Nullable File file, + @Nullable Boolean followRedirect, + @Nullable Duration requestTimeout, + @Nullable Duration readTimeout, + long rangeOffset, + @Nullable Charset charset, + ChannelPoolPartitioning channelPoolPartitioning, + NameResolver nameResolver) { + this.method = method; + this.uri = uri; + this.address = address; + this.localAddress = localAddress; + this.headers = headers; + this.cookies = cookies; + this.byteData = byteData; + this.compositeByteData = compositeByteData; + this.stringData = stringData; + this.byteBufferData = byteBufferData; + this.byteBufData = byteBufData; + this.streamData = streamData; + this.bodyGenerator = bodyGenerator; + this.formParams = formParams; + this.bodyParts = bodyParts; + this.virtualHost = virtualHost; + this.proxyServer = proxyServer; + this.realm = realm; + this.file = file; + this.followRedirect = followRedirect; + this.requestTimeout = requestTimeout == null ? Duration.ZERO : requestTimeout; + this.readTimeout = readTimeout == null ? Duration.ZERO : readTimeout; + this.rangeOffset = rangeOffset; + this.charset = charset; + this.channelPoolPartitioning = channelPoolPartitioning; + this.nameResolver = nameResolver; + } + + @Override + public String getUrl() { + return uri.toUrl(); + } + + @Override + public String getMethod() { + return method; + } + + @Override + public Uri getUri() { + return uri; + } + + @Override + public @Nullable InetAddress getAddress() { + return address; + } + + @Override + public @Nullable InetAddress getLocalAddress() { + return localAddress; + } + + @Override + public HttpHeaders getHeaders() { + return headers; + } + + @Override + public List getCookies() { + return cookies; + } + + @Override + public byte @Nullable [] getByteData() { + return byteData; + } + + @Override + public @Nullable List getCompositeByteData() { + return compositeByteData; + } + + @Override + public @Nullable String getStringData() { + return stringData; + } + + @Override + public @Nullable ByteBuffer getByteBufferData() { + return byteBufferData; + } + + @Override + public @Nullable ByteBuf getByteBufData() { + return byteBufData; + } + + @Override + public @Nullable InputStream getStreamData() { + return streamData; + } + + @Override + public @Nullable BodyGenerator getBodyGenerator() { + return bodyGenerator; + } + + @Override + public List getFormParams() { + return formParams; + } + + @Override + public List getBodyParts() { + return bodyParts; + } + + @Override + public @Nullable String getVirtualHost() { + return virtualHost; + } + + @Override + public @Nullable ProxyServer getProxyServer() { + return proxyServer; + } + + @Override + public @Nullable Realm getRealm() { + return realm; + } + + @Override + public @Nullable File getFile() { + return file; + } + + @Override + public @Nullable Boolean getFollowRedirect() { + return followRedirect; + } + + @Override + public Duration getRequestTimeout() { + return requestTimeout; + } + + @Override + public Duration getReadTimeout() { + return readTimeout; + } + + @Override + public long getRangeOffset() { + return rangeOffset; + } + + @Override + public @Nullable Charset getCharset() { + return charset; + } + + @Override + public ChannelPoolPartitioning getChannelPoolPartitioning() { + return channelPoolPartitioning; + } + + @Override + public NameResolver getNameResolver() { + return nameResolver; + } + + @Override + public List getQueryParams() { + // lazy load + if (queryParams == null) { + if (isNonEmpty(uri.getQuery())) { + queryParams = new ArrayList<>(1); + for (String queryStringParam : uri.getQuery().split("&")) { + int pos = queryStringParam.indexOf('='); + if (pos <= 0) { + queryParams.add(new Param(queryStringParam, null)); + } else { + queryParams.add(new Param(queryStringParam.substring(0, pos), queryStringParam.substring(pos + 1))); + } + } + } else { + queryParams = Collections.emptyList(); + } + } + return queryParams; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(getUrl()); + sb.append('\t'); + sb.append(method); + sb.append("\theaders:"); + + if (!headers.isEmpty()) { + for (Map.Entry header : headers) { + sb.append('\t'); + sb.append(header.getKey()); + sb.append(':'); + sb.append(header.getValue()); + } + } + + if (isNonEmpty(formParams)) { + sb.append("\tformParams:"); + for (Param param : formParams) { + sb.append('\t'); + sb.append(param.getName()); + sb.append(':'); + sb.append(param.getValue()); + } + } + return sb.toString(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/Dsl.java b/client/src/main/java/org/asynchttpclient/Dsl.java new file mode 100644 index 0000000000..f72820258c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/Dsl.java @@ -0,0 +1,133 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.proxy.ProxyServer; + +import static org.asynchttpclient.util.HttpConstants.Methods.DELETE; +import static org.asynchttpclient.util.HttpConstants.Methods.GET; +import static org.asynchttpclient.util.HttpConstants.Methods.HEAD; +import static org.asynchttpclient.util.HttpConstants.Methods.OPTIONS; +import static org.asynchttpclient.util.HttpConstants.Methods.PATCH; +import static org.asynchttpclient.util.HttpConstants.Methods.POST; +import static org.asynchttpclient.util.HttpConstants.Methods.PUT; +import static org.asynchttpclient.util.HttpConstants.Methods.TRACE; + +public final class Dsl { + + private Dsl() { + } + + // /////////// Client //////////////// + public static AsyncHttpClient asyncHttpClient() { + return new DefaultAsyncHttpClient(); + } + + public static AsyncHttpClient asyncHttpClient(DefaultAsyncHttpClientConfig.Builder configBuilder) { + return new DefaultAsyncHttpClient(configBuilder.build()); + } + + public static AsyncHttpClient asyncHttpClient(AsyncHttpClientConfig config) { + return new DefaultAsyncHttpClient(config); + } + + // /////////// Request //////////////// + public static RequestBuilder get(String url) { + return request(GET, url); + } + + public static RequestBuilder put(String url) { + return request(PUT, url); + } + + public static RequestBuilder post(String url) { + return request(POST, url); + } + + public static RequestBuilder delete(String url) { + return request(DELETE, url); + } + + public static RequestBuilder head(String url) { + return request(HEAD, url); + } + + public static RequestBuilder options(String url) { + return request(OPTIONS, url); + } + + public static RequestBuilder patch(String url) { + return request(PATCH, url); + } + + public static RequestBuilder trace(String url) { + return request(TRACE, url); + } + + public static RequestBuilder request(String method, String url) { + return new RequestBuilder(method).setUrl(url); + } + + // /////////// ProxyServer //////////////// + public static ProxyServer.Builder proxyServer(String host, int port) { + return new ProxyServer.Builder(host, port); + } + + // /////////// Config //////////////// + public static DefaultAsyncHttpClientConfig.Builder config() { + return new DefaultAsyncHttpClientConfig.Builder(); + } + + // /////////// Realm //////////////// + public static Realm.Builder realm(Realm prototype) { + return new Realm.Builder(prototype.getPrincipal(), prototype.getPassword()) + .setRealmName(prototype.getRealmName()) + .setAlgorithm(prototype.getAlgorithm()) + .setNc(prototype.getNc()) + .setNonce(prototype.getNonce()) + .setCharset(prototype.getCharset()) + .setOpaque(prototype.getOpaque()) + .setQop(prototype.getQop()) + .setScheme(prototype.getScheme()) + .setUri(prototype.getUri()) + .setUsePreemptiveAuth(prototype.isUsePreemptiveAuth()) + .setNtlmDomain(prototype.getNtlmDomain()) + .setNtlmHost(prototype.getNtlmHost()) + .setUseAbsoluteURI(prototype.isUseAbsoluteURI()) + .setOmitQuery(prototype.isOmitQuery()) + .setServicePrincipalName(prototype.getServicePrincipalName()) + .setUseCanonicalHostname(prototype.isUseCanonicalHostname()) + .setCustomLoginConfig(prototype.getCustomLoginConfig()) + .setLoginContextName(prototype.getLoginContextName()); + } + + public static Realm.Builder realm(AuthScheme scheme, String principal, String password) { + return new Realm.Builder(principal, password).setScheme(scheme); + } + + public static Realm.Builder basicAuthRealm(String principal, String password) { + return realm(AuthScheme.BASIC, principal, password); + } + + public static Realm.Builder digestAuthRealm(String principal, String password) { + return realm(AuthScheme.DIGEST, principal, password); + } + + public static Realm.Builder ntlmAuthRealm(String principal, String password) { + return realm(AuthScheme.NTLM, principal, password); + } +} diff --git a/client/src/main/java/org/asynchttpclient/HostStats.java b/client/src/main/java/org/asynchttpclient/HostStats.java new file mode 100644 index 0000000000..3470ea4e1e --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/HostStats.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import java.util.Objects; + +/** + * A record class representing the status of connections to some host. + */ +public class HostStats { + + private final long activeConnectionCount; + private final long idleConnectionCount; + + public HostStats(long activeConnectionCount, long idleConnectionCount) { + this.activeConnectionCount = activeConnectionCount; + this.idleConnectionCount = idleConnectionCount; + } + + /** + * @return The sum of {@link #getHostActiveConnectionCount()} and {@link #getHostIdleConnectionCount()}, + * a long representing the total number of connections to this host. + */ + public long getHostConnectionCount() { + return activeConnectionCount + idleConnectionCount; + } + + /** + * @return A long representing the number of active connections to the host. + */ + public long getHostActiveConnectionCount() { + return activeConnectionCount; + } + + /** + * @return A long representing the number of idle connections in the connection pool. + */ + public long getHostIdleConnectionCount() { + return idleConnectionCount; + } + + @Override + public String toString() { + return "There are " + getHostConnectionCount() + + " total connections, " + getHostActiveConnectionCount() + + " are active and " + getHostIdleConnectionCount() + " are idle."; + } + + @Override + public boolean equals(final Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + final HostStats hostStats = (HostStats) o; + return activeConnectionCount == hostStats.activeConnectionCount && idleConnectionCount == hostStats.idleConnectionCount; + } + + @Override + public int hashCode() { + return Objects.hash(activeConnectionCount, idleConnectionCount); + } +} diff --git a/client/src/main/java/org/asynchttpclient/HttpResponseBodyPart.java b/client/src/main/java/org/asynchttpclient/HttpResponseBodyPart.java new file mode 100644 index 0000000000..0df78f7b2c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/HttpResponseBodyPart.java @@ -0,0 +1,61 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; + +import java.nio.ByteBuffer; + +/** + * A callback class used when an HTTP response body is received. + */ +public abstract class HttpResponseBodyPart { + + private final boolean last; + + protected HttpResponseBodyPart(boolean last) { + this.last = last; + } + + /** + * @return length of this part in bytes + */ + public abstract int length(); + + /** + * @return the response body's part bytes received. + */ + public abstract byte[] getBodyPartBytes(); + + /** + * @return a {@link ByteBuffer} that wraps the actual bytes read from the response's chunk. + * The {@link ByteBuffer}'s capacity is equal to the number of bytes available. + */ + public abstract ByteBuffer getBodyByteBuffer(); + + /** + * @return the {@link ByteBuf} of the bytes read from the response's chunk. + * The {@link ByteBuf}'s capacity is equal to the number of bytes available. + */ + public abstract ByteBuf getBodyByteBuf(); + + /** + * @return true if this is the last part. + */ + public boolean isLast() { + return last; + } +} diff --git a/client/src/main/java/org/asynchttpclient/HttpResponseStatus.java b/client/src/main/java/org/asynchttpclient/HttpResponseStatus.java new file mode 100644 index 0000000000..8ac5c316d8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/HttpResponseStatus.java @@ -0,0 +1,108 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import org.asynchttpclient.uri.Uri; + +import java.net.SocketAddress; + +/** + * A class that represent the HTTP response status line (code + text) + */ +public abstract class HttpResponseStatus { + + private final Uri uri; + + protected HttpResponseStatus(Uri uri) { + this.uri = uri; + } + + /** + * Return the request {@link Uri} + * + * @return the request {@link Uri} + */ + public Uri getUri() { + return uri; + } + + /** + * Return the response status code + * + * @return the response status code + */ + public abstract int getStatusCode(); + + /** + * Return the response status text + * + * @return the response status text + */ + public abstract String getStatusText(); + + /** + * Protocol name from status line. + * + * @return Protocol name. + */ + public abstract String getProtocolName(); + + /** + * Protocol major version. + * + * @return Major version. + */ + public abstract int getProtocolMajorVersion(); + + /** + * Protocol minor version. + * + * @return Minor version. + */ + public abstract int getProtocolMinorVersion(); + + /** + * Full protocol name + version + * + * @return protocol name + version + */ + public abstract String getProtocolText(); + + /** + * Get remote address client initiated request to. + * + * @return remote address client initiated request to, may be {@code null} + * if asynchronous provider is unable to provide the remote address + */ + public abstract SocketAddress getRemoteAddress(); + + /** + * Get local address client initiated request from. + * + * @return local address client initiated request from, may be {@code null} + * if asynchronous provider is unable to provide the local address + */ + public abstract SocketAddress getLocalAddress(); + + /** + * Code followed by text. + */ + @Override + public String toString() { + return getStatusCode() + " " + getStatusText(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/ListenableFuture.java b/client/src/main/java/org/asynchttpclient/ListenableFuture.java new file mode 100755 index 0000000000..6f9280369c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ListenableFuture.java @@ -0,0 +1,151 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +/* + * Copyright (C) 2007 Google Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Executor; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +/** + * Extended {@link Future} + * + * @param Type of the value that will be returned. + */ +public interface ListenableFuture extends Future { + + /** + * Terminate and if there is no exception, mark this Future as done and release the internal lock. + */ + void done(); + + /** + * Abort the current processing, and propagate the {@link Throwable} to the {@link AsyncHandler} or {@link Future} + * + * @param t the exception + */ + void abort(Throwable t); + + /** + * Touch the current instance to prevent external service to times out. + */ + void touch(); + + /** + * Adds a listener and executor to the ListenableFuture. + * The listener will be {@linkplain Executor#execute(Runnable) passed + * to the executor} for execution when the {@code Future}'s computation is + * {@linkplain Future#isDone() complete}. + *
+ * Executor can be {@code null}, in that case executor will be executed + * in the thread where completion happens. + *
+ * There is no guaranteed ordering of execution of listeners, they may get + * called in the order they were added, and they may get called out of order, + * but any listener added through this method is guaranteed to be called once + * the computation is complete. + * + * @param listener the listener to run when the computation is complete. + * @param exec the executor to run the listener in. + * @return this Future + */ + ListenableFuture addListener(Runnable listener, Executor exec); + + CompletableFuture toCompletableFuture(); + + class CompletedFailure implements ListenableFuture { + + private final ExecutionException e; + + public CompletedFailure(Throwable t) { + e = new ExecutionException(t); + } + + public CompletedFailure(String message, Throwable t) { + e = new ExecutionException(message, t); + } + + @Override + public boolean cancel(boolean mayInterruptIfRunning) { + return true; + } + + @Override + public boolean isCancelled() { + return false; + } + + @Override + public boolean isDone() { + return true; + } + + @Override + public T get() throws ExecutionException { + throw e; + } + + @Override + public T get(long timeout, TimeUnit unit) throws ExecutionException { + throw e; + } + + @Override + public void done() { + } + + @Override + public void abort(Throwable t) { + } + + @Override + public void touch() { + } + + @Override + public ListenableFuture addListener(Runnable listener, Executor exec) { + if (exec != null) { + exec.execute(listener); + } else { + listener.run(); + } + return this; + } + + @Override + public CompletableFuture toCompletableFuture() { + CompletableFuture future = new CompletableFuture<>(); + future.completeExceptionally(e); + return future; + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/Param.java b/client/src/main/java/org/asynchttpclient/Param.java new file mode 100644 index 0000000000..4f7a5530ae --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/Param.java @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import org.jetbrains.annotations.Nullable; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * A pair of (name, value) String + * + * @author slandelle + */ +public class Param { + + private final String name; + private final @Nullable String value; + + public Param(String name, @Nullable String value) { + this.name = name; + this.value = value; + } + + public static @Nullable List map2ParamList(Map> map) { + if (map == null) { + return null; + } + + List params = new ArrayList<>(map.size()); + for (Map.Entry> entries : map.entrySet()) { + String name = entries.getKey(); + for (String value : entries.getValue()) { + params.add(new Param(name, value)); + } + } + return params; + } + + public String getName() { + return name; + } + + public @Nullable String getValue() { + return value; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + (name == null ? 0 : name.hashCode()); + result = prime * result + (value == null ? 0 : value.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (!(obj instanceof Param)) { + return false; + } + Param other = (Param) obj; + if (name == null) { + if (other.name != null) { + return false; + } + } else if (!name.equals(other.name)) { + return false; + } + if (value == null) { + return other.value == null; + } else { + return value.equals(other.value); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/Realm.java b/client/src/main/java/org/asynchttpclient/Realm.java new file mode 100644 index 0000000000..c6b70a7dee --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/Realm.java @@ -0,0 +1,599 @@ +/* + * Copyright 2010-2013 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.AuthenticatorUtils; +import org.asynchttpclient.util.StringBuilderPool; +import org.asynchttpclient.util.StringUtils; +import org.jetbrains.annotations.Nullable; + +import java.nio.charset.Charset; +import java.security.MessageDigest; +import java.util.Map; +import java.util.concurrent.ThreadLocalRandom; + +import static java.nio.charset.StandardCharsets.ISO_8859_1; +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.HttpConstants.Methods.GET; +import static org.asynchttpclient.util.MessageDigestUtils.pooledMd5MessageDigest; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.util.StringUtils.appendBase16; +import static org.asynchttpclient.util.StringUtils.toHexString; + +/** + * This class is required when authentication is needed. The class support + * BASIC, DIGEST, NTLM, SPNEGO and KERBEROS. + */ +public class Realm { + + private static final String DEFAULT_NC = "00000001"; + // MD5("") + private static final String EMPTY_ENTITY_MD5 = "d41d8cd98f00b204e9800998ecf8427e"; + + private final @Nullable String principal; + private final @Nullable String password; + private final AuthScheme scheme; + private final @Nullable String realmName; + private final @Nullable String nonce; + private final @Nullable String algorithm; + private final @Nullable String response; + private final @Nullable String opaque; + private final @Nullable String qop; + private final String nc; + private final @Nullable String cnonce; + private final @Nullable Uri uri; + private final boolean usePreemptiveAuth; + private final Charset charset; + private final String ntlmHost; + private final String ntlmDomain; + private final boolean useAbsoluteURI; + private final boolean omitQuery; + private final @Nullable Map customLoginConfig; + private final @Nullable String servicePrincipalName; + private final boolean useCanonicalHostname; + private final @Nullable String loginContextName; + + private Realm(@Nullable AuthScheme scheme, + @Nullable String principal, + @Nullable String password, + @Nullable String realmName, + @Nullable String nonce, + @Nullable String algorithm, + @Nullable String response, + @Nullable String opaque, + @Nullable String qop, + String nc, + @Nullable String cnonce, + @Nullable Uri uri, + boolean usePreemptiveAuth, + Charset charset, + String ntlmDomain, + String ntlmHost, + boolean useAbsoluteURI, + boolean omitQuery, + @Nullable String servicePrincipalName, + boolean useCanonicalHostname, + @Nullable Map customLoginConfig, + @Nullable String loginContextName) { + + this.scheme = requireNonNull(scheme, "scheme"); + this.principal = principal; + this.password = password; + this.realmName = realmName; + this.nonce = nonce; + this.algorithm = algorithm; + this.response = response; + this.opaque = opaque; + this.qop = qop; + this.nc = nc; + this.cnonce = cnonce; + this.uri = uri; + this.usePreemptiveAuth = usePreemptiveAuth; + this.charset = charset; + this.ntlmDomain = ntlmDomain; + this.ntlmHost = ntlmHost; + this.useAbsoluteURI = useAbsoluteURI; + this.omitQuery = omitQuery; + this.servicePrincipalName = servicePrincipalName; + this.useCanonicalHostname = useCanonicalHostname; + this.customLoginConfig = customLoginConfig; + this.loginContextName = loginContextName; + } + + public @Nullable String getPrincipal() { + return principal; + } + + public @Nullable String getPassword() { + return password; + } + + public AuthScheme getScheme() { + return scheme; + } + + public @Nullable String getRealmName() { + return realmName; + } + + public @Nullable String getNonce() { + return nonce; + } + + public @Nullable String getAlgorithm() { + return algorithm; + } + + public @Nullable String getResponse() { + return response; + } + + public @Nullable String getOpaque() { + return opaque; + } + + public @Nullable String getQop() { + return qop; + } + + public String getNc() { + return nc; + } + + public @Nullable String getCnonce() { + return cnonce; + } + + public @Nullable Uri getUri() { + return uri; + } + + public Charset getCharset() { + return charset; + } + + /** + * Return true is preemptive authentication is enabled + * + * @return true is preemptive authentication is enabled + */ + public boolean isUsePreemptiveAuth() { + return usePreemptiveAuth; + } + + /** + * Return the NTLM domain to use. This value should map the JDK + * + * @return the NTLM domain + */ + public String getNtlmDomain() { + return ntlmDomain; + } + + /** + * Return the NTLM host. + * + * @return the NTLM host + */ + public String getNtlmHost() { + return ntlmHost; + } + + public boolean isUseAbsoluteURI() { + return useAbsoluteURI; + } + + public boolean isOmitQuery() { + return omitQuery; + } + + public @Nullable Map getCustomLoginConfig() { + return customLoginConfig; + } + + public @Nullable String getServicePrincipalName() { + return servicePrincipalName; + } + + public boolean isUseCanonicalHostname() { + return useCanonicalHostname; + } + + public @Nullable String getLoginContextName() { + return loginContextName; + } + + @Override + public String toString() { + return "Realm{" + + "principal='" + principal + '\'' + + ", password='" + password + '\'' + + ", scheme=" + scheme + + ", realmName='" + realmName + '\'' + + ", nonce='" + nonce + '\'' + + ", algorithm='" + algorithm + '\'' + + ", response='" + response + '\'' + + ", opaque='" + opaque + '\'' + + ", qop='" + qop + '\'' + + ", nc='" + nc + '\'' + + ", cnonce='" + cnonce + '\'' + + ", uri=" + uri + + ", usePreemptiveAuth=" + usePreemptiveAuth + + ", charset=" + charset + + ", ntlmHost='" + ntlmHost + '\'' + + ", ntlmDomain='" + ntlmDomain + '\'' + + ", useAbsoluteURI=" + useAbsoluteURI + + ", omitQuery=" + omitQuery + + ", customLoginConfig=" + customLoginConfig + + ", servicePrincipalName='" + servicePrincipalName + '\'' + + ", useCanonicalHostname=" + useCanonicalHostname + + ", loginContextName='" + loginContextName + '\'' + + '}'; + } + + public enum AuthScheme { + BASIC, DIGEST, NTLM, SPNEGO, KERBEROS + } + + /** + * A builder for {@link Realm} + */ + public static class Builder { + + private final @Nullable String principal; + private final @Nullable String password; + private @Nullable AuthScheme scheme; + private @Nullable String realmName; + private @Nullable String nonce; + private @Nullable String algorithm; + private @Nullable String response; + private @Nullable String opaque; + private @Nullable String qop; + private String nc = DEFAULT_NC; + private @Nullable String cnonce; + private @Nullable Uri uri; + private String methodName = GET; + private boolean usePreemptive; + private String ntlmDomain = System.getProperty("http.auth.ntlm.domain"); + private Charset charset = UTF_8; + private String ntlmHost = "localhost"; + private boolean useAbsoluteURI; + private boolean omitQuery; + /** + * Kerberos/Spnego properties + */ + private @Nullable Map customLoginConfig; + private @Nullable String servicePrincipalName; + private boolean useCanonicalHostname; + private @Nullable String loginContextName; + + public Builder() { + principal = null; + password = null; + } + + public Builder(@Nullable String principal, @Nullable String password) { + this.principal = principal; + this.password = password; + } + + public Builder setNtlmDomain(String ntlmDomain) { + this.ntlmDomain = ntlmDomain; + return this; + } + + public Builder setNtlmHost(String host) { + ntlmHost = host; + return this; + } + + public Builder setScheme(AuthScheme scheme) { + this.scheme = scheme; + return this; + } + + public Builder setRealmName(@Nullable String realmName) { + this.realmName = realmName; + return this; + } + + public Builder setNonce(@Nullable String nonce) { + this.nonce = nonce; + return this; + } + + public Builder setAlgorithm(@Nullable String algorithm) { + this.algorithm = algorithm; + return this; + } + + public Builder setResponse(String response) { + this.response = response; + return this; + } + + public Builder setOpaque(@Nullable String opaque) { + this.opaque = opaque; + return this; + } + + public Builder setQop(@Nullable String qop) { + if (isNonEmpty(qop)) { + this.qop = qop; + } + return this; + } + + public Builder setNc(String nc) { + this.nc = nc; + return this; + } + + public Builder setUri(@Nullable Uri uri) { + this.uri = uri; + return this; + } + + public Builder setMethodName(String methodName) { + this.methodName = methodName; + return this; + } + + public Builder setUsePreemptiveAuth(boolean usePreemptiveAuth) { + usePreemptive = usePreemptiveAuth; + return this; + } + + public Builder setUseAbsoluteURI(boolean useAbsoluteURI) { + this.useAbsoluteURI = useAbsoluteURI; + return this; + } + + public Builder setOmitQuery(boolean omitQuery) { + this.omitQuery = omitQuery; + return this; + } + + public Builder setCharset(Charset charset) { + this.charset = charset; + return this; + } + + public Builder setCustomLoginConfig(@Nullable Map customLoginConfig) { + this.customLoginConfig = customLoginConfig; + return this; + } + + public Builder setServicePrincipalName(@Nullable String servicePrincipalName) { + this.servicePrincipalName = servicePrincipalName; + return this; + } + + public Builder setUseCanonicalHostname(boolean useCanonicalHostname) { + this.useCanonicalHostname = useCanonicalHostname; + return this; + } + + public Builder setLoginContextName(@Nullable String loginContextName) { + this.loginContextName = loginContextName; + return this; + } + + private static @Nullable String parseRawQop(String rawQop) { + String[] rawServerSupportedQops = rawQop.split(","); + String[] serverSupportedQops = new String[rawServerSupportedQops.length]; + for (int i = 0; i < rawServerSupportedQops.length; i++) { + serverSupportedQops[i] = rawServerSupportedQops[i].trim(); + } + + // prefer auth over auth-int + for (String rawServerSupportedQop : serverSupportedQops) { + if ("auth".equals(rawServerSupportedQop)) { + return rawServerSupportedQop; + } + } + + for (String rawServerSupportedQop : serverSupportedQops) { + if ("auth-int".equals(rawServerSupportedQop)) { + return rawServerSupportedQop; + } + } + + return null; + } + + public Builder parseWWWAuthenticateHeader(String headerLine) { + setRealmName(match(headerLine, "realm")) + .setNonce(match(headerLine, "nonce")) + .setOpaque(match(headerLine, "opaque")) + .setScheme(isNonEmpty(nonce) ? AuthScheme.DIGEST : AuthScheme.BASIC); + String algorithm = match(headerLine, "algorithm"); + if (isNonEmpty(algorithm)) { + setAlgorithm(algorithm); + } + + // FIXME qop is different with proxy? + String rawQop = match(headerLine, "qop"); + if (rawQop != null) { + setQop(parseRawQop(rawQop)); + } + + return this; + } + + public Builder parseProxyAuthenticateHeader(String headerLine) { + setRealmName(match(headerLine, "realm")) + .setNonce(match(headerLine, "nonce")) + .setOpaque(match(headerLine, "opaque")) + .setScheme(isNonEmpty(nonce) ? AuthScheme.DIGEST : AuthScheme.BASIC); + String algorithm = match(headerLine, "algorithm"); + if (isNonEmpty(algorithm)) { + setAlgorithm(algorithm); + } + // FIXME qop is different with proxy? + setQop(match(headerLine, "qop")); + + return this; + } + + private void newCnonce(MessageDigest md) { + byte[] b = new byte[8]; + ThreadLocalRandom.current().nextBytes(b); + b = md.digest(b); + cnonce = toHexString(b); + } + + /** + * TODO: A Pattern/Matcher may be better. + */ + private static @Nullable String match(String headerLine, String token) { + if (headerLine == null) { + return null; + } + + int match = headerLine.indexOf(token); + if (match <= 0) { + return null; + } + + // = to skip + match += token.length() + 1; + int trailingComa = headerLine.indexOf(',', match); + String value = headerLine.substring(match, trailingComa > 0 ? trailingComa : headerLine.length()); + value = value.length() > 0 && value.charAt(value.length() - 1) == '"' + ? value.substring(0, value.length() - 1) + : value; + return value.charAt(0) == '"' ? value.substring(1) : value; + } + + private static byte[] md5FromRecycledStringBuilder(StringBuilder sb, MessageDigest md) { + md.update(StringUtils.charSequence2ByteBuffer(sb, ISO_8859_1)); + sb.setLength(0); + return md.digest(); + } + + private byte[] ha1(StringBuilder sb, MessageDigest md) { + // if algorithm is "MD5" or is unspecified => A1 = username ":" realm-value ":" + // passwd + // if algorithm is "MD5-sess" => A1 = MD5( username-value ":" realm-value ":" + // passwd ) ":" nonce-value ":" cnonce-value + + sb.append(principal).append(':').append(realmName).append(':').append(password); + byte[] core = md5FromRecycledStringBuilder(sb, md); + + if (algorithm == null || "MD5".equals(algorithm)) { + // A1 = username ":" realm-value ":" passwd + return core; + } + if ("MD5-sess".equals(algorithm)) { + // A1 = MD5(username ":" realm-value ":" passwd ) ":" nonce ":" cnonce + appendBase16(sb, core); + sb.append(':').append(nonce).append(':').append(cnonce); + return md5FromRecycledStringBuilder(sb, md); + } + + throw new UnsupportedOperationException("Digest algorithm not supported: " + algorithm); + } + + private byte[] ha2(StringBuilder sb, String digestUri, MessageDigest md) { + + // if qop is "auth" or is unspecified => A2 = Method ":" digest-uri-value + // if qop is "auth-int" => A2 = Method ":" digest-uri-value ":" H(entity-body) + sb.append(methodName).append(':').append(digestUri); + if ("auth-int".equals(qop)) { + // when qop == "auth-int", A2 = Method ":" digest-uri-value ":" H(entity-body) + // but we don't have the request body here + // we would need a new API + sb.append(':').append(EMPTY_ENTITY_MD5); + + } else if (qop != null && !"auth".equals(qop)) { + throw new UnsupportedOperationException("Digest qop not supported: " + qop); + } + + return md5FromRecycledStringBuilder(sb, md); + } + + private void appendMiddlePart(StringBuilder sb) { + // request-digest = MD5(H(A1) ":" nonce ":" nc ":" cnonce ":" qop ":" H(A2)) + sb.append(':').append(nonce).append(':'); + if ("auth".equals(qop) || "auth-int".equals(qop)) { + sb.append(nc).append(':').append(cnonce).append(':').append(qop).append(':'); + } + } + + private void newResponse(MessageDigest md) { + // when using preemptive auth, the request uri is missing + if (uri != null) { + // BEWARE: compute first as it uses the cached StringBuilder + String digestUri = AuthenticatorUtils.computeRealmURI(uri, useAbsoluteURI, omitQuery); + + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + + // WARNING: DON'T MOVE, BUFFER IS RECYCLED!!!! + byte[] ha1 = ha1(sb, md); + byte[] ha2 = ha2(sb, digestUri, md); + + appendBase16(sb, ha1); + appendMiddlePart(sb); + appendBase16(sb, ha2); + + byte[] responseDigest = md5FromRecycledStringBuilder(sb, md); + response = toHexString(responseDigest); + } + } + + /** + * Build a {@link Realm} + * + * @return a {@link Realm} + */ + public Realm build() { + + // Avoid generating + if (isNonEmpty(nonce)) { + MessageDigest md = pooledMd5MessageDigest(); + newCnonce(md); + newResponse(md); + } + + return new Realm(scheme, + principal, + password, + realmName, + nonce, + algorithm, + response, + opaque, + qop, + nc, + cnonce, + uri, + usePreemptive, + charset, + ntlmDomain, + ntlmHost, + useAbsoluteURI, + omitQuery, + servicePrincipalName, + useCanonicalHostname, + customLoginConfig, + loginContextName); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/Request.java b/client/src/main/java/org/asynchttpclient/Request.java new file mode 100644 index 0000000000..1d95016b36 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/Request.java @@ -0,0 +1,212 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.resolver.NameResolver; +import org.asynchttpclient.channel.ChannelPoolPartitioning; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.request.body.generator.BodyGenerator; +import org.asynchttpclient.request.body.multipart.Part; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.io.File; +import java.io.InputStream; +import java.net.InetAddress; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.time.Duration; +import java.util.List; + +/** + * The Request class can be used to construct HTTP request: + *
+ *   Request r = new RequestBuilder()
+ *      .setUrl("url")
+ *      .setRealm(
+ *          new Realm.Builder("principal", "password")
+ *              .setRealmName("MyRealm")
+ *              .setScheme(Realm.AuthScheme.BASIC)
+ *      ).build();
+ * 
+ */ +public interface Request { + + /** + * @return the request's HTTP method (GET, POST, etc.) + */ + String getMethod(); + + /** + * @return the uri + */ + Uri getUri(); + + /** + * @return the url (the uri's String form) + */ + String getUrl(); + + /** + * @return the InetAddress to be used to bypass uri's hostname resolution + */ + @Nullable + InetAddress getAddress(); + + /** + * @return the local address to bind from + */ + @Nullable + InetAddress getLocalAddress(); + + /** + * @return the HTTP headers + */ + HttpHeaders getHeaders(); + + /** + * @return the HTTP cookies + */ + List getCookies(); + + /** + * @return the request's body byte array (only non-null if it was set this way) + */ + byte @Nullable [] getByteData(); + + /** + * @return the request's body array of byte arrays (only non-null if it was set this way) + */ + @Nullable + List getCompositeByteData(); + + /** + * @return the request's body string (only non-null if it was set this way) + */ + @Nullable + String getStringData(); + + /** + * @return the request's body ByteBuffer (only non-null if it was set this way) + */ + @Nullable + ByteBuffer getByteBufferData(); + + /** + * @return the request's body ByteBuf (only non-null if it was set this way) + */ + @Nullable + ByteBuf getByteBufData(); + + /** + * @return the request's body InputStream (only non-null if it was set this way) + */ + @Nullable + InputStream getStreamData(); + + /** + * @return the request's body BodyGenerator (only non-null if it was set this way) + */ + @Nullable + BodyGenerator getBodyGenerator(); + + /** + * @return the request's form parameters + */ + List getFormParams(); + + /** + * @return the multipart parts + */ + List getBodyParts(); + + /** + * @return the virtual host to connect to + */ + @Nullable + String getVirtualHost(); + + /** + * @return the query params resolved from the url/uri + */ + List getQueryParams(); + + /** + * @return the proxy server to be used to perform this request (overrides the one defined in config) + */ + @Nullable + ProxyServer getProxyServer(); + + /** + * @return the realm to be used to perform this request (overrides the one defined in config) + */ + @Nullable + Realm getRealm(); + + /** + * @return the file to be uploaded + */ + @Nullable + File getFile(); + + /** + * @return if this request is to follow redirects. Non null values means "override config value". + */ + @Nullable + Boolean getFollowRedirect(); + + /** + * @return the request timeout. Non zero values means "override config value". + */ + Duration getRequestTimeout(); + + /** + * @return the read timeout. Non-zero values means "override config value". + */ + Duration getReadTimeout(); + + /** + * @return the range header value, or 0 is not set. + */ + long getRangeOffset(); + + /** + * @return the charset value used when decoding the request's body. + */ + @Nullable + Charset getCharset(); + + /** + * @return the strategy to compute ChannelPool's keys + */ + ChannelPoolPartitioning getChannelPoolPartitioning(); + + /** + * @return the NameResolver to be used to resolve hostnams's IP + */ + NameResolver getNameResolver(); + + /** + * @return a new request builder using this request as a prototype + */ + default RequestBuilder toBuilder() { + return new RequestBuilder(this); + } +} diff --git a/client/src/main/java/org/asynchttpclient/RequestBuilder.java b/client/src/main/java/org/asynchttpclient/RequestBuilder.java new file mode 100644 index 0000000000..9b4491ffc3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/RequestBuilder.java @@ -0,0 +1,45 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import static org.asynchttpclient.util.HttpConstants.Methods.GET; + +/** + * Builder for a {@link Request}. Warning: mutable and not thread-safe! Beware that it holds a reference to the Request instance it builds, so modifying the builder will modify the + * request even after it has been built. + */ +public class RequestBuilder extends RequestBuilderBase { + + public RequestBuilder() { + this(GET); + } + + public RequestBuilder(String method) { + this(method, false); + } + + public RequestBuilder(String method, boolean disableUrlEncoding) { + super(method, disableUrlEncoding); + } + + public RequestBuilder(String method, boolean disableUrlEncoding, boolean validateHeaders) { + super(method, disableUrlEncoding, validateHeaders); + } + + RequestBuilder(Request prototype) { + super(prototype); + } +} diff --git a/client/src/main/java/org/asynchttpclient/RequestBuilderBase.java b/client/src/main/java/org/asynchttpclient/RequestBuilderBase.java new file mode 100644 index 0000000000..dbc5e41442 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/RequestBuilderBase.java @@ -0,0 +1,693 @@ +/* + * Copyright 2010-2013 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.resolver.DefaultNameResolver; +import io.netty.resolver.NameResolver; +import io.netty.util.concurrent.ImmediateEventExecutor; +import org.asynchttpclient.channel.ChannelPoolPartitioning; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.request.body.generator.BodyGenerator; +import org.asynchttpclient.request.body.multipart.Part; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.EnsuresNonNull; +import org.asynchttpclient.util.UriEncoder; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.InputStream; +import java.net.InetAddress; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.util.HttpUtils.extractContentTypeCharsetAttribute; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.util.MiscUtils.withDefault; + +/** + * Builder for {@link Request} + * + * @param the builder type + */ +public abstract class RequestBuilderBase> { + + private static final Logger LOGGER = LoggerFactory.getLogger(RequestBuilderBase.class); + private static final Uri DEFAULT_REQUEST_URL = Uri.create("http://localhost/"); + public static final NameResolver DEFAULT_NAME_RESOLVER = new DefaultNameResolver(ImmediateEventExecutor.INSTANCE); + // builder only fields + protected UriEncoder uriEncoder; + protected @Nullable List queryParams; + protected @Nullable SignatureCalculator signatureCalculator; + + // request fields + protected String method; + protected @Nullable Uri uri; + protected @Nullable InetAddress address; + protected @Nullable InetAddress localAddress; + protected HttpHeaders headers; + protected @Nullable ArrayList cookies; + protected byte @Nullable [] byteData; + protected @Nullable List compositeByteData; + protected @Nullable String stringData; + protected @Nullable ByteBuffer byteBufferData; + protected @Nullable ByteBuf byteBufData; + protected @Nullable InputStream streamData; + protected @Nullable BodyGenerator bodyGenerator; + protected @Nullable List formParams; + protected @Nullable List bodyParts; + protected @Nullable String virtualHost; + protected @Nullable ProxyServer proxyServer; + protected @Nullable Realm realm; + protected @Nullable File file; + protected @Nullable Boolean followRedirect; + protected @Nullable Duration requestTimeout; + protected @Nullable Duration readTimeout; + protected long rangeOffset; + protected @Nullable Charset charset; + protected ChannelPoolPartitioning channelPoolPartitioning = ChannelPoolPartitioning.PerHostChannelPoolPartitioning.INSTANCE; + protected NameResolver nameResolver = DEFAULT_NAME_RESOLVER; + + protected RequestBuilderBase(String method, boolean disableUrlEncoding) { + this(method, disableUrlEncoding, true); + } + + protected RequestBuilderBase(String method, boolean disableUrlEncoding, boolean validateHeaders) { + this.method = method; + uriEncoder = UriEncoder.uriEncoder(disableUrlEncoding); + headers = new DefaultHttpHeaders(validateHeaders); + } + + protected RequestBuilderBase(Request prototype) { + this(prototype, false, false); + } + + protected RequestBuilderBase(Request prototype, boolean disableUrlEncoding, boolean validateHeaders) { + method = prototype.getMethod(); + uriEncoder = UriEncoder.uriEncoder(disableUrlEncoding); + uri = prototype.getUri(); + address = prototype.getAddress(); + localAddress = prototype.getLocalAddress(); + headers = new DefaultHttpHeaders(validateHeaders); + headers.add(prototype.getHeaders()); + if (isNonEmpty(prototype.getCookies())) { + cookies = new ArrayList<>(prototype.getCookies()); + } + byteData = prototype.getByteData(); + compositeByteData = prototype.getCompositeByteData(); + stringData = prototype.getStringData(); + byteBufferData = prototype.getByteBufferData(); + byteBufData = prototype.getByteBufData(); + streamData = prototype.getStreamData(); + bodyGenerator = prototype.getBodyGenerator(); + if (isNonEmpty(prototype.getFormParams())) { + formParams = new ArrayList<>(prototype.getFormParams()); + } + if (isNonEmpty(prototype.getBodyParts())) { + bodyParts = new ArrayList<>(prototype.getBodyParts()); + } + virtualHost = prototype.getVirtualHost(); + proxyServer = prototype.getProxyServer(); + realm = prototype.getRealm(); + file = prototype.getFile(); + followRedirect = prototype.getFollowRedirect(); + requestTimeout = prototype.getRequestTimeout(); + readTimeout = prototype.getReadTimeout(); + rangeOffset = prototype.getRangeOffset(); + charset = prototype.getCharset(); + channelPoolPartitioning = prototype.getChannelPoolPartitioning(); + nameResolver = prototype.getNameResolver(); + } + + @SuppressWarnings("unchecked") + private T asDerivedType() { + return (T) this; + } + + public T setUrl(String url) { + return setUri(Uri.create(url)); + } + + public T setUri(Uri uri) { + this.uri = uri; + return asDerivedType(); + } + + public T setAddress(InetAddress address) { + this.address = address; + return asDerivedType(); + } + + public T setLocalAddress(InetAddress address) { + localAddress = address; + return asDerivedType(); + } + + public T setVirtualHost(String virtualHost) { + this.virtualHost = virtualHost; + return asDerivedType(); + } + + /** + * Remove all added headers + * + * @return {@code this} + */ + public T clearHeaders() { + headers.clear(); + return asDerivedType(); + } + + /** + * @param name header name + * @param value header value to set + * @return {@code this} + * @see #setHeader(CharSequence, Object) + */ + public T setHeader(CharSequence name, String value) { + return setHeader(name, (Object) value); + } + + /** + * Set uni-value header for the request + * + * @param name header name + * @param value header value to set + * @return {@code this} + */ + public T setHeader(CharSequence name, Object value) { + headers.set(name, value); + return asDerivedType(); + } + + /** + * Set multi-values header for the request + * + * @param name header name + * @param values {@code Iterable} with multiple header values to set + * @return {@code this} + */ + public T setHeader(CharSequence name, Iterable values) { + headers.set(name, values); + return asDerivedType(); + } + + /** + * @param name header name + * @param value header value to add + * @return {@code this} + * @see #addHeader(CharSequence, Object) + */ + public T addHeader(CharSequence name, String value) { + return addHeader(name, (Object) value); + } + + /** + * Add a header value for the request. If a header with {@code name} was set up for this request already - + * call will add one more header value and convert it to multi-value header + * + * @param name header name + * @param value header value to add + * @return {@code this} + */ + public T addHeader(CharSequence name, Object value) { + if (value == null) { + LOGGER.warn("Value was null, set to \"\""); + value = ""; + } + + headers.add(name, value); + return asDerivedType(); + } + + /** + * Add header values for the request. If a header with {@code name} was set up for this request already - + * call will add more header values and convert it to multi-value header + * + * @param name header name + * @param values {@code Iterable} with multiple header values to add + * @return {@code} + */ + public T addHeader(CharSequence name, Iterable values) { + headers.add(name, values); + return asDerivedType(); + } + + public T setHeaders(HttpHeaders headers) { + if (headers == null) { + this.headers.clear(); + } else { + this.headers = headers; + } + return asDerivedType(); + } + + /** + * Set request headers using a map {@code headers} of pair (Header name, Header values) + * This method could be used to set up multivalued headers + * + * @param headers map of header names as the map keys and header values {@link Iterable} as the map values + * @return {@code this} + */ + public T setHeaders(Map> headers) { + clearHeaders(); + if (headers != null) { + headers.forEach((name, values) -> this.headers.add(name, values)); + } + return asDerivedType(); + } + + /** + * Set single-value request headers using a map {@code headers} of pairs (Header name, Header value). + * To set headers with multiple values use {@link #setHeaders(Map)} + * + * @param headers map of header names as the map keys and header values as the map values + * @return {@code this} + */ + public T setSingleHeaders(Map headers) { + clearHeaders(); + if (headers != null) { + headers.forEach((name, value) -> this.headers.add(name, value)); + } + return asDerivedType(); + } + + @EnsuresNonNull("cookies") + private void lazyInitCookies() { + if (cookies == null) { + cookies = new ArrayList<>(3); + } + } + + public T setCookies(Collection cookies) { + this.cookies = new ArrayList<>(cookies); + return asDerivedType(); + } + + public T addCookie(Cookie cookie) { + lazyInitCookies(); + cookies.add(cookie); + return asDerivedType(); + } + + /** + * Add/replace a cookie based on its name + * + * @param cookie the new cookie + * @return this + */ + public T addOrReplaceCookie(Cookie cookie) { + return maybeAddOrReplaceCookie(cookie, true); + } + + /** + * Add a cookie based on its name, if it does not exist yet. Cookies that + * are already set will be ignored. + * + * @param cookie the new cookie + * @return this + */ + public T addCookieIfUnset(Cookie cookie) { + return maybeAddOrReplaceCookie(cookie, false); + } + + private T maybeAddOrReplaceCookie(Cookie cookie, boolean allowReplace) { + String cookieKey = cookie.name(); + boolean replace = false; + int index = 0; + lazyInitCookies(); + for (Cookie c : cookies) { + if (c.name().equals(cookieKey)) { + replace = true; + break; + } + + index++; + } + if (!replace) { + cookies.add(cookie); + } else if (allowReplace) { + cookies.set(index, cookie); + } + return asDerivedType(); + } + + public void resetCookies() { + if (cookies != null) { + cookies.clear(); + } + } + + public void resetQuery() { + queryParams = null; + if (uri != null) { + uri = uri.withNewQuery(null); + } + } + + public void resetFormParams() { + formParams = null; + } + + public void resetNonMultipartData() { + byteData = null; + compositeByteData = null; + byteBufferData = null; + byteBufData = null; + stringData = null; + streamData = null; + bodyGenerator = null; + } + + public void resetMultipartData() { + bodyParts = null; + } + + public T setBody(File file) { + this.file = file; + return asDerivedType(); + } + + private void resetBody() { + resetFormParams(); + resetNonMultipartData(); + resetMultipartData(); + } + + public T setBody(byte[] data) { + resetBody(); + byteData = data; + return asDerivedType(); + } + + public T setBody(List data) { + resetBody(); + compositeByteData = data; + return asDerivedType(); + } + + public T setBody(String data) { + resetBody(); + stringData = data; + return asDerivedType(); + } + + public T setBody(ByteBuffer data) { + resetBody(); + byteBufferData = data; + return asDerivedType(); + } + + public T setBody(ByteBuf data) { + resetBody(); + byteBufData = data; + return asDerivedType(); + } + + public T setBody(InputStream stream) { + resetBody(); + streamData = stream; + return asDerivedType(); + } + + public T setBody(BodyGenerator bodyGenerator) { + this.bodyGenerator = bodyGenerator; + return asDerivedType(); + } + + @EnsuresNonNull("queryParams") + public T addQueryParam(String name, String value) { + if (queryParams == null) { + queryParams = new ArrayList<>(1); + } + queryParams.add(new Param(name, value)); + return asDerivedType(); + } + + @EnsuresNonNull("queryParams") + public T addQueryParams(List params) { + if (queryParams == null) { + queryParams = params; + } else { + queryParams.addAll(params); + } + return asDerivedType(); + } + + public T setQueryParams(Map> map) { + return setQueryParams(Param.map2ParamList(map)); + } + + public T setQueryParams(@Nullable List params) { + // reset existing query + if (uri != null && isNonEmpty(uri.getQuery())) { + uri = uri.withNewQuery(null); + } + queryParams = params; + return asDerivedType(); + } + + @EnsuresNonNull("formParams") + public T addFormParam(String name, String value) { + resetNonMultipartData(); + resetMultipartData(); + if (formParams == null) { + formParams = new ArrayList<>(1); + } + formParams.add(new Param(name, value)); + return asDerivedType(); + } + + public T setFormParams(Map> map) { + return setFormParams(Param.map2ParamList(map)); + } + + public T setFormParams(@Nullable List params) { + resetNonMultipartData(); + resetMultipartData(); + formParams = params; + return asDerivedType(); + } + + @EnsuresNonNull("bodyParts") + public T addBodyPart(Part bodyPart) { + resetFormParams(); + resetNonMultipartData(); + if (bodyParts == null) { + bodyParts = new ArrayList<>(); + } + bodyParts.add(bodyPart); + return asDerivedType(); + } + + @EnsuresNonNull("bodyParts") + public T setBodyParts(List bodyParts) { + this.bodyParts = new ArrayList<>(bodyParts); + return asDerivedType(); + } + + public T setProxyServer(ProxyServer proxyServer) { + this.proxyServer = proxyServer; + return asDerivedType(); + } + + public T setProxyServer(ProxyServer.Builder proxyServerBuilder) { + proxyServer = proxyServerBuilder.build(); + return asDerivedType(); + } + + public T setRealm(Realm.Builder realm) { + this.realm = realm.build(); + return asDerivedType(); + } + + public T setRealm(Realm realm) { + this.realm = realm; + return asDerivedType(); + } + + public T setFollowRedirect(boolean followRedirect) { + this.followRedirect = followRedirect; + return asDerivedType(); + } + + public T setRequestTimeout(Duration requestTimeout) { + this.requestTimeout = requestTimeout; + return asDerivedType(); + } + + public T setReadTimeout(Duration readTimeout) { + this.readTimeout = readTimeout; + return asDerivedType(); + } + + public T setRangeOffset(long rangeOffset) { + this.rangeOffset = rangeOffset; + return asDerivedType(); + } + + public T setMethod(String method) { + this.method = method; + return asDerivedType(); + } + + public T setCharset(Charset charset) { + this.charset = charset; + return asDerivedType(); + } + + public T setChannelPoolPartitioning(ChannelPoolPartitioning channelPoolPartitioning) { + this.channelPoolPartitioning = channelPoolPartitioning; + return asDerivedType(); + } + + public T setNameResolver(NameResolver nameResolver) { + this.nameResolver = nameResolver; + return asDerivedType(); + } + + public T setSignatureCalculator(@Nullable SignatureCalculator signatureCalculator) { + this.signatureCalculator = signatureCalculator; + return asDerivedType(); + } + + private RequestBuilderBase executeSignatureCalculator() { + if (signatureCalculator == null) { + return this; + } + + // build a first version of the request, without signatureCalculator in play + RequestBuilder rb = new RequestBuilder(method); + // make copy of mutable collections, so we don't risk affecting + // original RequestBuilder + // call setFormParams first as it resets other fields + if (formParams != null) { + rb.setFormParams(formParams); + } + if (headers != null) { + rb.headers.add(headers); + } + if (cookies != null) { + rb.setCookies(cookies); + } + if (bodyParts != null) { + rb.setBodyParts(bodyParts); + } + + // copy all other fields + // but rb.signatureCalculator, that's the whole point here + rb.uriEncoder = uriEncoder; + rb.queryParams = queryParams; + rb.uri = uri; + rb.address = address; + rb.localAddress = localAddress; + rb.byteData = byteData; + rb.compositeByteData = compositeByteData; + rb.stringData = stringData; + rb.byteBufferData = byteBufferData; + rb.byteBufData = byteBufData; + rb.streamData = streamData; + rb.bodyGenerator = bodyGenerator; + rb.virtualHost = virtualHost; + rb.proxyServer = proxyServer; + rb.realm = realm; + rb.file = file; + rb.followRedirect = followRedirect; + rb.requestTimeout = requestTimeout; + rb.rangeOffset = rangeOffset; + rb.charset = charset; + rb.channelPoolPartitioning = channelPoolPartitioning; + rb.nameResolver = nameResolver; + Request unsignedRequest = rb.build(); + signatureCalculator.calculateAndAddSignature(unsignedRequest, rb); + return rb; + } + + @EnsuresNonNull("charset") + private void updateCharset() { + String contentTypeHeader = headers.get(CONTENT_TYPE); + Charset contentTypeCharset = extractContentTypeCharsetAttribute(contentTypeHeader); + charset = withDefault(contentTypeCharset, withDefault(charset, UTF_8)); + if (contentTypeHeader != null && contentTypeHeader.regionMatches(true, 0, "text/", 0, 5) && contentTypeCharset == null) { + // add explicit charset to content-type header + headers.set(CONTENT_TYPE, contentTypeHeader + "; charset=" + charset.name()); + } + } + + private Uri computeUri() { + + Uri tempUri = uri; + if (tempUri == null) { + LOGGER.debug("setUrl hasn't been invoked. Using {}", DEFAULT_REQUEST_URL); + tempUri = DEFAULT_REQUEST_URL; + } else { + Uri.validateSupportedScheme(tempUri); + } + + return uriEncoder.encode(tempUri, queryParams); + } + + public Request build() { + updateCharset(); + RequestBuilderBase rb = executeSignatureCalculator(); + Uri finalUri = rb.computeUri(); + + // make copies of mutable internal collections + List cookiesCopy = rb.cookies == null ? Collections.emptyList() : new ArrayList<>(rb.cookies); + List formParamsCopy = rb.formParams == null ? Collections.emptyList() : new ArrayList<>(rb.formParams); + List bodyPartsCopy = rb.bodyParts == null ? Collections.emptyList() : new ArrayList<>(rb.bodyParts); + + return new DefaultRequest(rb.method, + finalUri, + rb.address, + rb.localAddress, + rb.headers, + cookiesCopy, + rb.byteData, + rb.compositeByteData, + rb.stringData, + rb.byteBufferData, + rb.byteBufData, + rb.streamData, + rb.bodyGenerator, + formParamsCopy, + bodyPartsCopy, + rb.virtualHost, + rb.proxyServer, + rb.realm, + rb.file, + rb.followRedirect, + rb.requestTimeout, + rb.readTimeout, + rb.rangeOffset, + rb.charset, + rb.channelPoolPartitioning, + rb.nameResolver); + } +} diff --git a/client/src/main/java/org/asynchttpclient/Response.java b/client/src/main/java/org/asynchttpclient/Response.java new file mode 100644 index 0000000000..220d989b09 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/Response.java @@ -0,0 +1,226 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import io.netty.buffer.ByteBuf; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.netty.NettyResponse; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.io.InputStream; +import java.net.SocketAddress; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; + +/** + * Represents the asynchronous HTTP response callback for an {@link AsyncCompletionHandler} + */ +public interface Response { + /** + * Returns the status code for the request. + * + * @return The status code + */ + int getStatusCode(); + + /** + * Returns the status text for the request. + * + * @return The status text + */ + String getStatusText(); + + /** + * Return the entire response body as a byte[]. + * + * @return the entire response body as a byte[]. + */ + byte[] getResponseBodyAsBytes(); + + /** + * Return the entire response body as a ByteBuffer. + * + * @return the entire response body as a ByteBuffer. + */ + ByteBuffer getResponseBodyAsByteBuffer(); + + /** + * Return the entire response body as a ByteBuf. + * + * @return the entire response body as a ByteBuf. + */ + ByteBuf getResponseBodyAsByteBuf(); + + /** + * Returns an input stream for the response body. Note that you should not try to get this more than once, and that you should not close the stream. + * + * @return The input stream + */ + InputStream getResponseBodyAsStream(); + + /** + * Return the entire response body as a String. + * + * @param charset the charset to use when decoding the stream + * @return the entire response body as a String. + */ + String getResponseBody(Charset charset); + + /** + * Return the entire response body as a String. + * + * @return the entire response body as a String. + */ + String getResponseBody(); + + /** + * Return the request {@link Uri}. Note that if the request got redirected, the value of the {@link Uri} will be the last valid redirect url. + * + * @return the request {@link Uri}. + */ + Uri getUri(); + + /** + * Return the content-type header value. + * + * @return the content-type header value. + */ + String getContentType(); + + /** + * @param name the header name + * @return the first response header value + */ + String getHeader(CharSequence name); + + /** + * Return a {@link List} of the response header value. + * + * @param name the header name + * @return the response header value + */ + List getHeaders(CharSequence name); + + HttpHeaders getHeaders(); + + /** + * Return true if the response redirects to another object. + * + * @return True if the response redirects to another object. + */ + boolean isRedirected(); + + /** + * Subclasses SHOULD implement toString() in a way that identifies the response for logging. + * + * @return the textual representation + */ + @Override + String toString(); + + /** + * @return the list of {@link Cookie}. + */ + List getCookies(); + + /** + * Return true if the response's status has been computed by an {@link AsyncHandler} + * + * @return true if the response's status has been computed by an {@link AsyncHandler} + */ + boolean hasResponseStatus(); + + /** + * Return true if the response's headers has been computed by an {@link AsyncHandler} It will return false if the either + * {@link AsyncHandler#onStatusReceived(HttpResponseStatus)} or {@link AsyncHandler#onHeadersReceived(HttpHeaders)} returned {@link AsyncHandler.State#ABORT} + * + * @return true if the response's headers has been computed by an {@link AsyncHandler} + */ + boolean hasResponseHeaders(); + + /** + * Return true if the response's body has been computed by an {@link AsyncHandler}. + * It will return false if: + *
    + *
  • either the {@link AsyncHandler#onStatusReceived(HttpResponseStatus)} returned {@link AsyncHandler.State#ABORT}
  • + *
  • or {@link AsyncHandler#onHeadersReceived(HttpHeaders)} returned {@link AsyncHandler.State#ABORT}
  • + *
  • response body was empty
  • + *
+ * + * @return true if the response's body has been computed by an {@link AsyncHandler} to new empty bytes + */ + boolean hasResponseBody(); + + /** + * Get the remote address that the client initiated the request to. + * + * @return The remote address that the client initiated the request to. May be {@code null} if asynchronous provider is unable to provide the remote address + */ + SocketAddress getRemoteAddress(); + + /** + * Get the local address that the client initiated the request from. + * + * @return The local address that the client initiated the request from. May be {@code null} if asynchronous provider is unable to provide the local address + */ + SocketAddress getLocalAddress(); + + class ResponseBuilder { + private final List bodyParts = new ArrayList<>(1); + private @Nullable HttpResponseStatus status; + private @Nullable HttpHeaders headers; + + public void accumulate(HttpResponseStatus status) { + this.status = status; + } + + public void accumulate(HttpHeaders headers) { + this.headers = this.headers == null ? headers : this.headers.add(headers); + } + + /** + * @param bodyPart a body part (possibly empty, but will be filtered out) + */ + public void accumulate(HttpResponseBodyPart bodyPart) { + if (bodyPart.length() > 0) { + bodyParts.add(bodyPart); + } + } + + /** + * Build a {@link Response} instance + * + * @return a {@link Response} instance + */ + public @Nullable Response build() { + return status == null ? null : new NettyResponse(status, headers, bodyParts); + } + + /** + * Reset the internal state of this builder. + */ + public void reset() { + bodyParts.clear(); + status = null; + headers = null; + } + } +} diff --git a/src/main/java/com/ning/http/client/SignatureCalculator.java b/client/src/main/java/org/asynchttpclient/SignatureCalculator.java similarity index 85% rename from src/main/java/com/ning/http/client/SignatureCalculator.java rename to client/src/main/java/org/asynchttpclient/SignatureCalculator.java index 8c31cc8d0d..98000f0d28 100644 --- a/src/main/java/com/ning/http/client/SignatureCalculator.java +++ b/client/src/main/java/org/asynchttpclient/SignatureCalculator.java @@ -1,7 +1,7 @@ /* * Copyright 2010 Ning, Inc. * - * Ning licenses this file to you under the Apache License, version 2.0 + * This program is licensed to you under the Apache License, version 2.0 * (the "License"); you may not use this file except in compliance with the * License. You may obtain a copy of the License at: * @@ -13,7 +13,8 @@ * License for the specific language governing permissions and limitations * under the License. */ -package com.ning.http.client; +package org.asynchttpclient; + /** * Interface that allows injecting signature calculator into @@ -22,7 +23,9 @@ * * @since 1.1 */ +@FunctionalInterface public interface SignatureCalculator { + /** * Method called when {@link RequestBuilder#build} method is called. * Should first calculate signature information and then modify request @@ -35,6 +38,5 @@ public interface SignatureCalculator { * @param request Request that is being built; needed to access content to * be signed */ - public void calculateAndAddSignature(String url, Request request, - RequestBuilderBase requestBuilder); + void calculateAndAddSignature(Request request, RequestBuilderBase requestBuilder); } diff --git a/client/src/main/java/org/asynchttpclient/SslEngineFactory.java b/client/src/main/java/org/asynchttpclient/SslEngineFactory.java new file mode 100644 index 0000000000..15ec9748e4 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/SslEngineFactory.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import javax.net.ssl.SSLEngine; +import javax.net.ssl.SSLException; + +@FunctionalInterface +public interface SslEngineFactory { + + /** + * Creates a new {@link SSLEngine}. + * + * @param config the client config + * @param peerHost the peer hostname + * @param peerPort the peer port + * @return new engine + */ + SSLEngine newSslEngine(AsyncHttpClientConfig config, String peerHost, int peerPort); + + /** + * Perform any necessary one-time configuration. This will be called just once before {@code newSslEngine} is called + * for the first time. + * + * @param config the client config + * @throws SSLException if initialization fails. If an exception is thrown, the instance will not be used as client + * creation will fail. + */ + default void init(AsyncHttpClientConfig config) throws SSLException { + // no op + } + + /** + * Perform any necessary cleanup. + */ + default void destroy() { + // no op + } +} diff --git a/client/src/main/java/org/asynchttpclient/channel/ChannelPool.java b/client/src/main/java/org/asynchttpclient/channel/ChannelPool.java new file mode 100755 index 0000000000..4f2bc3b9b9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/channel/ChannelPool.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.channel; + +import io.netty.channel.Channel; +import org.jetbrains.annotations.Nullable; + +import java.util.Map; +import java.util.function.Predicate; + +public interface ChannelPool { + + /** + * Add a channel to the pool + * + * @param channel an I/O channel + * @param partitionKey a key used to retrieve the cached channel + * @return true if added. + */ + boolean offer(Channel channel, Object partitionKey); + + /** + * Remove the channel associated with the uri. + * + * @param partitionKey the partition used when invoking offer + * @return the channel associated with the uri + */ + @Nullable + Channel poll(Object partitionKey); + + /** + * Remove all channels from the cache. A channel might have been associated + * with several uri. + * + * @param channel a channel + * @return the true if the channel has been removed + */ + boolean removeAll(Channel channel); + + /** + * Return true if a channel can be cached. An implementation can decide based + * on some rules to allow caching Calling this method is equivalent of + * checking the returned value of {@link ChannelPool#offer(Channel, Object)} + * + * @return true if a channel can be cached. + */ + boolean isOpen(); + + /** + * Destroy all channels that has been cached by this instance. + */ + void destroy(); + + /** + * Flush partitions based on a predicate + * + * @param predicate the predicate + */ + void flushPartitions(Predicate predicate); + + /** + * @return The number of idle channels per host. + */ + Map getIdleChannelCountPerHost(); +} diff --git a/client/src/main/java/org/asynchttpclient/channel/ChannelPoolPartitioning.java b/client/src/main/java/org/asynchttpclient/channel/ChannelPoolPartitioning.java new file mode 100644 index 0000000000..324a4ce343 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/channel/ChannelPoolPartitioning.java @@ -0,0 +1,117 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.channel; + +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.proxy.ProxyType; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.util.Objects; + +@FunctionalInterface +public interface ChannelPoolPartitioning { + + Object getPartitionKey(Uri uri, String virtualHost, ProxyServer proxyServer); + + enum PerHostChannelPoolPartitioning implements ChannelPoolPartitioning { + + INSTANCE; + + @Override + public Object getPartitionKey(Uri uri, @Nullable String virtualHost, @Nullable ProxyServer proxyServer) { + String targetHostBaseUrl = uri.getBaseUrl(); + if (proxyServer == null) { + if (virtualHost == null) { + return targetHostBaseUrl; + } else { + return new CompositePartitionKey( + targetHostBaseUrl, + virtualHost, + null, + 0, + null); + } + } else { + return new CompositePartitionKey( + targetHostBaseUrl, + virtualHost, + proxyServer.getHost(), + uri.isSecured() && proxyServer.getProxyType() == ProxyType.HTTP ? + proxyServer.getSecuredPort() : + proxyServer.getPort(), + proxyServer.getProxyType()); + } + } + } + + class CompositePartitionKey { + private final String targetHostBaseUrl; + private final @Nullable String virtualHost; + private final @Nullable String proxyHost; + private final int proxyPort; + private final @Nullable ProxyType proxyType; + + CompositePartitionKey(String targetHostBaseUrl, @Nullable String virtualHost, @Nullable String proxyHost, int proxyPort, @Nullable ProxyType proxyType) { + this.targetHostBaseUrl = targetHostBaseUrl; + this.virtualHost = virtualHost; + this.proxyHost = proxyHost; + this.proxyPort = proxyPort; + this.proxyType = proxyType; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + + CompositePartitionKey that = (CompositePartitionKey) o; + + if (proxyPort != that.proxyPort) { + return false; + } + if (!Objects.equals(targetHostBaseUrl, that.targetHostBaseUrl)) { + return false; + } + if (!Objects.equals(virtualHost, that.virtualHost)) { + return false; + } + if (!Objects.equals(proxyHost, that.proxyHost)) { + return false; + } + return proxyType == that.proxyType; + } + + @Override + public int hashCode() { + return Objects.hash(targetHostBaseUrl, virtualHost, proxyHost, proxyPort, proxyType); + } + + @Override + public String toString() { + return "CompositePartitionKey(" + + "targetHostBaseUrl=" + targetHostBaseUrl + + ", virtualHost=" + virtualHost + + ", proxyHost=" + proxyHost + + ", proxyPort=" + proxyPort + + ", proxyType=" + proxyType; + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/channel/DefaultKeepAliveStrategy.java b/client/src/main/java/org/asynchttpclient/channel/DefaultKeepAliveStrategy.java new file mode 100644 index 0000000000..f1b5cc9516 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/channel/DefaultKeepAliveStrategy.java @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.channel; + +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.HttpUtil; +import org.asynchttpclient.Request; + +import java.net.InetSocketAddress; + +import static io.netty.handler.codec.http.HttpHeaderValues.CLOSE; + +/** + * Connection strategy implementing standard HTTP 1.0/1.1 behavior. + */ +public class DefaultKeepAliveStrategy implements KeepAliveStrategy { + + /** + * Implemented in accordance with RFC 7230 section 6.1 ... + */ + @Override + public boolean keepAlive(InetSocketAddress remoteAddress, Request ahcRequest, HttpRequest request, HttpResponse response) { + return HttpUtil.isKeepAlive(response) && + HttpUtil.isKeepAlive(request) && + // support non-standard Proxy-Connection + !response.headers().contains("Proxy-Connection", CLOSE, true); + } +} diff --git a/client/src/main/java/org/asynchttpclient/channel/KeepAliveStrategy.java b/client/src/main/java/org/asynchttpclient/channel/KeepAliveStrategy.java new file mode 100644 index 0000000000..e72cc8c13e --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/channel/KeepAliveStrategy.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.channel; + +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import org.asynchttpclient.Request; + +import java.net.InetSocketAddress; + +@FunctionalInterface +public interface KeepAliveStrategy { + + /** + * Determines whether the connection should be kept alive after this HTTP message exchange. + * + * @param remoteAddress the remote InetSocketAddress associated with the request + * @param ahcRequest the Request, as built by AHC + * @param nettyRequest the HTTP request sent to Netty + * @param nettyResponse the HTTP response received from Netty + * @return true if the connection should be kept alive, false if it should be closed. + */ + boolean keepAlive(InetSocketAddress remoteAddress, Request ahcRequest, HttpRequest nettyRequest, HttpResponse nettyResponse); +} diff --git a/client/src/main/java/org/asynchttpclient/channel/NoopChannelPool.java b/client/src/main/java/org/asynchttpclient/channel/NoopChannelPool.java new file mode 100644 index 0000000000..ae3aab81a3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/channel/NoopChannelPool.java @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.channel; + +import io.netty.channel.Channel; +import org.jetbrains.annotations.Nullable; + +import java.util.Collections; +import java.util.Map; +import java.util.function.Predicate; + +/** + * A {@link ChannelPool} implementation that doesn't pool anything. + */ +public enum NoopChannelPool implements ChannelPool { + + INSTANCE; + + /** + * @return always false since this is a {@link NoopChannelPool} + */ + @Override + public boolean offer(Channel channel, Object partitionKey) { + return false; + } + + /** + * @return always null since this is a {@link NoopChannelPool} + */ + @Override + public @Nullable Channel poll(Object partitionKey) { + return null; + } + + /** + * @return always false since this is a {@link NoopChannelPool} + */ + @Override + public boolean removeAll(Channel channel) { + return false; + } + + /** + * @return always true since this is a {@link NoopChannelPool} + */ + @Override + public boolean isOpen() { + return true; + } + + /** + * Does nothing since this is a {@link NoopChannelPool} + */ + @Override + public void destroy() { + } + + /** + * Does nothing since this is a {@link NoopChannelPool} + */ + @Override + public void flushPartitions(Predicate predicate) { + } + + /** + * @return always {@link Collections#emptyMap()} since this is a {@link NoopChannelPool} + */ + @Override + public Map getIdleChannelCountPerHost() { + return Collections.emptyMap(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java new file mode 100644 index 0000000000..3596c67a92 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java @@ -0,0 +1,335 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.config; + +import org.jetbrains.annotations.Nullable; + +import java.io.IOException; +import java.io.InputStream; +import java.time.Duration; +import java.util.Properties; + +public final class AsyncHttpClientConfigDefaults { + + public static final String ASYNC_CLIENT_CONFIG_ROOT = "org.asynchttpclient."; + public static final String THREAD_POOL_NAME_CONFIG = "threadPoolName"; + public static final String MAX_CONNECTIONS_CONFIG = "maxConnections"; + public static final String MAX_CONNECTIONS_PER_HOST_CONFIG = "maxConnectionsPerHost"; + public static final String ACQUIRE_FREE_CHANNEL_TIMEOUT = "acquireFreeChannelTimeout"; + public static final String CONNECTION_TIMEOUT_CONFIG = "connectTimeout"; + public static final String POOLED_CONNECTION_IDLE_TIMEOUT_CONFIG = "pooledConnectionIdleTimeout"; + public static final String CONNECTION_POOL_CLEANER_PERIOD_CONFIG = "connectionPoolCleanerPeriod"; + public static final String READ_TIMEOUT_CONFIG = "readTimeout"; + public static final String REQUEST_TIMEOUT_CONFIG = "requestTimeout"; + public static final String CONNECTION_TTL_CONFIG = "connectionTtl"; + public static final String FOLLOW_REDIRECT_CONFIG = "followRedirect"; + public static final String MAX_REDIRECTS_CONFIG = "maxRedirects"; + public static final String COMPRESSION_ENFORCED_CONFIG = "compressionEnforced"; + + public static final String ENABLE_AUTOMATIC_DECOMPRESSION_CONFIG = "enableAutomaticDecompression"; + public static final String USER_AGENT_CONFIG = "userAgent"; + public static final String ENABLED_PROTOCOLS_CONFIG = "enabledProtocols"; + public static final String ENABLED_CIPHER_SUITES_CONFIG = "enabledCipherSuites"; + public static final String FILTER_INSECURE_CIPHER_SUITES_CONFIG = "filterInsecureCipherSuites"; + public static final String USE_PROXY_SELECTOR_CONFIG = "useProxySelector"; + public static final String USE_PROXY_PROPERTIES_CONFIG = "useProxyProperties"; + public static final String VALIDATE_RESPONSE_HEADERS_CONFIG = "validateResponseHeaders"; + public static final String AGGREGATE_WEBSOCKET_FRAME_FRAGMENTS_CONFIG = "aggregateWebSocketFrameFragments"; + public static final String ENABLE_WEBSOCKET_COMPRESSION_CONFIG = "enableWebSocketCompression"; + public static final String STRICT_302_HANDLING_CONFIG = "strict302Handling"; + public static final String KEEP_ALIVE_CONFIG = "keepAlive"; + public static final String MAX_REQUEST_RETRY_CONFIG = "maxRequestRetry"; + public static final String DISABLE_URL_ENCODING_FOR_BOUND_REQUESTS_CONFIG = "disableUrlEncodingForBoundRequests"; + public static final String USE_LAX_COOKIE_ENCODER_CONFIG = "useLaxCookieEncoder"; + public static final String USE_OPEN_SSL_CONFIG = "useOpenSsl"; + public static final String USE_INSECURE_TRUST_MANAGER_CONFIG = "useInsecureTrustManager"; + public static final String DISABLE_HTTPS_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG = "disableHttpsEndpointIdentificationAlgorithm"; + public static final String SSL_SESSION_CACHE_SIZE_CONFIG = "sslSessionCacheSize"; + public static final String SSL_SESSION_TIMEOUT_CONFIG = "sslSessionTimeout"; + public static final String TCP_NO_DELAY_CONFIG = "tcpNoDelay"; + public static final String SO_REUSE_ADDRESS_CONFIG = "soReuseAddress"; + public static final String SO_KEEP_ALIVE_CONFIG = "soKeepAlive"; + public static final String SO_LINGER_CONFIG = "soLinger"; + public static final String SO_SND_BUF_CONFIG = "soSndBuf"; + public static final String SO_RCV_BUF_CONFIG = "soRcvBuf"; + public static final String HTTP_CLIENT_CODEC_MAX_INITIAL_LINE_LENGTH_CONFIG = "httpClientCodecMaxInitialLineLength"; + public static final String HTTP_CLIENT_CODEC_MAX_HEADER_SIZE_CONFIG = "httpClientCodecMaxHeaderSize"; + public static final String HTTP_CLIENT_CODEC_MAX_CHUNK_SIZE_CONFIG = "httpClientCodecMaxChunkSize"; + public static final String HTTP_CLIENT_CODEC_INITIAL_BUFFER_SIZE_CONFIG = "httpClientCodecInitialBufferSize"; + public static final String DISABLE_ZERO_COPY_CONFIG = "disableZeroCopy"; + public static final String HANDSHAKE_TIMEOUT_CONFIG = "handshakeTimeout"; + public static final String CHUNKED_FILE_CHUNK_SIZE_CONFIG = "chunkedFileChunkSize"; + public static final String WEBSOCKET_MAX_BUFFER_SIZE_CONFIG = "webSocketMaxBufferSize"; + public static final String WEBSOCKET_MAX_FRAME_SIZE_CONFIG = "webSocketMaxFrameSize"; + public static final String KEEP_ENCODING_HEADER_CONFIG = "keepEncodingHeader"; + public static final String SHUTDOWN_QUIET_PERIOD_CONFIG = "shutdownQuietPeriod"; + public static final String SHUTDOWN_TIMEOUT_CONFIG = "shutdownTimeout"; + public static final String USE_NATIVE_TRANSPORT_CONFIG = "useNativeTransport"; + public static final String USE_ONLY_EPOLL_NATIVE_TRANSPORT = "useOnlyEpollNativeTransport"; + public static final String IO_THREADS_COUNT_CONFIG = "ioThreadsCount"; + public static final String HASHED_WHEEL_TIMER_TICK_DURATION = "hashedWheelTimerTickDuration"; + public static final String HASHED_WHEEL_TIMER_SIZE = "hashedWheelTimerSize"; + public static final String EXPIRED_COOKIE_EVICTION_DELAY = "expiredCookieEvictionDelay"; + + public static final String AHC_VERSION; + + static { + try (InputStream is = AsyncHttpClientConfigDefaults.class.getResourceAsStream("ahc-version.properties")) { + Properties prop = new Properties(); + prop.load(is); + AHC_VERSION = prop.getProperty("ahc.version", "UNKNOWN"); + } catch (IOException e) { + throw new ExceptionInInitializerError(e); + } + } + + private AsyncHttpClientConfigDefaults() { + } + + public static String defaultThreadPoolName() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getString(ASYNC_CLIENT_CONFIG_ROOT + THREAD_POOL_NAME_CONFIG); + } + + public static int defaultMaxConnections() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + MAX_CONNECTIONS_CONFIG); + } + + public static int defaultMaxConnectionsPerHost() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + MAX_CONNECTIONS_PER_HOST_CONFIG); + } + + public static int defaultAcquireFreeChannelTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + ACQUIRE_FREE_CHANNEL_TIMEOUT); + } + + public static Duration defaultConnectTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TIMEOUT_CONFIG); + } + + public static Duration defaultPooledConnectionIdleTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + POOLED_CONNECTION_IDLE_TIMEOUT_CONFIG); + } + + public static Duration defaultConnectionPoolCleanerPeriod() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_POOL_CLEANER_PERIOD_CONFIG); + } + + public static Duration defaultReadTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + READ_TIMEOUT_CONFIG); + } + + public static Duration defaultRequestTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + REQUEST_TIMEOUT_CONFIG); + } + + public static Duration defaultConnectionTtl() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TTL_CONFIG); + } + + public static boolean defaultFollowRedirect() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + FOLLOW_REDIRECT_CONFIG); + } + + public static int defaultMaxRedirects() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + MAX_REDIRECTS_CONFIG); + } + + public static boolean defaultCompressionEnforced() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + COMPRESSION_ENFORCED_CONFIG); + } + + public static boolean defaultEnableAutomaticDecompression() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + ENABLE_AUTOMATIC_DECOMPRESSION_CONFIG); + } + + public static String defaultUserAgent() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getString(ASYNC_CLIENT_CONFIG_ROOT + USER_AGENT_CONFIG); + } + + public static @Nullable String[] defaultEnabledProtocols() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getStringArray(ASYNC_CLIENT_CONFIG_ROOT + ENABLED_PROTOCOLS_CONFIG); + } + + public static @Nullable String[] defaultEnabledCipherSuites() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getStringArray(ASYNC_CLIENT_CONFIG_ROOT + ENABLED_CIPHER_SUITES_CONFIG); + } + + public static boolean defaultFilterInsecureCipherSuites() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + FILTER_INSECURE_CIPHER_SUITES_CONFIG); + } + + public static boolean defaultUseProxySelector() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_PROXY_SELECTOR_CONFIG); + } + + public static boolean defaultUseProxyProperties() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_PROXY_PROPERTIES_CONFIG); + } + + public static boolean defaultValidateResponseHeaders() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + VALIDATE_RESPONSE_HEADERS_CONFIG); + } + + public static boolean defaultAggregateWebSocketFrameFragments() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + AGGREGATE_WEBSOCKET_FRAME_FRAGMENTS_CONFIG); + } + + public static boolean defaultEnableWebSocketCompression() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + ENABLE_WEBSOCKET_COMPRESSION_CONFIG); + } + + public static boolean defaultStrict302Handling() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + STRICT_302_HANDLING_CONFIG); + } + + public static boolean defaultKeepAlive() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + KEEP_ALIVE_CONFIG); + } + + public static int defaultMaxRequestRetry() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + MAX_REQUEST_RETRY_CONFIG); + } + + public static boolean defaultDisableUrlEncodingForBoundRequests() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + DISABLE_URL_ENCODING_FOR_BOUND_REQUESTS_CONFIG); + } + + public static boolean defaultUseLaxCookieEncoder() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_LAX_COOKIE_ENCODER_CONFIG); + } + + public static boolean defaultUseOpenSsl() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_OPEN_SSL_CONFIG); + } + + public static boolean defaultUseInsecureTrustManager() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_INSECURE_TRUST_MANAGER_CONFIG); + } + + public static boolean defaultDisableHttpsEndpointIdentificationAlgorithm() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + DISABLE_HTTPS_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG); + } + + public static int defaultSslSessionCacheSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + SSL_SESSION_CACHE_SIZE_CONFIG); + } + + public static int defaultSslSessionTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + SSL_SESSION_TIMEOUT_CONFIG); + } + + public static boolean defaultTcpNoDelay() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + TCP_NO_DELAY_CONFIG); + } + + public static boolean defaultSoReuseAddress() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + SO_REUSE_ADDRESS_CONFIG); + } + + public static boolean defaultSoKeepAlive() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + SO_KEEP_ALIVE_CONFIG); + } + + public static int defaultSoLinger() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + SO_LINGER_CONFIG); + } + + public static int defaultSoSndBuf() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + SO_SND_BUF_CONFIG); + } + + public static int defaultSoRcvBuf() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + SO_RCV_BUF_CONFIG); + } + + public static int defaultHttpClientCodecMaxInitialLineLength() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HTTP_CLIENT_CODEC_MAX_INITIAL_LINE_LENGTH_CONFIG); + } + + public static int defaultHttpClientCodecMaxHeaderSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HTTP_CLIENT_CODEC_MAX_HEADER_SIZE_CONFIG); + } + + public static int defaultHttpClientCodecMaxChunkSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HTTP_CLIENT_CODEC_MAX_CHUNK_SIZE_CONFIG); + } + + public static int defaultHttpClientCodecInitialBufferSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HTTP_CLIENT_CODEC_INITIAL_BUFFER_SIZE_CONFIG); + } + + public static boolean defaultDisableZeroCopy() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + DISABLE_ZERO_COPY_CONFIG); + } + + public static int defaultHandshakeTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HANDSHAKE_TIMEOUT_CONFIG); + } + + public static int defaultChunkedFileChunkSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + CHUNKED_FILE_CHUNK_SIZE_CONFIG); + } + + public static int defaultWebSocketMaxBufferSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + WEBSOCKET_MAX_BUFFER_SIZE_CONFIG); + } + + public static int defaultWebSocketMaxFrameSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + WEBSOCKET_MAX_FRAME_SIZE_CONFIG); + } + + public static boolean defaultKeepEncodingHeader() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + KEEP_ENCODING_HEADER_CONFIG); + } + + public static Duration defaultShutdownQuietPeriod() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + SHUTDOWN_QUIET_PERIOD_CONFIG); + } + + public static Duration defaultShutdownTimeout() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + SHUTDOWN_TIMEOUT_CONFIG); + } + + public static boolean defaultUseNativeTransport() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_NATIVE_TRANSPORT_CONFIG); + } + + public static boolean defaultUseOnlyEpollNativeTransport() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getBoolean(ASYNC_CLIENT_CONFIG_ROOT + USE_ONLY_EPOLL_NATIVE_TRANSPORT); + } + + public static int defaultIoThreadsCount() { + int threads = AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + IO_THREADS_COUNT_CONFIG); + + // If threads value is -1 then we will automatically pick number of available processors. + if (threads == -1) { + threads = Runtime.getRuntime().availableProcessors(); + } + return threads; + } + + public static int defaultHashedWheelTimerTickDuration() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HASHED_WHEEL_TIMER_TICK_DURATION); + } + + public static int defaultHashedWheelTimerSize() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + HASHED_WHEEL_TIMER_SIZE); + } + + public static int defaultExpiredCookieEvictionDelay() { + return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + EXPIRED_COOKIE_EVICTION_DELAY); + } +} diff --git a/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigHelper.java b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigHelper.java new file mode 100644 index 0000000000..7bb87afb35 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigHelper.java @@ -0,0 +1,135 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.config; + +import org.jetbrains.annotations.Nullable; + +import java.io.IOException; +import java.io.InputStream; +import java.time.Duration; +import java.util.Properties; +import java.util.concurrent.ConcurrentHashMap; + +public final class AsyncHttpClientConfigHelper { + + @Nullable + private static volatile Config config; + + private AsyncHttpClientConfigHelper() { + } + + public static Config getAsyncHttpClientConfig() { + if (config == null) { + config = new Config(); + } + + return config; + } + + /** + * This method invalidates the property caches. So if a system property has been changed and the effect of this change is to be seen then call reloadProperties() and then + * getAsyncHttpClientConfig() to get the new property values. + */ + public static void reloadProperties() { + final Config localInstance = config; + if (localInstance != null) { + localInstance.reload(); + } + } + + public static class Config { + + public static final String DEFAULT_AHC_PROPERTIES = "ahc-default.properties"; + public static final String CUSTOM_AHC_PROPERTIES = "ahc.properties"; + + private final ConcurrentHashMap propsCache = new ConcurrentHashMap<>(); + private final Properties defaultProperties = parsePropertiesFile(DEFAULT_AHC_PROPERTIES, true); + private volatile Properties customProperties = parsePropertiesFile(CUSTOM_AHC_PROPERTIES, false); + + public void reload() { + customProperties = parsePropertiesFile(CUSTOM_AHC_PROPERTIES, false); + propsCache.clear(); + } + + /** + * Parse a property file. + * + * @param file the file to parse + * @param required if true, the file must be present + * @return the parsed properties + * @throws RuntimeException if the file is required and not present or if the file can't be parsed + */ + private Properties parsePropertiesFile(String file, boolean required) { + Properties props = new Properties(); + + try (InputStream is = getClass().getResourceAsStream(file)) { + if (is != null) { + try { + props.load(is); + } catch (IOException e) { + throw new IllegalArgumentException("Can't parse config file " + file, e); + } + } else if (required) { + throw new IllegalArgumentException("Can't locate config file " + file); + } + } catch (IOException e) { + throw new RuntimeException(e); + } + + return props; + } + + public String getString(String key) { + return propsCache.computeIfAbsent(key, k -> { + String value = System.getProperty(k); + if (value == null) { + value = customProperties.getProperty(k); + } + if (value == null) { + value = defaultProperties.getProperty(k); + } + return value; + }); + } + + @Nullable + public String[] getStringArray(String key) { + String s = getString(key); + s = s.trim(); + if (s.isEmpty()) { + return null; + } + String[] rawArray = s.split(","); + String[] array = new String[rawArray.length]; + for (int i = 0; i < rawArray.length; i++) { + array[i] = rawArray[i].trim(); + } + return array; + } + + public int getInt(String key) { + return Integer.parseInt(getString(key)); + } + + public boolean getBoolean(String key) { + return Boolean.parseBoolean(getString(key)); + } + + public Duration getDuration(String key) { + return Duration.parse(getString(key)); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/cookie/CookieEvictionTask.java b/client/src/main/java/org/asynchttpclient/cookie/CookieEvictionTask.java new file mode 100644 index 0000000000..e2141d9ef7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/cookie/CookieEvictionTask.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.cookie; + +import io.netty.util.Timeout; +import io.netty.util.TimerTask; +import org.asynchttpclient.AsyncHttpClientConfig; + +import java.util.concurrent.TimeUnit; + +/** + * Evicts expired cookies from the {@linkplain CookieStore} periodically. + * The default delay is 30 seconds. You may override the default using + * {@linkplain AsyncHttpClientConfig#expiredCookieEvictionDelay()}. + */ +public class CookieEvictionTask implements TimerTask { + + private final long evictDelayInMs; + private final CookieStore cookieStore; + + public CookieEvictionTask(long evictDelayInMs, CookieStore cookieStore) { + this.evictDelayInMs = evictDelayInMs; + this.cookieStore = cookieStore; + } + + @Override + public void run(Timeout timeout) throws Exception { + cookieStore.evictExpired(); + timeout.timer().newTimeout(this, evictDelayInMs, TimeUnit.MILLISECONDS); + } +} diff --git a/client/src/main/java/org/asynchttpclient/cookie/CookieStore.java b/client/src/main/java/org/asynchttpclient/cookie/CookieStore.java new file mode 100644 index 0000000000..d19a0d13e9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/cookie/CookieStore.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.cookie; + +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.Counted; + +import java.net.CookieManager; +import java.util.List; +import java.util.function.Predicate; + +/** + * This interface represents an abstract store for {@link Cookie} objects. + * + *

{@link CookieManager} will call {@code CookieStore.add} to save cookies + * for every incoming HTTP response, and call {@code CookieStore.get} to + * retrieve cookie for every outgoing HTTP request. A CookieStore + * is responsible for removing HttpCookie instances which have expired. + * + * @since 2.1 + */ +public interface CookieStore extends Counted { + + /** + * Adds one {@link Cookie} to the store. This is called for every incoming HTTP response. + * If the given cookie has already expired it will not be added. + * + *

A cookie to store may or may not be associated with a URI. If it + * is not associated with a URI, the cookie's domain and path attribute + * will indicate where it comes from. If it is associated with a URI and + * its domain and path attribute are not specified, given URI will indicate + * where this cookie comes from. + * + *

If a cookie corresponding to the given URI already exists, + * then it is replaced with the new one. + * + * @param uri the {@link Uri uri} this cookie associated with. if {@code null}, this cookie will not be associated with a URI + * @param cookie the {@link Cookie cookie} to be added + */ + void add(Uri uri, Cookie cookie); + + /** + * Retrieve cookies associated with given URI, or whose domain matches the given URI. Only cookies that + * have not expired are returned. This is called for every outgoing HTTP request. + * + * @param uri the {@link Uri uri} associated with the cookies to be returned + * @return an immutable list of Cookie, return empty list if no cookies match the given URI + */ + List get(Uri uri); + + /** + * Get all not-expired cookies in cookie store. + * + * @return an immutable list of http cookies; + * return empty list if there's no http cookie in store + */ + List getAll(); + + /** + * Remove a cookie from store. + * + * @param predicate that indicates what cookies to remove + * @return {@code true} if this store contained the specified cookie + * @throws NullPointerException if {@code cookie} is {@code null} + */ + boolean remove(Predicate predicate); + + /** + * Remove all cookies in this cookie store. + * + * @return true if any cookies were purged. + */ + boolean clear(); + + /** + * Evicts all the cookies that expired as of the time this method is run. + */ + void evictExpired(); +} diff --git a/client/src/main/java/org/asynchttpclient/cookie/ThreadSafeCookieStore.java b/client/src/main/java/org/asynchttpclient/cookie/ThreadSafeCookieStore.java new file mode 100644 index 0000000000..5832185cc5 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/cookie/ThreadSafeCookieStore.java @@ -0,0 +1,310 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.cookie; + +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.MiscUtils; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.function.Predicate; +import java.util.stream.Collectors; + +import static java.util.Objects.requireNonNull; + +public final class ThreadSafeCookieStore implements CookieStore { + + private final Map> cookieJar = new ConcurrentHashMap<>(); + private final AtomicInteger counter = new AtomicInteger(); + + @Override + public void add(Uri uri, Cookie cookie) { + String thisRequestDomain = requestDomain(uri); + String thisRequestPath = requestPath(uri); + + add(thisRequestDomain, thisRequestPath, cookie); + } + + @Override + public List get(Uri uri) { + return get(requestDomain(uri), requestPath(uri), uri.isSecured()); + } + + @Override + public List getAll() { + return cookieJar.values() + .stream() + .flatMap(map -> map.values().stream()) + .filter(pair -> !hasCookieExpired(pair.cookie, pair.createdAt)) + .map(pair -> pair.cookie) + .collect(Collectors.toList()); + } + + @Override + public boolean remove(Predicate predicate) { + final boolean[] removed = {false}; + cookieJar.forEach((key, value) -> { + if (!removed[0]) { + removed[0] = value.entrySet().removeIf(v -> predicate.test(v.getValue().cookie)); + } + }); + if (removed[0]) { + cookieJar.entrySet().removeIf(entry -> entry.getValue() == null || entry.getValue().isEmpty()); + } + return removed[0]; + } + + @Override + public boolean clear() { + boolean result = !cookieJar.isEmpty(); + cookieJar.clear(); + return result; + } + + @Override + public void evictExpired() { + removeExpired(); + } + + @Override + public int incrementAndGet() { + return counter.incrementAndGet(); + } + + @Override + public int decrementAndGet() { + return counter.decrementAndGet(); + } + + @Override + public int count() { + return counter.get(); + } + + //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// + + public Map> getUnderlying() { + return new HashMap<>(cookieJar); + } + + private static String requestDomain(Uri requestUri) { + return requestUri.getHost().toLowerCase(); + } + + private static String requestPath(Uri requestUri) { + return requestUri.getPath().isEmpty() ? "/" : requestUri.getPath(); + } + + // rfc6265#section-5.2.3 + // Let cookie-domain be the attribute-value without the leading %x2E (".") character. + private static AbstractMap.SimpleEntry cookieDomain(@Nullable String cookieDomain, String requestDomain) { + if (cookieDomain != null) { + String normalizedCookieDomain = cookieDomain.toLowerCase(); + return new AbstractMap.SimpleEntry<>( + !cookieDomain.isEmpty() && cookieDomain.charAt(0) == '.' ? + normalizedCookieDomain.substring(1) : + normalizedCookieDomain, false); + } else { + return new AbstractMap.SimpleEntry<>(requestDomain, true); + } + } + + // rfc6265#section-5.2.4 + private static String cookiePath(@Nullable String rawCookiePath, String requestPath) { + if (MiscUtils.isNonEmpty(rawCookiePath) && rawCookiePath.charAt(0) == '/') { + return rawCookiePath; + } else { + // rfc6265#section-5.1.4 + int indexOfLastSlash = requestPath.lastIndexOf('/'); + if (!requestPath.isEmpty() && requestPath.charAt(0) == '/' && indexOfLastSlash > 0) { + return requestPath.substring(0, indexOfLastSlash); + } else { + return "/"; + } + } + } + + private static boolean hasCookieExpired(Cookie cookie, long whenCreated) { + // if not specify max-age, this cookie should be discarded when user agent is to be closed, but it is not expired. + if (cookie.maxAge() == Cookie.UNDEFINED_MAX_AGE) { + return false; + } + + if (cookie.maxAge() <= 0) { + return true; + } + + if (whenCreated > 0) { + long deltaSecond = (System.currentTimeMillis() - whenCreated) / 1000; + return deltaSecond > cookie.maxAge(); + } else { + return false; + } + } + + // rfc6265#section-5.1.4 + private static boolean pathsMatch(String cookiePath, String requestPath) { + return Objects.equals(cookiePath, requestPath) || + requestPath.startsWith(cookiePath) && (cookiePath.charAt(cookiePath.length() - 1) == '/' || requestPath.charAt(cookiePath.length()) == '/'); + } + + private void add(String requestDomain, String requestPath, Cookie cookie) { + AbstractMap.SimpleEntry pair = cookieDomain(cookie.domain(), requestDomain); + String keyDomain = pair.getKey(); + boolean hostOnly = pair.getValue(); + String keyPath = cookiePath(cookie.path(), requestPath); + CookieKey key = new CookieKey(cookie.name().toLowerCase(), keyPath); + + if (hasCookieExpired(cookie, 0)) { + cookieJar.getOrDefault(keyDomain, Collections.emptyMap()).remove(key); + } else { + final Map innerMap = cookieJar.computeIfAbsent(keyDomain, domain -> new ConcurrentHashMap<>()); + innerMap.put(key, new StoredCookie(cookie, hostOnly, cookie.maxAge() != Cookie.UNDEFINED_MAX_AGE)); + } + } + + private List get(String domain, String path, boolean secure) { + boolean exactDomainMatch = true; + String subDomain = domain; + List results = null; + + while (MiscUtils.isNonEmpty(subDomain)) { + final List storedCookies = getStoredCookies(subDomain, path, secure, exactDomainMatch); + subDomain = DomainUtils.getSubDomain(subDomain); + exactDomainMatch = false; + if (storedCookies.isEmpty()) { + continue; + } + if (results == null) { + results = new ArrayList<>(4); + } + results.addAll(storedCookies); + } + + return results == null ? Collections.emptyList() : results; + } + + private List getStoredCookies(String domain, String path, boolean secure, boolean isExactMatch) { + final Map innerMap = cookieJar.get(domain); + if (innerMap == null) { + return Collections.emptyList(); + } + + return innerMap.entrySet().stream().filter(pair -> { + CookieKey key = pair.getKey(); + StoredCookie storedCookie = pair.getValue(); + boolean hasCookieExpired = hasCookieExpired(storedCookie.cookie, storedCookie.createdAt); + return !hasCookieExpired && + (isExactMatch || !storedCookie.hostOnly) && + pathsMatch(key.path, path) && + (secure || !storedCookie.cookie.isSecure()); + }).map(v -> v.getValue().cookie).collect(Collectors.toList()); + } + + private void removeExpired() { + final boolean[] removed = {false}; + + cookieJar.values() + .forEach(cookieMap -> removed[0] |= cookieMap.entrySet() + .removeIf(v -> hasCookieExpired(v.getValue().cookie, v.getValue().createdAt))); + + if (removed[0]) { + cookieJar.entrySet().removeIf(entry -> entry.getValue() == null || entry.getValue().isEmpty()); + } + } + + private static class CookieKey implements Comparable { + final String name; + final String path; + + CookieKey(String name, String path) { + this.name = name; + this.path = path; + } + + @Override + public int compareTo(@NotNull CookieKey cookieKey) { + requireNonNull(cookieKey, "Parameter can't be null"); + + int result; + if ((result = name.compareTo(cookieKey.name)) == 0) { + result = path.compareTo(cookieKey.path); + } + return result; + } + + @Override + public boolean equals(Object obj) { + return obj instanceof CookieKey && compareTo((CookieKey) obj) == 0; + } + + @Override + public int hashCode() { + return Objects.hash(name, path); + } + + @Override + public String toString() { + return String.format("%s: %s", name, path); + } + } + + private static class StoredCookie { + final Cookie cookie; + final boolean hostOnly; + final boolean persistent; + final long createdAt = System.currentTimeMillis(); + + StoredCookie(Cookie cookie, boolean hostOnly, boolean persistent) { + this.cookie = cookie; + this.hostOnly = hostOnly; + this.persistent = persistent; + } + + @Override + public String toString() { + return String.format("%s; hostOnly %s; persistent %s", cookie.toString(), hostOnly, persistent); + } + } + + public static final class DomainUtils { + private static final char DOT = '.'; + + public static @Nullable String getSubDomain(@Nullable String domain) { + if (domain == null || domain.isEmpty()) { + return null; + } + final int indexOfDot = domain.indexOf(DOT); + if (indexOfDot == -1) { + return null; + } + return domain.substring(indexOfDot + 1); + } + + private DomainUtils() { + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/ChannelClosedException.java b/client/src/main/java/org/asynchttpclient/exception/ChannelClosedException.java new file mode 100644 index 0000000000..4b63997aa4 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/ChannelClosedException.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import java.io.IOException; + +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +/** + * This exception is thrown when a channel is closed. + */ +public final class ChannelClosedException extends IOException { + + private static final long serialVersionUID = -2528693697240456658L; + public static final ChannelClosedException INSTANCE = unknownStackTrace(new ChannelClosedException(), ChannelClosedException.class, "INSTANCE"); + + private ChannelClosedException() { + super("Channel closed"); + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/FilterException.java b/client/src/main/java/org/asynchttpclient/exception/FilterException.java new file mode 100644 index 0000000000..6e5902b9b8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/FilterException.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.filter.RequestFilter; +import org.asynchttpclient.filter.ResponseFilter; + +/** + * An exception that can be thrown by an {@link AsyncHandler} to interrupt invocation of + * the {@link RequestFilter} and {@link ResponseFilter}. It also interrupts the request and response processing. + */ +public class FilterException extends Exception { + + private static final long serialVersionUID = -3963344749394925069L; + + public FilterException(final String message) { + super(message); + } + + public FilterException(final String message, final Throwable cause) { + super(message, cause); + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/PoolAlreadyClosedException.java b/client/src/main/java/org/asynchttpclient/exception/PoolAlreadyClosedException.java new file mode 100644 index 0000000000..d66c3b76a7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/PoolAlreadyClosedException.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import java.io.IOException; + +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +/** + * This exception is thrown when a channel pool is already closed. + */ +public class PoolAlreadyClosedException extends IOException { + + private static final long serialVersionUID = -3883404852005245296L; + public static final PoolAlreadyClosedException INSTANCE = unknownStackTrace(new PoolAlreadyClosedException(), PoolAlreadyClosedException.class, "INSTANCE"); + + private PoolAlreadyClosedException() { + super("Pool is already closed"); + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/RemotelyClosedException.java b/client/src/main/java/org/asynchttpclient/exception/RemotelyClosedException.java new file mode 100644 index 0000000000..2b1977a6f9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/RemotelyClosedException.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import java.io.IOException; + +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +/** + * This exception is thrown when a channel is closed by remote host. + */ +public final class RemotelyClosedException extends IOException { + + private static final long serialVersionUID = 5634105738124356785L; + public static final RemotelyClosedException INSTANCE = unknownStackTrace(new RemotelyClosedException(), RemotelyClosedException.class, "INSTANCE"); + + private RemotelyClosedException() { + super("Remotely closed"); + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsException.java b/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsException.java new file mode 100644 index 0000000000..6797c68c70 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsException.java @@ -0,0 +1,29 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import java.io.IOException; + +/** + * This exception is thrown when too many connections are opened. + */ +public class TooManyConnectionsException extends IOException { + private static final long serialVersionUID = 8645586459539317237L; + + public TooManyConnectionsException(int max) { + super("Too many connections: " + max); + } +} diff --git a/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsPerHostException.java b/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsPerHostException.java new file mode 100644 index 0000000000..e7959bb374 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/exception/TooManyConnectionsPerHostException.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.exception; + +import java.io.IOException; + +/** + * This exception is thrown when too many connections are opened to a remote host. + */ +public class TooManyConnectionsPerHostException extends IOException { + + private static final long serialVersionUID = 5702859695179937503L; + + public TooManyConnectionsPerHostException(int max) { + super("Too many connections: " + max); + } +} diff --git a/src/main/java/com/ning/http/client/filter/FilterContext.java b/client/src/main/java/org/asynchttpclient/filter/FilterContext.java similarity index 57% rename from src/main/java/com/ning/http/client/filter/FilterContext.java rename to client/src/main/java/org/asynchttpclient/filter/FilterContext.java index 91aeee1c6a..7334553894 100644 --- a/src/main/java/com/ning/http/client/filter/FilterContext.java +++ b/client/src/main/java/org/asynchttpclient/filter/FilterContext.java @@ -10,12 +10,14 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.filter; +package org.asynchttpclient.filter; -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Request; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Request; +import org.jetbrains.annotations.Nullable; import java.io.IOException; @@ -23,92 +25,85 @@ * A {@link FilterContext} can be used to decorate {@link Request} and {@link AsyncHandler} from a list of {@link RequestFilter}. * {@link RequestFilter} gets executed before the HTTP request is made to the remote server. Once the response bytes are * received, a {@link FilterContext} is then passed to the list of {@link ResponseFilter}. {@link ResponseFilter} - * gets invoked before the response gets processed, e.g. before authorization, redirection and invokation of {@link AsyncHandler} + * gets invoked before the response gets processed, e.g. before authorization, redirection and invocation of {@link AsyncHandler} * gets processed. - *

- * Invoking {@link com.ning.http.client.filter.FilterContext#getResponseStatus()} returns an instance of {@link HttpResponseStatus} + *
+ * Invoking {@link FilterContext#getResponseStatus()} returns an instance of {@link HttpResponseStatus} * that can be used to decide if the response processing should continue or not. You can stop the current response processing - * and replay the request but creating a {@link FilterContext}. The {@link com.ning.http.client.AsyncHttpProvider} + * and replay the request but creating a {@link FilterContext}. The {@link AsyncHttpClient} * will interrupt the processing and "replay" the associated {@link Request} instance. + * + * @param the handler result type */ public class FilterContext { - private final FilterContextBuilder b; + private final FilterContextBuilder builder; /** * Create a new {@link FilterContext} * - * @param b a {@link FilterContextBuilder} + * @param builder a {@link FilterContextBuilder} */ - private FilterContext(FilterContextBuilder b) { - this.b = b; + private FilterContext(FilterContextBuilder builder) { + this.builder = builder; } /** - * Return the original or decorated {@link AsyncHandler} - * * @return the original or decorated {@link AsyncHandler} */ public AsyncHandler getAsyncHandler() { - return b.asyncHandler; + return builder.asyncHandler; } /** - * Return the original or decorated {@link Request} - * * @return the original or decorated {@link Request} */ public Request getRequest() { - return b.request; + return builder.request; } /** - * Return the unprocessed response's {@link HttpResponseStatus} - * * @return the unprocessed response's {@link HttpResponseStatus} */ - public HttpResponseStatus getResponseStatus() { - return b.responseStatus; + public @Nullable HttpResponseStatus getResponseStatus() { + return builder.responseStatus; } /** - * Return the response {@link HttpResponseHeaders} - * @return + * @return the response {@link HttpHeaders} */ - public HttpResponseHeaders getResponseHeaders() { - return b.headers; + public @Nullable HttpHeaders getResponseHeaders() { + return builder.headers; } /** - * Return true if the current response's processing needs to be interrupted and a new {@link Request} be executed. - * * @return true if the current response's processing needs to be interrupted and a new {@link Request} be executed. */ public boolean replayRequest() { - return b.replayRequest; + return builder.replayRequest; } /** - * Return the {@link IOException} - * * @return the {@link IOException} */ - public IOException getIOException() { - return b.ioException; + public @Nullable IOException getIOException() { + return builder.ioException; } public static class FilterContextBuilder { - private AsyncHandler asyncHandler = null; - private Request request = null; - private HttpResponseStatus responseStatus = null; - private boolean replayRequest = false; - private IOException ioException = null; - private HttpResponseHeaders headers; - - public FilterContextBuilder() { + private AsyncHandler asyncHandler; + private Request request; + private @Nullable HttpResponseStatus responseStatus; + private boolean replayRequest; + private @Nullable IOException ioException; + private @Nullable HttpHeaders headers; + + public FilterContextBuilder(AsyncHandler asyncHandler, Request request) { + this.asyncHandler = asyncHandler; + this.request = request; } - public FilterContextBuilder(FilterContext clone) { + public FilterContextBuilder(FilterContext clone) { asyncHandler = clone.getAsyncHandler(); request = clone.getRequest(); responseStatus = clone.getResponseStatus(); @@ -120,7 +115,7 @@ public AsyncHandler getAsyncHandler() { return asyncHandler; } - public FilterContextBuilder asyncHandler(AsyncHandler asyncHandler) { + public FilterContextBuilder asyncHandler(AsyncHandler asyncHandler) { this.asyncHandler = asyncHandler; return this; } @@ -129,34 +124,33 @@ public Request getRequest() { return request; } - public FilterContextBuilder request(Request request) { + public FilterContextBuilder request(Request request) { this.request = request; return this; } - public FilterContextBuilder responseStatus(HttpResponseStatus responseStatus) { + public FilterContextBuilder responseStatus(HttpResponseStatus responseStatus) { this.responseStatus = responseStatus; return this; } - public FilterContextBuilder responseHeaders(HttpResponseHeaders headers) { + public FilterContextBuilder responseHeaders(HttpHeaders headers) { this.headers = headers; return this; } - public FilterContextBuilder replayRequest(boolean replayRequest) { + public FilterContextBuilder replayRequest(boolean replayRequest) { this.replayRequest = replayRequest; return this; } - public FilterContextBuilder ioException(IOException ioException) { + public FilterContextBuilder ioException(IOException ioException) { this.ioException = ioException; return this; } - public FilterContext build() { - return new FilterContext(this); + public FilterContext build() { + return new FilterContext<>(this); } } - } diff --git a/src/main/java/com/ning/http/client/filter/IOExceptionFilter.java b/client/src/main/java/org/asynchttpclient/filter/IOExceptionFilter.java similarity index 66% rename from src/main/java/com/ning/http/client/filter/IOExceptionFilter.java rename to client/src/main/java/org/asynchttpclient/filter/IOExceptionFilter.java index 59f5cdc6f0..182ea56e29 100644 --- a/src/main/java/com/ning/http/client/filter/IOExceptionFilter.java +++ b/client/src/main/java/org/asynchttpclient/filter/IOExceptionFilter.java @@ -10,20 +10,27 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.filter; +package org.asynchttpclient.filter; + +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Request; +import org.asynchttpclient.exception.FilterException; + +import java.io.IOException; /** - * This filter is invoked when an {@link java.io.IOException} occurs during an http transaction. + * This filter is invoked when an {@link IOException} occurs during a http transaction. */ public interface IOExceptionFilter { /** - * An {@link com.ning.http.client.AsyncHttpProvider} will invoke {@link IOExceptionFilter#filter} and will - * use the returned {@link FilterContext} to replay the {@link com.ning.http.client.Request} or abort the processing. + * An {@link AsyncHttpClient} will invoke {@link IOExceptionFilter#filter} and will + * use the returned {@link FilterContext} to replay the {@link Request} or abort the processing. * * @param ctx a {@link FilterContext} + * @param the handler result type * @return {@link FilterContext}. The {@link FilterContext} instance may not the same as the original one. * @throws FilterException to interrupt the filter processing. */ - public FilterContext filter(FilterContext ctx) throws FilterException; + FilterContext filter(FilterContext ctx) throws FilterException; } diff --git a/client/src/main/java/org/asynchttpclient/filter/ReleasePermitOnComplete.java b/client/src/main/java/org/asynchttpclient/filter/ReleasePermitOnComplete.java new file mode 100644 index 0000000000..baf8585078 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/filter/ReleasePermitOnComplete.java @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.filter; + +import org.asynchttpclient.AsyncHandler; + +import java.lang.reflect.Proxy; +import java.util.Collections; +import java.util.HashSet; +import java.util.Set; +import java.util.concurrent.Semaphore; + +/** + * Wrapper for {@link AsyncHandler}s to release a permit on {@link AsyncHandler#onCompleted()}. This is done via a dynamic proxy to preserve all interfaces of the wrapped handler. + */ +public final class ReleasePermitOnComplete { + + private ReleasePermitOnComplete() { + // Prevent outside initialization + } + + /** + * Wrap handler to release the permit of the semaphore on {@link AsyncHandler#onCompleted()}. + * + * @param handler the handler to be wrapped + * @param available the Semaphore to be released when the wrapped handler is completed + * @param the handler result type + * @return the wrapped handler + */ + @SuppressWarnings("unchecked") + public static AsyncHandler wrap(final AsyncHandler handler, final Semaphore available) { + Class handlerClass = handler.getClass(); + ClassLoader classLoader = handlerClass.getClassLoader(); + Class[] interfaces = allInterfaces(handlerClass); + + return (AsyncHandler) Proxy.newProxyInstance(classLoader, interfaces, (proxy, method, args) -> { + try { + return method.invoke(handler, args); + } finally { + switch (method.getName()) { + case "onCompleted": + case "onThrowable": + available.release(); + default: + } + } + }); + } + + /** + * Extract all interfaces of a class. + * + * @param handlerClass the handler class + * @return all interfaces implemented by this class + */ + private static Class[] allInterfaces(Class handlerClass) { + Set> allInterfaces = new HashSet<>(); + for (Class clazz = handlerClass; clazz != null; clazz = clazz.getSuperclass()) { + Collections.addAll(allInterfaces, clazz.getInterfaces()); + } + return allInterfaces.toArray(new Class[0]); + } +} diff --git a/src/main/java/com/ning/http/client/filter/RequestFilter.java b/client/src/main/java/org/asynchttpclient/filter/RequestFilter.java similarity index 77% rename from src/main/java/com/ning/http/client/filter/RequestFilter.java rename to client/src/main/java/org/asynchttpclient/filter/RequestFilter.java index 31d0749b9b..d4eaf8a328 100644 --- a/src/main/java/com/ning/http/client/filter/RequestFilter.java +++ b/client/src/main/java/org/asynchttpclient/filter/RequestFilter.java @@ -10,7 +10,10 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.filter; +package org.asynchttpclient.filter; + +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.exception.FilterException; /** * A Filter interface that gets invoked before making an actual request. @@ -18,14 +21,14 @@ public interface RequestFilter { /** - * An {@link com.ning.http.client.AsyncHttpProvider} will invoke {@link RequestFilter#filter} and will use the + * An {@link AsyncHttpClient} will invoke {@link RequestFilter#filter} and will use the * returned {@link FilterContext#getRequest()} and {@link FilterContext#getAsyncHandler()} to continue the request * processing. * * @param ctx a {@link FilterContext} + * @param the handler result type * @return {@link FilterContext}. The {@link FilterContext} instance may not the same as the original one. * @throws FilterException to interrupt the filter processing. */ - public FilterContext filter(FilterContext ctx) throws FilterException; - + FilterContext filter(FilterContext ctx) throws FilterException; } diff --git a/src/main/java/com/ning/http/client/filter/ResponseFilter.java b/client/src/main/java/org/asynchttpclient/filter/ResponseFilter.java similarity index 78% rename from src/main/java/com/ning/http/client/filter/ResponseFilter.java rename to client/src/main/java/org/asynchttpclient/filter/ResponseFilter.java index 3175dfe399..939adf6d8a 100644 --- a/src/main/java/com/ning/http/client/filter/ResponseFilter.java +++ b/client/src/main/java/org/asynchttpclient/filter/ResponseFilter.java @@ -10,25 +10,28 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.filter; +package org.asynchttpclient.filter; + +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.exception.FilterException; /** * A Filter interface that gets invoked before making the processing of the response bytes. {@link ResponseFilter} are invoked * before the actual response's status code get processed. That means authorization, proxy authentication and redirects - * processing hasn't occured when {@link ResponseFilter} gets invoked. + * processing hasn't occurred when {@link ResponseFilter} gets invoked. */ public interface ResponseFilter { /** - * An {@link com.ning.http.client.AsyncHttpProvider} will invoke {@link ResponseFilter#filter} and will use the + * An {@link AsyncHttpClient} will invoke {@link ResponseFilter#filter} and will use the * returned {@link FilterContext#replayRequest()} and {@link FilterContext#getAsyncHandler()} to decide if the response * processing can continue. If {@link FilterContext#replayRequest()} return true, a new request will be made * using {@link FilterContext#getRequest()} and the current response processing will be ignored. * * @param ctx a {@link FilterContext} + * @param the handler result type * @return {@link FilterContext}. The {@link FilterContext} instance may not the same as the original one. * @throws FilterException to interrupt the filter processing. */ - public FilterContext filter(FilterContext ctx) throws FilterException; - + FilterContext filter(FilterContext ctx) throws FilterException; } diff --git a/client/src/main/java/org/asynchttpclient/filter/ThrottleRequestFilter.java b/client/src/main/java/org/asynchttpclient/filter/ThrottleRequestFilter.java new file mode 100644 index 0000000000..3d5d9943ad --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/filter/ThrottleRequestFilter.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.filter; + +import org.asynchttpclient.exception.FilterException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +/** + * A {@link RequestFilter} throttles requests and block when the number of permits is reached, + * waiting for the response to arrives before executing the next request. + */ +public class ThrottleRequestFilter implements RequestFilter { + private static final Logger logger = LoggerFactory.getLogger(ThrottleRequestFilter.class); + private final Semaphore available; + private final int maxWait; + + public ThrottleRequestFilter(int maxConnections) { + this(maxConnections, Integer.MAX_VALUE); + } + + public ThrottleRequestFilter(int maxConnections, int maxWait) { + this(maxConnections, maxWait, false); + } + + public ThrottleRequestFilter(int maxConnections, int maxWait, boolean fair) { + this.maxWait = maxWait; + available = new Semaphore(maxConnections, fair); + } + + @Override + public FilterContext filter(FilterContext ctx) throws FilterException { + try { + if (logger.isDebugEnabled()) { + logger.debug("Current Throttling Status {}", available.availablePermits()); + } + if (!available.tryAcquire(maxWait, TimeUnit.MILLISECONDS)) { + throw new FilterException(String.format("No slot available for processing Request %s with AsyncHandler %s", ctx.getRequest(), ctx.getAsyncHandler())); + } + } catch (InterruptedException e) { + throw new FilterException(String.format("Interrupted Request %s with AsyncHandler %s", ctx.getRequest(), ctx.getAsyncHandler())); + } + + return new FilterContext.FilterContextBuilder<>(ctx) + .asyncHandler(ReleasePermitOnComplete.wrap(ctx.getAsyncHandler(), available)) + .build(); + } +} diff --git a/src/main/java/com/ning/http/client/BodyDeferringAsyncHandler.java b/client/src/main/java/org/asynchttpclient/handler/BodyDeferringAsyncHandler.java similarity index 64% rename from src/main/java/com/ning/http/client/BodyDeferringAsyncHandler.java rename to client/src/main/java/org/asynchttpclient/handler/BodyDeferringAsyncHandler.java index 3171d78aab..dc58fc2c5b 100644 --- a/src/main/java/com/ning/http/client/BodyDeferringAsyncHandler.java +++ b/client/src/main/java/org/asynchttpclient/handler/BodyDeferringAsyncHandler.java @@ -10,9 +10,14 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client; +package org.asynchttpclient.handler; -import com.ning.http.client.Response.ResponseBuilder; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.jetbrains.annotations.Nullable; import java.io.FilterInputStream; import java.io.IOException; @@ -27,25 +32,25 @@ * An AsyncHandler that returns Response (without body, so status code and * headers only) as fast as possible for inspection, but leaves you the option * to defer body consumption. - *

+ *
* This class introduces new call: getResponse(), that blocks caller thread as * long as headers are received, and return Response as soon as possible, but * still pouring response body into supplied output stream. This handler is * meant for situations when the "recommended" way (using - * client.prepareGet("http://foo.com/aResource").execute().get() + * {@code client.prepareGet("http://foo.com/aResource").execute().get()}), which * would not work for you, since a potentially large response body is about to - * be GETted, but you need headers first, or you don't know yet (depending on + * be GET-ted, but you need headers first, or you don't know yet (depending on * some logic, maybe coming from headers) where to save the body, or you just * want to leave body stream to some other component to consume it. - *

+ *
* All these above means that this AsyncHandler needs a bit of different * handling than "recommended" way. Some examples: - *

+ *
*

- *     FileOutputStream fos = ...
+ *     OutputStream fos = ...
  *     BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(fos);
  *     // client executes async
- *     Future<Response> fr = client.prepareGet("http://foo.com/aresource").execute(
+ *     Future<Response> fr = client.prepareGet("...).execute(
  * 	bdah);
  *     // main thread will block here until headers are available
  *     Response response = bdah.getResponse();
@@ -55,46 +60,46 @@
  *     // finally "join" the download
  *     fr.get();
  * 
- *

+ *
*

  *     PipedOutputStream pout = new PipedOutputStream();
- *     BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pout);
- *     // client executes async
- *     Future<Response> fr = client.prepareGet("http://foo.com/aresource").execute(bdah);
- *     // main thread will block here until headers are available
- *     Response response = bdah.getResponse();
- *     if (response.getStatusCode() == 200) {
- *      InputStream pin = new BodyDeferringInputStream(fr,new PipedInputStream(pout));
- *      // consume InputStream
- *      ...
- *     } else {
- *      // handle unexpected response status code
- *      ...
+ *     try (PipedInputStream pin = new PipedInputStream(pout)) {
+ *         BodyDeferringAsyncHandler handler = new BodyDeferringAsyncHandler(pout);
+ *         ListenableFuture<Response> respFut = client.prepareGet(getTargetUrl()).execute(handler);
+ *         Response resp = handler.getResponse();
+ *         // main thread will block here until headers are available
+ *         if (resp.getStatusCode() == 200) {
+ *             try (InputStream is = new BodyDeferringInputStream(respFut, handler, pin)) {
+ *                 // consume InputStream
+ *                 ...
+ *             }
+ *         } else {
+ *             // handle unexpected response status code
+ *             ...
+ *         }
  *     }
  * 
*/ public class BodyDeferringAsyncHandler implements AsyncHandler { - private final ResponseBuilder responseBuilder = new ResponseBuilder(); + + private final Response.ResponseBuilder responseBuilder = new Response.ResponseBuilder(); private final CountDownLatch headersArrived = new CountDownLatch(1); private final OutputStream output; - - private volatile boolean responseSet; - - private volatile Response response; - - private volatile Throwable throwable; - private final Semaphore semaphore = new Semaphore(1); + private boolean responseSet; + private volatile @Nullable Response response; + private volatile @Nullable Throwable throwable; public BodyDeferringAsyncHandler(final OutputStream os) { - this.output = os; - this.responseSet = false; + output = os; + responseSet = false; } + @Override public void onThrowable(Throwable t) { - this.throwable = t; + throwable = t; // Counting down to handle error cases too. // In "premature exceptions" cases, the onBodyPartReceived() and // onCompleted() @@ -116,21 +121,32 @@ public void onThrowable(Throwable t) { } } - public STATE onStatusReceived(HttpResponseStatus responseStatus) - throws Exception { + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { responseBuilder.reset(); responseBuilder.accumulate(responseStatus); - return STATE.CONTINUE; + return State.CONTINUE; } - public STATE onHeadersReceived(HttpResponseHeaders headers) - throws Exception { + @Override + public State onHeadersReceived(HttpHeaders headers) { responseBuilder.accumulate(headers); - return STATE.CONTINUE; + return State.CONTINUE; } - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) - throws Exception { + @Override + public State onTrailingHeadersReceived(HttpHeaders headers) { + responseBuilder.accumulate(headers); + return State.CONTINUE; + } + + @Override + public void onRetry() { + throw new UnsupportedOperationException(getClass().getSimpleName() + " cannot retry a request."); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { // body arrived, flush headers if (!responseSet) { response = responseBuilder.build(); @@ -138,8 +154,8 @@ public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) headersArrived.countDown(); } - bodyPart.writeTo(output); - return STATE.CONTINUE; + output.write(bodyPart.getBodyPartBytes()); + return State.CONTINUE; } protected void closeOut() throws IOException { @@ -150,7 +166,14 @@ protected void closeOut() throws IOException { } } - public Response onCompleted() throws IOException { + @Override + public @Nullable Response onCompleted() throws IOException { + + if (!responseSet) { + response = responseBuilder.build(); + responseSet = true; + } + // Counting down to handle error cases too. // In "normal" cases, latch is already at 0 here // But in other cases, for example when because of some error @@ -164,9 +187,7 @@ public Response onCompleted() throws IOException { try { semaphore.acquire(); if (throwable != null) { - IOException ioe = new IOException(throwable.getMessage()); - ioe.initCause(throwable); - throw ioe; + throw new IOException(throwable); } else { // sending out current response return responseBuilder.build(); @@ -179,33 +200,32 @@ public Response onCompleted() throws IOException { } /** - * This method -- unlike Future.get() -- will block only as long, + * This method -- unlike Future<Reponse>.get() -- will block only as long, * as headers arrive. This is useful for large transfers, to examine headers * ASAP, and defer body streaming to it's fine destination and prevent * unneeded bandwidth consumption. The response here will contain the very * 1st response from server, so status code and headers, but it might be * incomplete in case of broken servers sending trailing headers. In that - * case, the "usual" Future.get() method will return complete + * case, the "usual" Future<Response>.get() method will return complete * headers, but multiple invocations of getResponse() will always return the * 1st cached, probably incomplete one. Note: the response returned by this * method will contain everything except the response body itself, * so invoking any method like Response.getResponseBodyXXX() will result in - * error! Also, please not that this method might return null + * error! Also, please note that this method might return {@code null} * in case of some errors. * * @return a {@link Response} - * @throws InterruptedException + * @throws InterruptedException if the latch is interrupted + * @throws IOException if the handler completed with an exception */ - public Response getResponse() throws InterruptedException, IOException { + public @Nullable Response getResponse() throws InterruptedException, IOException { // block here as long as headers arrive headersArrived.await(); try { semaphore.acquire(); if (throwable != null) { - IOException ioe = new IOException(throwable.getMessage()); - ioe.initCause(throwable); - throw ioe; + throw new IOException(throwable.getMessage(), throwable); } else { return response; } @@ -225,8 +245,7 @@ public static class BodyDeferringInputStream extends FilterInputStream { private final BodyDeferringAsyncHandler bdah; - public BodyDeferringInputStream(final Future future, - final BodyDeferringAsyncHandler bdah, final InputStream in) { + public BodyDeferringInputStream(final Future future, final BodyDeferringAsyncHandler bdah, final InputStream in) { super(in); this.future = future; this.bdah = bdah; @@ -236,44 +255,44 @@ public BodyDeferringInputStream(final Future future, * Closes the input stream, and "joins" (wait for complete execution * together with potential exception thrown) of the async request. */ + @Override public void close() throws IOException { // close super.close(); // "join" async request try { getLastResponse(); - } catch (Exception e) { - IOException ioe = new IOException(e.getMessage()); - ioe.initCause(e); - throw ioe; + } catch (ExecutionException e) { + throw new IOException(e.getMessage(), e.getCause()); + } catch (InterruptedException e) { + throw new IOException(e.getMessage(), e); } } /** * Delegates to {@link BodyDeferringAsyncHandler#getResponse()}. Will * blocks as long as headers arrives only. Might return - * null. See + * {@code null}. See * {@link BodyDeferringAsyncHandler#getResponse()} method for details. * * @return a {@link Response} - * @throws InterruptedException + * @throws InterruptedException if the latch is interrupted + * @throws IOException if the handler completed with an exception */ - public Response getAsapResponse() throws InterruptedException, - IOException { + public @Nullable Response getAsapResponse() throws InterruptedException, IOException { return bdah.getResponse(); } /** - * Delegates to Future#get() method. Will block + * Delegates to {@code Future$lt;Response>#get()} method. Will block * as long as complete response arrives. * * @return a {@link Response} - * @throws InterruptedException - * @throws ExecutionException + * @throws ExecutionException if the computation threw an exception + * @throws InterruptedException if the current thread was interrupted */ - public Response getLastResponse() throws InterruptedException, - ExecutionException { + public Response getLastResponse() throws InterruptedException, ExecutionException { return future.get(); } } -} \ No newline at end of file +} diff --git a/client/src/main/java/org/asynchttpclient/handler/MaxRedirectException.java b/client/src/main/java/org/asynchttpclient/handler/MaxRedirectException.java new file mode 100644 index 0000000000..993f87d93e --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/handler/MaxRedirectException.java @@ -0,0 +1,29 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.handler; + +import org.asynchttpclient.DefaultAsyncHttpClientConfig; + +/** + * Thrown when the {@link DefaultAsyncHttpClientConfig#getMaxRedirects()} has been reached. + */ +public class MaxRedirectException extends Exception { + private static final long serialVersionUID = 1L; + + public MaxRedirectException(String msg) { + super(msg, null, true, false); + } +} diff --git a/src/main/java/com/ning/http/client/ProgressAsyncHandler.java b/client/src/main/java/org/asynchttpclient/handler/ProgressAsyncHandler.java similarity index 65% rename from src/main/java/com/ning/http/client/ProgressAsyncHandler.java rename to client/src/main/java/org/asynchttpclient/handler/ProgressAsyncHandler.java index 3c0363d8f0..04839e2760 100644 --- a/src/main/java/com/ning/http/client/ProgressAsyncHandler.java +++ b/client/src/main/java/org/asynchttpclient/handler/ProgressAsyncHandler.java @@ -10,7 +10,13 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client; +package org.asynchttpclient.handler; + +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.Request; + +import java.io.File; +import java.io.FileInputStream; /** * An extended {@link AsyncHandler} with two extra callback who get invoked during the content upload to a remote server. @@ -19,20 +25,20 @@ public interface ProgressAsyncHandler extends AsyncHandler { /** - * Invoked when the content (a {@link java.io.File}, {@link String} or {@link java.io.FileInputStream} has been fully + * Invoked when the content (a {@link File}, {@link String} or {@link FileInputStream}) has been fully * written on the I/O socket. * - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. + * @return a {@link AsyncHandler.State} telling to CONTINUE or ABORT the current processing. */ - STATE onHeaderWriteCompleted(); + State onHeadersWritten(); /** - * Invoked when the content (a {@link java.io.File}, {@link String} or {@link java.io.FileInputStream} has been fully + * Invoked when the content (a {@link File}, {@link String} or {@link FileInputStream}) has been fully * written on the I/O socket. * - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. + * @return a {@link AsyncHandler.State} telling to CONTINUE or ABORT the current processing. */ - STATE onContentWriteCompleted(); + State onContentWritten(); /** * Invoked when the I/O operation associated with the {@link Request} body wasn't fully written in a single I/O write @@ -41,8 +47,7 @@ public interface ProgressAsyncHandler extends AsyncHandler { * @param amount The amount of bytes to transfer. * @param current The amount of bytes transferred * @param total The total number of bytes transferred - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. + * @return a {@link AsyncHandler.State} telling to CONTINUE or ABORT the current processing. */ - STATE onContentWriteProgress(long amount, long current, long total); - + State onContentWriteProgress(long amount, long current, long total); } diff --git a/client/src/main/java/org/asynchttpclient/handler/TransferCompletionHandler.java b/client/src/main/java/org/asynchttpclient/handler/TransferCompletionHandler.java new file mode 100644 index 0000000000..e0705ad25f --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/handler/TransferCompletionHandler.java @@ -0,0 +1,203 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.handler; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncCompletionHandlerBase; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.Response; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.concurrent.ConcurrentLinkedQueue; + +/** + * A {@link AsyncHandler} that can be used to notify a set of {@link TransferListener} + *
+ *
+ *
+ * AsyncHttpClient client = new AsyncHttpClient();
+ * TransferCompletionHandler tl = new TransferCompletionHandler();
+ * tl.addTransferListener(new TransferListener() {
+ *
+ * public void onRequestHeadersSent(HttpHeaders headers) {
+ * }
+ *
+ * public void onResponseHeadersReceived(HttpHeaders headers) {
+ * }
+ *
+ * public void onBytesReceived(ByteBuffer buffer) {
+ * }
+ *
+ * public void onBytesSent(long amount, long current, long total) {
+ * }
+ *
+ * public void onRequestResponseCompleted() {
+ * }
+ *
+ * public void onThrowable(Throwable t) {
+ * }
+ * });
+ *
+ * Response response = httpClient.prepareGet("http://.../").execute(tl).get();
+ * 
+ *
+ */ +public class TransferCompletionHandler extends AsyncCompletionHandlerBase { + private static final Logger logger = LoggerFactory.getLogger(TransferCompletionHandler.class); + + private final ConcurrentLinkedQueue listeners = new ConcurrentLinkedQueue<>(); + private final boolean accumulateResponseBytes; + private @Nullable HttpHeaders headers; + + /** + * Create a TransferCompletionHandler that will not accumulate bytes. The resulting {@link Response#getResponseBody()}, + * {@link Response#getResponseBodyAsStream()} will throw an IllegalStateException if called. + */ + public TransferCompletionHandler() { + this(false); + } + + /** + * Create a TransferCompletionHandler that can or cannot accumulate bytes and make it available when {@link Response#getResponseBody()} get called. The + * default is false. + * + * @param accumulateResponseBytes true to accumulates bytes in memory. + */ + public TransferCompletionHandler(boolean accumulateResponseBytes) { + this.accumulateResponseBytes = accumulateResponseBytes; + } + + public TransferCompletionHandler addTransferListener(TransferListener t) { + listeners.offer(t); + return this; + } + + public TransferCompletionHandler removeTransferListener(TransferListener t) { + listeners.remove(t); + return this; + } + + public void headers(HttpHeaders headers) { + this.headers = headers; + } + + @Override + public State onHeadersReceived(final HttpHeaders headers) throws Exception { + fireOnHeaderReceived(headers); + return super.onHeadersReceived(headers); + } + + @Override + public State onTrailingHeadersReceived(HttpHeaders headers) throws Exception { + fireOnHeaderReceived(headers); + return super.onHeadersReceived(headers); + } + + @Override + public State onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { + State s = State.CONTINUE; + if (accumulateResponseBytes) { + s = super.onBodyPartReceived(content); + } + fireOnBytesReceived(content.getBodyPartBytes()); + return s; + } + + @Override + public @Nullable Response onCompleted(@Nullable Response response) throws Exception { + fireOnEnd(); + return response; + } + + @Override + public State onHeadersWritten() { + if (headers != null) { + fireOnHeadersSent(headers); + } + return State.CONTINUE; + } + + @Override + public State onContentWriteProgress(long amount, long current, long total) { + fireOnBytesSent(amount, current, total); + return State.CONTINUE; + } + + @Override + public void onThrowable(Throwable t) { + fireOnThrowable(t); + } + + private void fireOnHeadersSent(HttpHeaders headers) { + for (TransferListener l : listeners) { + try { + l.onRequestHeadersSent(headers); + } catch (Throwable t) { + l.onThrowable(t); + } + } + } + + private void fireOnHeaderReceived(HttpHeaders headers) { + for (TransferListener l : listeners) { + try { + l.onResponseHeadersReceived(headers); + } catch (Throwable t) { + l.onThrowable(t); + } + } + } + + private void fireOnEnd() { + for (TransferListener l : listeners) { + try { + l.onRequestResponseCompleted(); + } catch (Throwable t) { + l.onThrowable(t); + } + } + } + + private void fireOnBytesReceived(byte[] b) { + for (TransferListener l : listeners) { + try { + l.onBytesReceived(b); + } catch (Throwable t) { + l.onThrowable(t); + } + } + } + + private void fireOnBytesSent(long amount, long current, long total) { + for (TransferListener l : listeners) { + try { + l.onBytesSent(amount, current, total); + } catch (Throwable t) { + l.onThrowable(t); + } + } + } + + private void fireOnThrowable(Throwable t) { + for (TransferListener l : listeners) { + try { + l.onThrowable(t); + } catch (Throwable t2) { + logger.warn("onThrowable", t2); + } + } + } +} diff --git a/src/main/java/com/ning/http/client/listener/TransferListener.java b/client/src/main/java/org/asynchttpclient/handler/TransferListener.java similarity index 62% rename from src/main/java/com/ning/http/client/listener/TransferListener.java rename to client/src/main/java/org/asynchttpclient/handler/TransferListener.java index 580c3cba53..fd50dcf7e6 100644 --- a/src/main/java/com/ning/http/client/listener/TransferListener.java +++ b/client/src/main/java/org/asynchttpclient/handler/TransferListener.java @@ -10,51 +10,55 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.listener; +package org.asynchttpclient.handler; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; - -import java.io.IOException; -import java.nio.ByteBuffer; +import io.netty.handler.codec.http.HttpHeaders; /** - * A simple interface an application can implements in order to received byte transfer information. + * A simple interface an application can implement in order to received byte transfer information. */ public interface TransferListener { /** * Invoked when the request bytes are starting to get send. + * + * @param headers the headers */ - public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers); + void onRequestHeadersSent(HttpHeaders headers); /** * Invoked when the response bytes are starting to get received. + * + * @param headers the headers */ - public void onResponseHeadersReceived(FluentCaseInsensitiveStringsMap headers); + void onResponseHeadersReceived(HttpHeaders headers); /** * Invoked every time response's chunk are received. * - * @param buffer a {@link ByteBuffer} + * @param bytes a {@link byte} array */ - public void onBytesReceived(ByteBuffer buffer) throws IOException; + void onBytesReceived(byte[] bytes); /** * Invoked every time request's chunk are sent. * - * @param buffer a {@link ByteBuffer} + * @param amount The amount of bytes to transfer + * @param current The amount of bytes transferred + * @param total The total number of bytes transferred */ - public void onBytesSent(ByteBuffer buffer); + void onBytesSent(long amount, long current, long total); /** * Invoked when the response bytes are been fully received. */ - public void onRequestResponseCompleted(); + void onRequestResponseCompleted(); /** * Invoked when there is an unexpected issue. * * @param t a {@link Throwable} */ - public void onThrowable(Throwable t); + void onThrowable(Throwable t); } + diff --git a/src/main/java/com/ning/http/client/resumable/PropertiesBasedResumableProcessor.java b/client/src/main/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessor.java similarity index 69% rename from src/main/java/com/ning/http/client/resumable/PropertiesBasedResumableProcessor.java rename to client/src/main/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessor.java index efb6dea06b..3a65f019e7 100644 --- a/src/main/java/com/ning/http/client/resumable/PropertiesBasedResumableProcessor.java +++ b/client/src/main/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessor.java @@ -10,96 +10,84 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.resumable; +package org.asynchttpclient.handler.resumable; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.File; import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; +import java.io.OutputStream; +import java.nio.file.Files; +import java.util.Collections; import java.util.Map; import java.util.Scanner; import java.util.concurrent.ConcurrentHashMap; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.util.MiscUtils.closeSilently; + /** - * A {@link com.ning.http.client.resumable.ResumableAsyncHandler.ResumableProcessor} which use a properties file + * A {@link ResumableAsyncHandler.ResumableProcessor} which use a properties file * to store the download index information. */ public class PropertiesBasedResumableProcessor implements ResumableAsyncHandler.ResumableProcessor { - private final static Logger log = LoggerFactory.getLogger(PropertiesBasedResumableProcessor.class); - private final static File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc"); - private final static String storeName = "ResumableAsyncHandler.properties"; - private final ConcurrentHashMap properties = new ConcurrentHashMap(); + private static final Logger log = LoggerFactory.getLogger(PropertiesBasedResumableProcessor.class); + private static final File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc"); + private static final String storeName = "ResumableAsyncHandler.properties"; + + private final ConcurrentHashMap properties = new ConcurrentHashMap<>(); + + private static String append(Map.Entry e) { + return e.getKey() + '=' + e.getValue() + '\n'; + } - /** - * {@inheritDoc} - */ - /* @Override */ + @Override public void put(String url, long transferredBytes) { properties.put(url, transferredBytes); } - /** - * {@inheritDoc} - */ - /* @Override */ + @Override public void remove(String uri) { if (uri != null) { properties.remove(uri); } } - /** - * {@inheritDoc} - */ - /* @Override */ + @Override public void save(Map map) { - log.debug("Saving current download state {}", properties.toString()); - FileOutputStream os = null; + log.debug("Saving current download state {}", properties); + OutputStream os = null; try { - if (!TMP.mkdirs()) { + if (!TMP.exists() && !TMP.mkdirs()) { throw new IllegalStateException("Unable to create directory: " + TMP.getAbsolutePath()); } File f = new File(TMP, storeName); - if (!f.createNewFile()) { + if (!f.exists() && !f.createNewFile()) { throw new IllegalStateException("Unable to create temp file: " + f.getAbsolutePath()); } if (!f.canWrite()) { throw new IllegalStateException(); } - os = new FileOutputStream(f); - + os = Files.newOutputStream(f.toPath()); for (Map.Entry e : properties.entrySet()) { - os.write((append(e)).getBytes("UTF-8")); + os.write(append(e).getBytes(UTF_8)); } os.flush(); } catch (Throwable e) { log.warn(e.getMessage(), e); } finally { - if (os != null) { - try { - os.close(); - } catch (IOException ignored) { - } - } + closeSilently(os); } } - private static String append(Map.Entry e) { - return new StringBuffer(e.getKey()).append("=").append(e.getValue()).append("\n").toString(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ + @Override public Map load() { + Scanner scan = null; try { - Scanner scan = new Scanner(new File(TMP, storeName), "UTF-8"); + scan = new Scanner(new File(TMP, storeName), UTF_8); scan.useDelimiter("[=\n]"); String key; @@ -109,13 +97,17 @@ public Map load() { value = scan.next().trim(); properties.put(key, Long.valueOf(value)); } - log.debug("Loading previous download state {}", properties.toString()); + log.debug("Loading previous download state {}", properties); } catch (FileNotFoundException ex) { log.debug("Missing {}", storeName); } catch (Throwable ex) { // Survive any exceptions log.warn(ex.getMessage(), ex); + } finally { + if (scan != null) { + scan.close(); + } } - return properties; + return Collections.unmodifiableMap(properties); } } diff --git a/src/main/java/com/ning/http/client/resumable/ResumableAsyncHandler.java b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandler.java similarity index 63% rename from src/main/java/com/ning/http/client/resumable/ResumableAsyncHandler.java rename to client/src/main/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandler.java index 51d60ccf99..6b8794547a 100644 --- a/src/main/java/com/ning/http/client/resumable/ResumableAsyncHandler.java +++ b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandler.java @@ -10,51 +10,57 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.resumable; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response.ResponseBuilder; -import com.ning.http.client.listener.TransferCompletionHandler; +package org.asynchttpclient.handler.resumable; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Request; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.asynchttpclient.Response.ResponseBuilder; +import org.asynchttpclient.handler.TransferCompletionHandler; +import org.jetbrains.annotations.Nullable; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.IOException; import java.nio.ByteBuffer; +import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.atomic.AtomicLong; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.RANGE; + /** - * An {@link AsyncHandler} which support resumable download, e.g when used with an {@link ResumableIOExceptionFilter}, - * this handler can resume the download operation at the point it was before the interruption occured. This prevent having to - * download the entire file again. It's the responsibility of the {@link com.ning.http.client.listener.TransferListener} + * An {@link AsyncHandler} which support resumable download, e.g. when used with an {@link ResumableIOExceptionFilter}, + * this handler can resume the download operation at the point it was before the interruption occurred. This prevents having to + * download the entire file again. It's the responsibility of the {@link ResumableAsyncHandler} * to track how many bytes has been transferred and to properly adjust the file's write position. - *

+ *
* In case of a JVM crash/shutdown, you can create an instance of this class and pass the last valid bytes position. + *

+ * Beware that it registers a shutdown hook, that will cause a ClassLoader leak when used in an appserver and only redeploying the application. */ -public class ResumableAsyncHandler implements AsyncHandler { - private final static Logger logger = LoggerFactory.getLogger(TransferCompletionHandler.class); +public class ResumableAsyncHandler implements AsyncHandler { + private static final Logger logger = LoggerFactory.getLogger(TransferCompletionHandler.class); + private static final ResumableIndexThread resumeIndexThread = new ResumableIndexThread(); + private static Map resumableIndex = Collections.emptyMap(); + private final AtomicLong byteTransferred; - private Integer contentLength; - private String url; private final ResumableProcessor resumableProcessor; - private final AsyncHandler decoratedAsyncHandler; - private static Map resumableIndex; - private final static ResumableIndexThread resumeIndexThread = new ResumableIndexThread(); - private ResponseBuilder responseBuilder = new ResponseBuilder(); + private final @Nullable AsyncHandler decoratedAsyncHandler; private final boolean accumulateBody; + private String url = ""; + private final ResponseBuilder responseBuilder = new ResponseBuilder(); private ResumableListener resumableListener = new NULLResumableListener(); - private ResumableAsyncHandler(long byteTransferred, - ResumableProcessor resumableProcessor, - AsyncHandler decoratedAsyncHandler, - boolean accumulateBody) { + private ResumableAsyncHandler(long byteTransferred, @Nullable ResumableProcessor resumableProcessor, + @Nullable AsyncHandler decoratedAsyncHandler, boolean accumulateBody) { this.byteTransferred = new AtomicLong(byteTransferred); @@ -82,11 +88,11 @@ public ResumableAsyncHandler() { this(0, null, null, false); } - public ResumableAsyncHandler(AsyncHandler decoratedAsyncHandler) { + public ResumableAsyncHandler(AsyncHandler decoratedAsyncHandler) { this(0, new PropertiesBasedResumableProcessor(), decoratedAsyncHandler, false); } - public ResumableAsyncHandler(long byteTransferred, AsyncHandler decoratedAsyncHandler) { + public ResumableAsyncHandler(long byteTransferred, AsyncHandler decoratedAsyncHandler) { this(byteTransferred, new PropertiesBasedResumableProcessor(), decoratedAsyncHandler, false); } @@ -98,29 +104,23 @@ public ResumableAsyncHandler(ResumableProcessor resumableProcessor, boolean accu this(0, resumableProcessor, null, accumulateBody); } - /** - * {@inheritDoc} - */ - /* @Override */ - public AsyncHandler.STATE onStatusReceived(final HttpResponseStatus status) throws Exception { + @Override + public State onStatusReceived(final HttpResponseStatus status) throws Exception { responseBuilder.accumulate(status); if (status.getStatusCode() == 200 || status.getStatusCode() == 206) { - url = status.getUrl().toURL().toString(); + url = status.getUri().toUrl(); } else { - return AsyncHandler.STATE.ABORT; + return AsyncHandler.State.ABORT; } if (decoratedAsyncHandler != null) { return decoratedAsyncHandler.onStatusReceived(status); } - return AsyncHandler.STATE.CONTINUE; + return AsyncHandler.State.CONTINUE; } - /** - * {@inheritDoc} - */ - /* @Override */ + @Override public void onThrowable(Throwable t) { if (decoratedAsyncHandler != null) { decoratedAsyncHandler.onThrowable(t); @@ -129,21 +129,18 @@ public void onThrowable(Throwable t) { } } - /** - * {@inheritDoc} - */ - /* @Override */ - public AsyncHandler.STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { if (accumulateBody) { responseBuilder.accumulate(bodyPart); } - STATE state = STATE.CONTINUE; + State state = State.CONTINUE; try { resumableListener.onBytesReceived(bodyPart.getBodyByteBuffer()); } catch (IOException ex) { - return AsyncHandler.STATE.ABORT; + return AsyncHandler.State.ABORT; } if (decoratedAsyncHandler != null) { @@ -156,11 +153,8 @@ public AsyncHandler.STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) thro return state; } - /** - * {@inheritDoc} - */ - /* @Override */ - public T onCompleted() throws Exception { + @Override + public @Nullable Response onCompleted() throws Exception { resumableProcessor.remove(url); resumableListener.onAllBytesReceived(); @@ -168,26 +162,29 @@ public T onCompleted() throws Exception { decoratedAsyncHandler.onCompleted(); } // Not sure - return (T) responseBuilder.build(); + return responseBuilder.build(); } - /** - * {@inheritDoc} - */ - /* @Override */ - public AsyncHandler.STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { + @Override + public State onHeadersReceived(HttpHeaders headers) throws Exception { responseBuilder.accumulate(headers); - if (headers.getHeaders().getFirstValue("Content-Length") != null) { - contentLength = Integer.valueOf(headers.getHeaders().getFirstValue("Content-Length")); - if (contentLength == null || contentLength == -1) { - return AsyncHandler.STATE.ABORT; + String contentLengthHeader = headers.get(CONTENT_LENGTH); + if (contentLengthHeader != null) { + if (Long.parseLong(contentLengthHeader) == -1L) { + return AsyncHandler.State.ABORT; } } if (decoratedAsyncHandler != null) { return decoratedAsyncHandler.onHeadersReceived(headers); } - return AsyncHandler.STATE.CONTINUE; + return State.CONTINUE; + } + + @Override + public State onTrailingHeadersReceived(HttpHeaders headers) { + responseBuilder.accumulate(headers); + return State.CONTINUE; } /** @@ -198,19 +195,19 @@ public AsyncHandler.STATE onHeadersReceived(HttpResponseHeaders headers) throws * @return a {@link Request} with the Range header properly set. */ public Request adjustRequestRange(Request request) { - - if (resumableIndex.get(request.getUrl()) != null) { - byteTransferred.set(resumableIndex.get(request.getUrl())); + Long ri = resumableIndex.get(request.getUrl()); + if (ri != null) { + byteTransferred.set(ri); } - // The Resumbale + // The Resumable if (resumableListener != null && resumableListener.length() > 0 && byteTransferred.get() != resumableListener.length()) { byteTransferred.set(resumableListener.length()); } - RequestBuilder builder = new RequestBuilder(request); - if (request.getHeaders().get("Range") == null && byteTransferred.get() != 0) { - builder.setHeader("Range", "bytes=" + byteTransferred.get() + "-"); + RequestBuilder builder = request.toBuilder(); + if (request.getHeaders().get(RANGE) == null && byteTransferred.get() != 0) { + builder.setHeader(RANGE, "bytes=" + byteTransferred.get() + '-'); } return builder.build(); } @@ -226,92 +223,102 @@ public ResumableAsyncHandler setResumableListener(ResumableListener resumableLis return this; } - private static class ResumableIndexThread extends Thread { - - public final ConcurrentLinkedQueue resumableProcessors = new ConcurrentLinkedQueue(); - - public ResumableIndexThread() { - Runtime.getRuntime().addShutdownHook(this); - } - - public void addResumableProcessor(ResumableProcessor p) { - resumableProcessors.offer(p); - } - - public void run() { - for (ResumableProcessor p : resumableProcessors) { - p.save(resumableIndex); - } - } - } - /** * An interface to implement in order to manage the way the incomplete file management are handled. */ - public static interface ResumableProcessor { + public interface ResumableProcessor { /** - * Associate a key with the number of bytes sucessfully transferred. + * Associate a key with the number of bytes successfully transferred. * * @param key a key. The recommended way is to use an url. - * @param transferredBytes The number of bytes sucessfully transferred. + * @param transferredBytes The number of bytes successfully transferred. */ - public void put(String key, long transferredBytes); + void put(String key, long transferredBytes); /** * Remove the key associate value. * - * @param key key from which the value will be discarted + * @param key key from which the value will be discarded */ - public void remove(String key); + void remove(String key); /** * Save the current {@link Map} instance which contains information about the current transfer state. * This method *only* invoked when the JVM is shutting down. * - * @param map + * @param map the current transfer state */ - public void save(Map map); + void save(Map map); /** * Load the {@link Map} in memory, contains information about the transferred bytes. * - * @return {@link Map} + * @return {@link Map} current transfer state */ - public Map load(); + Map load(); + } + + private static class ResumableIndexThread extends Thread { + + public final ConcurrentLinkedQueue resumableProcessors = new ConcurrentLinkedQueue<>(); + + private ResumableIndexThread() { + Runtime.getRuntime().addShutdownHook(this); + } + public void addResumableProcessor(ResumableProcessor p) { + resumableProcessors.offer(p); + } + + @Override + public void run() { + for (ResumableProcessor p : resumableProcessors) { + p.save(resumableIndex); + } + } } private static class NULLResumableHandler implements ResumableProcessor { + @Override public void put(String url, long transferredBytes) { } + @Override public void remove(String uri) { } + @Override public void save(Map map) { } + @Override public Map load() { - return new HashMap(); + return new HashMap<>(); } } private static class NULLResumableListener implements ResumableListener { - private long length = 0L; + private long length; - public void onBytesReceived(ByteBuffer byteBuffer) throws IOException { + private NULLResumableListener() { + length = 0L; + } + + @Override + public void onBytesReceived(ByteBuffer byteBuffer) { length += byteBuffer.remaining(); } + @Override public void onAllBytesReceived() { } + @Override public long length() { return length; } - } } diff --git a/src/main/java/com/ning/http/client/resumable/ResumableIOExceptionFilter.java b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableIOExceptionFilter.java similarity index 54% rename from src/main/java/com/ning/http/client/resumable/ResumableIOExceptionFilter.java rename to client/src/main/java/org/asynchttpclient/handler/resumable/ResumableIOExceptionFilter.java index 7e2bd1d254..190ec6a3a7 100644 --- a/src/main/java/com/ning/http/client/resumable/ResumableIOExceptionFilter.java +++ b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableIOExceptionFilter.java @@ -10,26 +10,23 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.resumable; +package org.asynchttpclient.handler.resumable; -import com.ning.http.client.Request; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.IOExceptionFilter; +import org.asynchttpclient.Request; +import org.asynchttpclient.filter.FilterContext; +import org.asynchttpclient.filter.IOExceptionFilter; /** - * Simple {@link IOExceptionFilter} that replay the current {@link com.ning.http.client.Request} using - * a {@link ResumableAsyncHandler} + * Simple {@link IOExceptionFilter} that replay the current {@link Request} using a {@link ResumableAsyncHandler} */ public class ResumableIOExceptionFilter implements IOExceptionFilter { - public FilterContext filter(FilterContext ctx) throws FilterException { - if (ctx.getIOException() != null && ResumableAsyncHandler.class.isAssignableFrom(ctx.getAsyncHandler().getClass())) { - Request request = ResumableAsyncHandler.class.cast(ctx.getAsyncHandler()).adjustRequestRange(ctx.getRequest()); - - return new FilterContext.FilterContextBuilder(ctx).request(request).replayRequest(true).build(); + @Override + public FilterContext filter(FilterContext ctx) { + if (ctx.getIOException() != null && ctx.getAsyncHandler() instanceof ResumableAsyncHandler) { + Request request = ((ResumableAsyncHandler) ctx.getAsyncHandler()).adjustRequestRange(ctx.getRequest()); + return new FilterContext.FilterContextBuilder<>(ctx).request(request).replayRequest(true).build(); } return ctx; } } - \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/resumable/ResumableListener.java b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableListener.java similarity index 79% rename from src/main/java/com/ning/http/client/resumable/ResumableListener.java rename to client/src/main/java/org/asynchttpclient/handler/resumable/ResumableListener.java index 0b55ac2257..4c4c6cbffd 100644 --- a/src/main/java/com/ning/http/client/resumable/ResumableListener.java +++ b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableListener.java @@ -10,7 +10,7 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.resumable; +package org.asynchttpclient.handler.resumable; import java.io.IOException; import java.nio.ByteBuffer; @@ -24,20 +24,19 @@ public interface ResumableListener { * Invoked when some bytes are available to digest. * * @param byteBuffer the current bytes - * @throws IOException + * @throws IOException exception while writing the byteBuffer */ - public void onBytesReceived(ByteBuffer byteBuffer) throws IOException; + void onBytesReceived(ByteBuffer byteBuffer) throws IOException; /** - * Invoked when all the bytes has been sucessfully transferred. + * Invoked when all the bytes has been successfully transferred. */ - public void onAllBytesReceived(); + void onAllBytesReceived(); /** * Return the length of previously downloaded bytes. * * @return the length of previously downloaded bytes */ - public long length(); - -} \ No newline at end of file + long length(); +} diff --git a/src/main/java/com/ning/http/client/extra/ResumableRandomAccessFileListener.java b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListener.java similarity index 66% rename from src/main/java/com/ning/http/client/extra/ResumableRandomAccessFileListener.java rename to client/src/main/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListener.java index 042baf1552..f7e28f6f64 100644 --- a/src/main/java/com/ning/http/client/extra/ResumableRandomAccessFileListener.java +++ b/client/src/main/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListener.java @@ -10,22 +10,19 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.extra; - -import com.ning.http.client.resumable.ResumableListener; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +package org.asynchttpclient.handler.resumable; import java.io.IOException; import java.io.RandomAccessFile; import java.nio.ByteBuffer; +import static org.asynchttpclient.util.MiscUtils.closeSilently; + /** - * A {@link com.ning.http.client.listener.TransferListener} which use a {@link RandomAccessFile} for storing the received bytes. + * A {@link ResumableListener} which use a {@link RandomAccessFile} for storing the received bytes. */ public class ResumableRandomAccessFileListener implements ResumableListener { private final RandomAccessFile file; - private final static Logger logger = LoggerFactory.getLogger(ThrottleRequestFilter.class); public ResumableRandomAccessFileListener(RandomAccessFile file) { this.file = file; @@ -36,36 +33,33 @@ public ResumableRandomAccessFileListener(RandomAccessFile file) { * resumable file download. * * @param buffer a {@link ByteBuffer} - * @throws IOException + * @throws IOException exception while writing into the file */ + @Override public void onBytesReceived(ByteBuffer buffer) throws IOException { file.seek(file.length()); - file.write(buffer.array()); + if (buffer.hasArray()) { + file.write(buffer.array(), buffer.arrayOffset() + buffer.position(), buffer.remaining()); + } else { // if the buffer is direct or backed by a String... + byte[] b = new byte[buffer.remaining()]; + int pos = buffer.position(); + buffer.get(b); + buffer.position(pos); + file.write(b); + } } - /** - * {@inheritDoc} - */ + @Override public void onAllBytesReceived() { - if (file != null) { - try { - file.close(); - } catch (IOException e) { - ; - } - } + closeSilently(file); } - /** - * {@inheritDoc} - */ + @Override public long length() { try { return file.length(); } catch (IOException e) { - ; + return -1; } - return 0; } - } diff --git a/client/src/main/java/org/asynchttpclient/netty/DiscardEvent.java b/client/src/main/java/org/asynchttpclient/netty/DiscardEvent.java new file mode 100644 index 0000000000..7983122572 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/DiscardEvent.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +/** + * Simple marker for stopping publishing bytes + */ +public enum DiscardEvent { + DISCARD +} diff --git a/client/src/main/java/org/asynchttpclient/netty/EagerResponseBodyPart.java b/client/src/main/java/org/asynchttpclient/netty/EagerResponseBodyPart.java new file mode 100755 index 0000000000..8247379b08 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/EagerResponseBodyPart.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.HttpResponseBodyPart; + +import java.nio.ByteBuffer; + +/** + * A callback class used when an HTTP response body is received. + * Bytes are eagerly fetched from the ByteBuf + */ +public class EagerResponseBodyPart extends HttpResponseBodyPart { + + private final byte[] bytes; + + public EagerResponseBodyPart(ByteBuf buf, boolean last) { + super(last); + bytes = ByteBufUtil.getBytes(buf); + } + + /** + * Return the response body's part bytes received. + * + * @return the response body's part bytes received. + */ + @Override + public byte[] getBodyPartBytes() { + return bytes; + } + + @Override + public int length() { + return bytes.length; + } + + @Override + public ByteBuffer getBodyByteBuffer() { + return ByteBuffer.wrap(bytes); + } + + @Override + public ByteBuf getBodyByteBuf() { + return Unpooled.wrappedBuffer(bytes); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/LazyResponseBodyPart.java b/client/src/main/java/org/asynchttpclient/netty/LazyResponseBodyPart.java new file mode 100755 index 0000000000..e472770061 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/LazyResponseBodyPart.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; +import org.asynchttpclient.HttpResponseBodyPart; + +import java.nio.ByteBuffer; + +/** + * A callback class used when an HTTP response body is received. + */ +public class LazyResponseBodyPart extends HttpResponseBodyPart { + + private final ByteBuf buf; + + public LazyResponseBodyPart(ByteBuf buf, boolean last) { + super(last); + this.buf = buf; + } + + @Override + public ByteBuf getBodyByteBuf() { + return buf; + } + + @Override + public int length() { + return buf.readableBytes(); + } + + /** + * Return the response body's part bytes received. + * + * @return the response body's part bytes received. + */ + @Override + public byte[] getBodyPartBytes() { + return ByteBufUtil.getBytes(buf.duplicate()); + } + + @Override + public ByteBuffer getBodyByteBuffer() { + return buf.nioBuffer(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponse.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponse.java new file mode 100755 index 0000000000..61fb15161c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/NettyResponse.java @@ -0,0 +1,235 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import io.netty.buffer.CompositeByteBuf; +import io.netty.handler.codec.http.EmptyHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.ClientCookieDecoder; +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.asynchttpclient.uri.Uri; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.net.SocketAddress; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.SET_COOKIE; +import static io.netty.handler.codec.http.HttpHeaderNames.SET_COOKIE2; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.util.HttpUtils.extractContentTypeCharsetAttribute; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.util.MiscUtils.withDefault; + +/** + * Wrapper around the {@link Response} API. + */ +public class NettyResponse implements Response { + + private final List bodyParts; + private final HttpHeaders headers; + private final HttpResponseStatus status; + private List cookies; + + public NettyResponse(HttpResponseStatus status, + HttpHeaders headers, + List bodyParts) { + this.bodyParts = bodyParts; + this.headers = headers; + this.status = status; + } + + private List buildCookies() { + + List setCookieHeaders = headers.getAll(SET_COOKIE2); + + if (!isNonEmpty(setCookieHeaders)) { + setCookieHeaders = headers.getAll(SET_COOKIE); + } + + if (isNonEmpty(setCookieHeaders)) { + List cookies = new ArrayList<>(1); + for (String value : setCookieHeaders) { + Cookie c = ClientCookieDecoder.STRICT.decode(value); + if (c != null) { + cookies.add(c); + } + } + return Collections.unmodifiableList(cookies); + } + + return Collections.emptyList(); + } + + @Override + public final int getStatusCode() { + return status.getStatusCode(); + } + + @Override + public final String getStatusText() { + return status.getStatusText(); + } + + @Override + public final Uri getUri() { + return status.getUri(); + } + + @Override + public SocketAddress getRemoteAddress() { + return status.getRemoteAddress(); + } + + @Override + public SocketAddress getLocalAddress() { + return status.getLocalAddress(); + } + + @Override + public final String getContentType() { + return headers != null ? getHeader(CONTENT_TYPE) : null; + } + + @Override + public final String getHeader(CharSequence name) { + return headers != null ? getHeaders().get(name) : null; + } + + @Override + public final List getHeaders(CharSequence name) { + return headers != null ? getHeaders().getAll(name) : Collections.emptyList(); + } + + @Override + public final HttpHeaders getHeaders() { + return headers != null ? headers : EmptyHttpHeaders.INSTANCE; + } + + @Override + public final boolean isRedirected() { + switch (status.getStatusCode()) { + case 301: + case 302: + case 303: + case 307: + case 308: + return true; + default: + return false; + } + } + + @Override + public List getCookies() { + + if (headers == null) { + return Collections.emptyList(); + } + + if (cookies == null) { + cookies = buildCookies(); + } + return cookies; + + } + + @Override + public boolean hasResponseStatus() { + return status != null; + } + + @Override + public boolean hasResponseHeaders() { + return headers != null && !headers.isEmpty(); + } + + @Override + public boolean hasResponseBody() { + return isNonEmpty(bodyParts); + } + + @Override + public byte[] getResponseBodyAsBytes() { + return getResponseBodyAsByteBuffer().array(); + } + + @Override + public ByteBuffer getResponseBodyAsByteBuffer() { + + int length = 0; + for (HttpResponseBodyPart part : bodyParts) { + length += part.length(); + } + + ByteBuffer target = ByteBuffer.wrap(new byte[length]); + for (HttpResponseBodyPart part : bodyParts) { + target.put(part.getBodyPartBytes()); + } + + target.flip(); + return target; + } + + @Override + public ByteBuf getResponseBodyAsByteBuf() { + CompositeByteBuf compositeByteBuf = ByteBufAllocator.DEFAULT.compositeBuffer(bodyParts.size()); + for (HttpResponseBodyPart part : bodyParts) { + compositeByteBuf.addComponent(true, part.getBodyByteBuf()); + } + return compositeByteBuf; + } + + @Override + public String getResponseBody() { + return getResponseBody(withDefault(extractContentTypeCharsetAttribute(getContentType()), UTF_8)); + } + + @Override + public String getResponseBody(Charset charset) { + return new String(getResponseBodyAsBytes(), charset); + } + + @Override + public InputStream getResponseBodyAsStream() { + return new ByteArrayInputStream(getResponseBodyAsBytes()); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append(getClass().getSimpleName()).append(" {\n") + .append("\tstatusCode=").append(getStatusCode()).append('\n') + .append("\theaders=\n"); + + for (Map.Entry header : getHeaders()) { + sb.append("\t\t").append(header.getKey()).append(": ").append(header.getValue()).append('\n'); + } + return sb.append("\tbody=\n").append(getResponseBody()).append('\n') + .append('}').toString(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponseFuture.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponseFuture.java new file mode 100755 index 0000000000..c29c0f33d9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/NettyResponseFuture.java @@ -0,0 +1,560 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.channel.Channel; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.asynchttpclient.channel.ChannelPoolPartitioning; +import org.asynchttpclient.netty.channel.ChannelState; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.channel.ConnectionSemaphore; +import org.asynchttpclient.netty.request.NettyRequest; +import org.asynchttpclient.netty.timeout.TimeoutsHolder; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.concurrent.CancellationException; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Executor; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicIntegerFieldUpdater; +import java.util.concurrent.atomic.AtomicReferenceFieldUpdater; + +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; + +/** + * A {@link Future} that can be used to track when an asynchronous HTTP request + * has been fully processed. + * + * @param the result type + */ +public final class NettyResponseFuture implements ListenableFuture { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyResponseFuture.class); + + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater REDIRECT_COUNT_UPDATER = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "redirectCount"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater CURRENT_RETRY_UPDATER = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "currentRetry"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater IS_DONE_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "isDone"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater IS_CANCELLED_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "isCancelled"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater IN_AUTH_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "inAuth"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater IN_PROXY_AUTH_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "inProxyAuth"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater CONTENT_PROCESSED_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "contentProcessed"); + @SuppressWarnings("rawtypes") + private static final AtomicIntegerFieldUpdater ON_THROWABLE_CALLED_FIELD = AtomicIntegerFieldUpdater + .newUpdater(NettyResponseFuture.class, "onThrowableCalled"); + @SuppressWarnings("rawtypes") + private static final AtomicReferenceFieldUpdater TIMEOUTS_HOLDER_FIELD = AtomicReferenceFieldUpdater + .newUpdater(NettyResponseFuture.class, TimeoutsHolder.class, "timeoutsHolder"); + @SuppressWarnings("rawtypes") + private static final AtomicReferenceFieldUpdater PARTITION_KEY_LOCK_FIELD = AtomicReferenceFieldUpdater + .newUpdater(NettyResponseFuture.class, Object.class, "partitionKeyLock"); + + private final long start = unpreciseMillisTime(); + private final ChannelPoolPartitioning connectionPoolPartitioning; + private final ConnectionSemaphore connectionSemaphore; + private final ProxyServer proxyServer; + private final int maxRetry; + private final CompletableFuture future = new CompletableFuture<>(); + public Throwable pendingException; + // state mutated from outside the event loop + // TODO check if they are indeed mutated outside the event loop + private volatile int isDone; + private volatile int isCancelled; + private volatile int inAuth; + private volatile int inProxyAuth; + @SuppressWarnings("unused") + private volatile int contentProcessed; + @SuppressWarnings("unused") + private volatile int onThrowableCalled; + @SuppressWarnings("unused") + private volatile TimeoutsHolder timeoutsHolder; + // partition key, when != null used to release lock in ChannelManager + private volatile Object partitionKeyLock; + // volatile where we need CAS ops + private volatile int redirectCount; + private volatile int currentRetry; + // volatile where we don't need CAS ops + private volatile long touch = unpreciseMillisTime(); + private volatile ChannelState channelState = ChannelState.NEW; + // state mutated only inside the event loop + private Channel channel; + private boolean keepAlive = true; + private Request targetRequest; + private Request currentRequest; + private NettyRequest nettyRequest; + private AsyncHandler asyncHandler; + private boolean streamAlreadyConsumed; + private boolean reuseChannel; + private boolean headersAlreadyWrittenOnContinue; + private boolean dontWriteBodyBecauseExpectContinue; + private boolean allowConnect; + private Realm realm; + private Realm proxyRealm; + + public NettyResponseFuture(Request originalRequest, + AsyncHandler asyncHandler, + NettyRequest nettyRequest, + int maxRetry, + ChannelPoolPartitioning connectionPoolPartitioning, + ConnectionSemaphore connectionSemaphore, + ProxyServer proxyServer) { + + this.asyncHandler = asyncHandler; + targetRequest = currentRequest = originalRequest; + this.nettyRequest = nettyRequest; + this.connectionPoolPartitioning = connectionPoolPartitioning; + this.connectionSemaphore = connectionSemaphore; + this.proxyServer = proxyServer; + this.maxRetry = maxRetry; + } + + private void releasePartitionKeyLock() { + if (connectionSemaphore == null) { + return; + } + + Object partitionKey = takePartitionKeyLock(); + if (partitionKey != null) { + connectionSemaphore.releaseChannelLock(partitionKey); + } + } + + // Take partition key lock object, + // but do not release channel lock. + public Object takePartitionKeyLock() { + // shortcut, much faster than getAndSet + if (partitionKeyLock == null) { + return null; + } + + return PARTITION_KEY_LOCK_FIELD.getAndSet(this, null); + } + + // java.util.concurrent.Future + + @Override + public boolean isDone() { + return isDone != 0 || isCancelled(); + } + + @Override + public boolean isCancelled() { + return isCancelled != 0; + } + + @Override + public boolean cancel(boolean force) { + releasePartitionKeyLock(); + cancelTimeouts(); + + if (IS_CANCELLED_FIELD.getAndSet(this, 1) != 0) { + return false; + } + + final Channel ch = channel; //atomic read, so that it won't end up in TOCTOU + if (ch != null) { + Channels.setDiscard(ch); + Channels.silentlyCloseChannel(ch); + } + + if (ON_THROWABLE_CALLED_FIELD.getAndSet(this, 1) == 0) { + try { + asyncHandler.onThrowable(new CancellationException()); + } catch (Throwable t) { + LOGGER.warn("cancel", t); + } + } + + future.cancel(false); + return true; + } + + @Override + public V get() throws InterruptedException, ExecutionException { + return future.get(); + } + + @Override + public V get(long l, TimeUnit tu) throws InterruptedException, TimeoutException, ExecutionException { + return future.get(l, tu); + } + + private void loadContent() throws ExecutionException { + if (future.isDone()) { + try { + future.get(); + } catch (InterruptedException e) { + throw new RuntimeException("unreachable", e); + } + } + + // No more retry + CURRENT_RETRY_UPDATER.set(this, maxRetry); + if (CONTENT_PROCESSED_FIELD.getAndSet(this, 1) == 0) { + try { + future.complete(asyncHandler.onCompleted()); + } catch (Throwable ex) { + if (ON_THROWABLE_CALLED_FIELD.getAndSet(this, 1) == 0) { + try { + try { + asyncHandler.onThrowable(ex); + } catch (Throwable t) { + LOGGER.debug("asyncHandler.onThrowable", t); + } + } finally { + cancelTimeouts(); + } + } + future.completeExceptionally(ex); + } + } + future.getNow(null); + } + + // org.asynchttpclient.ListenableFuture + + private boolean terminateAndExit() { + releasePartitionKeyLock(); + cancelTimeouts(); + channel = null; + reuseChannel = false; + return IS_DONE_FIELD.getAndSet(this, 1) != 0 || isCancelled != 0; + } + + @Override + public void done() { + + if (terminateAndExit()) { + return; + } + + try { + loadContent(); + } catch (ExecutionException ignored) { + + } catch (RuntimeException t) { + future.completeExceptionally(t); + } catch (Throwable t) { + future.completeExceptionally(t); + throw t; + } + } + + @Override + public void abort(final Throwable t) { + + if (terminateAndExit()) { + return; + } + + future.completeExceptionally(t); + + if (ON_THROWABLE_CALLED_FIELD.compareAndSet(this, 0, 1)) { + try { + asyncHandler.onThrowable(t); + } catch (Throwable te) { + LOGGER.debug("asyncHandler.onThrowable", te); + } + } + } + + @Override + public void touch() { + touch = unpreciseMillisTime(); + } + + @Override + public ListenableFuture addListener(Runnable listener, Executor exec) { + if (exec == null) { + exec = Runnable::run; + } + future.whenCompleteAsync((r, v) -> listener.run(), exec); + return this; + } + + @Override + public CompletableFuture toCompletableFuture() { + return future; + } + + // INTERNAL + + public Uri getUri() { + return targetRequest.getUri(); + } + + public ProxyServer getProxyServer() { + return proxyServer; + } + + public void cancelTimeouts() { + TimeoutsHolder ref = TIMEOUTS_HOLDER_FIELD.getAndSet(this, null); + if (ref != null) { + ref.cancel(); + } + } + + public Request getTargetRequest() { + return targetRequest; + } + + public void setTargetRequest(Request targetRequest) { + this.targetRequest = targetRequest; + } + + public Request getCurrentRequest() { + return currentRequest; + } + + public void setCurrentRequest(Request currentRequest) { + this.currentRequest = currentRequest; + } + + public NettyRequest getNettyRequest() { + return nettyRequest; + } + + public void setNettyRequest(NettyRequest nettyRequest) { + this.nettyRequest = nettyRequest; + } + + public AsyncHandler getAsyncHandler() { + return asyncHandler; + } + + public void setAsyncHandler(AsyncHandler asyncHandler) { + this.asyncHandler = asyncHandler; + } + + public boolean isKeepAlive() { + return keepAlive; + } + + public void setKeepAlive(final boolean keepAlive) { + this.keepAlive = keepAlive; + } + + public int incrementAndGetCurrentRedirectCount() { + return REDIRECT_COUNT_UPDATER.incrementAndGet(this); + } + + public TimeoutsHolder getTimeoutsHolder() { + return TIMEOUTS_HOLDER_FIELD.get(this); + } + + public void setTimeoutsHolder(TimeoutsHolder timeoutsHolder) { + TimeoutsHolder ref = TIMEOUTS_HOLDER_FIELD.getAndSet(this, timeoutsHolder); + if (ref != null) { + ref.cancel(); + } + } + + public boolean isInAuth() { + return inAuth != 0; + } + + public void setInAuth(boolean inAuth) { + this.inAuth = inAuth ? 1 : 0; + } + + public boolean isAndSetInAuth(boolean set) { + return IN_AUTH_FIELD.getAndSet(this, set ? 1 : 0) != 0; + } + + public boolean isInProxyAuth() { + return inProxyAuth != 0; + } + + public void setInProxyAuth(boolean inProxyAuth) { + this.inProxyAuth = inProxyAuth ? 1 : 0; + } + + public boolean isAndSetInProxyAuth(boolean inProxyAuth) { + return IN_PROXY_AUTH_FIELD.getAndSet(this, inProxyAuth ? 1 : 0) != 0; + } + + public ChannelState getChannelState() { + return channelState; + } + + public void setChannelState(ChannelState channelState) { + this.channelState = channelState; + } + + public boolean isStreamConsumed() { + return streamAlreadyConsumed; + } + + public void setStreamConsumed(boolean streamConsumed) { + streamAlreadyConsumed = streamConsumed; + } + + public long getLastTouch() { + return touch; + } + + public boolean isHeadersAlreadyWrittenOnContinue() { + return headersAlreadyWrittenOnContinue; + } + + public void setHeadersAlreadyWrittenOnContinue(boolean headersAlreadyWrittenOnContinue) { + this.headersAlreadyWrittenOnContinue = headersAlreadyWrittenOnContinue; + } + + public boolean isDontWriteBodyBecauseExpectContinue() { + return dontWriteBodyBecauseExpectContinue; + } + + public void setDontWriteBodyBecauseExpectContinue(boolean dontWriteBodyBecauseExpectContinue) { + this.dontWriteBodyBecauseExpectContinue = dontWriteBodyBecauseExpectContinue; + } + + public boolean isConnectAllowed() { + return allowConnect; + } + + public void setConnectAllowed(boolean allowConnect) { + this.allowConnect = allowConnect; + } + + public void attachChannel(Channel channel, boolean reuseChannel) { + + // future could have been cancelled first + if (isDone()) { + Channels.silentlyCloseChannel(channel); + } + + this.channel = channel; + this.reuseChannel = reuseChannel; + } + + public Channel channel() { + return channel; + } + + public boolean isReuseChannel() { + return reuseChannel; + } + + public void setReuseChannel(boolean reuseChannel) { + this.reuseChannel = reuseChannel; + } + + public boolean incrementRetryAndCheck() { + return maxRetry > 0 && CURRENT_RETRY_UPDATER.incrementAndGet(this) <= maxRetry; + } + + /** + * Return true if the {@link Future} can be recovered. There is some scenario + * where a connection can be closed by an unexpected IOException, and in some + * situation we can recover from that exception. + * + * @return true if that {@link Future} cannot be recovered. + */ + public boolean isReplayPossible() { + return !isDone() && !(Channels.isChannelActive(channel) && !"https".equalsIgnoreCase(getUri().getScheme())) + && inAuth == 0 && inProxyAuth == 0; + } + + public long getStart() { + return start; + } + + public Object getPartitionKey() { + return connectionPoolPartitioning.getPartitionKey(targetRequest.getUri(), targetRequest.getVirtualHost(), + proxyServer); + } + + public void acquirePartitionLockLazily() throws IOException { + if (connectionSemaphore == null || partitionKeyLock != null) { + return; + } + + Object partitionKey = getPartitionKey(); + connectionSemaphore.acquireChannelLock(partitionKey); + Object prevKey = PARTITION_KEY_LOCK_FIELD.getAndSet(this, partitionKey); + if (prevKey != null) { + // self-check + + connectionSemaphore.releaseChannelLock(prevKey); + releasePartitionKeyLock(); + + throw new IllegalStateException("Trying to acquire partition lock concurrently. Please report."); + } + + if (isDone()) { + // may be cancelled while we acquired a lock + releasePartitionKeyLock(); + } + } + + public Realm getRealm() { + return realm; + } + + public void setRealm(Realm realm) { + this.realm = realm; + } + + public Realm getProxyRealm() { + return proxyRealm; + } + + public void setProxyRealm(Realm proxyRealm) { + this.proxyRealm = proxyRealm; + } + + @Override + public String toString() { + return "NettyResponseFuture{" + // + "currentRetry=" + currentRetry + // + ",\n\tisDone=" + isDone + // + ",\n\tisCancelled=" + isCancelled + // + ",\n\tasyncHandler=" + asyncHandler + // + ",\n\tnettyRequest=" + nettyRequest + // + ",\n\tfuture=" + future + // + ",\n\turi=" + getUri() + // + ",\n\tkeepAlive=" + keepAlive + // + ",\n\tredirectCount=" + redirectCount + // + ",\n\ttimeoutsHolder=" + TIMEOUTS_HOLDER_FIELD.get(this) + // + ",\n\tinAuth=" + inAuth + // + ",\n\ttouch=" + touch + // + '}'; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponseStatus.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponseStatus.java new file mode 100755 index 0000000000..567432af3b --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/NettyResponseStatus.java @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpResponse; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.uri.Uri; + +import java.net.SocketAddress; + +/** + * A class that represent the HTTP response status line (code + text) + */ +public class NettyResponseStatus extends HttpResponseStatus { + + private final HttpResponse response; + private final SocketAddress remoteAddress; + private final SocketAddress localAddress; + + public NettyResponseStatus(Uri uri, HttpResponse response, Channel channel) { + super(uri); + this.response = response; + if (channel != null) { + remoteAddress = channel.remoteAddress(); + localAddress = channel.localAddress(); + } else { + remoteAddress = null; + localAddress = null; + } + } + + /** + * Return the response status code + * + * @return the response status code + */ + @Override + public int getStatusCode() { + return response.status().code(); + } + + /** + * Return the response status text + * + * @return the response status text + */ + @Override + public String getStatusText() { + return response.status().reasonPhrase(); + } + + @Override + public String getProtocolName() { + return response.protocolVersion().protocolName(); + } + + @Override + public int getProtocolMajorVersion() { + return response.protocolVersion().majorVersion(); + } + + @Override + public int getProtocolMinorVersion() { + return response.protocolVersion().minorVersion(); + } + + @Override + public String getProtocolText() { + return response.protocolVersion().text(); + } + + @Override + public SocketAddress getRemoteAddress() { + return remoteAddress; + } + + @Override + public SocketAddress getLocalAddress() { + return localAddress; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/OnLastHttpContentCallback.java b/client/src/main/java/org/asynchttpclient/netty/OnLastHttpContentCallback.java new file mode 100644 index 0000000000..15c0c96174 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/OnLastHttpContentCallback.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +public abstract class OnLastHttpContentCallback { + + protected final NettyResponseFuture future; + + protected OnLastHttpContentCallback(NettyResponseFuture future) { + this.future = future; + } + + public abstract void call() throws Exception; + + public NettyResponseFuture future() { + return future; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/SimpleChannelFutureListener.java b/client/src/main/java/org/asynchttpclient/netty/SimpleChannelFutureListener.java new file mode 100644 index 0000000000..e4271c5367 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/SimpleChannelFutureListener.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelFuture; +import io.netty.channel.ChannelFutureListener; + +public abstract class SimpleChannelFutureListener implements ChannelFutureListener { + + @Override + public final void operationComplete(ChannelFuture future) { + Channel channel = future.channel(); + if (future.isSuccess()) { + onSuccess(channel); + } else { + onFailure(channel, future.cause()); + } + } + + public abstract void onSuccess(Channel channel); + + public abstract void onFailure(Channel channel, Throwable cause); +} diff --git a/client/src/main/java/org/asynchttpclient/netty/SimpleFutureListener.java b/client/src/main/java/org/asynchttpclient/netty/SimpleFutureListener.java new file mode 100644 index 0000000000..357f572441 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/SimpleFutureListener.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.FutureListener; + +public abstract class SimpleFutureListener implements FutureListener { + + @Override + public final void operationComplete(Future future) throws Exception { + if (future.isSuccess()) { + onSuccess(future.getNow()); + } else { + onFailure(future.cause()); + } + } + + protected abstract void onSuccess(V value) throws Exception; + + protected abstract void onFailure(Throwable t) throws Exception; +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java new file mode 100755 index 0000000000..c5c94c551c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java @@ -0,0 +1,557 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.bootstrap.Bootstrap; +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.Channel; +import io.netty.channel.ChannelFactory; +import io.netty.channel.ChannelHandler; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInitializer; +import io.netty.channel.ChannelOption; +import io.netty.channel.ChannelPipeline; +import io.netty.channel.EventLoopGroup; +import io.netty.channel.group.ChannelGroup; +import io.netty.channel.group.ChannelGroupFuture; +import io.netty.channel.group.DefaultChannelGroup; +import io.netty.channel.nio.NioEventLoopGroup; +import io.netty.handler.codec.http.HttpClientCodec; +import io.netty.handler.codec.http.HttpContentDecompressor; +import io.netty.handler.codec.http.websocketx.WebSocket08FrameDecoder; +import io.netty.handler.codec.http.websocketx.WebSocket08FrameEncoder; +import io.netty.handler.codec.http.websocketx.WebSocketFrameAggregator; +import io.netty.handler.codec.http.websocketx.extensions.compression.WebSocketClientCompressionHandler; +import io.netty.handler.logging.LogLevel; +import io.netty.handler.logging.LoggingHandler; +import io.netty.handler.proxy.ProxyHandler; +import io.netty.handler.proxy.Socks4ProxyHandler; +import io.netty.handler.proxy.Socks5ProxyHandler; +import io.netty.handler.ssl.SslHandler; +import io.netty.handler.stream.ChunkedWriteHandler; +import io.netty.resolver.NameResolver; +import io.netty.util.Timer; +import io.netty.util.concurrent.DefaultThreadFactory; +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.GlobalEventExecutor; +import io.netty.util.concurrent.ImmediateEventExecutor; +import io.netty.util.concurrent.Promise; +import io.netty.util.internal.PlatformDependent; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.ClientStats; +import org.asynchttpclient.HostStats; +import org.asynchttpclient.Realm; +import org.asynchttpclient.SslEngineFactory; +import org.asynchttpclient.channel.ChannelPool; +import org.asynchttpclient.channel.ChannelPoolPartitioning; +import org.asynchttpclient.channel.NoopChannelPool; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.OnLastHttpContentCallback; +import org.asynchttpclient.netty.handler.AsyncHttpClientHandler; +import org.asynchttpclient.netty.handler.HttpHandler; +import org.asynchttpclient.netty.handler.WebSocketHandler; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.netty.ssl.DefaultSslEngineFactory; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.net.ssl.SSLEngine; +import javax.net.ssl.SSLException; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.util.Map; +import java.util.Map.Entry; +import java.util.concurrent.ThreadFactory; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import java.util.stream.Collectors; + +public class ChannelManager { + + public static final String HTTP_CLIENT_CODEC = "http"; + public static final String SSL_HANDLER = "ssl"; + public static final String SOCKS_HANDLER = "socks"; + public static final String INFLATER_HANDLER = "inflater"; + public static final String CHUNKED_WRITER_HANDLER = "chunked-writer"; + public static final String WS_DECODER_HANDLER = "ws-decoder"; + public static final String WS_FRAME_AGGREGATOR = "ws-aggregator"; + public static final String WS_COMPRESSOR_HANDLER = "ws-compressor"; + public static final String WS_ENCODER_HANDLER = "ws-encoder"; + public static final String AHC_HTTP_HANDLER = "ahc-http"; + public static final String AHC_WS_HANDLER = "ahc-ws"; + public static final String LOGGING_HANDLER = "logging"; + private static final Logger LOGGER = LoggerFactory.getLogger(ChannelManager.class); + private final AsyncHttpClientConfig config; + private final SslEngineFactory sslEngineFactory; + private final EventLoopGroup eventLoopGroup; + private final boolean allowReleaseEventLoopGroup; + private final Bootstrap httpBootstrap; + private final Bootstrap wsBootstrap; + private final long handshakeTimeout; + + private final ChannelPool channelPool; + private final ChannelGroup openChannels; + + private AsyncHttpClientHandler wsHandler; + + private boolean isInstanceof(Object object, String name) { + final Class clazz; + try { + clazz = Class.forName(name, false, getClass().getClassLoader()); + } catch (ClassNotFoundException ignored) { + return false; + } + return clazz.isInstance(object); + } + + public ChannelManager(final AsyncHttpClientConfig config, Timer nettyTimer) { + this.config = config; + + sslEngineFactory = config.getSslEngineFactory() != null ? config.getSslEngineFactory() : new DefaultSslEngineFactory(); + try { + sslEngineFactory.init(config); + } catch (SSLException e) { + throw new RuntimeException("Could not initialize SslEngineFactory", e); + } + + ChannelPool channelPool = config.getChannelPool(); + if (channelPool == null) { + if (config.isKeepAlive()) { + channelPool = new DefaultChannelPool(config, nettyTimer); + } else { + channelPool = NoopChannelPool.INSTANCE; + } + } + + this.channelPool = channelPool; + openChannels = new DefaultChannelGroup("asyncHttpClient", GlobalEventExecutor.INSTANCE); + handshakeTimeout = config.getHandshakeTimeout(); + + // check if external EventLoopGroup is defined + ThreadFactory threadFactory = config.getThreadFactory() != null ? config.getThreadFactory() : new DefaultThreadFactory(config.getThreadPoolName()); + allowReleaseEventLoopGroup = config.getEventLoopGroup() == null; + TransportFactory transportFactory; + + if (allowReleaseEventLoopGroup) { + if (config.isUseNativeTransport()) { + transportFactory = getNativeTransportFactory(config); + } else { + transportFactory = NioTransportFactory.INSTANCE; + } + eventLoopGroup = transportFactory.newEventLoopGroup(config.getIoThreadsCount(), threadFactory); + } else { + eventLoopGroup = config.getEventLoopGroup(); + + if (eventLoopGroup instanceof NioEventLoopGroup) { + transportFactory = NioTransportFactory.INSTANCE; + } else if (isInstanceof(eventLoopGroup, "io.netty.channel.epoll.EpollEventLoopGroup")) { + transportFactory = new EpollTransportFactory(); + } else if (isInstanceof(eventLoopGroup, "io.netty.channel.kqueue.KQueueEventLoopGroup")) { + transportFactory = new KQueueTransportFactory(); + } else if (isInstanceof(eventLoopGroup, "io.netty.incubator.channel.uring.IOUringEventLoopGroup")) { + transportFactory = new IoUringIncubatorTransportFactory(); + } else { + throw new IllegalArgumentException("Unknown event loop group " + eventLoopGroup.getClass().getSimpleName()); + } + } + + httpBootstrap = newBootstrap(transportFactory, eventLoopGroup, config); + wsBootstrap = newBootstrap(transportFactory, eventLoopGroup, config); + } + + private static TransportFactory getNativeTransportFactory(AsyncHttpClientConfig config) { + // If we are running on macOS then use KQueue + if (PlatformDependent.isOsx()) { + if (KQueueTransportFactory.isAvailable()) { + return new KQueueTransportFactory(); + } + } + + // If we're not running on Windows then we're probably running on Linux. + // We will check if Io_Uring is available or not. If available, return IoUringIncubatorTransportFactory. + // Else + // We will check if Epoll is available or not. If available, return EpollTransportFactory. + // If none of the condition matches then no native transport is available, and we will throw an exception. + if (!PlatformDependent.isWindows()) { + if (IoUringIncubatorTransportFactory.isAvailable() && !config.isUseOnlyEpollNativeTransport()) { + return new IoUringIncubatorTransportFactory(); + } else if (EpollTransportFactory.isAvailable()) { + return new EpollTransportFactory(); + } + } + + throw new IllegalArgumentException("No suitable native transport (Epoll, Io_Uring or KQueue) available"); + } + + public static boolean isSslHandlerConfigured(ChannelPipeline pipeline) { + return pipeline.get(SSL_HANDLER) != null; + } + + private static Bootstrap newBootstrap(ChannelFactory channelFactory, EventLoopGroup eventLoopGroup, AsyncHttpClientConfig config) { + Bootstrap bootstrap = new Bootstrap().channelFactory(channelFactory).group(eventLoopGroup) + .option(ChannelOption.ALLOCATOR, config.getAllocator() != null ? config.getAllocator() : ByteBufAllocator.DEFAULT) + .option(ChannelOption.TCP_NODELAY, config.isTcpNoDelay()) + .option(ChannelOption.SO_REUSEADDR, config.isSoReuseAddress()) + .option(ChannelOption.SO_KEEPALIVE, config.isSoKeepAlive()) + .option(ChannelOption.AUTO_CLOSE, false); + + long connectTimeout = config.getConnectTimeout().toMillis(); + if (connectTimeout > 0) { + connectTimeout = Math.min(connectTimeout, Integer.MAX_VALUE); + bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, (int) connectTimeout); + } + + if (config.getSoLinger() >= 0) { + bootstrap.option(ChannelOption.SO_LINGER, config.getSoLinger()); + } + + if (config.getSoSndBuf() >= 0) { + bootstrap.option(ChannelOption.SO_SNDBUF, config.getSoSndBuf()); + } + + if (config.getSoRcvBuf() >= 0) { + bootstrap.option(ChannelOption.SO_RCVBUF, config.getSoRcvBuf()); + } + + for (Entry, Object> entry : config.getChannelOptions().entrySet()) { + bootstrap.option(entry.getKey(), entry.getValue()); + } + + return bootstrap; + } + + public void configureBootstraps(NettyRequestSender requestSender) { + final AsyncHttpClientHandler httpHandler = new HttpHandler(config, this, requestSender); + wsHandler = new WebSocketHandler(config, this, requestSender); + + httpBootstrap.handler(new ChannelInitializer() { + @Override + protected void initChannel(Channel ch) { + ChannelPipeline pipeline = ch.pipeline() + .addLast(HTTP_CLIENT_CODEC, newHttpClientCodec()); + + if (config.isEnableAutomaticDecompression()) { + // Add automatic decompression if desired + pipeline = pipeline.addLast(INFLATER_HANDLER, newHttpContentDecompressor()); + } + + pipeline = pipeline + .addLast(CHUNKED_WRITER_HANDLER, new ChunkedWriteHandler()) + .addLast(AHC_HTTP_HANDLER, httpHandler); + + if (LOGGER.isTraceEnabled()) { + pipeline.addFirst(LOGGING_HANDLER, new LoggingHandler(LogLevel.TRACE)); + } + + if (config.getHttpAdditionalChannelInitializer() != null) { + config.getHttpAdditionalChannelInitializer().accept(ch); + } + } + }); + + wsBootstrap.handler(new ChannelInitializer() { + @Override + protected void initChannel(Channel ch) { + ChannelPipeline pipeline = ch.pipeline() + .addLast(HTTP_CLIENT_CODEC, newHttpClientCodec()) + .addLast(AHC_WS_HANDLER, wsHandler); + + if (config.isEnableWebSocketCompression()) { + pipeline.addBefore(AHC_WS_HANDLER, WS_COMPRESSOR_HANDLER, WebSocketClientCompressionHandler.INSTANCE); + } + + if (LOGGER.isTraceEnabled()) { + pipeline.addFirst(LOGGING_HANDLER, new LoggingHandler(LogLevel.TRACE)); + } + + if (config.getWsAdditionalChannelInitializer() != null) { + config.getWsAdditionalChannelInitializer().accept(ch); + } + } + }); + } + + private HttpContentDecompressor newHttpContentDecompressor() { + if (config.isKeepEncodingHeader()) { + return new HttpContentDecompressor() { + @Override + protected String getTargetContentEncoding(String contentEncoding) { + return contentEncoding; + } + }; + } else { + return new HttpContentDecompressor(); + } + } + + public final void tryToOfferChannelToPool(Channel channel, AsyncHandler asyncHandler, boolean keepAlive, Object partitionKey) { + if (channel.isActive() && keepAlive) { + LOGGER.debug("Adding key: {} for channel {}", partitionKey, channel); + Channels.setDiscard(channel); + + try { + asyncHandler.onConnectionOffer(channel); + } catch (Exception e) { + LOGGER.error("onConnectionOffer crashed", e); + } + + if (!channelPool.offer(channel, partitionKey)) { + // rejected by pool + closeChannel(channel); + } + } else { + // not offered + closeChannel(channel); + } + } + + public Channel poll(Uri uri, String virtualHost, ProxyServer proxy, ChannelPoolPartitioning connectionPoolPartitioning) { + Object partitionKey = connectionPoolPartitioning.getPartitionKey(uri, virtualHost, proxy); + return channelPool.poll(partitionKey); + } + + public void removeAll(Channel connection) { + channelPool.removeAll(connection); + } + + private void doClose() { + ChannelGroupFuture groupFuture = openChannels.close(); + channelPool.destroy(); + groupFuture.addListener(future -> sslEngineFactory.destroy()); + } + + public void close() { + if (allowReleaseEventLoopGroup) { + final long shutdownQuietPeriod = config.getShutdownQuietPeriod().toMillis(); + final long shutdownTimeout = config.getShutdownTimeout().toMillis(); + eventLoopGroup + .shutdownGracefully(shutdownQuietPeriod, shutdownTimeout, TimeUnit.MILLISECONDS) + .addListener(future -> doClose()); + } else { + doClose(); + } + } + + public void closeChannel(Channel channel) { + LOGGER.debug("Closing Channel {} ", channel); + Channels.setDiscard(channel); + removeAll(channel); + Channels.silentlyCloseChannel(channel); + } + + public void registerOpenChannel(Channel channel) { + openChannels.add(channel); + } + + private HttpClientCodec newHttpClientCodec() { + return new HttpClientCodec(// + config.getHttpClientCodecMaxInitialLineLength(), + config.getHttpClientCodecMaxHeaderSize(), + config.getHttpClientCodecMaxChunkSize(), + false, + config.isValidateResponseHeaders(), + config.getHttpClientCodecInitialBufferSize()); + } + + private SslHandler createSslHandler(String peerHost, int peerPort) { + SSLEngine sslEngine = sslEngineFactory.newSslEngine(config, peerHost, peerPort); + SslHandler sslHandler = new SslHandler(sslEngine); + if (handshakeTimeout > 0) { + sslHandler.setHandshakeTimeoutMillis(handshakeTimeout); + } + return sslHandler; + } + + public Future updatePipelineForHttpTunneling(ChannelPipeline pipeline, Uri requestUri) { + Future whenHandshaked = null; + + if (pipeline.get(HTTP_CLIENT_CODEC) != null) { + pipeline.remove(HTTP_CLIENT_CODEC); + } + + if (requestUri.isSecured()) { + if (!isSslHandlerConfigured(pipeline)) { + SslHandler sslHandler = createSslHandler(requestUri.getHost(), requestUri.getExplicitPort()); + whenHandshaked = sslHandler.handshakeFuture(); + pipeline.addBefore(INFLATER_HANDLER, SSL_HANDLER, sslHandler); + } + pipeline.addAfter(SSL_HANDLER, HTTP_CLIENT_CODEC, newHttpClientCodec()); + + } else { + pipeline.addBefore(AHC_HTTP_HANDLER, HTTP_CLIENT_CODEC, newHttpClientCodec()); + } + + if (requestUri.isWebSocket()) { + pipeline.addAfter(AHC_HTTP_HANDLER, AHC_WS_HANDLER, wsHandler); + + if (config.isEnableWebSocketCompression()) { + pipeline.addBefore(AHC_WS_HANDLER, WS_COMPRESSOR_HANDLER, WebSocketClientCompressionHandler.INSTANCE); + } + + pipeline.remove(AHC_HTTP_HANDLER); + } + return whenHandshaked; + } + + public SslHandler addSslHandler(ChannelPipeline pipeline, Uri uri, String virtualHost, boolean hasSocksProxyHandler) { + String peerHost; + int peerPort; + + if (virtualHost != null) { + int i = virtualHost.indexOf(':'); + if (i == -1) { + peerHost = virtualHost; + peerPort = uri.getSchemeDefaultPort(); + } else { + peerHost = virtualHost.substring(0, i); + peerPort = Integer.valueOf(virtualHost.substring(i + 1)); + } + + } else { + peerHost = uri.getHost(); + peerPort = uri.getExplicitPort(); + } + + SslHandler sslHandler = createSslHandler(peerHost, peerPort); + if (hasSocksProxyHandler) { + pipeline.addAfter(SOCKS_HANDLER, SSL_HANDLER, sslHandler); + } else { + pipeline.addFirst(SSL_HANDLER, sslHandler); + } + return sslHandler; + } + + public Future getBootstrap(Uri uri, NameResolver nameResolver, ProxyServer proxy) { + final Promise promise = ImmediateEventExecutor.INSTANCE.newPromise(); + + if (uri.isWebSocket() && proxy == null) { + return promise.setSuccess(wsBootstrap); + } + + if (proxy != null && proxy.getProxyType().isSocks()) { + Bootstrap socksBootstrap = httpBootstrap.clone(); + ChannelHandler httpBootstrapHandler = socksBootstrap.config().handler(); + + nameResolver.resolve(proxy.getHost()).addListener((Future whenProxyAddress) -> { + if (whenProxyAddress.isSuccess()) { + socksBootstrap.handler(new ChannelInitializer() { + @Override + public void handlerAdded(ChannelHandlerContext ctx) throws Exception { + httpBootstrapHandler.handlerAdded(ctx); + super.handlerAdded(ctx); + } + + @Override + protected void initChannel(Channel channel) throws Exception { + InetSocketAddress proxyAddress = new InetSocketAddress(whenProxyAddress.get(), proxy.getPort()); + Realm realm = proxy.getRealm(); + String username = realm != null ? realm.getPrincipal() : null; + String password = realm != null ? realm.getPassword() : null; + ProxyHandler socksProxyHandler; + switch (proxy.getProxyType()) { + case SOCKS_V4: + socksProxyHandler = new Socks4ProxyHandler(proxyAddress, username); + break; + + case SOCKS_V5: + socksProxyHandler = new Socks5ProxyHandler(proxyAddress, username, password); + break; + + default: + throw new IllegalArgumentException("Only SOCKS4 and SOCKS5 supported at the moment."); + } + channel.pipeline().addFirst(SOCKS_HANDLER, socksProxyHandler); + } + }); + promise.setSuccess(socksBootstrap); + + } else { + promise.setFailure(whenProxyAddress.cause()); + } + }); + + } else { + promise.setSuccess(httpBootstrap); + } + + return promise; + } + + public void upgradePipelineForWebSockets(ChannelPipeline pipeline) { + pipeline.addAfter(HTTP_CLIENT_CODEC, WS_ENCODER_HANDLER, new WebSocket08FrameEncoder(true)); + pipeline.addAfter(WS_ENCODER_HANDLER, WS_DECODER_HANDLER, new WebSocket08FrameDecoder(false, + config.isEnableWebSocketCompression(), config.getWebSocketMaxFrameSize())); + + if (config.isAggregateWebSocketFrameFragments()) { + pipeline.addAfter(WS_DECODER_HANDLER, WS_FRAME_AGGREGATOR, new WebSocketFrameAggregator(config.getWebSocketMaxBufferSize())); + } + + pipeline.remove(HTTP_CLIENT_CODEC); + } + + private OnLastHttpContentCallback newDrainCallback(final NettyResponseFuture future, final Channel channel, final boolean keepAlive, final Object partitionKey) { + return new OnLastHttpContentCallback(future) { + @Override + public void call() { + tryToOfferChannelToPool(channel, future.getAsyncHandler(), keepAlive, partitionKey); + } + }; + } + + public void drainChannelAndOffer(Channel channel, NettyResponseFuture future) { + drainChannelAndOffer(channel, future, future.isKeepAlive(), future.getPartitionKey()); + } + + public void drainChannelAndOffer(Channel channel, NettyResponseFuture future, boolean keepAlive, Object partitionKey) { + Channels.setAttribute(channel, newDrainCallback(future, channel, keepAlive, partitionKey)); + } + + public ChannelPool getChannelPool() { + return channelPool; + } + + public EventLoopGroup getEventLoopGroup() { + return eventLoopGroup; + } + + public ClientStats getClientStats() { + Map totalConnectionsPerHost = openChannels.stream() + .map(Channel::remoteAddress) + .filter(a -> a instanceof InetSocketAddress) + .map(a -> (InetSocketAddress) a) + .map(InetSocketAddress::getHostString) + .collect(Collectors.groupingBy(Function.identity(), Collectors.counting())); + + Map idleConnectionsPerHost = channelPool.getIdleChannelCountPerHost(); + + Map statsPerHost = totalConnectionsPerHost.entrySet() + .stream() + .collect(Collectors.toMap(Entry::getKey, entry -> { + final long totalConnectionCount = entry.getValue(); + final long idleConnectionCount = idleConnectionsPerHost.getOrDefault(entry.getKey(), 0L); + final long activeConnectionCount = totalConnectionCount - idleConnectionCount; + return new HostStats(activeConnectionCount, idleConnectionCount); + })); + return new ClientStats(statsPerHost); + } + + public boolean isOpen() { + return channelPool.isOpen(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ChannelState.java b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelState.java new file mode 100644 index 0000000000..1b550983e6 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelState.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +public enum ChannelState { + /** + * The channel is new + */ + NEW, + + /** + * The channel is open and pooled + */ + POOLED, + + /** + * The channel is reconnected + */ + RECONNECTED, + + /** + * The channel is closed + */ + CLOSED, +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/Channels.java b/client/src/main/java/org/asynchttpclient/netty/channel/Channels.java new file mode 100755 index 0000000000..c56a05ba54 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/Channels.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.Channel; +import io.netty.util.Attribute; +import io.netty.util.AttributeKey; +import org.asynchttpclient.netty.DiscardEvent; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public final class Channels { + + private static final Logger LOGGER = LoggerFactory.getLogger(Channels.class); + + private static final AttributeKey DEFAULT_ATTRIBUTE = AttributeKey.valueOf("default"); + private static final AttributeKey ACTIVE_TOKEN_ATTRIBUTE = AttributeKey.valueOf("activeToken"); + + private Channels() { + // Prevent outside initialization + } + + public static Object getAttribute(Channel channel) { + Attribute attr = channel.attr(DEFAULT_ATTRIBUTE); + return attr != null ? attr.get() : null; + } + + public static void setAttribute(Channel channel, Object o) { + channel.attr(DEFAULT_ATTRIBUTE).set(o); + } + + public static void setDiscard(Channel channel) { + setAttribute(channel, DiscardEvent.DISCARD); + } + + public static boolean isChannelActive(Channel channel) { + return channel != null && channel.isActive(); + } + + public static void setActiveToken(Channel channel) { + channel.attr(ACTIVE_TOKEN_ATTRIBUTE).set(Active.INSTANCE); + } + + public static boolean isActiveTokenSet(Channel channel) { + return channel != null && channel.attr(ACTIVE_TOKEN_ATTRIBUTE).getAndSet(null) != null; + } + + public static void silentlyCloseChannel(Channel channel) { + try { + if (channel != null && channel.isActive()) { + channel.close(); + } + } catch (Throwable t) { + LOGGER.debug("Failed to close channel", t); + } + } + + private enum Active {INSTANCE} +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/CombinedConnectionSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/CombinedConnectionSemaphore.java new file mode 100644 index 0000000000..36748b077f --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/CombinedConnectionSemaphore.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +/** + * A combined {@link ConnectionSemaphore} with two limits - a global limit and a per-host limit + */ +public class CombinedConnectionSemaphore extends PerHostConnectionSemaphore { + protected final MaxConnectionSemaphore globalMaxConnectionSemaphore; + + CombinedConnectionSemaphore(int maxConnections, int maxConnectionsPerHost, int acquireTimeout) { + super(maxConnectionsPerHost, acquireTimeout); + globalMaxConnectionSemaphore = new MaxConnectionSemaphore(maxConnections, acquireTimeout); + } + + @Override + public void acquireChannelLock(Object partitionKey) throws IOException { + long remainingTime = acquireTimeout > 0 ? acquireGlobalTimed(partitionKey) : acquireGlobal(partitionKey); + + try { + if (remainingTime < 0 || !getFreeConnectionsForHost(partitionKey).tryAcquire(remainingTime, TimeUnit.MILLISECONDS)) { + releaseGlobal(partitionKey); + throw tooManyConnectionsPerHost; + } + } catch (InterruptedException e) { + releaseGlobal(partitionKey); + throw new RuntimeException(e); + } + } + + protected void releaseGlobal(Object partitionKey) { + globalMaxConnectionSemaphore.releaseChannelLock(partitionKey); + } + + protected long acquireGlobal(Object partitionKey) throws IOException { + globalMaxConnectionSemaphore.acquireChannelLock(partitionKey); + return 0; + } + + /* + * Acquires the global lock and returns the remaining time, in millis, to acquire the per-host lock + */ + protected long acquireGlobalTimed(Object partitionKey) throws IOException { + long beforeGlobalAcquire = System.currentTimeMillis(); + acquireGlobal(partitionKey); + long lockTime = System.currentTimeMillis() - beforeGlobalAcquire; + return acquireTimeout - lockTime; + } + + @Override + public void releaseChannelLock(Object partitionKey) { + globalMaxConnectionSemaphore.releaseChannelLock(partitionKey); + super.releaseChannelLock(partitionKey); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphore.java new file mode 100644 index 0000000000..300d0a8cd4 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphore.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import java.io.IOException; + +/** + * Connections limiter. + */ +public interface ConnectionSemaphore { + + void acquireChannelLock(Object partitionKey) throws IOException; + + void releaseChannelLock(Object partitionKey); +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphoreFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphoreFactory.java new file mode 100644 index 0000000000..d763f917f6 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/ConnectionSemaphoreFactory.java @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import org.asynchttpclient.AsyncHttpClientConfig; + +@FunctionalInterface +public interface ConnectionSemaphoreFactory { + + ConnectionSemaphore newConnectionSemaphore(AsyncHttpClientConfig config); +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java b/client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java new file mode 100755 index 0000000000..c4042fdfc7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java @@ -0,0 +1,388 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.Channel; +import io.netty.util.Attribute; +import io.netty.util.AttributeKey; +import io.netty.util.Timeout; +import io.netty.util.Timer; +import io.netty.util.TimerTask; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.channel.ChannelPool; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.InetSocketAddress; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Deque; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentLinkedDeque; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicIntegerFieldUpdater; +import java.util.function.Function; +import java.util.function.Predicate; +import java.util.stream.Collectors; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; + +/** + * A simple implementation of {@link ChannelPool} based on a {@link ConcurrentHashMap} + */ +public final class DefaultChannelPool implements ChannelPool { + + private static final Logger LOGGER = LoggerFactory.getLogger(DefaultChannelPool.class); + private static final AttributeKey CHANNEL_CREATION_ATTRIBUTE_KEY = AttributeKey.valueOf("channelCreation"); + + private final ConcurrentHashMap> partitions = new ConcurrentHashMap<>(); + private final AtomicBoolean isClosed = new AtomicBoolean(false); + private final Timer nettyTimer; + private final long connectionTtl; + private final boolean connectionTtlEnabled; + private final long maxIdleTime; + private final boolean maxIdleTimeEnabled; + private final long cleanerPeriod; + private final PoolLeaseStrategy poolLeaseStrategy; + + public DefaultChannelPool(AsyncHttpClientConfig config, Timer hashedWheelTimer) { + this(config.getPooledConnectionIdleTimeout(), + config.getConnectionTtl(), + hashedWheelTimer, + config.getConnectionPoolCleanerPeriod()); + } + + public DefaultChannelPool(Duration maxIdleTime, Duration connectionTtl, Timer nettyTimer, Duration cleanerPeriod) { + this(maxIdleTime, connectionTtl, PoolLeaseStrategy.LIFO, nettyTimer, cleanerPeriod); + } + + public DefaultChannelPool(Duration maxIdleTime, Duration connectionTtl, PoolLeaseStrategy poolLeaseStrategy, Timer nettyTimer, Duration cleanerPeriod) { + final long maxIdleTimeInMs = maxIdleTime.toMillis(); + final long connectionTtlInMs = connectionTtl.toMillis(); + final long cleanerPeriodInMs = cleanerPeriod.toMillis(); + this.maxIdleTime = maxIdleTimeInMs; + this.connectionTtl = connectionTtlInMs; + connectionTtlEnabled = connectionTtlInMs > 0; + this.nettyTimer = nettyTimer; + maxIdleTimeEnabled = maxIdleTimeInMs > 0; + this.poolLeaseStrategy = poolLeaseStrategy; + + this.cleanerPeriod = Math.min(cleanerPeriodInMs, Math.min(connectionTtlEnabled ? connectionTtlInMs : Integer.MAX_VALUE, + maxIdleTimeEnabled ? maxIdleTimeInMs : Integer.MAX_VALUE)); + + if (connectionTtlEnabled || maxIdleTimeEnabled) { + scheduleNewIdleChannelDetector(new IdleChannelDetector()); + } + } + + private void scheduleNewIdleChannelDetector(TimerTask task) { + nettyTimer.newTimeout(task, cleanerPeriod, TimeUnit.MILLISECONDS); + } + + private boolean isTtlExpired(Channel channel, long now) { + if (!connectionTtlEnabled) { + return false; + } + + ChannelCreation creation = channel.attr(CHANNEL_CREATION_ATTRIBUTE_KEY).get(); + return creation != null && now - creation.creationTime >= connectionTtl; + } + + @Override + public boolean offer(Channel channel, Object partitionKey) { + if (isClosed.get()) { + return false; + } + + long now = unpreciseMillisTime(); + + if (isTtlExpired(channel, now)) { + return false; + } + + boolean offered = offer0(channel, partitionKey, now); + if (connectionTtlEnabled && offered) { + registerChannelCreation(channel, partitionKey, now); + } + + return offered; + } + + private boolean offer0(Channel channel, Object partitionKey, long now) { + ConcurrentLinkedDeque partition = partitions.get(partitionKey); + if (partition == null) { + partition = partitions.computeIfAbsent(partitionKey, pk -> new ConcurrentLinkedDeque<>()); + } + return partition.offerFirst(new IdleChannel(channel, now)); + } + + private static void registerChannelCreation(Channel channel, Object partitionKey, long now) { + Attribute channelCreationAttribute = channel.attr(CHANNEL_CREATION_ATTRIBUTE_KEY); + if (channelCreationAttribute.get() == null) { + channelCreationAttribute.set(new ChannelCreation(now, partitionKey)); + } + } + + @Override + public Channel poll(Object partitionKey) { + IdleChannel idleChannel = null; + ConcurrentLinkedDeque partition = partitions.get(partitionKey); + if (partition != null) { + while (idleChannel == null) { + idleChannel = poolLeaseStrategy.lease(partition); + + if (idleChannel == null) + // pool is empty + { + break; + } else if (!Channels.isChannelActive(idleChannel.channel)) { + idleChannel = null; + LOGGER.trace("Channel is inactive, probably remotely closed!"); + } else if (!idleChannel.takeOwnership()) { + idleChannel = null; + LOGGER.trace("Couldn't take ownership of channel, probably in the process of being expired!"); + } + } + } + return idleChannel != null ? idleChannel.channel : null; + } + + @Override + public boolean removeAll(Channel channel) { + ChannelCreation creation = connectionTtlEnabled ? channel.attr(CHANNEL_CREATION_ATTRIBUTE_KEY).get() : null; + return !isClosed.get() && creation != null && partitions.get(creation.partitionKey).remove(new IdleChannel(channel, Long.MIN_VALUE)); + } + + @Override + public boolean isOpen() { + return !isClosed.get(); + } + + @Override + public void destroy() { + if (isClosed.getAndSet(true)) { + return; + } + + partitions.clear(); + } + + private static void close(Channel channel) { + // FIXME pity to have to do this here + Channels.setDiscard(channel); + Channels.silentlyCloseChannel(channel); + } + + private void flushPartition(Object partitionKey, ConcurrentLinkedDeque partition) { + if (partition != null) { + partitions.remove(partitionKey); + for (IdleChannel idleChannel : partition) { + close(idleChannel.channel); + } + } + } + + @Override + public void flushPartitions(Predicate predicate) { + for (Map.Entry> partitionsEntry : partitions.entrySet()) { + Object partitionKey = partitionsEntry.getKey(); + if (predicate.test(partitionKey)) { + flushPartition(partitionKey, partitionsEntry.getValue()); + } + } + } + + @Override + public Map getIdleChannelCountPerHost() { + return partitions + .values() + .stream() + .flatMap(ConcurrentLinkedDeque::stream) + .map(idle -> idle.getChannel().remoteAddress()) + .filter(a -> a.getClass() == InetSocketAddress.class) + .map(a -> (InetSocketAddress) a) + .map(InetSocketAddress::getHostString) + .collect(Collectors.groupingBy(Function.identity(), Collectors.counting())); + } + + public enum PoolLeaseStrategy { + LIFO { + @Override + public E lease(Deque d) { + return d.pollFirst(); + } + }, + FIFO { + @Override + public E lease(Deque d) { + return d.pollLast(); + } + }; + + abstract E lease(Deque d); + } + + private static final class ChannelCreation { + final long creationTime; + final Object partitionKey; + + ChannelCreation(long creationTime, Object partitionKey) { + this.creationTime = creationTime; + this.partitionKey = partitionKey; + } + } + + private static final class IdleChannel { + + private static final AtomicIntegerFieldUpdater ownedField = AtomicIntegerFieldUpdater.newUpdater(IdleChannel.class, "owned"); + + final Channel channel; + final long start; + @SuppressWarnings("unused") + private volatile int owned; + + IdleChannel(Channel channel, long start) { + this.channel = requireNonNull(channel, "channel"); + this.start = start; + } + + public boolean takeOwnership() { + return ownedField.getAndSet(this, 1) == 0; + } + + public Channel getChannel() { + return channel; + } + + @Override + // only depends on channel + public boolean equals(Object o) { + return this == o || o instanceof IdleChannel && channel.equals(((IdleChannel) o).channel); + } + + @Override + public int hashCode() { + return channel.hashCode(); + } + } + + private final class IdleChannelDetector implements TimerTask { + + private boolean isIdleTimeoutExpired(IdleChannel idleChannel, long now) { + return maxIdleTimeEnabled && now - idleChannel.start >= maxIdleTime; + } + + private List expiredChannels(ConcurrentLinkedDeque partition, long now) { + // lazy create + List idleTimeoutChannels = null; + for (IdleChannel idleChannel : partition) { + boolean isIdleTimeoutExpired = isIdleTimeoutExpired(idleChannel, now); + boolean isRemotelyClosed = !Channels.isChannelActive(idleChannel.channel); + boolean isTtlExpired = isTtlExpired(idleChannel.channel, now); + if (isIdleTimeoutExpired || isRemotelyClosed || isTtlExpired) { + + LOGGER.debug("Adding Candidate expired Channel {} isIdleTimeoutExpired={} isRemotelyClosed={} isTtlExpired={}", + idleChannel.channel, isIdleTimeoutExpired, isRemotelyClosed, isTtlExpired); + + if (idleTimeoutChannels == null) { + idleTimeoutChannels = new ArrayList<>(1); + } + idleTimeoutChannels.add(idleChannel); + } + } + + return idleTimeoutChannels != null ? idleTimeoutChannels : Collections.emptyList(); + } + + private List closeChannels(List candidates) { + // lazy create, only if we hit a non-closeable channel + List closedChannels = null; + for (int i = 0; i < candidates.size(); i++) { + // We call takeOwnership here to avoid closing a channel that has just been taken out + // of the pool, otherwise we risk closing an active connection. + IdleChannel idleChannel = candidates.get(i); + if (idleChannel.takeOwnership()) { + LOGGER.debug("Closing Idle Channel {}", idleChannel.channel); + close(idleChannel.channel); + if (closedChannels != null) { + closedChannels.add(idleChannel); + } + + } else if (closedChannels == null) { + // first non-closeable to be skipped, copy all + // previously skipped closeable channels + closedChannels = new ArrayList<>(candidates.size()); + for (int j = 0; j < i; j++) { + closedChannels.add(candidates.get(j)); + } + } + } + + return closedChannels != null ? closedChannels : candidates; + } + + @Override + public void run(Timeout timeout) { + + if (isClosed.get()) { + return; + } + + if (LOGGER.isDebugEnabled()) { + for (Map.Entry> entry : partitions.entrySet()) { + int size = entry.getValue().size(); + if (size > 0) { + LOGGER.debug("Entry count for : {} : {}", entry.getKey(), size); + } + } + } + + long start = unpreciseMillisTime(); + int closedCount = 0; + int totalCount = 0; + + for (ConcurrentLinkedDeque partition : partitions.values()) { + + // store in intermediate unsynchronized lists to minimize + // the impact on the ConcurrentLinkedDeque + if (LOGGER.isDebugEnabled()) { + totalCount += partition.size(); + } + + List closedChannels = closeChannels(expiredChannels(partition, start)); + + if (!closedChannels.isEmpty()) { + partition.removeAll(closedChannels); + closedCount += closedChannels.size(); + } + } + + if (LOGGER.isDebugEnabled()) { + long duration = unpreciseMillisTime() - start; + if (closedCount > 0) { + LOGGER.debug("Closed {} connections out of {} in {} ms", closedCount, totalCount, duration); + } + } + + scheduleNewIdleChannelDetector(timeout.task()); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/DefaultConnectionSemaphoreFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/DefaultConnectionSemaphoreFactory.java new file mode 100644 index 0000000000..cbe5c046e6 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/DefaultConnectionSemaphoreFactory.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import org.asynchttpclient.AsyncHttpClientConfig; + +public class DefaultConnectionSemaphoreFactory implements ConnectionSemaphoreFactory { + + @Override + public ConnectionSemaphore newConnectionSemaphore(AsyncHttpClientConfig config) { + int acquireFreeChannelTimeout = Math.max(0, config.getAcquireFreeChannelTimeout()); + int maxConnections = config.getMaxConnections(); + int maxConnectionsPerHost = config.getMaxConnectionsPerHost(); + + if (maxConnections > 0 && maxConnectionsPerHost > 0) { + return new CombinedConnectionSemaphore(maxConnections, maxConnectionsPerHost, acquireFreeChannelTimeout); + } + if (maxConnections > 0) { + return new MaxConnectionSemaphore(maxConnections, acquireFreeChannelTimeout); + } + if (maxConnectionsPerHost > 0) { + return new CombinedConnectionSemaphore(maxConnections, maxConnectionsPerHost, acquireFreeChannelTimeout); + } + + return new NoopConnectionSemaphore(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/EpollTransportFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/EpollTransportFactory.java new file mode 100644 index 0000000000..d24b32b706 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/EpollTransportFactory.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.epoll.Epoll; +import io.netty.channel.epoll.EpollEventLoopGroup; +import io.netty.channel.epoll.EpollSocketChannel; + +import java.util.concurrent.ThreadFactory; + +class EpollTransportFactory implements TransportFactory { + + static boolean isAvailable() { + try { + Class.forName("io.netty.channel.epoll.Epoll"); + } catch (ClassNotFoundException e) { + return false; + } + return Epoll.isAvailable(); + } + + @Override + public EpollSocketChannel newChannel() { + return new EpollSocketChannel(); + } + + @Override + public EpollEventLoopGroup newEventLoopGroup(int ioThreadsCount, ThreadFactory threadFactory) { + return new EpollEventLoopGroup(ioThreadsCount, threadFactory); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/InfiniteSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/InfiniteSemaphore.java new file mode 100644 index 0000000000..8d7cbdc3d9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/InfiniteSemaphore.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import java.util.Collection; +import java.util.Collections; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +/** + * A java.util.concurrent.Semaphore that always has Integer.Integer.MAX_VALUE free permits + * + * @author Alex Maltinsky + */ +public class InfiniteSemaphore extends Semaphore { + + public static final InfiniteSemaphore INSTANCE = new InfiniteSemaphore(); + private static final long serialVersionUID = 1L; + + private InfiniteSemaphore() { + super(Integer.MAX_VALUE); + } + + @Override + public void acquire() { + // NO-OP + } + + @Override + public void acquireUninterruptibly() { + // NO-OP + } + + @Override + public boolean tryAcquire() { + return true; + } + + @Override + public boolean tryAcquire(long timeout, TimeUnit unit) { + return true; + } + + @Override + public void release() { + // NO-OP + } + + @Override + public void acquire(int permits) { + // NO-OP + } + + @Override + public void acquireUninterruptibly(int permits) { + // NO-OP + } + + @Override + public boolean tryAcquire(int permits) { + return true; + } + + @Override + public boolean tryAcquire(int permits, long timeout, TimeUnit unit) { + return true; + } + + @Override + public void release(int permits) { + // NO-OP + } + + @Override + public int availablePermits() { + return Integer.MAX_VALUE; + } + + @Override + public int drainPermits() { + return Integer.MAX_VALUE; + } + + @Override + protected void reducePermits(int reduction) { + // NO-OP + } + + @Override + public boolean isFair() { + return true; + } + + @Override + protected Collection getQueuedThreads() { + return Collections.emptyList(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/IoUringIncubatorTransportFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/IoUringIncubatorTransportFactory.java new file mode 100644 index 0000000000..2065ef10b8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/IoUringIncubatorTransportFactory.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2022-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.incubator.channel.uring.IOUring; +import io.netty.incubator.channel.uring.IOUringEventLoopGroup; +import io.netty.incubator.channel.uring.IOUringSocketChannel; + +import java.util.concurrent.ThreadFactory; + +class IoUringIncubatorTransportFactory implements TransportFactory { + + static boolean isAvailable() { + try { + Class.forName("io.netty.incubator.channel.uring.IOUring"); + } catch (ClassNotFoundException e) { + return false; + } + return IOUring.isAvailable(); + } + + @Override + public IOUringSocketChannel newChannel() { + return new IOUringSocketChannel(); + } + + @Override + public IOUringEventLoopGroup newEventLoopGroup(int ioThreadsCount, ThreadFactory threadFactory) { + return new IOUringEventLoopGroup(ioThreadsCount, threadFactory); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/KQueueTransportFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/KQueueTransportFactory.java new file mode 100644 index 0000000000..54bcfe0d48 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/KQueueTransportFactory.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2019-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.kqueue.KQueue; +import io.netty.channel.kqueue.KQueueEventLoopGroup; +import io.netty.channel.kqueue.KQueueSocketChannel; + +import java.util.concurrent.ThreadFactory; + +class KQueueTransportFactory implements TransportFactory { + + static boolean isAvailable() { + try { + Class.forName("io.netty.channel.kqueue.KQueue"); + } catch (ClassNotFoundException e) { + return false; + } + return KQueue.isAvailable(); + } + + @Override + public KQueueSocketChannel newChannel() { + return new KQueueSocketChannel(); + } + + @Override + public KQueueEventLoopGroup newEventLoopGroup(int ioThreadsCount, ThreadFactory threadFactory) { + return new KQueueEventLoopGroup(ioThreadsCount, threadFactory); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/MaxConnectionSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/MaxConnectionSemaphore.java new file mode 100644 index 0000000000..7640b0e1fa --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/MaxConnectionSemaphore.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import org.asynchttpclient.exception.TooManyConnectionsException; + +import java.io.IOException; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +/** + * Max connections limiter. + * + * @author Stepan Koltsov + * @author Alex Maltinsky + */ +public class MaxConnectionSemaphore implements ConnectionSemaphore { + + protected final Semaphore freeChannels; + protected final IOException tooManyConnections; + protected final int acquireTimeout; + + MaxConnectionSemaphore(int maxConnections, int acquireTimeout) { + tooManyConnections = unknownStackTrace(new TooManyConnectionsException(maxConnections), MaxConnectionSemaphore.class, "acquireChannelLock"); + freeChannels = maxConnections > 0 ? new Semaphore(maxConnections) : InfiniteSemaphore.INSTANCE; + this.acquireTimeout = Math.max(0, acquireTimeout); + } + + @Override + public void acquireChannelLock(Object partitionKey) throws IOException { + try { + if (!freeChannels.tryAcquire(acquireTimeout, TimeUnit.MILLISECONDS)) { + throw tooManyConnections; + } + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + + @Override + public void releaseChannelLock(Object partitionKey) { + freeChannels.release(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/NettyChannelConnector.java b/client/src/main/java/org/asynchttpclient/netty/channel/NettyChannelConnector.java new file mode 100644 index 0000000000..3f5da5d7b7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/NettyChannelConnector.java @@ -0,0 +1,112 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.bootstrap.Bootstrap; +import io.netty.channel.Channel; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClientState; +import org.asynchttpclient.netty.SimpleChannelFutureListener; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.util.List; +import java.util.concurrent.RejectedExecutionException; +import java.util.concurrent.atomic.AtomicIntegerFieldUpdater; + +public class NettyChannelConnector { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyChannelConnector.class); + + private static final AtomicIntegerFieldUpdater I_UPDATER = AtomicIntegerFieldUpdater + .newUpdater(NettyChannelConnector.class, "i"); + + private final AsyncHandler asyncHandler; + private final InetSocketAddress localAddress; + private final List remoteAddresses; + private final AsyncHttpClientState clientState; + private volatile int i; + + public NettyChannelConnector(InetAddress localAddress, List remoteAddresses, AsyncHandler asyncHandler, AsyncHttpClientState clientState) { + this.localAddress = localAddress != null ? new InetSocketAddress(localAddress, 0) : null; + this.remoteAddresses = remoteAddresses; + this.asyncHandler = asyncHandler; + this.clientState = clientState; + } + + private boolean pickNextRemoteAddress() { + I_UPDATER.incrementAndGet(this); + return i < remoteAddresses.size(); + } + + public void connect(final Bootstrap bootstrap, final NettyConnectListener connectListener) { + final InetSocketAddress remoteAddress = remoteAddresses.get(i); + + try { + asyncHandler.onTcpConnectAttempt(remoteAddress); + } catch (Exception e) { + LOGGER.error("onTcpConnectAttempt crashed", e); + connectListener.onFailure(null, e); + return; + } + + try { + connect0(bootstrap, connectListener, remoteAddress); + } catch (RejectedExecutionException e) { + if (clientState.isClosed()) { + LOGGER.info("Connect crash but engine is shutting down"); + } else { + connectListener.onFailure(null, e); + } + } + } + + private void connect0(Bootstrap bootstrap, final NettyConnectListener connectListener, InetSocketAddress remoteAddress) { + bootstrap.connect(remoteAddress, localAddress) + .addListener(new SimpleChannelFutureListener() { + @Override + public void onSuccess(Channel channel) { + try { + asyncHandler.onTcpConnectSuccess(remoteAddress, channel); + } catch (Exception e) { + LOGGER.error("onTcpConnectSuccess crashed", e); + connectListener.onFailure(channel, e); + return; + } + connectListener.onSuccess(channel, remoteAddress); + } + + @Override + public void onFailure(Channel channel, Throwable t) { + try { + asyncHandler.onTcpConnectFailure(remoteAddress, t); + } catch (Exception e) { + LOGGER.error("onTcpConnectFailure crashed", e); + connectListener.onFailure(channel, e); + return; + } + boolean retry = pickNextRemoteAddress(); + if (retry) { + connect(bootstrap, connectListener); + } else { + connectListener.onFailure(channel, t); + } + } + }); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/NettyConnectListener.java b/client/src/main/java/org/asynchttpclient/netty/channel/NettyConnectListener.java new file mode 100755 index 0000000000..719733f8ae --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/NettyConnectListener.java @@ -0,0 +1,177 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.ssl.SslHandler; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.Request; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.SimpleFutureListener; +import org.asynchttpclient.netty.future.StackTraceInspector; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.netty.timeout.TimeoutsHolder; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.ConnectException; +import java.net.InetSocketAddress; + +/** + * Non Blocking connect. + */ +public final class NettyConnectListener { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyConnectListener.class); + + private final NettyRequestSender requestSender; + private final NettyResponseFuture future; + private final ChannelManager channelManager; + private final ConnectionSemaphore connectionSemaphore; + + public NettyConnectListener(NettyResponseFuture future, NettyRequestSender requestSender, ChannelManager channelManager, ConnectionSemaphore connectionSemaphore) { + this.future = future; + this.requestSender = requestSender; + this.channelManager = channelManager; + this.connectionSemaphore = connectionSemaphore; + } + + private boolean futureIsAlreadyCancelled(Channel channel) { + // If Future is cancelled then we will close the channel silently + if (future.isCancelled()) { + Channels.silentlyCloseChannel(channel); + return true; + } + return false; + } + + private void writeRequest(Channel channel) { + if (futureIsAlreadyCancelled(channel)) { + return; + } + + if (LOGGER.isDebugEnabled()) { + HttpRequest httpRequest = future.getNettyRequest().getHttpRequest(); + LOGGER.debug("Using new Channel '{}' for '{}' to '{}'", channel, httpRequest.method(), httpRequest.uri()); + } + + Channels.setAttribute(channel, future); + + channelManager.registerOpenChannel(channel); + future.attachChannel(channel, false); + requestSender.writeRequest(future, channel); + } + + public void onSuccess(Channel channel, InetSocketAddress remoteAddress) { + if (connectionSemaphore != null) { + // transfer lock from future to channel + Object partitionKeyLock = future.takePartitionKeyLock(); + + if (partitionKeyLock != null) { + channel.closeFuture().addListener(future -> connectionSemaphore.releaseChannelLock(partitionKeyLock)); + } + } + + Channels.setActiveToken(channel); + TimeoutsHolder timeoutsHolder = future.getTimeoutsHolder(); + + if (futureIsAlreadyCancelled(channel)) { + return; + } + + Request request = future.getTargetRequest(); + Uri uri = request.getUri(); + timeoutsHolder.setResolvedRemoteAddress(remoteAddress); + ProxyServer proxyServer = future.getProxyServer(); + + // in case of proxy tunneling, we'll add the SslHandler later, after the CONNECT request + if ((proxyServer == null || proxyServer.getProxyType().isSocks()) && uri.isSecured()) { + SslHandler sslHandler; + try { + sslHandler = channelManager.addSslHandler(channel.pipeline(), uri, request.getVirtualHost(), proxyServer != null); + } catch (Exception sslError) { + onFailure(channel, sslError); + return; + } + + final AsyncHandler asyncHandler = future.getAsyncHandler(); + + try { + asyncHandler.onTlsHandshakeAttempt(); + } catch (Exception e) { + LOGGER.error("onTlsHandshakeAttempt crashed", e); + onFailure(channel, e); + return; + } + + sslHandler.handshakeFuture().addListener(new SimpleFutureListener() { + @Override + protected void onSuccess(Channel value) { + try { + asyncHandler.onTlsHandshakeSuccess(sslHandler.engine().getSession()); + } catch (Exception e) { + LOGGER.error("onTlsHandshakeSuccess crashed", e); + NettyConnectListener.this.onFailure(channel, e); + return; + } + writeRequest(channel); + } + + @Override + protected void onFailure(Throwable cause) { + try { + asyncHandler.onTlsHandshakeFailure(cause); + } catch (Exception e) { + LOGGER.error("onTlsHandshakeFailure crashed", e); + NettyConnectListener.this.onFailure(channel, e); + return; + } + NettyConnectListener.this.onFailure(channel, cause); + } + }); + + } else { + writeRequest(channel); + } + } + + public void onFailure(Channel channel, Throwable cause) { + + // beware, channel can be null + Channels.silentlyCloseChannel(channel); + + boolean canRetry = future.incrementRetryAndCheck(); + LOGGER.debug("Trying to recover from failing to connect channel {} with a retry value of {} ", channel, canRetry); + if (canRetry// + && cause != null // FIXME when can we have a null cause? + && (future.getChannelState() != ChannelState.NEW || StackTraceInspector.recoverOnNettyDisconnectException(cause))) { + + if (requestSender.retry(future)) { + return; + } + } + + LOGGER.debug("Failed to recover from connect exception: {} with channel {}", cause, channel); + + String message = cause.getMessage() != null ? cause.getMessage() : future.getUri().getBaseUrl(); + ConnectException e = new ConnectException(message); + e.initCause(cause); + future.abort(e); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/NioTransportFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/NioTransportFactory.java new file mode 100644 index 0000000000..96eeb37509 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/NioTransportFactory.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2019-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.nio.NioEventLoopGroup; +import io.netty.channel.socket.nio.NioSocketChannel; + +import java.util.concurrent.ThreadFactory; + +enum NioTransportFactory implements TransportFactory { + + INSTANCE; + + @Override + public NioSocketChannel newChannel() { + return new NioSocketChannel(); + } + + @Override + public NioEventLoopGroup newEventLoopGroup(int ioThreadsCount, ThreadFactory threadFactory) { + return new NioEventLoopGroup(ioThreadsCount, threadFactory); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/NoopConnectionSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/NoopConnectionSemaphore.java new file mode 100644 index 0000000000..40afe12be5 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/NoopConnectionSemaphore.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import java.io.IOException; + +/** + * No-op implementation of {@link ConnectionSemaphore}. + */ +public class NoopConnectionSemaphore implements ConnectionSemaphore { + + @Override + public void acquireChannelLock(Object partitionKey) throws IOException { + } + + @Override + public void releaseChannelLock(Object partitionKey) { + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/PerHostConnectionSemaphore.java b/client/src/main/java/org/asynchttpclient/netty/channel/PerHostConnectionSemaphore.java new file mode 100644 index 0000000000..5930c0e959 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/PerHostConnectionSemaphore.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import org.asynchttpclient.exception.TooManyConnectionsPerHostException; + +import java.io.IOException; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +/** + * Max per-host connections limiter. + */ +public class PerHostConnectionSemaphore implements ConnectionSemaphore { + + protected final ConcurrentHashMap freeChannelsPerHost = new ConcurrentHashMap<>(); + protected final int maxConnectionsPerHost; + protected final IOException tooManyConnectionsPerHost; + protected final int acquireTimeout; + + PerHostConnectionSemaphore(int maxConnectionsPerHost, int acquireTimeout) { + tooManyConnectionsPerHost = unknownStackTrace(new TooManyConnectionsPerHostException(maxConnectionsPerHost), + PerHostConnectionSemaphore.class, "acquireChannelLock"); + this.maxConnectionsPerHost = maxConnectionsPerHost; + this.acquireTimeout = Math.max(0, acquireTimeout); + } + + @Override + public void acquireChannelLock(Object partitionKey) throws IOException { + try { + if (!getFreeConnectionsForHost(partitionKey).tryAcquire(acquireTimeout, TimeUnit.MILLISECONDS)) { + throw tooManyConnectionsPerHost; + } + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + + @Override + public void releaseChannelLock(Object partitionKey) { + getFreeConnectionsForHost(partitionKey).release(); + } + + protected Semaphore getFreeConnectionsForHost(Object partitionKey) { + return maxConnectionsPerHost > 0 ? + freeChannelsPerHost.computeIfAbsent(partitionKey, pk -> new Semaphore(maxConnectionsPerHost)) : + InfiniteSemaphore.INSTANCE; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/TransportFactory.java b/client/src/main/java/org/asynchttpclient/netty/channel/TransportFactory.java new file mode 100644 index 0000000000..e833fdecf9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/channel/TransportFactory.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2019-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelFactory; +import io.netty.channel.EventLoopGroup; + +import java.util.concurrent.ThreadFactory; + +public interface TransportFactory extends ChannelFactory { + + L newEventLoopGroup(int ioThreadsCount, ThreadFactory threadFactory); +} diff --git a/client/src/main/java/org/asynchttpclient/netty/future/StackTraceInspector.java b/client/src/main/java/org/asynchttpclient/netty/future/StackTraceInspector.java new file mode 100755 index 0000000000..28a0f359de --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/future/StackTraceInspector.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.future; + +import java.io.IOException; +import java.nio.channels.ClosedChannelException; + +public final class StackTraceInspector { + + private StackTraceInspector() { + // Prevent outside initialization + } + + private static boolean exceptionInMethod(Throwable t, String className, String methodName) { + try { + for (StackTraceElement element : t.getStackTrace()) { + if (element.getClassName().equals(className) && element.getMethodName().equals(methodName)) { + return true; + } + } + } catch (Throwable ignore) { + } + return false; + } + + private static boolean recoverOnConnectCloseException(Throwable t) { + while (true) { + if (exceptionInMethod(t, "sun.nio.ch.SocketChannelImpl", "checkConnect")) { + return true; + } + if (t.getCause() == null) { + return false; + } + t = t.getCause(); + } + } + + public static boolean recoverOnNettyDisconnectException(Throwable t) { + return t instanceof ClosedChannelException + || exceptionInMethod(t, "io.netty.handler.ssl.SslHandler", "disconnect") + || t.getCause() != null && recoverOnConnectCloseException(t.getCause()); + } + + public static boolean recoverOnReadOrWriteException(Throwable t) { + while (true) { + if (t instanceof IOException && "Connection reset by peer".equalsIgnoreCase(t.getMessage())) { + return true; + } + + try { + for (StackTraceElement element : t.getStackTrace()) { + String className = element.getClassName(); + String methodName = element.getMethodName(); + if ("sun.nio.ch.SocketDispatcher".equals(className) && ("read".equals(methodName) || "write".equals(methodName))) { + return true; + } + } + } catch (Throwable ignore) { + } + + if (t.getCause() == null) { + return false; + } + t = t.getCause(); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/AsyncHttpClientHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/AsyncHttpClientHandler.java new file mode 100755 index 0000000000..aeecbef553 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/AsyncHttpClientHandler.java @@ -0,0 +1,206 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInboundHandlerAdapter; +import io.netty.handler.codec.PrematureChannelClosureException; +import io.netty.handler.codec.http.LastHttpContent; +import io.netty.util.ReferenceCountUtil; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.exception.ChannelClosedException; +import org.asynchttpclient.netty.DiscardEvent; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.OnLastHttpContentCallback; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.future.StackTraceInspector; +import org.asynchttpclient.netty.handler.intercept.Interceptors; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.nio.channels.ClosedChannelException; + +import static org.asynchttpclient.util.MiscUtils.getCause; + +public abstract class AsyncHttpClientHandler extends ChannelInboundHandlerAdapter { + + protected final Logger logger = LoggerFactory.getLogger(getClass()); + + protected final AsyncHttpClientConfig config; + protected final ChannelManager channelManager; + protected final NettyRequestSender requestSender; + final Interceptors interceptors; + final boolean hasIOExceptionFilters; + + AsyncHttpClientHandler(AsyncHttpClientConfig config, + ChannelManager channelManager, + NettyRequestSender requestSender) { + this.config = config; + this.channelManager = channelManager; + this.requestSender = requestSender; + interceptors = new Interceptors(config, channelManager, requestSender); + hasIOExceptionFilters = !config.getIoExceptionFilters().isEmpty(); + } + + @Override + public void channelRead(final ChannelHandlerContext ctx, Object msg) throws Exception { + Channel channel = ctx.channel(); + Object attribute = Channels.getAttribute(channel); + + try { + if (attribute instanceof OnLastHttpContentCallback) { + if (msg instanceof LastHttpContent) { + ((OnLastHttpContentCallback) attribute).call(); + } + } else if (attribute instanceof NettyResponseFuture) { + NettyResponseFuture future = (NettyResponseFuture) attribute; + future.touch(); + handleRead(channel, future, msg); + } else if (attribute != DiscardEvent.DISCARD) { + // unhandled message + logger.debug("Orphan channel {} with attribute {} received message {}, closing", channel, attribute, msg); + Channels.silentlyCloseChannel(channel); + } + } finally { + ReferenceCountUtil.release(msg); + } + } + + @Override + public void channelInactive(ChannelHandlerContext ctx) throws Exception { + if (requestSender.isClosed()) { + return; + } + + Channel channel = ctx.channel(); + channelManager.removeAll(channel); + + Object attribute = Channels.getAttribute(channel); + logger.debug("Channel Closed: {} with attribute {}", channel, attribute); + if (attribute instanceof OnLastHttpContentCallback) { + OnLastHttpContentCallback callback = (OnLastHttpContentCallback) attribute; + Channels.setAttribute(channel, callback.future()); + callback.call(); + + } else if (attribute instanceof NettyResponseFuture) { + NettyResponseFuture future = (NettyResponseFuture) attribute; + future.touch(); + + if (hasIOExceptionFilters && requestSender.applyIoExceptionFiltersAndReplayRequest(future, ChannelClosedException.INSTANCE, channel)) { + return; + } + + handleChannelInactive(future); + requestSender.handleUnexpectedClosedChannel(channel, future); + } + } + + @Override + public void exceptionCaught(ChannelHandlerContext ctx, Throwable e) { + Throwable cause = getCause(e); + + if (cause instanceof PrematureChannelClosureException || cause instanceof ClosedChannelException) { + return; + } + + Channel channel = ctx.channel(); + NettyResponseFuture future = null; + + logger.debug("Unexpected I/O exception on channel {}", channel, cause); + + try { + Object attribute = Channels.getAttribute(channel); + if (attribute instanceof NettyResponseFuture) { + future = (NettyResponseFuture) attribute; + future.attachChannel(null, false); + future.touch(); + + if (cause instanceof IOException) { + // FIXME why drop the original exception and throw a new one? + if (hasIOExceptionFilters) { + if (!requestSender.applyIoExceptionFiltersAndReplayRequest(future, ChannelClosedException.INSTANCE, channel)) { + // Close the channel so the recovering can occurs. + Channels.silentlyCloseChannel(channel); + } + return; + } + } + + if (StackTraceInspector.recoverOnReadOrWriteException(cause)) { + logger.debug("Trying to recover from dead Channel: {}", channel); + future.pendingException = cause; + return; + } + } else if (attribute instanceof OnLastHttpContentCallback) { + future = ((OnLastHttpContentCallback) attribute).future(); + } + } catch (Throwable t) { + cause = t; + } + + if (future != null) { + try { + logger.debug("Was unable to recover Future: {}", future); + requestSender.abort(channel, future, cause); + handleException(future, e); + } catch (Throwable t) { + logger.error(t.getMessage(), t); + } + } + + channelManager.closeChannel(channel); + // FIXME not really sure + // ctx.fireChannelRead(e); + Channels.silentlyCloseChannel(channel); + } + + @Override + public void channelActive(ChannelHandlerContext ctx) { + ctx.read(); + } + + @Override + public void channelReadComplete(ChannelHandlerContext ctx) { + ctx.read(); + } + + void finishUpdate(NettyResponseFuture future, Channel channel, boolean close) { + future.cancelTimeouts(); + + if (close) { + channelManager.closeChannel(channel); + } else { + channelManager.tryToOfferChannelToPool(channel, future.getAsyncHandler(), true, future.getPartitionKey()); + } + + try { + future.done(); + } catch (Exception t) { + // Never propagate exception once we know we are done. + logger.debug(t.getMessage(), t); + } + } + + public abstract void handleRead(Channel channel, NettyResponseFuture future, Object message) throws Exception; + + public abstract void handleException(NettyResponseFuture future, Throwable error); + + public abstract void handleChannelInactive(NettyResponseFuture future); +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/HttpHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/HttpHandler.java new file mode 100755 index 0000000000..99a23c7e96 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/HttpHandler.java @@ -0,0 +1,156 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler; + +import io.netty.buffer.ByteBuf; +import io.netty.channel.Channel; +import io.netty.channel.ChannelHandler.Sharable; +import io.netty.handler.codec.DecoderResultProvider; +import io.netty.handler.codec.http.HttpContent; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.LastHttpContent; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHandler.State; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.NettyResponseStatus; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.util.HttpConstants.ResponseStatusCodes; + +import java.io.IOException; +import java.net.InetSocketAddress; + +@Sharable +public final class HttpHandler extends AsyncHttpClientHandler { + + public HttpHandler(AsyncHttpClientConfig config, ChannelManager channelManager, NettyRequestSender requestSender) { + super(config, channelManager, requestSender); + } + + private static boolean abortAfterHandlingStatus(AsyncHandler handler, HttpMethod httpMethod, NettyResponseStatus status) throws Exception { + // For non-200 response of a CONNECT request, it's still unconnected. + // We need to either close the connection or reuse it but send CONNECT request again. + // The former one is easier or we have to attach more state to Channel. + return handler.onStatusReceived(status) == State.ABORT || httpMethod == HttpMethod.CONNECT && status.getStatusCode() != ResponseStatusCodes.OK_200; + } + + private static boolean abortAfterHandlingHeaders(AsyncHandler handler, HttpHeaders responseHeaders) throws Exception { + return !responseHeaders.isEmpty() && handler.onHeadersReceived(responseHeaders) == State.ABORT; + } + + private void handleHttpResponse(final HttpResponse response, final Channel channel, final NettyResponseFuture future, AsyncHandler handler) throws Exception { + HttpRequest httpRequest = future.getNettyRequest().getHttpRequest(); + logger.debug("\n\nRequest {}\n\nResponse {}\n", httpRequest, response); + + future.setKeepAlive(config.getKeepAliveStrategy().keepAlive((InetSocketAddress) channel.remoteAddress(), future.getTargetRequest(), httpRequest, response)); + + NettyResponseStatus status = new NettyResponseStatus(future.getUri(), response, channel); + HttpHeaders responseHeaders = response.headers(); + + if (!interceptors.exitAfterIntercept(channel, future, handler, response, status, responseHeaders)) { + boolean abort = abortAfterHandlingStatus(handler, httpRequest.method(), status) || abortAfterHandlingHeaders(handler, responseHeaders); + if (abort) { + finishUpdate(future, channel, true); + } + } + } + + private void handleChunk(HttpContent chunk, final Channel channel, final NettyResponseFuture future, AsyncHandler handler) throws Exception { + boolean abort = false; + boolean last = chunk instanceof LastHttpContent; + + // Netty 4: the last chunk is not empty + if (last) { + LastHttpContent lastChunk = (LastHttpContent) chunk; + HttpHeaders trailingHeaders = lastChunk.trailingHeaders(); + if (!trailingHeaders.isEmpty()) { + abort = handler.onTrailingHeadersReceived(trailingHeaders) == State.ABORT; + } + } + + ByteBuf buf = chunk.content(); + if (!abort && (buf.isReadable() || last)) { + HttpResponseBodyPart bodyPart = config.getResponseBodyPartFactory().newResponseBodyPart(buf, last); + abort = handler.onBodyPartReceived(bodyPart) == State.ABORT; + } + + if (abort || last) { + boolean close = abort || !future.isKeepAlive(); + finishUpdate(future, channel, close); + } + } + + @Override + public void handleRead(final Channel channel, final NettyResponseFuture future, final Object e) throws Exception { + // future is already done because of an exception or a timeout + if (future.isDone()) { + // FIXME isn't the channel already properly closed? + channelManager.closeChannel(channel); + return; + } + + AsyncHandler handler = future.getAsyncHandler(); + try { + if (e instanceof DecoderResultProvider) { + DecoderResultProvider object = (DecoderResultProvider) e; + Throwable t = object.decoderResult().cause(); + if (t != null) { + readFailed(channel, future, t); + return; + } + } + + if (e instanceof HttpResponse) { + handleHttpResponse((HttpResponse) e, channel, future, handler); + + } else if (e instanceof HttpContent) { + handleChunk((HttpContent) e, channel, future, handler); + } + } catch (Exception t) { + // e.g. an IOException when trying to open a connection and send the + // next request + if (hasIOExceptionFilters && t instanceof IOException && requestSender.applyIoExceptionFiltersAndReplayRequest(future, (IOException) t, channel)) { + return; + } + + readFailed(channel, future, t); + throw t; + } + } + + private void readFailed(Channel channel, NettyResponseFuture future, Throwable t) { + try { + requestSender.abort(channel, future, t); + } catch (Exception abortException) { + logger.debug("Abort failed", abortException); + } finally { + finishUpdate(future, channel, true); + } + } + + @Override + public void handleException(NettyResponseFuture future, Throwable error) { + } + + @Override + public void handleChannelInactive(NettyResponseFuture future) { + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/WebSocketHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/WebSocketHandler.java new file mode 100755 index 0000000000..1cf19d0ef1 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/WebSocketHandler.java @@ -0,0 +1,173 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelHandler.Sharable; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.LastHttpContent; +import io.netty.handler.codec.http.websocketx.WebSocketFrame; +import org.asynchttpclient.AsyncHandler.State; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.NettyResponseStatus; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.netty.ws.NettyWebSocket; +import org.asynchttpclient.ws.WebSocketUpgradeHandler; + +import java.io.IOException; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONNECTION; +import static io.netty.handler.codec.http.HttpHeaderNames.SEC_WEBSOCKET_ACCEPT; +import static io.netty.handler.codec.http.HttpHeaderNames.SEC_WEBSOCKET_KEY; +import static io.netty.handler.codec.http.HttpHeaderNames.UPGRADE; +import static io.netty.handler.codec.http.HttpResponseStatus.SWITCHING_PROTOCOLS; +import static org.asynchttpclient.ws.WebSocketUtils.getAcceptKey; + +@Sharable +public final class WebSocketHandler extends AsyncHttpClientHandler { + + public WebSocketHandler(AsyncHttpClientConfig config, ChannelManager channelManager, NettyRequestSender requestSender) { + super(config, channelManager, requestSender); + } + + private static WebSocketUpgradeHandler getWebSocketUpgradeHandler(NettyResponseFuture future) { + return (WebSocketUpgradeHandler) future.getAsyncHandler(); + } + + private static NettyWebSocket getNettyWebSocket(NettyResponseFuture future) throws Exception { + return getWebSocketUpgradeHandler(future).onCompleted(); + } + + private void upgrade(Channel channel, NettyResponseFuture future, WebSocketUpgradeHandler handler, HttpResponse response, HttpHeaders responseHeaders) throws Exception { + boolean validStatus = response.status().equals(SWITCHING_PROTOCOLS); + boolean validUpgrade = response.headers().get(UPGRADE) != null; + String connection = response.headers().get(CONNECTION); + boolean validConnection = HttpHeaderValues.UPGRADE.contentEqualsIgnoreCase(connection); + final boolean headerOK = handler.onHeadersReceived(responseHeaders) == State.CONTINUE; + if (!headerOK || !validStatus || !validUpgrade || !validConnection) { + requestSender.abort(channel, future, new IOException("Invalid handshake response")); + return; + } + + String accept = response.headers().get(SEC_WEBSOCKET_ACCEPT); + String key = getAcceptKey(future.getNettyRequest().getHttpRequest().headers().get(SEC_WEBSOCKET_KEY)); + if (accept == null || !accept.equals(key)) { + requestSender.abort(channel, future, new IOException("Invalid challenge. Actual: " + accept + ". Expected: " + key)); + } + + // set back the future so the protocol gets notified of frames + // removing the HttpClientCodec from the pipeline might trigger a read with a WebSocket message + // if it comes in the same frame as the HTTP Upgrade response + Channels.setAttribute(channel, future); + + final NettyWebSocket webSocket = new NettyWebSocket(channel, responseHeaders); + handler.setWebSocket(webSocket); + channelManager.upgradePipelineForWebSockets(channel.pipeline()); + + // We don't need to synchronize as replacing the "ws-decoder" will + // process using the same thread. + try { + handler.onOpen(webSocket); + } catch (Exception ex) { + logger.warn("onSuccess unexpected exception", ex); + } + future.done(); + } + + private void abort(Channel channel, NettyResponseFuture future, WebSocketUpgradeHandler handler, HttpResponseStatus status) { + try { + handler.onThrowable(new IOException("Invalid Status code=" + status.getStatusCode() + " text=" + status.getStatusText())); + } finally { + finishUpdate(future, channel, true); + } + } + + @Override + public void handleRead(Channel channel, NettyResponseFuture future, Object e) throws Exception { + + if (e instanceof HttpResponse) { + HttpResponse response = (HttpResponse) e; + if (logger.isDebugEnabled()) { + HttpRequest httpRequest = future.getNettyRequest().getHttpRequest(); + logger.debug("\n\nRequest {}\n\nResponse {}\n", httpRequest, response); + } + + WebSocketUpgradeHandler handler = getWebSocketUpgradeHandler(future); + HttpResponseStatus status = new NettyResponseStatus(future.getUri(), response, channel); + HttpHeaders responseHeaders = response.headers(); + + if (!interceptors.exitAfterIntercept(channel, future, handler, response, status, responseHeaders)) { + if (handler.onStatusReceived(status) == State.CONTINUE) { + upgrade(channel, future, handler, response, responseHeaders); + } else { + abort(channel, future, handler, status); + } + } + + } else if (e instanceof WebSocketFrame) { + WebSocketFrame frame = (WebSocketFrame) e; + NettyWebSocket webSocket = getNettyWebSocket(future); + // retain because we might buffer the frame + if (webSocket.isReady()) { + webSocket.handleFrame(frame); + } else { + // WebSocket hasn't been opened yet, but upgrading the pipeline triggered a read and a frame was sent along the HTTP upgrade response + // as we want to keep sequential order (but can't notify user of open before upgrading, so he doesn't try to send immediately), we have to buffer + webSocket.bufferFrame(frame); + } + + } else if (!(e instanceof LastHttpContent)) { + // ignore, end of handshake response + logger.error("Invalid message {}", e); + } + } + + @Override + public void handleException(NettyResponseFuture future, Throwable e) { + logger.warn("onError", e); + + try { + NettyWebSocket webSocket = getNettyWebSocket(future); + if (webSocket != null) { + webSocket.onError(e); + webSocket.sendCloseFrame(); + } + } catch (Throwable t) { + logger.error("onError", t); + } + } + + @Override + public void handleChannelInactive(NettyResponseFuture future) { + logger.trace("Connection was closed abnormally (that is, with no close frame being received)."); + + try { + NettyWebSocket webSocket = getNettyWebSocket(future); + if (webSocket != null) { + webSocket.onClose(1006, "Connection was closed abnormally (that is, with no close frame being received)."); + } + } catch (Throwable t) { + logger.error("onError", t); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ConnectSuccessInterceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ConnectSuccessInterceptor.java new file mode 100644 index 0000000000..22e29dbfb1 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ConnectSuccessInterceptor.java @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.util.concurrent.Future; +import org.asynchttpclient.Request; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class ConnectSuccessInterceptor { + + private static final Logger LOGGER = LoggerFactory.getLogger(ConnectSuccessInterceptor.class); + + private final ChannelManager channelManager; + private final NettyRequestSender requestSender; + + ConnectSuccessInterceptor(ChannelManager channelManager, NettyRequestSender requestSender) { + this.channelManager = channelManager; + this.requestSender = requestSender; + } + + public boolean exitAfterHandlingConnect(Channel channel, NettyResponseFuture future, Request request, ProxyServer proxyServer) { + if (future.isKeepAlive()) { + future.attachChannel(channel, true); + } + + Uri requestUri = request.getUri(); + LOGGER.debug("Connecting to proxy {} for scheme {}", proxyServer, requestUri.getScheme()); + final Future whenHandshaked = channelManager.updatePipelineForHttpTunneling(channel.pipeline(), requestUri); + future.setReuseChannel(true); + future.setConnectAllowed(false); + + Request targetRequest = future.getTargetRequest().toBuilder().build(); + if (whenHandshaked == null) { + requestSender.drainChannelAndExecuteNextRequest(channel, future, targetRequest); + } else { + requestSender.drainChannelAndExecuteNextRequest(channel, future, targetRequest, whenHandshaked); + } + + return true; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Continue100Interceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Continue100Interceptor.java new file mode 100644 index 0000000000..aadd7f980a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Continue100Interceptor.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.OnLastHttpContentCallback; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.request.NettyRequestSender; + +class Continue100Interceptor { + + private final NettyRequestSender requestSender; + + Continue100Interceptor(NettyRequestSender requestSender) { + this.requestSender = requestSender; + } + + public boolean exitAfterHandling100(final Channel channel, final NettyResponseFuture future) { + future.setHeadersAlreadyWrittenOnContinue(true); + future.setDontWriteBodyBecauseExpectContinue(false); + // directly send the body + Channels.setAttribute(channel, new OnLastHttpContentCallback(future) { + @Override + public void call() { + Channels.setAttribute(channel, future); + requestSender.writeRequest(future, channel); + } + }); + return true; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Interceptors.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Interceptors.java new file mode 100644 index 0000000000..3de5bd40bb --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Interceptors.java @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.cookie.ClientCookieDecoder; +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.proxy.ProxyServer; + +import static io.netty.handler.codec.http.HttpHeaderNames.SET_COOKIE; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.CONTINUE_100; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.OK_200; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.PROXY_AUTHENTICATION_REQUIRED_407; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.UNAUTHORIZED_401; + +public class Interceptors { + + private final AsyncHttpClientConfig config; + private final Unauthorized401Interceptor unauthorized401Interceptor; + private final ProxyUnauthorized407Interceptor proxyUnauthorized407Interceptor; + private final Continue100Interceptor continue100Interceptor; + private final Redirect30xInterceptor redirect30xInterceptor; + private final ConnectSuccessInterceptor connectSuccessInterceptor; + private final ResponseFiltersInterceptor responseFiltersInterceptor; + private final boolean hasResponseFilters; + private final ClientCookieDecoder cookieDecoder; + + public Interceptors(AsyncHttpClientConfig config, + ChannelManager channelManager, + NettyRequestSender requestSender) { + this.config = config; + unauthorized401Interceptor = new Unauthorized401Interceptor(channelManager, requestSender); + proxyUnauthorized407Interceptor = new ProxyUnauthorized407Interceptor(channelManager, requestSender); + continue100Interceptor = new Continue100Interceptor(requestSender); + redirect30xInterceptor = new Redirect30xInterceptor(channelManager, config, requestSender); + connectSuccessInterceptor = new ConnectSuccessInterceptor(channelManager, requestSender); + responseFiltersInterceptor = new ResponseFiltersInterceptor(config, requestSender); + hasResponseFilters = !config.getResponseFilters().isEmpty(); + cookieDecoder = config.isUseLaxCookieEncoder() ? ClientCookieDecoder.LAX : ClientCookieDecoder.STRICT; + } + + public boolean exitAfterIntercept(Channel channel, NettyResponseFuture future, AsyncHandler handler, HttpResponse response, + HttpResponseStatus status, HttpHeaders responseHeaders) throws Exception { + + HttpRequest httpRequest = future.getNettyRequest().getHttpRequest(); + ProxyServer proxyServer = future.getProxyServer(); + int statusCode = response.status().code(); + Request request = future.getCurrentRequest(); + Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); + + // This MUST BE called before Redirect30xInterceptor because latter assumes cookie store is already updated + CookieStore cookieStore = config.getCookieStore(); + if (cookieStore != null) { + for (String cookieStr : responseHeaders.getAll(SET_COOKIE)) { + Cookie c = cookieDecoder.decode(cookieStr); + if (c != null) { + // Set-Cookie header could be invalid/malformed + cookieStore.add(future.getCurrentRequest().getUri(), c); + } + } + } + + if (hasResponseFilters && responseFiltersInterceptor.exitAfterProcessingFilters(channel, future, handler, status, responseHeaders)) { + return true; + } + + if (statusCode == UNAUTHORIZED_401) { + return unauthorized401Interceptor.exitAfterHandling401(channel, future, response, request, realm, httpRequest); + } + + if (statusCode == PROXY_AUTHENTICATION_REQUIRED_407) { + return proxyUnauthorized407Interceptor.exitAfterHandling407(channel, future, response, request, proxyServer, httpRequest); + } + + if (statusCode == CONTINUE_100) { + return continue100Interceptor.exitAfterHandling100(channel, future); + } + + if (Redirect30xInterceptor.REDIRECT_STATUSES.contains(statusCode)) { + return redirect30xInterceptor.exitAfterHandlingRedirect(channel, future, response, request, statusCode, realm); + } + + if (httpRequest.method() == HttpMethod.CONNECT && statusCode == OK_200) { + return connectSuccessInterceptor.exitAfterHandlingConnect(channel, future, request, proxyServer); + } + return false; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ProxyUnauthorized407Interceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ProxyUnauthorized407Interceptor.java new file mode 100644 index 0000000000..b30f6bbd94 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ProxyUnauthorized407Interceptor.java @@ -0,0 +1,215 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.HttpUtil; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.Request; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.channel.ChannelState; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.ntlm.NtlmEngine; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.spnego.SpnegoEngine; +import org.asynchttpclient.spnego.SpnegoEngineException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHENTICATE; +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static org.asynchttpclient.Dsl.realm; +import static org.asynchttpclient.util.AuthenticatorUtils.NEGOTIATE; +import static org.asynchttpclient.util.AuthenticatorUtils.getHeaderWithPrefix; +import static org.asynchttpclient.util.HttpConstants.Methods.CONNECT; + +public class ProxyUnauthorized407Interceptor { + + private static final Logger LOGGER = LoggerFactory.getLogger(ProxyUnauthorized407Interceptor.class); + + private final ChannelManager channelManager; + private final NettyRequestSender requestSender; + + ProxyUnauthorized407Interceptor(ChannelManager channelManager, NettyRequestSender requestSender) { + this.channelManager = channelManager; + this.requestSender = requestSender; + } + + public boolean exitAfterHandling407(Channel channel, NettyResponseFuture future, HttpResponse response, Request request, + ProxyServer proxyServer, HttpRequest httpRequest) { + + if (future.isAndSetInProxyAuth(true)) { + LOGGER.info("Can't handle 407 as auth was already performed"); + return false; + } + + Realm proxyRealm = future.getProxyRealm(); + + if (proxyRealm == null) { + LOGGER.debug("Can't handle 407 as there's no proxyRealm"); + return false; + } + + List proxyAuthHeaders = response.headers().getAll(PROXY_AUTHENTICATE); + + if (proxyAuthHeaders.isEmpty()) { + LOGGER.info("Can't handle 407 as response doesn't contain Proxy-Authenticate headers"); + return false; + } + + // FIXME what's this??? + future.setChannelState(ChannelState.NEW); + HttpHeaders requestHeaders = new DefaultHttpHeaders().add(request.getHeaders()); + + switch (proxyRealm.getScheme()) { + case BASIC: + if (getHeaderWithPrefix(proxyAuthHeaders, "Basic") == null) { + LOGGER.info("Can't handle 407 with Basic realm as Proxy-Authenticate headers don't match"); + return false; + } + + if (proxyRealm.isUsePreemptiveAuth()) { + // FIXME do we need this, as future.getAndSetAuth + // was tested above? + // auth was already performed, most likely auth + // failed + LOGGER.info("Can't handle 407 with Basic realm as auth was preemptive and already performed"); + return false; + } + + // FIXME do we want to update the realm, or directly + // set the header? + Realm newBasicRealm = realm(proxyRealm) + .setUsePreemptiveAuth(true) + .build(); + future.setProxyRealm(newBasicRealm); + break; + + case DIGEST: + String digestHeader = getHeaderWithPrefix(proxyAuthHeaders, "Digest"); + if (digestHeader == null) { + LOGGER.info("Can't handle 407 with Digest realm as Proxy-Authenticate headers don't match"); + return false; + } + Realm newDigestRealm = realm(proxyRealm) + .setUri(request.getUri()) + .setMethodName(request.getMethod()) + .setUsePreemptiveAuth(true) + .parseProxyAuthenticateHeader(digestHeader) + .build(); + future.setProxyRealm(newDigestRealm); + break; + + case NTLM: + String ntlmHeader = getHeaderWithPrefix(proxyAuthHeaders, "NTLM"); + if (ntlmHeader == null) { + LOGGER.info("Can't handle 407 with NTLM realm as Proxy-Authenticate headers don't match"); + return false; + } + ntlmProxyChallenge(ntlmHeader, requestHeaders, proxyRealm, future); + Realm newNtlmRealm = realm(proxyRealm) + .setUsePreemptiveAuth(true) + .build(); + future.setProxyRealm(newNtlmRealm); + break; + + case KERBEROS: + case SPNEGO: + if (getHeaderWithPrefix(proxyAuthHeaders, NEGOTIATE) == null) { + LOGGER.info("Can't handle 407 with Kerberos or Spnego realm as Proxy-Authenticate headers don't match"); + return false; + } + try { + kerberosProxyChallenge(proxyRealm, proxyServer, requestHeaders); + } catch (SpnegoEngineException e) { + String ntlmHeader2 = getHeaderWithPrefix(proxyAuthHeaders, "NTLM"); + if (ntlmHeader2 != null) { + LOGGER.warn("Kerberos/Spnego proxy auth failed, proceeding with NTLM"); + ntlmProxyChallenge(ntlmHeader2, requestHeaders, proxyRealm, future); + Realm newNtlmRealm2 = realm(proxyRealm) + .setScheme(AuthScheme.NTLM) + .setUsePreemptiveAuth(true) + .build(); + future.setProxyRealm(newNtlmRealm2); + } else { + requestSender.abort(channel, future, e); + return false; + } + } + break; + default: + throw new IllegalStateException("Invalid Authentication scheme " + proxyRealm.getScheme()); + } + + RequestBuilder nextRequestBuilder = future.getCurrentRequest().toBuilder().setHeaders(requestHeaders); + if (future.getCurrentRequest().getUri().isSecured()) { + nextRequestBuilder.setMethod(CONNECT); + } + final Request nextRequest = nextRequestBuilder.build(); + + LOGGER.debug("Sending proxy authentication to {}", request.getUri()); + if (future.isKeepAlive() + && !HttpUtil.isTransferEncodingChunked(httpRequest) + && !HttpUtil.isTransferEncodingChunked(response)) { + future.setConnectAllowed(true); + future.setReuseChannel(true); + requestSender.drainChannelAndExecuteNextRequest(channel, future, nextRequest); + } else { + channelManager.closeChannel(channel); + requestSender.sendNextRequest(nextRequest, future); + } + + return true; + } + + private static void kerberosProxyChallenge(Realm proxyRealm, ProxyServer proxyServer, HttpHeaders headers) throws SpnegoEngineException { + String challengeHeader = SpnegoEngine.instance(proxyRealm.getPrincipal(), + proxyRealm.getPassword(), + proxyRealm.getServicePrincipalName(), + proxyRealm.getRealmName(), + proxyRealm.isUseCanonicalHostname(), + proxyRealm.getCustomLoginConfig(), + proxyRealm.getLoginContextName()).generateToken(proxyServer.getHost()); + headers.set(PROXY_AUTHORIZATION, NEGOTIATE + ' ' + challengeHeader); + } + + private static void ntlmProxyChallenge(String authenticateHeader, HttpHeaders requestHeaders, Realm proxyRealm, NettyResponseFuture future) { + if ("NTLM".equals(authenticateHeader)) { + // server replied bare NTLM => we didn't preemptively send Type1Msg + String challengeHeader = NtlmEngine.INSTANCE.generateType1Msg(); + // FIXME we might want to filter current NTLM and add (leave other + // Authorization headers untouched) + requestHeaders.set(PROXY_AUTHORIZATION, "NTLM " + challengeHeader); + future.setInProxyAuth(false); + } else { + String serverChallenge = authenticateHeader.substring("NTLM ".length()).trim(); + String challengeHeader = NtlmEngine.generateType3Msg(proxyRealm.getPrincipal(), proxyRealm.getPassword(), proxyRealm.getNtlmDomain(), + proxyRealm.getNtlmHost(), serverChallenge); + // FIXME we might want to filter current NTLM and add (leave other + // Authorization headers untouched) + requestHeaders.set(PROXY_AUTHORIZATION, "NTLM " + challengeHeader); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Redirect30xInterceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Redirect30xInterceptor.java new file mode 100644 index 0000000000..40628a7e51 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Redirect30xInterceptor.java @@ -0,0 +1,199 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.HttpUtil; +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.Request; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.handler.MaxRedirectException; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.HashSet; +import java.util.Set; + +import static io.netty.handler.codec.http.HttpHeaderNames.AUTHORIZATION; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.HOST; +import static io.netty.handler.codec.http.HttpHeaderNames.LOCATION; +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static org.asynchttpclient.util.HttpConstants.Methods.GET; +import static org.asynchttpclient.util.HttpConstants.Methods.HEAD; +import static org.asynchttpclient.util.HttpConstants.Methods.OPTIONS; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.FOUND_302; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.MOVED_PERMANENTLY_301; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.PERMANENT_REDIRECT_308; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.SEE_OTHER_303; +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.TEMPORARY_REDIRECT_307; +import static org.asynchttpclient.util.HttpUtils.followRedirect; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; + +public class Redirect30xInterceptor { + + public static final Set REDIRECT_STATUSES = new HashSet<>(); + private static final Logger LOGGER = LoggerFactory.getLogger(Redirect30xInterceptor.class); + + static { + REDIRECT_STATUSES.add(MOVED_PERMANENTLY_301); + REDIRECT_STATUSES.add(FOUND_302); + REDIRECT_STATUSES.add(SEE_OTHER_303); + REDIRECT_STATUSES.add(TEMPORARY_REDIRECT_307); + REDIRECT_STATUSES.add(PERMANENT_REDIRECT_308); + } + + private final ChannelManager channelManager; + private final AsyncHttpClientConfig config; + private final NettyRequestSender requestSender; + private final MaxRedirectException maxRedirectException; + private final boolean stripAuthorizationOnRedirect; + + Redirect30xInterceptor(ChannelManager channelManager, AsyncHttpClientConfig config, NettyRequestSender requestSender) { + this.channelManager = channelManager; + this.config = config; + this.requestSender = requestSender; + stripAuthorizationOnRedirect = config.isStripAuthorizationOnRedirect(); // New flag + maxRedirectException = unknownStackTrace(new MaxRedirectException("Maximum redirect reached: " + config.getMaxRedirects()), + Redirect30xInterceptor.class, "exitAfterHandlingRedirect"); + } + + public boolean exitAfterHandlingRedirect(Channel channel, NettyResponseFuture future, HttpResponse response, Request request, + int statusCode, Realm realm) throws Exception { + + if (followRedirect(config, request)) { + if (future.incrementAndGetCurrentRedirectCount() >= config.getMaxRedirects()) { + throw maxRedirectException; + + } else { + // We must allow auth handling again. + future.setInAuth(false); + future.setInProxyAuth(false); + + String originalMethod = request.getMethod(); + boolean switchToGet = !originalMethod.equals(GET) && + !originalMethod.equals(OPTIONS) && + !originalMethod.equals(HEAD) && + (statusCode == MOVED_PERMANENTLY_301 || statusCode == SEE_OTHER_303 || statusCode == FOUND_302 && !config.isStrict302Handling()); + boolean keepBody = statusCode == TEMPORARY_REDIRECT_307 || statusCode == PERMANENT_REDIRECT_308 || statusCode == FOUND_302 && config.isStrict302Handling(); + + final RequestBuilder requestBuilder = new RequestBuilder(switchToGet ? GET : originalMethod) + .setChannelPoolPartitioning(request.getChannelPoolPartitioning()) + .setFollowRedirect(true) + .setLocalAddress(request.getLocalAddress()) + .setNameResolver(request.getNameResolver()) + .setProxyServer(request.getProxyServer()) + .setRealm(request.getRealm()) + .setRequestTimeout(request.getRequestTimeout()); + + if (keepBody) { + requestBuilder.setCharset(request.getCharset()); + if (isNonEmpty(request.getFormParams())) { + requestBuilder.setFormParams(request.getFormParams()); + } else if (request.getStringData() != null) { + requestBuilder.setBody(request.getStringData()); + } else if (request.getByteData() != null) { + requestBuilder.setBody(request.getByteData()); + } else if (request.getByteBufferData() != null) { + requestBuilder.setBody(request.getByteBufferData()); + } else if (request.getBodyGenerator() != null) { + requestBuilder.setBody(request.getBodyGenerator()); + } else if (isNonEmpty(request.getBodyParts())) { + requestBuilder.setBodyParts(request.getBodyParts()); + } + } + + requestBuilder.setHeaders(propagatedHeaders(request, realm, keepBody, stripAuthorizationOnRedirect)); + + // in case of a redirect from HTTP to HTTPS, future + // attributes might change + final boolean initialConnectionKeepAlive = future.isKeepAlive(); + final Object initialPartitionKey = future.getPartitionKey(); + + HttpHeaders responseHeaders = response.headers(); + String location = responseHeaders.get(LOCATION); + Uri newUri = Uri.create(future.getUri(), location); + LOGGER.debug("Redirecting to {}", newUri); + + CookieStore cookieStore = config.getCookieStore(); + if (cookieStore != null) { + // Update request's cookies assuming that cookie store is already updated by Interceptors + for (Cookie cookie : cookieStore.get(newUri)) { + requestBuilder.addCookieIfUnset(cookie); + } + } + + boolean sameBase = request.getUri().isSameBase(newUri); + if (sameBase) { + // we can only assume the virtual host is still valid if the baseUrl is the same + requestBuilder.setVirtualHost(request.getVirtualHost()); + } + + final Request nextRequest = requestBuilder.setUri(newUri).build(); + future.setTargetRequest(nextRequest); + + LOGGER.debug("Sending redirect to {}", newUri); + + if (future.isKeepAlive() && !HttpUtil.isTransferEncodingChunked(response)) { + if (sameBase) { + future.setReuseChannel(true); + // we can't directly send the next request because we still have to received LastContent + requestSender.drainChannelAndExecuteNextRequest(channel, future, nextRequest); + } else { + channelManager.drainChannelAndOffer(channel, future, initialConnectionKeepAlive, initialPartitionKey); + requestSender.sendNextRequest(nextRequest, future); + } + + } else { + // redirect + chunking = WAT + channelManager.closeChannel(channel); + requestSender.sendNextRequest(nextRequest, future); + } + + return true; + } + } + return false; + } + + private static HttpHeaders propagatedHeaders(Request request, Realm realm, boolean keepBody, boolean stripAuthorization) { + HttpHeaders headers = request.getHeaders() + .remove(HOST) + .remove(CONTENT_LENGTH); + + if (!keepBody) { + headers.remove(CONTENT_TYPE); + } + + if (stripAuthorization || (realm != null && realm.getScheme() == AuthScheme.NTLM)) { + headers.remove(AUTHORIZATION) + .remove(PROXY_AUTHORIZATION); + } + return headers; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ResponseFiltersInterceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ResponseFiltersInterceptor.java new file mode 100644 index 0000000000..5f905d94f3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/ResponseFiltersInterceptor.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.exception.FilterException; +import org.asynchttpclient.filter.FilterContext; +import org.asynchttpclient.filter.ResponseFilter; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.NettyRequestSender; + +public class ResponseFiltersInterceptor { + + private final AsyncHttpClientConfig config; + private final NettyRequestSender requestSender; + + ResponseFiltersInterceptor(AsyncHttpClientConfig config, NettyRequestSender requestSender) { + this.config = config; + this.requestSender = requestSender; + } + + @SuppressWarnings({"rawtypes", "unchecked"}) + public boolean exitAfterProcessingFilters(Channel channel, + NettyResponseFuture future, + AsyncHandler handler, + HttpResponseStatus status, + HttpHeaders responseHeaders) { + + FilterContext fc = new FilterContext.FilterContextBuilder(handler, future.getCurrentRequest()).responseStatus(status) + .responseHeaders(responseHeaders).build(); + + for (ResponseFilter asyncFilter : config.getResponseFilters()) { + try { + fc = asyncFilter.filter(fc); + // FIXME Is it worth protecting against this? +// requireNonNull(fc, "filterContext"); + } catch (FilterException fe) { + requestSender.abort(channel, future, fe); + } + } + + // The handler may have been wrapped. + future.setAsyncHandler(fc.getAsyncHandler()); + + // The request has changed + if (fc.replayRequest()) { + requestSender.replayRequest(future, fc, channel); + return true; + } + return false; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Unauthorized401Interceptor.java b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Unauthorized401Interceptor.java new file mode 100644 index 0000000000..cb89f70b83 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/handler/intercept/Unauthorized401Interceptor.java @@ -0,0 +1,211 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.handler.intercept; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpResponse; +import io.netty.handler.codec.http.HttpUtil; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.Request; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.channel.ChannelState; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.ntlm.NtlmEngine; +import org.asynchttpclient.spnego.SpnegoEngine; +import org.asynchttpclient.spnego.SpnegoEngineException; +import org.asynchttpclient.uri.Uri; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderNames.AUTHORIZATION; +import static io.netty.handler.codec.http.HttpHeaderNames.WWW_AUTHENTICATE; +import static org.asynchttpclient.Dsl.realm; +import static org.asynchttpclient.util.AuthenticatorUtils.NEGOTIATE; +import static org.asynchttpclient.util.AuthenticatorUtils.getHeaderWithPrefix; +import static org.asynchttpclient.util.MiscUtils.withDefault; + +public class Unauthorized401Interceptor { + + private static final Logger LOGGER = LoggerFactory.getLogger(Unauthorized401Interceptor.class); + + private final ChannelManager channelManager; + private final NettyRequestSender requestSender; + + Unauthorized401Interceptor(ChannelManager channelManager, NettyRequestSender requestSender) { + this.channelManager = channelManager; + this.requestSender = requestSender; + } + + public boolean exitAfterHandling401(Channel channel, NettyResponseFuture future, HttpResponse response, Request request, Realm realm, HttpRequest httpRequest) { + if (realm == null) { + LOGGER.debug("Can't handle 401 as there's no realm"); + return false; + } + + if (future.isAndSetInAuth(true)) { + LOGGER.info("Can't handle 401 as auth was already performed"); + return false; + } + + List wwwAuthHeaders = response.headers().getAll(WWW_AUTHENTICATE); + + if (wwwAuthHeaders.isEmpty()) { + LOGGER.info("Can't handle 401 as response doesn't contain WWW-Authenticate headers"); + return false; + } + + // FIXME what's this??? + future.setChannelState(ChannelState.NEW); + HttpHeaders requestHeaders = new DefaultHttpHeaders().add(request.getHeaders()); + + switch (realm.getScheme()) { + case BASIC: + if (getHeaderWithPrefix(wwwAuthHeaders, "Basic") == null) { + LOGGER.info("Can't handle 401 with Basic realm as WWW-Authenticate headers don't match"); + return false; + } + + if (realm.isUsePreemptiveAuth()) { + // FIXME do we need this, as future.getAndSetAuth + // was tested above? + // auth was already performed, most likely auth + // failed + LOGGER.info("Can't handle 401 with Basic realm as auth was preemptive and already performed"); + return false; + } + + // FIXME do we want to update the realm, or directly + // set the header? + Realm newBasicRealm = realm(realm) + .setUsePreemptiveAuth(true) + .build(); + future.setRealm(newBasicRealm); + break; + + case DIGEST: + String digestHeader = getHeaderWithPrefix(wwwAuthHeaders, "Digest"); + if (digestHeader == null) { + LOGGER.info("Can't handle 401 with Digest realm as WWW-Authenticate headers don't match"); + return false; + } + Realm newDigestRealm = realm(realm) + .setUri(request.getUri()) + .setMethodName(request.getMethod()) + .setUsePreemptiveAuth(true) + .parseWWWAuthenticateHeader(digestHeader) + .build(); + future.setRealm(newDigestRealm); + break; + + case NTLM: + String ntlmHeader = getHeaderWithPrefix(wwwAuthHeaders, "NTLM"); + if (ntlmHeader == null) { + LOGGER.info("Can't handle 401 with NTLM realm as WWW-Authenticate headers don't match"); + return false; + } + + ntlmChallenge(ntlmHeader, requestHeaders, realm, future); + Realm newNtlmRealm = realm(realm) + .setUsePreemptiveAuth(true) + .build(); + future.setRealm(newNtlmRealm); + break; + + case KERBEROS: + case SPNEGO: + if (getHeaderWithPrefix(wwwAuthHeaders, NEGOTIATE) == null) { + LOGGER.info("Can't handle 401 with Kerberos or Spnego realm as WWW-Authenticate headers don't match"); + return false; + } + try { + kerberosChallenge(realm, request, requestHeaders); + } catch (SpnegoEngineException e) { + String ntlmHeader2 = getHeaderWithPrefix(wwwAuthHeaders, "NTLM"); + if (ntlmHeader2 != null) { + LOGGER.warn("Kerberos/Spnego auth failed, proceeding with NTLM"); + ntlmChallenge(ntlmHeader2, requestHeaders, realm, future); + Realm newNtlmRealm2 = realm(realm) + .setScheme(AuthScheme.NTLM) + .setUsePreemptiveAuth(true) + .build(); + future.setRealm(newNtlmRealm2); + } else { + requestSender.abort(channel, future, e); + return false; + } + } + break; + default: + throw new IllegalStateException("Invalid Authentication scheme " + realm.getScheme()); + } + + final Request nextRequest = future.getCurrentRequest().toBuilder().setHeaders(requestHeaders).build(); + + LOGGER.debug("Sending authentication to {}", request.getUri()); + if (future.isKeepAlive() && !HttpUtil.isTransferEncodingChunked(httpRequest) && !HttpUtil.isTransferEncodingChunked(response)) { + future.setReuseChannel(true); + requestSender.drainChannelAndExecuteNextRequest(channel, future, nextRequest); + } else { + channelManager.closeChannel(channel); + requestSender.sendNextRequest(nextRequest, future); + } + + return true; + } + + private static void ntlmChallenge(String authenticateHeader, + HttpHeaders requestHeaders, + Realm realm, + NettyResponseFuture future) { + + if ("NTLM".equals(authenticateHeader)) { + // server replied bare NTLM => we didn't preemptively send Type1Msg + String challengeHeader = NtlmEngine.INSTANCE.generateType1Msg(); + // FIXME we might want to filter current NTLM and add (leave other + // Authorization headers untouched) + requestHeaders.set(AUTHORIZATION, "NTLM " + challengeHeader); + future.setInAuth(false); + + } else { + String serverChallenge = authenticateHeader.substring("NTLM ".length()).trim(); + String challengeHeader = NtlmEngine.generateType3Msg(realm.getPrincipal(), realm.getPassword(), + realm.getNtlmDomain(), realm.getNtlmHost(), serverChallenge); + // FIXME we might want to filter current NTLM and add (leave other + // Authorization headers untouched) + requestHeaders.set(AUTHORIZATION, "NTLM " + challengeHeader); + } + } + + private static void kerberosChallenge(Realm realm, Request request, HttpHeaders headers) throws SpnegoEngineException { + Uri uri = request.getUri(); + String host = withDefault(request.getVirtualHost(), uri.getHost()); + String challengeHeader = SpnegoEngine.instance(realm.getPrincipal(), + realm.getPassword(), + realm.getServicePrincipalName(), + realm.getRealmName(), + realm.isUseCanonicalHostname(), + realm.getCustomLoginConfig(), + realm.getLoginContextName()).generateToken(host); + headers.set(AUTHORIZATION, NEGOTIATE + ' ' + challengeHeader); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequest.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequest.java new file mode 100755 index 0000000000..71cc658a0a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequest.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.handler.codec.http.HttpRequest; +import org.asynchttpclient.netty.request.body.NettyBody; + +public final class NettyRequest { + + private final HttpRequest httpRequest; + private final NettyBody body; + + NettyRequest(HttpRequest httpRequest, NettyBody body) { + this.httpRequest = httpRequest; + this.body = body; + } + + public HttpRequest getHttpRequest() { + return httpRequest; + } + + public NettyBody getBody() { + return body; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestFactory.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestFactory.java new file mode 100755 index 0000000000..67d9a67be6 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestFactory.java @@ -0,0 +1,286 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.handler.codec.compression.Brotli; +import io.netty.handler.codec.compression.Zstd; +import io.netty.handler.codec.http.DefaultFullHttpRequest; +import io.netty.handler.codec.http.DefaultHttpRequest; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.handler.codec.http.HttpVersion; +import io.netty.handler.codec.http.cookie.ClientCookieEncoder; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.asynchttpclient.netty.request.body.NettyBody; +import org.asynchttpclient.netty.request.body.NettyBodyBody; +import org.asynchttpclient.netty.request.body.NettyByteArrayBody; +import org.asynchttpclient.netty.request.body.NettyByteBufBody; +import org.asynchttpclient.netty.request.body.NettyByteBufferBody; +import org.asynchttpclient.netty.request.body.NettyCompositeByteArrayBody; +import org.asynchttpclient.netty.request.body.NettyDirectBody; +import org.asynchttpclient.netty.request.body.NettyFileBody; +import org.asynchttpclient.netty.request.body.NettyInputStreamBody; +import org.asynchttpclient.netty.request.body.NettyMultipartBody; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.request.body.generator.FileBodyGenerator; +import org.asynchttpclient.request.body.generator.InputStreamBodyGenerator; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.StringUtils; + +import java.nio.charset.Charset; + +import static io.netty.handler.codec.http.HttpHeaderNames.ACCEPT; +import static io.netty.handler.codec.http.HttpHeaderNames.ACCEPT_ENCODING; +import static io.netty.handler.codec.http.HttpHeaderNames.AUTHORIZATION; +import static io.netty.handler.codec.http.HttpHeaderNames.CONNECTION; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.COOKIE; +import static io.netty.handler.codec.http.HttpHeaderNames.HOST; +import static io.netty.handler.codec.http.HttpHeaderNames.ORIGIN; +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static io.netty.handler.codec.http.HttpHeaderNames.SEC_WEBSOCKET_KEY; +import static io.netty.handler.codec.http.HttpHeaderNames.SEC_WEBSOCKET_VERSION; +import static io.netty.handler.codec.http.HttpHeaderNames.TRANSFER_ENCODING; +import static io.netty.handler.codec.http.HttpHeaderNames.UPGRADE; +import static io.netty.handler.codec.http.HttpHeaderNames.USER_AGENT; +import static org.asynchttpclient.util.AuthenticatorUtils.perRequestAuthorizationHeader; +import static org.asynchttpclient.util.AuthenticatorUtils.perRequestProxyAuthorizationHeader; +import static org.asynchttpclient.util.HttpUtils.ACCEPT_ALL_HEADER_VALUE; +import static org.asynchttpclient.util.HttpUtils.GZIP_DEFLATE; +import static org.asynchttpclient.util.HttpUtils.filterOutBrotliFromAcceptEncoding; +import static org.asynchttpclient.util.HttpUtils.filterOutZstdFromAcceptEncoding; +import static org.asynchttpclient.util.HttpUtils.hostHeader; +import static org.asynchttpclient.util.HttpUtils.originHeader; +import static org.asynchttpclient.util.HttpUtils.urlEncodeFormParams; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.ws.WebSocketUtils.getWebSocketKey; + +public final class NettyRequestFactory { + + private static final Integer ZERO_CONTENT_LENGTH = 0; + + private final AsyncHttpClientConfig config; + private final ClientCookieEncoder cookieEncoder; + + NettyRequestFactory(AsyncHttpClientConfig config) { + this.config = config; + cookieEncoder = config.isUseLaxCookieEncoder() ? ClientCookieEncoder.LAX : ClientCookieEncoder.STRICT; + } + + private NettyBody body(Request request) { + NettyBody nettyBody = null; + Charset bodyCharset = request.getCharset(); + + if (request.getByteData() != null) { + nettyBody = new NettyByteArrayBody(request.getByteData()); + } else if (request.getCompositeByteData() != null) { + nettyBody = new NettyCompositeByteArrayBody(request.getCompositeByteData()); + } else if (request.getStringData() != null) { + nettyBody = new NettyByteBufferBody(StringUtils.charSequence2ByteBuffer(request.getStringData(), bodyCharset)); + } else if (request.getByteBufferData() != null) { + nettyBody = new NettyByteBufferBody(request.getByteBufferData()); + } else if (request.getByteBufData() != null) { + nettyBody = new NettyByteBufBody(request.getByteBufData()); + } else if (request.getStreamData() != null) { + nettyBody = new NettyInputStreamBody(request.getStreamData()); + } else if (isNonEmpty(request.getFormParams())) { + CharSequence contentTypeOverride = request.getHeaders().contains(CONTENT_TYPE) ? null : HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED; + nettyBody = new NettyByteBufferBody(urlEncodeFormParams(request.getFormParams(), bodyCharset), contentTypeOverride); + } else if (isNonEmpty(request.getBodyParts())) { + nettyBody = new NettyMultipartBody(request.getBodyParts(), request.getHeaders(), config); + } else if (request.getFile() != null) { + nettyBody = new NettyFileBody(request.getFile(), config); + } else if (request.getBodyGenerator() instanceof FileBodyGenerator) { + FileBodyGenerator fileBodyGenerator = (FileBodyGenerator) request.getBodyGenerator(); + nettyBody = new NettyFileBody(fileBodyGenerator.getFile(), fileBodyGenerator.getRegionSeek(), fileBodyGenerator.getRegionLength(), config); + } else if (request.getBodyGenerator() instanceof InputStreamBodyGenerator) { + InputStreamBodyGenerator inStreamGenerator = (InputStreamBodyGenerator) request.getBodyGenerator(); + nettyBody = new NettyInputStreamBody(inStreamGenerator.getInputStream(), inStreamGenerator.getContentLength()); + } else if (request.getBodyGenerator() != null) { + nettyBody = new NettyBodyBody(request.getBodyGenerator().createBody(), config); + } + + return nettyBody; + } + + public void addAuthorizationHeader(HttpHeaders headers, String authorizationHeader) { + if (authorizationHeader != null) { + // don't override authorization but append + headers.add(AUTHORIZATION, authorizationHeader); + } + } + + public void setProxyAuthorizationHeader(HttpHeaders headers, String proxyAuthorizationHeader) { + if (proxyAuthorizationHeader != null) { + headers.set(PROXY_AUTHORIZATION, proxyAuthorizationHeader); + } + } + + public NettyRequest newNettyRequest(Request request, boolean performConnectRequest, ProxyServer proxyServer, Realm realm, Realm proxyRealm) { + Uri uri = request.getUri(); + HttpMethod method = performConnectRequest ? HttpMethod.CONNECT : HttpMethod.valueOf(request.getMethod()); + boolean connect = method == HttpMethod.CONNECT; + + HttpVersion httpVersion = HttpVersion.HTTP_1_1; + String requestUri = requestUri(uri, proxyServer, connect); + + NettyBody body = connect ? null : body(request); + + NettyRequest nettyRequest; + if (body == null) { + HttpRequest httpRequest = new DefaultFullHttpRequest(httpVersion, method, requestUri, Unpooled.EMPTY_BUFFER); + nettyRequest = new NettyRequest(httpRequest, null); + + } else if (body instanceof NettyDirectBody) { + ByteBuf buf = ((NettyDirectBody) body).byteBuf(); + HttpRequest httpRequest = new DefaultFullHttpRequest(httpVersion, method, requestUri, buf); + // body is passed as null as it's written directly with the request + nettyRequest = new NettyRequest(httpRequest, null); + } else { + HttpRequest httpRequest = new DefaultHttpRequest(httpVersion, method, requestUri); + nettyRequest = new NettyRequest(httpRequest, body); + } + + HttpHeaders headers = nettyRequest.getHttpRequest().headers(); + + if (connect) { + // assign proxy-auth as configured on request + headers.set(PROXY_AUTHORIZATION, request.getHeaders().getAll(PROXY_AUTHORIZATION)); + headers.set(USER_AGENT, request.getHeaders().getAll(USER_AGENT)); + + } else { + // assign headers as configured on request + headers.set(request.getHeaders()); + + if (isNonEmpty(request.getCookies())) { + headers.set(COOKIE, cookieEncoder.encode(request.getCookies())); + } + + String userDefinedAcceptEncoding = headers.get(ACCEPT_ENCODING); + if (userDefinedAcceptEncoding != null) { + if (config.isEnableAutomaticDecompression()) { + if (!Brotli.isAvailable()) { + // Brotli is not available. + // For manual decompression by user, any encoding may suite, so leave untouched + headers.set(ACCEPT_ENCODING, filterOutBrotliFromAcceptEncoding(userDefinedAcceptEncoding)); + } + if (!Zstd.isAvailable()) { + // zstd is not available. + // For manual decompression by user, any encoding may suit, so leave untouched + headers.set(ACCEPT_ENCODING, filterOutZstdFromAcceptEncoding(userDefinedAcceptEncoding)); + } + } + } else if (config.isCompressionEnforced()) { + // Add Accept Encoding header if compression is enforced + headers.set(ACCEPT_ENCODING, GZIP_DEFLATE); + if (Brotli.isAvailable()) { + headers.add(ACCEPT_ENCODING, HttpHeaderValues.BR); + } + if (Zstd.isAvailable()) { + headers.add(ACCEPT_ENCODING, HttpHeaderValues.ZSTD); + } + } + } + + if (!headers.contains(CONTENT_LENGTH)) { + if (body != null) { + if (body.getContentLength() < 0) { + headers.set(TRANSFER_ENCODING, HttpHeaderValues.CHUNKED); + } else { + headers.set(CONTENT_LENGTH, body.getContentLength()); + } + } else if (method == HttpMethod.POST || method == HttpMethod.PUT || method == HttpMethod.PATCH) { + headers.set(CONTENT_LENGTH, ZERO_CONTENT_LENGTH); + } + } + + if (body != null && body.getContentTypeOverride() != null) { + headers.set(CONTENT_TYPE, body.getContentTypeOverride()); + } + + // connection header and friends + if (!connect && uri.isWebSocket()) { + headers.set(UPGRADE, HttpHeaderValues.WEBSOCKET) + .set(CONNECTION, HttpHeaderValues.UPGRADE) + .set(SEC_WEBSOCKET_KEY, getWebSocketKey()) + .set(SEC_WEBSOCKET_VERSION, "13"); + + if (!headers.contains(ORIGIN)) { + headers.set(ORIGIN, originHeader(uri)); + } + + } else if (!headers.contains(CONNECTION)) { + CharSequence connectionHeaderValue = connectionHeader(config.isKeepAlive(), httpVersion); + if (connectionHeaderValue != null) { + headers.set(CONNECTION, connectionHeaderValue); + } + } + + if (!headers.contains(HOST)) { + String virtualHost = request.getVirtualHost(); + headers.set(HOST, virtualHost != null ? virtualHost : hostHeader(uri)); + } + + // don't override authorization but append + addAuthorizationHeader(headers, perRequestAuthorizationHeader(request, realm)); + // only set proxy auth on request over plain HTTP, or when performing CONNECT + if (!uri.isSecured() || connect) { + setProxyAuthorizationHeader(headers, perRequestProxyAuthorizationHeader(request, proxyRealm)); + } + + // Add default accept headers + if (!headers.contains(ACCEPT)) { + headers.set(ACCEPT, ACCEPT_ALL_HEADER_VALUE); + } + + // Add default user agent + if (!headers.contains(USER_AGENT) && config.getUserAgent() != null) { + headers.set(USER_AGENT, config.getUserAgent()); + } + + return nettyRequest; + } + + private static String requestUri(Uri uri, ProxyServer proxyServer, boolean connect) { + if (connect) { + // proxy tunnelling, connect need host and explicit port + return uri.getAuthority(); + + } else if (proxyServer != null && !uri.isSecured() && proxyServer.getProxyType().isHttp()) { + // proxy over HTTP, need full url + return uri.toUrl(); + + } else { + // direct connection to target host or tunnel already connected: only path and query + return uri.toRelativeUrl(); + } + } + + private static CharSequence connectionHeader(boolean keepAlive, HttpVersion httpVersion) { + if (httpVersion.isKeepAliveDefault()) { + return keepAlive ? null : HttpHeaderValues.CLOSE; + } else { + return keepAlive ? HttpHeaderValues.KEEP_ALIVE : null; + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestSender.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestSender.java new file mode 100755 index 0000000000..b66dd713df --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestSender.java @@ -0,0 +1,621 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.bootstrap.Bootstrap; +import io.netty.channel.Channel; +import io.netty.channel.ChannelFuture; +import io.netty.channel.ChannelProgressivePromise; +import io.netty.channel.ChannelPromise; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.HttpRequest; +import io.netty.util.Timer; +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.ImmediateEventExecutor; +import io.netty.util.concurrent.Promise; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.AsyncHttpClientState; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.Request; +import org.asynchttpclient.exception.FilterException; +import org.asynchttpclient.exception.PoolAlreadyClosedException; +import org.asynchttpclient.exception.RemotelyClosedException; +import org.asynchttpclient.filter.FilterContext; +import org.asynchttpclient.filter.IOExceptionFilter; +import org.asynchttpclient.handler.TransferCompletionHandler; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.OnLastHttpContentCallback; +import org.asynchttpclient.netty.SimpleFutureListener; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.channel.ChannelState; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.channel.ConnectionSemaphore; +import org.asynchttpclient.netty.channel.DefaultConnectionSemaphoreFactory; +import org.asynchttpclient.netty.channel.NettyChannelConnector; +import org.asynchttpclient.netty.channel.NettyConnectListener; +import org.asynchttpclient.netty.timeout.TimeoutsHolder; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.resolver.RequestHostnameResolver; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.ws.WebSocketUpgradeHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderNames.EXPECT; +import static java.util.Collections.singletonList; +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.AuthenticatorUtils.perConnectionAuthorizationHeader; +import static org.asynchttpclient.util.AuthenticatorUtils.perConnectionProxyAuthorizationHeader; +import static org.asynchttpclient.util.HttpConstants.Methods.CONNECT; +import static org.asynchttpclient.util.HttpConstants.Methods.GET; +import static org.asynchttpclient.util.MiscUtils.getCause; +import static org.asynchttpclient.util.ProxyUtils.getProxyServer; + +public final class NettyRequestSender { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyRequestSender.class); + + private final AsyncHttpClientConfig config; + private final ChannelManager channelManager; + private final ConnectionSemaphore connectionSemaphore; + private final Timer nettyTimer; + private final AsyncHttpClientState clientState; + private final NettyRequestFactory requestFactory; + + public NettyRequestSender(AsyncHttpClientConfig config, ChannelManager channelManager, Timer nettyTimer, AsyncHttpClientState clientState) { + this.config = config; + this.channelManager = channelManager; + connectionSemaphore = config.getConnectionSemaphoreFactory() == null + ? new DefaultConnectionSemaphoreFactory().newConnectionSemaphore(config) + : config.getConnectionSemaphoreFactory().newConnectionSemaphore(config); + this.nettyTimer = nettyTimer; + this.clientState = clientState; + requestFactory = new NettyRequestFactory(config); + } + + // needConnect returns true if the request is secure/websocket and a HTTP proxy is set + private boolean needConnect(final Request request, final ProxyServer proxyServer) { + return proxyServer != null + && proxyServer.getProxyType().isHttp() + && (request.getUri().isSecured() || request.getUri().isWebSocket()); + } + + public ListenableFuture sendRequest(final Request request, final AsyncHandler asyncHandler, NettyResponseFuture future) { + if (isClosed()) { + throw new IllegalStateException("Closed"); + } + + validateWebSocketRequest(request, asyncHandler); + ProxyServer proxyServer = getProxyServer(config, request); + + // WebSockets use connect tunneling to work with proxies + if (needConnect(request, proxyServer) && !isConnectAlreadyDone(request, future)) { + // Proxy with HTTPS or WebSocket: CONNECT for sure + if (future != null && future.isConnectAllowed()) { + // Perform CONNECT + return sendRequestWithCertainForceConnect(request, asyncHandler, future, proxyServer, true); + } else { + // CONNECT will depend on if we can pool or connection or if we have to open a new one + return sendRequestThroughProxy(request, asyncHandler, future, proxyServer); + } + } else { + // no CONNECT for sure + return sendRequestWithCertainForceConnect(request, asyncHandler, future, proxyServer, false); + } + } + + private static boolean isConnectAlreadyDone(Request request, NettyResponseFuture future) { + return future != null + // If the channel can't be reused or closed, a CONNECT is still required + && future.isReuseChannel() && Channels.isChannelActive(future.channel()) + && future.getNettyRequest() != null + && future.getNettyRequest().getHttpRequest().method() == HttpMethod.CONNECT + && !request.getMethod().equals(CONNECT); + } + + /** + * We know for sure if we have to force to connect or not, so we can build the + * HttpRequest right away This reduces the probability of having a pooled + * channel closed by the server by the time we build the request + */ + private ListenableFuture sendRequestWithCertainForceConnect(Request request, AsyncHandler asyncHandler, NettyResponseFuture future, + ProxyServer proxyServer, boolean performConnectRequest) { + Channel channel = getOpenChannel(future, request, proxyServer, asyncHandler); + if (Channels.isChannelActive(channel)) { + NettyResponseFuture newFuture = newNettyRequestAndResponseFuture(request, asyncHandler, future, + proxyServer, performConnectRequest); + return sendRequestWithOpenChannel(newFuture, asyncHandler, channel); + } else { + // A new channel is not expected when performConnectRequest is false. We need to + // revisit the condition of sending + // the CONNECT request to the new channel. + NettyResponseFuture newFuture = newNettyRequestAndResponseFuture(request, asyncHandler, future, + proxyServer, needConnect(request, proxyServer)); + return sendRequestWithNewChannel(request, proxyServer, newFuture, asyncHandler); + } + } + + /** + * Using CONNECT depends on whether we can fetch a valid channel or not Loop + * until we get a valid channel from the pool, and it's still valid once the + * request is built @ + */ + private ListenableFuture sendRequestThroughProxy(Request request, + AsyncHandler asyncHandler, + NettyResponseFuture future, + ProxyServer proxyServer) { + + NettyResponseFuture newFuture = null; + for (int i = 0; i < 3; i++) { + Channel channel = getOpenChannel(future, request, proxyServer, asyncHandler); + if (channel == null) { + // pool is empty + break; + } + + if (newFuture == null) { + newFuture = newNettyRequestAndResponseFuture(request, asyncHandler, future, proxyServer, false); + } + + if (Channels.isChannelActive(channel)) { + // if the channel is still active, we can use it, + // otherwise, channel was closed by the time we computed the request, try again + return sendRequestWithOpenChannel(newFuture, asyncHandler, channel); + } + } + + // couldn't poll an active channel + newFuture = newNettyRequestAndResponseFuture(request, asyncHandler, future, proxyServer, true); + return sendRequestWithNewChannel(request, proxyServer, newFuture, asyncHandler); + } + + private NettyResponseFuture newNettyRequestAndResponseFuture(final Request request, final AsyncHandler asyncHandler, NettyResponseFuture originalFuture, + ProxyServer proxy, boolean performConnectRequest) { + Realm realm; + if (originalFuture != null) { + realm = originalFuture.getRealm(); + } else { + realm = request.getRealm(); + if (realm == null) { + realm = config.getRealm(); + } + } + + Realm proxyRealm = null; + if (originalFuture != null) { + proxyRealm = originalFuture.getProxyRealm(); + } else if (proxy != null) { + proxyRealm = proxy.getRealm(); + } + + NettyRequest nettyRequest = requestFactory.newNettyRequest(request, performConnectRequest, proxy, realm, proxyRealm); + if (originalFuture == null) { + NettyResponseFuture future = newNettyResponseFuture(request, asyncHandler, nettyRequest, proxy); + future.setRealm(realm); + future.setProxyRealm(proxyRealm); + return future; + } else { + originalFuture.setNettyRequest(nettyRequest); + originalFuture.setCurrentRequest(request); + return originalFuture; + } + } + + private Channel getOpenChannel(NettyResponseFuture future, Request request, ProxyServer proxyServer, AsyncHandler asyncHandler) { + if (future != null && future.isReuseChannel() && Channels.isChannelActive(future.channel())) { + return future.channel(); + } else { + return pollPooledChannel(request, proxyServer, asyncHandler); + } + } + + private ListenableFuture sendRequestWithOpenChannel(NettyResponseFuture future, AsyncHandler asyncHandler, Channel channel) { + try { + asyncHandler.onConnectionPooled(channel); + } catch (Exception e) { + LOGGER.error("onConnectionPooled crashed", e); + abort(channel, future, e); + return future; + } + + SocketAddress channelRemoteAddress = channel.remoteAddress(); + if (channelRemoteAddress != null) { + // otherwise, bad luck, the channel was closed, see bellow + scheduleRequestTimeout(future, (InetSocketAddress) channelRemoteAddress); + } + + future.setChannelState(ChannelState.POOLED); + future.attachChannel(channel, false); + + if (LOGGER.isDebugEnabled()) { + HttpRequest httpRequest = future.getNettyRequest().getHttpRequest(); + LOGGER.debug("Using open Channel {} for {} '{}'", channel, httpRequest.method(), httpRequest.uri()); + } + + // channelInactive might be called between isChannelValid and writeRequest + // so if we don't store the Future now, channelInactive won't perform + // handleUnexpectedClosedChannel + Channels.setAttribute(channel, future); + + if (Channels.isChannelActive(channel)) { + writeRequest(future, channel); + } else { + // bad luck, the channel was closed in-between + // there's a very good chance onClose was already notified but the + // future wasn't already registered + handleUnexpectedClosedChannel(channel, future); + } + + return future; + } + + private ListenableFuture sendRequestWithNewChannel(Request request, ProxyServer proxy, NettyResponseFuture future, AsyncHandler asyncHandler) { + // some headers are only set when performing the first request + HttpHeaders headers = future.getNettyRequest().getHttpRequest().headers(); + if (proxy != null && proxy.getCustomHeaders() != null) { + HttpHeaders customHeaders = proxy.getCustomHeaders().apply(request); + if (customHeaders != null) { + headers.add(customHeaders); + } + } + Realm realm = future.getRealm(); + Realm proxyRealm = future.getProxyRealm(); + requestFactory.addAuthorizationHeader(headers, perConnectionAuthorizationHeader(request, proxy, realm)); + requestFactory.setProxyAuthorizationHeader(headers, perConnectionProxyAuthorizationHeader(request, proxyRealm)); + + future.setInAuth(realm != null && realm.isUsePreemptiveAuth() && realm.getScheme() != AuthScheme.NTLM); + future.setInProxyAuth(proxyRealm != null && proxyRealm.isUsePreemptiveAuth() && proxyRealm.getScheme() != AuthScheme.NTLM); + + try { + if (!channelManager.isOpen()) { + throw PoolAlreadyClosedException.INSTANCE; + } + + // Do not throw an exception when we need an extra connection for a + // redirect. + future.acquirePartitionLockLazily(); + } catch (Throwable t) { + abort(null, future, getCause(t)); + // exit and don't try to resolve address + return future; + } + + resolveAddresses(request, proxy, future, asyncHandler).addListener(new SimpleFutureListener>() { + + @Override + protected void onSuccess(List addresses) { + NettyConnectListener connectListener = new NettyConnectListener<>(future, NettyRequestSender.this, channelManager, connectionSemaphore); + NettyChannelConnector connector = new NettyChannelConnector(request.getLocalAddress(), addresses, asyncHandler, clientState); + if (!future.isDone()) { + // Do not throw an exception when we need an extra connection for a redirect + // FIXME why? This violate the max connection per host handling, right? + channelManager.getBootstrap(request.getUri(), request.getNameResolver(), proxy).addListener((Future whenBootstrap) -> { + if (whenBootstrap.isSuccess()) { + connector.connect(whenBootstrap.get(), connectListener); + } else { + abort(null, future, whenBootstrap.cause()); + } + }); + } + } + + @Override + protected void onFailure(Throwable cause) { + abort(null, future, getCause(cause)); + } + }); + + return future; + } + + private Future> resolveAddresses(Request request, ProxyServer proxy, NettyResponseFuture future, AsyncHandler asyncHandler) { + Uri uri = request.getUri(); + final Promise> promise = ImmediateEventExecutor.INSTANCE.newPromise(); + + if (proxy != null && !proxy.isIgnoredForHost(uri.getHost()) && proxy.getProxyType().isHttp()) { + int port = uri.isSecured() ? proxy.getSecuredPort() : proxy.getPort(); + InetSocketAddress unresolvedRemoteAddress = InetSocketAddress.createUnresolved(proxy.getHost(), port); + scheduleRequestTimeout(future, unresolvedRemoteAddress); + return RequestHostnameResolver.INSTANCE.resolve(request.getNameResolver(), unresolvedRemoteAddress, asyncHandler); + } else { + int port = uri.getExplicitPort(); + + InetSocketAddress unresolvedRemoteAddress = InetSocketAddress.createUnresolved(uri.getHost(), port); + scheduleRequestTimeout(future, unresolvedRemoteAddress); + + if (request.getAddress() != null) { + // bypass resolution + InetSocketAddress inetSocketAddress = new InetSocketAddress(request.getAddress(), port); + return promise.setSuccess(singletonList(inetSocketAddress)); + } else { + return RequestHostnameResolver.INSTANCE.resolve(request.getNameResolver(), unresolvedRemoteAddress, asyncHandler); + } + } + } + + private NettyResponseFuture newNettyResponseFuture(Request request, AsyncHandler asyncHandler, NettyRequest nettyRequest, ProxyServer proxyServer) { + NettyResponseFuture future = new NettyResponseFuture<>( + request, + asyncHandler, + nettyRequest, + config.getMaxRequestRetry(), + request.getChannelPoolPartitioning(), + connectionSemaphore, + proxyServer); + + String expectHeader = request.getHeaders().get(EXPECT); + if (HttpHeaderValues.CONTINUE.contentEqualsIgnoreCase(expectHeader)) { + future.setDontWriteBodyBecauseExpectContinue(true); + } + return future; + } + + public void writeRequest(NettyResponseFuture future, Channel channel) { + NettyRequest nettyRequest = future.getNettyRequest(); + HttpRequest httpRequest = nettyRequest.getHttpRequest(); + AsyncHandler asyncHandler = future.getAsyncHandler(); + + // if the channel is dead because it was pooled and the remote server decided to + // close it, + // we just let it go and the channelInactive do its work + if (!Channels.isChannelActive(channel)) { + return; + } + + try { + if (asyncHandler instanceof TransferCompletionHandler) { + configureTransferAdapter(asyncHandler, httpRequest); + } + + boolean writeBody = !future.isDontWriteBodyBecauseExpectContinue() && httpRequest.method() != HttpMethod.CONNECT && nettyRequest.getBody() != null; + if (!future.isHeadersAlreadyWrittenOnContinue()) { + try { + asyncHandler.onRequestSend(nettyRequest); + } catch (Exception e) { + LOGGER.error("onRequestSend crashed", e); + abort(channel, future, e); + return; + } + + // if the request has a body, we want to track progress + if (writeBody) { + // FIXME does this really work??? the promise is for the request without body!!! + ChannelProgressivePromise promise = channel.newProgressivePromise(); + ChannelFuture f = channel.write(httpRequest, promise); + f.addListener(new WriteProgressListener(future, true, 0L)); + } else { + // we can just track write completion + ChannelPromise promise = channel.newPromise(); + ChannelFuture f = channel.writeAndFlush(httpRequest, promise); + f.addListener(new WriteCompleteListener(future)); + } + } + + if (writeBody) { + nettyRequest.getBody().write(channel, future); + } + + // don't bother scheduling read timeout if channel became invalid + if (Channels.isChannelActive(channel)) { + scheduleReadTimeout(future); + } + + } catch (Exception e) { + LOGGER.error("Can't write request", e); + abort(channel, future, e); + } + } + + private static void configureTransferAdapter(AsyncHandler handler, HttpRequest httpRequest) { + HttpHeaders h = new DefaultHttpHeaders().set(httpRequest.headers()); + ((TransferCompletionHandler) handler).headers(h); + } + + private void scheduleRequestTimeout(NettyResponseFuture nettyResponseFuture, + InetSocketAddress originalRemoteAddress) { + nettyResponseFuture.touch(); + TimeoutsHolder timeoutsHolder = new TimeoutsHolder(nettyTimer, nettyResponseFuture, this, config, + originalRemoteAddress); + nettyResponseFuture.setTimeoutsHolder(timeoutsHolder); + } + + private static void scheduleReadTimeout(NettyResponseFuture nettyResponseFuture) { + TimeoutsHolder timeoutsHolder = nettyResponseFuture.getTimeoutsHolder(); + if (timeoutsHolder != null) { + // on very fast requests, it's entirely possible that the response has already + // been completed + // by the time we try to schedule the read timeout + nettyResponseFuture.touch(); + timeoutsHolder.startReadTimeout(); + } + } + + public void abort(Channel channel, NettyResponseFuture future, Throwable t) { + if (channel != null) { + if (channel.isActive()) { + channelManager.closeChannel(channel); + } + } + + if (!future.isDone()) { + future.setChannelState(ChannelState.CLOSED); + LOGGER.debug("Aborting Future {}\n", future); + LOGGER.debug(t.getMessage(), t); + future.abort(t); + } + } + + public void handleUnexpectedClosedChannel(Channel channel, NettyResponseFuture future) { + if (Channels.isActiveTokenSet(channel)) { + if (future.isDone()) { + channelManager.closeChannel(channel); + } else if (future.incrementRetryAndCheck() && retry(future)) { + future.pendingException = null; + } else { + abort(channel, future, future.pendingException != null ? future.pendingException : RemotelyClosedException.INSTANCE); + } + } + } + + public boolean retry(NettyResponseFuture future) { + if (isClosed()) { + return false; + } + + if (future.isReplayPossible()) { + future.setChannelState(ChannelState.RECONNECTED); + + LOGGER.debug("Trying to recover request {}\n", future.getNettyRequest().getHttpRequest()); + try { + future.getAsyncHandler().onRetry(); + } catch (Exception e) { + LOGGER.error("onRetry crashed", e); + abort(future.channel(), future, e); + return false; + } + + try { + sendNextRequest(future.getCurrentRequest(), future); + return true; + + } catch (Exception e) { + abort(future.channel(), future, e); + return false; + } + } else { + LOGGER.debug("Unable to recover future {}\n", future); + return false; + } + } + + public boolean applyIoExceptionFiltersAndReplayRequest(NettyResponseFuture future, IOException e, Channel channel) { + + boolean replayed = false; + @SuppressWarnings({"unchecked", "rawtypes"}) + FilterContext fc = new FilterContext.FilterContextBuilder(future.getAsyncHandler(), future.getCurrentRequest()) + .ioException(e).build(); + for (IOExceptionFilter asyncFilter : config.getIoExceptionFilters()) { + try { + fc = asyncFilter.filter(fc); + requireNonNull(fc, "filterContext"); + } catch (FilterException efe) { + abort(channel, future, efe); + } + } + + if (fc.replayRequest() && future.incrementRetryAndCheck() && future.isReplayPossible()) { + future.setKeepAlive(false); + replayRequest(future, fc, channel); + replayed = true; + } + return replayed; + } + + public void sendNextRequest(final Request request, final NettyResponseFuture future) { + sendRequest(request, future.getAsyncHandler(), future); + } + + private static void validateWebSocketRequest(Request request, AsyncHandler asyncHandler) { + Uri uri = request.getUri(); + boolean isWs = uri.isWebSocket(); + if (asyncHandler instanceof WebSocketUpgradeHandler) { + if (!isWs) { + throw new IllegalArgumentException("WebSocketUpgradeHandler but scheme isn't ws or wss: " + uri.getScheme()); + } else if (!request.getMethod().equals(GET) && !request.getMethod().equals(CONNECT)) { + throw new IllegalArgumentException("WebSocketUpgradeHandler but method isn't GET or CONNECT: " + request.getMethod()); + } + } else if (isWs) { + throw new IllegalArgumentException("No WebSocketUpgradeHandler but scheme is " + uri.getScheme()); + } + } + + private Channel pollPooledChannel(Request request, ProxyServer proxy, AsyncHandler asyncHandler) { + try { + asyncHandler.onConnectionPoolAttempt(); + } catch (Exception e) { + LOGGER.error("onConnectionPoolAttempt crashed", e); + } + + Uri uri = request.getUri(); + String virtualHost = request.getVirtualHost(); + final Channel channel = channelManager.poll(uri, virtualHost, proxy, request.getChannelPoolPartitioning()); + + if (channel != null) { + LOGGER.debug("Using pooled Channel '{}' for '{}' to '{}'", channel, request.getMethod(), uri); + } + return channel; + } + + @SuppressWarnings({"rawtypes", "unchecked"}) + public void replayRequest(final NettyResponseFuture future, FilterContext fc, Channel channel) { + Request newRequest = fc.getRequest(); + future.setAsyncHandler(fc.getAsyncHandler()); + future.setChannelState(ChannelState.NEW); + future.touch(); + + LOGGER.debug("\n\nReplaying Request {}\n for Future {}\n", newRequest, future); + try { + future.getAsyncHandler().onRetry(); + } catch (Exception e) { + LOGGER.error("onRetry crashed", e); + abort(channel, future, e); + return; + } + + channelManager.drainChannelAndOffer(channel, future); + sendNextRequest(newRequest, future); + } + + public boolean isClosed() { + return clientState.isClosed(); + } + + public void drainChannelAndExecuteNextRequest(final Channel channel, final NettyResponseFuture future, Request nextRequest) { + Channels.setAttribute(channel, new OnLastHttpContentCallback(future) { + @Override + public void call() { + sendNextRequest(nextRequest, future); + } + }); + } + + public void drainChannelAndExecuteNextRequest(final Channel channel, final NettyResponseFuture future, Request nextRequest, Future whenHandshaked) { + Channels.setAttribute(channel, new OnLastHttpContentCallback(future) { + @Override + public void call() { + whenHandshaked.addListener(f -> { + if (f.isSuccess()) { + sendNextRequest(nextRequest, future); + } else { + future.abort(f.cause()); + } + } + ); + } + }); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/WriteCompleteListener.java b/client/src/main/java/org/asynchttpclient/netty/request/WriteCompleteListener.java new file mode 100644 index 0000000000..1ba2530715 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/WriteCompleteListener.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.channel.ChannelFuture; +import io.netty.util.concurrent.GenericFutureListener; +import org.asynchttpclient.netty.NettyResponseFuture; + +public class WriteCompleteListener extends WriteListener implements GenericFutureListener { + + WriteCompleteListener(NettyResponseFuture future) { + super(future, true); + } + + @Override + public void operationComplete(ChannelFuture future) { + operationComplete(future.channel(), future.cause()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/WriteListener.java b/client/src/main/java/org/asynchttpclient/netty/request/WriteListener.java new file mode 100644 index 0000000000..95f8d4af85 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/WriteListener.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.channel.Channel; +import org.asynchttpclient.handler.ProgressAsyncHandler; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelState; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.netty.future.StackTraceInspector; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.net.ssl.SSLException; +import java.nio.channels.ClosedChannelException; + +public abstract class WriteListener { + + private static final Logger LOGGER = LoggerFactory.getLogger(WriteListener.class); + protected final NettyResponseFuture future; + final ProgressAsyncHandler progressAsyncHandler; + final boolean notifyHeaders; + + WriteListener(NettyResponseFuture future, boolean notifyHeaders) { + this.future = future; + progressAsyncHandler = future.getAsyncHandler() instanceof ProgressAsyncHandler ? (ProgressAsyncHandler) future.getAsyncHandler() : null; + this.notifyHeaders = notifyHeaders; + } + + private void abortOnThrowable(Channel channel, Throwable cause) { + if (future.getChannelState() == ChannelState.POOLED && (cause instanceof IllegalStateException || + cause instanceof ClosedChannelException || + cause instanceof SSLException || + StackTraceInspector.recoverOnReadOrWriteException(cause))) { + LOGGER.debug("Write exception on pooled channel, letting retry trigger", cause); + } else { + future.abort(cause); + } + Channels.silentlyCloseChannel(channel); + } + + void operationComplete(Channel channel, Throwable cause) { + future.touch(); + + // The write operation failed. If the channel was pooled, it means it got asynchronously closed. + // Let's retry a second time. + if (cause != null) { + abortOnThrowable(channel, cause); + return; + } + + if (progressAsyncHandler != null) { + // We need to make sure we aren't in the middle of an authorization process before publishing events as we will re-publish again the same event after the authorization, + // causing unpredictable behavior. + boolean startPublishing = !future.isInAuth() && !future.isInProxyAuth(); + if (startPublishing) { + + if (notifyHeaders) { + progressAsyncHandler.onHeadersWritten(); + } else { + progressAsyncHandler.onContentWritten(); + } + } + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/WriteProgressListener.java b/client/src/main/java/org/asynchttpclient/netty/request/WriteProgressListener.java new file mode 100755 index 0000000000..98f669eae3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/WriteProgressListener.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request; + +import io.netty.channel.ChannelProgressiveFuture; +import io.netty.channel.ChannelProgressiveFutureListener; +import org.asynchttpclient.netty.NettyResponseFuture; + +public class WriteProgressListener extends WriteListener implements ChannelProgressiveFutureListener { + + private final long expectedTotal; + private long lastProgress; + + public WriteProgressListener(NettyResponseFuture future, boolean notifyHeaders, long expectedTotal) { + super(future, notifyHeaders); + this.expectedTotal = expectedTotal; + } + + @Override + public void operationComplete(ChannelProgressiveFuture cf) { + operationComplete(cf.channel(), cf.cause()); + } + + @Override + public void operationProgressed(ChannelProgressiveFuture f, long progress, long total) { + future.touch(); + + if (progressAsyncHandler != null && !notifyHeaders) { + long lastLastProgress = lastProgress; + lastProgress = progress; + if (total < 0) { + total = expectedTotal; + } + if (progress != lastLastProgress) { + progressAsyncHandler.onContentWriteProgress(progress - lastLastProgress, progress, total); + } + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/BodyChunkedInput.java b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyChunkedInput.java new file mode 100755 index 0000000000..772baca43a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyChunkedInput.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import io.netty.channel.ChannelHandlerContext; +import io.netty.handler.stream.ChunkedInput; +import org.asynchttpclient.request.body.Body; + +import static java.util.Objects.requireNonNull; + +/** + * Adapts a {@link Body} to Netty's {@link ChunkedInput}. + */ +public class BodyChunkedInput implements ChunkedInput { + + public static final int DEFAULT_CHUNK_SIZE = 8 * 1024; + + private final Body body; + private final int chunkSize; + private final long contentLength; + private boolean endOfInput; + private long progress; + + BodyChunkedInput(Body body) { + this.body = requireNonNull(body, "body"); + contentLength = body.getContentLength(); + if (contentLength <= 0) { + chunkSize = DEFAULT_CHUNK_SIZE; + } else { + chunkSize = (int) Math.min(contentLength, DEFAULT_CHUNK_SIZE); + } + } + + @Override + @Deprecated + public ByteBuf readChunk(ChannelHandlerContext ctx) throws Exception { + return readChunk(ctx.alloc()); + } + + @Override + public ByteBuf readChunk(ByteBufAllocator alloc) throws Exception { + if (endOfInput) { + return null; + } + + ByteBuf buffer = alloc.buffer(chunkSize); + Body.BodyState state = body.transferTo(buffer); + progress += buffer.writerIndex(); + switch (state) { + case STOP: + endOfInput = true; + return buffer; + case SUSPEND: + // this will suspend the stream in ChunkedWriteHandler + buffer.release(); + return null; + case CONTINUE: + return buffer; + default: + throw new IllegalStateException("Unknown state: " + state); + } + } + + @Override + public boolean isEndOfInput() { + return endOfInput; + } + + @Override + public void close() throws Exception { + body.close(); + } + + @Override + public long length() { + return contentLength; + } + + @Override + public long progress() { + return progress; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/BodyFileRegion.java b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyFileRegion.java new file mode 100755 index 0000000000..91f2b1ecfc --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyFileRegion.java @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.channel.FileRegion; +import io.netty.util.AbstractReferenceCounted; +import org.asynchttpclient.request.body.RandomAccessBody; + +import java.io.IOException; +import java.nio.channels.WritableByteChannel; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +/** + * Adapts a {@link RandomAccessBody} to Netty's {@link FileRegion}. + */ +class BodyFileRegion extends AbstractReferenceCounted implements FileRegion { + + private final RandomAccessBody body; + private long transferred; + + BodyFileRegion(RandomAccessBody body) { + this.body = requireNonNull(body, "body"); + } + + @Override + public long position() { + return 0; + } + + @Override + public long count() { + return body.getContentLength(); + } + + @Override + public long transfered() { + return transferred(); + } + + @Override + public long transferred() { + return transferred; + } + + @Override + public FileRegion retain() { + super.retain(); + return this; + } + + @Override + public FileRegion retain(int increment) { + super.retain(increment); + return this; + } + + @Override + public FileRegion touch() { + return this; + } + + @Override + public FileRegion touch(Object hint) { + return this; + } + + @Override + public long transferTo(WritableByteChannel target, long position) throws IOException { + long written = body.transferTo(target); + if (written > 0) { + transferred += written; + } + return written; + } + + @Override + protected void deallocate() { + closeSilently(body); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBody.java new file mode 100755 index 0000000000..f38ef3939d --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBody.java @@ -0,0 +1,32 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.channel.Channel; +import org.asynchttpclient.netty.NettyResponseFuture; + +import java.io.IOException; + +public interface NettyBody { + + long getContentLength(); + + default CharSequence getContentTypeOverride() { + return null; + } + + void write(Channel channel, NettyResponseFuture future) throws IOException; +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBodyBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBodyBody.java new file mode 100755 index 0000000000..efe337bfe8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBodyBody.java @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelProgressiveFuture; +import io.netty.handler.codec.http.LastHttpContent; +import io.netty.handler.stream.ChunkedWriteHandler; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.WriteProgressListener; +import org.asynchttpclient.request.body.Body; +import org.asynchttpclient.request.body.RandomAccessBody; +import org.asynchttpclient.request.body.generator.BodyGenerator; +import org.asynchttpclient.request.body.generator.FeedListener; +import org.asynchttpclient.request.body.generator.FeedableBodyGenerator; + +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +public class NettyBodyBody implements NettyBody { + + private final Body body; + private final AsyncHttpClientConfig config; + + public NettyBodyBody(Body body, AsyncHttpClientConfig config) { + this.body = body; + this.config = config; + } + + public Body getBody() { + return body; + } + + @Override + public long getContentLength() { + return body.getContentLength(); + } + + @Override + public void write(final Channel channel, NettyResponseFuture future) { + + Object msg; + if (body instanceof RandomAccessBody && !ChannelManager.isSslHandlerConfigured(channel.pipeline()) && !config.isDisableZeroCopy() && getContentLength() > 0) { + msg = new BodyFileRegion((RandomAccessBody) body); + + } else { + msg = new BodyChunkedInput(body); + + BodyGenerator bg = future.getTargetRequest().getBodyGenerator(); + if (bg instanceof FeedableBodyGenerator) { + final ChunkedWriteHandler chunkedWriteHandler = channel.pipeline().get(ChunkedWriteHandler.class); + ((FeedableBodyGenerator) bg).setListener(new FeedListener() { + @Override + public void onContentAdded() { + chunkedWriteHandler.resumeTransfer(); + } + + @Override + public void onError(Throwable t) { + } + }); + } + } + + channel.write(msg, channel.newProgressivePromise()) + .addListener(new WriteProgressListener(future, false, getContentLength()) { + @Override + public void operationComplete(ChannelProgressiveFuture cf) { + closeSilently(body); + super.operationComplete(cf); + } + }); + channel.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT, channel.voidPromise()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteArrayBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteArrayBody.java new file mode 100755 index 0000000000..b794ab6e96 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteArrayBody.java @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; + +public class NettyByteArrayBody extends NettyDirectBody { + + private final byte[] bytes; + + public NettyByteArrayBody(byte[] bytes) { + this.bytes = bytes; + } + + @Override + public long getContentLength() { + return bytes.length; + } + + @Override + public ByteBuf byteBuf() { + return Unpooled.wrappedBuffer(bytes); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufBody.java new file mode 100644 index 0000000000..d236cdade3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufBody.java @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; + +public class NettyByteBufBody extends NettyDirectBody { + + private final ByteBuf bb; + private final CharSequence contentTypeOverride; + private final long length; + + public NettyByteBufBody(ByteBuf bb) { + this(bb, null); + } + + public NettyByteBufBody(ByteBuf bb, CharSequence contentTypeOverride) { + this.bb = bb; + length = bb.readableBytes(); + this.contentTypeOverride = contentTypeOverride; + } + + @Override + public long getContentLength() { + return length; + } + + @Override + public CharSequence getContentTypeOverride() { + return contentTypeOverride; + } + + @Override + public ByteBuf byteBuf() { + return bb; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufferBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufferBody.java new file mode 100644 index 0000000000..5e79b54b07 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyByteBufferBody.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; + +import java.nio.ByteBuffer; + +public class NettyByteBufferBody extends NettyDirectBody { + + private final ByteBuffer bb; + private final CharSequence contentTypeOverride; + private final long length; + + public NettyByteBufferBody(ByteBuffer bb) { + this(bb, null); + } + + public NettyByteBufferBody(ByteBuffer bb, CharSequence contentTypeOverride) { + this.bb = bb; + length = bb.remaining(); + bb.mark(); + this.contentTypeOverride = contentTypeOverride; + } + + @Override + public long getContentLength() { + return length; + } + + @Override + public CharSequence getContentTypeOverride() { + return contentTypeOverride; + } + + @Override + public ByteBuf byteBuf() { + // for retry + bb.reset(); + return Unpooled.wrappedBuffer(bb); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyCompositeByteArrayBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyCompositeByteArrayBody.java new file mode 100644 index 0000000000..e852528fd7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyCompositeByteArrayBody.java @@ -0,0 +1,47 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; + +import java.util.List; + +public class NettyCompositeByteArrayBody extends NettyDirectBody { + + private final byte[][] bytes; + private final long contentLength; + + public NettyCompositeByteArrayBody(List bytes) { + this.bytes = new byte[bytes.size()][]; + bytes.toArray(this.bytes); + long l = 0; + for (byte[] b : bytes) { + l += b.length; + } + contentLength = l; + } + + @Override + public long getContentLength() { + return contentLength; + } + + @Override + public ByteBuf byteBuf() { + return Unpooled.wrappedBuffer(bytes); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyDirectBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyDirectBody.java new file mode 100644 index 0000000000..55dfcb8bc4 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyDirectBody.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.buffer.ByteBuf; +import io.netty.channel.Channel; +import org.asynchttpclient.netty.NettyResponseFuture; + +public abstract class NettyDirectBody implements NettyBody { + + public abstract ByteBuf byteBuf(); + + @Override + public void write(Channel channel, NettyResponseFuture future) { + throw new UnsupportedOperationException("This kind of body is supposed to be written directly"); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyFileBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyFileBody.java new file mode 100755 index 0000000000..a3c40322dc --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyFileBody.java @@ -0,0 +1,74 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.channel.Channel; +import io.netty.channel.DefaultFileRegion; +import io.netty.handler.codec.http.LastHttpContent; +import io.netty.handler.stream.ChunkedNioFile; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.channel.ChannelManager; +import org.asynchttpclient.netty.request.WriteProgressListener; + +import java.io.File; +import java.io.IOException; +import java.io.RandomAccessFile; +import java.nio.channels.FileChannel; + +public class NettyFileBody implements NettyBody { + + private final File file; + private final long offset; + private final long length; + private final AsyncHttpClientConfig config; + + public NettyFileBody(File file, AsyncHttpClientConfig config) { + this(file, 0, file.length(), config); + } + + public NettyFileBody(File file, long offset, long length, AsyncHttpClientConfig config) { + if (!file.isFile()) { + throw new IllegalArgumentException(String.format("File %s is not a file or doesn't exist", file.getAbsolutePath())); + } + this.file = file; + this.offset = offset; + this.length = length; + this.config = config; + } + + public File getFile() { + return file; + } + + @Override + public long getContentLength() { + return length; + } + + @Override + public void write(Channel channel, NettyResponseFuture future) throws IOException { + @SuppressWarnings("resource") + // netty will close the FileChannel + FileChannel fileChannel = new RandomAccessFile(file, "r").getChannel(); + boolean noZeroCopy = ChannelManager.isSslHandlerConfigured(channel.pipeline()) || config.isDisableZeroCopy(); + Object body = noZeroCopy ? new ChunkedNioFile(fileChannel, offset, length, config.getChunkedFileChunkSize()) : new DefaultFileRegion(fileChannel, offset, length); + + channel.write(body, channel.newProgressivePromise()) + .addListener(new WriteProgressListener(future, false, length)); + channel.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT, channel.voidPromise()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyInputStreamBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyInputStreamBody.java new file mode 100755 index 0000000000..4dba9d951a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyInputStreamBody.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.channel.Channel; +import io.netty.channel.ChannelProgressiveFuture; +import io.netty.handler.codec.http.LastHttpContent; +import io.netty.handler.stream.ChunkedStream; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.WriteProgressListener; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.io.InputStream; + +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +public class NettyInputStreamBody implements NettyBody { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyInputStreamBody.class); + + private final InputStream inputStream; + private final long contentLength; + + public NettyInputStreamBody(InputStream inputStream) { + this(inputStream, -1L); + } + + public NettyInputStreamBody(InputStream inputStream, long contentLength) { + this.inputStream = inputStream; + this.contentLength = contentLength; + } + + public InputStream getInputStream() { + return inputStream; + } + + @Override + public long getContentLength() { + return contentLength; + } + + @Override + public void write(Channel channel, NettyResponseFuture future) throws IOException { + final InputStream is = inputStream; + + if (future.isStreamConsumed()) { + if (is.markSupported()) { + is.reset(); + } else { + LOGGER.warn("Stream has already been consumed and cannot be reset"); + return; + } + } else { + future.setStreamConsumed(true); + } + + channel.write(new ChunkedStream(is), channel.newProgressivePromise()).addListener( + new WriteProgressListener(future, false, getContentLength()) { + @Override + public void operationComplete(ChannelProgressiveFuture cf) { + closeSilently(is); + super.operationComplete(cf); + } + }); + channel.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT, channel.voidPromise()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyMultipartBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyMultipartBody.java new file mode 100755 index 0000000000..7fa23c07f3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyMultipartBody.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.request.body; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.request.body.multipart.MultipartBody; +import org.asynchttpclient.request.body.multipart.Part; + +import java.util.List; + +import static org.asynchttpclient.request.body.multipart.MultipartUtils.newMultipartBody; + +public class NettyMultipartBody extends NettyBodyBody { + + private final String contentTypeOverride; + + public NettyMultipartBody(List parts, HttpHeaders headers, AsyncHttpClientConfig config) { + this(newMultipartBody(parts, headers), config); + } + + private NettyMultipartBody(MultipartBody body, AsyncHttpClientConfig config) { + super(body, config); + contentTypeOverride = body.getContentType(); + } + + @Override + public String getContentTypeOverride() { + return contentTypeOverride; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/ssl/DefaultSslEngineFactory.java b/client/src/main/java/org/asynchttpclient/netty/ssl/DefaultSslEngineFactory.java new file mode 100644 index 0000000000..a96f6ffb1a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/ssl/DefaultSslEngineFactory.java @@ -0,0 +1,94 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.ssl; + +import io.netty.buffer.ByteBufAllocator; +import io.netty.handler.ssl.IdentityCipherSuiteFilter; +import io.netty.handler.ssl.SslContext; +import io.netty.handler.ssl.SslContextBuilder; +import io.netty.handler.ssl.SslProvider; +import io.netty.handler.ssl.util.InsecureTrustManagerFactory; +import io.netty.util.ReferenceCountUtil; +import org.asynchttpclient.AsyncHttpClientConfig; + +import javax.net.ssl.SSLEngine; +import javax.net.ssl.SSLException; +import java.util.Arrays; + +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public class DefaultSslEngineFactory extends SslEngineFactoryBase { + + private volatile SslContext sslContext; + + private SslContext buildSslContext(AsyncHttpClientConfig config) throws SSLException { + if (config.getSslContext() != null) { + return config.getSslContext(); + } + + SslContextBuilder sslContextBuilder = SslContextBuilder.forClient() + .sslProvider(config.isUseOpenSsl() ? SslProvider.OPENSSL : SslProvider.JDK) + .sessionCacheSize(config.getSslSessionCacheSize()) + .sessionTimeout(config.getSslSessionTimeout()); + + if (isNonEmpty(config.getEnabledProtocols())) { + sslContextBuilder.protocols(config.getEnabledProtocols()); + } + + if (isNonEmpty(config.getEnabledCipherSuites())) { + sslContextBuilder.ciphers(Arrays.asList(config.getEnabledCipherSuites())); + } else if (!config.isFilterInsecureCipherSuites()) { + sslContextBuilder.ciphers(null, IdentityCipherSuiteFilter.INSTANCE_DEFAULTING_TO_SUPPORTED_CIPHERS); + } + + if (config.isUseInsecureTrustManager()) { + sslContextBuilder.trustManager(InsecureTrustManagerFactory.INSTANCE); + } + + return configureSslContextBuilder(sslContextBuilder).build(); + } + + @Override + public SSLEngine newSslEngine(AsyncHttpClientConfig config, String peerHost, int peerPort) { + SSLEngine sslEngine = config.isDisableHttpsEndpointIdentificationAlgorithm() ? + sslContext.newEngine(ByteBufAllocator.DEFAULT) : + sslContext.newEngine(ByteBufAllocator.DEFAULT, domain(peerHost), peerPort); + configureSslEngine(sslEngine, config); + return sslEngine; + } + + @Override + public void init(AsyncHttpClientConfig config) throws SSLException { + sslContext = buildSslContext(config); + } + + @Override + public void destroy() { + ReferenceCountUtil.release(sslContext); + } + + /** + * The last step of configuring the SslContextBuilder used to create an SslContext when no context is provided in the {@link AsyncHttpClientConfig}. This defaults to no-op and + * is intended to be overridden as needed. + * + * @param builder builder with normal configuration applied + * @return builder to be used to build context (can be the same object as the input) + */ + protected SslContextBuilder configureSslContextBuilder(SslContextBuilder builder) { + // default to no op + return builder; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/ssl/JsseSslEngineFactory.java b/client/src/main/java/org/asynchttpclient/netty/ssl/JsseSslEngineFactory.java new file mode 100644 index 0000000000..1c76eb84ed --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/ssl/JsseSslEngineFactory.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.ssl; + +import org.asynchttpclient.AsyncHttpClientConfig; + +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLEngine; + +public class JsseSslEngineFactory extends SslEngineFactoryBase { + + private final SSLContext sslContext; + + public JsseSslEngineFactory(SSLContext sslContext) { + this.sslContext = sslContext; + } + + @Override + public SSLEngine newSslEngine(AsyncHttpClientConfig config, String peerHost, int peerPort) { + SSLEngine sslEngine = sslContext.createSSLEngine(domain(peerHost), peerPort); + configureSslEngine(sslEngine, config); + return sslEngine; + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/ssl/SslEngineFactoryBase.java b/client/src/main/java/org/asynchttpclient/netty/ssl/SslEngineFactoryBase.java new file mode 100644 index 0000000000..2d6e5f5eff --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/ssl/SslEngineFactoryBase.java @@ -0,0 +1,39 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.ssl; + +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.SslEngineFactory; + +import javax.net.ssl.SSLEngine; +import javax.net.ssl.SSLParameters; + +public abstract class SslEngineFactoryBase implements SslEngineFactory { + + protected String domain(String hostname) { + int fqdnLength = hostname.length() - 1; + return hostname.charAt(fqdnLength) == '.' ? hostname.substring(0, fqdnLength) : hostname; + } + + protected void configureSslEngine(SSLEngine sslEngine, AsyncHttpClientConfig config) { + sslEngine.setUseClientMode(true); + if (!config.isDisableHttpsEndpointIdentificationAlgorithm()) { + SSLParameters params = sslEngine.getSSLParameters(); + params.setEndpointIdentificationAlgorithm("HTTPS"); + sslEngine.setSSLParameters(params); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/timeout/ReadTimeoutTimerTask.java b/client/src/main/java/org/asynchttpclient/netty/timeout/ReadTimeoutTimerTask.java new file mode 100755 index 0000000000..8b0d4373a1 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/timeout/ReadTimeoutTimerTask.java @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.timeout; + +import io.netty.util.Timeout; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.util.StringBuilderPool; + +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; + +public class ReadTimeoutTimerTask extends TimeoutTimerTask { + + private final long readTimeout; + + ReadTimeoutTimerTask(NettyResponseFuture nettyResponseFuture, NettyRequestSender requestSender, TimeoutsHolder timeoutsHolder, long readTimeout) { + super(nettyResponseFuture, requestSender, timeoutsHolder); + this.readTimeout = readTimeout; + } + + @Override + public void run(Timeout timeout) { + if (done.getAndSet(true) || requestSender.isClosed()) { + return; + } + + if (nettyResponseFuture.isDone()) { + timeoutsHolder.cancel(); + return; + } + + long now = unpreciseMillisTime(); + + long currentReadTimeoutInstant = readTimeout + nettyResponseFuture.getLastTouch(); + long durationBeforeCurrentReadTimeout = currentReadTimeoutInstant - now; + + if (durationBeforeCurrentReadTimeout <= 0L) { + // idleConnectTimeout reached + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder().append("Read timeout to "); + appendRemoteAddress(sb); + String message = sb.append(" after ").append(readTimeout).append(" ms").toString(); + long durationSinceLastTouch = now - nettyResponseFuture.getLastTouch(); + expire(message, durationSinceLastTouch); + // cancel request timeout sibling + timeoutsHolder.cancel(); + + } else { + done.set(false); + timeoutsHolder.startReadTimeout(this); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/timeout/RequestTimeoutTimerTask.java b/client/src/main/java/org/asynchttpclient/netty/timeout/RequestTimeoutTimerTask.java new file mode 100755 index 0000000000..74c5d0197a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/timeout/RequestTimeoutTimerTask.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.timeout; + +import io.netty.util.Timeout; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.asynchttpclient.util.StringBuilderPool; + +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; + +public class RequestTimeoutTimerTask extends TimeoutTimerTask { + + private final long requestTimeout; + + RequestTimeoutTimerTask(NettyResponseFuture nettyResponseFuture, + NettyRequestSender requestSender, + TimeoutsHolder timeoutsHolder, + long requestTimeout) { + super(nettyResponseFuture, requestSender, timeoutsHolder); + this.requestTimeout = requestTimeout; + } + + @Override + public void run(Timeout timeout) { + if (done.getAndSet(true) || requestSender.isClosed()) { + return; + } + + // in any case, cancel possible readTimeout sibling + timeoutsHolder.cancel(); + + if (nettyResponseFuture.isDone()) { + return; + } + + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder().append("Request timeout to "); + appendRemoteAddress(sb); + String message = sb.append(" after ").append(requestTimeout).append(" ms").toString(); + long age = unpreciseMillisTime() - nettyResponseFuture.getStart(); + expire(message, age); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutTimerTask.java b/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutTimerTask.java new file mode 100755 index 0000000000..3c9a3675ea --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutTimerTask.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.timeout; + +import io.netty.util.TimerTask; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.NettyRequestSender; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.InetSocketAddress; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicBoolean; + +public abstract class TimeoutTimerTask implements TimerTask { + + private static final Logger LOGGER = LoggerFactory.getLogger(TimeoutTimerTask.class); + + protected final AtomicBoolean done = new AtomicBoolean(); + protected final NettyRequestSender requestSender; + final TimeoutsHolder timeoutsHolder; + volatile NettyResponseFuture nettyResponseFuture; + + TimeoutTimerTask(NettyResponseFuture nettyResponseFuture, NettyRequestSender requestSender, TimeoutsHolder timeoutsHolder) { + this.nettyResponseFuture = nettyResponseFuture; + this.requestSender = requestSender; + this.timeoutsHolder = timeoutsHolder; + } + + void expire(String message, long time) { + LOGGER.debug("{} for {} after {} ms", message, nettyResponseFuture, time); + requestSender.abort(nettyResponseFuture.channel(), nettyResponseFuture, new TimeoutException(message)); + } + + /** + * When the timeout is cancelled, it could still be referenced for quite some time in the Timer. Holding a reference to the future might mean holding a reference to the + * channel, and heavy objects such as SslEngines + */ + public void clean() { + if (done.compareAndSet(false, true)) { + nettyResponseFuture = null; + } + } + + void appendRemoteAddress(StringBuilder sb) { + InetSocketAddress remoteAddress = timeoutsHolder.remoteAddress(); + sb.append(remoteAddress.getHostString()); + if (!remoteAddress.isUnresolved()) { + sb.append('/').append(remoteAddress.getAddress().getHostAddress()); + } + sb.append(':').append(remoteAddress.getPort()); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutsHolder.java b/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutsHolder.java new file mode 100755 index 0000000000..acce84b6d3 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/timeout/TimeoutsHolder.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.timeout; + +import io.netty.util.Timeout; +import io.netty.util.Timer; +import io.netty.util.TimerTask; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Request; +import org.asynchttpclient.netty.NettyResponseFuture; +import org.asynchttpclient.netty.request.NettyRequestSender; + +import java.net.InetSocketAddress; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; + +public class TimeoutsHolder { + + private final Timeout requestTimeout; + private final AtomicBoolean cancelled = new AtomicBoolean(); + private final Timer nettyTimer; + private final NettyRequestSender requestSender; + private final long requestTimeoutMillisTime; + private final long readTimeoutValue; + private volatile Timeout readTimeout; + private final NettyResponseFuture nettyResponseFuture; + private volatile InetSocketAddress remoteAddress; + + public TimeoutsHolder(Timer nettyTimer, NettyResponseFuture nettyResponseFuture, NettyRequestSender requestSender, + AsyncHttpClientConfig config, InetSocketAddress originalRemoteAddress) { + this.nettyTimer = nettyTimer; + this.nettyResponseFuture = nettyResponseFuture; + this.requestSender = requestSender; + remoteAddress = originalRemoteAddress; + + final Request targetRequest = nettyResponseFuture.getTargetRequest(); + + final long readTimeoutInMs = targetRequest.getReadTimeout().toMillis(); + readTimeoutValue = readTimeoutInMs == 0 ? config.getReadTimeout().toMillis() : readTimeoutInMs; + + long requestTimeoutInMs = targetRequest.getRequestTimeout().toMillis(); + if (requestTimeoutInMs == 0) { + requestTimeoutInMs = config.getRequestTimeout().toMillis(); + } + + if (requestTimeoutInMs > -1) { + requestTimeoutMillisTime = unpreciseMillisTime() + requestTimeoutInMs; + requestTimeout = newTimeout(new RequestTimeoutTimerTask(nettyResponseFuture, requestSender, this, requestTimeoutInMs), requestTimeoutInMs); + } else { + requestTimeoutMillisTime = -1L; + requestTimeout = null; + } + } + + public void setResolvedRemoteAddress(InetSocketAddress address) { + remoteAddress = address; + } + + InetSocketAddress remoteAddress() { + return remoteAddress; + } + + public void startReadTimeout() { + if (readTimeoutValue != -1) { + startReadTimeout(null); + } + } + + void startReadTimeout(ReadTimeoutTimerTask task) { + if (requestTimeout == null || !requestTimeout.isExpired() && readTimeoutValue < requestTimeoutMillisTime - unpreciseMillisTime()) { + // only schedule a new readTimeout if the requestTimeout doesn't happen first + if (task == null) { + // first call triggered from outside (else is read timeout is re-scheduling itself) + task = new ReadTimeoutTimerTask(nettyResponseFuture, requestSender, this, readTimeoutValue); + } + readTimeout = newTimeout(task, readTimeoutValue); + + } else if (task != null) { + // read timeout couldn't re-scheduling itself, clean up + task.clean(); + } + } + + public void cancel() { + if (cancelled.compareAndSet(false, true)) { + if (requestTimeout != null) { + requestTimeout.cancel(); + ((TimeoutTimerTask) requestTimeout.task()).clean(); + } + if (readTimeout != null) { + readTimeout.cancel(); + ((TimeoutTimerTask) readTimeout.task()).clean(); + } + } + } + + private Timeout newTimeout(TimerTask task, long delay) { + return requestSender.isClosed() ? null : nettyTimer.newTimeout(task, delay, TimeUnit.MILLISECONDS); + } +} diff --git a/client/src/main/java/org/asynchttpclient/netty/ws/NettyWebSocket.java b/client/src/main/java/org/asynchttpclient/netty/ws/NettyWebSocket.java new file mode 100755 index 0000000000..2329edacf9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/netty/ws/NettyWebSocket.java @@ -0,0 +1,350 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.ws; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame; +import io.netty.handler.codec.http.websocketx.CloseWebSocketFrame; +import io.netty.handler.codec.http.websocketx.ContinuationWebSocketFrame; +import io.netty.handler.codec.http.websocketx.PingWebSocketFrame; +import io.netty.handler.codec.http.websocketx.PongWebSocketFrame; +import io.netty.handler.codec.http.websocketx.TextWebSocketFrame; +import io.netty.handler.codec.http.websocketx.WebSocketFrame; +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.ImmediateEventExecutor; +import org.asynchttpclient.netty.channel.Channels; +import org.asynchttpclient.ws.WebSocket; +import org.asynchttpclient.ws.WebSocketListener; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.SocketAddress; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.concurrent.ConcurrentLinkedQueue; + +import static io.netty.buffer.Unpooled.wrappedBuffer; + +public final class NettyWebSocket implements WebSocket { + + private static final Logger LOGGER = LoggerFactory.getLogger(NettyWebSocket.class); + + private final Channel channel; + private final HttpHeaders upgradeHeaders; + private final Collection listeners; + private FragmentedFrameType expectedFragmentedFrameType; + // no need for volatile because only mutated in IO thread + private boolean ready; + private List bufferedFrames; + + public NettyWebSocket(Channel channel, HttpHeaders upgradeHeaders) { + this(channel, upgradeHeaders, new ConcurrentLinkedQueue<>()); + } + + private NettyWebSocket(Channel channel, HttpHeaders upgradeHeaders, Collection listeners) { + this.channel = channel; + this.upgradeHeaders = upgradeHeaders; + this.listeners = listeners; + } + + @Override + public HttpHeaders getUpgradeHeaders() { + return upgradeHeaders; + } + + @Override + public SocketAddress getRemoteAddress() { + return channel.remoteAddress(); + } + + @Override + public SocketAddress getLocalAddress() { + return channel.localAddress(); + } + + @Override + public Future sendTextFrame(String message) { + return sendTextFrame(message, true, 0); + } + + @Override + public Future sendTextFrame(String payload, boolean finalFragment, int rsv) { + return channel.writeAndFlush(new TextWebSocketFrame(finalFragment, rsv, payload)); + } + + @Override + public Future sendTextFrame(ByteBuf payload, boolean finalFragment, int rsv) { + return channel.writeAndFlush(new TextWebSocketFrame(finalFragment, rsv, payload)); + } + + @Override + public Future sendBinaryFrame(byte[] payload) { + return sendBinaryFrame(payload, true, 0); + } + + @Override + public Future sendBinaryFrame(byte[] payload, boolean finalFragment, int rsv) { + return sendBinaryFrame(wrappedBuffer(payload), finalFragment, rsv); + } + + @Override + public Future sendBinaryFrame(ByteBuf payload, boolean finalFragment, int rsv) { + return channel.writeAndFlush(new BinaryWebSocketFrame(finalFragment, rsv, payload)); + } + + @Override + public Future sendContinuationFrame(String payload, boolean finalFragment, int rsv) { + return channel.writeAndFlush(new ContinuationWebSocketFrame(finalFragment, rsv, payload)); + } + + @Override + public Future sendContinuationFrame(byte[] payload, boolean finalFragment, int rsv) { + return sendContinuationFrame(wrappedBuffer(payload), finalFragment, rsv); + } + + @Override + public Future sendContinuationFrame(ByteBuf payload, boolean finalFragment, int rsv) { + return channel.writeAndFlush(new ContinuationWebSocketFrame(finalFragment, rsv, payload)); + } + + @Override + public Future sendPingFrame() { + return channel.writeAndFlush(new PingWebSocketFrame()); + } + + @Override + public Future sendPingFrame(byte[] payload) { + return sendPingFrame(wrappedBuffer(payload)); + } + + @Override + public Future sendPingFrame(ByteBuf payload) { + return channel.writeAndFlush(new PingWebSocketFrame(payload)); + } + + @Override + public Future sendPongFrame() { + return channel.writeAndFlush(new PongWebSocketFrame()); + } + + @Override + public Future sendPongFrame(byte[] payload) { + return sendPongFrame(wrappedBuffer(payload)); + } + + @Override + public Future sendPongFrame(ByteBuf payload) { + return channel.writeAndFlush(new PongWebSocketFrame(wrappedBuffer(payload))); + } + + @Override + public Future sendCloseFrame() { + return sendCloseFrame(1000, "normal closure"); + } + + @Override + public Future sendCloseFrame(int statusCode, String reasonText) { + if (channel.isOpen()) { + return channel.writeAndFlush(new CloseWebSocketFrame(statusCode, reasonText)); + } + return ImmediateEventExecutor.INSTANCE.newSucceededFuture(null); + } + + @Override + public boolean isOpen() { + return channel.isOpen(); + } + + @Override + public WebSocket addWebSocketListener(WebSocketListener l) { + listeners.add(l); + return this; + } + + @Override + public WebSocket removeWebSocketListener(WebSocketListener l) { + listeners.remove(l); + return this; + } + + // INTERNAL, NOT FOR PUBLIC USAGE!!! + + public boolean isReady() { + return ready; + } + + public void bufferFrame(WebSocketFrame frame) { + if (bufferedFrames == null) { + bufferedFrames = new ArrayList<>(1); + } + frame.retain(); + bufferedFrames.add(frame); + } + + private void releaseBufferedFrames() { + if (bufferedFrames != null) { + for (WebSocketFrame frame : bufferedFrames) { + frame.release(); + } + bufferedFrames = null; + } + } + + public void processBufferedFrames() { + ready = true; + if (bufferedFrames != null) { + try { + for (WebSocketFrame frame : bufferedFrames) { + handleFrame(frame); + } + } finally { + releaseBufferedFrames(); + } + bufferedFrames = null; + } + } + + public void handleFrame(WebSocketFrame frame) { + if (frame instanceof TextWebSocketFrame) { + onTextFrame((TextWebSocketFrame) frame); + + } else if (frame instanceof BinaryWebSocketFrame) { + onBinaryFrame((BinaryWebSocketFrame) frame); + + } else if (frame instanceof CloseWebSocketFrame) { + Channels.setDiscard(channel); + CloseWebSocketFrame closeFrame = (CloseWebSocketFrame) frame; + onClose(closeFrame.statusCode(), closeFrame.reasonText()); + Channels.silentlyCloseChannel(channel); + + } else if (frame instanceof PingWebSocketFrame) { + onPingFrame((PingWebSocketFrame) frame); + + } else if (frame instanceof PongWebSocketFrame) { + onPongFrame((PongWebSocketFrame) frame); + + } else if (frame instanceof ContinuationWebSocketFrame) { + onContinuationFrame((ContinuationWebSocketFrame) frame); + } + } + + public void onError(Throwable t) { + try { + for (WebSocketListener listener : listeners) { + try { + listener.onError(t); + } catch (Throwable t2) { + LOGGER.error("WebSocketListener.onError crash", t2); + } + } + } finally { + releaseBufferedFrames(); + } + } + + public void onClose(int code, String reason) { + try { + for (WebSocketListener listener : listeners) { + try { + listener.onClose(this, code, reason); + } catch (Throwable t) { + listener.onError(t); + } + } + listeners.clear(); + } finally { + releaseBufferedFrames(); + } + } + + @Override + public String toString() { + return "NettyWebSocket{channel=" + channel + '}'; + } + + private void onBinaryFrame(BinaryWebSocketFrame frame) { + if (expectedFragmentedFrameType == null && !frame.isFinalFragment()) { + expectedFragmentedFrameType = FragmentedFrameType.BINARY; + } + onBinaryFrame0(frame); + } + + private void onBinaryFrame0(WebSocketFrame frame) { + byte[] bytes = ByteBufUtil.getBytes(frame.content()); + for (WebSocketListener listener : listeners) { + listener.onBinaryFrame(bytes, frame.isFinalFragment(), frame.rsv()); + } + } + + private void onTextFrame(TextWebSocketFrame frame) { + if (expectedFragmentedFrameType == null && !frame.isFinalFragment()) { + expectedFragmentedFrameType = FragmentedFrameType.TEXT; + } + onTextFrame0(frame); + } + + private void onTextFrame0(WebSocketFrame frame) { + for (WebSocketListener listener : listeners) { + listener.onTextFrame(frame.content().toString(StandardCharsets.UTF_8), frame.isFinalFragment(), frame.rsv()); + } + } + + private void onContinuationFrame(ContinuationWebSocketFrame frame) { + if (expectedFragmentedFrameType == null) { + LOGGER.warn("Received continuation frame without an original text or binary frame, ignoring"); + return; + } + try { + switch (expectedFragmentedFrameType) { + case BINARY: + onBinaryFrame0(frame); + break; + case TEXT: + onTextFrame0(frame); + break; + default: + throw new IllegalArgumentException("Unknown FragmentedFrameType " + expectedFragmentedFrameType); + } + } finally { + if (frame.isFinalFragment()) { + expectedFragmentedFrameType = null; + } + } + } + + private void onPingFrame(PingWebSocketFrame frame) { + byte[] bytes = ByteBufUtil.getBytes(frame.content()); + for (WebSocketListener listener : listeners) { + listener.onPingFrame(bytes); + } + } + + private void onPongFrame(PongWebSocketFrame frame) { + byte[] bytes = ByteBufUtil.getBytes(frame.content()); + for (WebSocketListener listener : listeners) { + listener.onPongFrame(bytes); + } + } + + private enum FragmentedFrameType { + TEXT, BINARY + } +} diff --git a/client/src/main/java/org/asynchttpclient/ntlm/NtlmEngine.java b/client/src/main/java/org/asynchttpclient/ntlm/NtlmEngine.java new file mode 100644 index 0000000000..c2338c46a0 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ntlm/NtlmEngine.java @@ -0,0 +1,1586 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + */ +// fork from Apache HttpComponents +package org.asynchttpclient.ntlm; + +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.Nullable; + +import javax.crypto.Cipher; +import javax.crypto.spec.SecretKeySpec; +import java.io.UnsupportedEncodingException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.security.Key; +import java.security.MessageDigest; +import java.security.SecureRandom; +import java.util.Arrays; +import java.util.Base64; +import java.util.Locale; + +import static java.nio.charset.StandardCharsets.US_ASCII; + +/** + * Provides an implementation for NTLMv1, NTLMv2, and NTLM2 Session forms of the NTLM + * authentication protocol. + * + * @since 4.1 + */ +@SuppressWarnings("unused") +public final class NtlmEngine { + + public static final NtlmEngine INSTANCE = new NtlmEngine(); + + /** + * Unicode encoding + */ + private static final Charset UNICODE_LITTLE_UNMARKED = StandardCharsets.UTF_16LE; + + private static final byte[] MAGIC_CONSTANT = "KGS!@#$%".getBytes(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 + private static final int FLAG_REQUEST_UNICODE_ENCODING = 0x00000001; // Unicode string encoding requested + private static final int FLAG_REQUEST_TARGET = 0x00000004; // Requests target field + private static final int FLAG_REQUEST_SIGN = 0x00000010; // Requests all messages have a signature attached, in NEGOTIATE message. + private static final int FLAG_REQUEST_SEAL = 0x00000020; // Request key exchange for message confidentiality in NEGOTIATE message. MUST be used in conjunction with 56BIT. + private static final int FLAG_REQUEST_LAN_MANAGER_KEY = 0x00000080; // Request Lan Manager key instead of user session key + private static final int FLAG_REQUEST_NTLMv1 = 0x00000200; // Request NTLMv1 security. MUST be set in NEGOTIATE and CHALLENGE both + private static final int FLAG_DOMAIN_PRESENT = 0x00001000; // Domain is present in message + private static final int FLAG_WORKSTATION_PRESENT = 0x00002000; // Workstation is present in message + private static final int FLAG_REQUEST_ALWAYS_SIGN = 0x00008000; // Requests a signature block on all messages. Overridden by REQUEST_SIGN and REQUEST_SEAL. + private static final int FLAG_REQUEST_NTLM2_SESSION = 0x00080000; // From server in challenge, requesting NTLM2 session security + private static final int FLAG_REQUEST_VERSION = 0x02000000; // Request protocol version + private static final int FLAG_TARGETINFO_PRESENT = 0x00800000; // From server in challenge message, indicating targetinfo is present + private static final int FLAG_REQUEST_128BIT_KEY_EXCH = 0x20000000; // Request explicit 128-bit key exchange + private static final int FLAG_REQUEST_EXPLICIT_KEY_EXCH = 0x40000000; // Request explicit key exchange + private static final int FLAG_REQUEST_56BIT_ENCRYPTION = 0x80000000; // Must be used in conjunction with SEAL + + /** + * Secure random generator + */ + private static final @Nullable SecureRandom RND_GEN; + + static { + SecureRandom rnd = null; + try { + rnd = SecureRandom.getInstance("SHA1PRNG"); + } catch (final Exception ignore) { + } + RND_GEN = rnd; + } + + /** + * The signature string as bytes in the default encoding + */ + private static final byte[] SIGNATURE; + + static { + final byte[] bytesWithoutNull = "NTLMSSP".getBytes(US_ASCII); + SIGNATURE = new byte[bytesWithoutNull.length + 1]; + System.arraycopy(bytesWithoutNull, 0, SIGNATURE, 0, bytesWithoutNull.length); + SIGNATURE[bytesWithoutNull.length] = 0x00; + } + + private static final String TYPE_1_MESSAGE = new Type1Message().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 username. 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 {@encrypt(byte[],byte[])} fails. + */ + private static String getType3Message(final String user, final String password, final String host, final String domain, final byte[] nonce, + final int type2Flags, final @Nullable String target, final byte @Nullable [] targetInformation) { + return new Type3Message(domain, host, user, password, nonce, type2Flags, target, targetInformation).getResponse(); + } + + /** + * Strip dot suffix from a name + */ + private static String stripDotSuffix(final String value) { + final int index = value.indexOf('.'); + if (index != -1) { + return value.substring(0, index); + } + return value; + } + + /** + * Convert host to standard form + */ + @Contract(value = "!null -> !null", pure = true) + private static @Nullable String convertHost(final String host) { + return host != null ? stripDotSuffix(host).toUpperCase() : null; + } + + /** + * Convert domain to standard form + */ + @Contract(value = "!null -> !null", pure = true) + private static @Nullable String convertDomain(final String domain) { + return domain != null ? stripDotSuffix(domain).toUpperCase() : null; + } + + private static int readULong(final byte[] src, final int index) { + if (src.length < index + 4) { + throw new NtlmEngineException("NTLM authentication - buffer too small for DWORD"); + } + 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) { + throw new NtlmEngineException("NTLM authentication - buffer too small for WORD"); + } + 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) { + throw new NtlmEngineException("NTLM authentication - buffer too small for data item"); + } + final byte[] buffer = new byte[length]; + System.arraycopy(src, offset, buffer, 0, length); + return buffer; + } + + /** + * Calculate a challenge block + */ + private static byte[] makeRandomChallenge() { + if (RND_GEN == null) { + throw new NtlmEngineException("Random generator not available"); + } + final byte[] rval = new byte[8]; + synchronized (RND_GEN) { + RND_GEN.nextBytes(rval); + } + return rval; + } + + /** + * Calculate a 16-byte secondary key + */ + private static byte[] makeSecondaryKey() { + if (RND_GEN == null) { + throw new NtlmEngineException("Random generator not available"); + } + final byte[] rval = new byte[16]; + synchronized (RND_GEN) { + RND_GEN.nextBytes(rval); + } + return rval; + } + + private static class CipherGen { + + protected final String domain; + protected final String user; + protected final String password; + protected final byte[] challenge; + protected final @Nullable String target; + protected final byte @Nullable [] targetInformation; + + // Information we can generate but may be passed in (for testing) + protected byte @Nullable [] clientChallenge; + protected byte @Nullable [] clientChallenge2; + protected byte @Nullable [] secondaryKey; + protected byte @Nullable [] timestamp; + + // Stuff we always generate + protected byte @Nullable [] lmHash; + protected byte @Nullable [] lmResponse; + protected byte @Nullable [] ntlmHash; + protected byte @Nullable [] ntlmResponse; + protected byte @Nullable [] ntlmv2Hash; + protected byte @Nullable [] lmv2Hash; + protected byte @Nullable [] lmv2Response; + protected byte @Nullable [] ntlmv2Blob; + protected byte @Nullable [] ntlmv2Response; + protected byte @Nullable [] ntlm2SessionResponse; + protected byte @Nullable [] lm2SessionResponse; + protected byte @Nullable [] lmUserSessionKey; + protected byte @Nullable [] ntlmUserSessionKey; + protected byte @Nullable [] ntlmv2UserSessionKey; + protected byte @Nullable [] ntlm2SessionResponseUserSessionKey; + protected byte @Nullable [] lanManagerSessionKey; + + CipherGen(final String domain, final String user, final String password, final byte[] challenge, final @Nullable String target, + final byte @Nullable [] targetInformation, final byte @Nullable [] clientChallenge, final byte @Nullable [] clientChallenge2, + final byte @Nullable [] secondaryKey, final byte @Nullable [] timestamp) { + 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 String domain, final String user, final String password, final byte[] challenge, final @Nullable String target, + final byte @Nullable [] targetInformation) { + this(domain, user, password, challenge, target, targetInformation, null, null, null, null); + } + + /** + * Calculate and return client challenge + */ + public byte[] getClientChallenge() { + if (clientChallenge == null) { + clientChallenge = makeRandomChallenge(); + } + return clientChallenge; + } + + /** + * Calculate and return second client challenge + */ + public byte[] getClientChallenge2() { + if (clientChallenge2 == null) { + clientChallenge2 = makeRandomChallenge(); + } + return clientChallenge2; + } + + /** + * Calculate and return random secondary key + */ + public byte[] getSecondaryKey() { + if (secondaryKey == null) { + secondaryKey = makeSecondaryKey(); + } + return secondaryKey; + } + + /** + * Calculate and return the LMHash + */ + public byte[] getLMHash() { + if (lmHash == null) { + lmHash = lmHash(password); + } + return lmHash; + } + + /** + * Calculate and return the LMResponse + */ + public byte[] getLMResponse() { + if (lmResponse == null) { + lmResponse = lmResponse(getLMHash(), challenge); + } + return lmResponse; + } + + /** + * Calculate and return the NTLMHash + */ + public byte[] getNTLMHash() { + if (ntlmHash == null) { + ntlmHash = ntlmHash(password); + } + return ntlmHash; + } + + /** + * Calculate and return the NTLMResponse + */ + public byte[] getNTLMResponse() { + if (ntlmResponse == null) { + ntlmResponse = lmResponse(getNTLMHash(), challenge); + } + return ntlmResponse; + } + + /** + * Calculate the LMv2 hash + */ + public byte[] getLMv2Hash() { + if (lmv2Hash == null) { + lmv2Hash = lmv2Hash(domain, user, getNTLMHash()); + } + return lmv2Hash; + } + + /** + * Calculate the NTLMv2 hash + */ + public byte[] getNTLMv2Hash() { + if (ntlmv2Hash == null) { + ntlmv2Hash = ntlmv2Hash(domain, user, getNTLMHash()); + } + return ntlmv2Hash; + } + + /** + * Calculate a timestamp + */ + public byte[] getTimestamp() { + if (timestamp == null) { + long time = System.currentTimeMillis(); + 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 + * + * @param targetInformation this parameter is the same object as the field targetInformation, + * but guaranteed to be not null. This is done to satisfy NullAway requirements + */ + public byte[] getNTLMv2Blob(byte[] targetInformation) { + if (ntlmv2Blob == null) { + ntlmv2Blob = createBlob(getClientChallenge2(), targetInformation, getTimestamp()); + } + return ntlmv2Blob; + } + + /** + * Calculate the NTLMv2Response + * + * @param targetInformation this parameter is the same object as the field targetInformation, + * but guaranteed to be not null. This is done to satisfy NullAway requirements + */ + public byte[] getNTLMv2Response(byte[] targetInformation) { + if (ntlmv2Response == null) { + ntlmv2Response = lmv2Response(getNTLMv2Hash(), challenge, getNTLMv2Blob(targetInformation)); + } + return ntlmv2Response; + } + + /** + * Calculate the LMv2Response + */ + public byte[] getLMv2Response() { + if (lmv2Response == null) { + lmv2Response = lmv2Response(getLMv2Hash(), challenge, getClientChallenge()); + } + return lmv2Response; + } + + /** + * Get NTLM2SessionResponse + */ + public byte[] getNTLM2SessionResponse() { + if (ntlm2SessionResponse == null) { + ntlm2SessionResponse = ntlm2SessionResponse(getNTLMHash(), challenge, getClientChallenge()); + } + return ntlm2SessionResponse; + } + + /** + * Calculate and return LM2 session response + */ + public 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 + */ + public byte[] getLMUserSessionKey() { + 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 + */ + public byte[] getNTLMUserSessionKey() { + if (ntlmUserSessionKey == null) { + final MD4 md4 = new MD4(); + md4.update(getNTLMHash()); + ntlmUserSessionKey = md4.getOutput(); + } + return ntlmUserSessionKey; + } + + /** + * GetNTLMv2UserSessionKey + * + * @param targetInformation this parameter is the same object as the field targetInformation, + * but guaranteed to be not null. This is done to satisfy NullAway requirements + */ + public byte[] getNTLMv2UserSessionKey(byte[] targetInformation) { + if (ntlmv2UserSessionKey == null) { + final byte[] ntlmv2hash = getNTLMv2Hash(); + final byte[] truncatedResponse = new byte[16]; + System.arraycopy(getNTLMv2Response(targetInformation), 0, truncatedResponse, 0, 16); + ntlmv2UserSessionKey = hmacMD5(truncatedResponse, ntlmv2hash); + } + return ntlmv2UserSessionKey; + } + + /** + * Get NTLM2SessionResponseUserSessionKey + */ + public 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 + */ + public byte[] getLanManagerSessionKey() { + 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 + */ + private static byte[] hmacMD5(final byte[] value, final byte[] key) { + final HMACMD5 hmacMD5 = new HMACMD5(key); + hmacMD5.update(value); + return hmacMD5.getOutput(); + } + + /** + * Calculates RC4 + */ + private static byte[] RC4(final byte[] value, final byte[] key) { + 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. + */ + private static byte[] ntlm2SessionResponse(final byte[] ntlmHash, final byte[] challenge, final byte[] clientChallenge) { + try { + final MessageDigest md5 = MessageDigest.getInstance("MD5"); + 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 String password) { + try { + final byte[] oemPassword = password.toUpperCase(Locale.ROOT).getBytes(US_ASCII); + 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 Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); + des.init(Cipher.ENCRYPT_MODE, lowKey); + final byte[] lowHash = des.doFinal(MAGIC_CONSTANT); + des.init(Cipher.ENCRYPT_MODE, highKey); + final byte[] highHash = des.doFinal(MAGIC_CONSTANT); + 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 String password) { + final byte[] unicodePassword = password.getBytes(UNICODE_LITTLE_UNMARKED); + 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) { + 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; + } + + /** + * 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 = {(byte) 0x01, (byte) 0x01, (byte) 0x00, (byte) 0x00}; + final byte[] reserved = {(byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00}; + final byte[] unknown1 = {(byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00}; + final byte[] unknown2 = {(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); + 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] |= 0x01; + } else { + bytes[i] &= (byte) 0xfe; + } + } + } + + /** + * NTLM message generation, base class + */ + private static class NTLMMessage { + private static final byte[] EMPTY_BYTE_ARRAY = {}; + /** + * The current response + */ + private byte[] messageContents = EMPTY_BYTE_ARRAY; + + /** + * The current output position + */ + private int currentOutputPosition; + + /** + * Constructor to use when message contents are not yet known + */ + NTLMMessage() { + } + + /** + * Constructor to use when message contents are known + */ + NTLMMessage(final String messageBody, final int expectedType) { + messageContents = Base64.getDecoder().decode(messageBody); + // 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. + */ + protected int getPreambleLength() { + return SIGNATURE.length + 4; + } + + /** + * Get the message length + */ + protected final int getMessageLength() { + return currentOutputPosition; + } + + /** + * Read a byte from a position within the message buffer + */ + protected byte readByte(final int position) { + 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 + */ + protected final void readBytes(final byte[] buffer, final int position) { + if (messageContents.length < position + buffer.length) { + throw new NtlmEngineException("NTLM: Message too short"); + } + System.arraycopy(messageContents, position, buffer, 0, buffer.length); + } + + /** + * Read an ushort from a position within the message buffer + */ + protected int readUShort(final int position) { + return NtlmEngine.readUShort(messageContents, position); + } + + /** + * Read an ulong from a position within the message buffer + */ + protected final int readULong(final int position) { + return NtlmEngine.readULong(messageContents, position); + } + + /** + * Read a security buffer from a position within the message buffer + */ + protected final byte[] readSecurityBuffer(final int position) { + return NtlmEngine.readSecurityBuffer(messageContents, position); + } + + /** + * Prepares the object to create a response of the given length. + * + * @param maxlength the maximum length of the response to prepare, not + * including the type and the signature (which this method + * adds). + */ + protected 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. + */ + protected void addByte(final byte b) { + messageContents[currentOutputPosition] = b; + currentOutputPosition++; + } + + /** + * Adds the given bytes to the response. + * + * @param bytes the bytes to add. + */ + protected void addBytes(final byte @Nullable [] bytes) { + if (bytes == null) { + return; + } + for (final byte b : bytes) { + messageContents[currentOutputPosition] = b; + currentOutputPosition++; + } + } + + /** + * Adds a USHORT to the response + */ + protected void addUShort(final int value) { + addByte((byte) (value & 0xff)); + addByte((byte) (value >> 8 & 0xff)); + } + + /** + * Adds a ULong to the response + */ + protected 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() { + final byte[] resp; + if (messageContents.length > currentOutputPosition) { + final byte[] tmp = new byte[currentOutputPosition]; + System.arraycopy(messageContents, 0, tmp, 0, currentOutputPosition); + resp = tmp; + } else { + resp = messageContents; + } + return Base64.getEncoder().encodeToString(resp); + } + + } + + /** + * Type 1 message assembly class + */ + private static class Type1Message extends NTLMMessage { + + /** + * Getting the response involves building the message before returning + * it + */ + @Override + String getResponse() { + // Now, build the message. Calculate its length first, including + // signature or type. + final int finalLength = 32 + 8; + + // 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( + //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); + + // Domain length (two times). + addUShort(0); + addUShort(0); + + // Domain offset. + addULong(finalLength); + + // Host length (two times). + addUShort(0); + addUShort(0); + + // Host offset (always 32 + 8). + addULong(finalLength); + + // Version + addUShort(0x0105); + // Build + addULong(2600); + // NTLM revision + addUShort(0x0f00); + + return super.getResponse(); + } + } + + /** + * Type 2 message class + */ + static class Type2Message extends NTLMMessage { + protected byte[] challenge; + protected @Nullable String target; + protected byte @Nullable [] targetInfo; + protected int flags; + + Type2Message(final String message) { + 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 an 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); + + if ((flags & FLAG_REQUEST_UNICODE_ENCODING) == 0) { + throw new NtlmEngineException("NTLM type 2 message indicates no support for Unicode. Flags are: " + flags); + } + + // 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) { + try { + target = new String(bytes, "UnicodeLittleUnmarked"); + } catch (final UnsupportedEncodingException e) { + throw new NtlmEngineException(e.getMessage(), e); + } + } + } + + // 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 + */ + @Nullable + String getTarget() { + return target; + } + + /** + * Retrieve the target info + */ + byte @Nullable [] getTargetInfo() { + return targetInfo; + } + + /** + * Retrieve the response flags + */ + int getFlags() { + return flags; + } + + } + + /** + * Type 3 message assembly class + */ + static class Type3Message extends NTLMMessage { + // Response flags from the type2 message + protected int type2Flags; + + protected byte @Nullable [] domainBytes; + protected byte @Nullable [] hostBytes; + protected byte[] userBytes; + + protected byte[] lmResp; + protected byte[] ntResp; + protected byte @Nullable [] sessionKey; + + /** + * Constructor. Pass the arguments we will need + */ + Type3Message(final String domain, final String host, final String user, final String password, final byte[] nonce, + final int type2Flags, final @Nullable String target, final byte @Nullable [] targetInformation) { + // Save the flags + this.type2Flags = type2Flags; + + // Strip off domain name from the host! + final String unqualifiedHost = convertHost(host); + // Use only the base domain name! + final String unqualifiedDomain = convertDomain(domain); + + // Create a cipher generator class. Use domain BEFORE it gets modified! + final CipherGen gen = new CipherGen(unqualifiedDomain, user, password, nonce, target, targetInformation); + + // 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(targetInformation); + lmResp = gen.getLMv2Response(); + if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { + userSessionKey = gen.getLanManagerSessionKey(); + } else { + userSessionKey = gen.getNTLMv2UserSessionKey(targetInformation); + } + } 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) { + sessionKey = RC4(gen.getSecondaryKey(), userSessionKey); + } else { + sessionKey = userSessionKey; + } + } else { + sessionKey = null; + } + hostBytes = unqualifiedHost != null ? unqualifiedHost.getBytes(UNICODE_LITTLE_UNMARKED) : null; + domainBytes = unqualifiedDomain != null ? unqualifiedDomain.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED) : null; + userBytes = user.getBytes(UNICODE_LITTLE_UNMARKED); + } + + /** + * Assemble the response + */ + @Override + String getResponse() { + 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 + 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); + + // Version + addUShort(0x0105); + // Build + addULong(2600); + // NTLM revision + addUShort(0x0f00); + + // Add the actual data + addBytes(lmResp); + addBytes(ntResp); + addBytes(domainBytes); + addBytes(userBytes); + addBytes(hostBytes); + if (sessionKey != null) { + addBytes(sessionKey); + } + + return super.getResponse(); + } + } + + 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; + } + + /** + * Cryptography support - MD4. The following class was based loosely on the + * RFC and on code found at .... + * Code correctness was verified by looking at MD4.java from the jcifs + * library (...). It was massaged extensively to the + * final form found here by Karl Wright (kwright@metacarta.com). + */ + static class MD4 { + protected int A = 0x67452301; + protected int B = 0xefcdab89; + protected int C = 0x98badcfe; + protected int D = 0x10325476; + protected long count; + protected byte[] dataBuffer = new byte[64]; + + 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; + } + } + + 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; + } + + protected 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; + + } + + protected 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); + } + + protected 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); + + } + + protected 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 + */ + private static class HMACMD5 { + protected byte[] ipad; + protected byte[] opad; + protected MessageDigest md5; + + HMACMD5(final byte[] input) { + byte[] key = input; + try { + md5 = MessageDigest.getInstance("MD5"); + } catch (final Exception ex) { + // Umm, the algorithm doesn't exist - throw an + // NTLMEngineException! + throw new NtlmEngineException("Error getting md5 message digest implementation: " + ex.getMessage(), ex); + } + + // 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] = 0x36; + opad[i] = 0x5c; + i++; + } + + // Very important: update 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); + } + } + + /** + * Creates the first message (type 1 message) in the NTLM authentication + * sequence. This message includes the username, domain and host for the + * authentication session. + * + * @return String the message to add to the HTTP request header. + */ + public String generateType1Msg() { + return TYPE_1_MESSAGE; + } + + public static String generateType3Msg(final String username, final String password, final String domain, final String workstation, + final String challenge) { + final Type2Message t2m = new Type2Message(challenge); + return getType3Message(username, password, workstation, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), + t2m.getTargetInfo()); + } + +} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/ntlm/NTLMEngineException.java b/client/src/main/java/org/asynchttpclient/ntlm/NtlmEngineException.java similarity index 65% rename from src/main/java/com/ning/http/client/ntlm/NTLMEngineException.java rename to client/src/main/java/org/asynchttpclient/ntlm/NtlmEngineException.java index d1c557520a..dd7827cbf7 100644 --- a/src/main/java/com/ning/http/client/ntlm/NTLMEngineException.java +++ b/client/src/main/java/org/asynchttpclient/ntlm/NtlmEngineException.java @@ -1,15 +1,3 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ /* * ==================================================================== * @@ -35,28 +23,24 @@ * . * */ +package org.asynchttpclient.ntlm; + -package com.ning.http.client.ntlm; +import org.jetbrains.annotations.Nullable; /** * Signals NTLM protocol failure. - * - * @since 4.0 */ -public class NTLMEngineException extends Exception { +class NtlmEngineException extends RuntimeException { 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(String message) { + NtlmEngineException(String message) { super(message); } @@ -67,8 +51,7 @@ public NTLMEngineException(String message) { * @param cause the Throwable that caused this exception, or null * if the cause is unavailable, unknown, or not a Throwable */ - public NTLMEngineException(String message, Throwable cause) { + NtlmEngineException(@Nullable String message, Throwable cause) { super(message, cause); } - } diff --git a/client/src/main/java/org/asynchttpclient/proxy/ProxyServer.java b/client/src/main/java/org/asynchttpclient/proxy/ProxyServer.java new file mode 100644 index 0000000000..9cb33362c5 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/proxy/ProxyServer.java @@ -0,0 +1,189 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient.proxy; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.jetbrains.annotations.Nullable; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +/** + * Represents a proxy server. + */ +public class ProxyServer { + + private final String host; + private final int port; + private final int securedPort; + private final @Nullable Realm realm; + private final List nonProxyHosts; + private final ProxyType proxyType; + private final @Nullable Function customHeaders; + + public ProxyServer(String host, int port, int securedPort, @Nullable Realm realm, List nonProxyHosts, ProxyType proxyType, + @Nullable Function customHeaders) { + this.host = host; + this.port = port; + this.securedPort = securedPort; + this.realm = realm; + this.nonProxyHosts = nonProxyHosts; + this.proxyType = proxyType; + this.customHeaders = customHeaders; + } + + public ProxyServer(String host, int port, int securedPort, Realm realm, List nonProxyHosts, ProxyType proxyType) { + this(host, port, securedPort, realm, nonProxyHosts, proxyType, null); + } + + public String getHost() { + return host; + } + + public int getPort() { + return port; + } + + public int getSecuredPort() { + return securedPort; + } + + public List getNonProxyHosts() { + return nonProxyHosts; + } + + public @Nullable Realm getRealm() { + return realm; + } + + public ProxyType getProxyType() { + return proxyType; + } + + public @Nullable Function getCustomHeaders() { + return customHeaders; + } + + /** + * Checks whether proxy should be used according to nonProxyHosts settings of + * it, or we want to go directly to target host. If {@code null} proxy is + * passed in, this method returns true -- since there is NO proxy, we should + * avoid to use it. Simple hostname pattern matching using "*" are supported, + * but only as prefixes. + * + * @param hostname the hostname + * @return true if we have to ignore proxy use (obeying non-proxy hosts + * settings), false otherwise. + * @see Networking + * Properties + */ + public boolean isIgnoredForHost(String hostname) { + requireNonNull(hostname, "hostname"); + if (isNonEmpty(nonProxyHosts)) { + for (String nonProxyHost : nonProxyHosts) { + if (matchNonProxyHost(hostname, nonProxyHost)) { + return true; + } + } + } + + return false; + } + + private static boolean matchNonProxyHost(String targetHost, String nonProxyHost) { + + if (nonProxyHost.length() > 1) { + if (nonProxyHost.charAt(0) == '*') { + return targetHost.regionMatches(true, targetHost.length() - nonProxyHost.length() + 1, nonProxyHost, 1, + nonProxyHost.length() - 1); + } else if (nonProxyHost.charAt(nonProxyHost.length() - 1) == '*') { + return targetHost.regionMatches(true, 0, nonProxyHost, 0, nonProxyHost.length() - 1); + } + } + + return nonProxyHost.equalsIgnoreCase(targetHost); + } + + public static class Builder { + + private final String host; + private final int port; + private int securedPort; + private @Nullable Realm realm; + private @Nullable List nonProxyHosts; + private @Nullable ProxyType proxyType; + private @Nullable Function customHeaders; + + public Builder(String host, int port) { + this.host = host; + this.port = port; + securedPort = port; + } + + public Builder setSecuredPort(int securedPort) { + this.securedPort = securedPort; + return this; + } + + public Builder setRealm(@Nullable Realm realm) { + this.realm = realm; + return this; + } + + public Builder setRealm(Realm.Builder realm) { + this.realm = realm.build(); + return this; + } + + public Builder setNonProxyHost(String nonProxyHost) { + if (nonProxyHosts == null) { + nonProxyHosts = new ArrayList<>(1); + } + nonProxyHosts.add(nonProxyHost); + return this; + } + + public Builder setNonProxyHosts(List nonProxyHosts) { + this.nonProxyHosts = nonProxyHosts; + return this; + } + + public Builder setProxyType(ProxyType proxyType) { + this.proxyType = proxyType; + return this; + } + + public Builder setCustomHeaders(Function customHeaders) { + this.customHeaders = customHeaders; + return this; + } + + public ProxyServer build() { + List nonProxyHosts = this.nonProxyHosts != null ? Collections.unmodifiableList(this.nonProxyHosts) : Collections.emptyList(); + ProxyType proxyType = this.proxyType != null ? this.proxyType : ProxyType.HTTP; + return new ProxyServer(host, port, securedPort, realm, nonProxyHosts, proxyType, customHeaders); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/proxy/ProxyServerSelector.java b/client/src/main/java/org/asynchttpclient/proxy/ProxyServerSelector.java new file mode 100644 index 0000000000..048f2e78ed --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/proxy/ProxyServerSelector.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.proxy; + +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +/** + * Selector for a proxy server + */ +@FunctionalInterface +public interface ProxyServerSelector { + + /** + * A selector that always selects no proxy. + */ + ProxyServerSelector NO_PROXY_SELECTOR = uri -> null; + + /** + * Select a proxy server to use for the given URI. + * + * @param uri The URI to select a proxy server for. + * @return The proxy server to use, if any. May return null. + */ + @Nullable + ProxyServer select(Uri uri); +} diff --git a/client/src/main/java/org/asynchttpclient/proxy/ProxyType.java b/client/src/main/java/org/asynchttpclient/proxy/ProxyType.java new file mode 100644 index 0000000000..d1f74e70d7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/proxy/ProxyType.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.proxy; + +public enum ProxyType { + HTTP(true), SOCKS_V4(false), SOCKS_V5(false); + + private final boolean http; + + ProxyType(boolean http) { + this.http = http; + } + + public boolean isHttp() { + return http; + } + + public boolean isSocks() { + return !isHttp(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/Body.java b/client/src/main/java/org/asynchttpclient/request/body/Body.java new file mode 100644 index 0000000000..6e38107fcd --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/Body.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.netty.buffer.ByteBuf; + +import java.io.Closeable; +import java.io.IOException; + +/** + * A request body. + */ +public interface Body extends Closeable { + + /** + * Gets the length of the body. + * + * @return The length of the body in bytes, or negative if unknown. + */ + long getContentLength(); + + /** + * Reads the next chunk of bytes from the body. + * + * @param target The buffer to store the chunk in, must not be {@code null}. + * @return The state. + * @throws IOException If the chunk could not be read. + */ + BodyState transferTo(ByteBuf target) throws IOException; + + enum BodyState { + + /** + * There's something to read + */ + CONTINUE, + + /** + * There's nothing to read and input has to suspend + */ + SUSPEND, + + /** + * There's nothing to read and input has to stop + */ + STOP + } +} diff --git a/src/main/java/com/ning/http/client/BodyConsumer.java b/client/src/main/java/org/asynchttpclient/request/body/RandomAccessBody.java similarity index 55% rename from src/main/java/com/ning/http/client/BodyConsumer.java rename to client/src/main/java/org/asynchttpclient/request/body/RandomAccessBody.java index b092ec1210..55f76f1718 100644 --- a/src/main/java/com/ning/http/client/BodyConsumer.java +++ b/client/src/main/java/org/asynchttpclient/request/body/RandomAccessBody.java @@ -10,30 +10,22 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ - -package com.ning.http.client; +package org.asynchttpclient.request.body; import java.io.IOException; -import java.nio.ByteBuffer; +import java.nio.channels.WritableByteChannel; /** - * A simple API to be used with the {@link SimpleAsyncHttpClient} class in order to process response's bytes. + * A request body which supports random access to its contents. */ -public interface BodyConsumer { - - /** - * Consume the received bytes. - * - * @param byteBuffer a {@link ByteBuffer} represntation of the response's chunk. - * @throws IOException - */ - void consume(ByteBuffer byteBuffer) throws IOException; +public interface RandomAccessBody extends Body { /** - * Invoked when all the response bytes has been processed. + * Transfers the specified chunk of bytes from this body to the specified channel. * - * @throws IOException + * @param target The destination channel to transfer the body chunk to, must not be {@code null}. + * @return The non-negative number of bytes actually transferred. + * @throws IOException If the body chunk could not be transferred. */ - void close() throws IOException; - + long transferTo(WritableByteChannel target) throws IOException; } diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/BodyChunk.java b/client/src/main/java/org/asynchttpclient/request/body/generator/BodyChunk.java new file mode 100644 index 0000000000..c7af53232e --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/BodyChunk.java @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import io.netty.buffer.ByteBuf; + +public final class BodyChunk { + public final boolean last; + public final ByteBuf buffer; + + BodyChunk(ByteBuf buffer, boolean last) { + this.buffer = buffer; + this.last = last; + } +} diff --git a/src/main/java/com/ning/http/client/BodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/BodyGenerator.java similarity index 82% rename from src/main/java/com/ning/http/client/BodyGenerator.java rename to client/src/main/java/org/asynchttpclient/request/body/generator/BodyGenerator.java index 35fe386282..835ef7bd60 100644 --- a/src/main/java/com/ning/http/client/BodyGenerator.java +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/BodyGenerator.java @@ -10,25 +10,22 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ +package org.asynchttpclient.request.body.generator; -package com.ning.http.client; - -import java.io.IOException; +import org.asynchttpclient.request.body.Body; /** * Creates a request body. */ +@FunctionalInterface public interface BodyGenerator { /** * Creates a new instance of the request body to be read. While each invocation of this method is supposed to create * a fresh instance of the body, the actual contents of all these body instances is the same. For example, the body - * needs to be resend after an authentication challenge of a redirect. + * needs to be resent after an authentication challenge of a redirect. * * @return The request body, never {@code null}. - * @throws IOException If the body could not be created. */ - Body createBody() - throws IOException; - + Body createBody(); } diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/BoundedQueueFeedableBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/BoundedQueueFeedableBodyGenerator.java new file mode 100644 index 0000000000..8604fd39e6 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/BoundedQueueFeedableBodyGenerator.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; + +public final class BoundedQueueFeedableBodyGenerator extends QueueBasedFeedableBodyGenerator> { + + public BoundedQueueFeedableBodyGenerator(int capacity) { + super(new ArrayBlockingQueue<>(capacity, true)); + } + + @Override + protected boolean offer(BodyChunk chunk) throws InterruptedException { + return queue.offer(chunk); + } +} diff --git a/src/main/java/com/ning/http/client/generators/ByteArrayBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGenerator.java similarity index 57% rename from src/main/java/com/ning/http/client/generators/ByteArrayBodyGenerator.java rename to client/src/main/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGenerator.java index 48cc2ae2d2..4cc6b55338 100644 --- a/src/main/java/com/ning/http/client/generators/ByteArrayBodyGenerator.java +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGenerator.java @@ -10,18 +10,15 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.generators; +package org.asynchttpclient.request.body.generator; -import com.ning.http.client.Body; -import com.ning.http.client.BodyGenerator; - -import java.io.IOException; -import java.nio.ByteBuffer; +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.request.body.Body; /** * A {@link BodyGenerator} backed by a byte array. */ -public class ByteArrayBodyGenerator implements BodyGenerator { +public final class ByteArrayBodyGenerator implements BodyGenerator { private final byte[] bytes; @@ -29,41 +26,42 @@ public ByteArrayBodyGenerator(byte[] bytes) { this.bytes = bytes; } + @Override + public Body createBody() { + return new ByteBody(); + } + protected final class ByteBody implements Body { - private boolean eof = false; - private int lastPosition = 0; + private boolean eof; + private int lastPosition; + @Override public long getContentLength() { return bytes.length; } - public long read(ByteBuffer byteBuffer) throws IOException { - + @Override + public BodyState transferTo(ByteBuf target) { if (eof) { - return -1; + return BodyState.STOP; } - if (bytes.length - lastPosition <= byteBuffer.capacity()) { - byteBuffer.put(bytes, lastPosition, bytes.length); + final int remaining = bytes.length - lastPosition; + final int initialTargetWritableBytes = target.writableBytes(); + if (remaining <= initialTargetWritableBytes) { + target.writeBytes(bytes, lastPosition, remaining); eof = true; } else { - byteBuffer.put(bytes, lastPosition, byteBuffer.capacity()); - lastPosition = bytes.length - byteBuffer.capacity(); + target.writeBytes(bytes, lastPosition, initialTargetWritableBytes); + lastPosition += initialTargetWritableBytes; } - return bytes.length; + return BodyState.CONTINUE; } - public void close() throws IOException { + @Override + public void close() { lastPosition = 0; eof = false; } } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Body createBody() throws IOException { - return new ByteBody(); - } } diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/FeedListener.java b/client/src/main/java/org/asynchttpclient/request/body/generator/FeedListener.java new file mode 100644 index 0000000000..ce3e6f79ad --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/FeedListener.java @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +public interface FeedListener { + void onContentAdded(); + + void onError(Throwable t); +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/FeedableBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/FeedableBodyGenerator.java new file mode 100644 index 0000000000..1aa27f0ac8 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/FeedableBodyGenerator.java @@ -0,0 +1,29 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import io.netty.buffer.ByteBuf; + +/** + * {@link BodyGenerator} which may return just part of the payload at the time handler is requesting it. + * If it happens, client becomes responsible for providing the rest of the chunks. + */ +public interface FeedableBodyGenerator extends BodyGenerator { + + boolean feed(ByteBuf buffer, boolean isLast) throws Exception; + + void setListener(FeedListener listener); +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/FileBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/FileBodyGenerator.java new file mode 100644 index 0000000000..82bc02111c --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/FileBodyGenerator.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body.generator; + +import org.asynchttpclient.request.body.RandomAccessBody; + +import java.io.File; + +import static java.util.Objects.requireNonNull; + +/** + * Creates a request body from the contents of a file. + */ +public final class FileBodyGenerator implements BodyGenerator { + + private final File file; + private final long regionSeek; + private final long regionLength; + + public FileBodyGenerator(File file) { + this(file, 0L, file.length()); + } + + public FileBodyGenerator(File file, long regionSeek, long regionLength) { + this.file = requireNonNull(file, "file"); + this.regionLength = regionLength; + this.regionSeek = regionSeek; + } + + public File getFile() { + return file; + } + + public long getRegionLength() { + return regionLength; + } + + public long getRegionSeek() { + return regionSeek; + } + + @Override + public RandomAccessBody createBody() { + throw new UnsupportedOperationException("FileBodyGenerator.createBody isn't used, Netty direclt sends the file"); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/InputStreamBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/InputStreamBodyGenerator.java new file mode 100644 index 0000000000..1f602dae40 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/InputStreamBodyGenerator.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body.generator; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.request.body.Body; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.io.InputStream; + +/** + * A {@link BodyGenerator} which use an {@link InputStream} for reading bytes, without having to read the entire stream in memory. + *
+ * NOTE: The {@link InputStream} must support the {@link InputStream#mark} and {@link InputStream#reset()} operation. If not, mechanisms like authentication, redirect, or + * resumable download will not work. + */ +public final class InputStreamBodyGenerator implements BodyGenerator { + + private static final Logger LOGGER = LoggerFactory.getLogger(InputStreamBody.class); + private final InputStream inputStream; + private final long contentLength; + + public InputStreamBodyGenerator(InputStream inputStream) { + this(inputStream, -1L); + } + + public InputStreamBodyGenerator(InputStream inputStream, long contentLength) { + this.inputStream = inputStream; + this.contentLength = contentLength; + } + + public InputStream getInputStream() { + return inputStream; + } + + public long getContentLength() { + return contentLength; + } + + @Override + public Body createBody() { + return new InputStreamBody(inputStream, contentLength); + } + + private static class InputStreamBody implements Body { + + private final InputStream inputStream; + private final long contentLength; + private byte[] chunk; + + private InputStreamBody(InputStream inputStream, long contentLength) { + this.inputStream = inputStream; + this.contentLength = contentLength; + } + + @Override + public long getContentLength() { + return contentLength; + } + + @Override + public BodyState transferTo(ByteBuf target) { + + // To be safe. + chunk = new byte[target.writableBytes() - 10]; + + int read = -1; + boolean write = false; + try { + read = inputStream.read(chunk); + } catch (IOException ex) { + LOGGER.warn("Unable to read", ex); + } + + if (read > 0) { + target.writeBytes(chunk, 0, read); + write = true; + } + return write ? BodyState.CONTINUE : BodyState.STOP; + } + + @Override + public void close() throws IOException { + inputStream.close(); + } + } +} + diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/PushBody.java b/client/src/main/java/org/asynchttpclient/request/body/generator/PushBody.java new file mode 100644 index 0000000000..72fb653332 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/PushBody.java @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.request.body.Body; + +import java.util.Queue; + +public final class PushBody implements Body { + + private final Queue queue; + private BodyState state = BodyState.CONTINUE; + + public PushBody(Queue queue) { + this.queue = queue; + } + + @Override + public long getContentLength() { + return -1; + } + + @Override + public BodyState transferTo(final ByteBuf target) { + switch (state) { + case CONTINUE: + return readNextChunk(target); + case STOP: + return BodyState.STOP; + default: + throw new IllegalStateException("Illegal process state."); + } + } + + private BodyState readNextChunk(ByteBuf target) { + BodyState res = BodyState.SUSPEND; + while (target.isWritable() && state != BodyState.STOP) { + BodyChunk nextChunk = queue.peek(); + if (nextChunk == null) { + // Nothing in the queue. suspend stream if nothing was read. (reads == 0) + return res; + } else if (!nextChunk.buffer.isReadable() && !nextChunk.last) { + // skip empty buffers + queue.remove(); + } else { + res = BodyState.CONTINUE; + readChunk(target, nextChunk); + } + } + return res; + } + + private void readChunk(ByteBuf target, BodyChunk part) { + target.writeBytes(part.buffer); + if (!part.buffer.isReadable()) { + if (part.last) { + state = BodyState.STOP; + } + queue.remove(); + } + } + + @Override + public void close() { + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/QueueBasedFeedableBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/QueueBasedFeedableBodyGenerator.java new file mode 100644 index 0000000000..9bce479e25 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/QueueBasedFeedableBodyGenerator.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.request.body.Body; + +import java.util.Queue; + +public abstract class QueueBasedFeedableBodyGenerator> implements FeedableBodyGenerator { + + protected final T queue; + private FeedListener listener; + + protected QueueBasedFeedableBodyGenerator(T queue) { + this.queue = queue; + } + + @Override + public Body createBody() { + return new PushBody(queue); + } + + protected abstract boolean offer(BodyChunk chunk) throws Exception; + + @Override + public boolean feed(final ByteBuf buffer, final boolean isLast) throws Exception { + boolean offered = offer(new BodyChunk(buffer, isLast)); + if (offered && listener != null) { + listener.onContentAdded(); + } + return offered; + } + + @Override + public void setListener(FeedListener listener) { + this.listener = listener; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/generator/UnboundedQueueFeedableBodyGenerator.java b/client/src/main/java/org/asynchttpclient/request/body/generator/UnboundedQueueFeedableBodyGenerator.java new file mode 100755 index 0000000000..f55dcbe37a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/generator/UnboundedQueueFeedableBodyGenerator.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import java.util.concurrent.ConcurrentLinkedQueue; + +public final class UnboundedQueueFeedableBodyGenerator extends QueueBasedFeedableBodyGenerator> { + + public UnboundedQueueFeedableBodyGenerator() { + super(new ConcurrentLinkedQueue<>()); + } + + @Override + protected boolean offer(BodyChunk chunk) { + return queue.offer(chunk); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/ByteArrayPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/ByteArrayPart.java new file mode 100644 index 0000000000..203d37a2c5 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/ByteArrayPart.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import java.nio.charset.Charset; + +import static java.util.Objects.requireNonNull; + +public class ByteArrayPart extends FileLikePart { + + private final byte[] bytes; + + public ByteArrayPart(String name, byte[] bytes) { + this(name, bytes, null); + } + + public ByteArrayPart(String name, byte[] bytes, String contentType) { + this(name, bytes, contentType, null); + } + + public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset) { + this(name, bytes, contentType, charset, null); + } + + public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName) { + this(name, bytes, contentType, charset, fileName, null); + } + + public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName, String contentId) { + this(name, bytes, contentType, charset, fileName, contentId, null); + } + + public ByteArrayPart(String name, byte[] bytes, String contentType, Charset charset, String fileName, String contentId, String transferEncoding) { + super(name, contentType, charset, fileName, contentId, transferEncoding); + this.bytes = requireNonNull(bytes, "bytes"); + } + + public byte[] getBytes() { + return bytes; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/FileLikePart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/FileLikePart.java new file mode 100644 index 0000000000..1d03ad22bb --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/FileLikePart.java @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import jakarta.activation.MimetypesFileTypeMap; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.Charset; + +import static org.asynchttpclient.util.MiscUtils.withDefault; + +/** + * This class is an adaptation of the Apache HttpClient implementation + */ +public abstract class FileLikePart extends PartBase { + + private static final MimetypesFileTypeMap MIME_TYPES_FILE_TYPE_MAP; + + static { + try (InputStream is = FileLikePart.class.getResourceAsStream("ahc-mime.types")) { + MIME_TYPES_FILE_TYPE_MAP = new MimetypesFileTypeMap(is); + } catch (IOException e) { + throw new ExceptionInInitializerError(e); + } + } + + /** + * Default content encoding of file attachments. + */ + private final String fileName; + + /** + * FilePart Constructor. + * + * @param name the name for this part + * @param contentType the content type for this part, if {@code null} try to figure out from the fileName mime type + * @param charset the charset encoding for this part + * @param fileName the fileName + * @param contentId the content id + * @param transferEncoding the transfer encoding + */ + protected FileLikePart(String name, String contentType, Charset charset, String fileName, String contentId, String transferEncoding) { + super(name, + computeContentType(contentType, fileName), + charset, + contentId, + transferEncoding); + this.fileName = fileName; + } + + private static String computeContentType(String contentType, String fileName) { + return contentType != null ? contentType : MIME_TYPES_FILE_TYPE_MAP.getContentType(withDefault(fileName, "")); + } + + public String getFileName() { + return fileName; + } + + @Override + public String toString() { + return super.toString() + " filename=" + fileName; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/FilePart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/FilePart.java new file mode 100644 index 0000000000..a156dd077a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/FilePart.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import java.io.File; +import java.nio.charset.Charset; + +public class FilePart extends FileLikePart { + + private final File file; + + public FilePart(String name, File file) { + this(name, file, null); + } + + public FilePart(String name, File file, String contentType) { + this(name, file, contentType, null); + } + + public FilePart(String name, File file, String contentType, Charset charset) { + this(name, file, contentType, charset, null); + } + + public FilePart(String name, File file, String contentType, Charset charset, String fileName) { + this(name, file, contentType, charset, fileName, null); + } + + public FilePart(String name, File file, String contentType, Charset charset, String fileName, String contentId) { + this(name, file, contentType, charset, fileName, contentId, null); + } + + public FilePart(String name, File file, String contentType, Charset charset, String fileName, String contentId, String transferEncoding) { + super(name, contentType, charset, fileName != null ? fileName : file.getName(), contentId, transferEncoding); + if (!file.isFile()) { + throw new IllegalArgumentException("File is not a normal file " + file.getAbsolutePath()); + } + if (!file.canRead()) { + throw new IllegalArgumentException("File is not readable " + file.getAbsolutePath()); + } + this.file = file; + } + + public File getFile() { + return file; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/InputStreamPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/InputStreamPart.java new file mode 100644 index 0000000000..aa14c979ac --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/InputStreamPart.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import java.io.InputStream; +import java.nio.charset.Charset; + +import static java.util.Objects.requireNonNull; + +public class InputStreamPart extends FileLikePart { + + private final InputStream inputStream; + private final long contentLength; + + public InputStreamPart(String name, InputStream inputStream, String fileName) { + this(name, inputStream, fileName, -1); + } + + public InputStreamPart(String name, InputStream inputStream, String fileName, long contentLength) { + this(name, inputStream, fileName, contentLength, null); + } + + public InputStreamPart(String name, InputStream inputStream, String fileName, long contentLength, String contentType) { + this(name, inputStream, fileName, contentLength, contentType, null); + } + + public InputStreamPart(String name, InputStream inputStream, String fileName, long contentLength, String contentType, Charset charset) { + this(name, inputStream, fileName, contentLength, contentType, charset, null); + } + + public InputStreamPart(String name, InputStream inputStream, String fileName, long contentLength, String contentType, Charset charset, String contentId) { + this(name, inputStream, fileName, contentLength, contentType, charset, contentId, null); + } + + public InputStreamPart(String name, InputStream inputStream, String fileName, long contentLength, String contentType, Charset charset, String contentId, + String transferEncoding) { + super(name, contentType, charset, fileName, contentId, transferEncoding); + this.inputStream = requireNonNull(inputStream, "inputStream"); + this.contentLength = contentLength; + } + + public InputStream getInputStream() { + return inputStream; + } + + public long getContentLength() { + return contentLength; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartBody.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartBody.java new file mode 100644 index 0000000000..a1fbb60876 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartBody.java @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.netty.request.body.BodyChunkedInput; +import org.asynchttpclient.request.body.RandomAccessBody; +import org.asynchttpclient.request.body.multipart.part.MultipartPart; +import org.asynchttpclient.request.body.multipart.part.MultipartState; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.nio.channels.WritableByteChannel; +import java.util.List; +import java.util.concurrent.atomic.AtomicBoolean; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +public class MultipartBody implements RandomAccessBody { + + private static final Logger LOGGER = LoggerFactory.getLogger(MultipartBody.class); + + private final List> parts; + private final String contentType; + private final byte[] boundary; + private final long contentLength; + private int currentPartIndex; + private boolean done; + private final AtomicBoolean closed = new AtomicBoolean(); + + public MultipartBody(List> parts, String contentType, byte[] boundary) { + this.boundary = boundary; + this.contentType = contentType; + this.parts = requireNonNull(parts, "parts"); + contentLength = computeContentLength(); + } + + private long computeContentLength() { + try { + long total = 0; + for (MultipartPart part : parts) { + long l = part.length(); + if (l < 0) { + return -1; + } + total += l; + } + return total; + } catch (Exception e) { + LOGGER.error("An exception occurred while getting the length of the parts", e); + return 0L; + } + } + + @Override + public void close() { + if (closed.compareAndSet(false, true)) { + for (MultipartPart part : parts) { + closeSilently(part); + } + } + } + + @Override + public long getContentLength() { + return contentLength; + } + + public String getContentType() { + return contentType; + } + + public byte[] getBoundary() { + return boundary; + } + + // Regular Body API + @Override + public BodyState transferTo(ByteBuf target) throws IOException { + if (done) { + return BodyState.STOP; + } + + while (target.isWritable() && !done) { + MultipartPart currentPart = parts.get(currentPartIndex); + currentPart.transferTo(target); + + if (currentPart.getState() == MultipartState.DONE) { + currentPartIndex++; + if (currentPartIndex == parts.size()) { + done = true; + } + } + } + + return BodyState.CONTINUE; + } + + // RandomAccessBody API, suited for HTTP but not for HTTPS (zero-copy) + @Override + public long transferTo(WritableByteChannel target) throws IOException { + if (done) { + return -1L; + } + + long transferred = 0L; + boolean slowTarget = false; + + while (transferred < BodyChunkedInput.DEFAULT_CHUNK_SIZE && !done && !slowTarget) { + MultipartPart currentPart = parts.get(currentPartIndex); + transferred += currentPart.transferTo(target); + slowTarget = currentPart.isTargetSlow(); + + if (currentPart.getState() == MultipartState.DONE) { + currentPartIndex++; + if (currentPartIndex == parts.size()) { + done = true; + } + } + } + + return transferred; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartUtils.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartUtils.java new file mode 100644 index 0000000000..eb7314f4bc --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/MultipartUtils.java @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.request.body.multipart.part.ByteArrayMultipartPart; +import org.asynchttpclient.request.body.multipart.part.FileMultipartPart; +import org.asynchttpclient.request.body.multipart.part.InputStreamMultipartPart; +import org.asynchttpclient.request.body.multipart.part.MessageEndMultipartPart; +import org.asynchttpclient.request.body.multipart.part.MultipartPart; +import org.asynchttpclient.request.body.multipart.part.StringMultipartPart; + +import java.util.ArrayList; +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static java.nio.charset.StandardCharsets.US_ASCII; +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.HttpUtils.computeMultipartBoundary; +import static org.asynchttpclient.util.HttpUtils.patchContentTypeWithBoundaryAttribute; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public final class MultipartUtils { + + private MultipartUtils() { + // Prevent outside initialization + } + + /** + * Creates a new multipart entity containing the given parts. + * + * @param parts the parts to include. + * @param requestHeaders the request headers + * @return a MultipartBody + */ + public static MultipartBody newMultipartBody(List parts, HttpHeaders requestHeaders) { + requireNonNull(parts, "parts"); + + byte[] boundary; + String contentType; + + String contentTypeHeader = requestHeaders.get(CONTENT_TYPE); + if (isNonEmpty(contentTypeHeader)) { + int boundaryLocation = contentTypeHeader.indexOf("boundary="); + if (boundaryLocation != -1) { + // boundary defined in existing Content-Type + contentType = contentTypeHeader; + boundary = contentTypeHeader.substring(boundaryLocation + "boundary=".length()).trim().getBytes(US_ASCII); + } else { + // generate boundary and append it to existing Content-Type + boundary = computeMultipartBoundary(); + contentType = patchContentTypeWithBoundaryAttribute(contentTypeHeader, boundary); + } + } else { + boundary = computeMultipartBoundary(); + contentType = patchContentTypeWithBoundaryAttribute(HttpHeaderValues.MULTIPART_FORM_DATA.toString(), boundary); + } + + List> multipartParts = generateMultipartParts(parts, boundary); + return new MultipartBody(multipartParts, contentType, boundary); + } + + public static List> generateMultipartParts(List parts, byte[] boundary) { + List> multipartParts = new ArrayList<>(parts.size()); + for (Part part : parts) { + if (part instanceof FilePart) { + multipartParts.add(new FileMultipartPart((FilePart) part, boundary)); + + } else if (part instanceof ByteArrayPart) { + multipartParts.add(new ByteArrayMultipartPart((ByteArrayPart) part, boundary)); + + } else if (part instanceof StringPart) { + multipartParts.add(new StringMultipartPart((StringPart) part, boundary)); + + } else if (part instanceof InputStreamPart) { + multipartParts.add(new InputStreamMultipartPart((InputStreamPart) part, boundary)); + + } else { + throw new IllegalArgumentException("Unknown part type: " + part); + } + } + // add an extra fake part for terminating the message + multipartParts.add(new MessageEndMultipartPart(boundary)); + return multipartParts; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/Part.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/Part.java new file mode 100644 index 0000000000..19266eb25f --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/Part.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import org.asynchttpclient.Param; + +import java.nio.charset.Charset; +import java.util.List; + +public interface Part { + + /** + * Return the name of this part. + * + * @return The name. + */ + String getName(); + + /** + * Returns the content type of this part. + * + * @return the content type, or {@code null} to exclude the content + * type header + */ + String getContentType(); + + /** + * Return the character encoding of this part. + * + * @return the character encoding, or {@code null} to exclude the + * character encoding header + */ + Charset getCharset(); + + /** + * Return the transfer encoding of this part. + * + * @return the transfer encoding, or {@code null} to exclude the + * transfer encoding header + */ + String getTransferEncoding(); + + /** + * Return the content ID of this part. + * + * @return the content ID, or {@code null} to exclude the content ID + * header + */ + String getContentId(); + + /** + * Gets the disposition-type to be used in Content-Disposition header + * + * @return the disposition-type + */ + String getDispositionType(); + + List getCustomHeaders(); +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/PartBase.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/PartBase.java new file mode 100644 index 0000000000..65e78286f0 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/PartBase.java @@ -0,0 +1,138 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import org.asynchttpclient.Param; + +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; + +public abstract class PartBase implements Part { + + /** + * The name of the form field, part of the Content-Disposition header + */ + private final String name; + + /** + * The main part of the Content-Type header + */ + private final String contentType; + + /** + * The charset (part of Content-Type header) + */ + private final Charset charset; + + /** + * The Content-Transfer-Encoding header value. + */ + private final String transferEncoding; + + /** + * The Content-Id + */ + private final String contentId; + + /** + * The disposition type (part of Content-Disposition) + */ + private String dispositionType; + + /** + * Additional part headers + */ + private List customHeaders; + + /** + * Constructor. + * + * @param name The name of the part, or {@code null} + * @param contentType The content type, or {@code null} + * @param charset The character encoding, or {@code null} + * @param contentId The content id, or {@code null} + * @param transferEncoding The transfer encoding, or {@code null} + */ + protected PartBase(String name, String contentType, Charset charset, String contentId, String transferEncoding) { + this.name = name; + this.contentType = contentType; + this.charset = charset; + this.contentId = contentId; + this.transferEncoding = transferEncoding; + } + + @Override + public String getName() { + return name; + } + + @Override + public String getContentType() { + return contentType; + } + + @Override + public Charset getCharset() { + return charset; + } + + @Override + public String getTransferEncoding() { + return transferEncoding; + } + + @Override + public String getContentId() { + return contentId; + } + + @Override + public String getDispositionType() { + return dispositionType; + } + + public void setDispositionType(String dispositionType) { + this.dispositionType = dispositionType; + } + + @Override + public List getCustomHeaders() { + return customHeaders; + } + + public void setCustomHeaders(List customHeaders) { + this.customHeaders = customHeaders; + } + + public void addCustomHeader(String name, String value) { + if (customHeaders == null) { + customHeaders = new ArrayList<>(2); + } + customHeaders.add(new Param(name, value)); + } + + @Override + public String toString() { + return getClass().getSimpleName() + + " name=" + getName() + + " contentType=" + getContentType() + + " charset=" + getCharset() + + " transferEncoding=" + getTransferEncoding() + + " contentId=" + getContentId() + + " dispositionType=" + getDispositionType(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/StringPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/StringPart.java new file mode 100644 index 0000000000..05c958d35d --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/StringPart.java @@ -0,0 +1,71 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import java.nio.charset.Charset; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.MiscUtils.withDefault; + +public class StringPart extends PartBase { + + /** + * Default charset of string parameters + */ + private static final Charset DEFAULT_CHARSET = UTF_8; + + /** + * Contents of this StringPart. + */ + private final String value; + + public StringPart(String name, String value) { + this(name, value, null); + } + + public StringPart(String name, String value, String contentType) { + this(name, value, contentType, null); + } + + public StringPart(String name, String value, String contentType, Charset charset) { + this(name, value, contentType, charset, null); + } + + public StringPart(String name, String value, String contentType, Charset charset, String contentId) { + this(name, value, contentType, charset, contentId, null); + } + + public StringPart(String name, String value, String contentType, Charset charset, String contentId, String transferEncoding) { + super(name, contentType, charsetOrDefault(charset), contentId, transferEncoding); + requireNonNull(value, "value"); + + // See RFC 2048, 2.8. "8bit Data" + if (value.indexOf(0) != -1) { + throw new IllegalArgumentException("NULs may not be present in string parts"); + } + + this.value = value; + } + + private static Charset charsetOrDefault(Charset charset) { + return withDefault(charset, DEFAULT_CHARSET); + } + + public String getValue() { + return value; + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/ByteArrayMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/ByteArrayMultipartPart.java new file mode 100644 index 0000000000..063afcf2a2 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/ByteArrayMultipartPart.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.request.body.multipart.ByteArrayPart; + +import java.io.IOException; +import java.nio.channels.WritableByteChannel; + +public class ByteArrayMultipartPart extends FileLikeMultipartPart { + + private final ByteBuf contentBuffer; + + public ByteArrayMultipartPart(ByteArrayPart part, byte[] boundary) { + super(part, boundary); + contentBuffer = Unpooled.wrappedBuffer(part.getBytes()); + } + + @Override + protected long getContentLength() { + return part.getBytes().length; + } + + @Override + protected long transferContentTo(ByteBuf target) { + return transfer(contentBuffer, target, MultipartState.POST_CONTENT); + } + + @Override + protected long transferContentTo(WritableByteChannel target) throws IOException { + return transfer(contentBuffer, target, MultipartState.POST_CONTENT); + } + + @Override + public void close() { + super.close(); + contentBuffer.release(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileLikeMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileLikeMultipartPart.java new file mode 100644 index 0000000000..659906f26f --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileLikeMultipartPart.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import org.asynchttpclient.request.body.multipart.FileLikePart; + +import static java.nio.charset.StandardCharsets.US_ASCII; +import static java.nio.charset.StandardCharsets.UTF_8; + +public abstract class FileLikeMultipartPart extends MultipartPart { + + /** + * Attachment's file name as a byte array + */ + private static final byte[] FILE_NAME_BYTES = "; filename=".getBytes(US_ASCII); + + FileLikeMultipartPart(T part, byte[] boundary) { + super(part, boundary); + } + + @Override + protected void visitDispositionHeader(PartVisitor visitor) { + super.visitDispositionHeader(visitor); + if (part.getFileName() != null) { + visitor.withBytes(FILE_NAME_BYTES); + visitor.withByte(QUOTE_BYTE); + visitor.withBytes(part.getFileName().getBytes(part.getCharset() != null ? part.getCharset() : UTF_8)); + visitor.withByte(QUOTE_BYTE); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileMultipartPart.java new file mode 100644 index 0000000000..65bdd58ca0 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/FileMultipartPart.java @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.netty.request.body.BodyChunkedInput; +import org.asynchttpclient.request.body.multipart.FilePart; + +import java.io.File; +import java.io.IOException; +import java.io.RandomAccessFile; +import java.nio.channels.FileChannel; +import java.nio.channels.WritableByteChannel; + +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +public class FileMultipartPart extends FileLikeMultipartPart { + + private final long length; + private FileChannel channel; + private long position; + + public FileMultipartPart(FilePart part, byte[] boundary) { + super(part, boundary); + File file = part.getFile(); + if (!file.exists()) { + throw new IllegalArgumentException("File part doesn't exist: " + file.getAbsolutePath()); + } + if (!file.canRead()) { + throw new IllegalArgumentException("File part can't be read: " + file.getAbsolutePath()); + } + length = file.length(); + } + + private FileChannel getChannel() throws IOException { + if (channel == null) { + channel = new RandomAccessFile(part.getFile(), "r").getChannel(); + } + return channel; + } + + @Override + protected long getContentLength() { + return length; + } + + @Override + protected long transferContentTo(ByteBuf target) throws IOException { + // can return -1 if file is empty or FileChannel was closed + int transferred = target.writeBytes(getChannel(), target.writableBytes()); + if (transferred > 0) { + position += transferred; + } + if (position == length || transferred < 0) { + state = MultipartState.POST_CONTENT; + if (channel.isOpen()) { + channel.close(); + } + } + return transferred; + } + + @Override + protected long transferContentTo(WritableByteChannel target) throws IOException { + // WARN: don't use channel.position(), it's always 0 here + // from FileChannel javadoc: "This method does not modify this channel's + // position." + long transferred = getChannel().transferTo(position, BodyChunkedInput.DEFAULT_CHUNK_SIZE, target); + if (transferred > 0) { + position += transferred; + } + if (position == length || transferred < 0) { + state = MultipartState.POST_CONTENT; + if (channel.isOpen()) { + channel.close(); + } + } else { + slowTarget = true; + } + return transferred; + } + + @Override + public void close() { + super.close(); + closeSilently(channel); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/InputStreamMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/InputStreamMultipartPart.java new file mode 100644 index 0000000000..cf1acb0a78 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/InputStreamMultipartPart.java @@ -0,0 +1,106 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import org.asynchttpclient.netty.request.body.BodyChunkedInput; +import org.asynchttpclient.request.body.multipart.InputStreamPart; + +import java.io.IOException; +import java.io.InputStream; +import java.nio.ByteBuffer; +import java.nio.channels.Channels; +import java.nio.channels.ReadableByteChannel; +import java.nio.channels.WritableByteChannel; + +import static org.asynchttpclient.util.MiscUtils.closeSilently; + +public class InputStreamMultipartPart extends FileLikeMultipartPart { + + private long position; + private ByteBuffer buffer; + private ReadableByteChannel channel; + + public InputStreamMultipartPart(InputStreamPart part, byte[] boundary) { + super(part, boundary); + } + + private ByteBuffer getBuffer() { + if (buffer == null) { + buffer = ByteBuffer.allocateDirect(BodyChunkedInput.DEFAULT_CHUNK_SIZE); + } + return buffer; + } + + private ReadableByteChannel getChannel() { + if (channel == null) { + channel = Channels.newChannel(part.getInputStream()); + } + return channel; + } + + @Override + protected long getContentLength() { + return part.getContentLength(); + } + + @Override + protected long transferContentTo(ByteBuf target) throws IOException { + InputStream inputStream = part.getInputStream(); + int transferred = target.writeBytes(inputStream, target.writableBytes()); + if (transferred > 0) { + position += transferred; + } + if (position == getContentLength() || transferred < 0) { + state = MultipartState.POST_CONTENT; + inputStream.close(); + } + return transferred; + } + + @Override + protected long transferContentTo(WritableByteChannel target) throws IOException { + ReadableByteChannel channel = getChannel(); + ByteBuffer buffer = getBuffer(); + + int transferred = 0; + int read = channel.read(buffer); + + if (read > 0) { + buffer.flip(); + while (buffer.hasRemaining()) { + transferred += target.write(buffer); + } + buffer.compact(); + position += transferred; + } + if (position == getContentLength() || read < 0) { + state = MultipartState.POST_CONTENT; + if (channel.isOpen()) { + channel.close(); + } + } + + return transferred; + } + + @Override + public void close() { + super.close(); + closeSilently(part.getInputStream()); + closeSilently(channel); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MessageEndMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MessageEndMultipartPart.java new file mode 100644 index 0000000000..4083f2bdda --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MessageEndMultipartPart.java @@ -0,0 +1,97 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.request.body.multipart.FileLikePart; + +import java.io.IOException; +import java.nio.channels.WritableByteChannel; + +public class MessageEndMultipartPart extends MultipartPart { + + // lazy + private ByteBuf contentBuffer; + + public MessageEndMultipartPart(byte[] boundary) { + super(null, boundary); + state = MultipartState.PRE_CONTENT; + } + + @Override + public long transferTo(ByteBuf target) { + return transfer(lazyLoadContentBuffer(), target, MultipartState.DONE); + } + + @Override + public long transferTo(WritableByteChannel target) throws IOException { + slowTarget = false; + return transfer(lazyLoadContentBuffer(), target, MultipartState.DONE); + } + + private ByteBuf lazyLoadContentBuffer() { + if (contentBuffer == null) { + contentBuffer = ByteBufAllocator.DEFAULT.buffer((int) getContentLength()); + contentBuffer.writeBytes(EXTRA_BYTES).writeBytes(boundary).writeBytes(EXTRA_BYTES).writeBytes(CRLF_BYTES); + } + return contentBuffer; + } + + @Override + protected int computePreContentLength() { + return 0; + } + + @Override + protected ByteBuf computePreContentBytes(int preContentLength) { + return Unpooled.EMPTY_BUFFER; + } + + @Override + protected int computePostContentLength() { + return 0; + } + + @Override + protected ByteBuf computePostContentBytes(int postContentLength) { + return Unpooled.EMPTY_BUFFER; + } + + @Override + protected long getContentLength() { + return EXTRA_BYTES.length + boundary.length + EXTRA_BYTES.length + CRLF_BYTES.length; + } + + @Override + protected long transferContentTo(ByteBuf target) { + throw new UnsupportedOperationException("Not supposed to be called"); + } + + @Override + protected long transferContentTo(WritableByteChannel target) { + throw new UnsupportedOperationException("Not supposed to be called"); + } + + @Override + public void close() { + super.close(); + if (contentBuffer != null) { + contentBuffer.release(); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartPart.java new file mode 100644 index 0000000000..2441980449 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartPart.java @@ -0,0 +1,333 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import org.asynchttpclient.Param; +import org.asynchttpclient.request.body.multipart.PartBase; +import org.asynchttpclient.request.body.multipart.part.PartVisitor.ByteBufVisitor; +import org.asynchttpclient.request.body.multipart.part.PartVisitor.CounterPartVisitor; + +import java.io.Closeable; +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.channels.GatheringByteChannel; +import java.nio.channels.WritableByteChannel; +import java.nio.charset.Charset; + +import static java.nio.charset.StandardCharsets.US_ASCII; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public abstract class MultipartPart implements Closeable { + + /** + * Content disposition as a byte + */ + static final byte QUOTE_BYTE = '\"'; + /** + * Carriage return/linefeed as a byte array + */ + protected static final byte[] CRLF_BYTES = "\r\n".getBytes(US_ASCII); + /** + * Extra characters as a byte array + */ + protected static final byte[] EXTRA_BYTES = "--".getBytes(US_ASCII); + + /** + * Content disposition as a byte array + */ + private static final byte[] CONTENT_DISPOSITION_BYTES = "Content-Disposition: ".getBytes(US_ASCII); + + /** + * form-data as a byte array + */ + private static final byte[] FORM_DATA_DISPOSITION_TYPE_BYTES = "form-data".getBytes(US_ASCII); + + /** + * name as a byte array + */ + private static final byte[] NAME_BYTES = "; name=".getBytes(US_ASCII); + + /** + * Content type header as a byte array + */ + private static final byte[] CONTENT_TYPE_BYTES = "Content-Type: ".getBytes(US_ASCII); + + /** + * Content charset as a byte array + */ + private static final byte[] CHARSET_BYTES = "; charset=".getBytes(US_ASCII); + + /** + * Content type header as a byte array + */ + private static final byte[] CONTENT_TRANSFER_ENCODING_BYTES = "Content-Transfer-Encoding: ".getBytes(US_ASCII); + + /** + * Content type header as a byte array + */ + private static final byte[] HEADER_NAME_VALUE_SEPARATOR_BYTES = ": ".getBytes(US_ASCII); + + /** + * Content type header as a byte array + */ + private static final byte[] CONTENT_ID_BYTES = "Content-ID: ".getBytes(US_ASCII); + + protected final T part; + protected final byte[] boundary; + + private final int preContentLength; + private final int postContentLength; + protected MultipartState state; + boolean slowTarget; + + // lazy + private ByteBuf preContentBuffer; + private ByteBuf postContentBuffer; + + MultipartPart(T part, byte[] boundary) { + this.part = part; + this.boundary = boundary; + preContentLength = computePreContentLength(); + postContentLength = computePostContentLength(); + state = MultipartState.PRE_CONTENT; + } + + public long length() { + long contentLength = getContentLength(); + if (contentLength < 0) { + return contentLength; + } + return preContentLength + postContentLength + getContentLength(); + } + + public MultipartState getState() { + return state; + } + + public boolean isTargetSlow() { + return slowTarget; + } + + public long transferTo(ByteBuf target) throws IOException { + switch (state) { + case DONE: + return 0L; + case PRE_CONTENT: + return transfer(lazyLoadPreContentBuffer(), target, MultipartState.CONTENT); + case CONTENT: + return transferContentTo(target); + case POST_CONTENT: + return transfer(lazyLoadPostContentBuffer(), target, MultipartState.DONE); + default: + throw new IllegalStateException("Unknown state " + state); + } + } + + public long transferTo(WritableByteChannel target) throws IOException { + slowTarget = false; + switch (state) { + case DONE: + return 0L; + case PRE_CONTENT: + return transfer(lazyLoadPreContentBuffer(), target, MultipartState.CONTENT); + case CONTENT: + return transferContentTo(target); + case POST_CONTENT: + return transfer(lazyLoadPostContentBuffer(), target, MultipartState.DONE); + default: + throw new IllegalStateException("Unknown state " + state); + } + } + + private ByteBuf lazyLoadPreContentBuffer() { + if (preContentBuffer == null) { + preContentBuffer = computePreContentBytes(preContentLength); + } + return preContentBuffer; + } + + private ByteBuf lazyLoadPostContentBuffer() { + if (postContentBuffer == null) { + postContentBuffer = computePostContentBytes(postContentLength); + } + return postContentBuffer; + } + + @Override + public void close() { + if (preContentBuffer != null) { + preContentBuffer.release(); + } + if (postContentBuffer != null) { + postContentBuffer.release(); + } + } + + protected abstract long getContentLength(); + + protected abstract long transferContentTo(ByteBuf target) throws IOException; + + protected abstract long transferContentTo(WritableByteChannel target) throws IOException; + + protected long transfer(ByteBuf source, ByteBuf target, MultipartState sourceFullyWrittenState) { + + int sourceRemaining = source.readableBytes(); + int targetRemaining = target.writableBytes(); + + if (sourceRemaining <= targetRemaining) { + target.writeBytes(source); + state = sourceFullyWrittenState; + return sourceRemaining; + } else { + target.writeBytes(source, targetRemaining); + return targetRemaining; + } + } + + protected long transfer(ByteBuf source, WritableByteChannel target, MultipartState sourceFullyWrittenState) throws IOException { + + int transferred = 0; + if (target instanceof GatheringByteChannel) { + transferred = source.readBytes((GatheringByteChannel) target, source.readableBytes()); + } else { + for (ByteBuffer byteBuffer : source.nioBuffers()) { + int len = byteBuffer.remaining(); + int written = target.write(byteBuffer); + transferred += written; + if (written != len) { + // couldn't write full buffer, exit loop + break; + } + } + // assume this is a basic single ByteBuf + source.readerIndex(source.readerIndex() + transferred); + } + + if (source.isReadable()) { + slowTarget = true; + } else { + state = sourceFullyWrittenState; + } + return transferred; + } + + protected int computePreContentLength() { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + visitPreContent(counterVisitor); + return counterVisitor.getCount(); + } + + protected ByteBuf computePreContentBytes(int preContentLength) { + ByteBuf buffer = ByteBufAllocator.DEFAULT.buffer(preContentLength); + ByteBufVisitor bytesVisitor = new ByteBufVisitor(buffer); + visitPreContent(bytesVisitor); + return buffer; + } + + protected int computePostContentLength() { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + visitPostContent(counterVisitor); + return counterVisitor.getCount(); + } + + protected ByteBuf computePostContentBytes(int postContentLength) { + ByteBuf buffer = ByteBufAllocator.DEFAULT.buffer(postContentLength); + ByteBufVisitor bytesVisitor = new ByteBufVisitor(buffer); + visitPostContent(bytesVisitor); + return buffer; + } + + protected void visitStart(PartVisitor visitor) { + visitor.withBytes(EXTRA_BYTES); + visitor.withBytes(boundary); + } + + protected void visitDispositionHeader(PartVisitor visitor) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(CONTENT_DISPOSITION_BYTES); + visitor.withBytes(part.getDispositionType() != null ? part.getDispositionType().getBytes(US_ASCII) : FORM_DATA_DISPOSITION_TYPE_BYTES); + if (part.getName() != null) { + visitor.withBytes(NAME_BYTES); + visitor.withByte(QUOTE_BYTE); + visitor.withBytes(part.getName().getBytes(US_ASCII)); + visitor.withByte(QUOTE_BYTE); + } + } + + protected void visitContentTypeHeader(PartVisitor visitor) { + String contentType = part.getContentType(); + if (contentType != null) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(CONTENT_TYPE_BYTES); + visitor.withBytes(contentType.getBytes(US_ASCII)); + Charset charSet = part.getCharset(); + if (charSet != null) { + visitor.withBytes(CHARSET_BYTES); + visitor.withBytes(part.getCharset().name().getBytes(US_ASCII)); + } + } + } + + protected void visitTransferEncodingHeader(PartVisitor visitor) { + String transferEncoding = part.getTransferEncoding(); + if (transferEncoding != null) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(CONTENT_TRANSFER_ENCODING_BYTES); + visitor.withBytes(transferEncoding.getBytes(US_ASCII)); + } + } + + protected void visitContentIdHeader(PartVisitor visitor) { + String contentId = part.getContentId(); + if (contentId != null) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(CONTENT_ID_BYTES); + visitor.withBytes(contentId.getBytes(US_ASCII)); + } + } + + protected void visitCustomHeaders(PartVisitor visitor) { + if (isNonEmpty(part.getCustomHeaders())) { + for (Param param : part.getCustomHeaders()) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(param.getName().getBytes(US_ASCII)); + visitor.withBytes(HEADER_NAME_VALUE_SEPARATOR_BYTES); + visitor.withBytes(param.getValue().getBytes(US_ASCII)); + } + } + } + + protected void visitEndOfHeaders(PartVisitor visitor) { + visitor.withBytes(CRLF_BYTES); + visitor.withBytes(CRLF_BYTES); + } + + protected void visitPreContent(PartVisitor visitor) { + visitStart(visitor); + visitDispositionHeader(visitor); + visitContentTypeHeader(visitor); + visitTransferEncodingHeader(visitor); + visitContentIdHeader(visitor); + visitCustomHeaders(visitor); + visitEndOfHeaders(visitor); + } + + protected void visitPostContent(PartVisitor visitor) { + visitor.withBytes(CRLF_BYTES); + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartState.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartState.java new file mode 100644 index 0000000000..a4f6c402fd --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/MultipartState.java @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +public enum MultipartState { + PRE_CONTENT, + CONTENT, + POST_CONTENT, + DONE +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/PartVisitor.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/PartVisitor.java new file mode 100644 index 0000000000..8e9029c4fc --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/PartVisitor.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; + +public interface PartVisitor { + + void withBytes(byte[] bytes); + + void withByte(byte b); + + class CounterPartVisitor implements PartVisitor { + + private int count; + + @Override + public void withBytes(byte[] bytes) { + count += bytes.length; + } + + @Override + public void withByte(byte b) { + count++; + } + + public int getCount() { + return count; + } + } + + class ByteBufVisitor implements PartVisitor { + private final ByteBuf target; + + public ByteBufVisitor(ByteBuf target) { + this.target = target; + } + + @Override + public void withBytes(byte[] bytes) { + target.writeBytes(bytes); + } + + @Override + public void withByte(byte b) { + target.writeByte(b); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/request/body/multipart/part/StringMultipartPart.java b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/StringMultipartPart.java new file mode 100644 index 0000000000..e3db5a0954 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/request/body/multipart/part/StringMultipartPart.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.request.body.multipart.StringPart; + +import java.io.IOException; +import java.nio.channels.WritableByteChannel; + +public class StringMultipartPart extends MultipartPart { + + private final ByteBuf contentBuffer; + + public StringMultipartPart(StringPart part, byte[] boundary) { + super(part, boundary); + contentBuffer = Unpooled.wrappedBuffer(part.getValue().getBytes(part.getCharset())); + } + + @Override + protected long getContentLength() { + return contentBuffer.capacity(); + } + + @Override + protected long transferContentTo(ByteBuf target) { + return transfer(contentBuffer, target, MultipartState.POST_CONTENT); + } + + @Override + protected long transferContentTo(WritableByteChannel target) throws IOException { + return transfer(contentBuffer, target, MultipartState.POST_CONTENT); + } + + @Override + public void close() { + super.close(); + contentBuffer.release(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/resolver/RequestHostnameResolver.java b/client/src/main/java/org/asynchttpclient/resolver/RequestHostnameResolver.java new file mode 100644 index 0000000000..b6330cf14a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/resolver/RequestHostnameResolver.java @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.resolver; + +import io.netty.resolver.NameResolver; +import io.netty.util.concurrent.Future; +import io.netty.util.concurrent.ImmediateEventExecutor; +import io.netty.util.concurrent.Promise; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.netty.SimpleFutureListener; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.util.ArrayList; +import java.util.List; + +public enum RequestHostnameResolver { + + INSTANCE; + + private static final Logger LOGGER = LoggerFactory.getLogger(RequestHostnameResolver.class); + + public Future> resolve(NameResolver nameResolver, InetSocketAddress unresolvedAddress, AsyncHandler asyncHandler) { + final String hostname = unresolvedAddress.getHostString(); + final int port = unresolvedAddress.getPort(); + final Promise> promise = ImmediateEventExecutor.INSTANCE.newPromise(); + + try { + asyncHandler.onHostnameResolutionAttempt(hostname); + } catch (Exception e) { + LOGGER.error("onHostnameResolutionAttempt crashed", e); + promise.tryFailure(e); + return promise; + } + + final Future> whenResolved = nameResolver.resolveAll(hostname); + + whenResolved.addListener(new SimpleFutureListener>() { + + @Override + protected void onSuccess(List value) { + ArrayList socketAddresses = new ArrayList<>(value.size()); + for (InetAddress a : value) { + socketAddresses.add(new InetSocketAddress(a, port)); + } + try { + asyncHandler.onHostnameResolutionSuccess(hostname, socketAddresses); + } catch (Exception e) { + LOGGER.error("onHostnameResolutionSuccess crashed", e); + promise.tryFailure(e); + return; + } + promise.trySuccess(socketAddresses); + } + + @Override + protected void onFailure(Throwable t) { + try { + asyncHandler.onHostnameResolutionFailure(hostname, t); + } catch (Exception e) { + LOGGER.error("onHostnameResolutionFailure crashed", e); + promise.tryFailure(e); + return; + } + promise.tryFailure(t); + } + }); + + return promise; + } +} diff --git a/client/src/main/java/org/asynchttpclient/spnego/NamePasswordCallbackHandler.java b/client/src/main/java/org/asynchttpclient/spnego/NamePasswordCallbackHandler.java new file mode 100644 index 0000000000..164ee54711 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/spnego/NamePasswordCallbackHandler.java @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.spnego; + +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.auth.callback.Callback; +import javax.security.auth.callback.CallbackHandler; +import javax.security.auth.callback.NameCallback; +import javax.security.auth.callback.PasswordCallback; +import javax.security.auth.callback.UnsupportedCallbackException; +import java.io.IOException; +import java.lang.reflect.Method; + +public class NamePasswordCallbackHandler implements CallbackHandler { + private final Logger log = LoggerFactory.getLogger(getClass()); + private static final String PASSWORD_CALLBACK_NAME = "setObject"; + private static final Class[] PASSWORD_CALLBACK_TYPES = new Class[]{Object.class, char[].class, String.class}; + + private final String username; + private final @Nullable String password; + private final @Nullable String passwordCallbackName; + + public NamePasswordCallbackHandler(String username, @Nullable String password) { + this(username, password, null); + } + + public NamePasswordCallbackHandler(String username, @Nullable String password, @Nullable String passwordCallbackName) { + this.username = username; + this.password = password; + this.passwordCallbackName = passwordCallbackName; + } + + @Override + public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException { + for (Callback callback : callbacks) { + if (handleCallback(callback)) { + continue; + } else if (callback instanceof NameCallback) { + ((NameCallback) callback).setName(username); + } else if (callback instanceof PasswordCallback) { + PasswordCallback pwCallback = (PasswordCallback) callback; + pwCallback.setPassword(password != null ? password.toCharArray() : null); + } else if (!invokePasswordCallback(callback)) { + String errorMsg = "Unsupported callback type " + callback.getClass().getName(); + log.info(errorMsg); + throw new UnsupportedCallbackException(callback, errorMsg); + } + } + } + + protected boolean handleCallback(Callback callback) { + return false; + } + + /* + * This method is called from the handle(Callback[]) method when the specified callback + * did not match any of the known callback classes. It looks for the callback method + * having the specified method name with one of the supported parameter types. + * If found, it invokes the callback method on the object and returns true. + * If not, it returns false. + */ + private boolean invokePasswordCallback(Callback callback) { + String cbname = passwordCallbackName == null ? PASSWORD_CALLBACK_NAME : passwordCallbackName; + for (Class arg : PASSWORD_CALLBACK_TYPES) { + try { + Method method = callback.getClass().getMethod(cbname, arg); + Object[] args = { + arg == String.class ? password : password != null ? password.toCharArray() : null + }; + method.invoke(callback, args); + return true; + } catch (Exception e) { + // ignore and continue + log.debug(e.toString()); + } + } + return false; + } +} diff --git a/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngine.java b/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngine.java new file mode 100644 index 0000000000..d67d923bb7 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngine.java @@ -0,0 +1,297 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +/* + * ==================================================================== + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.asynchttpclient.spnego; + +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.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.auth.Subject; +import javax.security.auth.callback.CallbackHandler; +import javax.security.auth.login.AppConfigurationEntry; +import javax.security.auth.login.Configuration; +import javax.security.auth.login.LoginContext; +import javax.security.auth.login.LoginException; +import java.io.IOException; +import java.net.InetAddress; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; +import java.util.Base64; +import java.util.HashMap; +import java.util.Map; + +/** + * SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication scheme. + * + * @since 4.1 + */ +public class SpnegoEngine { + + private static final String SPNEGO_OID = "1.3.6.1.5.5.2"; + private static final String KERBEROS_OID = "1.2.840.113554.1.2.2"; + private static final Map instances = new HashMap<>(); + private final Logger log = LoggerFactory.getLogger(getClass()); + private final @Nullable SpnegoTokenGenerator spnegoGenerator; + private final @Nullable String username; + private final @Nullable String password; + private final @Nullable String servicePrincipalName; + private final @Nullable String realmName; + private final boolean useCanonicalHostname; + private final @Nullable String loginContextName; + private final @Nullable Map customLoginConfig; + + public SpnegoEngine(final @Nullable String username, final @Nullable String password, + final @Nullable String servicePrincipalName, final @Nullable String realmName, + final boolean useCanonicalHostname, final @Nullable Map customLoginConfig, + final @Nullable String loginContextName, final @Nullable SpnegoTokenGenerator spnegoGenerator) { + this.username = username; + this.password = password; + this.servicePrincipalName = servicePrincipalName; + this.realmName = realmName; + this.useCanonicalHostname = useCanonicalHostname; + this.customLoginConfig = customLoginConfig; + this.spnegoGenerator = spnegoGenerator; + this.loginContextName = loginContextName; + } + + public SpnegoEngine() { + this(null, null, null, null, true, null, null, null); + } + + public static SpnegoEngine instance(final @Nullable String username, final @Nullable String password, + final @Nullable String servicePrincipalName, final @Nullable String realmName, + final boolean useCanonicalHostname, final @Nullable Map customLoginConfig, + final @Nullable String loginContextName) { + String key = ""; + if (customLoginConfig != null && !customLoginConfig.isEmpty()) { + StringBuilder customLoginConfigKeyValues = new StringBuilder(); + for (Map.Entry entry : customLoginConfig.entrySet()) { + customLoginConfigKeyValues + .append(entry.getKey()) + .append('=') + .append(entry.getValue()); + } + key = customLoginConfigKeyValues.toString(); + } + + if (username != null) { + key += username; + } + + if (loginContextName != null) { + key += loginContextName; + } + + if (!instances.containsKey(key)) { + instances.put(key, new SpnegoEngine(username, + password, + servicePrincipalName, + realmName, + useCanonicalHostname, + customLoginConfig, + loginContextName, + null)); + } + return instances.get(key); + } + + public String generateToken(String host) throws SpnegoEngineException { + GSSContext gssContext = null; + byte[] token = null; // base64 decoded challenge + Oid negotiationOid; + + try { + /* + * Using the SPNEGO OID is the correct method. Kerberos v5 works for IIS but not JBoss. + * Unwrapping the initial token when using SPNEGO OID looks like what is described here... + * + * http://msdn.microsoft.com/en-us/library/ms995330.aspx + * + * Another helpful URL... + * + * http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/tsec_SPNEGO_token.html + * + * Unfortunately SPNEGO is JRE >=1.6. + */ + // Try SPNEGO by default, fall back to Kerberos later if error + negotiationOid = new Oid(SPNEGO_OID); + + String spn = getCompleteServicePrincipalName(host); + try { + GSSManager manager = GSSManager.getInstance(); + GSSName serverName = manager.createName(spn, GSSName.NT_HOSTBASED_SERVICE); + GSSCredential myCred = null; + if (username != null || loginContextName != null || customLoginConfig != null && !customLoginConfig.isEmpty()) { + String contextName = loginContextName; + if (contextName == null) { + contextName = ""; + } + LoginContext loginContext = new LoginContext(contextName, null, getUsernamePasswordHandler(), getLoginConfiguration()); + loginContext.login(); + final Oid negotiationOidFinal = negotiationOid; + final PrivilegedExceptionAction action = () -> + manager.createCredential(null, GSSCredential.INDEFINITE_LIFETIME, negotiationOidFinal, GSSCredential.INITIATE_AND_ACCEPT); + myCred = Subject.doAs(loginContext.getSubject(), action); + } + gssContext = manager.createContext(useCanonicalHostname ? serverName.canonicalize(negotiationOid) : serverName, + negotiationOid, + myCred, + GSSContext.DEFAULT_LIFETIME); + gssContext.requestMutualAuth(true); + gssContext.requestCredDeleg(true); + } catch (GSSException ex) { + log.error("generateToken", ex); + // BAD MECH means we are likely to be using 1.5, fall back to Kerberos MECH. + // Rethrow any other exception. + if (ex.getMajor() == GSSException.BAD_MECH) { + log.debug("GSSException BAD_MECH, retry with Kerberos MECH"); + } else { + throw ex; + } + + } + if (gssContext == null) { + /* Kerberos v5 GSS-API mechanism defined in RFC 1964. */ + log.debug("Using Kerberos MECH {}", KERBEROS_OID); + negotiationOid = new Oid(KERBEROS_OID); + GSSManager manager = GSSManager.getInstance(); + GSSName serverName = manager.createName(spn, GSSName.NT_HOSTBASED_SERVICE); + gssContext = manager.createContext(serverName.canonicalize(negotiationOid), negotiationOid, null, + GSSContext.DEFAULT_LIFETIME); + gssContext.requestMutualAuth(true); + gssContext.requestCredDeleg(true); + } + + // TODO suspicious: this will always be null because no value has been assigned before. Assign directly? + if (token == null) { + token = new byte[0]; + } + + token = gssContext.initSecContext(token, 0, token.length); + if (token == null) { + throw new SpnegoEngineException("GSS security context initialization failed"); + } + + /* + * IIS accepts Kerberos and SPNEGO tokens. Some other servers Jboss, Glassfish? seem to only accept SPNEGO. Below wraps Kerberos into SPNEGO token. + */ + if (spnegoGenerator != null && negotiationOid.toString().equals(KERBEROS_OID)) { + token = spnegoGenerator.generateSpnegoDERObject(token); + } + + gssContext.dispose(); + + String tokenstr = Base64.getEncoder().encodeToString(token); + log.debug("Sending response '{}' back to the server", tokenstr); + + return tokenstr; + } catch (GSSException gsse) { + log.error("generateToken", gsse); + if (gsse.getMajor() == GSSException.DEFECTIVE_CREDENTIAL || gsse.getMajor() == GSSException.CREDENTIALS_EXPIRED) { + throw new SpnegoEngineException(gsse.getMessage(), gsse); + } + if (gsse.getMajor() == GSSException.NO_CRED) { + throw new SpnegoEngineException(gsse.getMessage(), gsse); + } + if (gsse.getMajor() == GSSException.DEFECTIVE_TOKEN || gsse.getMajor() == GSSException.DUPLICATE_TOKEN + || gsse.getMajor() == GSSException.OLD_TOKEN) { + throw new SpnegoEngineException(gsse.getMessage(), gsse); + } + // other error + throw new SpnegoEngineException(gsse.getMessage()); + } catch (IOException | LoginException | PrivilegedActionException ex) { + throw new SpnegoEngineException(ex.getMessage()); + } + } + + String getCompleteServicePrincipalName(String host) { + String name; + if (servicePrincipalName == null) { + if (useCanonicalHostname) { + host = getCanonicalHostname(host); + } + name = "HTTP@" + host; + } else { + name = servicePrincipalName; + if (realmName != null && !name.contains("@")) { + name += '@' + realmName; + } + } + log.debug("Service Principal Name is {}", name); + return name; + } + + private String getCanonicalHostname(String hostname) { + String canonicalHostname = hostname; + try { + InetAddress in = InetAddress.getByName(hostname); + canonicalHostname = in.getCanonicalHostName(); + log.debug("Resolved hostname={} to canonicalHostname={}", hostname, canonicalHostname); + } catch (Exception e) { + log.warn("Unable to resolve canonical hostname", e); + } + return canonicalHostname; + } + + private @Nullable CallbackHandler getUsernamePasswordHandler() { + if (username == null) { + return null; + } + return new NamePasswordCallbackHandler(username, password); + } + + public @Nullable Configuration getLoginConfiguration() { + if (customLoginConfig != null && !customLoginConfig.isEmpty()) { + return new Configuration() { + @Override + public AppConfigurationEntry[] getAppConfigurationEntry(String name) { + return new AppConfigurationEntry[]{ + new AppConfigurationEntry("com.sun.security.auth.module.Krb5LoginModule", + AppConfigurationEntry.LoginModuleControlFlag.REQUIRED, + customLoginConfig)}; + } + }; + } + return null; + } +} diff --git a/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngineException.java b/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngineException.java new file mode 100644 index 0000000000..a28c0996a9 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/spnego/SpnegoEngineException.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.spnego; + +import org.jetbrains.annotations.Nullable; + +/** + * Signals SPNEGO protocol failure. + */ +public class SpnegoEngineException extends Exception { + + private static final long serialVersionUID = -3123799505052881438L; + + public SpnegoEngineException(@Nullable String message) { + super(message); + } + + public SpnegoEngineException(@Nullable String message, Throwable cause) { + super(message, cause); + } +} diff --git a/src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoTokenGenerator.java b/client/src/main/java/org/asynchttpclient/spnego/SpnegoTokenGenerator.java similarity index 97% rename from src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoTokenGenerator.java rename to client/src/main/java/org/asynchttpclient/spnego/SpnegoTokenGenerator.java index 1eca8af21a..fa1acc480b 100644 --- a/src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoTokenGenerator.java +++ b/client/src/main/java/org/asynchttpclient/spnego/SpnegoTokenGenerator.java @@ -35,21 +35,20 @@ * . * */ - -package com.ning.http.client.providers.netty.spnego; +package org.asynchttpclient.spnego; import java.io.IOException; /** * Abstract SPNEGO token generator. Implementations should take an Kerberos ticket and transform * into a SPNEGO token. - *

+ *
* Implementations of this interface are expected to be thread-safe. * * @since 4.1 */ +@FunctionalInterface public interface SpnegoTokenGenerator { byte[] generateSpnegoDERObject(byte[] kerberosTicket) throws IOException; - } diff --git a/client/src/main/java/org/asynchttpclient/uri/Uri.java b/client/src/main/java/org/asynchttpclient/uri/Uri.java new file mode 100644 index 0000000000..e1d53d1cad --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/uri/Uri.java @@ -0,0 +1,286 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.uri; + +import org.asynchttpclient.util.StringBuilderPool; +import org.jetbrains.annotations.Nullable; + +import java.net.URI; +import java.net.URISyntaxException; + +import static org.asynchttpclient.util.Assertions.assertNotEmpty; +import static org.asynchttpclient.util.MiscUtils.isEmpty; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public class Uri { + + public static final String HTTP = "http"; + public static final String HTTPS = "https"; + public static final String WS = "ws"; + public static final String WSS = "wss"; + private final String scheme; + private final @Nullable String userInfo; + private final String host; + private final int port; + private final @Nullable String query; + private final String path; + private final @Nullable String fragment; + private @Nullable String url; + private final boolean secured; + private final boolean webSocket; + + public Uri(String scheme, @Nullable String userInfo, String host, int port, String path, @Nullable String query, @Nullable String fragment) { + this.scheme = assertNotEmpty(scheme, "scheme"); + this.userInfo = userInfo; + this.host = assertNotEmpty(host, "host"); + this.port = port; + this.path = path; + this.query = query; + this.fragment = fragment; + secured = HTTPS.equals(scheme) || WSS.equals(scheme); + webSocket = WS.equals(scheme) || WSS.equalsIgnoreCase(scheme); + } + + public static Uri create(String originalUrl) { + return create(null, originalUrl); + } + + public static Uri create(@Nullable Uri context, final String originalUrl) { + UriParser parser = UriParser.parse(context, originalUrl); + if (isEmpty(parser.scheme)) { + throw new IllegalArgumentException(originalUrl + " could not be parsed into a proper Uri, missing scheme"); + } + if (isEmpty(parser.host)) { + throw new IllegalArgumentException(originalUrl + " could not be parsed into a proper Uri, missing host"); + } + + return new Uri(parser.scheme, parser.userInfo, parser.host, parser.port, parser.path, parser.query, parser.fragment); + } + + public @Nullable String getQuery() { + return query; + } + + public String getPath() { + return path; + } + + public @Nullable String getUserInfo() { + return userInfo; + } + + public int getPort() { + return port; + } + + public String getScheme() { + return scheme; + } + + public String getHost() { + return host; + } + + public @Nullable String getFragment() { + return fragment; + } + + public boolean isSecured() { + return secured; + } + + public boolean isWebSocket() { + return webSocket; + } + + public URI toJavaNetURI() throws URISyntaxException { + return new URI(toUrl()); + } + + public int getExplicitPort() { + return port == -1 ? getSchemeDefaultPort() : port; + } + + public int getSchemeDefaultPort() { + return isSecured() ? 443 : 80; + } + + public String toUrl() { + if (url == null) { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + sb.append(scheme).append("://"); + if (userInfo != null) { + sb.append(userInfo).append('@'); + } + sb.append(host); + if (port != -1) { + sb.append(':').append(port); + } + if (path != null) { + sb.append(path); + } + if (query != null) { + sb.append('?').append(query); + } + url = sb.toString(); + sb.setLength(0); + } + return url; + } + + /** + * @return [scheme]://[hostname](:[port])/path. Port is omitted if it matches the scheme's default one. + */ + public String toBaseUrl() { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + sb.append(scheme).append("://").append(host); + if (port != -1 && port != getSchemeDefaultPort()) { + sb.append(':').append(port); + } + if (isNonEmpty(path)) { + sb.append(path); + } + return sb.toString(); + } + + public String toRelativeUrl() { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + if (isNonEmpty(path)) { + sb.append(path); + } else { + sb.append('/'); + } + if (query != null) { + sb.append('?').append(query); + } + + return sb.toString(); + } + + public String toFullUrl() { + return fragment == null ? toUrl() : toUrl() + '#' + fragment; + } + + public String getBaseUrl() { + return scheme + "://" + host + ':' + getExplicitPort(); + } + + public String getAuthority() { + return host + ':' + getExplicitPort(); + } + + public boolean isSameBase(Uri other) { + return scheme.equals(other.getScheme()) + && host.equals(other.getHost()) + && getExplicitPort() == other.getExplicitPort(); + } + + public String getNonEmptyPath() { + return isNonEmpty(path) ? path : "/"; + } + + @Override + public String toString() { + // for now, but might change + return toUrl(); + } + + public Uri withNewScheme(String newScheme) { + return new Uri(newScheme, userInfo, host, port, path, query, fragment); + } + + public Uri withNewQuery(@Nullable String newQuery) { + return new Uri(scheme, userInfo, host, port, path, newQuery, fragment); + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + (host == null ? 0 : host.hashCode()); + result = prime * result + (path == null ? 0 : path.hashCode()); + result = prime * result + port; + result = prime * result + (query == null ? 0 : query.hashCode()); + result = prime * result + (scheme == null ? 0 : scheme.hashCode()); + result = prime * result + (userInfo == null ? 0 : userInfo.hashCode()); + result = prime * result + (fragment == null ? 0 : fragment.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + Uri other = (Uri) obj; + if (host == null) { + if (other.host != null) { + return false; + } + } else if (!host.equals(other.host)) { + return false; + } + if (path == null) { + if (other.path != null) { + return false; + } + } else if (!path.equals(other.path)) { + return false; + } + if (port != other.port) { + return false; + } + if (query == null) { + if (other.query != null) { + return false; + } + } else if (!query.equals(other.query)) { + return false; + } + if (scheme == null) { + if (other.scheme != null) { + return false; + } + } else if (!scheme.equals(other.scheme)) { + return false; + } + if (userInfo == null) { + if (other.userInfo != null) { + return false; + } + } else if (!userInfo.equals(other.userInfo)) { + return false; + } + if (fragment == null) { + return other.fragment == null; + } else { + return fragment.equals(other.fragment); + } + } + + public static void validateSupportedScheme(Uri uri) { + final String scheme = uri.getScheme(); + if (scheme == null || !scheme.equalsIgnoreCase(HTTP) && !scheme.equalsIgnoreCase(HTTPS) && !scheme.equalsIgnoreCase(WS) && !scheme.equalsIgnoreCase(WSS)) { + throw new IllegalArgumentException("The URI scheme, of the URI " + uri + ", must be equal (ignoring case) to 'http', 'https', 'ws', or 'wss'"); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/uri/UriParser.java b/client/src/main/java/org/asynchttpclient/uri/UriParser.java new file mode 100644 index 0000000000..c65f145dd2 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/uri/UriParser.java @@ -0,0 +1,377 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.uri; + +import org.jetbrains.annotations.Nullable; + +import static java.util.Objects.requireNonNull; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +final class UriParser { + + public @Nullable String scheme; + public @Nullable String host; + public int port = -1; + public @Nullable String query; + public @Nullable String fragment; + private @Nullable String authority; + public String path = ""; + public @Nullable String userInfo; + + private final String originalUrl; + private int start, end, currentIndex; + + private UriParser(final String originalUrl) { + this.originalUrl = originalUrl; + } + + private void trimLeft() { + while (start < end && originalUrl.charAt(start) <= ' ') { + start++; + } + + if (originalUrl.regionMatches(true, start, "url:", 0, 4)) { + start += 4; + } + } + + private void trimRight() { + end = originalUrl.length(); + while (end > 0 && originalUrl.charAt(end - 1) <= ' ') { + end--; + } + } + + private boolean isFragmentOnly() { + return start < originalUrl.length() && originalUrl.charAt(start) == '#'; + } + + private static boolean isValidProtocolChar(char c) { + return Character.isLetterOrDigit(c) && c != '.' && c != '+' && c != '-'; + } + + private static boolean isValidProtocolChars(String protocol) { + for (int i = 1; i < protocol.length(); i++) { + if (!isValidProtocolChar(protocol.charAt(i))) { + return false; + } + } + return true; + } + + private static boolean isValidProtocol(String protocol) { + return protocol.length() > 0 && Character.isLetter(protocol.charAt(0)) && isValidProtocolChars(protocol); + } + + private void computeInitialScheme() { + for (int i = currentIndex; i < end; i++) { + char c = originalUrl.charAt(i); + if (c == ':') { + String s = originalUrl.substring(currentIndex, i); + if (isValidProtocol(s)) { + scheme = s.toLowerCase(); + currentIndex = i + 1; + } + break; + } else if (c == '/') { + break; + } + } + } + + private boolean overrideWithContext(@Nullable Uri context) { + + boolean isRelative = false; + + // use context only if schemes match + if (context != null && (scheme == null || scheme.equalsIgnoreCase(context.getScheme()))) { + + // see RFC2396 5.2.3 + String contextPath = context.getPath(); + if (isNonEmpty(contextPath) && contextPath.charAt(0) == '/') { + scheme = null; + } + + if (scheme == null) { + scheme = context.getScheme(); + userInfo = context.getUserInfo(); + host = context.getHost(); + port = context.getPort(); + path = contextPath; + isRelative = true; + } + } + return isRelative; + } + + private int findWithinCurrentRange(char c) { + int pos = originalUrl.indexOf(c, currentIndex); + return pos > end ? -1 : pos; + } + + private void trimFragment() { + int charpPosition = findWithinCurrentRange('#'); + if (charpPosition >= 0) { + end = charpPosition; + if (charpPosition + 1 < originalUrl.length()) { + fragment = originalUrl.substring(charpPosition + 1); + } + } + } + + // isRelative can be true only when context is not null + @SuppressWarnings("NullAway") + private void inheritContextQuery(@Nullable Uri context, boolean isRelative) { + // see RFC2396 5.2.2: query and fragment inheritance + if (isRelative && currentIndex == end) { + query = context.getQuery(); + fragment = context.getFragment(); + } + } + + private boolean computeQuery() { + if (currentIndex < end) { + int askPosition = findWithinCurrentRange('?'); + if (askPosition != -1) { + query = originalUrl.substring(askPosition + 1, end); + if (end > askPosition) { + end = askPosition; + } + return askPosition == currentIndex; + } + } + return false; + } + + private boolean currentPositionStartsWith4Slashes() { + return originalUrl.regionMatches(currentIndex, "////", 0, 4); + } + + private boolean currentPositionStartsWith2Slashes() { + return originalUrl.regionMatches(currentIndex, "//", 0, 2); + } + + private String computeAuthority() { + int authorityEndPosition = findWithinCurrentRange('/'); + if (authorityEndPosition == -1) { + authorityEndPosition = findWithinCurrentRange('?'); + if (authorityEndPosition == -1) { + authorityEndPosition = end; + } + } + host = authority = originalUrl.substring(currentIndex, authorityEndPosition); + currentIndex = authorityEndPosition; + return authority; + } + + private void computeUserInfo(String nonNullAuthority) { + int atPosition = nonNullAuthority.indexOf('@'); + if (atPosition != -1) { + userInfo = nonNullAuthority.substring(0, atPosition); + host = nonNullAuthority.substring(atPosition + 1); + } else { + userInfo = null; + } + } + + private static boolean isMaybeIPV6(String nonNullHost) { + // If the host is surrounded by [ and ] then it's an IPv6 + // literal address as specified in RFC2732 + return nonNullHost.length() > 0 && nonNullHost.charAt(0) == '['; + } + + private void computeIPV6(String nonNullHost) { + int positionAfterClosingSquareBrace = nonNullHost.indexOf(']') + 1; + if (positionAfterClosingSquareBrace > 1) { + + port = -1; + + if (nonNullHost.length() > positionAfterClosingSquareBrace) { + if (nonNullHost.charAt(positionAfterClosingSquareBrace) == ':') { + // see RFC2396: port can be null + int portPosition = positionAfterClosingSquareBrace + 1; + if (nonNullHost.length() > portPosition) { + port = Integer.parseInt(nonNullHost.substring(portPosition)); + } + } else { + throw new IllegalArgumentException("Invalid authority field: " + authority); + } + } + + host = nonNullHost.substring(0, positionAfterClosingSquareBrace); + + } else { + throw new IllegalArgumentException("Invalid authority field: " + authority); + } + } + + private void computeRegularHostPort(String nonNullHost) { + int colonPosition = nonNullHost.indexOf(':'); + port = -1; + if (colonPosition >= 0) { + // see RFC2396: port can be null + int portPosition = colonPosition + 1; + if (nonNullHost.length() > portPosition) { + port = Integer.parseInt(nonNullHost.substring(portPosition)); + } + host = nonNullHost.substring(0, colonPosition); + } + } + + // /./ + private void removeEmbeddedDot() { + path = path.replace("/./", "/"); + } + + // /../ + private void removeEmbedded2Dots() { + int i = 0; + while ((i = path.indexOf("/../", i)) >= 0) { + if (i > 0) { + end = path.lastIndexOf('/', i - 1); + if (end >= 0 && path.indexOf("/../", end) != 0) { + path = path.substring(0, end) + path.substring(i + 3); + i = 0; + } else if (end == 0) { + break; + } + } else { + i += 3; + } + } + } + + private void removeTailing2Dots() { + while (path.endsWith("/..")) { + end = path.lastIndexOf('/', path.length() - 4); + if (end >= 0) { + path = path.substring(0, end + 1); + } else { + break; + } + } + } + + private void removeStartingDot() { + if (path.startsWith("./") && path.length() > 2) { + path = path.substring(2); + } + } + + private void removeTrailingDot() { + if (path.endsWith("/.")) { + path = path.substring(0, path.length() - 1); + } + } + + private void handleRelativePath() { + int lastSlashPosition = path.lastIndexOf('/'); + String pathEnd = originalUrl.substring(currentIndex, end); + + if (lastSlashPosition == -1) { + path = authority != null ? '/' + pathEnd : pathEnd; + } else { + path = path.substring(0, lastSlashPosition + 1) + pathEnd; + } + } + + private void handlePathDots() { + if (path.indexOf('.') != -1) { + removeEmbeddedDot(); + removeEmbedded2Dots(); + removeTailing2Dots(); + removeStartingDot(); + removeTrailingDot(); + } + } + + private void parseAuthority() { + if (!currentPositionStartsWith4Slashes() && currentPositionStartsWith2Slashes()) { + currentIndex += 2; + + String nonNullAuthority = computeAuthority(); + computeUserInfo(nonNullAuthority); + + if (host != null) { + String nonNullHost = host; + if (isMaybeIPV6(nonNullHost)) { + computeIPV6(nonNullHost); + } else { + computeRegularHostPort(nonNullHost); + } + } + + if (port < -1) { + throw new IllegalArgumentException("Invalid port number :" + port); + } + + // see RFC2396 5.2.4: ignore context path if authority is defined + if (isNonEmpty(authority)) { + path = ""; + } + } + } + + private void computeRegularPath() { + if (originalUrl.charAt(currentIndex) == '/') { + path = originalUrl.substring(currentIndex, end); + } else if (isNonEmpty(path)) { + handleRelativePath(); + } else { + String pathEnd = originalUrl.substring(currentIndex, end); + path = isNonEmpty(pathEnd) && pathEnd.charAt(0) != '/' ? '/' + pathEnd : pathEnd; + } + handlePathDots(); + } + + private void computeQueryOnlyPath() { + int lastSlashPosition = path.lastIndexOf('/'); + path = lastSlashPosition < 0 ? "/" : path.substring(0, lastSlashPosition) + '/'; + } + + private void computePath(boolean queryOnly) { + // Parse the file path if any + if (currentIndex < end) { + computeRegularPath(); + } else if (queryOnly) { + computeQueryOnlyPath(); + } + } + + private void parse(@Nullable Uri context) { + end = originalUrl.length(); + + trimLeft(); + trimRight(); + currentIndex = start; + if (!isFragmentOnly()) { + computeInitialScheme(); + } + boolean isRelative = overrideWithContext(context); + trimFragment(); + inheritContextQuery(context, isRelative); + boolean queryOnly = computeQuery(); + parseAuthority(); + computePath(queryOnly); + } + + public static UriParser parse(@Nullable Uri context, final String originalUrl) { + requireNonNull(originalUrl, "originalUrl"); + final UriParser parser = new UriParser(originalUrl); + parser.parse(context); + return parser; + } +} \ No newline at end of file diff --git a/client/src/main/java/org/asynchttpclient/util/Assertions.java b/client/src/main/java/org/asynchttpclient/util/Assertions.java new file mode 100644 index 0000000000..0b2e38a7c1 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/Assertions.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.Nullable; + +import static java.util.Objects.requireNonNull; + +public final class Assertions { + + private Assertions() { + } + + @Contract(value = "null, _ -> fail", pure = true) + public static String assertNotEmpty(@Nullable String value, String name) { + requireNonNull(value, name); + if (value.length() == 0) { + throw new IllegalArgumentException("empty " + name); + } + return value; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/AuthenticatorUtils.java b/client/src/main/java/org/asynchttpclient/util/AuthenticatorUtils.java new file mode 100644 index 0000000000..4e2c4aed3b --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/AuthenticatorUtils.java @@ -0,0 +1,241 @@ +/* + * Copyright (c) 2010-2013 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.util; + +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.asynchttpclient.ntlm.NtlmEngine; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.spnego.SpnegoEngine; +import org.asynchttpclient.spnego.SpnegoEngineException; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static java.nio.charset.StandardCharsets.ISO_8859_1; +import static org.asynchttpclient.Dsl.realm; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; + +public final class AuthenticatorUtils { + + public static final String NEGOTIATE = "Negotiate"; + + private AuthenticatorUtils() { + // Prevent outside initialization + } + + public static @Nullable String getHeaderWithPrefix(@Nullable List authenticateHeaders, String prefix) { + if (authenticateHeaders != null) { + for (String authenticateHeader : authenticateHeaders) { + if (authenticateHeader.regionMatches(true, 0, prefix, 0, prefix.length())) { + return authenticateHeader; + } + } + } + + return null; + } + + private static @Nullable String computeBasicAuthentication(@Nullable Realm realm) { + return realm != null ? computeBasicAuthentication(realm.getPrincipal(), realm.getPassword(), realm.getCharset()) : null; + } + + private static String computeBasicAuthentication(@Nullable String principal, @Nullable String password, Charset charset) { + String s = principal + ':' + password; + return "Basic " + Base64.getEncoder().encodeToString(s.getBytes(charset)); + } + + public static String computeRealmURI(Uri uri, boolean useAbsoluteURI, boolean omitQuery) { + if (useAbsoluteURI) { + return omitQuery && isNonEmpty(uri.getQuery()) ? uri.withNewQuery(null).toUrl() : uri.toUrl(); + } else { + String path = uri.getNonEmptyPath(); + return omitQuery || !isNonEmpty(uri.getQuery()) ? path : path + '?' + uri.getQuery(); + } + } + + private static String computeDigestAuthentication(Realm realm, Uri uri) { + + String realmUri = computeRealmURI(uri, realm.isUseAbsoluteURI(), realm.isOmitQuery()); + + StringBuilder builder = new StringBuilder().append("Digest "); + append(builder, "username", realm.getPrincipal(), true); + append(builder, "realm", realm.getRealmName(), true); + append(builder, "nonce", realm.getNonce(), true); + append(builder, "uri", realmUri, true); + if (isNonEmpty(realm.getAlgorithm())) { + append(builder, "algorithm", realm.getAlgorithm(), false); + } + + append(builder, "response", realm.getResponse(), true); + + if (realm.getOpaque() != null) { + append(builder, "opaque", realm.getOpaque(), true); + } + + if (realm.getQop() != null) { + append(builder, "qop", realm.getQop(), false); + // nc and cnonce only sent if server sent qop + append(builder, "nc", realm.getNc(), false); + append(builder, "cnonce", realm.getCnonce(), true); + } + builder.setLength(builder.length() - 2); // remove tailing ", " + + // FIXME isn't there a more efficient way? + return new String(StringUtils.charSequence2Bytes(builder, ISO_8859_1), StandardCharsets.UTF_8); + } + + private static void append(StringBuilder builder, String name, @Nullable String value, boolean quoted) { + builder.append(name).append('='); + if (quoted) { + builder.append('"').append(value).append('"'); + } else { + builder.append(value); + } + builder.append(", "); + } + + public static @Nullable String perConnectionProxyAuthorizationHeader(Request request, @Nullable Realm proxyRealm) { + String proxyAuthorization = null; + if (proxyRealm != null && proxyRealm.isUsePreemptiveAuth()) { + switch (proxyRealm.getScheme()) { + case NTLM: + case KERBEROS: + case SPNEGO: + List auth = request.getHeaders().getAll(PROXY_AUTHORIZATION); + if (getHeaderWithPrefix(auth, "NTLM") == null) { + String msg = NtlmEngine.INSTANCE.generateType1Msg(); + proxyAuthorization = "NTLM " + msg; + } + + break; + default: + } + } + + return proxyAuthorization; + } + + public static @Nullable String perRequestProxyAuthorizationHeader(Request request, @Nullable Realm proxyRealm) { + String proxyAuthorization = null; + if (proxyRealm != null && proxyRealm.isUsePreemptiveAuth()) { + + switch (proxyRealm.getScheme()) { + case BASIC: + proxyAuthorization = computeBasicAuthentication(proxyRealm); + break; + case DIGEST: + if (isNonEmpty(proxyRealm.getNonce())) { + // update realm with request information + final Uri uri = request.getUri(); + proxyRealm = realm(proxyRealm) + .setUri(uri) + .setMethodName(request.getMethod()) + .build(); + proxyAuthorization = computeDigestAuthentication(proxyRealm, uri); + } + break; + case NTLM: + case KERBEROS: + case SPNEGO: + // NTLM, KERBEROS and SPNEGO are only set on the first request with a connection, + // see perConnectionProxyAuthorizationHeader + break; + default: + throw new IllegalStateException("Invalid Authentication scheme " + proxyRealm.getScheme()); + } + } + + return proxyAuthorization; + } + + public static @Nullable String perConnectionAuthorizationHeader(Request request, @Nullable ProxyServer proxyServer, + @Nullable Realm realm) { + String authorizationHeader = null; + + if (realm != null && realm.isUsePreemptiveAuth()) { + switch (realm.getScheme()) { + case NTLM: + String msg = NtlmEngine.INSTANCE.generateType1Msg(); + authorizationHeader = "NTLM " + msg; + break; + case KERBEROS: + case SPNEGO: + String host; + if (proxyServer != null) { + host = proxyServer.getHost(); + } else if (request.getVirtualHost() != null) { + host = request.getVirtualHost(); + } else { + host = request.getUri().getHost(); + } + + try { + authorizationHeader = NEGOTIATE + ' ' + SpnegoEngine.instance( + realm.getPrincipal(), + realm.getPassword(), + realm.getServicePrincipalName(), + realm.getRealmName(), + realm.isUseCanonicalHostname(), + realm.getCustomLoginConfig(), + realm.getLoginContextName()).generateToken(host); + } catch (SpnegoEngineException e) { + throw new RuntimeException(e); + } + break; + default: + break; + } + } + + return authorizationHeader; + } + + public static @Nullable String perRequestAuthorizationHeader(Request request, @Nullable Realm realm) { + String authorizationHeader = null; + if (realm != null && realm.isUsePreemptiveAuth()) { + + switch (realm.getScheme()) { + case BASIC: + authorizationHeader = computeBasicAuthentication(realm); + break; + case DIGEST: + if (isNonEmpty(realm.getNonce())) { + // update realm with request information + final Uri uri = request.getUri(); + realm = realm(realm) + .setUri(uri) + .setMethodName(request.getMethod()) + .build(); + authorizationHeader = computeDigestAuthentication(realm, uri); + } + break; + case NTLM: + case KERBEROS: + case SPNEGO: + // NTLM, KERBEROS and SPNEGO are only set on the first request with a connection, + // see perConnectionAuthorizationHeader + break; + default: + throw new IllegalStateException("Invalid Authentication " + realm); + } + } + + return authorizationHeader; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/Counted.java b/client/src/main/java/org/asynchttpclient/util/Counted.java new file mode 100644 index 0000000000..f861d01d16 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/Counted.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import org.asynchttpclient.AsyncHttpClient; + +/** + * An interface that defines useful methods to check how many {@linkplain AsyncHttpClient} + * instances this particular implementation is shared with. + */ +public interface Counted { + + /** + * Increment counter and return the incremented value + */ + int incrementAndGet(); + + /** + * Decrement counter and return the decremented value + */ + int decrementAndGet(); + + /** + * Return the current counter + */ + int count(); +} diff --git a/client/src/main/java/org/asynchttpclient/util/DateUtils.java b/client/src/main/java/org/asynchttpclient/util/DateUtils.java new file mode 100644 index 0000000000..39199dea69 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/DateUtils.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +public final class DateUtils { + + private DateUtils() { + // Prevent outside initialization + } + + public static long unpreciseMillisTime() { + return System.currentTimeMillis(); + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/EnsuresNonNull.java b/client/src/main/java/org/asynchttpclient/util/EnsuresNonNull.java new file mode 100644 index 0000000000..64ccee659e --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/EnsuresNonNull.java @@ -0,0 +1,17 @@ +package org.asynchttpclient.util; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * NullAway supports @EnsuresNonNull(param) annotation, but org.jetbrains.annotations doesn't include this annotation. + * The purpose of this annotation is to tell NullAway that if the annotated method succeeded without any exceptions, + * all class's fields defined in "param" will be @NotNull. + */ +@Retention(RetentionPolicy.CLASS) +@Target(ElementType.METHOD) +public @interface EnsuresNonNull { + String[] value(); +} diff --git a/client/src/main/java/org/asynchttpclient/util/HttpConstants.java b/client/src/main/java/org/asynchttpclient/util/HttpConstants.java new file mode 100644 index 0000000000..4a1a128650 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/HttpConstants.java @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.HttpResponseStatus; + +public final class HttpConstants { + + private HttpConstants() { + // Prevent outside initialization + } + + public static final class Methods { + public static final String CONNECT = HttpMethod.CONNECT.name(); + public static final String DELETE = HttpMethod.DELETE.name(); + public static final String GET = HttpMethod.GET.name(); + public static final String HEAD = HttpMethod.HEAD.name(); + public static final String OPTIONS = HttpMethod.OPTIONS.name(); + public static final String PATCH = HttpMethod.PATCH.name(); + public static final String POST = HttpMethod.POST.name(); + public static final String PUT = HttpMethod.PUT.name(); + public static final String TRACE = HttpMethod.TRACE.name(); + + private Methods() { + // Prevent outside initialization + } + } + + public static final class ResponseStatusCodes { + public static final int CONTINUE_100 = HttpResponseStatus.CONTINUE.code(); + public static final int SWITCHING_PROTOCOLS_101 = HttpResponseStatus.SWITCHING_PROTOCOLS.code(); + public static final int OK_200 = HttpResponseStatus.OK.code(); + public static final int MOVED_PERMANENTLY_301 = HttpResponseStatus.MOVED_PERMANENTLY.code(); + public static final int FOUND_302 = HttpResponseStatus.FOUND.code(); + public static final int SEE_OTHER_303 = HttpResponseStatus.SEE_OTHER.code(); + public static final int TEMPORARY_REDIRECT_307 = HttpResponseStatus.TEMPORARY_REDIRECT.code(); + public static final int PERMANENT_REDIRECT_308 = HttpResponseStatus.PERMANENT_REDIRECT.code(); + public static final int UNAUTHORIZED_401 = HttpResponseStatus.UNAUTHORIZED.code(); + public static final int PROXY_AUTHENTICATION_REQUIRED_407 = HttpResponseStatus.PROXY_AUTHENTICATION_REQUIRED.code(); + + private ResponseStatusCodes() { + // Prevent outside initialization + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/HttpUtils.java b/client/src/main/java/org/asynchttpclient/util/HttpUtils.java new file mode 100644 index 0000000000..3cca41e616 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/HttpUtils.java @@ -0,0 +1,185 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.util; + +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.util.AsciiString; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Param; +import org.asynchttpclient.Request; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.net.URLEncoder; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.util.List; +import java.util.concurrent.ThreadLocalRandom; + +import static java.nio.charset.StandardCharsets.US_ASCII; +import static java.nio.charset.StandardCharsets.UTF_8; + +/** + * {@link AsyncHttpClient} common utilities. + */ +public final class HttpUtils { + + public static final AsciiString ACCEPT_ALL_HEADER_VALUE = new AsciiString("*/*"); + public static final AsciiString GZIP_DEFLATE = new AsciiString(HttpHeaderValues.GZIP + "," + HttpHeaderValues.DEFLATE); + private static final String CONTENT_TYPE_CHARSET_ATTRIBUTE = "charset="; + private static final String CONTENT_TYPE_BOUNDARY_ATTRIBUTE = "boundary="; + private static final String BROTLY_ACCEPT_ENCODING_SUFFIX = ", br"; + private static final String ZSTD_ACCEPT_ENCODING_SUFFIX = ", zstd"; + + private HttpUtils() { + // Prevent outside initialization + } + + public static String hostHeader(Uri uri) { + String host = uri.getHost(); + int port = uri.getPort(); + return port == -1 || port == uri.getSchemeDefaultPort() ? host : host + ':' + port; + } + + public static String originHeader(Uri uri) { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + sb.append(uri.isSecured() ? "https://" : "http://").append(uri.getHost()); + if (uri.getExplicitPort() != uri.getSchemeDefaultPort()) { + sb.append(':').append(uri.getPort()); + } + return sb.toString(); + } + + public static @Nullable Charset extractContentTypeCharsetAttribute(String contentType) { + String charsetName = extractContentTypeAttribute(contentType, CONTENT_TYPE_CHARSET_ATTRIBUTE); + return charsetName != null ? Charset.forName(charsetName) : null; + } + + public static @Nullable String extractContentTypeBoundaryAttribute(String contentType) { + return extractContentTypeAttribute(contentType, CONTENT_TYPE_BOUNDARY_ATTRIBUTE); + } + + private static @Nullable String extractContentTypeAttribute(@Nullable String contentType, String attribute) { + if (contentType == null) { + return null; + } + + for (int i = 0; i < contentType.length(); i++) { + if (contentType.regionMatches(true, i, attribute, 0, + attribute.length())) { + int start = i + attribute.length(); + + // trim left + while (start < contentType.length()) { + char c = contentType.charAt(start); + if (c == ' ' || c == '\'' || c == '"') { + start++; + } else { + break; + } + } + if (start == contentType.length()) { + break; + } + + // trim right + int end = start + 1; + while (end < contentType.length()) { + char c = contentType.charAt(end); + if (c == ' ' || c == '\'' || c == '"' || c == ';') { + break; + } else { + end++; + } + } + + return contentType.substring(start, end); + } + } + + return null; + } + + // The pool of ASCII chars to be used for generating a multipart boundary. + private static final byte[] MULTIPART_CHARS = "-_1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".getBytes(US_ASCII); + + // a random size from 30 to 40 + public static byte[] computeMultipartBoundary() { + ThreadLocalRandom random = ThreadLocalRandom.current(); + byte[] bytes = new byte[random.nextInt(11) + 30]; + for (int i = 0; i < bytes.length; i++) { + bytes[i] = MULTIPART_CHARS[random.nextInt(MULTIPART_CHARS.length)]; + } + return bytes; + } + + public static String patchContentTypeWithBoundaryAttribute(String base, byte[] boundary) { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder().append(base); + if (!base.isEmpty() && base.charAt(base.length() - 1) != ';') { + sb.append(';'); + } + return sb.append(' ').append(CONTENT_TYPE_BOUNDARY_ATTRIBUTE).append(new String(boundary, US_ASCII)).toString(); + } + + public static boolean followRedirect(AsyncHttpClientConfig config, Request request) { + return request.getFollowRedirect() != null ? request.getFollowRedirect() : config.isFollowRedirect(); + } + + public static ByteBuffer urlEncodeFormParams(List params, Charset charset) { + return StringUtils.charSequence2ByteBuffer(urlEncodeFormParams0(params, charset), US_ASCII); + } + + private static StringBuilder urlEncodeFormParams0(List params, Charset charset) { + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + for (Param param : params) { + encodeAndAppendFormParam(sb, param.getName(), param.getValue(), charset); + } + sb.setLength(sb.length() - 1); + return sb; + } + + private static void encodeAndAppendFormParam(StringBuilder sb, String name, @Nullable String value, Charset charset) { + encodeAndAppendFormField(sb, name, charset); + if (value != null) { + sb.append('='); + encodeAndAppendFormField(sb, value, charset); + } + sb.append('&'); + } + + private static void encodeAndAppendFormField(StringBuilder sb, String field, Charset charset) { + if (charset.equals(UTF_8)) { + Utf8UrlEncoder.encodeAndAppendFormElement(sb, field); + } else { + // TODO there's probably room for perf improvements + sb.append(URLEncoder.encode(field, charset)); + } + } + + public static CharSequence filterOutBrotliFromAcceptEncoding(String acceptEncoding) { + // we don't support Brotly ATM + if (acceptEncoding.endsWith(BROTLY_ACCEPT_ENCODING_SUFFIX)) { + return acceptEncoding.subSequence(0, acceptEncoding.length() - BROTLY_ACCEPT_ENCODING_SUFFIX.length()); + } + return acceptEncoding; + } + + public static CharSequence filterOutZstdFromAcceptEncoding(String acceptEncoding) { + // we don't support zstd ATM + if (acceptEncoding.endsWith(ZSTD_ACCEPT_ENCODING_SUFFIX)) { + return acceptEncoding.subSequence(0, acceptEncoding.length() - ZSTD_ACCEPT_ENCODING_SUFFIX.length()); + } + return acceptEncoding; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/MessageDigestUtils.java b/client/src/main/java/org/asynchttpclient/util/MessageDigestUtils.java new file mode 100644 index 0000000000..c60e242380 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/MessageDigestUtils.java @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +public final class MessageDigestUtils { + + private static final ThreadLocal MD5_MESSAGE_DIGESTS = ThreadLocal.withInitial(() -> { + try { + return MessageDigest.getInstance("MD5"); + } catch (NoSuchAlgorithmException e) { + throw new InternalError("MD5 not supported on this platform"); + } + }); + + private static final ThreadLocal SHA1_MESSAGE_DIGESTS = ThreadLocal.withInitial(() -> { + try { + return MessageDigest.getInstance("SHA1"); + } catch (NoSuchAlgorithmException e) { + throw new InternalError("SHA1 not supported on this platform"); + } + }); + + private MessageDigestUtils() { + // Prevent outside initialization + } + + public static MessageDigest pooledMd5MessageDigest() { + MessageDigest md = MD5_MESSAGE_DIGESTS.get(); + md.reset(); + return md; + } + + public static MessageDigest pooledSha1MessageDigest() { + MessageDigest md = SHA1_MESSAGE_DIGESTS.get(); + md.reset(); + return md; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/MiscUtils.java b/client/src/main/java/org/asynchttpclient/util/MiscUtils.java new file mode 100644 index 0000000000..5a37cce759 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/MiscUtils.java @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.util; + +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.Nullable; + +import java.io.Closeable; +import java.io.IOException; +import java.util.Collection; +import java.util.Map; + +public final class MiscUtils { + + private MiscUtils() { + // Prevent outside initialization + } + + // NullAway is not powerful enough to recognise that if the values has passed the check, it's not null + @Contract(value = "null -> false", pure = true) + public static boolean isNonEmpty(@Nullable String string) { + return !isEmpty(string); + } + + @Contract(value = "null -> true", pure = true) + public static boolean isEmpty(@Nullable String string) { + return string == null || string.isEmpty(); + } + + @Contract(value = "null -> false", pure = true) + public static boolean isNonEmpty(@Nullable Object[] array) { + return array != null && array.length != 0; + } + + @Contract(value = "null -> false", pure = true) + public static boolean isNonEmpty(byte @Nullable [] array) { + return array != null && array.length != 0; + } + + @Contract("null -> false") + public static boolean isNonEmpty(@Nullable Collection collection) { + return collection != null && !collection.isEmpty(); + } + + @Contract("null -> false") + public static boolean isNonEmpty(@Nullable Map map) { + return map != null && !map.isEmpty(); + } + + public static T withDefault(@Nullable T value, T def) { + return value == null ? def : value; + } + + public static void closeSilently(@Nullable Closeable closeable) { + if (closeable != null) { + try { + closeable.close(); + } catch (IOException e) { + // + } + } + } + + public static Throwable getCause(Throwable t) { + Throwable cause = t.getCause(); + return cause != null ? getCause(cause) : t; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/ProxyUtils.java b/client/src/main/java/org/asynchttpclient/util/ProxyUtils.java new file mode 100644 index 0000000000..a7bf5b7e20 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/ProxyUtils.java @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.util; + +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Request; +import org.asynchttpclient.proxy.ProxyServer; +import org.asynchttpclient.proxy.ProxyServerSelector; +import org.jetbrains.annotations.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.net.InetSocketAddress; +import java.net.Proxy; +import java.net.ProxySelector; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Properties; + +import static org.asynchttpclient.Dsl.basicAuthRealm; +import static org.asynchttpclient.Dsl.proxyServer; + +/** + * Utilities for Proxy handling. + * + * @author cstamas + */ +public final class ProxyUtils { + + /** + * The host to use as proxy. + * + * @see Networking Properties + */ + public static final String PROXY_HOST = "http.proxyHost"; + /** + * The port to use for the proxy. + * + * @see Networking Properties + */ + public static final String PROXY_PORT = "http.proxyPort"; + /** + * A specification of non-proxy hosts. + * + * @see Networking Properties + */ + public static final String PROXY_NONPROXYHOSTS = "http.nonProxyHosts"; + private static final Logger logger = LoggerFactory.getLogger(ProxyUtils.class); + private static final String PROPERTY_PREFIX = "org.asynchttpclient.AsyncHttpClientConfig.proxy."; + + /** + * The username to use for authentication for the proxy server. + */ + private static final String PROXY_USER = PROPERTY_PREFIX + "user"; + + /** + * The password to use for authentication for the proxy server. + */ + private static final String PROXY_PASSWORD = PROPERTY_PREFIX + "password"; + + private ProxyUtils() { + // Prevent outside initialization + } + + /** + * @param config the global config + * @param request the request + * @return the proxy server to be used for this request (can be null) + */ + public static @Nullable ProxyServer getProxyServer(AsyncHttpClientConfig config, Request request) { + ProxyServer proxyServer = request.getProxyServer(); + if (proxyServer == null) { + ProxyServerSelector selector = config.getProxyServerSelector(); + if (selector != null) { + proxyServer = selector.select(request.getUri()); + } + } + return proxyServer != null && !proxyServer.isIgnoredForHost(request.getUri().getHost()) ? proxyServer : null; + } + + /** + * Creates a proxy server instance from the given properties. + * Currently, the default http.* proxy properties are supported as well as properties specific for AHC. + * + * @param properties the properties to evaluate. Must not be null. + * @return a ProxyServer instance or null, if no valid properties were set. + * @see Networking Properties + * @see #PROXY_HOST + * @see #PROXY_PORT + * @see #PROXY_NONPROXYHOSTS + */ + public static ProxyServerSelector createProxyServerSelector(Properties properties) { + String host = properties.getProperty(PROXY_HOST); + + if (host != null) { + int port = Integer.valueOf(properties.getProperty(PROXY_PORT, "80")); + + String principal = properties.getProperty(PROXY_USER); + String password = properties.getProperty(PROXY_PASSWORD); + + Realm realm = null; + if (principal != null) { + realm = basicAuthRealm(principal, password).build(); + } + + ProxyServer.Builder proxyServer = proxyServer(host, port).setRealm(realm); + + String nonProxyHosts = properties.getProperty(PROXY_NONPROXYHOSTS); + if (nonProxyHosts != null) { + proxyServer.setNonProxyHosts(new ArrayList<>(Arrays.asList(nonProxyHosts.split("\\|")))); + } + + ProxyServer proxy = proxyServer.build(); + return uri -> proxy; + } + + return ProxyServerSelector.NO_PROXY_SELECTOR; + } + + /** + * Get a proxy server selector based on the JDK default proxy selector. + * + * @return The proxy server selector. + */ + public static ProxyServerSelector getJdkDefaultProxyServerSelector() { + return createProxyServerSelector(ProxySelector.getDefault()); + } + + /** + * Create a proxy server selector based on the passed in JDK proxy selector. + * + * @param proxySelector The proxy selector to use. Must not be null. + * @return The proxy server selector. + */ + private static ProxyServerSelector createProxyServerSelector(final ProxySelector proxySelector) { + return uri -> { + try { + URI javaUri = uri.toJavaNetURI(); + + List proxies = proxySelector.select(javaUri); + if (proxies != null) { + // Loop through them until we find one that we know how to use + for (Proxy proxy : proxies) { + switch (proxy.type()) { + case HTTP: + if (!(proxy.address() instanceof InetSocketAddress)) { + logger.warn("Don't know how to connect to address " + proxy.address()); + return null; + } else { + InetSocketAddress address = (InetSocketAddress) proxy.address(); + return proxyServer(address.getHostString(), address.getPort()).build(); + } + case DIRECT: + return null; + default: + logger.warn("ProxySelector returned proxy type that we don't know how to use: " + proxy.type()); + break; + } + } + } + return null; + } catch (URISyntaxException e) { + logger.warn(uri + " couldn't be turned into a java.net.URI", e); + return null; + } + }; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/StringBuilderPool.java b/client/src/main/java/org/asynchttpclient/util/StringBuilderPool.java new file mode 100644 index 0000000000..ae4f9c6766 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/StringBuilderPool.java @@ -0,0 +1,34 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +public class StringBuilderPool { + + public static final StringBuilderPool DEFAULT = new StringBuilderPool(); + + private final ThreadLocal pool = ThreadLocal.withInitial(() -> new StringBuilder(512)); + + /** + * BEWARE: MUSTN'T APPEND TO ITSELF! + * + * @return a pooled StringBuilder + */ + public StringBuilder stringBuilder() { + StringBuilder sb = pool.get(); + sb.setLength(0); + return sb; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/StringUtils.java b/client/src/main/java/org/asynchttpclient/util/StringUtils.java new file mode 100644 index 0000000000..0abf0b686d --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/StringUtils.java @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import java.nio.ByteBuffer; +import java.nio.CharBuffer; +import java.nio.charset.Charset; + +public final class StringUtils { + + private StringUtils() { + // Prevent outside initialization + } + + public static ByteBuffer charSequence2ByteBuffer(CharSequence cs, Charset charset) { + return charset.encode(CharBuffer.wrap(cs)); + } + + public static byte[] byteBuffer2ByteArray(ByteBuffer bb) { + byte[] rawBase = new byte[bb.remaining()]; + bb.get(rawBase); + return rawBase; + } + + public static byte[] charSequence2Bytes(CharSequence sb, Charset charset) { + ByteBuffer bb = charSequence2ByteBuffer(sb, charset); + return byteBuffer2ByteArray(bb); + } + + public static String toHexString(byte[] data) { + StringBuilder buffer = StringBuilderPool.DEFAULT.stringBuilder(); + for (byte aData : data) { + buffer.append(Integer.toHexString((aData & 0xf0) >>> 4)); + buffer.append(Integer.toHexString(aData & 0x0f)); + } + return buffer.toString(); + } + + public static void appendBase16(StringBuilder buf, byte[] bytes) { + int base = 16; + for (byte b : bytes) { + int bi = 0xff & b; + int c = '0' + bi / base % base; + if (c > '9') { + c = 'a' + c - '0' - 10; + } + buf.append((char) c); + c = '0' + bi % base; + if (c > '9') { + c = 'a' + c - '0' - 10; + } + buf.append((char) c); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/ThrowableUtil.java b/client/src/main/java/org/asynchttpclient/util/ThrowableUtil.java new file mode 100644 index 0000000000..7ca4ebbfaa --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/ThrowableUtil.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +public final class ThrowableUtil { + + private ThrowableUtil() { + // Prevent outside initialization + } + + /** + * @param the Throwable type + * @param t the throwable whose stacktrace we want to remove + * @param clazz the caller class + * @param method the caller method + * @return the input throwable with removed stacktrace + */ + public static T unknownStackTrace(T t, Class clazz, String method) { + t.setStackTrace(new StackTraceElement[]{new StackTraceElement(clazz.getName(), method, null, -1)}); + return t; + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/UriEncoder.java b/client/src/main/java/org/asynchttpclient/util/UriEncoder.java new file mode 100644 index 0000000000..92706d2926 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/UriEncoder.java @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import org.asynchttpclient.Param; +import org.asynchttpclient.uri.Uri; +import org.jetbrains.annotations.Nullable; + +import java.util.List; + +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.asynchttpclient.util.Utf8UrlEncoder.encodeAndAppendQuery; + +public enum UriEncoder { + + FIXING { + @Override + public String encodePath(String path) { + return Utf8UrlEncoder.encodePath(path); + } + + private void encodeAndAppendQueryParam(final StringBuilder sb, final CharSequence name, final @Nullable CharSequence value) { + Utf8UrlEncoder.encodeAndAppendQueryElement(sb, name); + if (value != null) { + sb.append('='); + Utf8UrlEncoder.encodeAndAppendQueryElement(sb, value); + } + sb.append('&'); + } + + private void encodeAndAppendQueryParams(final StringBuilder sb, final List queryParams) { + for (Param param : queryParams) { + encodeAndAppendQueryParam(sb, param.getName(), param.getValue()); + } + } + + @Override + protected String withQueryWithParams(final String query, final List queryParams) { + // concatenate encoded query + encoded query params + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + encodeAndAppendQuery(sb, query); + sb.append('&'); + encodeAndAppendQueryParams(sb, queryParams); + sb.setLength(sb.length() - 1); + return sb.toString(); + } + + @Override + protected String withQueryWithoutParams(final String query) { + // encode query + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + encodeAndAppendQuery(sb, query); + return sb.toString(); + } + + @Override + protected String withoutQueryWithParams(final List queryParams) { + // concatenate encoded query params + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + encodeAndAppendQueryParams(sb, queryParams); + sb.setLength(sb.length() - 1); + return sb.toString(); + } + }, + + RAW { + @Override + public String encodePath(String path) { + return path; + } + + private void appendRawQueryParam(StringBuilder sb, String name, @Nullable String value) { + sb.append(name); + if (value != null) { + sb.append('=').append(value); + } + sb.append('&'); + } + + private void appendRawQueryParams(final StringBuilder sb, final List queryParams) { + for (Param param : queryParams) { + appendRawQueryParam(sb, param.getName(), param.getValue()); + } + } + + @Override + protected String withQueryWithParams(final String query, final List queryParams) { + // concatenate raw query + raw query params + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + sb.append(query); + appendRawQueryParams(sb, queryParams); + sb.setLength(sb.length() - 1); + return sb.toString(); + } + + @Override + protected String withQueryWithoutParams(final String query) { + // return raw query as is + return query; + } + + @Override + protected String withoutQueryWithParams(final List queryParams) { + // concatenate raw queryParams + StringBuilder sb = StringBuilderPool.DEFAULT.stringBuilder(); + appendRawQueryParams(sb, queryParams); + sb.setLength(sb.length() - 1); + return sb.toString(); + } + }; + + public static UriEncoder uriEncoder(boolean disableUrlEncoding) { + return disableUrlEncoding ? RAW : FIXING; + } + + protected abstract String withQueryWithParams(String query, List queryParams); + + protected abstract String withQueryWithoutParams(String query); + + protected abstract String withoutQueryWithParams(List queryParams); + + private String withQuery(final String query, final @Nullable List queryParams) { + return isNonEmpty(queryParams) ? withQueryWithParams(query, queryParams) : withQueryWithoutParams(query); + } + + private @Nullable String withoutQuery(final @Nullable List queryParams) { + return isNonEmpty(queryParams) ? withoutQueryWithParams(queryParams) : null; + } + + public Uri encode(Uri uri, @Nullable List queryParams) { + String newPath = encodePath(uri.getPath()); + String newQuery = encodeQuery(uri.getQuery(), queryParams); + return new Uri(uri.getScheme(), + uri.getUserInfo(), + uri.getHost(), + uri.getPort(), + newPath, + newQuery, + uri.getFragment()); + } + + protected abstract String encodePath(String path); + + private @Nullable String encodeQuery(final @Nullable String query, final @Nullable List queryParams) { + return isNonEmpty(query) ? withQuery(query, queryParams) : withoutQuery(queryParams); + } +} diff --git a/client/src/main/java/org/asynchttpclient/util/Utf8UrlEncoder.java b/client/src/main/java/org/asynchttpclient/util/Utf8UrlEncoder.java new file mode 100644 index 0000000000..fe01e32087 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/util/Utf8UrlEncoder.java @@ -0,0 +1,241 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.Nullable; + +import java.util.BitSet; + +public final class Utf8UrlEncoder { + + // see http://tools.ietf.org/html/rfc3986#section-3.4 + // ALPHA / DIGIT / "-" / "." / "_" / "~" + private static final BitSet RFC3986_UNRESERVED_CHARS = new BitSet(); + // gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" + private static final BitSet RFC3986_GENDELIM_CHARS = new BitSet(); + // "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" + private static final BitSet RFC3986_SUBDELIM_CHARS = new BitSet(); + // gen-delims / sub-delims + private static final BitSet RFC3986_RESERVED_CHARS = new BitSet(); + // unreserved / pct-encoded / sub-delims / ":" / "@" + private static final BitSet RFC3986_PCHARS = new BitSet(); + private static final BitSet BUILT_PATH_UNTOUCHED_CHARS = new BitSet(); + private static final BitSet BUILT_QUERY_UNTOUCHED_CHARS = new BitSet(); + // http://www.w3.org/TR/html5/forms.html#application/x-www-form-urlencoded-encoding-algorithm + private static final BitSet FORM_URL_ENCODED_SAFE_CHARS = new BitSet(); + private static final char[] HEX = "0123456789ABCDEF".toCharArray(); + + static { + for (int i = 'a'; i <= 'z'; ++i) { + RFC3986_UNRESERVED_CHARS.set(i); + } + for (int i = 'A'; i <= 'Z'; ++i) { + RFC3986_UNRESERVED_CHARS.set(i); + } + for (int i = '0'; i <= '9'; ++i) { + RFC3986_UNRESERVED_CHARS.set(i); + } + RFC3986_UNRESERVED_CHARS.set('-'); + RFC3986_UNRESERVED_CHARS.set('.'); + RFC3986_UNRESERVED_CHARS.set('_'); + RFC3986_UNRESERVED_CHARS.set('~'); + } + + static { + RFC3986_GENDELIM_CHARS.set(':'); + RFC3986_GENDELIM_CHARS.set('/'); + RFC3986_GENDELIM_CHARS.set('?'); + RFC3986_GENDELIM_CHARS.set('#'); + RFC3986_GENDELIM_CHARS.set('['); + RFC3986_GENDELIM_CHARS.set(']'); + RFC3986_GENDELIM_CHARS.set('@'); + } + + static { + RFC3986_SUBDELIM_CHARS.set('!'); + RFC3986_SUBDELIM_CHARS.set('$'); + RFC3986_SUBDELIM_CHARS.set('&'); + RFC3986_SUBDELIM_CHARS.set('\''); + RFC3986_SUBDELIM_CHARS.set('('); + RFC3986_SUBDELIM_CHARS.set(')'); + RFC3986_SUBDELIM_CHARS.set('*'); + RFC3986_SUBDELIM_CHARS.set('+'); + RFC3986_SUBDELIM_CHARS.set(','); + RFC3986_SUBDELIM_CHARS.set(';'); + RFC3986_SUBDELIM_CHARS.set('='); + } + + static { + RFC3986_RESERVED_CHARS.or(RFC3986_GENDELIM_CHARS); + RFC3986_RESERVED_CHARS.or(RFC3986_SUBDELIM_CHARS); + } + + static { + RFC3986_PCHARS.or(RFC3986_UNRESERVED_CHARS); + RFC3986_PCHARS.or(RFC3986_SUBDELIM_CHARS); + RFC3986_PCHARS.set(':'); + RFC3986_PCHARS.set('@'); + } + + static { + BUILT_PATH_UNTOUCHED_CHARS.or(RFC3986_PCHARS); + BUILT_PATH_UNTOUCHED_CHARS.set('%'); + BUILT_PATH_UNTOUCHED_CHARS.set('/'); + } + + static { + BUILT_QUERY_UNTOUCHED_CHARS.or(RFC3986_PCHARS); + BUILT_QUERY_UNTOUCHED_CHARS.set('%'); + BUILT_QUERY_UNTOUCHED_CHARS.set('/'); + BUILT_QUERY_UNTOUCHED_CHARS.set('?'); + } + + static { + for (int i = 'a'; i <= 'z'; ++i) { + FORM_URL_ENCODED_SAFE_CHARS.set(i); + } + for (int i = 'A'; i <= 'Z'; ++i) { + FORM_URL_ENCODED_SAFE_CHARS.set(i); + } + for (int i = '0'; i <= '9'; ++i) { + FORM_URL_ENCODED_SAFE_CHARS.set(i); + } + + FORM_URL_ENCODED_SAFE_CHARS.set('-'); + FORM_URL_ENCODED_SAFE_CHARS.set('.'); + FORM_URL_ENCODED_SAFE_CHARS.set('_'); + FORM_URL_ENCODED_SAFE_CHARS.set('*'); + } + + private Utf8UrlEncoder() { + } + + public static String encodePath(String input) { + StringBuilder sb = lazyAppendEncoded(null, input, BUILT_PATH_UNTOUCHED_CHARS, false); + return sb == null ? input : sb.toString(); + } + + public static StringBuilder encodeAndAppendQuery(StringBuilder sb, String query) { + return appendEncoded(sb, query, BUILT_QUERY_UNTOUCHED_CHARS, false); + } + + public static String encodeQueryElement(String input) { + StringBuilder sb = new StringBuilder(input.length() + 6); + encodeAndAppendQueryElement(sb, input); + return sb.toString(); + } + + public static StringBuilder encodeAndAppendQueryElement(StringBuilder sb, CharSequence input) { + return appendEncoded(sb, input, FORM_URL_ENCODED_SAFE_CHARS, false); + } + + public static StringBuilder encodeAndAppendFormElement(StringBuilder sb, CharSequence input) { + return appendEncoded(sb, input, FORM_URL_ENCODED_SAFE_CHARS, true); + } + + @Contract("!null -> !null") + public static @Nullable String percentEncodeQueryElement(@Nullable String input) { + if (input == null) { + return null; + } + StringBuilder sb = new StringBuilder(input.length() + 6); + encodeAndAppendPercentEncoded(sb, input); + return sb.toString(); + } + + public static StringBuilder encodeAndAppendPercentEncoded(StringBuilder sb, CharSequence input) { + return appendEncoded(sb, input, RFC3986_UNRESERVED_CHARS, false); + } + + private static StringBuilder lazyInitStringBuilder(CharSequence input, int firstNonUsAsciiPosition) { + StringBuilder sb = new StringBuilder(input.length() + 6); + for (int i = 0; i < firstNonUsAsciiPosition; i++) { + sb.append(input.charAt(i)); + } + return sb; + } + + private static @Nullable StringBuilder lazyAppendEncoded(@Nullable StringBuilder sb, CharSequence input, BitSet dontNeedEncoding, boolean encodeSpaceAsPlus) { + int c; + for (int i = 0; i < input.length(); i += Character.charCount(c)) { + c = Character.codePointAt(input, i); + if (c <= 127) { + if (dontNeedEncoding.get(c)) { + if (sb != null) { + sb.append((char) c); + } + } else { + if (sb == null) { + sb = lazyInitStringBuilder(input, i); + } + appendSingleByteEncoded(sb, c, encodeSpaceAsPlus); + } + } else { + if (sb == null) { + sb = lazyInitStringBuilder(input, i); + } + appendMultiByteEncoded(sb, c); + } + } + return sb; + } + + private static StringBuilder appendEncoded(StringBuilder sb, CharSequence input, BitSet dontNeedEncoding, boolean encodeSpaceAsPlus) { + int c; + for (int i = 0; i < input.length(); i += Character.charCount(c)) { + c = Character.codePointAt(input, i); + if (c <= 127) { + if (dontNeedEncoding.get(c)) { + sb.append((char) c); + } else { + appendSingleByteEncoded(sb, c, encodeSpaceAsPlus); + } + } else { + appendMultiByteEncoded(sb, c); + } + } + return sb; + } + + private static void appendSingleByteEncoded(StringBuilder sb, int value, boolean encodeSpaceAsPlus) { + + if (value == ' ' && encodeSpaceAsPlus) { + sb.append('+'); + return; + } + + sb.append('%'); + sb.append(HEX[value >> 4]); + sb.append(HEX[value & 0xF]); + } + + private static void appendMultiByteEncoded(StringBuilder sb, int value) { + if (value < 0x800) { + appendSingleByteEncoded(sb, 0xc0 | value >> 6, false); + appendSingleByteEncoded(sb, 0x80 | value & 0x3f, false); + } else if (value < 0x10000) { + appendSingleByteEncoded(sb, 0xe0 | value >> 12, false); + appendSingleByteEncoded(sb, 0x80 | value >> 6 & 0x3f, false); + appendSingleByteEncoded(sb, 0x80 | value & 0x3f, false); + } else { + appendSingleByteEncoded(sb, 0xf0 | value >> 18, false); + appendSingleByteEncoded(sb, 0x80 | value >> 12 & 0x3f, false); + appendSingleByteEncoded(sb, 0x80 | value >> 6 & 0x3f, false); + appendSingleByteEncoded(sb, 0x80 | value & 0x3f, false); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/ws/WebSocket.java b/client/src/main/java/org/asynchttpclient/ws/WebSocket.java new file mode 100644 index 0000000000..0362ba4551 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ws/WebSocket.java @@ -0,0 +1,216 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import io.netty.buffer.ByteBuf; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.util.concurrent.Future; + +import java.net.SocketAddress; + +/** + * A WebSocket client + */ +public interface WebSocket { + + /** + * @return the headers received in the Upgrade response + */ + HttpHeaders getUpgradeHeaders(); + + /** + * Get remote address client initiated request to. + * + * @return remote address client initiated request to, may be {@code null} if asynchronous provider is unable to provide the remote address + */ + SocketAddress getRemoteAddress(); + + /** + * Get local address client initiated request from. + * + * @return local address client initiated request from, may be {@code null} if asynchronous provider is unable to provide the local address + */ + SocketAddress getLocalAddress(); + + /** + * Send a full text frame + * + * @param payload a text payload + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendTextFrame(String payload); + + /** + * Allows sending a text frame with fragmentation or extension bits. When using fragmentation, the next fragments must be sent with sendContinuationFrame. + * + * @param payload a text fragment. + * @param finalFragment flag indicating whether this is the final fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendTextFrame(String payload, boolean finalFragment, int rsv); + + /** + * Allows sending a text frame with fragmentation or extension bits. When using fragmentation, the next fragments must be sent with sendContinuationFrame. + * + * @param payload a ByteBuf fragment. + * @param finalFragment flag indicating whether this is the final fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendTextFrame(ByteBuf payload, boolean finalFragment, int rsv); + + /** + * Send a full binary frame. + * + * @param payload a binary payload + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendBinaryFrame(byte[] payload); + + /** + * Allows sending a binary frame with fragmentation or extension bits. When using fragmentation, the next fragments must be sent with sendContinuationFrame. + * + * @param payload a binary payload + * @param finalFragment flag indicating whether this is the last fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendBinaryFrame(byte[] payload, boolean finalFragment, int rsv); + + /** + * Allows sending a binary frame with fragmentation or extension bits. When using fragmentation, the next fragments must be sent with sendContinuationFrame. + * + * @param payload a ByteBuf payload + * @param finalFragment flag indicating whether this is the last fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendBinaryFrame(ByteBuf payload, boolean finalFragment, int rsv); + + /** + * Send a text continuation frame. The last fragment must have finalFragment set to true. + * + * @param payload the text fragment + * @param finalFragment flag indicating whether this is the last fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendContinuationFrame(String payload, boolean finalFragment, int rsv); + + /** + * Send a binary continuation frame. The last fragment must have finalFragment set to true. + * + * @param payload the binary fragment + * @param finalFragment flag indicating whether this is the last fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendContinuationFrame(byte[] payload, boolean finalFragment, int rsv); + + /** + * Send a continuation frame (those are actually untyped as counterpart must have memorized first fragmented frame type). The last fragment must have finalFragment set to true. + * + * @param payload a ByteBuf fragment + * @param finalFragment flag indicating whether this is the last fragment + * @param rsv extension bits, 0 otherwise + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendContinuationFrame(ByteBuf payload, boolean finalFragment, int rsv); + + /** + * Send an empty ping frame + * + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPingFrame(); + + /** + * Send a ping frame with a byte array payload (limited to 125 bytes or fewer). + * + * @param payload the payload. + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPingFrame(byte[] payload); + + /** + * Send a ping frame with a ByteBuf payload (limited to 125 bytes or fewer). + * + * @param payload the payload. + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPingFrame(ByteBuf payload); + + /** + * Send an empty pong frame + * + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPongFrame(); + + /** + * Send a pong frame with a byte array payload (limited to 125 bytes or fewer). + * + * @param payload the payload. + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPongFrame(byte[] payload); + + /** + * Send a pong frame with a ByteBuf payload (limited to 125 bytes or fewer). + * + * @param payload the payload. + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendPongFrame(ByteBuf payload); + + /** + * Send an empty close frame. + * + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendCloseFrame(); + + /** + * Send an empty close frame. + * + * @param statusCode a status code + * @param reasonText a reason + * @return a future that will be completed once the frame will be actually written on the wire + */ + Future sendCloseFrame(int statusCode, String reasonText); + + /** + * @return {@code true} if the WebSocket is open/connected. + */ + boolean isOpen(); + + /** + * Add a {@link WebSocketListener} + * + * @param l a {@link WebSocketListener} + * @return this + */ + WebSocket addWebSocketListener(WebSocketListener l); + + /** + * Remove a {@link WebSocketListener} + * + * @param l a {@link WebSocketListener} + * @return this + */ + WebSocket removeWebSocketListener(WebSocketListener l); +} diff --git a/client/src/main/java/org/asynchttpclient/ws/WebSocketListener.java b/client/src/main/java/org/asynchttpclient/ws/WebSocketListener.java new file mode 100644 index 0000000000..7d92a66199 --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ws/WebSocketListener.java @@ -0,0 +1,79 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +/** + * A generic {@link WebSocketListener} for WebSocket events. Use the appropriate listener for receiving message bytes. + */ +public interface WebSocketListener { + + /** + * Invoked when the {@link WebSocket} is open. + * + * @param websocket the WebSocket + */ + void onOpen(WebSocket websocket); + + /** + * Invoked when the {@link WebSocket} is closed. + * + * @param websocket the WebSocket + * @param code the status code + * @param reason the reason message + * @see "http://tools.ietf.org/html/rfc6455#section-5.5.1" + */ + void onClose(WebSocket websocket, int code, String reason); + + /** + * Invoked when the {@link WebSocket} crashes. + * + * @param t a {@link Throwable} + */ + void onError(Throwable t); + + /** + * Invoked when a binary frame is received. + * + * @param payload a byte array + * @param finalFragment true if this frame is the final fragment + * @param rsv extension bits + */ + default void onBinaryFrame(byte[] payload, boolean finalFragment, int rsv) { + } + + /** + * Invoked when a text frame is received. + * + * @param payload a UTF-8 {@link String} message + * @param finalFragment true if this frame is the final fragment + * @param rsv extension bits + */ + default void onTextFrame(String payload, boolean finalFragment, int rsv) { + } + + /** + * Invoked when a ping frame is received + * + * @param payload a byte array + */ + default void onPingFrame(byte[] payload) { + } + + /** + * Invoked when a pong frame is received + * + * @param payload a byte array + */ + default void onPongFrame(byte[] payload) { + } +} diff --git a/client/src/main/java/org/asynchttpclient/ws/WebSocketUpgradeHandler.java b/client/src/main/java/org/asynchttpclient/ws/WebSocketUpgradeHandler.java new file mode 100644 index 0000000000..b4c6e1a44a --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ws/WebSocketUpgradeHandler.java @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.netty.ws.NettyWebSocket; +import org.jetbrains.annotations.Nullable; + +import java.util.ArrayList; +import java.util.List; + +import static org.asynchttpclient.util.HttpConstants.ResponseStatusCodes.SWITCHING_PROTOCOLS_101; + +/** + * An {@link AsyncHandler} which is able to execute WebSocket upgrade. Use the Builder for configuring WebSocket options. + */ +public class WebSocketUpgradeHandler implements AsyncHandler { + + private final List listeners; + private @Nullable NettyWebSocket webSocket; + + public WebSocketUpgradeHandler(List listeners) { + this.listeners = listeners; + } + + protected void setWebSocket0(NettyWebSocket webSocket) { + } + + protected void onStatusReceived0(HttpResponseStatus responseStatus) throws Exception { + } + + protected void onHeadersReceived0(HttpHeaders headers) throws Exception { + } + + protected void onBodyPartReceived0(HttpResponseBodyPart bodyPart) throws Exception { + } + + protected void onCompleted0() throws Exception { + } + + protected void onThrowable0(Throwable t) { + } + + protected void onOpen0() { + } + + @Override + public final State onStatusReceived(HttpResponseStatus responseStatus) throws Exception { + onStatusReceived0(responseStatus); + return responseStatus.getStatusCode() == SWITCHING_PROTOCOLS_101 ? State.CONTINUE : State.ABORT; + } + + @Override + public final State onHeadersReceived(HttpHeaders headers) throws Exception { + onHeadersReceived0(headers); + return State.CONTINUE; + } + + @Override + public final State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { + onBodyPartReceived0(bodyPart); + return State.CONTINUE; + } + + @Override + public final @Nullable NettyWebSocket onCompleted() throws Exception { + onCompleted0(); + return webSocket; + } + + @Override + public final void onThrowable(Throwable t) { + onThrowable0(t); + for (WebSocketListener listener : listeners) { + if (webSocket != null) { + webSocket.addWebSocketListener(listener); + } + listener.onError(t); + } + } + + public final void setWebSocket(NettyWebSocket webSocket) { + this.webSocket = webSocket; + setWebSocket0(webSocket); + } + + /** + * @param webSocket this parameter is the same object as the field webSocket, + * but guaranteed to be not null. This is done to satisfy NullAway requirements + */ + public final void onOpen(NettyWebSocket webSocket) { + onOpen0(); + for (WebSocketListener listener : listeners) { + webSocket.addWebSocketListener(listener); + listener.onOpen(webSocket); + } + webSocket.processBufferedFrames(); + } + + /** + * Build a {@link WebSocketUpgradeHandler} + */ + public static final class Builder { + + private final List listeners = new ArrayList<>(1); + + /** + * Add a {@link WebSocketListener} that will be added to the {@link WebSocket} + * + * @param listener a {@link WebSocketListener} + * @return this + */ + public Builder addWebSocketListener(WebSocketListener listener) { + listeners.add(listener); + return this; + } + + /** + * Remove a {@link WebSocketListener} + * + * @param listener a {@link WebSocketListener} + * @return this + */ + public Builder removeWebSocketListener(WebSocketListener listener) { + listeners.remove(listener); + return this; + } + + /** + * Build a {@link WebSocketUpgradeHandler} + * + * @return a {@link WebSocketUpgradeHandler} + */ + public WebSocketUpgradeHandler build() { + return new WebSocketUpgradeHandler(listeners); + } + } +} diff --git a/client/src/main/java/org/asynchttpclient/ws/WebSocketUtils.java b/client/src/main/java/org/asynchttpclient/ws/WebSocketUtils.java new file mode 100644 index 0000000000..628cc1d7df --- /dev/null +++ b/client/src/main/java/org/asynchttpclient/ws/WebSocketUtils.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import io.netty.util.internal.ThreadLocalRandom; + +import java.util.Base64; + +import static java.nio.charset.StandardCharsets.US_ASCII; +import static org.asynchttpclient.util.MessageDigestUtils.pooledSha1MessageDigest; + +public final class WebSocketUtils { + private static final String MAGIC_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; + + private WebSocketUtils() { + // Prevent outside initialization + } + + public static String getWebSocketKey() { + byte[] nonce = new byte[16]; + ThreadLocalRandom random = ThreadLocalRandom.current(); + for (int i = 0; i < nonce.length; i++) { + nonce[i] = (byte) random.nextInt(256); + } + return Base64.getEncoder().encodeToString(nonce); + } + + public static String getAcceptKey(String key) { + return Base64.getEncoder().encodeToString(pooledSha1MessageDigest().digest((key + MAGIC_GUID).getBytes(US_ASCII))); + } +} diff --git a/client/src/main/resources/org/asynchttpclient/config/ahc-default.properties b/client/src/main/resources/org/asynchttpclient/config/ahc-default.properties new file mode 100644 index 0000000000..f74127c23d --- /dev/null +++ b/client/src/main/resources/org/asynchttpclient/config/ahc-default.properties @@ -0,0 +1,57 @@ +org.asynchttpclient.threadPoolName=AsyncHttpClient +org.asynchttpclient.maxConnections=-1 +org.asynchttpclient.maxConnectionsPerHost=-1 +org.asynchttpclient.acquireFreeChannelTimeout=0 +org.asynchttpclient.connectTimeout=PT5S +org.asynchttpclient.pooledConnectionIdleTimeout=PT1M +org.asynchttpclient.connectionPoolCleanerPeriod=PT0.1S +org.asynchttpclient.readTimeout=PT1M +org.asynchttpclient.requestTimeout=PT1M +org.asynchttpclient.connectionTtl=-PT0.001S +org.asynchttpclient.followRedirect=false +org.asynchttpclient.maxRedirects=5 +org.asynchttpclient.compressionEnforced=false +org.asynchttpclient.enableAutomaticDecompression=true +org.asynchttpclient.userAgent=AHC/2.1 +org.asynchttpclient.enabledProtocols=TLSv1.3, TLSv1.2 +org.asynchttpclient.enabledCipherSuites= +org.asynchttpclient.filterInsecureCipherSuites=true +org.asynchttpclient.useProxySelector=false +org.asynchttpclient.useProxyProperties=false +org.asynchttpclient.validateResponseHeaders=true +org.asynchttpclient.aggregateWebSocketFrameFragments=true +org.asynchttpclient.strict302Handling=false +org.asynchttpclient.keepAlive=true +org.asynchttpclient.maxRequestRetry=5 +org.asynchttpclient.disableUrlEncodingForBoundRequests=false +org.asynchttpclient.useLaxCookieEncoder=false +org.asynchttpclient.removeQueryParamOnRedirect=true +org.asynchttpclient.useOpenSsl=false +org.asynchttpclient.useInsecureTrustManager=false +org.asynchttpclient.disableHttpsEndpointIdentificationAlgorithm=false +org.asynchttpclient.sslSessionCacheSize=0 +org.asynchttpclient.sslSessionTimeout=0 +org.asynchttpclient.tcpNoDelay=true +org.asynchttpclient.soReuseAddress=false +org.asynchttpclient.soKeepAlive=true +org.asynchttpclient.soLinger=-1 +org.asynchttpclient.soSndBuf=-1 +org.asynchttpclient.soRcvBuf=-1 +org.asynchttpclient.httpClientCodecMaxInitialLineLength=4096 +org.asynchttpclient.httpClientCodecMaxHeaderSize=8192 +org.asynchttpclient.httpClientCodecMaxChunkSize=8192 +org.asynchttpclient.httpClientCodecInitialBufferSize=128 +org.asynchttpclient.disableZeroCopy=false +org.asynchttpclient.handshakeTimeout=10000 +org.asynchttpclient.chunkedFileChunkSize=8192 +org.asynchttpclient.webSocketMaxBufferSize=128000000 +org.asynchttpclient.webSocketMaxFrameSize=10240 +org.asynchttpclient.keepEncodingHeader=false +org.asynchttpclient.shutdownQuietPeriod=PT2S +org.asynchttpclient.shutdownTimeout=PT15S +org.asynchttpclient.useNativeTransport=false +org.asynchttpclient.useOnlyEpollNativeTransport=false +org.asynchttpclient.ioThreadsCount=-1 +org.asynchttpclient.hashedWheelTimerTickDuration=100 +org.asynchttpclient.hashedWheelTimerSize=512 +org.asynchttpclient.expiredCookieEvictionDelay=30000 diff --git a/client/src/main/resources/org/asynchttpclient/config/ahc-version.properties b/client/src/main/resources/org/asynchttpclient/config/ahc-version.properties new file mode 100644 index 0000000000..242abfd904 --- /dev/null +++ b/client/src/main/resources/org/asynchttpclient/config/ahc-version.properties @@ -0,0 +1 @@ +ahc.version=${pom.version} \ No newline at end of file diff --git a/client/src/main/resources/org/asynchttpclient/request/body/multipart/ahc-mime.types b/client/src/main/resources/org/asynchttpclient/request/body/multipart/ahc-mime.types new file mode 100644 index 0000000000..4ec2dfc6b8 --- /dev/null +++ b/client/src/main/resources/org/asynchttpclient/request/body/multipart/ahc-mime.types @@ -0,0 +1,1832 @@ +# This file maps Internet media types to unique file extension(s). +# Although created for httpd, this file is used by many software systems +# and has been placed in the public domain for unlimited redisribution. +# +# The table below contains both registered and (common) unregistered types. +# A type that has no unique extension can be ignored -- they are listed +# here to guide configurations toward known types and to make it easier to +# identify "new" types. File extensions are also commonly used to indicate +# content languages and encodings, so choose them carefully. +# +# Internet media types should be registered as described in RFC 4288. +# The registry is at . +# +# MIME type (lowercased) Extensions +# ============================================ ========== +# application/1d-interleaved-parityfec +# application/3gpdash-qoe-report+xml +# application/3gpp-ims+xml +# application/a2l +# application/activemessage +# application/alto-costmap+json +# application/alto-costmapfilter+json +# application/alto-directory+json +# application/alto-endpointcost+json +# application/alto-endpointcostparams+json +# application/alto-endpointprop+json +# application/alto-endpointpropparams+json +# application/alto-error+json +# application/alto-networkmap+json +# application/alto-networkmapfilter+json +# application/aml +application/andrew-inset ez +# application/applefile +application/applixware aw +# application/atf +# application/atfx +application/atom+xml atom +application/atomcat+xml atomcat +# application/atomdeleted+xml +# application/atomicmail +application/atomsvc+xml atomsvc +# application/atxml +# application/auth-policy+xml +# application/bacnet-xdd+zip +# application/batch-smtp +# application/beep+xml +# application/calendar+json +# application/calendar+xml +# application/call-completion +# application/cals-1840 +# application/cbor +# application/ccmp+xml +application/ccxml+xml ccxml +# application/cdfx+xml +application/cdmi-capability cdmia +application/cdmi-container cdmic +application/cdmi-domain cdmid +application/cdmi-object cdmio +application/cdmi-queue cdmiq +# application/cdni +# application/cea +# application/cea-2018+xml +# application/cellml+xml +# application/cfw +# application/cms +# application/cnrp+xml +# application/coap-group+json +# application/commonground +# application/conference-info+xml +# application/cpl+xml +# application/csrattrs +# application/csta+xml +# application/cstadata+xml +# application/csvm+json +application/cu-seeme cu +# application/cybercash +# application/dash+xml +# application/dashdelta +application/davmount+xml davmount +# application/dca-rft +# application/dcd +# application/dec-dx +# application/dialog-info+xml +# application/dicom +# application/dii +# application/dit +# application/dns +application/docbook+xml dbk +# application/dskpp+xml +application/dssc+der dssc +application/dssc+xml xdssc +# application/dvcs +application/ecmascript ecma +# application/edi-consent +# application/edi-x12 +# application/edifact +# application/emergencycalldata.comment+xml +# application/emergencycalldata.deviceinfo+xml +# application/emergencycalldata.providerinfo+xml +# application/emergencycalldata.serviceinfo+xml +# application/emergencycalldata.subscriberinfo+xml +application/emma+xml emma +# application/emotionml+xml +# application/encaprtp +# application/epp+xml +application/epub+zip epub +# application/eshop +# application/example +application/exi exi +# application/fastinfoset +# application/fastsoap +# application/fdt+xml +# application/fits +# application/font-sfnt +application/font-tdpfr pfr +application/font-woff woff +# application/framework-attributes+xml +application/gml+xml gml +application/gpx+xml gpx +application/gxf gxf +# application/gzip +# application/h224 +# application/held+xml +# application/http +application/hyperstudio stk +# application/ibe-key-request+xml +# application/ibe-pkg-reply+xml +# application/ibe-pp-data +# application/iges +# application/im-iscomposing+xml +# application/index +# application/index.cmd +# application/index.obj +# application/index.response +# application/index.vnd +application/inkml+xml ink inkml +# application/iotp +application/ipfix ipfix +# application/ipp +# application/isup +# application/its+xml +application/java-archive jar +application/java-serialized-object ser +application/java-vm class +application/javascript js +# application/jose +# application/jose+json +# application/jrd+json +application/json json +# application/json-patch+json +# application/json-seq +application/jsonml+json jsonml +# application/jwk+json +# application/jwk-set+json +# application/jwt +# application/kpml-request+xml +# application/kpml-response+xml +# application/ld+json +# application/link-format +# application/load-control+xml +application/lost+xml lostxml +# application/lostsync+xml +# application/lxf +application/mac-binhex40 hqx +application/mac-compactpro cpt +# application/macwriteii +application/mads+xml mads +application/marc mrc +application/marcxml+xml mrcx +application/mathematica ma nb mb +application/mathml+xml mathml +# application/mathml-content+xml +# application/mathml-presentation+xml +# application/mbms-associated-procedure-description+xml +# application/mbms-deregister+xml +# application/mbms-envelope+xml +# application/mbms-msk+xml +# application/mbms-msk-response+xml +# application/mbms-protection-description+xml +# application/mbms-reception-report+xml +# application/mbms-register+xml +# application/mbms-register-response+xml +# application/mbms-schedule+xml +# application/mbms-user-service-description+xml +application/mbox mbox +# application/media-policy-dataset+xml +# application/media_control+xml +application/mediaservercontrol+xml mscml +# application/merge-patch+json +application/metalink+xml metalink +application/metalink4+xml meta4 +application/mets+xml mets +# application/mf4 +# application/mikey +application/mods+xml mods +# application/moss-keys +# application/moss-signature +# application/mosskey-data +# application/mosskey-request +application/mp21 m21 mp21 +application/mp4 mp4s +# application/mpeg4-generic +# application/mpeg4-iod +# application/mpeg4-iod-xmt +# application/mrb-consumer+xml +# application/mrb-publish+xml +# application/msc-ivr+xml +# application/msc-mixer+xml +application/msword doc dot +application/mxf mxf +# application/nasdata +# application/news-checkgroups +# application/news-groupinfo +# application/news-transmission +# application/nlsml+xml +# application/nss +# application/ocsp-request +# application/ocsp-response +application/octet-stream bin dms lrf mar so dist distz pkg bpk dump elc deploy +application/oda oda +# application/odx +application/oebps-package+xml opf +application/ogg ogx +application/omdoc+xml omdoc +application/onenote onetoc onetoc2 onetmp onepkg +application/oxps oxps +# application/p2p-overlay+xml +# application/parityfec +application/patch-ops-error+xml xer +application/pdf pdf +# application/pdx +application/pgp-encrypted pgp +# application/pgp-keys +application/pgp-signature asc sig +application/pics-rules prf +# application/pidf+xml +# application/pidf-diff+xml +application/pkcs10 p10 +# application/pkcs12 +application/pkcs7-mime p7m p7c +application/pkcs7-signature p7s +application/pkcs8 p8 +application/pkix-attr-cert ac +application/pkix-cert cer +application/pkix-crl crl +application/pkix-pkipath pkipath +application/pkixcmp pki +application/pls+xml pls +# application/poc-settings+xml +application/postscript ai eps ps +# application/ppsp-tracker+json +# application/problem+json +# application/problem+xml +# application/provenance+xml +# application/prs.alvestrand.titrax-sheet +application/prs.cww cww +# application/prs.hpub+zip +# application/prs.nprend +# application/prs.plucker +# application/prs.rdf-xml-crypt +# application/prs.xsf+xml +application/pskc+xml pskcxml +# application/qsig +# application/raptorfec +# application/rdap+json +application/rdf+xml rdf +application/reginfo+xml rif +application/relax-ng-compact-syntax rnc +# application/remote-printing +# application/reputon+json +application/resource-lists+xml rl +application/resource-lists-diff+xml rld +# application/rfc+xml +# application/riscos +# application/rlmi+xml +application/rls-services+xml rs +application/rpki-ghostbusters gbr +application/rpki-manifest mft +application/rpki-roa roa +# application/rpki-updown +application/rsd+xml rsd +application/rss+xml rss +application/rtf rtf +# application/rtploopback +# application/rtx +# application/samlassertion+xml +# application/samlmetadata+xml +application/sbml+xml sbml +# application/scaip+xml +# application/scim+json +application/scvp-cv-request scq +application/scvp-cv-response scs +application/scvp-vp-request spq +application/scvp-vp-response spp +application/sdp sdp +# application/sep+xml +# application/sep-exi +# application/session-info +# application/set-payment +application/set-payment-initiation setpay +# application/set-registration +application/set-registration-initiation setreg +# application/sgml +# application/sgml-open-catalog +application/shf+xml shf +# application/sieve +# application/simple-filter+xml +# application/simple-message-summary +# application/simplesymbolcontainer +# application/slate +# application/smil +application/smil+xml smi smil +# application/smpte336m +# application/soap+fastinfoset +# application/soap+xml +application/sparql-query rq +application/sparql-results+xml srx +# application/spirits-event+xml +# application/sql +application/srgs gram +application/srgs+xml grxml +application/sru+xml sru +application/ssdl+xml ssdl +application/ssml+xml ssml +# application/tamp-apex-update +# application/tamp-apex-update-confirm +# application/tamp-community-update +# application/tamp-community-update-confirm +# application/tamp-error +# application/tamp-sequence-adjust +# application/tamp-sequence-adjust-confirm +# application/tamp-status-query +# application/tamp-status-response +# application/tamp-update +# application/tamp-update-confirm +application/tei+xml tei teicorpus +application/thraud+xml tfi +# application/timestamp-query +# application/timestamp-reply +application/timestamped-data tsd +# application/ttml+xml +# application/tve-trigger +# application/ulpfec +# application/urc-grpsheet+xml +# application/urc-ressheet+xml +# application/urc-targetdesc+xml +# application/urc-uisocketdesc+xml +# application/vcard+json +# application/vcard+xml +# application/vemmi +# application/vividence.scriptfile +# application/vnd.3gpp-prose+xml +# application/vnd.3gpp-prose-pc3ch+xml +# application/vnd.3gpp.access-transfer-events+xml +# application/vnd.3gpp.bsf+xml +# application/vnd.3gpp.mid-call+xml +application/vnd.3gpp.pic-bw-large plb +application/vnd.3gpp.pic-bw-small psb +application/vnd.3gpp.pic-bw-var pvb +# application/vnd.3gpp.sms +# application/vnd.3gpp.srvcc-ext+xml +# application/vnd.3gpp.srvcc-info+xml +# application/vnd.3gpp.state-and-event-info+xml +# application/vnd.3gpp.ussd+xml +# application/vnd.3gpp2.bcmcsinfo+xml +# application/vnd.3gpp2.sms +application/vnd.3gpp2.tcap tcap +application/vnd.3m.post-it-notes pwn +application/vnd.accpac.simply.aso aso +application/vnd.accpac.simply.imp imp +application/vnd.acucobol acu +application/vnd.acucorp atc acutc +application/vnd.adobe.air-application-installer-package+zip air +# application/vnd.adobe.flash.movie +application/vnd.adobe.formscentral.fcdt fcdt +application/vnd.adobe.fxp fxp fxpl +# application/vnd.adobe.partial-upload +application/vnd.adobe.xdp+xml xdp +application/vnd.adobe.xfdf xfdf +# application/vnd.aether.imp +# application/vnd.ah-barcode +application/vnd.ahead.space ahead +application/vnd.airzip.filesecure.azf azf +application/vnd.airzip.filesecure.azs azs +application/vnd.amazon.ebook azw +application/vnd.americandynamics.acc acc +application/vnd.amiga.ami ami +# application/vnd.amundsen.maze+xml +application/vnd.android.package-archive apk +# application/vnd.anki +application/vnd.anser-web-certificate-issue-initiation cii +application/vnd.anser-web-funds-transfer-initiation fti +application/vnd.antix.game-component atx +# application/vnd.apache.thrift.binary +# application/vnd.apache.thrift.compact +# application/vnd.apache.thrift.json +# application/vnd.api+json +application/vnd.apple.installer+xml mpkg +application/vnd.apple.mpegurl m3u8 +# application/vnd.arastra.swi +application/vnd.aristanetworks.swi swi +# application/vnd.artsquare +application/vnd.astraea-software.iota iota +application/vnd.audiograph aep +# application/vnd.autopackage +# application/vnd.avistar+xml +# application/vnd.balsamiq.bmml+xml +# application/vnd.balsamiq.bmpr +# application/vnd.bekitzur-stech+json +# application/vnd.biopax.rdf+xml +application/vnd.blueice.multipass mpm +# application/vnd.bluetooth.ep.oob +# application/vnd.bluetooth.le.oob +application/vnd.bmi bmi +application/vnd.businessobjects rep +# application/vnd.cab-jscript +# application/vnd.canon-cpdl +# application/vnd.canon-lips +# application/vnd.cendio.thinlinc.clientconf +# application/vnd.century-systems.tcp_stream +application/vnd.chemdraw+xml cdxml +application/vnd.chipnuts.karaoke-mmd mmd +application/vnd.cinderella cdy +# application/vnd.cirpack.isdn-ext +# application/vnd.citationstyles.style+xml +application/vnd.claymore cla +application/vnd.cloanto.rp9 rp9 +application/vnd.clonk.c4group c4g c4d c4f c4p c4u +application/vnd.cluetrust.cartomobile-config c11amc +application/vnd.cluetrust.cartomobile-config-pkg c11amz +# application/vnd.coffeescript +# application/vnd.collection+json +# application/vnd.collection.doc+json +# application/vnd.collection.next+json +# application/vnd.commerce-battelle +application/vnd.commonspace csp +application/vnd.contact.cmsg cdbcmsg +application/vnd.cosmocaller cmc +application/vnd.crick.clicker clkx +application/vnd.crick.clicker.keyboard clkk +application/vnd.crick.clicker.palette clkp +application/vnd.crick.clicker.template clkt +application/vnd.crick.clicker.wordbank clkw +application/vnd.criticaltools.wbs+xml wbs +application/vnd.ctc-posml pml +# application/vnd.ctct.ws+xml +# application/vnd.cups-pdf +# application/vnd.cups-postscript +application/vnd.cups-ppd ppd +# application/vnd.cups-raster +# application/vnd.cups-raw +# application/vnd.curl +application/vnd.curl.car car +application/vnd.curl.pcurl pcurl +# application/vnd.cyan.dean.root+xml +# application/vnd.cybank +application/vnd.dart dart +application/vnd.data-vision.rdz rdz +# application/vnd.debian.binary-package +application/vnd.dece.data uvf uvvf uvd uvvd +application/vnd.dece.ttml+xml uvt uvvt +application/vnd.dece.unspecified uvx uvvx +application/vnd.dece.zip uvz uvvz +application/vnd.denovo.fcselayout-link fe_launch +# application/vnd.desmume.movie +# application/vnd.dir-bi.plate-dl-nosuffix +# application/vnd.dm.delegation+xml +application/vnd.dna dna +# application/vnd.document+json +application/vnd.dolby.mlp mlp +# application/vnd.dolby.mobile.1 +# application/vnd.dolby.mobile.2 +# application/vnd.doremir.scorecloud-binary-document +application/vnd.dpgraph dpg +application/vnd.dreamfactory dfac +# application/vnd.drive+json +application/vnd.ds-keypoint kpxx +# application/vnd.dtg.local +# application/vnd.dtg.local.flash +# application/vnd.dtg.local.html +application/vnd.dvb.ait ait +# application/vnd.dvb.dvbj +# application/vnd.dvb.esgcontainer +# application/vnd.dvb.ipdcdftnotifaccess +# application/vnd.dvb.ipdcesgaccess +# application/vnd.dvb.ipdcesgaccess2 +# application/vnd.dvb.ipdcesgpdd +# application/vnd.dvb.ipdcroaming +# application/vnd.dvb.iptv.alfec-base +# application/vnd.dvb.iptv.alfec-enhancement +# application/vnd.dvb.notif-aggregate-root+xml +# application/vnd.dvb.notif-container+xml +# application/vnd.dvb.notif-generic+xml +# application/vnd.dvb.notif-ia-msglist+xml +# application/vnd.dvb.notif-ia-registration-request+xml +# application/vnd.dvb.notif-ia-registration-response+xml +# application/vnd.dvb.notif-init+xml +# application/vnd.dvb.pfr +application/vnd.dvb.service svc +# application/vnd.dxr +application/vnd.dynageo geo +# application/vnd.dzr +# application/vnd.easykaraoke.cdgdownload +# application/vnd.ecdis-update +application/vnd.ecowin.chart mag +# application/vnd.ecowin.filerequest +# application/vnd.ecowin.fileupdate +# application/vnd.ecowin.series +# application/vnd.ecowin.seriesrequest +# application/vnd.ecowin.seriesupdate +# application/vnd.emclient.accessrequest+xml +application/vnd.enliven nml +# application/vnd.enphase.envoy +# application/vnd.eprints.data+xml +application/vnd.epson.esf esf +application/vnd.epson.msf msf +application/vnd.epson.quickanime qam +application/vnd.epson.salt slt +application/vnd.epson.ssf ssf +# application/vnd.ericsson.quickcall +application/vnd.eszigno3+xml es3 et3 +# application/vnd.etsi.aoc+xml +# application/vnd.etsi.asic-e+zip +# application/vnd.etsi.asic-s+zip +# application/vnd.etsi.cug+xml +# application/vnd.etsi.iptvcommand+xml +# application/vnd.etsi.iptvdiscovery+xml +# application/vnd.etsi.iptvprofile+xml +# application/vnd.etsi.iptvsad-bc+xml +# application/vnd.etsi.iptvsad-cod+xml +# application/vnd.etsi.iptvsad-npvr+xml +# application/vnd.etsi.iptvservice+xml +# application/vnd.etsi.iptvsync+xml +# application/vnd.etsi.iptvueprofile+xml +# application/vnd.etsi.mcid+xml +# application/vnd.etsi.mheg5 +# application/vnd.etsi.overload-control-policy-dataset+xml +# application/vnd.etsi.pstn+xml +# application/vnd.etsi.sci+xml +# application/vnd.etsi.simservs+xml +# application/vnd.etsi.timestamp-token +# application/vnd.etsi.tsl+xml +# application/vnd.etsi.tsl.der +# application/vnd.eudora.data +application/vnd.ezpix-album ez2 +application/vnd.ezpix-package ez3 +# application/vnd.f-secure.mobile +# application/vnd.fastcopy-disk-image +application/vnd.fdf fdf +application/vnd.fdsn.mseed mseed +application/vnd.fdsn.seed seed dataless +# application/vnd.ffsns +# application/vnd.filmit.zfc +# application/vnd.fints +# application/vnd.firemonkeys.cloudcell +application/vnd.flographit gph +application/vnd.fluxtime.clip ftc +# application/vnd.font-fontforge-sfd +application/vnd.framemaker fm frame maker book +application/vnd.frogans.fnc fnc +application/vnd.frogans.ltf ltf +application/vnd.fsc.weblaunch fsc +application/vnd.fujitsu.oasys oas +application/vnd.fujitsu.oasys2 oa2 +application/vnd.fujitsu.oasys3 oa3 +application/vnd.fujitsu.oasysgp fg5 +application/vnd.fujitsu.oasysprs bh2 +# application/vnd.fujixerox.art-ex +# application/vnd.fujixerox.art4 +application/vnd.fujixerox.ddd ddd +application/vnd.fujixerox.docuworks xdw +application/vnd.fujixerox.docuworks.binder xbd +# application/vnd.fujixerox.docuworks.container +# application/vnd.fujixerox.hbpl +# application/vnd.fut-misnet +application/vnd.fuzzysheet fzs +application/vnd.genomatix.tuxedo txd +# application/vnd.geo+json +# application/vnd.geocube+xml +application/vnd.geogebra.file ggb +application/vnd.geogebra.tool ggt +application/vnd.geometry-explorer gex gre +application/vnd.geonext gxt +application/vnd.geoplan g2w +application/vnd.geospace g3w +# application/vnd.gerber +# application/vnd.globalplatform.card-content-mgt +# application/vnd.globalplatform.card-content-mgt-response +application/vnd.gmx gmx +application/vnd.google-earth.kml+xml kml +application/vnd.google-earth.kmz kmz +# application/vnd.gov.sk.e-form+xml +# application/vnd.gov.sk.e-form+zip +# application/vnd.gov.sk.xmldatacontainer+xml +application/vnd.grafeq gqf gqs +# application/vnd.gridmp +application/vnd.groove-account gac +application/vnd.groove-help ghf +application/vnd.groove-identity-message gim +application/vnd.groove-injector grv +application/vnd.groove-tool-message gtm +application/vnd.groove-tool-template tpl +application/vnd.groove-vcard vcg +# application/vnd.hal+json +application/vnd.hal+xml hal +application/vnd.handheld-entertainment+xml zmm +application/vnd.hbci hbci +# application/vnd.hcl-bireports +# application/vnd.hdt +# application/vnd.heroku+json +application/vnd.hhe.lesson-player les +application/vnd.hp-hpgl hpgl +application/vnd.hp-hpid hpid +application/vnd.hp-hps hps +application/vnd.hp-jlyt jlt +application/vnd.hp-pcl pcl +application/vnd.hp-pclxl pclxl +# application/vnd.httphone +application/vnd.hydrostatix.sof-data sfd-hdstx +# application/vnd.hyperdrive+json +# application/vnd.hzn-3d-crossword +# application/vnd.ibm.afplinedata +# application/vnd.ibm.electronic-media +application/vnd.ibm.minipay mpy +application/vnd.ibm.modcap afp listafp list3820 +application/vnd.ibm.rights-management irm +application/vnd.ibm.secure-container sc +application/vnd.iccprofile icc icm +# application/vnd.ieee.1905 +application/vnd.igloader igl +application/vnd.immervision-ivp ivp +application/vnd.immervision-ivu ivu +# application/vnd.ims.imsccv1p1 +# application/vnd.ims.imsccv1p2 +# application/vnd.ims.imsccv1p3 +# application/vnd.ims.lis.v2.result+json +# application/vnd.ims.lti.v2.toolconsumerprofile+json +# application/vnd.ims.lti.v2.toolproxy+json +# application/vnd.ims.lti.v2.toolproxy.id+json +# application/vnd.ims.lti.v2.toolsettings+json +# application/vnd.ims.lti.v2.toolsettings.simple+json +# application/vnd.informedcontrol.rms+xml +# application/vnd.informix-visionary +# application/vnd.infotech.project +# application/vnd.infotech.project+xml +# application/vnd.innopath.wamp.notification +application/vnd.insors.igm igm +application/vnd.intercon.formnet xpw xpx +application/vnd.intergeo i2g +# application/vnd.intertrust.digibox +# application/vnd.intertrust.nncp +application/vnd.intu.qbo qbo +application/vnd.intu.qfx qfx +# application/vnd.iptc.g2.catalogitem+xml +# application/vnd.iptc.g2.conceptitem+xml +# application/vnd.iptc.g2.knowledgeitem+xml +# application/vnd.iptc.g2.newsitem+xml +# application/vnd.iptc.g2.newsmessage+xml +# application/vnd.iptc.g2.packageitem+xml +# application/vnd.iptc.g2.planningitem+xml +application/vnd.ipunplugged.rcprofile rcprofile +application/vnd.irepository.package+xml irp +application/vnd.is-xpr xpr +application/vnd.isac.fcs fcs +application/vnd.jam jam +# application/vnd.japannet-directory-service +# application/vnd.japannet-jpnstore-wakeup +# application/vnd.japannet-payment-wakeup +# application/vnd.japannet-registration +# application/vnd.japannet-registration-wakeup +# application/vnd.japannet-setstore-wakeup +# application/vnd.japannet-verification +# application/vnd.japannet-verification-wakeup +application/vnd.jcp.javame.midlet-rms rms +application/vnd.jisp jisp +application/vnd.joost.joda-archive joda +# application/vnd.jsk.isdn-ngn +application/vnd.kahootz ktz ktr +application/vnd.kde.karbon karbon +application/vnd.kde.kchart chrt +application/vnd.kde.kformula kfo +application/vnd.kde.kivio flw +application/vnd.kde.kontour kon +application/vnd.kde.kpresenter kpr kpt +application/vnd.kde.kspread ksp +application/vnd.kde.kword kwd kwt +application/vnd.kenameaapp htke +application/vnd.kidspiration kia +application/vnd.kinar kne knp +application/vnd.koan skp skd skt skm +application/vnd.kodak-descriptor sse +application/vnd.las.las+xml lasxml +# application/vnd.liberty-request+xml +application/vnd.llamagraphics.life-balance.desktop lbd +application/vnd.llamagraphics.life-balance.exchange+xml lbe +application/vnd.lotus-1-2-3 123 +application/vnd.lotus-approach apr +application/vnd.lotus-freelance pre +application/vnd.lotus-notes nsf +application/vnd.lotus-organizer org +application/vnd.lotus-screencam scm +application/vnd.lotus-wordpro lwp +application/vnd.macports.portpkg portpkg +# application/vnd.mapbox-vector-tile +# application/vnd.marlin.drm.actiontoken+xml +# application/vnd.marlin.drm.conftoken+xml +# application/vnd.marlin.drm.license+xml +# application/vnd.marlin.drm.mdcf +# application/vnd.mason+json +# application/vnd.maxmind.maxmind-db +application/vnd.mcd mcd +application/vnd.medcalcdata mc1 +application/vnd.mediastation.cdkey cdkey +# application/vnd.meridian-slingshot +application/vnd.mfer mwf +application/vnd.mfmp mfm +# application/vnd.micro+json +application/vnd.micrografx.flo flo +application/vnd.micrografx.igx igx +# application/vnd.microsoft.portable-executable +# application/vnd.miele+json +application/vnd.mif mif +# application/vnd.minisoft-hp3000-save +# application/vnd.mitsubishi.misty-guard.trustweb +application/vnd.mobius.daf daf +application/vnd.mobius.dis dis +application/vnd.mobius.mbk mbk +application/vnd.mobius.mqy mqy +application/vnd.mobius.msl msl +application/vnd.mobius.plc plc +application/vnd.mobius.txf txf +application/vnd.mophun.application mpn +application/vnd.mophun.certificate mpc +# application/vnd.motorola.flexsuite +# application/vnd.motorola.flexsuite.adsi +# application/vnd.motorola.flexsuite.fis +# application/vnd.motorola.flexsuite.gotap +# application/vnd.motorola.flexsuite.kmr +# application/vnd.motorola.flexsuite.ttc +# application/vnd.motorola.flexsuite.wem +# application/vnd.motorola.iprm +application/vnd.mozilla.xul+xml xul +# application/vnd.ms-3mfdocument +application/vnd.ms-artgalry cil +# application/vnd.ms-asf +application/vnd.ms-cab-compressed cab +# application/vnd.ms-color.iccprofile +application/vnd.ms-excel xls xlm xla xlc xlt xlw +application/vnd.ms-excel.addin.macroenabled.12 xlam +application/vnd.ms-excel.sheet.binary.macroenabled.12 xlsb +application/vnd.ms-excel.sheet.macroenabled.12 xlsm +application/vnd.ms-excel.template.macroenabled.12 xltm +application/vnd.ms-fontobject eot +application/vnd.ms-htmlhelp chm +application/vnd.ms-ims ims +application/vnd.ms-lrm lrm +# application/vnd.ms-office.activex+xml +application/vnd.ms-officetheme thmx +# application/vnd.ms-opentype +# application/vnd.ms-package.obfuscated-opentype +application/vnd.ms-pki.seccat cat +application/vnd.ms-pki.stl stl +# application/vnd.ms-playready.initiator+xml +application/vnd.ms-powerpoint ppt pps pot +application/vnd.ms-powerpoint.addin.macroenabled.12 ppam +application/vnd.ms-powerpoint.presentation.macroenabled.12 pptm +application/vnd.ms-powerpoint.slide.macroenabled.12 sldm +application/vnd.ms-powerpoint.slideshow.macroenabled.12 ppsm +application/vnd.ms-powerpoint.template.macroenabled.12 potm +# application/vnd.ms-printdevicecapabilities+xml +# application/vnd.ms-printing.printticket+xml +# application/vnd.ms-printschematicket+xml +application/vnd.ms-project mpp mpt +# application/vnd.ms-tnef +# application/vnd.ms-windows.devicepairing +# application/vnd.ms-windows.nwprinting.oob +# application/vnd.ms-windows.printerpairing +# application/vnd.ms-windows.wsd.oob +# application/vnd.ms-wmdrm.lic-chlg-req +# application/vnd.ms-wmdrm.lic-resp +# application/vnd.ms-wmdrm.meter-chlg-req +# application/vnd.ms-wmdrm.meter-resp +application/vnd.ms-word.document.macroenabled.12 docm +application/vnd.ms-word.template.macroenabled.12 dotm +application/vnd.ms-works wps wks wcm wdb +application/vnd.ms-wpl wpl +application/vnd.ms-xpsdocument xps +# application/vnd.msa-disk-image +application/vnd.mseq mseq +# application/vnd.msign +# application/vnd.multiad.creator +# application/vnd.multiad.creator.cif +# application/vnd.music-niff +application/vnd.musician mus +application/vnd.muvee.style msty +application/vnd.mynfc taglet +# application/vnd.ncd.control +# application/vnd.ncd.reference +# application/vnd.nervana +# application/vnd.netfpx +application/vnd.neurolanguage.nlu nlu +# application/vnd.nintendo.nitro.rom +# application/vnd.nintendo.snes.rom +application/vnd.nitf ntf nitf +application/vnd.noblenet-directory nnd +application/vnd.noblenet-sealer nns +application/vnd.noblenet-web nnw +# application/vnd.nokia.catalogs +# application/vnd.nokia.conml+wbxml +# application/vnd.nokia.conml+xml +# application/vnd.nokia.iptv.config+xml +# application/vnd.nokia.isds-radio-presets +# application/vnd.nokia.landmark+wbxml +# application/vnd.nokia.landmark+xml +# application/vnd.nokia.landmarkcollection+xml +# application/vnd.nokia.n-gage.ac+xml +application/vnd.nokia.n-gage.data ngdat +application/vnd.nokia.n-gage.symbian.install n-gage +# application/vnd.nokia.ncd +# application/vnd.nokia.pcd+wbxml +# application/vnd.nokia.pcd+xml +application/vnd.nokia.radio-preset rpst +application/vnd.nokia.radio-presets rpss +application/vnd.novadigm.edm edm +application/vnd.novadigm.edx edx +application/vnd.novadigm.ext ext +# application/vnd.ntt-local.content-share +# application/vnd.ntt-local.file-transfer +# application/vnd.ntt-local.ogw_remote-access +# application/vnd.ntt-local.sip-ta_remote +# application/vnd.ntt-local.sip-ta_tcp_stream +application/vnd.oasis.opendocument.chart odc +application/vnd.oasis.opendocument.chart-template otc +application/vnd.oasis.opendocument.database odb +application/vnd.oasis.opendocument.formula odf +application/vnd.oasis.opendocument.formula-template odft +application/vnd.oasis.opendocument.graphics odg +application/vnd.oasis.opendocument.graphics-template otg +application/vnd.oasis.opendocument.image odi +application/vnd.oasis.opendocument.image-template oti +application/vnd.oasis.opendocument.presentation odp +application/vnd.oasis.opendocument.presentation-template otp +application/vnd.oasis.opendocument.spreadsheet ods +application/vnd.oasis.opendocument.spreadsheet-template ots +application/vnd.oasis.opendocument.text odt +application/vnd.oasis.opendocument.text-master odm +application/vnd.oasis.opendocument.text-template ott +application/vnd.oasis.opendocument.text-web oth +# application/vnd.obn +# application/vnd.oftn.l10n+json +# application/vnd.oipf.contentaccessdownload+xml +# application/vnd.oipf.contentaccessstreaming+xml +# application/vnd.oipf.cspg-hexbinary +# application/vnd.oipf.dae.svg+xml +# application/vnd.oipf.dae.xhtml+xml +# application/vnd.oipf.mippvcontrolmessage+xml +# application/vnd.oipf.pae.gem +# application/vnd.oipf.spdiscovery+xml +# application/vnd.oipf.spdlist+xml +# application/vnd.oipf.ueprofile+xml +# application/vnd.oipf.userprofile+xml +application/vnd.olpc-sugar xo +# application/vnd.oma-scws-config +# application/vnd.oma-scws-http-request +# application/vnd.oma-scws-http-response +# application/vnd.oma.bcast.associated-procedure-parameter+xml +# application/vnd.oma.bcast.drm-trigger+xml +# application/vnd.oma.bcast.imd+xml +# application/vnd.oma.bcast.ltkm +# application/vnd.oma.bcast.notification+xml +# application/vnd.oma.bcast.provisioningtrigger +# application/vnd.oma.bcast.sgboot +# application/vnd.oma.bcast.sgdd+xml +# application/vnd.oma.bcast.sgdu +# application/vnd.oma.bcast.simple-symbol-container +# application/vnd.oma.bcast.smartcard-trigger+xml +# application/vnd.oma.bcast.sprov+xml +# application/vnd.oma.bcast.stkm +# application/vnd.oma.cab-address-book+xml +# application/vnd.oma.cab-feature-handler+xml +# application/vnd.oma.cab-pcc+xml +# application/vnd.oma.cab-subs-invite+xml +# application/vnd.oma.cab-user-prefs+xml +# application/vnd.oma.dcd +# application/vnd.oma.dcdc +application/vnd.oma.dd2+xml dd2 +# application/vnd.oma.drm.risd+xml +# application/vnd.oma.group-usage-list+xml +# application/vnd.oma.pal+xml +# application/vnd.oma.poc.detailed-progress-report+xml +# application/vnd.oma.poc.final-report+xml +# application/vnd.oma.poc.groups+xml +# application/vnd.oma.poc.invocation-descriptor+xml +# application/vnd.oma.poc.optimized-progress-report+xml +# application/vnd.oma.push +# application/vnd.oma.scidm.messages+xml +# application/vnd.oma.xcap-directory+xml +# application/vnd.omads-email+xml +# application/vnd.omads-file+xml +# application/vnd.omads-folder+xml +# application/vnd.omaloc-supl-init +# application/vnd.openblox.game+xml +# application/vnd.openblox.game-binary +# application/vnd.openeye.oeb +application/vnd.openofficeorg.extension oxt +# application/vnd.openxmlformats-officedocument.custom-properties+xml +# application/vnd.openxmlformats-officedocument.customxmlproperties+xml +# application/vnd.openxmlformats-officedocument.drawing+xml +# application/vnd.openxmlformats-officedocument.drawingml.chart+xml +# application/vnd.openxmlformats-officedocument.drawingml.chartshapes+xml +# application/vnd.openxmlformats-officedocument.drawingml.diagramcolors+xml +# application/vnd.openxmlformats-officedocument.drawingml.diagramdata+xml +# application/vnd.openxmlformats-officedocument.drawingml.diagramlayout+xml +# application/vnd.openxmlformats-officedocument.drawingml.diagramstyle+xml +# application/vnd.openxmlformats-officedocument.extended-properties+xml +# application/vnd.openxmlformats-officedocument.presentationml.commentauthors+xml +# application/vnd.openxmlformats-officedocument.presentationml.comments+xml +# application/vnd.openxmlformats-officedocument.presentationml.handoutmaster+xml +# application/vnd.openxmlformats-officedocument.presentationml.notesmaster+xml +# application/vnd.openxmlformats-officedocument.presentationml.notesslide+xml +application/vnd.openxmlformats-officedocument.presentationml.presentation pptx +# application/vnd.openxmlformats-officedocument.presentationml.presentation.main+xml +# application/vnd.openxmlformats-officedocument.presentationml.presprops+xml +application/vnd.openxmlformats-officedocument.presentationml.slide sldx +# application/vnd.openxmlformats-officedocument.presentationml.slide+xml +# application/vnd.openxmlformats-officedocument.presentationml.slidelayout+xml +# application/vnd.openxmlformats-officedocument.presentationml.slidemaster+xml +application/vnd.openxmlformats-officedocument.presentationml.slideshow ppsx +# application/vnd.openxmlformats-officedocument.presentationml.slideshow.main+xml +# application/vnd.openxmlformats-officedocument.presentationml.slideupdateinfo+xml +# application/vnd.openxmlformats-officedocument.presentationml.tablestyles+xml +# application/vnd.openxmlformats-officedocument.presentationml.tags+xml +application/vnd.openxmlformats-officedocument.presentationml.template potx +# application/vnd.openxmlformats-officedocument.presentationml.template.main+xml +# application/vnd.openxmlformats-officedocument.presentationml.viewprops+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.calcchain+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.chartsheet+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.comments+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.connections+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.dialogsheet+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.externallink+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.pivotcachedefinition+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.pivotcacherecords+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.pivottable+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.querytable+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.revisionheaders+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.revisionlog+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.sharedstrings+xml +application/vnd.openxmlformats-officedocument.spreadsheetml.sheet xlsx +# application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.sheetmetadata+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.tablesinglecells+xml +application/vnd.openxmlformats-officedocument.spreadsheetml.template xltx +# application/vnd.openxmlformats-officedocument.spreadsheetml.template.main+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.usernames+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.volatiledependencies+xml +# application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml +# application/vnd.openxmlformats-officedocument.theme+xml +# application/vnd.openxmlformats-officedocument.themeoverride+xml +# application/vnd.openxmlformats-officedocument.vmldrawing +# application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml +application/vnd.openxmlformats-officedocument.wordprocessingml.document docx +# application/vnd.openxmlformats-officedocument.wordprocessingml.document.glossary+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.endnotes+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.fonttable+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml +application/vnd.openxmlformats-officedocument.wordprocessingml.template dotx +# application/vnd.openxmlformats-officedocument.wordprocessingml.template.main+xml +# application/vnd.openxmlformats-officedocument.wordprocessingml.websettings+xml +# application/vnd.openxmlformats-package.core-properties+xml +# application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml +# application/vnd.openxmlformats-package.relationships+xml +# application/vnd.oracle.resource+json +# application/vnd.orange.indata +# application/vnd.osa.netdeploy +application/vnd.osgeo.mapguide.package mgp +# application/vnd.osgi.bundle +application/vnd.osgi.dp dp +application/vnd.osgi.subsystem esa +# application/vnd.otps.ct-kip+xml +# application/vnd.oxli.countgraph +# application/vnd.pagerduty+json +application/vnd.palm pdb pqa oprc +# application/vnd.panoply +# application/vnd.paos.xml +application/vnd.pawaafile paw +# application/vnd.pcos +application/vnd.pg.format str +application/vnd.pg.osasli ei6 +# application/vnd.piaccess.application-licence +application/vnd.picsel efif +application/vnd.pmi.widget wg +# application/vnd.poc.group-advertisement+xml +application/vnd.pocketlearn plf +application/vnd.powerbuilder6 pbd +# application/vnd.powerbuilder6-s +# application/vnd.powerbuilder7 +# application/vnd.powerbuilder7-s +# application/vnd.powerbuilder75 +# application/vnd.powerbuilder75-s +# application/vnd.preminet +application/vnd.previewsystems.box box +application/vnd.proteus.magazine mgz +application/vnd.publishare-delta-tree qps +application/vnd.pvi.ptid1 ptid +# application/vnd.pwg-multiplexed +# application/vnd.pwg-xhtml-print+xml +# application/vnd.qualcomm.brew-app-res +application/vnd.quark.quarkxpress qxd qxt qwd qwt qxl qxb +# application/vnd.quobject-quoxdocument +# application/vnd.radisys.moml+xml +# application/vnd.radisys.msml+xml +# application/vnd.radisys.msml-audit+xml +# application/vnd.radisys.msml-audit-conf+xml +# application/vnd.radisys.msml-audit-conn+xml +# application/vnd.radisys.msml-audit-dialog+xml +# application/vnd.radisys.msml-audit-stream+xml +# application/vnd.radisys.msml-conf+xml +# application/vnd.radisys.msml-dialog+xml +# application/vnd.radisys.msml-dialog-base+xml +# application/vnd.radisys.msml-dialog-fax-detect+xml +# application/vnd.radisys.msml-dialog-fax-sendrecv+xml +# application/vnd.radisys.msml-dialog-group+xml +# application/vnd.radisys.msml-dialog-speech+xml +# application/vnd.radisys.msml-dialog-transform+xml +# application/vnd.rainstor.data +# application/vnd.rapid +application/vnd.realvnc.bed bed +application/vnd.recordare.musicxml mxl +application/vnd.recordare.musicxml+xml musicxml +# application/vnd.renlearn.rlprint +application/vnd.rig.cryptonote cryptonote +application/vnd.rim.cod cod +application/vnd.rn-realmedia rm +application/vnd.rn-realmedia-vbr rmvb +application/vnd.route66.link66+xml link66 +# application/vnd.rs-274x +# application/vnd.ruckus.download +# application/vnd.s3sms +application/vnd.sailingtracker.track st +# application/vnd.sbm.cid +# application/vnd.sbm.mid2 +# application/vnd.scribus +# application/vnd.sealed.3df +# application/vnd.sealed.csf +# application/vnd.sealed.doc +# application/vnd.sealed.eml +# application/vnd.sealed.mht +# application/vnd.sealed.net +# application/vnd.sealed.ppt +# application/vnd.sealed.tiff +# application/vnd.sealed.xls +# application/vnd.sealedmedia.softseal.html +# application/vnd.sealedmedia.softseal.pdf +application/vnd.seemail see +application/vnd.sema sema +application/vnd.semd semd +application/vnd.semf semf +application/vnd.shana.informed.formdata ifm +application/vnd.shana.informed.formtemplate itp +application/vnd.shana.informed.interchange iif +application/vnd.shana.informed.package ipk +application/vnd.simtech-mindmapper twd twds +# application/vnd.siren+json +application/vnd.smaf mmf +# application/vnd.smart.notebook +application/vnd.smart.teacher teacher +# application/vnd.software602.filler.form+xml +# application/vnd.software602.filler.form-xml-zip +application/vnd.solent.sdkm+xml sdkm sdkd +application/vnd.spotfire.dxp dxp +application/vnd.spotfire.sfs sfs +# application/vnd.sss-cod +# application/vnd.sss-dtf +# application/vnd.sss-ntf +application/vnd.stardivision.calc sdc +application/vnd.stardivision.draw sda +application/vnd.stardivision.impress sdd +application/vnd.stardivision.math smf +application/vnd.stardivision.writer sdw vor +application/vnd.stardivision.writer-global sgl +application/vnd.stepmania.package smzip +application/vnd.stepmania.stepchart sm +# application/vnd.street-stream +# application/vnd.sun.wadl+xml +application/vnd.sun.xml.calc sxc +application/vnd.sun.xml.calc.template stc +application/vnd.sun.xml.draw sxd +application/vnd.sun.xml.draw.template std +application/vnd.sun.xml.impress sxi +application/vnd.sun.xml.impress.template sti +application/vnd.sun.xml.math sxm +application/vnd.sun.xml.writer sxw +application/vnd.sun.xml.writer.global sxg +application/vnd.sun.xml.writer.template stw +application/vnd.sus-calendar sus susp +application/vnd.svd svd +# application/vnd.swiftview-ics +application/vnd.symbian.install sis sisx +application/vnd.syncml+xml xsm +application/vnd.syncml.dm+wbxml bdm +application/vnd.syncml.dm+xml xdm +# application/vnd.syncml.dm.notification +# application/vnd.syncml.dmddf+wbxml +# application/vnd.syncml.dmddf+xml +# application/vnd.syncml.dmtnds+wbxml +# application/vnd.syncml.dmtnds+xml +# application/vnd.syncml.ds.notification +application/vnd.tao.intent-module-archive tao +application/vnd.tcpdump.pcap pcap cap dmp +# application/vnd.tmd.mediaflex.api+xml +# application/vnd.tml +application/vnd.tmobile-livetv tmo +application/vnd.trid.tpt tpt +application/vnd.triscape.mxs mxs +application/vnd.trueapp tra +# application/vnd.truedoc +# application/vnd.ubisoft.webplayer +application/vnd.ufdl ufd ufdl +application/vnd.uiq.theme utz +application/vnd.umajin umj +application/vnd.unity unityweb +application/vnd.uoml+xml uoml +# application/vnd.uplanet.alert +# application/vnd.uplanet.alert-wbxml +# application/vnd.uplanet.bearer-choice +# application/vnd.uplanet.bearer-choice-wbxml +# application/vnd.uplanet.cacheop +# application/vnd.uplanet.cacheop-wbxml +# application/vnd.uplanet.channel +# application/vnd.uplanet.channel-wbxml +# application/vnd.uplanet.list +# application/vnd.uplanet.list-wbxml +# application/vnd.uplanet.listcmd +# application/vnd.uplanet.listcmd-wbxml +# application/vnd.uplanet.signal +# application/vnd.uri-map +# application/vnd.valve.source.material +application/vnd.vcx vcx +# application/vnd.vd-study +# application/vnd.vectorworks +# application/vnd.verimatrix.vcas +# application/vnd.vidsoft.vidconference +application/vnd.visio vsd vst vss vsw +application/vnd.visionary vis +# application/vnd.vividence.scriptfile +application/vnd.vsf vsf +# application/vnd.wap.sic +# application/vnd.wap.slc +application/vnd.wap.wbxml wbxml +application/vnd.wap.wmlc wmlc +application/vnd.wap.wmlscriptc wmlsc +application/vnd.webturbo wtb +# application/vnd.wfa.p2p +# application/vnd.wfa.wsc +# application/vnd.windows.devicepairing +# application/vnd.wmc +# application/vnd.wmf.bootstrap +# application/vnd.wolfram.mathematica +# application/vnd.wolfram.mathematica.package +application/vnd.wolfram.player nbp +application/vnd.wordperfect wpd +application/vnd.wqd wqd +# application/vnd.wrq-hp3000-labelled +application/vnd.wt.stf stf +# application/vnd.wv.csp+wbxml +# application/vnd.wv.csp+xml +# application/vnd.wv.ssp+xml +# application/vnd.xacml+json +application/vnd.xara xar +application/vnd.xfdl xfdl +# application/vnd.xfdl.webform +# application/vnd.xmi+xml +# application/vnd.xmpie.cpkg +# application/vnd.xmpie.dpkg +# application/vnd.xmpie.plan +# application/vnd.xmpie.ppkg +# application/vnd.xmpie.xlim +application/vnd.yamaha.hv-dic hvd +application/vnd.yamaha.hv-script hvs +application/vnd.yamaha.hv-voice hvp +application/vnd.yamaha.openscoreformat osf +application/vnd.yamaha.openscoreformat.osfpvg+xml osfpvg +# application/vnd.yamaha.remote-setup +application/vnd.yamaha.smaf-audio saf +application/vnd.yamaha.smaf-phrase spf +# application/vnd.yamaha.through-ngn +# application/vnd.yamaha.tunnel-udpencap +# application/vnd.yaoweme +application/vnd.yellowriver-custom-menu cmp +application/vnd.zul zir zirz +application/vnd.zzazz.deck+xml zaz +application/voicexml+xml vxml +# application/vq-rtcpxr +# application/watcherinfo+xml +# application/whoispp-query +# application/whoispp-response +application/widget wgt +application/winhlp hlp +# application/wita +# application/wordperfect5.1 +application/wsdl+xml wsdl +application/wspolicy+xml wspolicy +application/x-7z-compressed 7z +application/x-abiword abw +application/x-ace-compressed ace +# application/x-amf +application/x-apple-diskimage dmg +application/x-authorware-bin aab x32 u32 vox +application/x-authorware-map aam +application/x-authorware-seg aas +application/x-bcpio bcpio +application/x-bittorrent torrent +application/x-blorb blb blorb +application/x-bzip bz +application/x-bzip2 bz2 boz +application/x-cbr cbr cba cbt cbz cb7 +application/x-cdlink vcd +application/x-cfs-compressed cfs +application/x-chat chat +application/x-chess-pgn pgn +# application/x-compress +application/x-conference nsc +application/x-cpio cpio +application/x-csh csh +application/x-debian-package deb udeb +application/x-dgc-compressed dgc +application/x-director dir dcr dxr cst cct cxt w3d fgd swa +application/x-doom wad +application/x-dtbncx+xml ncx +application/x-dtbook+xml dtb +application/x-dtbresource+xml res +application/x-dvi dvi +application/x-envoy evy +application/x-eva eva +application/x-font-bdf bdf +# application/x-font-dos +# application/x-font-framemaker +application/x-font-ghostscript gsf +# application/x-font-libgrx +application/x-font-linux-psf psf +application/x-font-otf otf +application/x-font-pcf pcf +application/x-font-snf snf +# application/x-font-speedo +# application/x-font-sunos-news +application/x-font-ttf ttf ttc +application/x-font-type1 pfa pfb pfm afm +# application/x-font-vfont +application/x-freearc arc +application/x-futuresplash spl +application/x-gca-compressed gca +application/x-glulx ulx +application/x-gnumeric gnumeric +application/x-gramps-xml gramps +application/x-gtar gtar +# application/x-gzip +application/x-hdf hdf +application/x-install-instructions install +application/x-iso9660-image iso +application/x-java-jnlp-file jnlp +application/x-latex latex +application/x-lzh-compressed lzh lha +application/x-mie mie +application/x-mobipocket-ebook prc mobi +application/x-ms-application application +application/x-ms-shortcut lnk +application/x-ms-wmd wmd +application/x-ms-wmz wmz +application/x-ms-xbap xbap +application/x-msaccess mdb +application/x-msbinder obd +application/x-mscardfile crd +application/x-msclip clp +application/x-msdownload exe dll com bat msi +application/x-msmediaview mvb m13 m14 +application/x-msmetafile wmf wmz emf emz +application/x-msmoney mny +application/x-mspublisher pub +application/x-msschedule scd +application/x-msterminal trm +application/x-mswrite wri +application/x-netcdf nc cdf +application/x-nzb nzb +application/x-pkcs12 p12 pfx +application/x-pkcs7-certificates p7b spc +application/x-pkcs7-certreqresp p7r +application/x-rar-compressed rar +application/x-research-info-systems ris +application/x-sh sh +application/x-shar shar +application/x-shockwave-flash swf +application/x-silverlight-app xap +application/x-sql sql +application/x-stuffit sit +application/x-stuffitx sitx +application/x-subrip srt +application/x-sv4cpio sv4cpio +application/x-sv4crc sv4crc +application/x-t3vm-image t3 +application/x-tads gam +application/x-tar tar +application/x-tcl tcl +application/x-tex tex +application/x-tex-tfm tfm +application/x-texinfo texinfo texi +application/x-tgif obj +application/x-ustar ustar +application/x-wais-source src +# application/x-www-form-urlencoded +application/x-x509-ca-cert der crt +application/x-xfig fig +application/x-xliff+xml xlf +application/x-xpinstall xpi +application/x-xz xz +application/x-zmachine z1 z2 z3 z4 z5 z6 z7 z8 +# application/x400-bp +# application/xacml+xml +application/xaml+xml xaml +# application/xcap-att+xml +# application/xcap-caps+xml +application/xcap-diff+xml xdf +# application/xcap-el+xml +# application/xcap-error+xml +# application/xcap-ns+xml +# application/xcon-conference-info+xml +# application/xcon-conference-info-diff+xml +application/xenc+xml xenc +application/xhtml+xml xhtml xht +# application/xhtml-voice+xml +application/xml xml xsl +application/xml-dtd dtd +# application/xml-external-parsed-entity +# application/xml-patch+xml +# application/xmpp+xml +application/xop+xml xop +application/xproc+xml xpl +application/xslt+xml xslt +application/xspf+xml xspf +application/xv+xml mxml xhvml xvml xvm +application/yang yang +application/yin+xml yin +application/zip zip +# application/zlib +# audio/1d-interleaved-parityfec +# audio/32kadpcm +# audio/3gpp +# audio/3gpp2 +# audio/ac3 +audio/adpcm adp +# audio/amr +# audio/amr-wb +# audio/amr-wb+ +# audio/aptx +# audio/asc +# audio/atrac-advanced-lossless +# audio/atrac-x +# audio/atrac3 +audio/basic au snd +# audio/bv16 +# audio/bv32 +# audio/clearmode +# audio/cn +# audio/dat12 +# audio/dls +# audio/dsr-es201108 +# audio/dsr-es202050 +# audio/dsr-es202211 +# audio/dsr-es202212 +# audio/dv +# audio/dvi4 +# audio/eac3 +# audio/encaprtp +# audio/evrc +# audio/evrc-qcp +# audio/evrc0 +# audio/evrc1 +# audio/evrcb +# audio/evrcb0 +# audio/evrcb1 +# audio/evrcnw +# audio/evrcnw0 +# audio/evrcnw1 +# audio/evrcwb +# audio/evrcwb0 +# audio/evrcwb1 +# audio/evs +# audio/example +# audio/fwdred +# audio/g711-0 +# audio/g719 +# audio/g722 +# audio/g7221 +# audio/g723 +# audio/g726-16 +# audio/g726-24 +# audio/g726-32 +# audio/g726-40 +# audio/g728 +# audio/g729 +# audio/g7291 +# audio/g729d +# audio/g729e +# audio/gsm +# audio/gsm-efr +# audio/gsm-hr-08 +# audio/ilbc +# audio/ip-mr_v2.5 +# audio/isac +# audio/l16 +# audio/l20 +# audio/l24 +# audio/l8 +# audio/lpc +audio/midi mid midi kar rmi +# audio/mobile-xmf +audio/mp4 m4a mp4a +# audio/mp4a-latm +# audio/mpa +# audio/mpa-robust +audio/mpeg mpga mp2 mp2a mp3 m2a m3a +# audio/mpeg4-generic +# audio/musepack +audio/ogg oga ogg spx +# audio/opus +# audio/parityfec +# audio/pcma +# audio/pcma-wb +# audio/pcmu +# audio/pcmu-wb +# audio/prs.sid +# audio/qcelp +# audio/raptorfec +# audio/red +# audio/rtp-enc-aescm128 +# audio/rtp-midi +# audio/rtploopback +# audio/rtx +audio/s3m s3m +audio/silk sil +# audio/smv +# audio/smv-qcp +# audio/smv0 +# audio/sp-midi +# audio/speex +# audio/t140c +# audio/t38 +# audio/telephone-event +# audio/tone +# audio/uemclip +# audio/ulpfec +# audio/vdvi +# audio/vmr-wb +# audio/vnd.3gpp.iufp +# audio/vnd.4sb +# audio/vnd.audiokoz +# audio/vnd.celp +# audio/vnd.cisco.nse +# audio/vnd.cmles.radio-events +# audio/vnd.cns.anp1 +# audio/vnd.cns.inf1 +audio/vnd.dece.audio uva uvva +audio/vnd.digital-winds eol +# audio/vnd.dlna.adts +# audio/vnd.dolby.heaac.1 +# audio/vnd.dolby.heaac.2 +# audio/vnd.dolby.mlp +# audio/vnd.dolby.mps +# audio/vnd.dolby.pl2 +# audio/vnd.dolby.pl2x +# audio/vnd.dolby.pl2z +# audio/vnd.dolby.pulse.1 +audio/vnd.dra dra +audio/vnd.dts dts +audio/vnd.dts.hd dtshd +# audio/vnd.dvb.file +# audio/vnd.everad.plj +# audio/vnd.hns.audio +audio/vnd.lucent.voice lvp +audio/vnd.ms-playready.media.pya pya +# audio/vnd.nokia.mobile-xmf +# audio/vnd.nortel.vbk +audio/vnd.nuera.ecelp4800 ecelp4800 +audio/vnd.nuera.ecelp7470 ecelp7470 +audio/vnd.nuera.ecelp9600 ecelp9600 +# audio/vnd.octel.sbc +# audio/vnd.qcelp +# audio/vnd.rhetorex.32kadpcm +audio/vnd.rip rip +# audio/vnd.sealedmedia.softseal.mpeg +# audio/vnd.vmx.cvsd +# audio/vorbis +# audio/vorbis-config +audio/webm weba +audio/x-aac aac +audio/x-aiff aif aiff aifc +audio/x-caf caf +audio/x-flac flac +audio/x-matroska mka +audio/x-mpegurl m3u +audio/x-ms-wax wax +audio/x-ms-wma wma +audio/x-pn-realaudio ram ra +audio/x-pn-realaudio-plugin rmp +# audio/x-tta +audio/x-wav wav +audio/xm xm +chemical/x-cdx cdx +chemical/x-cif cif +chemical/x-cmdf cmdf +chemical/x-cml cml +chemical/x-csml csml +# chemical/x-pdb +chemical/x-xyz xyz +image/bmp bmp +image/cgm cgm +# image/example +# image/fits +image/g3fax g3 +image/gif gif +image/ief ief +# image/jp2 +image/jpeg jpeg jpg jpe +# image/jpm +# image/jpx +image/ktx ktx +# image/naplps +image/png png +image/prs.btif btif +# image/prs.pti +# image/pwg-raster +image/sgi sgi +image/svg+xml svg svgz +# image/t38 +image/tiff tiff tif +# image/tiff-fx +image/vnd.adobe.photoshop psd +# image/vnd.airzip.accelerator.azv +# image/vnd.cns.inf2 +image/vnd.dece.graphic uvi uvvi uvg uvvg +image/vnd.djvu djvu djv +image/vnd.dvb.subtitle sub +image/vnd.dwg dwg +image/vnd.dxf dxf +image/vnd.fastbidsheet fbs +image/vnd.fpx fpx +image/vnd.fst fst +image/vnd.fujixerox.edmics-mmr mmr +image/vnd.fujixerox.edmics-rlc rlc +# image/vnd.globalgraphics.pgb +# image/vnd.microsoft.icon +# image/vnd.mix +# image/vnd.mozilla.apng +image/vnd.ms-modi mdi +image/vnd.ms-photo wdp +image/vnd.net-fpx npx +# image/vnd.radiance +# image/vnd.sealed.png +# image/vnd.sealedmedia.softseal.gif +# image/vnd.sealedmedia.softseal.jpg +# image/vnd.svf +# image/vnd.tencent.tap +# image/vnd.valve.source.texture +image/vnd.wap.wbmp wbmp +image/vnd.xiff xif +# image/vnd.zbrush.pcx +image/webp webp +image/x-3ds 3ds +image/x-cmu-raster ras +image/x-cmx cmx +image/x-freehand fh fhc fh4 fh5 fh7 +image/x-icon ico +image/x-mrsid-image sid +image/x-pcx pcx +image/x-pict pic pct +image/x-portable-anymap pnm +image/x-portable-bitmap pbm +image/x-portable-graymap pgm +image/x-portable-pixmap ppm +image/x-rgb rgb +image/x-tga tga +image/x-xbitmap xbm +image/x-xpixmap xpm +image/x-xwindowdump xwd +# message/cpim +# message/delivery-status +# message/disposition-notification +# message/example +# message/external-body +# message/feedback-report +# message/global +# message/global-delivery-status +# message/global-disposition-notification +# message/global-headers +# message/http +# message/imdn+xml +# message/news +# message/partial +message/rfc822 eml mime +# message/s-http +# message/sip +# message/sipfrag +# message/tracking-status +# message/vnd.si.simp +# message/vnd.wfa.wsc +# model/example +model/iges igs iges +model/mesh msh mesh silo +model/vnd.collada+xml dae +model/vnd.dwf dwf +# model/vnd.flatland.3dml +model/vnd.gdl gdl +# model/vnd.gs-gdl +# model/vnd.gs.gdl +model/vnd.gtw gtw +# model/vnd.moml+xml +model/vnd.mts mts +# model/vnd.opengex +# model/vnd.parasolid.transmit.binary +# model/vnd.parasolid.transmit.text +# model/vnd.rosette.annotated-data-model +# model/vnd.valve.source.compiled-map +model/vnd.vtu vtu +model/vrml wrl vrml +model/x3d+binary x3db x3dbz +# model/x3d+fastinfoset +model/x3d+vrml x3dv x3dvz +model/x3d+xml x3d x3dz +# model/x3d-vrml +# multipart/alternative +# multipart/appledouble +# multipart/byteranges +# multipart/digest +# multipart/encrypted +# multipart/example +# multipart/form-data +# multipart/header-set +# multipart/mixed +# multipart/parallel +# multipart/related +# multipart/report +# multipart/signed +# multipart/voice-message +# multipart/x-mixed-replace +# text/1d-interleaved-parityfec +text/cache-manifest appcache +text/calendar ics ifb +text/css css +text/csv csv +# text/csv-schema +# text/directory +# text/dns +# text/ecmascript +# text/encaprtp +# text/enriched +# text/example +# text/fwdred +# text/grammar-ref-list +text/html html htm +# text/javascript +# text/jcr-cnd +# text/markdown +# text/mizar +text/n3 n3 +# text/parameters +# text/parityfec +text/plain txt text conf def list log in +# text/provenance-notation +# text/prs.fallenstein.rst +text/prs.lines.tag dsc +# text/raptorfec +# text/red +# text/rfc822-headers +text/richtext rtx +# text/rtf +# text/rtp-enc-aescm128 +# text/rtploopback +# text/rtx +text/sgml sgml sgm +# text/t140 +text/tab-separated-values tsv +text/troff t tr roff man me ms +text/turtle ttl +# text/ulpfec +text/uri-list uri uris urls +text/vcard vcard +# text/vnd.a +# text/vnd.abc +text/vnd.curl curl +text/vnd.curl.dcurl dcurl +text/vnd.curl.mcurl mcurl +text/vnd.curl.scurl scurl +# text/vnd.debian.copyright +# text/vnd.dmclientscript +text/vnd.dvb.subtitle sub +# text/vnd.esmertec.theme-descriptor +text/vnd.fly fly +text/vnd.fmi.flexstor flx +text/vnd.graphviz gv +text/vnd.in3d.3dml 3dml +text/vnd.in3d.spot spot +# text/vnd.iptc.newsml +# text/vnd.iptc.nitf +# text/vnd.latex-z +# text/vnd.motorola.reflex +# text/vnd.ms-mediapackage +# text/vnd.net2phone.commcenter.command +# text/vnd.radisys.msml-basic-layout +# text/vnd.si.uricatalogue +text/vnd.sun.j2me.app-descriptor jad +# text/vnd.trolltech.linguist +# text/vnd.wap.si +# text/vnd.wap.sl +text/vnd.wap.wml wml +text/vnd.wap.wmlscript wmls +text/x-asm s asm +text/x-c c cc cxx cpp h hh dic +text/x-fortran f for f77 f90 +text/x-java-source java +text/x-nfo nfo +text/x-opml opml +text/x-pascal p pas +text/x-setext etx +text/x-sfv sfv +text/x-uuencode uu +text/x-vcalendar vcs +text/x-vcard vcf +# text/xml +# text/xml-external-parsed-entity +# video/1d-interleaved-parityfec +video/3gpp 3gp +# video/3gpp-tt +video/3gpp2 3g2 +# video/bmpeg +# video/bt656 +# video/celb +# video/dv +# video/encaprtp +# video/example +video/h261 h261 +video/h263 h263 +# video/h263-1998 +# video/h263-2000 +video/h264 h264 +# video/h264-rcdo +# video/h264-svc +# video/h265 +# video/iso.segment +video/jpeg jpgv +# video/jpeg2000 +video/jpm jpm jpgm +video/mj2 mj2 mjp2 +# video/mp1s +# video/mp2p +# video/mp2t +video/mp4 mp4 mp4v mpg4 +# video/mp4v-es +video/mpeg mpeg mpg mpe m1v m2v +# video/mpeg4-generic +# video/mpv +# video/nv +video/ogg ogv +# video/parityfec +# video/pointer +video/quicktime qt mov +# video/raptorfec +# video/raw +# video/rtp-enc-aescm128 +# video/rtploopback +# video/rtx +# video/smpte292m +# video/ulpfec +# video/vc1 +# video/vnd.cctv +video/vnd.dece.hd uvh uvvh +video/vnd.dece.mobile uvm uvvm +# video/vnd.dece.mp4 +video/vnd.dece.pd uvp uvvp +video/vnd.dece.sd uvs uvvs +video/vnd.dece.video uvv uvvv +# video/vnd.directv.mpeg +# video/vnd.directv.mpeg-tts +# video/vnd.dlna.mpeg-tts +video/vnd.dvb.file dvb +video/vnd.fvt fvt +# video/vnd.hns.video +# video/vnd.iptvforum.1dparityfec-1010 +# video/vnd.iptvforum.1dparityfec-2005 +# video/vnd.iptvforum.2dparityfec-1010 +# video/vnd.iptvforum.2dparityfec-2005 +# video/vnd.iptvforum.ttsavc +# video/vnd.iptvforum.ttsmpeg2 +# video/vnd.motorola.video +# video/vnd.motorola.videop +video/vnd.mpegurl mxu m4u +video/vnd.ms-playready.media.pyv pyv +# video/vnd.nokia.interleaved-multimedia +# video/vnd.nokia.videovoip +# video/vnd.objectvideo +# video/vnd.radgamettools.bink +# video/vnd.radgamettools.smacker +# video/vnd.sealed.mpeg1 +# video/vnd.sealed.mpeg4 +# video/vnd.sealed.swf +# video/vnd.sealedmedia.softseal.mov +video/vnd.uvvu.mp4 uvu uvvu +video/vnd.vivo viv +# video/vp8 +video/webm webm +video/x-f4v f4v +video/x-fli fli +video/x-flv flv +video/x-m4v m4v +video/x-matroska mkv mk3d mks +video/x-mng mng +video/x-ms-asf asf asx +video/x-ms-vob vob +video/x-ms-wm wm +video/x-ms-wmv wmv +video/x-ms-wmx wmx +video/x-ms-wvx wvx +video/x-msvideo avi +video/x-sgi-movie movie +video/x-smv smv +x-conference/x-cooltalk ice diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItem.java b/client/src/test/java/org/apache/commons/fileupload2/FileItem.java new file mode 100644 index 0000000000..f9e27bcbac --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItem.java @@ -0,0 +1,202 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.UncheckedIOException; +import java.io.UnsupportedEncodingException; + +/** + *

This class represents a file or form item that was received within a + * {@code multipart/form-data} POST request. + * + *

After retrieving an instance of this class from a {@link + * FileUpload FileUpload} instance (see + * {@link org.apache.commons.fileupload2.servlet.ServletFileUpload + * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may + * either request all contents of the file at once using {@link #get()} or + * request an {@link InputStream InputStream} with + * {@link #getInputStream()} and process the file without attempting to load + * it into memory, which may come handy with large files. + * + *

While this interface does not extend + * {@code javax.activation.DataSource} per se (to avoid a seldom used + * dependency), several of the defined methods are specifically defined with + * the same signatures as methods in that interface. This allows an + * implementation of this interface to also implement + * {@code javax.activation.DataSource} with minimal additional work. + * + * @since 1.3 additionally implements FileItemHeadersSupport + */ +public interface FileItem extends FileItemHeadersSupport { + + // ------------------------------- Methods from javax.activation.DataSource + + /** + * Returns an {@link InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @return An {@link InputStream InputStream} that can be + * used to retrieve the contents of the file. + * @throws IOException if an error occurs. + */ + InputStream getInputStream() throws IOException; + + /** + * Returns the content type passed by the browser or {@code null} if + * not defined. + * + * @return The content type passed by the browser or {@code null} if + * not defined. + */ + String getContentType(); + + /** + * Returns the original file name in the client's file system, as provided by + * the browser (or other client software). In most cases, this will be the + * base file name, without path information. However, some clients, such as + * the Opera browser, do include path information. + * + * @return The original file name in the client's file system. + * @throws InvalidFileNameException The file name contains a NUL character, + * which might be an indicator of a security attack. If you intend to + * use the file name anyways, catch the exception and use + * InvalidFileNameException#getName(). + */ + String getName(); + + // ------------------------------------------------------- FileItem methods + + /** + * Provides a hint as to whether or not the file contents will be read + * from memory. + * + * @return {@code true} if the file contents will be read from memory; + * {@code false} otherwise. + */ + boolean isInMemory(); + + /** + * Returns the size of the file item. + * + * @return The size of the file item, in bytes. + */ + long getSize(); + + /** + * Returns the contents of the file item as an array of bytes. + * + * @return The contents of the file item as an array of bytes. + * @throws UncheckedIOException if an I/O error occurs + */ + byte[] get() throws UncheckedIOException; + + /** + * Returns the contents of the file item as a String, using the specified + * encoding. This method uses {@link #get()} to retrieve the + * contents of the item. + * + * @param encoding The character encoding to use. + * @return The contents of the item, as a string. + * @throws UnsupportedEncodingException if the requested character + * encoding is not available. + * @throws IOException if an I/O error occurs + */ + String getString(String encoding) throws UnsupportedEncodingException, IOException; + + /** + * Returns the contents of the file item as a String, using the default + * character encoding. This method uses {@link #get()} to retrieve the + * contents of the item. + * + * @return The contents of the item, as a string. + */ + String getString(); + + /** + * A convenience method to write an uploaded item to disk. The client code + * is not concerned with whether or not the item is stored in memory, or on + * disk in a temporary location. They just want to write the uploaded item + * to a file. + *

+ * This method is not guaranteed to succeed if called more than once for + * the same item. This allows a particular implementation to use, for + * example, file renaming, where possible, rather than copying all of the + * underlying data, thus gaining a significant performance benefit. + * + * @param file The {@code File} into which the uploaded item should + * be stored. + * @throws Exception if an error occurs. + */ + void write(File file) throws Exception; + + /** + * Deletes the underlying storage for a file item, including deleting any + * associated temporary disk file. Although this storage will be deleted + * automatically when the {@code FileItem} instance is garbage + * collected, this method can be used to ensure that this is done at an + * earlier time, thus preserving system resources. + */ + void delete(); + + /** + * Returns the name of the field in the multipart form corresponding to + * this file item. + * + * @return The name of the form field. + */ + String getFieldName(); + + /** + * Sets the field name used to reference this file item. + * + * @param name The name of the form field. + */ + void setFieldName(String name); + + /** + * Determines whether or not a {@code FileItem} instance represents + * a simple form field. + * + * @return {@code true} if the instance represents a simple form + * field; {@code false} if it represents an uploaded file. + */ + boolean isFormField(); + + /** + * Specifies whether or not a {@code FileItem} instance represents + * a simple form field. + * + * @param state {@code true} if the instance represents a simple form + * field; {@code false} if it represents an uploaded file. + */ + void setFormField(boolean state); + + /** + * Returns an {@link OutputStream OutputStream} that can + * be used for storing the contents of the file. + * + * @return An {@link OutputStream OutputStream} that can be used + * for storing the contents of the file. + * @throws IOException if an error occurs. + */ + OutputStream getOutputStream() throws IOException; + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItemFactory.java b/client/src/test/java/org/apache/commons/fileupload2/FileItemFactory.java new file mode 100644 index 0000000000..6ba1d1ecac --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItemFactory.java @@ -0,0 +1,45 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + *

A factory interface for creating {@link FileItem} instances. Factories + * can provide their own custom configuration, over and above that provided + * by the default file upload implementation.

+ */ +public interface FileItemFactory { + + /** + * Create a new {@link FileItem} instance from the supplied parameters and + * any local factory configuration. + * + * @param fieldName The name of the form field. + * @param contentType The content type of the form field. + * @param isFormField {@code true} if this is a plain form field; + * {@code false} otherwise. + * @param fileName The name of the uploaded file, if any, as supplied + * by the browser or other client. + * @return The newly created file item. + */ + FileItem createItem( + String fieldName, + String contentType, + boolean isFormField, + String fileName + ); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItemHeaders.java b/client/src/test/java/org/apache/commons/fileupload2/FileItemHeaders.java new file mode 100644 index 0000000000..2f9e7ceae1 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItemHeaders.java @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import java.util.Iterator; + +/** + *

This class provides support for accessing the headers for a file or form + * item that was received within a {@code multipart/form-data} POST + * request.

+ * + * @since 1.2.1 + */ +public interface FileItemHeaders { + + /** + * Returns the value of the specified part header as a {@code String}. + *

+ * If the part did not include a header of the specified name, this method + * return {@code null}. If there are multiple headers with the same + * name, this method returns the first header in the item. The header + * name is case insensitive. + * + * @param name a {@code String} specifying the header name + * @return a {@code String} containing the value of the requested + * header, or {@code null} if the item does not have a header + * of that name + */ + String getHeader(String name); + + /** + *

+ * Returns all the values of the specified item header as an + * {@code Iterator} of {@code String} objects. + *

+ *

+ * If the item did not include any headers of the specified name, this + * method returns an empty {@code Iterator}. The header name is + * case insensitive. + *

+ * + * @param name a {@code String} specifying the header name + * @return an {@code Iterator} containing the values of the + * requested header. If the item does not have any headers of + * that name, return an empty {@code Iterator} + */ + Iterator getHeaders(String name); + + /** + *

+ * Returns an {@code Iterator} of all the header names. + *

+ * + * @return an {@code Iterator} containing all of the names of + * headers provided with this file item. If the item does not have + * any headers return an empty {@code Iterator} + */ + Iterator getHeaderNames(); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItemHeadersSupport.java b/client/src/test/java/org/apache/commons/fileupload2/FileItemHeadersSupport.java new file mode 100644 index 0000000000..61b96007f6 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItemHeadersSupport.java @@ -0,0 +1,47 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + * Interface that will indicate that {@link FileItem} or {@link FileItemStream} + * implementations will accept the headers read for the item. + * + * @see FileItem + * @see FileItemStream + * @since 1.2.1 + */ +public interface FileItemHeadersSupport { + + /** + * Returns the collection of headers defined locally within this item. + * + * @return the {@link FileItemHeaders} present for this item. + */ + FileItemHeaders getHeaders(); + + /** + * Sets the headers read from within an item. Implementations of + * {@link FileItem} or {@link FileItemStream} should implement this + * interface to be able to get the raw headers found within the item + * header block. + * + * @param headers the instance that holds onto the headers + * for this instance. + */ + void setHeaders(FileItemHeaders headers); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItemIterator.java b/client/src/test/java/org/apache/commons/fileupload2/FileItemIterator.java new file mode 100644 index 0000000000..b3e1703f5c --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItemIterator.java @@ -0,0 +1,105 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import org.apache.commons.fileupload2.pub.FileSizeLimitExceededException; +import org.apache.commons.fileupload2.pub.SizeLimitExceededException; + +import java.io.IOException; +import java.util.List; + +/** + * An iterator, as returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}. + */ +public interface FileItemIterator { + /** + * Returns the maximum size of a single file. An {@link FileSizeLimitExceededException} + * will be thrown, if there is an uploaded file, which is exceeding this value. + * By default, this value will be copied from the {@link FileUploadBase#getFileSizeMax() + * FileUploadBase} object, however, the user may replace the default value with a + * request specific value by invoking {@link #setFileSizeMax(long)} on this object. + * + * @return The maximum size of a single, uploaded file. The value -1 indicates "unlimited". + */ + long getFileSizeMax(); + + /** + * Sets the maximum size of a single file. An {@link FileSizeLimitExceededException} + * will be thrown, if there is an uploaded file, which is exceeding this value. + * By default, this value will be copied from the {@link FileUploadBase#getFileSizeMax() + * FileUploadBase} object, however, the user may replace the default value with a + * request specific value by invoking {@link #setFileSizeMax(long)} on this object, so + * there is no need to configure it here. + * Note:Changing this value doesn't affect files, that have already been uploaded. + * + * @param pFileSizeMax The maximum size of a single, uploaded file. The value -1 indicates "unlimited". + */ + void setFileSizeMax(long pFileSizeMax); + + /** + * Returns the maximum size of the complete HTTP request. A {@link SizeLimitExceededException} + * will be thrown, if the HTTP request will exceed this value. + * By default, this value will be copied from the {@link FileUploadBase#getSizeMax() + * FileUploadBase} object, however, the user may replace the default value with a + * request specific value by invoking {@link #setSizeMax(long)} on this object. + * + * @return The maximum size of the complete HTTP request. The value -1 indicates "unlimited". + */ + long getSizeMax(); + + /** + * Returns the maximum size of the complete HTTP request. A {@link SizeLimitExceededException} + * will be thrown, if the HTTP request will exceed this value. + * By default, this value will be copied from the {@link FileUploadBase#getSizeMax() + * FileUploadBase} object, however, the user may replace the default value with a + * request specific value by invoking {@link #setSizeMax(long)} on this object. + * Note: Setting the maximum size on this object will work only, if the iterator is not + * yet initialized. In other words: If the methods {@link #hasNext()}, {@link #next()} have not + * yet been invoked. + * + * @param pSizeMax The maximum size of the complete HTTP request. The value -1 indicates "unlimited". + */ + void setSizeMax(long pSizeMax); + + /** + * Returns, whether another instance of {@link FileItemStream} + * is available. + * + * @return True, if one or more additional file items + * are available, otherwise false. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + */ + boolean hasNext() throws FileUploadException, IOException; + + /** + * Returns the next available {@link FileItemStream}. + * + * @return FileItemStream instance, which provides + * access to the next file item. + * @throws java.util.NoSuchElementException No more items are available. Use + * {@link #hasNext()} to prevent this exception. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + */ + FileItemStream next() throws FileUploadException, IOException; + + List getFileItems() throws FileUploadException, IOException; +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileItemStream.java b/client/src/test/java/org/apache/commons/fileupload2/FileItemStream.java new file mode 100644 index 0000000000..c72c832073 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileItemStream.java @@ -0,0 +1,102 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import java.io.IOException; +import java.io.InputStream; + +/** + *

This interface provides access to a file or form item that was + * received within a {@code multipart/form-data} POST request. + * The items contents are retrieved by calling {@link #openStream()}.

+ *

Instances of this class are created by accessing the + * iterator, returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}.

+ *

Note: There is an interaction between the iterator and + * its associated instances of {@link FileItemStream}: By invoking + * {@link java.util.Iterator#hasNext()} on the iterator, you discard all data, + * which hasn't been read so far from the previous data.

+ */ +public interface FileItemStream extends FileItemHeadersSupport { + + /** + * This exception is thrown, if an attempt is made to read + * data from the {@link InputStream}, which has been returned + * by {@link FileItemStream#openStream()}, after + * {@link java.util.Iterator#hasNext()} has been invoked on the + * iterator, which created the {@link FileItemStream}. + */ + class ItemSkippedException extends IOException { + + /** + * The exceptions serial version UID, which is being used + * when serializing an exception instance. + */ + private static final long serialVersionUID = -7280778431581963740L; + + } + + /** + * Creates an {@link InputStream}, which allows to read the + * items contents. + * + * @return The input stream, from which the items data may + * be read. + * @throws IllegalStateException The method was already invoked on + * this item. It is not possible to recreate the data stream. + * @throws IOException An I/O error occurred. + * @see ItemSkippedException + */ + InputStream openStream() throws IOException; + + /** + * Returns the content type passed by the browser or {@code null} if + * not defined. + * + * @return The content type passed by the browser or {@code null} if + * not defined. + */ + String getContentType(); + + /** + * Returns the original file name in the client's file system, as provided by + * the browser (or other client software). In most cases, this will be the + * base file name, without path information. However, some clients, such as + * the Opera browser, do include path information. + * + * @return The original file name in the client's file system. + */ + String getName(); + + /** + * Returns the name of the field in the multipart form corresponding to + * this file item. + * + * @return The name of the form field. + */ + String getFieldName(); + + /** + * Determines whether or not a {@code FileItem} instance represents + * a simple form field. + * + * @return {@code true} if the instance represents a simple form + * field; {@code false} if it represents an uploaded file. + */ + boolean isFormField(); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileUpload.java b/client/src/test/java/org/apache/commons/fileupload2/FileUpload.java new file mode 100644 index 0000000000..45a0312e13 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileUpload.java @@ -0,0 +1,90 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + *

High level API for processing file uploads.

+ * + *

This class handles multiple files per single HTML widget, sent using + * {@code multipart/mixed} encoding type, as specified by + * RFC 1867. Use {@link + * #parseRequest(RequestContext)} to acquire a list + * of {@link FileItem FileItems} associated + * with a given HTML widget.

+ * + *

How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.

+ */ +public class FileUpload + extends FileUploadBase { + + // ----------------------------------------------------------- Data members + + /** + * The factory to use to create new form items. + */ + private FileItemFactory fileItemFactory; + + // ----------------------------------------------------------- Constructors + + /** + * Constructs an uninitialized instance of this class. + *

+ * A factory must be + * configured, using {@code setFileItemFactory()}, before attempting + * to parse requests. + * + * @see #FileUpload(FileItemFactory) + */ + public FileUpload() { + } + + /** + * Constructs an instance of this class which uses the supplied factory to + * create {@code FileItem} instances. + * + * @param fileItemFactory The factory to use for creating file items. + * @see #FileUpload() + */ + public FileUpload(final FileItemFactory fileItemFactory) { + this.fileItemFactory = fileItemFactory; + } + + // ----------------------------------------------------- Property accessors + + /** + * Returns the factory class used when creating file items. + * + * @return The factory class for new file items. + */ + @Override + public FileItemFactory getFileItemFactory() { + return fileItemFactory; + } + + /** + * Sets the factory class to use when creating file items. + * + * @param factory The factory class for new file items. + */ + @Override + public void setFileItemFactory(final FileItemFactory factory) { + this.fileItemFactory = factory; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileUploadBase.java b/client/src/test/java/org/apache/commons/fileupload2/FileUploadBase.java new file mode 100644 index 0000000000..d375518eb7 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileUploadBase.java @@ -0,0 +1,651 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import org.apache.commons.fileupload2.impl.FileItemIteratorImpl; +import org.apache.commons.fileupload2.pub.FileUploadIOException; +import org.apache.commons.fileupload2.pub.IOFileUploadException; +import org.apache.commons.fileupload2.util.FileItemHeadersImpl; +import org.apache.commons.fileupload2.util.Streams; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; + +import static java.lang.String.format; + +/** + *

High level API for processing file uploads.

+ * + *

This class handles multiple files per single HTML widget, sent using + * {@code multipart/mixed} encoding type, as specified by + * RFC 1867. Use {@link + * #parseRequest(RequestContext)} to acquire a list of {@link + * FileItem}s associated with a given HTML + * widget.

+ * + *

How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.

+ */ +public abstract class FileUploadBase { + + // ---------------------------------------------------------- Class methods + + /** + *

Utility method that determines whether the request contains multipart + * content.

+ * + *

NOTE:This method will be moved to the + * {@code ServletFileUpload} class after the FileUpload 1.1 release. + * Unfortunately, since this method is static, it is not possible to + * provide its replacement until this method is removed.

+ * + * @param ctx The request context to be evaluated. Must be non-null. + * @return {@code true} if the request is multipart; + * {@code false} otherwise. + */ + public static final boolean isMultipartContent(final RequestContext ctx) { + final String contentType = ctx.getContentType(); + if (contentType == null) { + return false; + } + return contentType.toLowerCase(Locale.ENGLISH).startsWith(MULTIPART); + } + + // ----------------------------------------------------- Manifest constants + + /** + * HTTP content type header name. + */ + public static final String CONTENT_TYPE = "Content-type"; + + /** + * HTTP content disposition header name. + */ + public static final String CONTENT_DISPOSITION = "Content-disposition"; + + /** + * HTTP content length header name. + */ + public static final String CONTENT_LENGTH = "Content-length"; + + /** + * Content-disposition value for form data. + */ + public static final String FORM_DATA = "form-data"; + + /** + * Content-disposition value for file attachment. + */ + public static final String ATTACHMENT = "attachment"; + + /** + * Part of HTTP content type header. + */ + public static final String MULTIPART = "multipart/"; + + /** + * HTTP content type header for multipart forms. + */ + public static final String MULTIPART_FORM_DATA = "multipart/form-data"; + + /** + * HTTP content type header for multiple uploads. + */ + public static final String MULTIPART_MIXED = "multipart/mixed"; + + /** + * The maximum length of a single header line that will be parsed + * (1024 bytes). + * + * @deprecated This constant is no longer used. As of commons-fileupload + * 1.2, the only applicable limit is the total size of a parts headers, + * {@link MultipartStream#HEADER_PART_SIZE_MAX}. + */ + @Deprecated + public static final int MAX_HEADER_SIZE = 1024; + + // ----------------------------------------------------------- Data members + + /** + * The maximum size permitted for the complete request, as opposed to + * {@link #fileSizeMax}. A value of -1 indicates no maximum. + */ + private long sizeMax = -1; + + /** + * The maximum size permitted for a single uploaded file, as opposed + * to {@link #sizeMax}. A value of -1 indicates no maximum. + */ + private long fileSizeMax = -1; + + /** + * The content encoding to use when reading part headers. + */ + private String headerEncoding; + + /** + * The progress listener. + */ + private ProgressListener listener; + + // ----------------------------------------------------- Property accessors + + /** + * Returns the factory class used when creating file items. + * + * @return The factory class for new file items. + */ + public abstract FileItemFactory getFileItemFactory(); + + /** + * Sets the factory class to use when creating file items. + * + * @param factory The factory class for new file items. + */ + public abstract void setFileItemFactory(FileItemFactory factory); + + /** + * Returns the maximum allowed size of a complete request, as opposed + * to {@link #getFileSizeMax()}. + * + * @return The maximum allowed size, in bytes. The default value of + * -1 indicates, that there is no limit. + * @see #setSizeMax(long) + */ + public long getSizeMax() { + return sizeMax; + } + + /** + * Sets the maximum allowed size of a complete request, as opposed + * to {@link #setFileSizeMax(long)}. + * + * @param sizeMax The maximum allowed size, in bytes. The default value of + * -1 indicates, that there is no limit. + * @see #getSizeMax() + */ + public void setSizeMax(final long sizeMax) { + this.sizeMax = sizeMax; + } + + /** + * Returns the maximum allowed size of a single uploaded file, + * as opposed to {@link #getSizeMax()}. + * + * @return Maximum size of a single uploaded file. + * @see #setFileSizeMax(long) + */ + public long getFileSizeMax() { + return fileSizeMax; + } + + /** + * Sets the maximum allowed size of a single uploaded file, + * as opposed to {@link #getSizeMax()}. + * + * @param fileSizeMax Maximum size of a single uploaded file. + * @see #getFileSizeMax() + */ + public void setFileSizeMax(final long fileSizeMax) { + this.fileSizeMax = fileSizeMax; + } + + /** + * Retrieves the character encoding used when reading the headers of an + * individual part. When not specified, or {@code null}, the request + * encoding is used. If that is also not specified, or {@code null}, + * the platform default encoding is used. + * + * @return The encoding used to read part headers. + */ + public String getHeaderEncoding() { + return headerEncoding; + } + + /** + * Specifies the character encoding to be used when reading the headers of + * individual part. When not specified, or {@code null}, the request + * encoding is used. If that is also not specified, or {@code null}, + * the platform default encoding is used. + * + * @param encoding The encoding used to read part headers. + */ + public void setHeaderEncoding(final String encoding) { + headerEncoding = encoding; + } + + // --------------------------------------------------------- Public methods + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param ctx The context for the request to be parsed. + * @return An iterator to instances of {@code FileItemStream} + * parsed from the request, in the order that they were + * transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(final RequestContext ctx) + throws FileUploadException, IOException { + try { + return new FileItemIteratorImpl(this, ctx); + } catch (final FileUploadIOException e) { + // unwrap encapsulated SizeException + throw (FileUploadException) e.getCause(); + } + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param ctx The context for the request to be parsed. + * @return A list of {@code FileItem} instances parsed from the + * request, in the order that they were transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + */ + public List parseRequest(final RequestContext ctx) + throws FileUploadException { + final List items = new ArrayList<>(); + boolean successful = false; + try { + final FileItemIterator iter = getItemIterator(ctx); + final FileItemFactory fileItemFactory = Objects.requireNonNull(getFileItemFactory(), + "No FileItemFactory has been set."); + final byte[] buffer = new byte[Streams.DEFAULT_BUFFER_SIZE]; + while (iter.hasNext()) { + final FileItemStream item = iter.next(); + // Don't use getName() here to prevent an InvalidFileNameException. + final String fileName = item.getName(); + final FileItem fileItem = fileItemFactory.createItem(item.getFieldName(), item.getContentType(), + item.isFormField(), fileName); + items.add(fileItem); + try { + Streams.copy(item.openStream(), fileItem.getOutputStream(), true, buffer); + } catch (final FileUploadIOException e) { + throw (FileUploadException) e.getCause(); + } catch (final IOException e) { + throw new IOFileUploadException(format("Processing of %s request failed. %s", + MULTIPART_FORM_DATA, e.getMessage()), e); + } + final FileItemHeaders fih = item.getHeaders(); + fileItem.setHeaders(fih); + } + successful = true; + return items; + } catch (final FileUploadException e) { + throw e; + } catch (final IOException e) { + throw new FileUploadException(e.getMessage(), e); + } finally { + if (!successful) { + for (final FileItem fileItem : items) { + try { + fileItem.delete(); + } catch (final Exception ignored) { + // ignored TODO perhaps add to tracker delete failure list somehow? + } + } + } + } + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param ctx The context for the request to be parsed. + * @return A map of {@code FileItem} instances parsed from the request. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @since 1.3 + */ + public Map> parseParameterMap(final RequestContext ctx) + throws FileUploadException { + final List items = parseRequest(ctx); + final Map> itemsMap = new HashMap<>(items.size()); + + for (final FileItem fileItem : items) { + final String fieldName = fileItem.getFieldName(); + final List mappedItems = itemsMap.computeIfAbsent(fieldName, k -> new ArrayList<>()); + + mappedItems.add(fileItem); + } + + return itemsMap; + } + + // ------------------------------------------------------ Protected methods + + /** + * Retrieves the boundary from the {@code Content-type} header. + * + * @param contentType The value of the content type header from which to + * extract the boundary value. + * @return The boundary, as a byte array. + */ + public byte[] getBoundary(final String contentType) { + final ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + final Map params = parser.parse(contentType, new char[]{';', ','}); + final String boundaryStr = params.get("boundary"); + + if (boundaryStr == null) { + return null; + } + final byte[] boundary; + boundary = boundaryStr.getBytes(StandardCharsets.ISO_8859_1); + return boundary; + } + + /** + * Retrieves the file name from the {@code Content-disposition} + * header. + * + * @param headers A {@code Map} containing the HTTP request headers. + * @return The file name for the current {@code encapsulation}. + * @deprecated 1.2.1 Use {@link #getFileName(FileItemHeaders)}. + */ + @Deprecated + protected String getFileName(final Map headers) { + return getFileName(getHeader(headers, CONTENT_DISPOSITION)); + } + + /** + * Retrieves the file name from the {@code Content-disposition} + * header. + * + * @param headers The HTTP headers object. + * @return The file name for the current {@code encapsulation}. + */ + public String getFileName(final FileItemHeaders headers) { + return getFileName(headers.getHeader(CONTENT_DISPOSITION)); + } + + /** + * Returns the given content-disposition headers file name. + * + * @param pContentDisposition The content-disposition headers value. + * @return The file name + */ + private String getFileName(final String pContentDisposition) { + String fileName = null; + if (pContentDisposition != null) { + final String cdl = pContentDisposition.toLowerCase(Locale.ENGLISH); + if (cdl.startsWith(FORM_DATA) || cdl.startsWith(ATTACHMENT)) { + final ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + final Map params = parser.parse(pContentDisposition, ';'); + if (params.containsKey("filename")) { + fileName = params.get("filename"); + if (fileName != null) { + fileName = fileName.trim(); + } else { + // Even if there is no value, the parameter is present, + // so we return an empty file name rather than no file + // name. + fileName = ""; + } + } + } + } + return fileName; + } + + /** + * Retrieves the field name from the {@code Content-disposition} + * header. + * + * @param headers A {@code Map} containing the HTTP request headers. + * @return The field name for the current {@code encapsulation}. + */ + public String getFieldName(final FileItemHeaders headers) { + return getFieldName(headers.getHeader(CONTENT_DISPOSITION)); + } + + /** + * Returns the field name, which is given by the content-disposition + * header. + * + * @param pContentDisposition The content-dispositions header value. + * @return The field jake + */ + private String getFieldName(final String pContentDisposition) { + String fieldName = null; + if (pContentDisposition != null + && pContentDisposition.toLowerCase(Locale.ENGLISH).startsWith(FORM_DATA)) { + final ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + final Map params = parser.parse(pContentDisposition, ';'); + fieldName = params.get("name"); + if (fieldName != null) { + fieldName = fieldName.trim(); + } + } + return fieldName; + } + + /** + * Retrieves the field name from the {@code Content-disposition} + * header. + * + * @param headers A {@code Map} containing the HTTP request headers. + * @return The field name for the current {@code encapsulation}. + * @deprecated 1.2.1 Use {@link #getFieldName(FileItemHeaders)}. + */ + @Deprecated + protected String getFieldName(final Map headers) { + return getFieldName(getHeader(headers, CONTENT_DISPOSITION)); + } + + /** + * Creates a new {@link FileItem} instance. + * + * @param headers A {@code Map} containing the HTTP request + * headers. + * @param isFormField Whether or not this item is a form field, as + * opposed to a file. + * @return A newly created {@code FileItem} instance. + * @throws FileUploadException if an error occurs. + * @deprecated 1.2 This method is no longer used in favour of + * internally created instances of {@link FileItem}. + */ + @Deprecated + protected FileItem createItem(final Map headers, + final boolean isFormField) + throws FileUploadException { + return getFileItemFactory().createItem(getFieldName(headers), + getHeader(headers, CONTENT_TYPE), + isFormField, + getFileName(headers)); + } + + /** + *

Parses the {@code header-part} and returns as key/value + * pairs. + * + *

If there are multiple headers of the same names, the name + * will map to a comma-separated list containing the values. + * + * @param headerPart The {@code header-part} of the current + * {@code encapsulation}. + * @return A {@code Map} containing the parsed HTTP request headers. + */ + public FileItemHeaders getParsedHeaders(final String headerPart) { + final int len = headerPart.length(); + final FileItemHeadersImpl headers = newFileItemHeaders(); + int start = 0; + for (; ; ) { + int end = parseEndOfLine(headerPart, start); + if (start == end) { + break; + } + final StringBuilder header = new StringBuilder(headerPart.substring(start, end)); + start = end + 2; + while (start < len) { + int nonWs = start; + while (nonWs < len) { + final char c = headerPart.charAt(nonWs); + if (c != ' ' && c != '\t') { + break; + } + ++nonWs; + } + if (nonWs == start) { + break; + } + // Continuation line found + end = parseEndOfLine(headerPart, nonWs); + header.append(' ').append(headerPart, nonWs, end); + start = end + 2; + } + parseHeaderLine(headers, header.toString()); + } + return headers; + } + + /** + * Creates a new instance of {@link FileItemHeaders}. + * + * @return The new instance. + */ + protected FileItemHeadersImpl newFileItemHeaders() { + return new FileItemHeadersImpl(); + } + + /** + *

Parses the {@code header-part} and returns as key/value + * pairs. + * + *

If there are multiple headers of the same names, the name + * will map to a comma-separated list containing the values. + * + * @param headerPart The {@code header-part} of the current + * {@code encapsulation}. + * @return A {@code Map} containing the parsed HTTP request headers. + * @deprecated 1.2.1 Use {@link #getParsedHeaders(String)} + */ + @Deprecated + protected Map parseHeaders(final String headerPart) { + final FileItemHeaders headers = getParsedHeaders(headerPart); + final Map result = new HashMap<>(); + for (final Iterator iter = headers.getHeaderNames(); iter.hasNext(); ) { + final String headerName = iter.next(); + final Iterator iter2 = headers.getHeaders(headerName); + final StringBuilder headerValue = new StringBuilder(iter2.next()); + while (iter2.hasNext()) { + headerValue.append(",").append(iter2.next()); + } + result.put(headerName, headerValue.toString()); + } + return result; + } + + /** + * Skips bytes until the end of the current line. + * + * @param headerPart The headers, which are being parsed. + * @param end Index of the last byte, which has yet been + * processed. + * @return Index of the \r\n sequence, which indicates + * end of line. + */ + private int parseEndOfLine(final String headerPart, final int end) { + int index = end; + for (; ; ) { + final int offset = headerPart.indexOf('\r', index); + if (offset == -1 || offset + 1 >= headerPart.length()) { + throw new IllegalStateException( + "Expected headers to be terminated by an empty line."); + } + if (headerPart.charAt(offset + 1) == '\n') { + return offset; + } + index = offset + 1; + } + } + + /** + * Reads the next header line. + * + * @param headers String with all headers. + * @param header Map where to store the current header. + */ + private void parseHeaderLine(final FileItemHeadersImpl headers, final String header) { + final int colonOffset = header.indexOf(':'); + if (colonOffset == -1) { + // This header line is malformed, skip it. + return; + } + final String headerName = header.substring(0, colonOffset).trim(); + final String headerValue = + header.substring(colonOffset + 1).trim(); + headers.addHeader(headerName, headerValue); + } + + /** + * Returns the header with the specified name from the supplied map. The + * header lookup is case-insensitive. + * + * @param headers A {@code Map} containing the HTTP request headers. + * @param name The name of the header to return. + * @return The value of specified header, or a comma-separated list if + * there were multiple headers of that name. + * @deprecated 1.2.1 Use {@link FileItemHeaders#getHeader(String)}. + */ + @Deprecated + protected final String getHeader(final Map headers, + final String name) { + return headers.get(name.toLowerCase(Locale.ENGLISH)); + } + + /** + * Returns the progress listener. + * + * @return The progress listener, if any, or null. + */ + public ProgressListener getProgressListener() { + return listener; + } + + /** + * Sets the progress listener. + * + * @param pListener The progress listener, if any. Defaults to null. + */ + public void setProgressListener(final ProgressListener pListener) { + listener = pListener; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/FileUploadException.java b/client/src/test/java/org/apache/commons/fileupload2/FileUploadException.java new file mode 100644 index 0000000000..ba46272af8 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/FileUploadException.java @@ -0,0 +1,106 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import java.io.IOException; +import java.io.PrintStream; +import java.io.PrintWriter; + +/** + * Exception for errors encountered while processing the request. + */ +public class FileUploadException extends IOException { + + /** + * Serial version UID, being used, if the exception + * is serialized. + */ + private static final long serialVersionUID = 8881893724388807504L; + + /** + * The exceptions cause. We overwrite the cause of + * the super class, which isn't available in Java 1.3. + */ + private final Throwable cause; + + /** + * Constructs a new {@code FileUploadException} without message. + */ + public FileUploadException() { + this(null, null); + } + + /** + * Constructs a new {@code FileUploadException} with specified detail + * message. + * + * @param msg the error message. + */ + public FileUploadException(final String msg) { + this(msg, null); + } + + /** + * Creates a new {@code FileUploadException} with the given + * detail message and cause. + * + * @param msg The exceptions detail message. + * @param cause The exceptions cause. + */ + public FileUploadException(final String msg, final Throwable cause) { + super(msg); + this.cause = cause; + } + + /** + * Prints this throwable and its backtrace to the specified print stream. + * + * @param stream {@code PrintStream} to use for output + */ + @Override + public void printStackTrace(final PrintStream stream) { + super.printStackTrace(stream); + if (cause != null) { + stream.println("Caused by:"); + cause.printStackTrace(stream); + } + } + + /** + * Prints this throwable and its backtrace to the specified + * print writer. + * + * @param writer {@code PrintWriter} to use for output + */ + @Override + public void printStackTrace(final PrintWriter writer) { + super.printStackTrace(writer); + if (cause != null) { + writer.println("Caused by:"); + cause.printStackTrace(writer); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Throwable getCause() { + return cause; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/InvalidFileNameException.java b/client/src/test/java/org/apache/commons/fileupload2/InvalidFileNameException.java new file mode 100644 index 0000000000..3b940be1ef --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/InvalidFileNameException.java @@ -0,0 +1,62 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + * This exception is thrown in case of an invalid file name. + * A file name is invalid, if it contains a NUL character. + * Attackers might use this to circumvent security checks: + * For example, a malicious user might upload a file with the name + * "foo.exe\0.png". This file name might pass security checks (i.e. + * checks for the extension ".png"), while, depending on the underlying + * C library, it might create a file named "foo.exe", as the NUL + * character is the string terminator in C. + */ +public class InvalidFileNameException extends RuntimeException { + + /** + * Serial version UID, being used, if the exception + * is serialized. + */ + private static final long serialVersionUID = 7922042602454350470L; + + /** + * The file name causing the exception. + */ + private final String name; + + /** + * Creates a new instance. + * + * @param pName The file name causing the exception. + * @param pMessage A human readable error message. + */ + public InvalidFileNameException(final String pName, final String pMessage) { + super(pMessage); + name = pName; + } + + /** + * Returns the invalid file name. + * + * @return the invalid file name. + */ + public String getName() { + return name; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/MultipartStream.java b/client/src/test/java/org/apache/commons/fileupload2/MultipartStream.java new file mode 100644 index 0000000000..4198a37ba0 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/MultipartStream.java @@ -0,0 +1,1044 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import org.apache.commons.fileupload2.pub.FileUploadIOException; +import org.apache.commons.fileupload2.util.Closeable; +import org.apache.commons.fileupload2.util.Streams; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.UnsupportedEncodingException; + +import static java.lang.String.format; + +/** + *

Low level API for processing file uploads. + * + *

This class can be used to process data streams conforming to MIME + * 'multipart' format as defined in + * RFC 1867. Arbitrarily + * large amounts of data in the stream can be processed under constant + * memory usage. + * + *

The format of the stream is defined in the following way:
+ * + * + * multipart-body := preamble 1*encapsulation close-delimiter epilogue
+ * encapsulation := delimiter body CRLF
+ * delimiter := "--" boundary CRLF
+ * close-delimiter := "--" boundary "--"
+ * preamble := <ignore>
+ * epilogue := <ignore>
+ * body := header-part CRLF body-part
+ * header-part := 1*header CRLF
+ * header := header-name ":" header-value
+ * header-name := <printable ascii characters except ":">
+ * header-value := <any ascii characters except CR & LF>
+ * body-data := <arbitrary data>
+ *
+ * + *

Note that body-data can contain another mulipart entity. There + * is limited support for single pass processing of such nested + * streams. The nested stream is required to have a + * boundary token of the same length as the parent stream (see {@link + * #setBoundary(byte[])}). + * + *

Here is an example of usage of this class.
+ * + *

+ *   try {
+ *     MultipartStream multipartStream = new MultipartStream(input, boundary);
+ *     boolean nextPart = multipartStream.skipPreamble();
+ *     OutputStream output;
+ *     while(nextPart) {
+ *       String header = multipartStream.readHeaders();
+ *       // process headers
+ *       // create some output stream
+ *       multipartStream.readBodyData(output);
+ *       nextPart = multipartStream.readBoundary();
+ *     }
+ *   } catch(MultipartStream.MalformedStreamException e) {
+ *     // the stream failed to follow required syntax
+ *   } catch(IOException e) {
+ *     // a read or write error occurred
+ *   }
+ * 
+ */ +public class MultipartStream { + + /** + * Internal class, which is used to invoke the + * {@link ProgressListener}. + */ + public static class ProgressNotifier { + + /** + * The listener to invoke. + */ + private final ProgressListener listener; + + /** + * Number of expected bytes, if known, or -1. + */ + private final long contentLength; + + /** + * Number of bytes, which have been read so far. + */ + private long bytesRead; + + /** + * Number of items, which have been read so far. + */ + private int items; + + /** + * Creates a new instance with the given listener + * and content length. + * + * @param pListener The listener to invoke. + * @param pContentLength The expected content length. + */ + public ProgressNotifier(final ProgressListener pListener, final long pContentLength) { + listener = pListener; + contentLength = pContentLength; + } + + /** + * Called to indicate that bytes have been read. + * + * @param pBytes Number of bytes, which have been read. + */ + void noteBytesRead(final int pBytes) { + /* Indicates, that the given number of bytes have been read from + * the input stream. + */ + bytesRead += pBytes; + notifyListener(); + } + + /** + * Called to indicate, that a new file item has been detected. + */ + public void noteItem() { + ++items; + notifyListener(); + } + + /** + * Called for notifying the listener. + */ + private void notifyListener() { + if (listener != null) { + listener.update(bytesRead, contentLength, items); + } + } + + } + + // ----------------------------------------------------- Manifest constants + + /** + * The Carriage Return ASCII character value. + */ + public static final byte CR = 0x0D; + + /** + * The Line Feed ASCII character value. + */ + public static final byte LF = 0x0A; + + /** + * The dash (-) ASCII character value. + */ + public static final byte DASH = 0x2D; + + /** + * The maximum length of {@code header-part} that will be + * processed (10 kilobytes = 10240 bytes.). + */ + public static final int HEADER_PART_SIZE_MAX = 10240; + + /** + * The default length of the buffer used for processing a request. + */ + protected static final int DEFAULT_BUFSIZE = 4096; + + /** + * A byte sequence that marks the end of {@code header-part} + * ({@code CRLFCRLF}). + */ + protected static final byte[] HEADER_SEPARATOR = {CR, LF, CR, LF}; + + /** + * A byte sequence that that follows a delimiter that will be + * followed by an encapsulation ({@code CRLF}). + */ + protected static final byte[] FIELD_SEPARATOR = {CR, LF}; + + /** + * A byte sequence that that follows a delimiter of the last + * encapsulation in the stream ({@code --}). + */ + protected static final byte[] STREAM_TERMINATOR = {DASH, DASH}; + + /** + * A byte sequence that precedes a boundary ({@code CRLF--}). + */ + protected static final byte[] BOUNDARY_PREFIX = {CR, LF, DASH, DASH}; + + // ----------------------------------------------------------- Data members + + /** + * The input stream from which data is read. + */ + private final InputStream input; + + /** + * The length of the boundary token plus the leading {@code CRLF--}. + */ + private int boundaryLength; + + /** + * The amount of data, in bytes, that must be kept in the buffer in order + * to detect delimiters reliably. + */ + private final int keepRegion; + + /** + * The byte sequence that partitions the stream. + */ + private final byte[] boundary; + + /** + * The table for Knuth-Morris-Pratt search algorithm. + */ + private final int[] boundaryTable; + + /** + * The length of the buffer used for processing the request. + */ + private final int bufSize; + + /** + * The buffer used for processing the request. + */ + private final byte[] buffer; + + /** + * The index of first valid character in the buffer. + *
+ * 0 <= head < bufSize + */ + private int head; + + /** + * The index of last valid character in the buffer + 1. + *
+ * 0 <= tail <= bufSize + */ + private int tail; + + /** + * The content encoding to use when reading headers. + */ + private String headerEncoding; + + /** + * The progress notifier, if any, or null. + */ + private final ProgressNotifier notifier; + + // ----------------------------------------------------------- Constructors + + /** + * Creates a new instance. + * + * @deprecated 1.2.1 Use {@link #MultipartStream(InputStream, byte[], int, + * ProgressNotifier)} + */ + @Deprecated + public MultipartStream() { + this(null, null, null); + } + + /** + *

Constructs a {@code MultipartStream} with a custom size buffer + * and no progress notifier. + * + *

Note that the buffer must be at least big enough to contain the + * boundary string, plus 4 characters for CR/LF and double dash, plus at + * least one byte of data. Too small a buffer size setting will degrade + * performance. + * + * @param input The {@code InputStream} to serve as a data source. + * @param boundary The token used for dividing the stream into + * {@code encapsulations}. + * @param bufSize The size of the buffer to be used, in bytes. + * @deprecated 1.2.1 Use {@link #MultipartStream(InputStream, byte[], int, + * ProgressNotifier)}. + */ + @Deprecated + public MultipartStream(final InputStream input, final byte[] boundary, final int bufSize) { + this(input, boundary, bufSize, null); + } + + /** + *

Constructs a {@code MultipartStream} with a custom size buffer. + * + *

Note that the buffer must be at least big enough to contain the + * boundary string, plus 4 characters for CR/LF and double dash, plus at + * least one byte of data. Too small a buffer size setting will degrade + * performance. + * + * @param input The {@code InputStream} to serve as a data source. + * @param boundary The token used for dividing the stream into + * {@code encapsulations}. + * @param bufSize The size of the buffer to be used, in bytes. + * @param pNotifier The notifier, which is used for calling the + * progress listener, if any. + * @throws IllegalArgumentException If the buffer size is too small + * @since 1.3.1 + */ + public MultipartStream(final InputStream input, + final byte[] boundary, + final int bufSize, + final ProgressNotifier pNotifier) { + + if (boundary == null) { + throw new IllegalArgumentException("boundary may not be null"); + } + // We prepend CR/LF to the boundary to chop trailing CR/LF from + // body-data tokens. + this.boundaryLength = boundary.length + BOUNDARY_PREFIX.length; + if (bufSize < this.boundaryLength + 1) { + throw new IllegalArgumentException( + "The buffer size specified for the MultipartStream is too small"); + } + + this.input = input; + this.bufSize = Math.max(bufSize, boundaryLength * 2); + this.buffer = new byte[this.bufSize]; + this.notifier = pNotifier; + + this.boundary = new byte[this.boundaryLength]; + this.boundaryTable = new int[this.boundaryLength + 1]; + this.keepRegion = this.boundary.length; + + System.arraycopy(BOUNDARY_PREFIX, 0, this.boundary, 0, + BOUNDARY_PREFIX.length); + System.arraycopy(boundary, 0, this.boundary, BOUNDARY_PREFIX.length, + boundary.length); + computeBoundaryTable(); + + head = 0; + tail = 0; + } + + /** + *

Constructs a {@code MultipartStream} with a default size buffer. + * + * @param input The {@code InputStream} to serve as a data source. + * @param boundary The token used for dividing the stream into + * {@code encapsulations}. + * @param pNotifier An object for calling the progress listener, if any. + * @see #MultipartStream(InputStream, byte[], int, ProgressNotifier) + */ + public MultipartStream(final InputStream input, + final byte[] boundary, + final ProgressNotifier pNotifier) { + this(input, boundary, DEFAULT_BUFSIZE, pNotifier); + } + + /** + *

Constructs a {@code MultipartStream} with a default size buffer. + * + * @param input The {@code InputStream} to serve as a data source. + * @param boundary The token used for dividing the stream into + * {@code encapsulations}. + * @deprecated 1.2.1 Use {@link #MultipartStream(InputStream, byte[], int, + * ProgressNotifier)}. + */ + @Deprecated + public MultipartStream(final InputStream input, + final byte[] boundary) { + this(input, boundary, DEFAULT_BUFSIZE, null); + } + + // --------------------------------------------------------- Public methods + + /** + * Retrieves the character encoding used when reading the headers of an + * individual part. When not specified, or {@code null}, the platform + * default encoding is used. + * + * @return The encoding used to read part headers. + */ + public String getHeaderEncoding() { + return headerEncoding; + } + + /** + * Specifies the character encoding to be used when reading the headers of + * individual parts. When not specified, or {@code null}, the platform + * default encoding is used. + * + * @param encoding The encoding used to read part headers. + */ + public void setHeaderEncoding(final String encoding) { + headerEncoding = encoding; + } + + /** + * Reads a byte from the {@code buffer}, and refills it as + * necessary. + * + * @return The next byte from the input stream. + * @throws IOException if there is no more data available. + */ + public byte readByte() throws IOException { + // Buffer depleted ? + if (head == tail) { + head = 0; + // Refill. + tail = input.read(buffer, head, bufSize); + if (tail == -1) { + // No more data available. + throw new IOException("No more data is available"); + } + if (notifier != null) { + notifier.noteBytesRead(tail); + } + } + return buffer[head++]; + } + + /** + * Skips a {@code boundary} token, and checks whether more + * {@code encapsulations} are contained in the stream. + * + * @return {@code true} if there are more encapsulations in + * this stream; {@code false} otherwise. + * @throws FileUploadIOException if the bytes read from the stream exceeded the size limits + * @throws MalformedStreamException if the stream ends unexpectedly or + * fails to follow required syntax. + */ + public boolean readBoundary() + throws FileUploadIOException, MalformedStreamException { + final byte[] marker = new byte[2]; + final boolean nextChunk; + + head += boundaryLength; + try { + marker[0] = readByte(); + if (marker[0] == LF) { + // Work around IE5 Mac bug with input type=image. + // Because the boundary delimiter, not including the trailing + // CRLF, must not appear within any file (RFC 2046, section + // 5.1.1), we know the missing CR is due to a buggy browser + // rather than a file containing something similar to a + // boundary. + return true; + } + + marker[1] = readByte(); + if (arrayequals(marker, STREAM_TERMINATOR, 2)) { + nextChunk = false; + } else if (arrayequals(marker, FIELD_SEPARATOR, 2)) { + nextChunk = true; + } else { + throw new MalformedStreamException( + "Unexpected characters follow a boundary"); + } + } catch (final FileUploadIOException e) { + // wraps a SizeException, re-throw as it will be unwrapped later + throw e; + } catch (final IOException e) { + throw new MalformedStreamException("Stream ended unexpectedly"); + } + return nextChunk; + } + + /** + *

Changes the boundary token used for partitioning the stream. + * + *

This method allows single pass processing of nested multipart + * streams. + * + *

The boundary token of the nested stream is {@code required} + * to be of the same length as the boundary token in parent stream. + * + *

Restoring the parent stream boundary token after processing of a + * nested stream is left to the application. + * + * @param boundary The boundary to be used for parsing of the nested + * stream. + * @throws IllegalBoundaryException if the {@code boundary} + * has a different length than the one + * being currently parsed. + */ + public void setBoundary(final byte[] boundary) + throws IllegalBoundaryException { + if (boundary.length != boundaryLength - BOUNDARY_PREFIX.length) { + throw new IllegalBoundaryException( + "The length of a boundary token cannot be changed"); + } + System.arraycopy(boundary, 0, this.boundary, BOUNDARY_PREFIX.length, + boundary.length); + computeBoundaryTable(); + } + + /** + * Compute the table used for Knuth-Morris-Pratt search algorithm. + */ + private void computeBoundaryTable() { + int position = 2; + int candidate = 0; + + boundaryTable[0] = -1; + boundaryTable[1] = 0; + + while (position <= boundaryLength) { + if (boundary[position - 1] == boundary[candidate]) { + boundaryTable[position] = candidate + 1; + candidate++; + position++; + } else if (candidate > 0) { + candidate = boundaryTable[candidate]; + } else { + boundaryTable[position] = 0; + position++; + } + } + } + + /** + *

Reads the {@code header-part} of the current + * {@code encapsulation}. + * + *

Headers are returned verbatim to the input stream, including the + * trailing {@code CRLF} marker. Parsing is left to the + * application. + * + *

TODO allow limiting maximum header size to + * protect against abuse. + * + * @return The {@code header-part} of the current encapsulation. + * @throws FileUploadIOException if the bytes read from the stream exceeded the size limits. + * @throws MalformedStreamException if the stream ends unexpectedly. + */ + public String readHeaders() throws FileUploadIOException, MalformedStreamException { + int i = 0; + byte b; + // to support multi-byte characters + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + int size = 0; + while (i < HEADER_SEPARATOR.length) { + try { + b = readByte(); + } catch (final FileUploadIOException e) { + // wraps a SizeException, re-throw as it will be unwrapped later + throw e; + } catch (final IOException e) { + throw new MalformedStreamException("Stream ended unexpectedly"); + } + if (++size > HEADER_PART_SIZE_MAX) { + throw new MalformedStreamException( + format("Header section has more than %s bytes (maybe it is not properly terminated)", + HEADER_PART_SIZE_MAX)); + } + if (b == HEADER_SEPARATOR[i]) { + i++; + } else { + i = 0; + } + baos.write(b); + } + + String headers; + if (headerEncoding != null) { + try { + headers = baos.toString(headerEncoding); + } catch (final UnsupportedEncodingException e) { + // Fall back to platform default if specified encoding is not + // supported. + headers = baos.toString(); + } + } else { + headers = baos.toString(); + } + + return headers; + } + + /** + *

Reads {@code body-data} from the current + * {@code encapsulation} and writes its contents into the + * output {@code Stream}. + * + *

Arbitrary large amounts of data can be processed by this + * method using a constant size buffer. (see {@link + * #MultipartStream(InputStream, byte[], int, + * ProgressNotifier) constructor}). + * + * @param output The {@code Stream} to write data into. May + * be null, in which case this method is equivalent + * to {@link #discardBodyData()}. + * @return the amount of data written. + * @throws MalformedStreamException if the stream ends unexpectedly. + * @throws IOException if an i/o error occurs. + */ + public int readBodyData(final OutputStream output) + throws MalformedStreamException, IOException { + return (int) Streams.copy(newInputStream(), output, false); // N.B. Streams.copy closes the input stream + } + + /** + * Creates a new {@link ItemInputStream}. + * + * @return A new instance of {@link ItemInputStream}. + */ + public ItemInputStream newInputStream() { + return new ItemInputStream(); + } + + /** + *

Reads {@code body-data} from the current + * {@code encapsulation} and discards it. + * + *

Use this method to skip encapsulations you don't need or don't + * understand. + * + * @return The amount of data discarded. + * @throws MalformedStreamException if the stream ends unexpectedly. + * @throws IOException if an i/o error occurs. + */ + public int discardBodyData() throws MalformedStreamException, IOException { + return readBodyData(null); + } + + /** + * Finds the beginning of the first {@code encapsulation}. + * + * @return {@code true} if an {@code encapsulation} was found in + * the stream. + * @throws IOException if an i/o error occurs. + */ + public boolean skipPreamble() throws IOException { + // First delimiter may be not preceded with a CRLF. + System.arraycopy(boundary, 2, boundary, 0, boundary.length - 2); + boundaryLength = boundary.length - 2; + computeBoundaryTable(); + try { + // Discard all data up to the delimiter. + discardBodyData(); + + // Read boundary - if succeeded, the stream contains an + // encapsulation. + return readBoundary(); + } catch (final MalformedStreamException e) { + return false; + } finally { + // Restore delimiter. + System.arraycopy(boundary, 0, boundary, 2, boundary.length - 2); + boundaryLength = boundary.length; + boundary[0] = CR; + boundary[1] = LF; + computeBoundaryTable(); + } + } + + /** + * Compares {@code count} first bytes in the arrays + * {@code a} and {@code b}. + * + * @param a The first array to compare. + * @param b The second array to compare. + * @param count How many bytes should be compared. + * @return {@code true} if {@code count} first bytes in arrays + * {@code a} and {@code b} are equal. + */ + public static boolean arrayequals(final byte[] a, + final byte[] b, + final int count) { + for (int i = 0; i < count; i++) { + if (a[i] != b[i]) { + return false; + } + } + return true; + } + + /** + * Searches for a byte of specified value in the {@code buffer}, + * starting at the specified {@code position}. + * + * @param value The value to find. + * @param pos The starting position for searching. + * @return The position of byte found, counting from beginning of the + * {@code buffer}, or {@code -1} if not found. + */ + protected int findByte(final byte value, + final int pos) { + for (int i = pos; i < tail; i++) { + if (buffer[i] == value) { + return i; + } + } + + return -1; + } + + /** + * Searches for the {@code boundary} in the {@code buffer} + * region delimited by {@code head} and {@code tail}. + * + * @return The position of the boundary found, counting from the + * beginning of the {@code buffer}, or {@code -1} if + * not found. + */ + protected int findSeparator() { + + int bufferPos = this.head; + int tablePos = 0; + + while (bufferPos < this.tail) { + while (tablePos >= 0 && buffer[bufferPos] != boundary[tablePos]) { + tablePos = boundaryTable[tablePos]; + } + bufferPos++; + tablePos++; + if (tablePos == boundaryLength) { + return bufferPos - boundaryLength; + } + } + return -1; + } + + /** + * Thrown to indicate that the input stream fails to follow the + * required syntax. + */ + public static class MalformedStreamException extends IOException { + + /** + * The UID to use when serializing this instance. + */ + private static final long serialVersionUID = 6466926458059796677L; + + /** + * Constructs a {@code MalformedStreamException} with no + * detail message. + */ + public MalformedStreamException() { + } + + /** + * Constructs an {@code MalformedStreamException} with + * the specified detail message. + * + * @param message The detail message. + */ + public MalformedStreamException(final String message) { + super(message); + } + + } + + /** + * Thrown upon attempt of setting an invalid boundary token. + */ + public static class IllegalBoundaryException extends IOException { + + /** + * The UID to use when serializing this instance. + */ + private static final long serialVersionUID = -161533165102632918L; + + /** + * Constructs an {@code IllegalBoundaryException} with no + * detail message. + */ + public IllegalBoundaryException() { + } + + /** + * Constructs an {@code IllegalBoundaryException} with + * the specified detail message. + * + * @param message The detail message. + */ + public IllegalBoundaryException(final String message) { + super(message); + } + + } + + /** + * An {@link InputStream} for reading an items contents. + */ + public class ItemInputStream extends InputStream implements Closeable { + + /** + * The number of bytes, which have been read so far. + */ + private long total; + + /** + * The number of bytes, which must be hold, because + * they might be a part of the boundary. + */ + private int pad; + + /** + * The current offset in the buffer. + */ + private int pos; + + /** + * Whether the stream is already closed. + */ + private boolean closed; + + /** + * Creates a new instance. + */ + ItemInputStream() { + findSeparator(); + } + + /** + * Called for finding the separator. + */ + private void findSeparator() { + pos = MultipartStream.this.findSeparator(); + if (pos == -1) { + if (tail - head > keepRegion) { + pad = keepRegion; + } else { + pad = tail - head; + } + } + } + + /** + * Returns the number of bytes, which have been read + * by the stream. + * + * @return Number of bytes, which have been read so far. + */ + public long getBytesRead() { + return total; + } + + /** + * Returns the number of bytes, which are currently + * available, without blocking. + * + * @return Number of bytes in the buffer. + * @throws IOException An I/O error occurs. + */ + @Override + public int available() throws IOException { + if (pos == -1) { + return tail - head - pad; + } + return pos - head; + } + + /** + * Offset when converting negative bytes to integers. + */ + private static final int BYTE_POSITIVE_OFFSET = 256; + + /** + * Returns the next byte in the stream. + * + * @return The next byte in the stream, as a non-negative + * integer, or -1 for EOF. + * @throws IOException An I/O error occurred. + */ + @Override + public int read() throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + if (available() == 0 && makeAvailable() == 0) { + return -1; + } + ++total; + final int b = buffer[head++]; + if (b >= 0) { + return b; + } + return b + BYTE_POSITIVE_OFFSET; + } + + /** + * Reads bytes into the given buffer. + * + * @param b The destination buffer, where to write to. + * @param off Offset of the first byte in the buffer. + * @param len Maximum number of bytes to read. + * @return Number of bytes, which have been actually read, + * or -1 for EOF. + * @throws IOException An I/O error occurred. + */ + @Override + public int read(final byte[] b, final int off, final int len) throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + if (len == 0) { + return 0; + } + int res = available(); + if (res == 0) { + res = makeAvailable(); + if (res == 0) { + return -1; + } + } + res = Math.min(res, len); + System.arraycopy(buffer, head, b, off, res); + head += res; + total += res; + return res; + } + + /** + * Closes the input stream. + * + * @throws IOException An I/O error occurred. + */ + @Override + public void close() throws IOException { + close(false); + } + + /** + * Closes the input stream. + * + * @param pCloseUnderlying Whether to close the underlying stream + * (hard close) + * @throws IOException An I/O error occurred. + */ + public void close(final boolean pCloseUnderlying) throws IOException { + if (closed) { + return; + } + if (pCloseUnderlying) { + closed = true; + input.close(); + } else { + for (; ; ) { + int av = available(); + if (av == 0) { + av = makeAvailable(); + if (av == 0) { + break; + } + } + skip(av); + } + } + closed = true; + } + + /** + * Skips the given number of bytes. + * + * @param bytes Number of bytes to skip. + * @return The number of bytes, which have actually been + * skipped. + * @throws IOException An I/O error occurred. + */ + @Override + public long skip(final long bytes) throws IOException { + if (closed) { + throw new FileItemStream.ItemSkippedException(); + } + int av = available(); + if (av == 0) { + av = makeAvailable(); + if (av == 0) { + return 0; + } + } + final long res = Math.min(av, bytes); + head += res; + return res; + } + + /** + * Attempts to read more data. + * + * @return Number of available bytes + * @throws IOException An I/O error occurred. + */ + private int makeAvailable() throws IOException { + if (pos != -1) { + return 0; + } + + // Move the data to the beginning of the buffer. + total += tail - head - pad; + System.arraycopy(buffer, tail - pad, buffer, 0, pad); + + // Refill buffer with new data. + head = 0; + tail = pad; + + for (; ; ) { + final int bytesRead = input.read(buffer, tail, bufSize - tail); + if (bytesRead == -1) { + // The last pad amount is left in the buffer. + // Boundary can't be in there so signal an error + // condition. + final String msg = "Stream ended unexpectedly"; + throw new MalformedStreamException(msg); + } + if (notifier != null) { + notifier.noteBytesRead(bytesRead); + } + tail += bytesRead; + + findSeparator(); + final int av = available(); + + if (av > 0 || pos != -1) { + return av; + } + } + } + + /** + * Returns, whether the stream is closed. + * + * @return True, if the stream is closed, otherwise false. + */ + @Override + public boolean isClosed() { + return closed; + } + + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/ParameterParser.java b/client/src/test/java/org/apache/commons/fileupload2/ParameterParser.java new file mode 100644 index 0000000000..bd00a9a11b --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/ParameterParser.java @@ -0,0 +1,333 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import org.apache.commons.fileupload2.util.mime.MimeUtility; +import org.apache.commons.fileupload2.util.mime.RFC2231Utility; + +import java.io.UnsupportedEncodingException; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; + +/** + * A simple parser intended to parse sequences of name/value pairs. + *

+ * Parameter values are expected to be enclosed in quotes if they + * contain unsafe characters, such as '=' characters or separators. + * Parameter values are optional and can be omitted. + * + *

+ * {@code param1 = value; param2 = "anything goes; really"; param3} + *

+ */ +public class ParameterParser { + + /** + * String to be parsed. + */ + private char[] chars = null; + + /** + * Current position in the string. + */ + private int pos = 0; + + /** + * Maximum position in the string. + */ + private int len = 0; + + /** + * Start of a token. + */ + private int i1 = 0; + + /** + * End of a token. + */ + private int i2 = 0; + + /** + * Whether names stored in the map should be converted to lower case. + */ + private boolean lowerCaseNames = false; + + /** + * Default ParameterParser constructor. + */ + public ParameterParser() { + } + + /** + * Are there any characters left to parse? + * + * @return {@code true} if there are unparsed characters, + * {@code false} otherwise. + */ + private boolean hasChar() { + return this.pos < this.len; + } + + /** + * A helper method to process the parsed token. This method removes + * leading and trailing blanks as well as enclosing quotation marks, + * when necessary. + * + * @param quoted {@code true} if quotation marks are expected, + * {@code false} otherwise. + * @return the token + */ + private String getToken(final boolean quoted) { + // Trim leading white spaces + while ((i1 < i2) && (Character.isWhitespace(chars[i1]))) { + i1++; + } + // Trim trailing white spaces + while ((i2 > i1) && (Character.isWhitespace(chars[i2 - 1]))) { + i2--; + } + // Strip away quotation marks if necessary + if (quoted + && ((i2 - i1) >= 2) + && (chars[i1] == '"') + && (chars[i2 - 1] == '"')) { + i1++; + i2--; + } + String result = null; + if (i2 > i1) { + result = new String(chars, i1, i2 - i1); + } + return result; + } + + /** + * Tests if the given character is present in the array of characters. + * + * @param ch the character to test for presence in the array of characters + * @param charray the array of characters to test against + * @return {@code true} if the character is present in the array of + * characters, {@code false} otherwise. + */ + private boolean isOneOf(final char ch, final char[] charray) { + boolean result = false; + for (final char element : charray) { + if (ch == element) { + result = true; + break; + } + } + return result; + } + + /** + * Parses out a token until any of the given terminators + * is encountered. + * + * @param terminators the array of terminating characters. Any of these + * characters when encountered signify the end of the token + * @return the token + */ + private String parseToken(final char[] terminators) { + char ch; + i1 = pos; + i2 = pos; + while (hasChar()) { + ch = chars[pos]; + if (isOneOf(ch, terminators)) { + break; + } + i2++; + pos++; + } + return getToken(false); + } + + /** + * Parses out a token until any of the given terminators + * is encountered outside the quotation marks. + * + * @param terminators the array of terminating characters. Any of these + * characters when encountered outside the quotation marks signify the end + * of the token + * @return the token + */ + private String parseQuotedToken(final char[] terminators) { + char ch; + i1 = pos; + i2 = pos; + boolean quoted = false; + boolean charEscaped = false; + while (hasChar()) { + ch = chars[pos]; + if (!quoted && isOneOf(ch, terminators)) { + break; + } + if (!charEscaped && ch == '"') { + quoted = !quoted; + } + charEscaped = (!charEscaped && ch == '\\'); + i2++; + pos++; + + } + return getToken(true); + } + + /** + * Returns {@code true} if parameter names are to be converted to lower + * case when name/value pairs are parsed. + * + * @return {@code true} if parameter names are to be + * converted to lower case when name/value pairs are parsed. + * Otherwise returns {@code false} + */ + public boolean isLowerCaseNames() { + return this.lowerCaseNames; + } + + /** + * Sets the flag if parameter names are to be converted to lower case when + * name/value pairs are parsed. + * + * @param b {@code true} if parameter names are to be + * converted to lower case when name/value pairs are parsed. + * {@code false} otherwise. + */ + public void setLowerCaseNames(final boolean b) { + this.lowerCaseNames = b; + } + + /** + * Extracts a map of name/value pairs from the given string. Names are + * expected to be unique. Multiple separators may be specified and + * the earliest found in the input string is used. + * + * @param str the string that contains a sequence of name/value pairs + * @param separators the name/value pairs separators + * @return a map of name/value pairs + */ + public Map parse(final String str, final char[] separators) { + if (separators == null || separators.length == 0) { + return new HashMap<>(); + } + char separator = separators[0]; + if (str != null) { + int idx = str.length(); + for (final char separator2 : separators) { + final int tmp = str.indexOf(separator2); + if (tmp != -1 && tmp < idx) { + idx = tmp; + separator = separator2; + } + } + } + return parse(str, separator); + } + + /** + * Extracts a map of name/value pairs from the given string. Names are + * expected to be unique. + * + * @param str the string that contains a sequence of name/value pairs + * @param separator the name/value pairs separator + * @return a map of name/value pairs + */ + public Map parse(final String str, final char separator) { + if (str == null) { + return new HashMap<>(); + } + return parse(str.toCharArray(), separator); + } + + /** + * Extracts a map of name/value pairs from the given array of + * characters. Names are expected to be unique. + * + * @param charArray the array of characters that contains a sequence of + * name/value pairs + * @param separator the name/value pairs separator + * @return a map of name/value pairs + */ + public Map parse(final char[] charArray, final char separator) { + if (charArray == null) { + return new HashMap<>(); + } + return parse(charArray, 0, charArray.length, separator); + } + + /** + * Extracts a map of name/value pairs from the given array of + * characters. Names are expected to be unique. + * + * @param charArray the array of characters that contains a sequence of + * name/value pairs + * @param offset - the initial offset. + * @param length - the length. + * @param separator the name/value pairs separator + * @return a map of name/value pairs + */ + public Map parse( + final char[] charArray, + final int offset, + final int length, + final char separator) { + + if (charArray == null) { + return new HashMap<>(); + } + final HashMap params = new HashMap<>(); + this.chars = charArray.clone(); + this.pos = offset; + this.len = length; + + String paramName; + String paramValue; + while (hasChar()) { + paramName = parseToken(new char[]{ + '=', separator}); + paramValue = null; + if (hasChar() && (charArray[pos] == '=')) { + pos++; // skip '=' + paramValue = parseQuotedToken(new char[]{ + separator}); + + if (paramValue != null) { + try { + paramValue = RFC2231Utility.hasEncodedValue(paramName) ? RFC2231Utility.decodeText(paramValue) + : MimeUtility.decodeText(paramValue); + } catch (final UnsupportedEncodingException e) { + // let's keep the original value in this case + } + } + } + if (hasChar() && (charArray[pos] == separator)) { + pos++; // skip separator + } + if ((paramName != null) && !paramName.isEmpty()) { + paramName = RFC2231Utility.stripDelimiter(paramName); + if (this.lowerCaseNames) { + paramName = paramName.toLowerCase(Locale.ENGLISH); + } + params.put(paramName, paramValue); + } + } + return params; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/ProgressListener.java b/client/src/test/java/org/apache/commons/fileupload2/ProgressListener.java new file mode 100644 index 0000000000..7f33ec8f28 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/ProgressListener.java @@ -0,0 +1,37 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + * The {@link ProgressListener} may be used to display a progress bar + * or do stuff like that. + */ +public interface ProgressListener { + + /** + * Updates the listeners status information. + * + * @param pBytesRead The total number of bytes, which have been read + * so far. + * @param pContentLength The total number of bytes, which are being + * read. May be -1, if this number is unknown. + * @param pItems The number of the field, which is currently being + * read. (0 = no item so far, 1 = first item is being read, ...) + */ + void update(long pBytesRead, long pContentLength, int pItems); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/RequestContext.java b/client/src/test/java/org/apache/commons/fileupload2/RequestContext.java new file mode 100644 index 0000000000..8cb590faff --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/RequestContext.java @@ -0,0 +1,62 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +import java.io.IOException; +import java.io.InputStream; + +/** + *

Abstracts access to the request information needed for file uploads. This + * interface should be implemented for each type of request that may be + * handled by FileUpload, such as servlets and portlets.

+ * + * @since 1.1 + */ +public interface RequestContext { + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + String getCharacterEncoding(); + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + String getContentType(); + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @deprecated 1.3 Use {@link UploadContext#contentLength()} instead + */ + @Deprecated + int getContentLength(); + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * @throws IOException if a problem occurs. + */ + InputStream getInputStream() throws IOException; + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/UploadContext.java b/client/src/test/java/org/apache/commons/fileupload2/UploadContext.java new file mode 100644 index 0000000000..181ac7b1c9 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/UploadContext.java @@ -0,0 +1,39 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2; + +/** + * Enhanced access to the request information needed for file uploads, + * which fixes the Content Length data access in {@link RequestContext}. + *

+ * The reason of introducing this new interface is just for backward compatibility + * and it might vanish for a refactored 2.x version moving the new method into + * RequestContext again. + * + * @since 1.3 + */ +public interface UploadContext extends RequestContext { + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @since 1.3 + */ + long contentLength(); + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItem.java b/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItem.java new file mode 100644 index 0000000000..1f68478c3e --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItem.java @@ -0,0 +1,615 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.disk; + +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemHeaders; +import org.apache.commons.fileupload2.FileUploadException; +import org.apache.commons.fileupload2.ParameterParser; +import org.apache.commons.fileupload2.util.Streams; +import org.apache.commons.io.FileUtils; +import org.apache.commons.io.IOUtils; +import org.apache.commons.io.output.DeferredFileOutputStream; + +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.UncheckedIOException; +import java.io.UnsupportedEncodingException; +import java.nio.file.Files; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.atomic.AtomicInteger; + +import static java.lang.String.format; + +/** + *

The default implementation of the + * {@link FileItem FileItem} interface. + * + *

After retrieving an instance of this class from a {@link + * DiskFileItemFactory} instance (see + * {@link org.apache.commons.fileupload2.servlet.ServletFileUpload + * #parseRequest(javax.servlet.http.HttpServletRequest)}), you may + * either request all contents of file at once using {@link #get()} or + * request an {@link InputStream InputStream} with + * {@link #getInputStream()} and process the file without attempting to load + * it into memory, which may come handy with large files. + * + *

Temporary files, which are created for file items, should be + * deleted later on. The best way to do this is using a + * {@link org.apache.commons.io.FileCleaningTracker}, which you can set on the + * {@link DiskFileItemFactory}. However, if you do use such a tracker, + * then you must consider the following: Temporary files are automatically + * deleted as soon as they are no longer needed. (More precisely, when the + * corresponding instance of {@link File} is garbage collected.) + * This is done by the so-called reaper thread, which is started and stopped + * automatically by the {@link org.apache.commons.io.FileCleaningTracker} when + * there are files to be tracked. + * It might make sense to terminate that thread, for example, if + * your web application ends. See the section on "Resource cleanup" + * in the users guide of commons-fileupload.

+ * + * @since 1.1 + */ +public class DiskFileItem + implements FileItem { + + // ----------------------------------------------------- Manifest constants + + /** + * Default content charset to be used when no explicit charset + * parameter is provided by the sender. Media subtypes of the + * "text" type are defined to have a default charset value of + * "ISO-8859-1" when received via HTTP. + */ + public static final String DEFAULT_CHARSET = "ISO-8859-1"; + + // ----------------------------------------------------------- Data members + + /** + * UID used in unique file name generation. + */ + private static final String UID = + UUID.randomUUID().toString().replace('-', '_'); + + /** + * Counter used in unique identifier generation. + */ + private static final AtomicInteger COUNTER = new AtomicInteger(0); + + /** + * The name of the form field as provided by the browser. + */ + private String fieldName; + + /** + * The content type passed by the browser, or {@code null} if + * not defined. + */ + private final String contentType; + + /** + * Whether or not this item is a simple form field. + */ + private boolean isFormField; + + /** + * The original file name in the user's file system. + */ + private final String fileName; + + /** + * The size of the item, in bytes. This is used to cache the size when a + * file item is moved from its original location. + */ + private long size = -1; + + + /** + * The threshold above which uploads will be stored on disk. + */ + private final int sizeThreshold; + + /** + * The directory in which uploaded files will be stored, if stored on disk. + */ + private final File repository; + + /** + * Cached contents of the file. + */ + private byte[] cachedContent; + + /** + * Output stream for this item. + */ + private transient DeferredFileOutputStream dfos; + + /** + * The temporary file to use. + */ + private transient File tempFile; + + /** + * The file items headers. + */ + private FileItemHeaders headers; + + /** + * Default content charset to be used when no explicit charset + * parameter is provided by the sender. + */ + private String defaultCharset = DEFAULT_CHARSET; + + // ----------------------------------------------------------- Constructors + + /** + * Constructs a new {@code DiskFileItem} instance. + * + * @param fieldName The name of the form field. + * @param contentType The content type passed by the browser or + * {@code null} if not specified. + * @param isFormField Whether or not this item is a plain form field, as + * opposed to a file upload. + * @param fileName The original file name in the user's file system, or + * {@code null} if not specified. + * @param sizeThreshold The threshold, in bytes, below which items will be + * retained in memory and above which they will be + * stored as a file. + * @param repository The data repository, which is the directory in + * which files will be created, should the item size + * exceed the threshold. + */ + public DiskFileItem(final String fieldName, + final String contentType, final boolean isFormField, final String fileName, + final int sizeThreshold, final File repository) { + this.fieldName = fieldName; + this.contentType = contentType; + this.isFormField = isFormField; + this.fileName = fileName; + this.sizeThreshold = sizeThreshold; + this.repository = repository; + } + + // ------------------------------- Methods from javax.activation.DataSource + + /** + * Returns an {@link InputStream InputStream} that can be + * used to retrieve the contents of the file. + * + * @return An {@link InputStream InputStream} that can be + * used to retrieve the contents of the file. + * @throws IOException if an error occurs. + */ + @Override + public InputStream getInputStream() + throws IOException { + if (!isInMemory()) { + return Files.newInputStream(dfos.getFile().toPath()); + } + + if (cachedContent == null) { + cachedContent = dfos.getData(); + } + return new ByteArrayInputStream(cachedContent); + } + + /** + * Returns the content type passed by the agent or {@code null} if + * not defined. + * + * @return The content type passed by the agent or {@code null} if + * not defined. + */ + @Override + public String getContentType() { + return contentType; + } + + /** + * Returns the content charset passed by the agent or {@code null} if + * not defined. + * + * @return The content charset passed by the agent or {@code null} if + * not defined. + */ + public String getCharSet() { + final ParameterParser parser = new ParameterParser(); + parser.setLowerCaseNames(true); + // Parameter parser can handle null input + final Map params = parser.parse(getContentType(), ';'); + return params.get("charset"); + } + + /** + * Returns the original file name in the client's file system. + * + * @return The original file name in the client's file system. + * @throws org.apache.commons.fileupload2.InvalidFileNameException The file name contains a NUL character, + * which might be an indicator of a security attack. If you intend to + * use the file name anyways, catch the exception and use + * {@link org.apache.commons.fileupload2.InvalidFileNameException#getName()}. + */ + @Override + public String getName() { + return Streams.checkFileName(fileName); + } + + // ------------------------------------------------------- FileItem methods + + /** + * Provides a hint as to whether or not the file contents will be read + * from memory. + * + * @return {@code true} if the file contents will be read + * from memory; {@code false} otherwise. + */ + @Override + public boolean isInMemory() { + if (cachedContent != null) { + return true; + } + return dfos.isInMemory(); + } + + /** + * Returns the size of the file. + * + * @return The size of the file, in bytes. + */ + @Override + public long getSize() { + if (size >= 0) { + return size; + } + if (cachedContent != null) { + return cachedContent.length; + } + if (dfos.isInMemory()) { + return dfos.getData().length; + } + return dfos.getFile().length(); + } + + /** + * Returns the contents of the file as an array of bytes. If the + * contents of the file were not yet cached in memory, they will be + * loaded from the disk storage and cached. + * + * @return The contents of the file as an array of bytes + * or {@code null} if the data cannot be read + * @throws UncheckedIOException if an I/O error occurs + */ + @Override + public byte[] get() throws UncheckedIOException { + if (isInMemory()) { + if (cachedContent == null && dfos != null) { + cachedContent = dfos.getData(); + } + return cachedContent != null ? cachedContent.clone() : new byte[0]; + } + + final byte[] fileData = new byte[(int) getSize()]; + + try (InputStream fis = Files.newInputStream(dfos.getFile().toPath())) { + IOUtils.readFully(fis, fileData); + } catch (final IOException e) { + throw new UncheckedIOException(e); + } + return fileData; + } + + /** + * Returns the contents of the file as a String, using the specified + * encoding. This method uses {@link #get()} to retrieve the + * contents of the file. + * + * @param charset The charset to use. + * @return The contents of the file, as a string. + * @throws UnsupportedEncodingException if the requested character + * encoding is not available. + */ + @Override + public String getString(final String charset) + throws UnsupportedEncodingException, IOException { + return new String(get(), charset); + } + + /** + * Returns the contents of the file as a String, using the default + * character encoding. This method uses {@link #get()} to retrieve the + * contents of the file. + * + * TODO Consider making this method throw UnsupportedEncodingException. + * + * @return The contents of the file, as a string. + */ + @Override + public String getString() { + try { + final byte[] rawData = get(); + String charset = getCharSet(); + if (charset == null) { + charset = defaultCharset; + } + return new String(rawData, charset); + } catch (final IOException e) { + return ""; + } + } + + /** + * A convenience method to write an uploaded item to disk. The client code + * is not concerned with whether or not the item is stored in memory, or on + * disk in a temporary location. They just want to write the uploaded item + * to a file. + *

+ * This implementation first attempts to rename the uploaded item to the + * specified destination file, if the item was originally written to disk. + * Otherwise, the data will be copied to the specified file. + *

+ * This method is only guaranteed to work once, the first time it + * is invoked for a particular item. This is because, in the event that the + * method renames a temporary file, that file will no longer be available + * to copy or rename again at a later time. + * + * @param file The {@code File} into which the uploaded item should + * be stored. + * @throws Exception if an error occurs. + */ + @Override + public void write(final File file) throws Exception { + if (isInMemory()) { + try (OutputStream fout = Files.newOutputStream(file.toPath())) { + fout.write(get()); + } catch (final IOException e) { + throw new IOException("Unexpected output data"); + } + } else { + final File outputFile = getStoreLocation(); + if (outputFile == null) { + /* + * For whatever reason we cannot write the + * file to disk. + */ + throw new FileUploadException( + "Cannot write uploaded file to disk!"); + } + // Save the length of the file + size = outputFile.length(); + /* + * The uploaded file is being stored on disk + * in a temporary location so move it to the + * desired file. + */ + if (file.exists() && !file.delete()) { + throw new FileUploadException( + "Cannot write uploaded file to disk!"); + } + FileUtils.moveFile(outputFile, file); + } + } + + /** + * Deletes the underlying storage for a file item, including deleting any associated temporary disk file. + * This method can be used to ensure that this is done at an earlier time, thus preserving system resources. + */ + @Override + public void delete() { + cachedContent = null; + final File outputFile = getStoreLocation(); + if (outputFile != null && !isInMemory() && outputFile.exists()) { + if (!outputFile.delete()) { + final String desc = "Cannot delete " + outputFile.toString(); + throw new UncheckedIOException(desc, new IOException(desc)); + } + } + } + + /** + * Returns the name of the field in the multipart form corresponding to + * this file item. + * + * @return The name of the form field. + * @see #setFieldName(String) + */ + @Override + public String getFieldName() { + return fieldName; + } + + /** + * Sets the field name used to reference this file item. + * + * @param fieldName The name of the form field. + * @see #getFieldName() + */ + @Override + public void setFieldName(final String fieldName) { + this.fieldName = fieldName; + } + + /** + * Determines whether or not a {@code FileItem} instance represents + * a simple form field. + * + * @return {@code true} if the instance represents a simple form + * field; {@code false} if it represents an uploaded file. + * @see #setFormField(boolean) + */ + @Override + public boolean isFormField() { + return isFormField; + } + + /** + * Specifies whether or not a {@code FileItem} instance represents + * a simple form field. + * + * @param state {@code true} if the instance represents a simple form + * field; {@code false} if it represents an uploaded file. + * @see #isFormField() + */ + @Override + public void setFormField(final boolean state) { + isFormField = state; + } + + /** + * Returns an {@link OutputStream OutputStream} that can + * be used for storing the contents of the file. + * + * @return An {@link OutputStream OutputStream} that can be used + * for storing the contents of the file. + */ + @Override + public OutputStream getOutputStream() { + if (dfos == null) { + final File outputFile = getTempFile(); + dfos = new DeferredFileOutputStream(sizeThreshold, outputFile); + } + return dfos; + } + + // --------------------------------------------------------- Public methods + + /** + * Returns the {@link File} object for the {@code FileItem}'s + * data's temporary location on the disk. Note that for + * {@code FileItem}s that have their data stored in memory, + * this method will return {@code null}. When handling large + * files, you can use {@link File#renameTo(File)} to + * move the file to new location without copying the data, if the + * source and destination locations reside within the same logical + * volume. + * + * @return The data file, or {@code null} if the data is stored in + * memory. + */ + public File getStoreLocation() { + if (dfos == null) { + return null; + } + if (isInMemory()) { + return null; + } + return dfos.getFile(); + } + + // ------------------------------------------------------ Protected methods + + /** + * Creates and returns a {@link File File} representing a uniquely + * named temporary file in the configured repository path. The lifetime of + * the file is tied to the lifetime of the {@code FileItem} instance; + * the file will be deleted when the instance is garbage collected. + *

+ * Note: Subclasses that override this method must ensure that they return the + * same File each time. + * + * @return The {@link File File} to be used for temporary storage. + */ + protected File getTempFile() { + if (tempFile == null) { + File tempDir = repository; + if (tempDir == null) { + tempDir = new File(System.getProperty("java.io.tmpdir")); + } + + final String tempFileName = format("upload_%s_%s.tmp", UID, getUniqueId()); + + tempFile = new File(tempDir, tempFileName); + } + return tempFile; + } + + // -------------------------------------------------------- Private methods + + /** + * Returns an identifier that is unique within the class loader used to + * load this class, but does not have random-like appearance. + * + * @return A String with the non-random looking instance identifier. + */ + private static String getUniqueId() { + final int limit = 100000000; + final int current = COUNTER.getAndIncrement(); + String id = Integer.toString(current); + + // If you manage to get more than 100 million of ids, you'll + // start getting ids longer than 8 characters. + if (current < limit) { + id = ("00000000" + id).substring(id.length()); + } + return id; + } + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return format("name=%s, StoreLocation=%s, size=%s bytes, isFormField=%s, FieldName=%s", + getName(), getStoreLocation(), getSize(), + isFormField(), getFieldName()); + } + + /** + * Returns the file item headers. + * + * @return The file items headers. + */ + @Override + public FileItemHeaders getHeaders() { + return headers; + } + + /** + * Sets the file item headers. + * + * @param pHeaders The file items headers. + */ + @Override + public void setHeaders(final FileItemHeaders pHeaders) { + headers = pHeaders; + } + + /** + * Returns the default charset for use when no explicit charset + * parameter is provided by the sender. + * + * @return the default charset + */ + public String getDefaultCharset() { + return defaultCharset; + } + + /** + * Sets the default charset for use when no explicit charset + * parameter is provided by the sender. + * + * @param charset the default charset + */ + public void setDefaultCharset(final String charset) { + defaultCharset = charset; + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java b/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java new file mode 100644 index 0000000000..56d8154dee --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java @@ -0,0 +1,244 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.disk; + +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemFactory; +import org.apache.commons.io.FileCleaningTracker; + +import java.io.File; + +/** + *

The default {@link FileItemFactory} + * implementation. This implementation creates + * {@link FileItem} instances which keep their + * content either in memory, for smaller items, or in a temporary file on disk, + * for larger items. The size threshold, above which content will be stored on + * disk, is configurable, as is the directory in which temporary files will be + * created.

+ * + *

If not otherwise configured, the default configuration values are as + * follows:

+ *
    + *
  • Size threshold is 10KB.
  • + *
  • Repository is the system default temp directory, as returned by + * {@code System.getProperty("java.io.tmpdir")}.
  • + *
+ *

+ * NOTE: Files are created in the system default temp directory with + * predictable names. This means that a local attacker with write access to that + * directory can perform a TOUTOC attack to replace any uploaded file with a + * file of the attackers choice. The implications of this will depend on how the + * uploaded file is used but could be significant. When using this + * implementation in an environment with local, untrusted users, + * {@link #setRepository(File)} MUST be used to configure a repository location + * that is not publicly writable. In a Servlet container the location identified + * by the ServletContext attribute {@code javax.servlet.context.tempdir} + * may be used. + *

+ * + *

Temporary files, which are created for file items, should be + * deleted later on. The best way to do this is using a + * {@link FileCleaningTracker}, which you can set on the + * {@link DiskFileItemFactory}. However, if you do use such a tracker, + * then you must consider the following: Temporary files are automatically + * deleted as soon as they are no longer needed. (More precisely, when the + * corresponding instance of {@link File} is garbage collected.) + * This is done by the so-called reaper thread, which is started and stopped + * automatically by the {@link FileCleaningTracker} when there are files to be + * tracked. + * It might make sense to terminate that thread, for example, if + * your web application ends. See the section on "Resource cleanup" + * in the users guide of commons-fileupload.

+ * + * @since 1.1 + */ +public class DiskFileItemFactory implements FileItemFactory { + + // ----------------------------------------------------- Manifest constants + + /** + * The default threshold above which uploads will be stored on disk. + */ + public static final int DEFAULT_SIZE_THRESHOLD = 10240; + + // ----------------------------------------------------- Instance Variables + + /** + * The directory in which uploaded files will be stored, if stored on disk. + */ + private File repository; + + /** + * The threshold above which uploads will be stored on disk. + */ + private int sizeThreshold = DEFAULT_SIZE_THRESHOLD; + + /** + *

The instance of {@link FileCleaningTracker}, which is responsible + * for deleting temporary files.

+ *

May be null, if tracking files is not required.

+ */ + private FileCleaningTracker fileCleaningTracker; + + /** + * Default content charset to be used when no explicit charset + * parameter is provided by the sender. + */ + private String defaultCharset = DiskFileItem.DEFAULT_CHARSET; + + // ----------------------------------------------------------- Constructors + + /** + * Constructs an unconfigured instance of this class. The resulting factory + * may be configured by calling the appropriate setter methods. + */ + public DiskFileItemFactory() { + this(DEFAULT_SIZE_THRESHOLD, null); + } + + /** + * Constructs a preconfigured instance of this class. + * + * @param sizeThreshold The threshold, in bytes, below which items will be + * retained in memory and above which they will be + * stored as a file. + * @param repository The data repository, which is the directory in + * which files will be created, should the item size + * exceed the threshold. + */ + public DiskFileItemFactory(final int sizeThreshold, final File repository) { + this.sizeThreshold = sizeThreshold; + this.repository = repository; + } + + // ------------------------------------------------------------- Properties + + /** + * Returns the directory used to temporarily store files that are larger + * than the configured size threshold. + * + * @return The directory in which temporary files will be located. + * @see #setRepository(File) + */ + public File getRepository() { + return repository; + } + + /** + * Sets the directory used to temporarily store files that are larger + * than the configured size threshold. + * + * @param repository The directory in which temporary files will be located. + * @see #getRepository() + */ + public void setRepository(final File repository) { + this.repository = repository; + } + + /** + * Returns the size threshold beyond which files are written directly to + * disk. The default value is 10240 bytes. + * + * @return The size threshold, in bytes. + * @see #setSizeThreshold(int) + */ + public int getSizeThreshold() { + return sizeThreshold; + } + + /** + * Sets the size threshold beyond which files are written directly to disk. + * + * @param sizeThreshold The size threshold, in bytes. + * @see #getSizeThreshold() + */ + public void setSizeThreshold(final int sizeThreshold) { + this.sizeThreshold = sizeThreshold; + } + + // --------------------------------------------------------- Public Methods + + /** + * Create a new {@link DiskFileItem} + * instance from the supplied parameters and the local factory + * configuration. + * + * @param fieldName The name of the form field. + * @param contentType The content type of the form field. + * @param isFormField {@code true} if this is a plain form field; + * {@code false} otherwise. + * @param fileName The name of the uploaded file, if any, as supplied + * by the browser or other client. + * @return The newly created file item. + */ + @Override + public FileItem createItem(final String fieldName, final String contentType, + final boolean isFormField, final String fileName) { + final DiskFileItem result = new DiskFileItem(fieldName, contentType, + isFormField, fileName, sizeThreshold, repository); + result.setDefaultCharset(defaultCharset); + final FileCleaningTracker tracker = getFileCleaningTracker(); + if (tracker != null) { + tracker.track(result.getTempFile(), result); + } + return result; + } + + /** + * Returns the tracker, which is responsible for deleting temporary + * files. + * + * @return An instance of {@link FileCleaningTracker}, or null + * (default), if temporary files aren't tracked. + */ + public FileCleaningTracker getFileCleaningTracker() { + return fileCleaningTracker; + } + + /** + * Sets the tracker, which is responsible for deleting temporary + * files. + * + * @param pTracker An instance of {@link FileCleaningTracker}, + * which will from now on track the created files, or null + * (default), to disable tracking. + */ + public void setFileCleaningTracker(final FileCleaningTracker pTracker) { + fileCleaningTracker = pTracker; + } + + /** + * Returns the default charset for use when no explicit charset + * parameter is provided by the sender. + * + * @return the default charset + */ + public String getDefaultCharset() { + return defaultCharset; + } + + /** + * Sets the default charset for use when no explicit charset + * parameter is provided by the sender. + * + * @param pCharset the default charset + */ + public void setDefaultCharset(final String pCharset) { + defaultCharset = pCharset; + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/disk/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/disk/package-info.java new file mode 100644 index 0000000000..1d2caecb9b --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/disk/package-info.java @@ -0,0 +1,54 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + *

+ * A disk-based implementation of the + * {@link org.apache.commons.fileupload2.FileItem FileItem} + * interface. This implementation retains smaller items in memory, while + * writing larger ones to disk. The threshold between these two is + * configurable, as is the location of files that are written to disk. + *

+ *

+ * In typical usage, an instance of + * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory} + * would be created, configured, and then passed to a + * {@link org.apache.commons.fileupload2.FileUpload FileUpload} + * implementation such as + * {@link org.apache.commons.fileupload2.servlet.ServletFileUpload ServletFileUpload} + * or + * {@link org.apache.commons.fileupload2.portlet.PortletFileUpload PortletFileUpload}. + *

+ *

+ * The following code fragment demonstrates this usage. + *

+ *
+ *        DiskFileItemFactory factory = new DiskFileItemFactory();
+ *        // maximum size that will be stored in memory
+ *        factory.setSizeThreshold(4096);
+ *        // the location for saving data that is larger than getSizeThreshold()
+ *        factory.setRepository(new File("/tmp"));
+ *
+ *        ServletFileUpload upload = new ServletFileUpload(factory);
+ * 
+ *

+ * Please see the FileUpload + * User Guide + * for further details and examples of how to use this package. + *

+ */ +package org.apache.commons.fileupload2.disk; diff --git a/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemIteratorImpl.java b/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemIteratorImpl.java new file mode 100644 index 0000000000..bd29bb87f9 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemIteratorImpl.java @@ -0,0 +1,362 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.impl; + +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemHeaders; +import org.apache.commons.fileupload2.FileItemIterator; +import org.apache.commons.fileupload2.FileItemStream; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.FileUploadException; +import org.apache.commons.fileupload2.MultipartStream; +import org.apache.commons.fileupload2.ProgressListener; +import org.apache.commons.fileupload2.RequestContext; +import org.apache.commons.fileupload2.UploadContext; +import org.apache.commons.fileupload2.pub.FileUploadIOException; +import org.apache.commons.fileupload2.pub.InvalidContentTypeException; +import org.apache.commons.fileupload2.pub.SizeLimitExceededException; +import org.apache.commons.fileupload2.util.LimitedInputStream; +import org.apache.commons.io.IOUtils; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.NoSuchElementException; +import java.util.Objects; + +import static java.lang.String.format; + +/** + * The iterator, which is returned by + * {@link FileUploadBase#getItemIterator(RequestContext)}. + */ +public class FileItemIteratorImpl implements FileItemIterator { + /** + * The file uploads processing utility. + * + * @see FileUploadBase + */ + private final FileUploadBase fileUploadBase; + /** + * The request context. + * + * @see RequestContext + */ + private final RequestContext ctx; + /** + * The maximum allowed size of a complete request. + */ + private long sizeMax; + /** + * The maximum allowed size of a single uploaded file. + */ + private long fileSizeMax; + + + @Override + public long getSizeMax() { + return sizeMax; + } + + @Override + public void setSizeMax(final long sizeMax) { + this.sizeMax = sizeMax; + } + + @Override + public long getFileSizeMax() { + return fileSizeMax; + } + + @Override + public void setFileSizeMax(final long fileSizeMax) { + this.fileSizeMax = fileSizeMax; + } + + /** + * The multi part stream to process. + */ + private MultipartStream multiPartStream; + + /** + * The notifier, which used for triggering the + * {@link ProgressListener}. + */ + private MultipartStream.ProgressNotifier progressNotifier; + + /** + * The boundary, which separates the various parts. + */ + private byte[] multiPartBoundary; + + /** + * The item, which we currently process. + */ + private FileItemStreamImpl currentItem; + + /** + * The current items field name. + */ + private String currentFieldName; + + /** + * Whether we are currently skipping the preamble. + */ + private boolean skipPreamble; + + /** + * Whether the current item may still be read. + */ + private boolean itemValid; + + /** + * Whether we have seen the end of the file. + */ + private boolean eof; + + /** + * Creates a new instance. + * + * @param fileUploadBase Main processor. + * @param requestContext The request context. + * @throws FileUploadException An error occurred while + * parsing the request. + * @throws IOException An I/O error occurred. + */ + public FileItemIteratorImpl(final FileUploadBase fileUploadBase, final RequestContext requestContext) + throws FileUploadException, IOException { + this.fileUploadBase = fileUploadBase; + sizeMax = fileUploadBase.getSizeMax(); + fileSizeMax = fileUploadBase.getFileSizeMax(); + ctx = Objects.requireNonNull(requestContext, "requestContext"); + skipPreamble = true; + findNextItem(); + } + + protected void init(final FileUploadBase fileUploadBase, final RequestContext pRequestContext) + throws FileUploadException, IOException { + final String contentType = ctx.getContentType(); + if ((null == contentType) + || (!contentType.toLowerCase(Locale.ENGLISH).startsWith(FileUploadBase.MULTIPART))) { + throw new InvalidContentTypeException( + format("the request doesn't contain a %s or %s stream, content type header is %s", + FileUploadBase.MULTIPART_FORM_DATA, FileUploadBase.MULTIPART_MIXED, contentType)); + } + final long contentLengthInt = ((UploadContext) ctx).contentLength(); + final long requestSize = UploadContext.class.isAssignableFrom(ctx.getClass()) + // Inline conditional is OK here CHECKSTYLE:OFF + ? ((UploadContext) ctx).contentLength() + : contentLengthInt; + // CHECKSTYLE:ON + + final InputStream input; // N.B. this is eventually closed in MultipartStream processing + if (sizeMax >= 0) { + if (requestSize != -1 && requestSize > sizeMax) { + throw new SizeLimitExceededException( + format("the request was rejected because its size (%s) exceeds the configured maximum (%s)", + requestSize, sizeMax), + requestSize, sizeMax); + } + // N.B. this is eventually closed in MultipartStream processing + input = new LimitedInputStream(ctx.getInputStream(), sizeMax) { + @Override + protected void raiseError(final long pSizeMax, final long pCount) + throws IOException { + final FileUploadException ex = new SizeLimitExceededException( + format("the request was rejected because its size (%s) exceeds the configured maximum (%s)", + pCount, pSizeMax), + pCount, pSizeMax); + throw new FileUploadIOException(ex); + } + }; + } else { + input = ctx.getInputStream(); + } + + String charEncoding = fileUploadBase.getHeaderEncoding(); + if (charEncoding == null) { + charEncoding = ctx.getCharacterEncoding(); + } + + multiPartBoundary = fileUploadBase.getBoundary(contentType); + if (multiPartBoundary == null) { + IOUtils.closeQuietly(input); // avoid possible resource leak + throw new FileUploadException("the request was rejected because no multipart boundary was found"); + } + + progressNotifier = new MultipartStream.ProgressNotifier(fileUploadBase.getProgressListener(), requestSize); + try { + multiPartStream = new MultipartStream(input, multiPartBoundary, progressNotifier); + } catch (final IllegalArgumentException iae) { + IOUtils.closeQuietly(input); // avoid possible resource leak + throw new InvalidContentTypeException( + format("The boundary specified in the %s header is too long", FileUploadBase.CONTENT_TYPE), iae); + } + multiPartStream.setHeaderEncoding(charEncoding); + } + + public MultipartStream getMultiPartStream() throws FileUploadException, IOException { + if (multiPartStream == null) { + init(fileUploadBase, ctx); + } + return multiPartStream; + } + + /** + * Called for finding the next item, if any. + * + * @return True, if an next item was found, otherwise false. + * @throws IOException An I/O error occurred. + */ + private boolean findNextItem() throws FileUploadException, IOException { + if (eof) { + return false; + } + if (currentItem != null) { + currentItem.close(); + currentItem = null; + } + final MultipartStream multi = getMultiPartStream(); + for (; ; ) { + final boolean nextPart; + if (skipPreamble) { + nextPart = multi.skipPreamble(); + } else { + nextPart = multi.readBoundary(); + } + if (!nextPart) { + if (currentFieldName == null) { + // Outer multipart terminated -> No more data + eof = true; + return false; + } + // Inner multipart terminated -> Return to parsing the outer + multi.setBoundary(multiPartBoundary); + currentFieldName = null; + continue; + } + final FileItemHeaders headers = fileUploadBase.getParsedHeaders(multi.readHeaders()); + if (currentFieldName == null) { + // We're parsing the outer multipart + final String fieldName = fileUploadBase.getFieldName(headers); + if (fieldName != null) { + final String subContentType = headers.getHeader(FileUploadBase.CONTENT_TYPE); + if (subContentType != null + && subContentType.toLowerCase(Locale.ENGLISH) + .startsWith(FileUploadBase.MULTIPART_MIXED)) { + currentFieldName = fieldName; + // Multiple files associated with this field name + final byte[] subBoundary = fileUploadBase.getBoundary(subContentType); + multi.setBoundary(subBoundary); + skipPreamble = true; + continue; + } + final String fileName = fileUploadBase.getFileName(headers); + currentItem = new FileItemStreamImpl(this, fileName, + fieldName, headers.getHeader(FileUploadBase.CONTENT_TYPE), + fileName == null, getContentLength(headers)); + currentItem.setHeaders(headers); + progressNotifier.noteItem(); + itemValid = true; + return true; + } + } else { + final String fileName = fileUploadBase.getFileName(headers); + if (fileName != null) { + currentItem = new FileItemStreamImpl(this, fileName, + currentFieldName, + headers.getHeader(FileUploadBase.CONTENT_TYPE), + false, getContentLength(headers)); + currentItem.setHeaders(headers); + progressNotifier.noteItem(); + itemValid = true; + return true; + } + } + multi.discardBodyData(); + } + } + + private long getContentLength(final FileItemHeaders pHeaders) { + try { + return Long.parseLong(pHeaders.getHeader(FileUploadBase.CONTENT_LENGTH)); + } catch (final Exception e) { + return -1; + } + } + + /** + * Returns, whether another instance of {@link FileItemStream} + * is available. + * + * @return True, if one or more additional file items + * are available, otherwise false. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + */ + @Override + public boolean hasNext() throws FileUploadException, IOException { + if (eof) { + return false; + } + if (itemValid) { + return true; + } + try { + return findNextItem(); + } catch (final FileUploadIOException e) { + // unwrap encapsulated SizeException + throw (FileUploadException) e.getCause(); + } + } + + /** + * Returns the next available {@link FileItemStream}. + * + * @return FileItemStream instance, which provides + * access to the next file item. + * @throws NoSuchElementException No more items are + * available. Use {@link #hasNext()} to prevent this exception. + * @throws FileUploadException Parsing or processing the + * file item failed. + * @throws IOException Reading the file item failed. + */ + @Override + public FileItemStream next() throws FileUploadException, IOException { + if (eof || (!itemValid && !hasNext())) { + throw new NoSuchElementException(); + } + itemValid = false; + return currentItem; + } + + @Override + public List getFileItems() throws FileUploadException, IOException { + final List items = new ArrayList<>(); + while (hasNext()) { + final FileItemStream fis = next(); + final FileItem fi = fileUploadBase.getFileItemFactory().createItem(fis.getFieldName(), + fis.getContentType(), fis.isFormField(), fis.getName()); + items.add(fi); + } + return items; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemStreamImpl.java b/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemStreamImpl.java new file mode 100644 index 0000000000..4884b18f63 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/impl/FileItemStreamImpl.java @@ -0,0 +1,222 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.impl; + +import org.apache.commons.fileupload2.FileItemHeaders; +import org.apache.commons.fileupload2.FileItemStream; +import org.apache.commons.fileupload2.FileUploadException; +import org.apache.commons.fileupload2.InvalidFileNameException; +import org.apache.commons.fileupload2.MultipartStream.ItemInputStream; +import org.apache.commons.fileupload2.pub.FileSizeLimitExceededException; +import org.apache.commons.fileupload2.pub.FileUploadIOException; +import org.apache.commons.fileupload2.util.Closeable; +import org.apache.commons.fileupload2.util.LimitedInputStream; +import org.apache.commons.fileupload2.util.Streams; + +import java.io.IOException; +import java.io.InputStream; + +import static java.lang.String.format; + + +/** + * Default implementation of {@link FileItemStream}. + */ +public class FileItemStreamImpl implements FileItemStream { + /** + * The File Item iterator implementation. + * + * @see FileItemIteratorImpl + */ + private final FileItemIteratorImpl fileItemIteratorImpl; + + /** + * The file items content type. + */ + private final String contentType; + + /** + * The file items field name. + */ + private final String fieldName; + + /** + * The file items file name. + */ + private final String name; + + /** + * Whether the file item is a form field. + */ + private final boolean formField; + + /** + * The file items input stream. + */ + private final InputStream stream; + + /** + * The headers, if any. + */ + private FileItemHeaders headers; + + /** + * Creates a new instance. + * + * @param pFileItemIterator The {@link FileItemIteratorImpl iterator}, which returned this file + * item. + * @param pName The items file name, or null. + * @param pFieldName The items field name. + * @param pContentType The items content type, or null. + * @param pFormField Whether the item is a form field. + * @param pContentLength The items content length, if known, or -1 + * @throws IOException Creating the file item failed. + * @throws FileUploadException Parsing the incoming data stream failed. + */ + public FileItemStreamImpl(final FileItemIteratorImpl pFileItemIterator, final String pName, final String pFieldName, + final String pContentType, final boolean pFormField, + final long pContentLength) throws FileUploadException, IOException { + fileItemIteratorImpl = pFileItemIterator; + name = pName; + fieldName = pFieldName; + contentType = pContentType; + formField = pFormField; + final long fileSizeMax = fileItemIteratorImpl.getFileSizeMax(); + if (fileSizeMax != -1 && pContentLength != -1 + && pContentLength > fileSizeMax) { + final FileSizeLimitExceededException e = + new FileSizeLimitExceededException( + format("The field %s exceeds its maximum permitted size of %s bytes.", + fieldName, fileSizeMax), + pContentLength, fileSizeMax); + e.setFileName(pName); + e.setFieldName(pFieldName); + throw new FileUploadIOException(e); + } + // OK to construct stream now + final ItemInputStream itemStream = fileItemIteratorImpl.getMultiPartStream().newInputStream(); + InputStream istream = itemStream; + if (fileSizeMax != -1) { + istream = new LimitedInputStream(istream, fileSizeMax) { + @Override + protected void raiseError(final long pSizeMax, final long pCount) + throws IOException { + itemStream.close(true); + final FileSizeLimitExceededException e = + new FileSizeLimitExceededException( + format("The field %s exceeds its maximum permitted size of %s bytes.", + fieldName, pSizeMax), + pCount, pSizeMax); + e.setFieldName(fieldName); + e.setFileName(name); + throw new FileUploadIOException(e); + } + }; + } + stream = istream; + } + + /** + * Returns the items content type, or null. + * + * @return Content type, if known, or null. + */ + @Override + public String getContentType() { + return contentType; + } + + /** + * Returns the items field name. + * + * @return Field name. + */ + @Override + public String getFieldName() { + return fieldName; + } + + /** + * Returns the items file name. + * + * @return File name, if known, or null. + * @throws InvalidFileNameException The file name contains a NUL character, + * which might be an indicator of a security attack. If you intend to + * use the file name anyways, catch the exception and use + * InvalidFileNameException#getName(). + */ + @Override + public String getName() { + return Streams.checkFileName(name); + } + + /** + * Returns, whether this is a form field. + * + * @return True, if the item is a form field, + * otherwise false. + */ + @Override + public boolean isFormField() { + return formField; + } + + /** + * Returns an input stream, which may be used to + * read the items contents. + * + * @return Opened input stream. + * @throws IOException An I/O error occurred. + */ + @Override + public InputStream openStream() throws IOException { + if (((Closeable) stream).isClosed()) { + throw new ItemSkippedException(); + } + return stream; + } + + /** + * Closes the file item. + * + * @throws IOException An I/O error occurred. + */ + public void close() throws IOException { + stream.close(); + } + + /** + * Returns the file item headers. + * + * @return The items header object + */ + @Override + public FileItemHeaders getHeaders() { + return headers; + } + + /** + * Sets the file item headers. + * + * @param pHeaders The items header object + */ + @Override + public void setHeaders(final FileItemHeaders pHeaders) { + headers = pHeaders; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/impl/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/impl/package-info.java new file mode 100644 index 0000000000..93c87acb02 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/impl/package-info.java @@ -0,0 +1,21 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Implementations and exceptions utils. + */ +package org.apache.commons.fileupload2.impl; diff --git a/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileCleaner.java b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileCleaner.java new file mode 100644 index 0000000000..bc23460c5a --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileCleaner.java @@ -0,0 +1,88 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.jaksrvlt; + + +import jakarta.servlet.ServletContext; +import jakarta.servlet.ServletContextEvent; +import jakarta.servlet.ServletContextListener; +import org.apache.commons.io.FileCleaningTracker; + +/** + * A servlet context listener, which ensures that the + * {@link FileCleaningTracker}'s reaper thread is terminated, + * when the web application is destroyed. + */ +public class JakSrvltFileCleaner implements ServletContextListener { + + /** + * Attribute name, which is used for storing an instance of + * {@link FileCleaningTracker} in the web application. + */ + public static final String FILE_CLEANING_TRACKER_ATTRIBUTE + = JakSrvltFileCleaner.class.getName() + ".FileCleaningTracker"; + + /** + * Returns the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * + * @param pServletContext The servlet context to query + * @return The contexts tracker + */ + public static FileCleaningTracker + getFileCleaningTracker(final ServletContext pServletContext) { + return (FileCleaningTracker) + pServletContext.getAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE); + } + + /** + * Sets the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * + * @param pServletContext The servlet context to modify + * @param pTracker The tracker to set + */ + public static void setFileCleaningTracker(final ServletContext pServletContext, + final FileCleaningTracker pTracker) { + pServletContext.setAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE, pTracker); + } + + /** + * Called when the web application is initialized. Does + * nothing. + * + * @param sce The servlet context, used for calling + * {@link #setFileCleaningTracker(ServletContext, FileCleaningTracker)}. + */ + @Override + public void contextInitialized(final ServletContextEvent sce) { + setFileCleaningTracker(sce.getServletContext(), + new FileCleaningTracker()); + } + + /** + * Called when the web application is being destroyed. + * Calls {@link FileCleaningTracker#exitWhenFinished()}. + * + * @param sce The servlet context, used for calling + * {@link #getFileCleaningTracker(ServletContext)}. + */ + @Override + public void contextDestroyed(final ServletContextEvent sce) { + getFileCleaningTracker(sce.getServletContext()).exitWhenFinished(); + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java new file mode 100644 index 0000000000..dba4d8225c --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltFileUpload.java @@ -0,0 +1,143 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.jaksrvlt; + +import jakarta.servlet.http.HttpServletRequest; +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemFactory; +import org.apache.commons.fileupload2.FileItemIterator; +import org.apache.commons.fileupload2.FileUpload; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.FileUploadException; + +import java.io.IOException; +import java.util.List; +import java.util.Map; + +/** + *

High level API for processing file uploads.

+ * + *

This class handles multiple files per single HTML widget, sent using + * {@code multipart/mixed} encoding type, as specified by + * RFC 1867. Use {@link + * #parseRequest(HttpServletRequest)} to acquire a list of {@link + * FileItem}s associated with a given HTML + * widget.

+ * + *

How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.

+ */ +public class JakSrvltFileUpload extends FileUpload { + + /** + * Constant for HTTP POST method. + */ + private static final String POST_METHOD = "POST"; + + // ---------------------------------------------------------- Class methods + + /** + * Utility method that determines whether the request contains multipart + * content. + * + * @param request The servlet request to be evaluated. Must be non-null. + * @return {@code true} if the request is multipart; + * {@code false} otherwise. + */ + public static final boolean isMultipartContent( + final HttpServletRequest request) { + if (!POST_METHOD.equalsIgnoreCase(request.getMethod())) { + return false; + } + return FileUploadBase.isMultipartContent(new JakSrvltRequestContext(request)); + } + + // ----------------------------------------------------------- Constructors + + /** + * Constructs an uninitialized instance of this class. A factory must be + * configured, using {@code setFileItemFactory()}, before attempting + * to parse requests. + * + * @see FileUpload#FileUpload(FileItemFactory) + */ + public JakSrvltFileUpload() { + } + + /** + * Constructs an instance of this class which uses the supplied factory to + * create {@code FileItem} instances. + * + * @param fileItemFactory The factory to use for creating file items. + * @see FileUpload#FileUpload() + */ + public JakSrvltFileUpload(final FileItemFactory fileItemFactory) { + super(fileItemFactory); + } + + // --------------------------------------------------------- Public methods + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return A list of {@code FileItem} instances parsed from the + * request, in the order that they were transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + */ + public List parseRequest(final HttpServletRequest request) throws FileUploadException { + return parseRequest(new JakSrvltRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return A map of {@code FileItem} instances parsed from the request. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @since 1.3 + */ + public Map> parseParameterMap(final HttpServletRequest request) + throws FileUploadException { + return parseParameterMap(new JakSrvltRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return An iterator to instances of {@code FileItemStream} + * parsed from the request, in the order that they were + * transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(final HttpServletRequest request) + throws FileUploadException, IOException { + return super.getItemIterator(new JakSrvltRequestContext(request)); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java new file mode 100644 index 0000000000..8bbc50e958 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/JakSrvltRequestContext.java @@ -0,0 +1,128 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.jaksrvlt; + +import jakarta.servlet.http.HttpServletRequest; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.UploadContext; + +import java.io.IOException; +import java.io.InputStream; + +import static java.lang.String.format; + +/** + *

Provides access to the request information needed for a request made to + * an HTTP servlet.

+ * + * @since 1.1 + */ +public class JakSrvltRequestContext implements UploadContext { + + // ----------------------------------------------------- Instance Variables + + /** + * The request for which the context is being provided. + */ + private final HttpServletRequest request; + + // ----------------------------------------------------------- Constructors + + /** + * Construct a context for this request. + * + * @param request The request to which this context applies. + */ + public JakSrvltRequestContext(final HttpServletRequest request) { + this.request = request; + } + + // --------------------------------------------------------- Public Methods + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + @Override + public String getCharacterEncoding() { + return request.getCharacterEncoding(); + } + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + @Override + public String getContentType() { + return request.getContentType(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @deprecated 1.3 Use {@link #contentLength()} instead + */ + @Override + @Deprecated + public int getContentLength() { + return request.getContentLength(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @since 1.3 + */ + @Override + public long contentLength() { + long size; + try { + size = Long.parseLong(request.getHeader(FileUploadBase.CONTENT_LENGTH)); + } catch (final NumberFormatException e) { + size = request.getContentLength(); + } + return size; + } + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * @throws IOException if a problem occurs. + */ + @Override + public InputStream getInputStream() throws IOException { + return request.getInputStream(); + } + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return format("ContentLength=%s, ContentType=%s", + this.contentLength(), + this.getContentType()); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/package-info.java new file mode 100644 index 0000000000..796830f623 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/jaksrvlt/package-info.java @@ -0,0 +1,41 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + *

+ * An implementation of + * {@link org.apache.commons.fileupload2.FileUpload FileUpload} + * for use in servlets conforming to the namespace {@code jakarta.servlet}. + * + *

+ *

+ * The following code fragment demonstrates typical usage. + *

+ *
+ *        DiskFileItemFactory factory = new DiskFileItemFactory();
+ *        // Configure the factory here, if desired.
+ *        JakSrvltFileUpload upload = new JakSrvltFileUpload(factory);
+ *        // Configure the uploader here, if desired.
+ *        List fileItems = upload.parseRequest(request);
+ * 
+ *

+ * Please see the FileUpload + * User Guide + * for further details and examples of how to use this package. + *

+ */ +package org.apache.commons.fileupload2.jaksrvlt; diff --git a/client/src/test/java/org/apache/commons/fileupload2/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/package-info.java new file mode 100644 index 0000000000..e91d991abf --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/package-info.java @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + *

+ * A component for handling HTML file uploads as specified by + * RFC 1867. + * This component provides support for uploads within both servlets (JSR 53) + * and portlets (JSR 168). + *

+ *

+ * While this package provides the generic functionality for file uploads, + * these classes are not typically used directly. Instead, normal usage + * involves one of the provided extensions of + * {@link org.apache.commons.fileupload2.FileUpload FileUpload} such as + * {@link org.apache.commons.fileupload2.servlet.ServletFileUpload ServletFileUpload} + * or + * {@link org.apache.commons.fileupload2.portlet.PortletFileUpload PortletFileUpload}, + * together with a factory for + * {@link org.apache.commons.fileupload2.FileItem FileItem} instances, + * such as + * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}. + *

+ *

+ * The following is a brief example of typical usage in a servlet, storing + * the uploaded files on disk. + *

+ *
public void doPost(HttpServletRequest req, HttpServletResponse res) {
+ *   DiskFileItemFactory factory = new DiskFileItemFactory();
+ *   // maximum size that will be stored in memory
+ *   factory.setSizeThreshold(4096);
+ *   // the location for saving data that is larger than getSizeThreshold()
+ *   factory.setRepository(new File("/tmp"));
+ *
+ *   ServletFileUpload upload = new ServletFileUpload(factory);
+ *   // maximum size before a FileUploadException will be thrown
+ *   upload.setSizeMax(1000000);
+ *
+ *   List fileItems = upload.parseRequest(req);
+ *   // assume we know there are two files. The first file is a small
+ *   // text file, the second is unknown and is written to a file on
+ *   // the server
+ *   Iterator i = fileItems.iterator();
+ *   String comment = ((FileItem)i.next()).getString();
+ *   FileItem fi = (FileItem)i.next();
+ *   // file name on the client
+ *   String fileName = fi.getName();
+ *   // save comment and file name to database
+ *   ...
+ *   // write the file
+ *   fi.write(new File("/www/uploads/", fileName));
+ * }
+ * 
+ *

+ * In the example above, the first file is loaded into memory as a + * {@code String}. Before calling the {@code getString} method, + * the data may have been in memory or on disk depending on its size. The + * second file we assume it will be large and therefore never explicitly + * load it into memory, though if it is less than 4096 bytes it will be + * in memory before it is written to its final location. When writing to + * the final location, if the data is larger than the threshold, an attempt + * is made to rename the temporary file to the given location. If it cannot + * be renamed, it is streamed to the new location. + *

+ *

+ * Please see the FileUpload + * User Guide + * for further details and examples of how to use this package. + *

+ */ +package org.apache.commons.fileupload2; diff --git a/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java b/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java new file mode 100644 index 0000000000..cc59fe92ef --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletFileUpload.java @@ -0,0 +1,134 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.portlet; + +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemFactory; +import org.apache.commons.fileupload2.FileItemIterator; +import org.apache.commons.fileupload2.FileUpload; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.FileUploadException; + +import javax.portlet.ActionRequest; +import java.io.IOException; +import java.util.List; +import java.util.Map; + +/** + *

High level API for processing file uploads.

+ * + *

This class handles multiple files per single HTML widget, sent using + * {@code multipart/mixed} encoding type, as specified by + * RFC 1867. Use + * {@link org.apache.commons.fileupload2.servlet.ServletFileUpload + * #parseRequest(javax.servlet.http.HttpServletRequest)} to acquire a list + * of {@link FileItem FileItems} associated + * with a given HTML widget.

+ * + *

How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.

+ * + * @since 1.1 + */ +public class PortletFileUpload extends FileUpload { + + // ---------------------------------------------------------- Class methods + + /** + * Utility method that determines whether the request contains multipart + * content. + * + * @param request The portlet request to be evaluated. Must be non-null. + * @return {@code true} if the request is multipart; + * {@code false} otherwise. + */ + public static final boolean isMultipartContent(final ActionRequest request) { + return FileUploadBase.isMultipartContent(new PortletRequestContext(request)); + } + + // ----------------------------------------------------------- Constructors + + /** + * Constructs an uninitialized instance of this class. A factory must be + * configured, using {@code setFileItemFactory()}, before attempting + * to parse requests. + * + * @see FileUpload#FileUpload(FileItemFactory) + */ + public PortletFileUpload() { + } + + /** + * Constructs an instance of this class which uses the supplied factory to + * create {@code FileItem} instances. + * + * @param fileItemFactory The factory to use for creating file items. + * @see FileUpload#FileUpload() + */ + public PortletFileUpload(final FileItemFactory fileItemFactory) { + super(fileItemFactory); + } + + // --------------------------------------------------------- Public methods + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The portlet request to be parsed. + * @return A list of {@code FileItem} instances parsed from the + * request, in the order that they were transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + */ + public List parseRequest(final ActionRequest request) throws FileUploadException { + return parseRequest(new PortletRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The portlet request to be parsed. + * @return A map of {@code FileItem} instances parsed from the request. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @since 1.3 + */ + public Map> parseParameterMap(final ActionRequest request) throws FileUploadException { + return parseParameterMap(new PortletRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The portlet request to be parsed. + * @return An iterator to instances of {@code FileItemStream} + * parsed from the request, in the order that they were + * transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(final ActionRequest request) throws FileUploadException, IOException { + return super.getItemIterator(new PortletRequestContext(request)); + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletRequestContext.java b/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletRequestContext.java new file mode 100644 index 0000000000..2beba44b0e --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/portlet/PortletRequestContext.java @@ -0,0 +1,130 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.portlet; + +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.UploadContext; + +import javax.portlet.ActionRequest; +import java.io.IOException; +import java.io.InputStream; + +import static java.lang.String.format; + +/** + *

Provides access to the request information needed for a request made to + * a portlet.

+ * + * @since 1.1 + */ +public class PortletRequestContext implements UploadContext { + + // ----------------------------------------------------- Instance Variables + + /** + * The request for which the context is being provided. + */ + private final ActionRequest request; + + + // ----------------------------------------------------------- Constructors + + /** + * Construct a context for this request. + * + * @param request The request to which this context applies. + */ + public PortletRequestContext(final ActionRequest request) { + this.request = request; + } + + + // --------------------------------------------------------- Public Methods + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + @Override + public String getCharacterEncoding() { + return request.getCharacterEncoding(); + } + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + @Override + public String getContentType() { + return request.getContentType(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @deprecated 1.3 Use {@link #contentLength()} instead + */ + @Override + @Deprecated + public int getContentLength() { + return request.getContentLength(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @since 1.3 + */ + @Override + public long contentLength() { + long size; + try { + size = Long.parseLong(request.getProperty(FileUploadBase.CONTENT_LENGTH)); + } catch (final NumberFormatException e) { + size = request.getContentLength(); + } + return size; + } + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * @throws IOException if a problem occurs. + */ + @Override + public InputStream getInputStream() throws IOException { + return request.getPortletInputStream(); + } + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return format("ContentLength=%s, ContentType=%s", + this.contentLength(), + this.getContentType()); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/portlet/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/portlet/package-info.java new file mode 100644 index 0000000000..d5c2c3bfea --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/portlet/package-info.java @@ -0,0 +1,45 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + *

+ * An implementation of + * {@link org.apache.commons.fileupload2.FileUpload FileUpload} + * for use in portlets conforming to JSR 168. This implementation requires + * only access to the portlet's current {@code ActionRequest} instance, + * and a suitable + * {@link org.apache.commons.fileupload2.FileItemFactory FileItemFactory} + * implementation, such as + * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}. + *

+ *

+ * The following code fragment demonstrates typical usage. + *

+ *
+ *        DiskFileItemFactory factory = new DiskFileItemFactory();
+ *        // Configure the factory here, if desired.
+ *        PortletFileUpload upload = new PortletFileUpload(factory);
+ *        // Configure the uploader here, if desired.
+ *        List fileItems = upload.parseRequest(request);
+ * 
+ *

+ * Please see the FileUpload + * User Guide + * for further details and examples of how to use this package. + *

+ */ +package org.apache.commons.fileupload2.portlet; diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/FileSizeLimitExceededException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/FileSizeLimitExceededException.java new file mode 100644 index 0000000000..b87b8dc5e7 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/FileSizeLimitExceededException.java @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +/** + * Thrown to indicate that A files size exceeds the configured maximum. + */ +public class FileSizeLimitExceededException + extends SizeException { + + /** + * The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = 8150776562029630058L; + + /** + * File name of the item, which caused the exception. + */ + private String fileName; + + /** + * Field name of the item, which caused the exception. + */ + private String fieldName; + + /** + * Constructs a {@code SizeExceededException} with + * the specified detail message, and actual and permitted sizes. + * + * @param message The detail message. + * @param actual The actual request size. + * @param permitted The maximum permitted request size. + */ + public FileSizeLimitExceededException(final String message, final long actual, + final long permitted) { + super(message, actual, permitted); + } + + /** + * Returns the file name of the item, which caused the + * exception. + * + * @return File name, if known, or null. + */ + public String getFileName() { + return fileName; + } + + /** + * Sets the file name of the item, which caused the + * exception. + * + * @param pFileName the file name of the item, which caused the exception. + */ + public void setFileName(final String pFileName) { + fileName = pFileName; + } + + /** + * Returns the field name of the item, which caused the + * exception. + * + * @return Field name, if known, or null. + */ + public String getFieldName() { + return fieldName; + } + + /** + * Sets the field name of the item, which caused the + * exception. + * + * @param pFieldName the field name of the item, + * which caused the exception. + */ + public void setFieldName(final String pFieldName) { + fieldName = pFieldName; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/FileUploadIOException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/FileUploadIOException.java new file mode 100644 index 0000000000..e8245e4e50 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/FileUploadIOException.java @@ -0,0 +1,62 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +import org.apache.commons.fileupload2.FileUploadException; + +import java.io.IOException; + +/** + * This exception is thrown for hiding an inner + * {@link FileUploadException} in an {@link IOException}. + */ +public class FileUploadIOException extends IOException { + + /** + * The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = -7047616958165584154L; + + /** + * The exceptions cause; we overwrite the parent + * classes field, which is available since Java + * 1.4 only. + */ + private final FileUploadException cause; + + /** + * Creates a {@code FileUploadIOException} with the + * given cause. + * + * @param pCause The exceptions cause, if any, or null. + */ + public FileUploadIOException(final FileUploadException pCause) { + // We're not doing super(pCause) cause of 1.3 compatibility. + cause = pCause; + } + + /** + * Returns the exceptions cause. + * + * @return The exceptions cause, if any, or null. + */ + @Override + public Throwable getCause() { + return cause; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/IOFileUploadException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/IOFileUploadException.java new file mode 100644 index 0000000000..a35d4d54a7 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/IOFileUploadException.java @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +import org.apache.commons.fileupload2.FileUploadException; + +import java.io.IOException; + +/** + * Thrown to indicate an IOException. + */ +public class IOFileUploadException extends FileUploadException { + + /** + * The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = 1749796615868477269L; + + /** + * The exceptions cause; we overwrite the parent + * classes field, which is available since Java + * 1.4 only. + */ + private final IOException cause; + + /** + * Creates a new instance with the given cause. + * + * @param pMsg The detail message. + * @param pException The exceptions cause. + */ + public IOFileUploadException(final String pMsg, final IOException pException) { + super(pMsg); + cause = pException; + } + + /** + * Returns the exceptions cause. + * + * @return The exceptions cause, if any, or null. + */ + @Override + public Throwable getCause() { + return cause; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/InvalidContentTypeException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/InvalidContentTypeException.java new file mode 100644 index 0000000000..4df548a4b8 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/InvalidContentTypeException.java @@ -0,0 +1,60 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +import org.apache.commons.fileupload2.FileUploadException; + +/** + * Thrown to indicate that the request is not a multipart request. + */ +public class InvalidContentTypeException + extends FileUploadException { + + /** + * The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = -9073026332015646668L; + + /** + * Constructs a {@code InvalidContentTypeException} with no + * detail message. + */ + public InvalidContentTypeException() { + } + + /** + * Constructs an {@code InvalidContentTypeException} with + * the specified detail message. + * + * @param message The detail message. + */ + public InvalidContentTypeException(final String message) { + super(message); + } + + /** + * Constructs an {@code InvalidContentTypeException} with + * the specified detail message and cause. + * + * @param msg The detail message. + * @param cause the original cause + * @since 1.3.1 + */ + public InvalidContentTypeException(final String msg, final Throwable cause) { + super(msg, cause); + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/SizeException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/SizeException.java new file mode 100644 index 0000000000..f075b5e336 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/SizeException.java @@ -0,0 +1,75 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +import org.apache.commons.fileupload2.FileUploadException; + +/** + * This exception is thrown, if a requests permitted size + * is exceeded. + */ +abstract class SizeException extends FileUploadException { + + /** + * Serial version UID, being used, if serialized. + */ + private static final long serialVersionUID = -8776225574705254126L; + + /** + * The actual size of the request. + */ + private final long actual; + + /** + * The maximum permitted size of the request. + */ + private final long permitted; + + /** + * Creates a new instance. + * + * @param message The detail message. + * @param actual The actual number of bytes in the request. + * @param permitted The requests size limit, in bytes. + */ + protected SizeException(final String message, final long actual, final long permitted) { + super(message); + this.actual = actual; + this.permitted = permitted; + } + + /** + * Retrieves the actual size of the request. + * + * @return The actual size of the request. + * @since 1.3 + */ + public long getActualSize() { + return actual; + } + + /** + * Retrieves the permitted size of the request. + * + * @return The permitted size of the request. + * @since 1.3 + */ + public long getPermittedSize() { + return permitted; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/SizeLimitExceededException.java b/client/src/test/java/org/apache/commons/fileupload2/pub/SizeLimitExceededException.java new file mode 100644 index 0000000000..2e4056250a --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/SizeLimitExceededException.java @@ -0,0 +1,43 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.pub; + +/** + * Thrown to indicate that the request size exceeds the configured maximum. + */ +public class SizeLimitExceededException + extends SizeException { + + /** + * The exceptions UID, for serializing an instance. + */ + private static final long serialVersionUID = -2474893167098052828L; + + /** + * Constructs a {@code SizeExceededException} with + * the specified detail message, and actual and permitted sizes. + * + * @param message The detail message. + * @param actual The actual request size. + * @param permitted The maximum permitted request size. + */ + public SizeLimitExceededException(final String message, final long actual, + final long permitted) { + super(message, actual, permitted); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/pub/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/pub/package-info.java new file mode 100644 index 0000000000..1b8698b53d --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/pub/package-info.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Exceptions, and other classes, that are known to be used outside + * of FileUpload. + */ +package org.apache.commons.fileupload2.pub; diff --git a/client/src/test/java/org/apache/commons/fileupload2/servlet/FileCleanerCleanup.java b/client/src/test/java/org/apache/commons/fileupload2/servlet/FileCleanerCleanup.java new file mode 100644 index 0000000000..9a096ce0e0 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/servlet/FileCleanerCleanup.java @@ -0,0 +1,88 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.servlet; + +import jakarta.servlet.ServletContext; +import jakarta.servlet.ServletContextEvent; +import jakarta.servlet.ServletContextListener; +import org.apache.commons.io.FileCleaningTracker; + +/** + * A servlet context listener, which ensures that the + * {@link FileCleaningTracker}'s reaper thread is terminated, + * when the web application is destroyed. + */ +public class FileCleanerCleanup implements ServletContextListener { + + /** + * Attribute name, which is used for storing an instance of + * {@link FileCleaningTracker} in the web application. + */ + public static final String FILE_CLEANING_TRACKER_ATTRIBUTE + = FileCleanerCleanup.class.getName() + ".FileCleaningTracker"; + + /** + * Returns the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * + * @param pServletContext The servlet context to query + * @return The contexts tracker + */ + public static FileCleaningTracker + getFileCleaningTracker(final ServletContext pServletContext) { + return (FileCleaningTracker) + pServletContext.getAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE); + } + + /** + * Sets the instance of {@link FileCleaningTracker}, which is + * associated with the given {@link ServletContext}. + * + * @param pServletContext The servlet context to modify + * @param pTracker The tracker to set + */ + public static void setFileCleaningTracker(final ServletContext pServletContext, + final FileCleaningTracker pTracker) { + pServletContext.setAttribute(FILE_CLEANING_TRACKER_ATTRIBUTE, pTracker); + } + + /** + * Called when the web application is initialized. Does + * nothing. + * + * @param sce The servlet context, used for calling + * {@link #setFileCleaningTracker(ServletContext, FileCleaningTracker)}. + */ + @Override + public void contextInitialized(final ServletContextEvent sce) { + setFileCleaningTracker(sce.getServletContext(), + new FileCleaningTracker()); + } + + /** + * Called when the web application is being destroyed. + * Calls {@link FileCleaningTracker#exitWhenFinished()}. + * + * @param sce The servlet context, used for calling + * {@link #getFileCleaningTracker(ServletContext)}. + */ + @Override + public void contextDestroyed(final ServletContextEvent sce) { + getFileCleaningTracker(sce.getServletContext()).exitWhenFinished(); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java b/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java new file mode 100644 index 0000000000..8b00f2c50a --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletFileUpload.java @@ -0,0 +1,143 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.servlet; + +import jakarta.servlet.http.HttpServletRequest; +import org.apache.commons.fileupload2.FileItem; +import org.apache.commons.fileupload2.FileItemFactory; +import org.apache.commons.fileupload2.FileItemIterator; +import org.apache.commons.fileupload2.FileUpload; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.FileUploadException; + +import java.io.IOException; +import java.util.List; +import java.util.Map; + +/** + *

High level API for processing file uploads.

+ * + *

This class handles multiple files per single HTML widget, sent using + * {@code multipart/mixed} encoding type, as specified by + * RFC 1867. Use {@link + * #parseRequest(HttpServletRequest)} to acquire a list of {@link + * FileItem}s associated with a given HTML + * widget.

+ * + *

How the data for individual parts is stored is determined by the factory + * used to create them; a given part may be in memory, on disk, or somewhere + * else.

+ */ +public class ServletFileUpload extends FileUpload { + + /** + * Constant for HTTP POST method. + */ + private static final String POST_METHOD = "POST"; + + // ---------------------------------------------------------- Class methods + + /** + * Utility method that determines whether the request contains multipart + * content. + * + * @param request The servlet request to be evaluated. Must be non-null. + * @return {@code true} if the request is multipart; + * {@code false} otherwise. + */ + public static final boolean isMultipartContent( + final HttpServletRequest request) { + if (!POST_METHOD.equalsIgnoreCase(request.getMethod())) { + return false; + } + return FileUploadBase.isMultipartContent(new ServletRequestContext(request)); + } + + // ----------------------------------------------------------- Constructors + + /** + * Constructs an uninitialized instance of this class. A factory must be + * configured, using {@code setFileItemFactory()}, before attempting + * to parse requests. + * + * @see FileUpload#FileUpload(FileItemFactory) + */ + public ServletFileUpload() { + } + + /** + * Constructs an instance of this class which uses the supplied factory to + * create {@code FileItem} instances. + * + * @param fileItemFactory The factory to use for creating file items. + * @see FileUpload#FileUpload() + */ + public ServletFileUpload(final FileItemFactory fileItemFactory) { + super(fileItemFactory); + } + + // --------------------------------------------------------- Public methods + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return A list of {@code FileItem} instances parsed from the + * request, in the order that they were transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + */ + public List parseRequest(final HttpServletRequest request) + throws FileUploadException { + return parseRequest(new ServletRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return A map of {@code FileItem} instances parsed from the request. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @since 1.3 + */ + public Map> parseParameterMap(final HttpServletRequest request) + throws FileUploadException { + return parseParameterMap(new ServletRequestContext(request)); + } + + /** + * Processes an RFC 1867 + * compliant {@code multipart/form-data} stream. + * + * @param request The servlet request to be parsed. + * @return An iterator to instances of {@code FileItemStream} + * parsed from the request, in the order that they were + * transmitted. + * @throws FileUploadException if there are problems reading/parsing + * the request or storing files. + * @throws IOException An I/O error occurred. This may be a network + * error while communicating with the client or a problem while + * storing the uploaded content. + */ + public FileItemIterator getItemIterator(final HttpServletRequest request) + throws FileUploadException, IOException { + return getItemIterator(new ServletRequestContext(request)); + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java b/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java new file mode 100644 index 0000000000..246f21f1ae --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/servlet/ServletRequestContext.java @@ -0,0 +1,128 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.servlet; + +import jakarta.servlet.http.HttpServletRequest; +import org.apache.commons.fileupload2.FileUploadBase; +import org.apache.commons.fileupload2.UploadContext; + +import java.io.IOException; +import java.io.InputStream; + +import static java.lang.String.format; + +/** + *

Provides access to the request information needed for a request made to + * an HTTP servlet.

+ * + * @since 1.1 + */ +public class ServletRequestContext implements UploadContext { + + // ----------------------------------------------------- Instance Variables + + /** + * The request for which the context is being provided. + */ + private final HttpServletRequest request; + + // ----------------------------------------------------------- Constructors + + /** + * Construct a context for this request. + * + * @param request The request to which this context applies. + */ + public ServletRequestContext(final HttpServletRequest request) { + this.request = request; + } + + // --------------------------------------------------------- Public Methods + + /** + * Retrieve the character encoding for the request. + * + * @return The character encoding for the request. + */ + @Override + public String getCharacterEncoding() { + return request.getCharacterEncoding(); + } + + /** + * Retrieve the content type of the request. + * + * @return The content type of the request. + */ + @Override + public String getContentType() { + return request.getContentType(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @deprecated 1.3 Use {@link #contentLength()} instead + */ + @Override + @Deprecated + public int getContentLength() { + return request.getContentLength(); + } + + /** + * Retrieve the content length of the request. + * + * @return The content length of the request. + * @since 1.3 + */ + @Override + public long contentLength() { + long size; + try { + size = Long.parseLong(request.getHeader(FileUploadBase.CONTENT_LENGTH)); + } catch (final NumberFormatException e) { + size = request.getContentLength(); + } + return size; + } + + /** + * Retrieve the input stream for the request. + * + * @return The input stream for the request. + * @throws IOException if a problem occurs. + */ + @Override + public InputStream getInputStream() throws IOException { + return request.getInputStream(); + } + + /** + * Returns a string representation of this object. + * + * @return a string representation of this object. + */ + @Override + public String toString() { + return format("ContentLength=%s, ContentType=%s", + contentLength(), + getContentType()); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/servlet/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/servlet/package-info.java new file mode 100644 index 0000000000..06b0cb8704 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/servlet/package-info.java @@ -0,0 +1,45 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + *

+ * An implementation of + * {@link org.apache.commons.fileupload2.FileUpload FileUpload} + * for use in servlets conforming to JSR 53. This implementation requires + * only access to the servlet's current {@code HttpServletRequest} + * instance, and a suitable + * {@link org.apache.commons.fileupload2.FileItemFactory FileItemFactory} + * implementation, such as + * {@link org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}. + *

+ *

+ * The following code fragment demonstrates typical usage. + *

+ *
+ *        DiskFileItemFactory factory = new DiskFileItemFactory();
+ *        // Configure the factory here, if desired.
+ *        ServletFileUpload upload = new ServletFileUpload(factory);
+ *        // Configure the uploader here, if desired.
+ *        List fileItems = upload.parseRequest(request);
+ * 
+ *

+ * Please see the FileUpload + * User Guide + * for further details and examples of how to use this package. + *

+ */ +package org.apache.commons.fileupload2.servlet; diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/Closeable.java b/client/src/test/java/org/apache/commons/fileupload2/util/Closeable.java new file mode 100644 index 0000000000..dce76f8b39 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/Closeable.java @@ -0,0 +1,41 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util; + +import java.io.IOException; + +/** + * Interface of an object, which may be closed. + */ +public interface Closeable { + + /** + * Closes the object. + * + * @throws IOException An I/O error occurred. + */ + void close() throws IOException; + + /** + * Returns, whether the object is already closed. + * + * @return True, if the object is closed, otherwise false. + * @throws IOException An I/O error occurred. + */ + boolean isClosed() throws IOException; + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/FileItemHeadersImpl.java b/client/src/test/java/org/apache/commons/fileupload2/util/FileItemHeadersImpl.java new file mode 100644 index 0000000000..d4413d174b --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/FileItemHeadersImpl.java @@ -0,0 +1,95 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util; + +import org.apache.commons.fileupload2.FileItemHeaders; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; + +/** + * Default implementation of the {@link FileItemHeaders} interface. + * + * @since 1.2.1 + */ +public class FileItemHeadersImpl implements FileItemHeaders, Serializable { + + /** + * Serial version UID, being used, if serialized. + */ + private static final long serialVersionUID = -4455695752627032559L; + + /** + * Map of {@code String} keys to a {@code List} of + * {@code String} instances. + */ + private final Map> headerNameToValueListMap = new LinkedHashMap<>(); + + /** + * {@inheritDoc} + */ + @Override + public String getHeader(final String name) { + final String nameLower = name.toLowerCase(Locale.ENGLISH); + final List headerValueList = headerNameToValueListMap.get(nameLower); + if (null == headerValueList) { + return null; + } + return headerValueList.get(0); + } + + /** + * {@inheritDoc} + */ + @Override + public Iterator getHeaderNames() { + return headerNameToValueListMap.keySet().iterator(); + } + + /** + * {@inheritDoc} + */ + @Override + public Iterator getHeaders(final String name) { + final String nameLower = name.toLowerCase(Locale.ENGLISH); + List headerValueList = headerNameToValueListMap.get(nameLower); + if (null == headerValueList) { + headerValueList = Collections.emptyList(); + } + return headerValueList.iterator(); + } + + /** + * Method to add header values to this instance. + * + * @param name name of this header + * @param value value of this header + */ + public synchronized void addHeader(final String name, final String value) { + final String nameLower = name.toLowerCase(Locale.ENGLISH); + final List headerValueList = headerNameToValueListMap. + computeIfAbsent(nameLower, k -> new ArrayList<>()); + headerValueList.add(value); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/LimitedInputStream.java b/client/src/test/java/org/apache/commons/fileupload2/util/LimitedInputStream.java new file mode 100644 index 0000000000..ec8c4d8301 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/LimitedInputStream.java @@ -0,0 +1,166 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util; + +import java.io.FilterInputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * An input stream, which limits its data size. This stream is + * used, if the content length is unknown. + */ +public abstract class LimitedInputStream extends FilterInputStream implements Closeable { + + /** + * The maximum size of an item, in bytes. + */ + private final long sizeMax; + + /** + * The current number of bytes. + */ + private long count; + + /** + * Whether this stream is already closed. + */ + private boolean closed; + + /** + * Creates a new instance. + * + * @param inputStream The input stream, which shall be limited. + * @param pSizeMax The limit; no more than this number of bytes + * shall be returned by the source stream. + */ + public LimitedInputStream(final InputStream inputStream, final long pSizeMax) { + super(inputStream); + sizeMax = pSizeMax; + } + + /** + * Called to indicate, that the input streams limit has + * been exceeded. + * + * @param pSizeMax The input streams limit, in bytes. + * @param pCount The actual number of bytes. + * @throws IOException The called method is expected + * to raise an IOException. + */ + protected abstract void raiseError(long pSizeMax, long pCount) + throws IOException; + + /** + * Called to check, whether the input streams + * limit is reached. + * + * @throws IOException The given limit is exceeded. + */ + private void checkLimit() throws IOException { + if (count > sizeMax) { + raiseError(sizeMax, count); + } + } + + /** + * Reads the next byte of data from this input stream. The value + * byte is returned as an {@code int} in the range + * {@code 0} to {@code 255}. If no byte is available + * because the end of the stream has been reached, the value + * {@code -1} is returned. This method blocks until input data + * is available, the end of the stream is detected, or an exception + * is thrown. + *

+ * This method + * simply performs {@code in.read()} and returns the result. + * + * @return the next byte of data, or {@code -1} if the end of the + * stream is reached. + * @throws IOException if an I/O error occurs. + * @see FilterInputStream#in + */ + @Override + public int read() throws IOException { + final int res = super.read(); + if (res != -1) { + count++; + checkLimit(); + } + return res; + } + + /** + * Reads up to {@code len} bytes of data from this input stream + * into an array of bytes. If {@code len} is not zero, the method + * blocks until some input is available; otherwise, no + * bytes are read and {@code 0} is returned. + *

+ * This method simply performs {@code in.read(b, off, len)} + * and returns the result. + * + * @param b the buffer into which the data is read. + * @param off The start offset in the destination array + * {@code b}. + * @param len the maximum number of bytes read. + * @return the total number of bytes read into the buffer, or + * {@code -1} if there is no more data because the end of + * the stream has been reached. + * @throws NullPointerException If {@code b} is {@code null}. + * @throws IndexOutOfBoundsException If {@code off} is negative, + * {@code len} is negative, or {@code len} is greater than + * {@code b.length - off} + * @throws IOException if an I/O error occurs. + * @see FilterInputStream#in + */ + @Override + public int read(final byte[] b, final int off, final int len) throws IOException { + final int res = super.read(b, off, len); + if (res > 0) { + count += res; + checkLimit(); + } + return res; + } + + /** + * Returns, whether this stream is already closed. + * + * @return True, if the stream is closed, otherwise false. + * @throws IOException An I/O error occurred. + */ + @Override + public boolean isClosed() throws IOException { + return closed; + } + + /** + * Closes this input stream and releases any system resources + * associated with the stream. + * This + * method simply performs {@code in.close()}. + * + * @throws IOException if an I/O error occurs. + * @see FilterInputStream#in + */ + @Override + public void close() throws IOException { + closed = true; + super.close(); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/Streams.java b/client/src/test/java/org/apache/commons/fileupload2/util/Streams.java new file mode 100644 index 0000000000..07faf497cf --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/Streams.java @@ -0,0 +1,186 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util; + +import org.apache.commons.fileupload2.InvalidFileNameException; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + +/** + * Utility class for working with streams. + */ +public final class Streams { + + /** + * Private constructor, to prevent instantiation. + * This class has only static methods. + */ + private Streams() { + // Does nothing + } + + /** + * Default buffer size for use in + * {@link #copy(InputStream, OutputStream, boolean)}. + */ + public static final int DEFAULT_BUFFER_SIZE = 8192; + + /** + * Copies the contents of the given {@link InputStream} + * to the given {@link OutputStream}. Shortcut for + *

+     *   copy(pInputStream, pOutputStream, new byte[8192]);
+     * 
+ * + * @param inputStream The input stream, which is being read. + * It is guaranteed, that {@link InputStream#close()} is called + * on the stream. + * @param outputStream The output stream, to which data should + * be written. May be null, in which case the input streams + * contents are simply discarded. + * @param closeOutputStream True guarantees, that + * {@link OutputStream#close()} is called on the stream. + * False indicates, that only + * {@link OutputStream#flush()} should be called finally. + * @return Number of bytes, which have been copied. + * @throws IOException An I/O error occurred. + */ + public static long copy(final InputStream inputStream, final OutputStream outputStream, + final boolean closeOutputStream) + throws IOException { + return copy(inputStream, outputStream, closeOutputStream, new byte[DEFAULT_BUFFER_SIZE]); + } + + /** + * Copies the contents of the given {@link InputStream} + * to the given {@link OutputStream}. + * + * @param inputStream The input stream, which is being read. + * It is guaranteed, that {@link InputStream#close()} is called + * on the stream. + * @param outputStream The output stream, to which data should + * be written. May be null, in which case the input streams + * contents are simply discarded. + * @param closeOutputStream True guarantees, that {@link OutputStream#close()} + * is called on the stream. False indicates, that only + * {@link OutputStream#flush()} should be called finally. + * @param buffer Temporary buffer, which is to be used for + * copying data. + * @return Number of bytes, which have been copied. + * @throws IOException An I/O error occurred. + */ + public static long copy(final InputStream inputStream, + final OutputStream outputStream, final boolean closeOutputStream, + final byte[] buffer) + throws IOException { + try (OutputStream out = outputStream; + InputStream in = inputStream) { + long total = 0; + for (; ; ) { + final int res = in.read(buffer); + if (res == -1) { + break; + } + if (res > 0) { + total += res; + if (out != null) { + out.write(buffer, 0, res); + } + } + } + if (out != null) { + if (closeOutputStream) { + out.close(); + } else { + out.flush(); + } + } + in.close(); + return total; + } + } + + /** + * This convenience method allows to read a + * {@link org.apache.commons.fileupload2.FileItemStream}'s + * content into a string. The platform's default character encoding + * is used for converting bytes into characters. + * + * @param inputStream The input stream to read. + * @return The streams contents, as a string. + * @throws IOException An I/O error occurred. + * @see #asString(InputStream, String) + */ + public static String asString(final InputStream inputStream) throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + copy(inputStream, baos, true); + return baos.toString(); + } + + /** + * This convenience method allows to read a + * {@link org.apache.commons.fileupload2.FileItemStream}'s + * content into a string, using the given character encoding. + * + * @param inputStream The input stream to read. + * @param encoding The character encoding, typically "UTF-8". + * @return The streams contents, as a string. + * @throws IOException An I/O error occurred. + * @see #asString(InputStream) + */ + public static String asString(final InputStream inputStream, final String encoding) + throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + copy(inputStream, baos, true); + return baos.toString(encoding); + } + + /** + * Checks, whether the given file name is valid in the sense, + * that it doesn't contain any NUL characters. If the file name + * is valid, it will be returned without any modifications. Otherwise, + * an {@link InvalidFileNameException} is raised. + * + * @param fileName The file name to check + * @return Unmodified file name, if valid. + * @throws InvalidFileNameException The file name was found to be invalid. + */ + public static String checkFileName(final String fileName) { + if (fileName != null && fileName.indexOf('\u0000') != -1) { + // pFileName.replace("\u0000", "\\0") + final StringBuilder sb = new StringBuilder(); + for (int i = 0; i < fileName.length(); i++) { + final char c = fileName.charAt(i); + switch (c) { + case 0: + sb.append("\\0"); + break; + default: + sb.append(c); + break; + } + } + throw new InvalidFileNameException(fileName, + "Invalid file name: " + sb); + } + return fileName; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/Base64Decoder.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/Base64Decoder.java new file mode 100644 index 0000000000..b61c2b921f --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/Base64Decoder.java @@ -0,0 +1,150 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util.mime; + +import java.io.IOException; +import java.io.OutputStream; +import java.util.Arrays; + +/** + * @since 1.3 + */ +final class Base64Decoder { + + /** + * Decoding table value for invalid bytes. + */ + private static final byte INVALID_BYTE = -1; // must be outside range 0-63 + + /** + * Decoding table value for padding bytes, so can detect PAD after conversion. + */ + private static final int PAD_BYTE = -2; // must be outside range 0-63 + + /** + * Mask to treat byte as unsigned integer. + */ + private static final int MASK_BYTE_UNSIGNED = 0xFF; + + /** + * Number of bytes per encoded chunk - 4 6bit bytes produce 3 8bit bytes on output. + */ + private static final int INPUT_BYTES_PER_CHUNK = 4; + + /** + * Set up the encoding table. + */ + private static final byte[] ENCODING_TABLE = { + (byte) 'A', (byte) 'B', (byte) 'C', (byte) 'D', (byte) 'E', (byte) 'F', (byte) 'G', + (byte) 'H', (byte) 'I', (byte) 'J', (byte) 'K', (byte) 'L', (byte) 'M', (byte) 'N', + (byte) 'O', (byte) 'P', (byte) 'Q', (byte) 'R', (byte) 'S', (byte) 'T', (byte) 'U', + (byte) 'V', (byte) 'W', (byte) 'X', (byte) 'Y', (byte) 'Z', + (byte) 'a', (byte) 'b', (byte) 'c', (byte) 'd', (byte) 'e', (byte) 'f', (byte) 'g', + (byte) 'h', (byte) 'i', (byte) 'j', (byte) 'k', (byte) 'l', (byte) 'm', (byte) 'n', + (byte) 'o', (byte) 'p', (byte) 'q', (byte) 'r', (byte) 's', (byte) 't', (byte) 'u', + (byte) 'v', (byte) 'w', (byte) 'x', (byte) 'y', (byte) 'z', + (byte) '0', (byte) '1', (byte) '2', (byte) '3', (byte) '4', (byte) '5', (byte) '6', + (byte) '7', (byte) '8', (byte) '9', + (byte) '+', (byte) '/' + }; + + /** + * The padding byte. + */ + private static final byte PADDING = (byte) '='; + + /** + * Set up the decoding table; this is indexed by a byte converted to an unsigned int, + * so must be at least as large as the number of different byte values, + * positive and negative and zero. + */ + private static final byte[] DECODING_TABLE = new byte[Byte.MAX_VALUE - Byte.MIN_VALUE + 1]; + + static { + // Initialize as all invalid characters + Arrays.fill(DECODING_TABLE, INVALID_BYTE); + // set up valid characters + for (int i = 0; i < ENCODING_TABLE.length; i++) { + DECODING_TABLE[ENCODING_TABLE[i]] = (byte) i; + } + // Allow pad byte to be easily detected after conversion + DECODING_TABLE[PADDING] = PAD_BYTE; + } + + /** + * Hidden constructor, this class must not be instantiated. + */ + private Base64Decoder() { + // do nothing + } + + /** + * Decode the base 64 encoded byte data writing it to the given output stream, + * whitespace characters will be ignored. + * + * @param data the buffer containing the Base64-encoded data + * @param out the output stream to hold the decoded bytes + * @return the number of bytes produced. + * @throws IOException thrown when the padding is incorrect or the input is truncated. + */ + public static int decode(final byte[] data, final OutputStream out) throws IOException { + int outLen = 0; + final byte[] cache = new byte[INPUT_BYTES_PER_CHUNK]; + int cachedBytes = 0; + + for (final byte b : data) { + final byte d = DECODING_TABLE[MASK_BYTE_UNSIGNED & b]; + if (d == INVALID_BYTE) { + continue; // Ignore invalid bytes + } + cache[cachedBytes++] = d; + if (cachedBytes == INPUT_BYTES_PER_CHUNK) { + // CHECKSTYLE IGNORE MagicNumber FOR NEXT 4 LINES + final byte b1 = cache[0]; + final byte b2 = cache[1]; + final byte b3 = cache[2]; + final byte b4 = cache[3]; + if (b1 == PAD_BYTE || b2 == PAD_BYTE) { + throw new IOException("Invalid Base64 input: incorrect padding, first two bytes cannot be padding"); + } + // Convert 4 6-bit bytes to 3 8-bit bytes + // CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE + out.write((b1 << 2) | (b2 >> 4)); // 6 bits of b1 plus 2 bits of b2 + outLen++; + if (b3 != PAD_BYTE) { + // CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE + out.write((b2 << 4) | (b3 >> 2)); // 4 bits of b2 plus 4 bits of b3 + outLen++; + if (b4 != PAD_BYTE) { + // CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE + out.write((b3 << 6) | b4); // 2 bits of b3 plus 6 bits of b4 + outLen++; + } + } else if (b4 != PAD_BYTE) { // if byte 3 is pad, byte 4 must be pad too + throw new // line wrap to avoid 120 char limit + IOException("Invalid Base64 input: incorrect padding, 4th byte must be padding if 3rd byte is"); + } + cachedBytes = 0; + } + } + // Check for anything left over + if (cachedBytes != 0) { + throw new IOException("Invalid Base64 input: truncated"); + } + return outLen; + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/MimeUtility.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/MimeUtility.java new file mode 100644 index 0000000000..847ea415af --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/MimeUtility.java @@ -0,0 +1,274 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util.mime; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.nio.charset.StandardCharsets; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; + +/** + * Utility class to decode MIME texts. + * + * @since 1.3 + */ +public final class MimeUtility { + + /** + * The marker to indicate text is encoded with BASE64 algorithm. + */ + private static final String BASE64_ENCODING_MARKER = "B"; + + /** + * The marker to indicate text is encoded with QuotedPrintable algorithm. + */ + private static final String QUOTEDPRINTABLE_ENCODING_MARKER = "Q"; + + /** + * If the text contains any encoded tokens, those tokens will be marked with "=?". + */ + private static final String ENCODED_TOKEN_MARKER = "=?"; + + /** + * If the text contains any encoded tokens, those tokens will terminate with "=?". + */ + private static final String ENCODED_TOKEN_FINISHER = "?="; + + /** + * The linear whitespace chars sequence. + */ + private static final String LINEAR_WHITESPACE = " \t\r\n"; + + /** + * Mappings between MIME and Java charset. + */ + private static final Map MIME2JAVA = new HashMap<>(); + + static { + MIME2JAVA.put("iso-2022-cn", "ISO2022CN"); + MIME2JAVA.put("iso-2022-kr", "ISO2022KR"); + MIME2JAVA.put("utf-8", "UTF8"); + MIME2JAVA.put("utf8", "UTF8"); + MIME2JAVA.put("ja_jp.iso2022-7", "ISO2022JP"); + MIME2JAVA.put("ja_jp.eucjp", "EUCJIS"); + MIME2JAVA.put("euc-kr", "KSC5601"); + MIME2JAVA.put("euckr", "KSC5601"); + MIME2JAVA.put("us-ascii", "ISO-8859-1"); + MIME2JAVA.put("x-us-ascii", "ISO-8859-1"); + } + + /** + * Hidden constructor, this class must not be instantiated. + */ + private MimeUtility() { + // do nothing + } + + /** + * Decode a string of text obtained from a mail header into + * its proper form. The text generally will consist of a + * string of tokens, some of which may be encoded using + * base64 encoding. + * + * @param text The text to decode. + * @return The decoded text string. + * @throws UnsupportedEncodingException if the detected encoding in the input text is not supported. + */ + public static String decodeText(final String text) throws UnsupportedEncodingException { + // if the text contains any encoded tokens, those tokens will be marked with "=?". If the + // source string doesn't contain that sequent, no decoding is required. + if (!text.contains(ENCODED_TOKEN_MARKER)) { + return text; + } + + int offset = 0; + final int endOffset = text.length(); + + int startWhiteSpace = -1; + int endWhiteSpace = -1; + + final StringBuilder decodedText = new StringBuilder(text.length()); + + boolean previousTokenEncoded = false; + + while (offset < endOffset) { + char ch = text.charAt(offset); + + // is this a whitespace character? + if (LINEAR_WHITESPACE.indexOf(ch) != -1) { // whitespace found + startWhiteSpace = offset; + while (offset < endOffset) { + // step over the white space characters. + ch = text.charAt(offset); + if (LINEAR_WHITESPACE.indexOf(ch) == -1) { + // record the location of the first non lwsp and drop down to process the + // token characters. + endWhiteSpace = offset; + break; + } + offset++; + } + } else { + // we have a word token. We need to scan over the word and then try to parse it. + final int wordStart = offset; + + while (offset < endOffset) { + // step over the non white space characters. + ch = text.charAt(offset); + if (LINEAR_WHITESPACE.indexOf(ch) != -1) { + break; + } + offset++; + + //NB: Trailing whitespace on these header strings will just be discarded. + } + // pull out the word token. + final String word = text.substring(wordStart, offset); + // is the token encoded? decode the word + if (word.startsWith(ENCODED_TOKEN_MARKER)) { + try { + // if this gives a parsing failure, treat it like a non-encoded word. + final String decodedWord = decodeWord(word); + + // are any whitespace characters significant? Append 'em if we've got 'em. + if (!previousTokenEncoded && startWhiteSpace != -1) { + decodedText.append(text, startWhiteSpace, endWhiteSpace); + startWhiteSpace = -1; + } + // this is definitely a decoded token. + previousTokenEncoded = true; + // and add this to the text. + decodedText.append(decodedWord); + // we continue parsing from here...we allow parsing errors to fall through + // and get handled as normal text. + continue; + + } catch (final ParseException e) { + // just ignore it, skip to next word + } + } + // this is a normal token, so it doesn't matter what the previous token was. Add the white space + // if we have it. + if (startWhiteSpace != -1) { + decodedText.append(text, startWhiteSpace, endWhiteSpace); + startWhiteSpace = -1; + } + // this is not a decoded token. + previousTokenEncoded = false; + decodedText.append(word); + } + } + + return decodedText.toString(); + } + + /** + * Parse a string using the RFC 2047 rules for an "encoded-word" + * type. This encoding has the syntax: + *

+ * encoded-word = "=?" charset "?" encoding "?" encoded-text "?=" + * + * @param word The possibly encoded word value. + * @return The decoded word. + * @throws ParseException in case of a parse error of the RFC 2047 + * @throws UnsupportedEncodingException Thrown when Invalid RFC 2047 encoding was found + */ + private static String decodeWord(final String word) throws ParseException, UnsupportedEncodingException { + // encoded words start with the characters "=?". If this not an encoded word, we throw a + // ParseException for the caller. + + if (!word.startsWith(ENCODED_TOKEN_MARKER)) { + throw new ParseException("Invalid RFC 2047 encoded-word: " + word); + } + + final int charsetPos = word.indexOf('?', 2); + if (charsetPos == -1) { + throw new ParseException("Missing charset in RFC 2047 encoded-word: " + word); + } + + // pull out the character set information (this is the MIME name at this point). + final String charset = word.substring(2, charsetPos).toLowerCase(Locale.ENGLISH); + + // now pull out the encoding token the same way. + final int encodingPos = word.indexOf('?', charsetPos + 1); + if (encodingPos == -1) { + throw new ParseException("Missing encoding in RFC 2047 encoded-word: " + word); + } + + final String encoding = word.substring(charsetPos + 1, encodingPos); + + // and finally the encoded text. + final int encodedTextPos = word.indexOf(ENCODED_TOKEN_FINISHER, encodingPos + 1); + if (encodedTextPos == -1) { + throw new ParseException("Missing encoded text in RFC 2047 encoded-word: " + word); + } + + final String encodedText = word.substring(encodingPos + 1, encodedTextPos); + + // seems a bit silly to encode a null string, but easy to deal with. + if (encodedText.isEmpty()) { + return ""; + } + + try { + // the decoder writes directly to an output stream. + final ByteArrayOutputStream out = new ByteArrayOutputStream(encodedText.length()); + + final byte[] encodedData = encodedText.getBytes(StandardCharsets.US_ASCII); + + // Base64 encoded? + if (encoding.equals(BASE64_ENCODING_MARKER)) { + Base64Decoder.decode(encodedData, out); + } else if (encoding.equals(QUOTEDPRINTABLE_ENCODING_MARKER)) { // maybe quoted printable. + QuotedPrintableDecoder.decode(encodedData, out); + } else { + throw new UnsupportedEncodingException("Unknown RFC 2047 encoding: " + encoding); + } + // get the decoded byte data and convert into a string. + final byte[] decodedData = out.toByteArray(); + return new String(decodedData, javaCharset(charset)); + } catch (final IOException e) { + throw new UnsupportedEncodingException("Invalid RFC 2047 encoding"); + } + } + + /** + * Translate a MIME standard character set name into the Java + * equivalent. + * + * @param charset The MIME standard name. + * @return The Java equivalent for this name. + */ + private static String javaCharset(final String charset) { + // nothing in, nothing out. + if (charset == null) { + return null; + } + + final String mappedCharset = MIME2JAVA.get(charset.toLowerCase(Locale.ENGLISH)); + // if there is no mapping, then the original name is used. Many of the MIME character set + // names map directly back into Java. The reverse isn't necessarily true. + if (mappedCharset == null) { + return charset; + } + return mappedCharset; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/ParseException.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/ParseException.java new file mode 100644 index 0000000000..7981ea4907 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/ParseException.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util.mime; + +/** + * @since 1.3 + */ +final class ParseException extends Exception { + + /** + * The UID to use when serializing this instance. + */ + private static final long serialVersionUID = 5355281266579392077L; + + /** + * Constructs a new exception with the specified detail message. + * + * @param message the detail message. + */ + ParseException(final String message) { + super(message); + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/QuotedPrintableDecoder.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/QuotedPrintableDecoder.java new file mode 100644 index 0000000000..88c0270b46 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/QuotedPrintableDecoder.java @@ -0,0 +1,111 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util.mime; + +import java.io.IOException; +import java.io.OutputStream; + +/** + * @since 1.3 + */ +final class QuotedPrintableDecoder { + + /** + * The shift value required to create the upper nibble + * from the first of 2 byte values converted from ascii hex. + */ + private static final int UPPER_NIBBLE_SHIFT = Byte.SIZE / 2; + + /** + * Hidden constructor, this class must not be instantiated. + */ + private QuotedPrintableDecoder() { + // do nothing + } + + /** + * Decode the encoded byte data writing it to the given output stream. + * + * @param data The array of byte data to decode. + * @param out The output stream used to return the decoded data. + * @return the number of bytes produced. + * @throws IOException if an IO error occurs + */ + public static int decode(final byte[] data, final OutputStream out) throws IOException { + int off = 0; + final int length = data.length; + final int endOffset = off + length; + int bytesWritten = 0; + + while (off < endOffset) { + final byte ch = data[off++]; + + // space characters were translated to '_' on encode, so we need to translate them back. + if (ch == '_') { + out.write(' '); + } else if (ch == '=') { + // we found an encoded character. Reduce the 3 char sequence to one. + // but first, make sure we have two characters to work with. + if (off + 1 >= endOffset) { + throw new IOException("Invalid quoted printable encoding; truncated escape sequence"); + } + + final byte b1 = data[off++]; + final byte b2 = data[off++]; + + // we've found an encoded carriage return. The next char needs to be a newline + if (b1 == '\r') { + if (b2 != '\n') { + throw new IOException("Invalid quoted printable encoding; CR must be followed by LF"); + } + // this was a soft linebreak inserted by the encoding. We just toss this away + // on decode. + } else { + // this is a hex pair we need to convert back to a single byte. + final int c1 = hexToBinary(b1); + final int c2 = hexToBinary(b2); + out.write((c1 << UPPER_NIBBLE_SHIFT) | c2); + // 3 bytes in, one byte out + bytesWritten++; + } + } else { + // simple character, just write it out. + out.write(ch); + bytesWritten++; + } + } + + return bytesWritten; + } + + /** + * Convert a hex digit to the binary value it represents. + * + * @param b the ascii hex byte to convert (0-0, A-F, a-f) + * @return the int value of the hex byte, 0-15 + * @throws IOException if the byte is not a valid hex digit. + */ + private static int hexToBinary(final byte b) throws IOException { + // CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE + final int i = Character.digit((char) b, 16); + if (i == -1) { + throw new IOException("Invalid quoted printable encoding: not a valid hex digit: " + b); + } + return i; + } + +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/RFC2231Utility.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/RFC2231Utility.java new file mode 100644 index 0000000000..4033765197 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/RFC2231Utility.java @@ -0,0 +1,160 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.fileupload2.util.mime; + +import java.io.ByteArrayOutputStream; +import java.io.UnsupportedEncodingException; + +/** + * Utility class to decode/encode character set on HTTP Header fields based on RFC 2231. + * This implementation adheres to RFC 5987 in particular, which was defined for HTTP headers + *

+ * RFC 5987 builds on RFC 2231, but has lesser scope like + * mandatory charset definition + * and no parameter continuation + * + *

+ * + * @see RFC 2231 + * @see RFC 5987 + */ +public final class RFC2231Utility { + /** + * The Hexadecimal values char array. + */ + private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray(); + /** + * The Hexadecimal representation of 127. + */ + private static final byte MASK = 0x7f; + /** + * The Hexadecimal representation of 128. + */ + private static final int MASK_128 = 0x80; + /** + * The Hexadecimal decode value. + */ + private static final byte[] HEX_DECODE = new byte[MASK_128]; + + // create a ASCII decoded array of Hexadecimal values + static { + for (int i = 0; i < HEX_DIGITS.length; i++) { + HEX_DECODE[HEX_DIGITS[i]] = (byte) i; + HEX_DECODE[Character.toLowerCase(HEX_DIGITS[i])] = (byte) i; + } + } + + /** + * Private constructor so that no instances can be created. This class + * contains only static utility methods. + */ + private RFC2231Utility() { + } + + /** + * Checks if Asterisk (*) at the end of parameter name to indicate, + * if it has charset and language information to decode the value. + * + * @param paramName The parameter, which is being checked. + * @return {@code true}, if encoded as per RFC 2231, {@code false} otherwise + */ + public static boolean hasEncodedValue(final String paramName) { + if (paramName != null) { + return paramName.lastIndexOf('*') == (paramName.length() - 1); + } + return false; + } + + /** + * If {@code paramName} has Asterisk (*) at the end, it will be stripped off, + * else the passed value will be returned. + * + * @param paramName The parameter, which is being inspected. + * @return stripped {@code paramName} of Asterisk (*), if RFC2231 encoded + */ + public static String stripDelimiter(final String paramName) { + if (hasEncodedValue(paramName)) { + final StringBuilder paramBuilder = new StringBuilder(paramName); + paramBuilder.deleteCharAt(paramName.lastIndexOf('*')); + return paramBuilder.toString(); + } + return paramName; + } + + /** + * Decode a string of text obtained from a HTTP header as per RFC 2231 + * + * Eg 1. {@code us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A} + * will be decoded to {@code This is ***fun***} + * + * Eg 2. {@code iso-8859-1'en'%A3%20rate} + * will be decoded to {@code £ rate}. + * + * Eg 3. {@code UTF-8''%c2%a3%20and%20%e2%82%ac%20rates} + * will be decoded to {@code £ and € rates}. + * + * @param encodedText - Text to be decoded has a format of {@code ''} + * and ASCII only + * @return Decoded text based on charset encoding + * @throws UnsupportedEncodingException The requested character set wasn't found. + */ + public static String decodeText(final String encodedText) throws UnsupportedEncodingException { + final int langDelimitStart = encodedText.indexOf('\''); + if (langDelimitStart == -1) { + // missing charset + return encodedText; + } + final String mimeCharset = encodedText.substring(0, langDelimitStart); + final int langDelimitEnd = encodedText.indexOf('\'', langDelimitStart + 1); + if (langDelimitEnd == -1) { + // missing language + return encodedText; + } + final byte[] bytes = fromHex(encodedText.substring(langDelimitEnd + 1)); + return new String(bytes, getJavaCharset(mimeCharset)); + } + + /** + * Convert {@code text} to their corresponding Hex value. + * + * @param text - ASCII text input + * @return Byte array of characters decoded from ASCII table + */ + private static byte[] fromHex(final String text) { + final int shift = 4; + final ByteArrayOutputStream out = new ByteArrayOutputStream(text.length()); + for (int i = 0; i < text.length(); ) { + final char c = text.charAt(i++); + if (c == '%') { + if (i > text.length() - 2) { + break; // unterminated sequence + } + final byte b1 = HEX_DECODE[text.charAt(i++) & MASK]; + final byte b2 = HEX_DECODE[text.charAt(i++) & MASK]; + out.write((b1 << shift) | b2); + } else { + out.write((byte) c); + } + } + return out.toByteArray(); + } + + private static String getJavaCharset(final String mimeCharset) { + // good enough for standard values + return mimeCharset; + } +} diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/mime/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/util/mime/package-info.java new file mode 100644 index 0000000000..6b9c410d33 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/mime/package-info.java @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * MIME decoder implementation, imported and retailed from + * Apache Geronimo. + */ +package org.apache.commons.fileupload2.util.mime; diff --git a/client/src/test/java/org/apache/commons/fileupload2/util/package-info.java b/client/src/test/java/org/apache/commons/fileupload2/util/package-info.java new file mode 100644 index 0000000000..95817a14a7 --- /dev/null +++ b/client/src/test/java/org/apache/commons/fileupload2/util/package-info.java @@ -0,0 +1,23 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * This package contains various IO related utility classes + * or methods, which are basically reusable and not necessarily + * restricted to the scope of a file upload. + */ +package org.apache.commons.fileupload2.util; diff --git a/client/src/test/java/org/asynchttpclient/AbstractBasicTest.java b/client/src/test/java/org/asynchttpclient/AbstractBasicTest.java new file mode 100644 index 0000000000..2dcfa859dc --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AbstractBasicTest.java @@ -0,0 +1,91 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.nettyplus.leakdetector.junit.NettyLeakDetectorExtension; +import org.asynchttpclient.test.EchoHandler; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.extension.ExtendWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.asynchttpclient.test.TestUtils.addHttpConnector; + +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +@ExtendWith(NettyLeakDetectorExtension.class) +public abstract class AbstractBasicTest { + protected static final Logger logger = LoggerFactory.getLogger(AbstractBasicTest.class); + protected static final int TIMEOUT = 30; + + protected Server server; + protected int port1 = -1; + protected int port2 = -1; + + @BeforeAll + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + server.setHandler(configureHandler()); + ServerConnector connector2 = addHttpConnector(server); + server.start(); + + port1 = connector1.getLocalPort(); + port2 = connector2.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @AfterAll + public void tearDownGlobal() throws Exception { + logger.debug("Shutting down local server: {}", server); + + if (server != null) { + server.stop(); + } + } + + protected String getTargetUrl() { + return String.format("http://localhost:%d/foo/test", port1); + } + + protected String getTargetUrl2() { + return String.format("https://localhost:%d/foo/test", port2); + } + + public AbstractHandler configureHandler() throws Exception { + return new EchoHandler(); + } + + public static class AsyncCompletionHandlerAdapter extends AsyncCompletionHandler { + + private static final Logger logger = LoggerFactory.getLogger(AsyncCompletionHandlerAdapter.class); + + @Override + public Response onCompleted(Response response) throws Exception { + return response; + } + + @Override + public void onThrowable(Throwable t) { + logger.error(t.getMessage(), t); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/AsyncHttpClientDefaultsTest.java b/client/src/test/java/org/asynchttpclient/AsyncHttpClientDefaultsTest.java new file mode 100644 index 0000000000..d125a9fa48 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AsyncHttpClientDefaultsTest.java @@ -0,0 +1,226 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.config.AsyncHttpClientConfigDefaults; +import org.asynchttpclient.config.AsyncHttpClientConfigHelper; + +import java.lang.reflect.Method; +import java.time.Duration; + +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.ASYNC_CLIENT_CONFIG_ROOT; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +public class AsyncHttpClientDefaultsTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultUseOnlyEpollNativeTransport() { + assertFalse(AsyncHttpClientConfigDefaults.defaultUseOnlyEpollNativeTransport()); + testBooleanSystemProperty("useOnlyEpollNativeTransport", "defaultUseOnlyEpollNativeTransport", "false"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultMaxTotalConnections() { + assertEquals(AsyncHttpClientConfigDefaults.defaultMaxConnections(), -1); + testIntegerSystemProperty("maxConnections", "defaultMaxConnections", "100"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultMaxConnectionPerHost() { + assertEquals(AsyncHttpClientConfigDefaults.defaultMaxConnectionsPerHost(), -1); + testIntegerSystemProperty("maxConnectionsPerHost", "defaultMaxConnectionsPerHost", "100"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultConnectTimeOut() { + assertEquals(AsyncHttpClientConfigDefaults.defaultConnectTimeout(), Duration.ofSeconds(5)); + testDurationSystemProperty("connectTimeout", "defaultConnectTimeout", "PT0.1S"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultPooledConnectionIdleTimeout() { + assertEquals(AsyncHttpClientConfigDefaults.defaultPooledConnectionIdleTimeout(), Duration.ofMinutes(1)); + testDurationSystemProperty("pooledConnectionIdleTimeout", "defaultPooledConnectionIdleTimeout", "PT0.1S"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultReadTimeout() { + assertEquals(AsyncHttpClientConfigDefaults.defaultReadTimeout(), Duration.ofSeconds(60)); + testDurationSystemProperty("readTimeout", "defaultReadTimeout", "PT0.1S"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultRequestTimeout() { + assertEquals(AsyncHttpClientConfigDefaults.defaultRequestTimeout(), Duration.ofSeconds(60)); + testDurationSystemProperty("requestTimeout", "defaultRequestTimeout", "PT0.1S"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultConnectionTtl() { + assertEquals(AsyncHttpClientConfigDefaults.defaultConnectionTtl(), Duration.ofMillis(-1)); + testDurationSystemProperty("connectionTtl", "defaultConnectionTtl", "PT0.1S"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultFollowRedirect() { + assertFalse(AsyncHttpClientConfigDefaults.defaultFollowRedirect()); + testBooleanSystemProperty("followRedirect", "defaultFollowRedirect", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultMaxRedirects() { + assertEquals(AsyncHttpClientConfigDefaults.defaultMaxRedirects(), 5); + testIntegerSystemProperty("maxRedirects", "defaultMaxRedirects", "100"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultCompressionEnforced() { + assertFalse(AsyncHttpClientConfigDefaults.defaultCompressionEnforced()); + testBooleanSystemProperty("compressionEnforced", "defaultCompressionEnforced", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultUserAgent() { + assertEquals(AsyncHttpClientConfigDefaults.defaultUserAgent(), "AHC/2.1"); + testStringSystemProperty("userAgent", "defaultUserAgent", "MyAHC"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultUseProxySelector() { + assertFalse(AsyncHttpClientConfigDefaults.defaultUseProxySelector()); + testBooleanSystemProperty("useProxySelector", "defaultUseProxySelector", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultUseProxyProperties() { + assertFalse(AsyncHttpClientConfigDefaults.defaultUseProxyProperties()); + testBooleanSystemProperty("useProxyProperties", "defaultUseProxyProperties", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultStrict302Handling() { + assertFalse(AsyncHttpClientConfigDefaults.defaultStrict302Handling()); + testBooleanSystemProperty("strict302Handling", "defaultStrict302Handling", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultAllowPoolingConnection() { + assertTrue(AsyncHttpClientConfigDefaults.defaultKeepAlive()); + testBooleanSystemProperty("keepAlive", "defaultKeepAlive", "false"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultMaxRequestRetry() { + assertEquals(AsyncHttpClientConfigDefaults.defaultMaxRequestRetry(), 5); + testIntegerSystemProperty("maxRequestRetry", "defaultMaxRequestRetry", "100"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultDisableUrlEncodingForBoundRequests() { + assertFalse(AsyncHttpClientConfigDefaults.defaultDisableUrlEncodingForBoundRequests()); + testBooleanSystemProperty("disableUrlEncodingForBoundRequests", "defaultDisableUrlEncodingForBoundRequests", "true"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultUseInsecureTrustManager() { + assertFalse(AsyncHttpClientConfigDefaults.defaultUseInsecureTrustManager()); + testBooleanSystemProperty("useInsecureTrustManager", "defaultUseInsecureTrustManager", "false"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultHashedWheelTimerTickDuration() { + assertEquals(AsyncHttpClientConfigDefaults.defaultHashedWheelTimerTickDuration(), 100); + testIntegerSystemProperty("hashedWheelTimerTickDuration", "defaultHashedWheelTimerTickDuration", "100"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultHashedWheelTimerSize() { + assertEquals(AsyncHttpClientConfigDefaults.defaultHashedWheelTimerSize(), 512); + testIntegerSystemProperty("hashedWheelTimerSize", "defaultHashedWheelTimerSize", "512"); + } + + private void testIntegerSystemProperty(String propertyName, String methodName, String value) { + String previous = System.getProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, value); + AsyncHttpClientConfigHelper.reloadProperties(); + try { + Method method = AsyncHttpClientConfigDefaults.class.getMethod(methodName); + assertEquals(method.invoke(null), Integer.parseInt(value)); + } catch (Exception e) { + fail("Couldn't find or execute method : " + methodName, e); + } + if (previous != null) { + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, previous); + } else { + System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + } + } + + private static void testBooleanSystemProperty(String propertyName, String methodName, String value) { + String previous = System.getProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, value); + AsyncHttpClientConfigHelper.reloadProperties(); + try { + Method method = AsyncHttpClientConfigDefaults.class.getMethod(methodName); + assertEquals(method.invoke(null), Boolean.parseBoolean(value)); + } catch (Exception e) { + fail("Couldn't find or execute method : " + methodName, e); + } + if (previous != null) { + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, previous); + } else { + System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + } + } + + private static void testStringSystemProperty(String propertyName, String methodName, String value) { + String previous = System.getProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, value); + AsyncHttpClientConfigHelper.reloadProperties(); + try { + Method method = AsyncHttpClientConfigDefaults.class.getMethod(methodName); + assertEquals(method.invoke(null), value); + } catch (Exception e) { + fail("Couldn't find or execute method : " + methodName, e); + } + if (previous != null) { + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, previous); + } else { + System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + } + } + + private static void testDurationSystemProperty(String propertyName, String methodName, String value) { + String previous = System.getProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, value); + AsyncHttpClientConfigHelper.reloadProperties(); + try { + Method method = AsyncHttpClientConfigDefaults.class.getMethod(methodName); + assertEquals(method.invoke(null), Duration.parse(value)); + } catch (Exception e) { + fail("Couldn't find or execute method : " + methodName, e); + } + if (previous != null) { + System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, previous); + } else { + System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/AsyncStreamHandlerTest.java b/client/src/test/java/org/asynchttpclient/AsyncStreamHandlerTest.java new file mode 100644 index 0000000000..90a515fca4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AsyncStreamHandlerTest.java @@ -0,0 +1,520 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.testserver.HttpServer; +import org.asynchttpclient.testserver.HttpTest; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Timeout; + +import java.util.Arrays; +import java.util.Map; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; + +import static io.netty.handler.codec.http.HttpHeaderNames.ALLOW; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.LOCATION; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.AsyncHandlerAdapter; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.TIMEOUT; +import static org.asynchttpclient.test.TestUtils.assertContentTypesEquals; +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +public class AsyncStreamHandlerTest extends HttpTest { + + private static final String RESPONSE = "param_1=value_1"; + + private HttpServer server; + + @BeforeEach + public void start() throws Throwable { + server = new HttpServer(); + server.start(); + } + + @AfterEach + public void stop() throws Throwable { + server.close(); + } + + private String getTargetUrl() { + return server.getHttpUrl() + "/foo/bar"; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getWithOnHeadersReceivedAbort() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + client.prepareGet(getTargetUrl()).execute(new AsyncHandlerAdapter() { + + @Override + public State onHeadersReceived(HttpHeaders headers) { + assertContentTypesEquals(headers.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + return State.ABORT; + } + }).get(5, TimeUnit.SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStreamPOSTTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + String responseBody = client.preparePost(getTargetUrl()) + .setHeader(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED) + .addFormParam("param_1", "value_1") + .execute(new AsyncHandlerAdapter() { + private final StringBuilder builder = new StringBuilder(); + + @Override + public State onHeadersReceived(HttpHeaders headers) { + assertContentTypesEquals(headers.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + for (Map.Entry header : headers) { + if (header.getKey().startsWith("X-param")) { + builder.append(header.getKey().substring(2)).append('=').append(header.getValue()).append('&'); + } + } + return State.CONTINUE; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) { + return State.CONTINUE; + } + + @Override + public String onCompleted() { + if (builder.length() > 0) { + builder.setLength(builder.length() - 1); + } + return builder.toString(); + } + }).get(10, TimeUnit.SECONDS); + + assertEquals(responseBody, RESPONSE); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStreamInterruptTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + final AtomicBoolean onHeadersReceived = new AtomicBoolean(); + final AtomicBoolean onBodyPartReceived = new AtomicBoolean(); + final AtomicBoolean onThrowable = new AtomicBoolean(); + + client.preparePost(getTargetUrl()) + .setHeader(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED) + .addFormParam("param_1", "value_1") + .execute(new AsyncHandlerAdapter() { + + @Override + public State onHeadersReceived(HttpHeaders headers) { + onHeadersReceived.set(true); + assertContentTypesEquals(headers.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + return State.ABORT; + } + + @Override + public State onBodyPartReceived(final HttpResponseBodyPart content) { + onBodyPartReceived.set(true); + return State.ABORT; + } + + @Override + public void onThrowable(Throwable t) { + onThrowable.set(true); + } + }).get(5, TimeUnit.SECONDS); + + assertTrue(onHeadersReceived.get(), "Headers weren't received"); + assertFalse(onBodyPartReceived.get(), "Abort not working"); + assertFalse(onThrowable.get(), "Shouldn't get an exception"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStreamFutureTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + final AtomicBoolean onHeadersReceived = new AtomicBoolean(); + final AtomicBoolean onThrowable = new AtomicBoolean(); + + String responseBody = client.preparePost(getTargetUrl()) + .addFormParam("param_1", "value_1") + .execute(new AsyncHandlerAdapter() { + private final StringBuilder builder = new StringBuilder(); + + @Override + public State onHeadersReceived(HttpHeaders headers) { + assertContentTypesEquals(headers.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + onHeadersReceived.set(true); + for (Map.Entry header : headers) { + if (header.getKey().startsWith("X-param")) { + builder.append(header.getKey().substring(2)).append('=').append(header.getValue()).append('&'); + } + } + return State.CONTINUE; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) { + return State.CONTINUE; + } + + @Override + public String onCompleted() { + if (builder.length() > 0) { + builder.setLength(builder.length() - 1); + } + return builder.toString().trim(); + } + + @Override + public void onThrowable(Throwable t) { + onThrowable.set(true); + } + }).get(5, TimeUnit.SECONDS); + + assertTrue(onHeadersReceived.get(), "Headers weren't received"); + assertFalse(onThrowable.get(), "Shouldn't get an exception"); + assertEquals(responseBody, RESPONSE, "Unexpected response body"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStreamThrowableRefusedTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + final CountDownLatch l = new CountDownLatch(1); + client.prepareGet(getTargetUrl()).execute(new AsyncHandlerAdapter() { + + @Override + public State onHeadersReceived(HttpHeaders headers) { + throw unknownStackTrace(new RuntimeException("FOO"), AsyncStreamHandlerTest.class, "asyncStreamThrowableRefusedTest"); + } + + @Override + public void onThrowable(Throwable t) { + try { + if (t.getMessage() != null) { + assertEquals(t.getMessage(), "FOO"); + } + } finally { + l.countDown(); + } + } + }); + + if (!l.await(10, TimeUnit.SECONDS)) { + fail("Timed out"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStreamReusePOSTTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + final AtomicReference responseHeaders = new AtomicReference<>(); + + BoundRequestBuilder rb = client.preparePost(getTargetUrl()) + .setHeader(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED) + .addFormParam("param_1", "value_1"); + + Future f = rb.execute(new AsyncHandlerAdapter() { + private final StringBuilder builder = new StringBuilder(); + + @Override + public State onHeadersReceived(HttpHeaders headers) { + responseHeaders.set(headers); + for (Map.Entry header : headers) { + if (header.getKey().startsWith("X-param")) { + builder.append(header.getKey().substring(2)).append('=').append(header.getValue()).append('&'); + } + } + return State.CONTINUE; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) { + return State.CONTINUE; + } + + @Override + public String onCompleted() { + if (builder.length() > 0) { + builder.setLength(builder.length() - 1); + } + return builder.toString(); + } + }); + + String r = f.get(5, TimeUnit.SECONDS); + HttpHeaders h = responseHeaders.get(); + assertNotNull(h, "Should receive non null headers"); + assertContentTypesEquals(h.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + assertNotNull(r, "No response body"); + assertEquals(r.trim(), RESPONSE, "Unexpected response body"); + + responseHeaders.set(null); + + server.enqueueEcho(); + + // Let do the same again + f = rb.execute(new AsyncHandlerAdapter() { + private final StringBuilder builder = new StringBuilder(); + + @Override + public State onHeadersReceived(HttpHeaders headers) { + responseHeaders.set(headers); + return State.CONTINUE; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) { + builder.append(new String(content.getBodyPartBytes())); + return State.CONTINUE; + } + + @Override + public String onCompleted() { + return builder.toString(); + } + }); + + f.get(5, TimeUnit.SECONDS); + h = responseHeaders.get(); + assertNotNull(h, "Should receive non null headers"); + assertContentTypesEquals(h.get(CONTENT_TYPE), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + assertNotNull(r, "No response body"); + assertEquals(r.trim(), RESPONSE, "Unexpected response body"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncStream302RedirectWithBody() throws Throwable { + withClient(config().setFollowRedirect(true)).run(client -> + withServer(server).run(server -> { + + String originalUrl = server.getHttpUrl() + "/original"; + String redirectUrl = server.getHttpUrl() + "/redirect"; + + server.enqueueResponse(response -> { + response.setStatus(302); + response.setHeader(LOCATION.toString(), redirectUrl); + response.getOutputStream().println("You are being asked to redirect to " + redirectUrl); + }); + server.enqueueOk(); + + Response response = client.prepareGet(originalUrl).execute().get(20, TimeUnit.SECONDS); + + assertEquals(response.getStatusCode(), 200); + assertTrue(response.getResponseBody().isEmpty()); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 3000) + public void asyncStreamJustStatusLine() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + server.enqueueEcho(); + + final int STATUS = 0; + final int COMPLETED = 1; + final int OTHER = 2; + final boolean[] whatCalled = {false, false, false}; + final CountDownLatch latch = new CountDownLatch(1); + Future statusCode = client.prepareGet(getTargetUrl()).execute(new AsyncHandler() { + private int status = -1; + + @Override + public void onThrowable(Throwable t) { + whatCalled[OTHER] = true; + latch.countDown(); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) { + whatCalled[OTHER] = true; + latch.countDown(); + return State.ABORT; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + whatCalled[STATUS] = true; + status = responseStatus.getStatusCode(); + latch.countDown(); + return State.ABORT; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) { + whatCalled[OTHER] = true; + latch.countDown(); + return State.ABORT; + } + + @Override + public Integer onCompleted() { + whatCalled[COMPLETED] = true; + latch.countDown(); + return status; + } + }); + + if (!latch.await(2, TimeUnit.SECONDS)) { + fail("Timeout"); + return; + } + Integer status = statusCode.get(TIMEOUT, TimeUnit.SECONDS); + assertEquals((int) status, 200, "Expected status code failed."); + + if (!whatCalled[STATUS]) { + fail("onStatusReceived not called."); + } + if (!whatCalled[COMPLETED]) { + fail("onCompleted not called."); + } + if (whatCalled[OTHER]) { + fail("Other method of AsyncHandler got called."); + } + })); + } + + // This test is flaky - see https://github.com/AsyncHttpClient/async-http-client/issues/1728#issuecomment-699962325 + // For now, just run again if fails + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncOptionsTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + final AtomicReference responseHeaders = new AtomicReference<>(); + + // Some responses contain the TRACE method, some do not - account for both + final String[] expected = {"GET", "HEAD", "OPTIONS", "POST"}; + final String[] expectedWithTrace = {"GET", "HEAD", "OPTIONS", "POST", "TRACE"}; + Future f = client.prepareOptions("https://www.google.com/").execute(new AsyncHandlerAdapter() { + + @Override + public State onHeadersReceived(HttpHeaders headers) { + responseHeaders.set(headers); + return State.ABORT; + } + + @Override + public String onCompleted() { + return "OK"; + } + }); + + f.get(20, TimeUnit.SECONDS); + HttpHeaders h = responseHeaders.get(); + assertNotNull(h); + if (h.contains(ALLOW)) { + String[] values = h.get(ALLOW).split(",|, "); + assertNotNull(values); + // Some responses contain the TRACE method, some do not - account for both + assert values.length == expected.length || values.length == expectedWithTrace.length; + Arrays.sort(values); + // Some responses contain the TRACE method, some do not - account for both + if (values.length == expected.length) { + assertArrayEquals(values, expected); + } else { + assertArrayEquals(values, expectedWithTrace); + } + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void closeConnectionTest() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + + Response r = client.prepareGet(getTargetUrl()).execute(new AsyncHandler() { + + private final Response.ResponseBuilder builder = new Response.ResponseBuilder(); + + @Override + public State onHeadersReceived(HttpHeaders headers) { + builder.accumulate(headers); + return State.CONTINUE; + } + + @Override + public void onThrowable(Throwable t) { + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) { + builder.accumulate(content); + return content.isLast() ? State.ABORT : State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + builder.accumulate(responseStatus); + + return State.CONTINUE; + } + + @Override + public Response onCompleted() { + return builder.build(); + } + }).get(); + + assertNotNull(r); + assertEquals(r.getStatusCode(), 200); + })); + } +} diff --git a/client/src/test/java/org/asynchttpclient/AsyncStreamLifecycleTest.java b/client/src/test/java/org/asynchttpclient/AsyncStreamLifecycleTest.java new file mode 100644 index 0000000000..9b290f82ed --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AsyncStreamLifecycleTest.java @@ -0,0 +1,148 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.AsyncContext; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterAll; + +import java.io.IOException; +import java.io.PrintWriter; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Tests default asynchronous life cycle. + * + * @author Hubert Iwaniuk + */ +public class AsyncStreamLifecycleTest extends AbstractBasicTest { + private static final ExecutorService executorService = Executors.newFixedThreadPool(2); + + @Override + @AfterAll + public void tearDownGlobal() throws Exception { + super.tearDownGlobal(); + executorService.shutdownNow(); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + @Override + public void handle(String s, Request request, HttpServletRequest req, final HttpServletResponse resp) throws IOException { + resp.setContentType("text/plain;charset=utf-8"); + resp.setStatus(200); + final AsyncContext asyncContext = request.startAsync(); + final PrintWriter writer = resp.getWriter(); + executorService.submit(() -> { + try { + Thread.sleep(100); + } catch (InterruptedException e) { + logger.error("Failed to sleep for 100 ms.", e); + } + logger.info("Delivering part1."); + writer.write("part1"); + writer.flush(); + }); + executorService.submit(() -> { + try { + Thread.sleep(200); + } catch (InterruptedException e) { + logger.error("Failed to sleep for 200 ms.", e); + } + logger.info("Delivering part2."); + writer.write("part2"); + writer.flush(); + asyncContext.complete(); + }); + request.setHandled(true); + } + }; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testStream() throws Exception { + try (AsyncHttpClient ahc = asyncHttpClient()) { + final AtomicBoolean err = new AtomicBoolean(false); + final LinkedBlockingQueue queue = new LinkedBlockingQueue<>(); + final AtomicBoolean status = new AtomicBoolean(false); + final AtomicInteger headers = new AtomicInteger(0); + final CountDownLatch latch = new CountDownLatch(1); + ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build(), new AsyncHandler() { + @Override + public void onThrowable(Throwable t) { + fail("Got throwable.", t); + err.set(true); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart e) throws Exception { + if (e.length() != 0) { + String s = new String(e.getBodyPartBytes()); + logger.info("got part: {}", s); + queue.put(s); + } + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus e) { + status.set(true); + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders e) throws Exception { + if (headers.incrementAndGet() == 2) { + throw new Exception("Analyze this."); + } + return State.CONTINUE; + } + + @Override + public Object onCompleted() { + latch.countDown(); + return null; + } + }); + + assertTrue(latch.await(1, TimeUnit.SECONDS), "Latch failed."); + assertFalse(err.get()); + assertEquals(queue.size(), 2); + assertTrue(queue.contains("part1")); + assertTrue(queue.contains("part2")); + assertTrue(status.get()); + assertEquals(headers.get(), 1); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/AuthTimeoutTest.java b/client/src/test/java/org/asynchttpclient/AuthTimeoutTest.java new file mode 100644 index 0000000000..e23328d7a4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AuthTimeoutTest.java @@ -0,0 +1,201 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Disabled; + +import java.io.IOException; +import java.io.OutputStream; +import java.time.Duration; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.basicAuthRealm; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.digestAuthRealm; +import static org.asynchttpclient.test.TestUtils.ADMIN; +import static org.asynchttpclient.test.TestUtils.USER; +import static org.asynchttpclient.test.TestUtils.addBasicAuthHandler; +import static org.asynchttpclient.test.TestUtils.addDigestAuthHandler; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class AuthTimeoutTest extends AbstractBasicTest { + + private static final Duration REQUEST_TIMEOUT = Duration.ofSeconds(1); + private static final int SHORT_FUTURE_TIMEOUT = 500; // shorter than REQUEST_TIMEOUT + private static final int LONG_FUTURE_TIMEOUT = 1500; // longer than REQUEST_TIMEOUT + + private Server server2; + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + addBasicAuthHandler(server, configureHandler()); + server.start(); + port1 = connector1.getLocalPort(); + + server2 = new Server(); + ServerConnector connector2 = addHttpConnector(server2); + addDigestAuthHandler(server2, configureHandler()); + server2.start(); + port2 = connector2.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + super.tearDownGlobal(); + server2.stop(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + execute(client, true, false).get(LONG_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS); + } catch (Exception ex) { + assertInstanceOf(TimeoutException.class, ex.getCause()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicPreemptiveAuthTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + execute(client, true, true).get(LONG_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS); + } catch (Exception ex) { + assertInstanceOf(TimeoutException.class, ex.getCause()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void digestAuthTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + execute(client, false, false).get(LONG_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS); + } catch (Exception ex) { + assertInstanceOf(TimeoutException.class, ex.getCause()); + } + } + + @Disabled + @RepeatedIfExceptionsTest(repeats = 5) + public void digestPreemptiveAuthTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + assertThrows(TimeoutException.class, () -> execute(client, false, true).get(LONG_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthFutureTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + assertThrows(TimeoutException.class, () -> execute(client, true, false).get(SHORT_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicPreemptiveAuthFutureTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + assertThrows(TimeoutException.class, () -> execute(client, true, true).get(SHORT_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void digestAuthFutureTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + assertThrows(TimeoutException.class, () -> execute(client, false, false).get(SHORT_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS)); + } + } + + @Disabled + @RepeatedIfExceptionsTest(repeats = 5) + public void digestPreemptiveAuthFutureTimeoutTest() throws Throwable { + try (AsyncHttpClient client = newClient()) { + assertThrows(TimeoutException.class, () -> execute(client, false, true).get(SHORT_FUTURE_TIMEOUT, TimeUnit.MILLISECONDS)); + } + } + + private static AsyncHttpClient newClient() { + return asyncHttpClient(config().setRequestTimeout(REQUEST_TIMEOUT)); + } + + protected Future execute(AsyncHttpClient client, boolean basic, boolean preemptive) { + Realm.Builder realm; + String url; + + if (basic) { + realm = basicAuthRealm(USER, ADMIN); + url = getTargetUrl(); + } else { + realm = digestAuthRealm(USER, ADMIN); + url = getTargetUrl2(); + if (preemptive) { + realm.setRealmName("MyRealm"); + realm.setAlgorithm("MD5"); + realm.setQop("auth"); + realm.setNonce("fFDVc60re9zt8fFDvht0tNrYuvqrcchN"); + } + } + + return client.prepareGet(url).setRealm(realm.setUsePreemptiveAuth(preemptive).build()).execute(); + } + + @Override + protected String getTargetUrl() { + return "http://localhost/" + port1 + '/'; + } + + @Override + protected String getTargetUrl2() { + return "http://localhost/" + port2 + '/'; + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new IncompleteResponseHandler(); + } + + private static class IncompleteResponseHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + // NOTE: handler sends less bytes than are given in Content-Length, which should lead to timeout + response.setStatus(200); + OutputStream out = response.getOutputStream(); + response.setIntHeader(CONTENT_LENGTH.toString(), 1000); + out.write(0); + out.flush(); + try { + Thread.sleep(LONG_FUTURE_TIMEOUT + 100); + } catch (InterruptedException e) { + // + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/AutomaticDecompressionTest.java b/client/src/test/java/org/asynchttpclient/AutomaticDecompressionTest.java new file mode 100644 index 0000000000..8f57ffb88f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/AutomaticDecompressionTest.java @@ -0,0 +1,166 @@ +/* + * Copyright (c) 2015-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import com.aayushatharva.brotli4j.encoder.BrotliOutputStream; +import com.aayushatharva.brotli4j.encoder.Encoder; +import com.github.luben.zstd.Zstd; +import com.sun.net.httpserver.Headers; +import com.sun.net.httpserver.HttpExchange; +import com.sun.net.httpserver.HttpHandler; +import com.sun.net.httpserver.HttpServer; +import io.github.nettyplus.leakdetector.junit.NettyLeakDetectorExtension; +import io.netty.handler.codec.compression.Brotli; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.io.OutputStream; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collectors; +import java.util.zip.GZIPOutputStream; +import org.junit.jupiter.api.extension.ExtendWith; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ExtendWith(NettyLeakDetectorExtension.class) +public class AutomaticDecompressionTest { + private static final String UNCOMPRESSED_PAYLOAD = "a".repeat(50_000); + + private static HttpServer HTTP_SERVER; + + private static AsyncHttpClient createClient() { + AsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setEnableAutomaticDecompression(true) + .setCompressionEnforced(true) + .build(); + return new DefaultAsyncHttpClient(config); + } + + @BeforeAll + static void setupServer() throws Exception { + HTTP_SERVER = HttpServer.create(new InetSocketAddress(0), 0); + + HTTP_SERVER.createContext("/br").setHandler(new HttpHandler() { + @Override + public void handle(HttpExchange exchange) + throws IOException { + validateAcceptEncodingHeader(exchange); + exchange.getResponseHeaders().set("Content-Encoding", "br"); + exchange.sendResponseHeaders(200, 0); + OutputStream out = exchange.getResponseBody(); + Encoder.Parameters params = new Encoder.Parameters(); + BrotliOutputStream brotliOutputStream = new BrotliOutputStream(out, params); + brotliOutputStream.write(UNCOMPRESSED_PAYLOAD.getBytes(StandardCharsets.UTF_8)); + brotliOutputStream.flush(); + brotliOutputStream.close(); + } + }); + + HTTP_SERVER.createContext("/zstd").setHandler(new HttpHandler() { + @Override + public void handle(HttpExchange exchange) + throws IOException { + validateAcceptEncodingHeader(exchange); + exchange.getResponseHeaders().set("Content-Encoding", "zstd"); + byte[] compressedData = new byte[UNCOMPRESSED_PAYLOAD.length()]; + long n = Zstd.compress(compressedData, UNCOMPRESSED_PAYLOAD.getBytes(StandardCharsets.UTF_8), 2, true); + exchange.sendResponseHeaders(200, n); + OutputStream out = exchange.getResponseBody(); + out.write(compressedData, 0, (int) n); + out.flush(); + out.close(); + } + }); + + HTTP_SERVER.createContext("/gzip").setHandler(new HttpHandler() { + @Override + public void handle(HttpExchange exchange) + throws IOException { + validateAcceptEncodingHeader(exchange); + exchange.getResponseHeaders().set("Content-Encoding", "gzip"); + exchange.sendResponseHeaders(200, 0); + OutputStream out = exchange.getResponseBody(); + GZIPOutputStream gzip = new GZIPOutputStream(out); + gzip.write(UNCOMPRESSED_PAYLOAD.getBytes(StandardCharsets.UTF_8)); + gzip.flush(); + gzip.close(); + } + }); + + HTTP_SERVER.start(); + } + + private static void validateAcceptEncodingHeader(HttpExchange exchange) { + Headers requestHeaders = exchange.getRequestHeaders(); + List acceptEncodingList = requestHeaders.get("Accept-Encoding") + .stream() + .flatMap(x -> Arrays.asList(x.split(",")).stream()) + .collect(Collectors.toList()); + assertEquals(List.of("gzip", "deflate", "br", "zstd"), acceptEncodingList); + } + + @AfterAll + static void stopServer() { + if (HTTP_SERVER != null) { + HTTP_SERVER.stop(0); + } + } + + @Test + void zstd() throws Throwable { + io.netty.handler.codec.compression.Zstd.ensureAvailability(); + try (AsyncHttpClient client = createClient()) { + Request request = new RequestBuilder("GET") + .setUrl("http://localhost/" + HTTP_SERVER.getAddress().getPort() + "/zstd") + .build(); + Response response = client.executeRequest(request).get(); + assertEquals(200, response.getStatusCode()); + assertEquals(UNCOMPRESSED_PAYLOAD, response.getResponseBody()); + } + } + + @Test + void brotli() throws Throwable { + Brotli.ensureAvailability(); + try (AsyncHttpClient client = createClient()) { + Request request = new RequestBuilder("GET") + .setUrl("http://localhost/" + HTTP_SERVER.getAddress().getPort() + "/br") + .build(); + Response response = client.executeRequest(request).get(); + assertEquals(200, response.getStatusCode()); + assertEquals(UNCOMPRESSED_PAYLOAD, response.getResponseBody()); + } + } + + @Test + void gzip() throws Throwable { + try (AsyncHttpClient client = createClient()) { + Request request = new RequestBuilder("GET") + .setUrl("http://localhost/" + HTTP_SERVER.getAddress().getPort() + "/gzip") + .build(); + Response response = client.executeRequest(request).get(); + assertEquals(200, response.getStatusCode()); + assertEquals(UNCOMPRESSED_PAYLOAD, response.getResponseBody()); + } + } + + +} diff --git a/client/src/test/java/org/asynchttpclient/BasicAuthTest.java b/client/src/test/java/org/asynchttpclient/BasicAuthTest.java new file mode 100644 index 0000000000..af1ee7b57a --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/BasicAuthTest.java @@ -0,0 +1,349 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.basicAuthRealm; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.ADMIN; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE_STRING; +import static org.asynchttpclient.test.TestUtils.USER; +import static org.asynchttpclient.test.TestUtils.addBasicAuthHandler; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class BasicAuthTest extends AbstractBasicTest { + + private Server server2; + private Server serverNoAuth; + private int portNoAuth; + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + addBasicAuthHandler(server, configureHandler()); + server.start(); + port1 = connector1.getLocalPort(); + + server2 = new Server(); + ServerConnector connector2 = addHttpConnector(server2); + addBasicAuthHandler(server2, new RedirectHandler()); + server2.start(); + port2 = connector2.getLocalPort(); + + // need noAuth server to verify the preemptive auth mode (see basicAuthTestPreemptiveTest) + serverNoAuth = new Server(); + ServerConnector connectorNoAuth = addHttpConnector(serverNoAuth); + serverNoAuth.setHandler(new SimpleHandler()); + serverNoAuth.start(); + portNoAuth = connectorNoAuth.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + super.tearDownGlobal(); + server2.stop(); + serverNoAuth.stop(); + } + + @Override + protected String getTargetUrl() { + return "http://localhost/" + port1 + '/'; + } + + @Override + protected String getTargetUrl2() { + return "http://localhost/" + port2 + "/uff"; + } + + private String getTargetUrlNoAuth() { + return "http://localhost/" + portNoAuth + '/'; + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SimpleHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet(getTargetUrl()) + .setRealm(basicAuthRealm(USER, ADMIN).build()) + .execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void redirectAndBasicAuthTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setFollowRedirect(true).setMaxRedirects(10))) { + Future f = client.prepareGet(getTargetUrl2()) + .setRealm(basicAuthRealm(USER, ADMIN).build()) + .execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basic401Test() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()) + .setHeader("X-401", "401") + .setRealm(basicAuthRealm(USER, ADMIN).build()); + + Future f = r.execute(new AsyncHandler() { + + private HttpResponseStatus status; + + @Override + public void onThrowable(Throwable t) { + + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) { + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + status = responseStatus; + + if (status.getStatusCode() != 200) { + return State.ABORT; + } + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) { + return State.CONTINUE; + } + + @Override + public Integer onCompleted() { + return status.getStatusCode(); + } + }); + Integer statusCode = f.get(10, TimeUnit.SECONDS); + assertNotNull(statusCode); + assertEquals(statusCode.intValue(), 401); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthTestPreemptiveTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + // send the request to the no-auth endpoint to be able to verify the + // auth header is really sent preemptively for the initial call. + Future f = client.prepareGet(getTargetUrlNoAuth()) + .setRealm(basicAuthRealm(USER, ADMIN).setUsePreemptiveAuth(true).build()) + .execute(); + + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthNegativeTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet(getTargetUrl()) + .setRealm(basicAuthRealm("fake", ADMIN).build()) + .execute(); + + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), 401); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthInputStreamTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost(getTargetUrl()) + .setBody(new ByteArrayInputStream("test".getBytes())) + .setRealm(basicAuthRealm(USER, ADMIN).build()) + .execute(); + + Response resp = f.get(30, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), "test"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthFileTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost(getTargetUrl()) + .setBody(SIMPLE_TEXT_FILE) + .setRealm(basicAuthRealm(USER, ADMIN).build()) + .execute(); + + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthAsyncConfigTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setRealm(basicAuthRealm(USER, ADMIN)))) { + Future f = client.preparePost(getTargetUrl()) + .setBody(SIMPLE_TEXT_FILE_STRING) + .execute(); + + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicAuthFileNoKeepAliveTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(false))) { + + Future f = client.preparePost(getTargetUrl()) + .setBody(SIMPLE_TEXT_FILE) + .setRealm(basicAuthRealm(USER, ADMIN).build()) + .execute(); + + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void noneAuthTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()).setRealm(basicAuthRealm(USER, ADMIN).build()); + + Future f = r.execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertNotNull(resp.getHeader("X-Auth")); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + private static class RedirectHandler extends AbstractHandler { + + private static final Logger LOGGER = LoggerFactory.getLogger(RedirectHandler.class); + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + + LOGGER.info("request: " + request.getRequestURI()); + + if ("/uff".equals(request.getRequestURI())) { + LOGGER.info("redirect to /bla"); + response.setStatus(302); + response.setContentLength(0); + response.setHeader("Location", "/bla"); + + } else { + LOGGER.info("got redirected" + request.getRequestURI()); + response.setStatus(200); + response.addHeader("X-Auth", request.getHeader("Authorization")); + response.addHeader("X-" + CONTENT_LENGTH, String.valueOf(request.getContentLength())); + byte[] b = "content".getBytes(UTF_8); + response.setContentLength(b.length); + response.getOutputStream().write(b); + } + response.getOutputStream().flush(); + response.getOutputStream().close(); + } + } + + public static class SimpleHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + + if (request.getHeader("X-401") != null) { + response.setStatus(401); + response.setContentLength(0); + + } else { + response.addHeader("X-Auth", request.getHeader("Authorization")); + response.addHeader("X-" + CONTENT_LENGTH, String.valueOf(request.getContentLength())); + response.setIntHeader("X-" + CONTENT_LENGTH, request.getContentLength()); + response.setStatus(200); + + int size = 10 * 1024; + byte[] bytes = new byte[size]; + int contentLength = 0; + int read; + do { + read = request.getInputStream().read(bytes); + if (read > 0) { + contentLength += read; + response.getOutputStream().write(bytes, 0, read); + } + } while (read >= 0); + response.setContentLength(contentLength); + } + response.getOutputStream().flush(); + response.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpTest.java b/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpTest.java new file mode 100644 index 0000000000..6845152d85 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpTest.java @@ -0,0 +1,135 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.test.EchoHandler; +import org.eclipse.jetty.proxy.ProxyServlet; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.servlet.ServletHandler; +import org.eclipse.jetty.servlet.ServletHolder; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.concurrent.Future; + +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHENTICATE; +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.asynchttpclient.Dsl.realm; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * Test that validates that when having an HTTP proxy and trying to access an HTTP through the proxy the proxy credentials should be passed after it gets a 407 response. + */ +public class BasicHttpProxyToHttpTest { + + private static final Logger LOGGER = LoggerFactory.getLogger(BasicHttpProxyToHttpTest.class); + + private int httpPort; + private int proxyPort; + + private Server httpServer; + private Server proxy; + + @BeforeEach + public void setUpGlobal() throws Exception { + httpServer = new Server(); + ServerConnector connector1 = addHttpConnector(httpServer); + httpServer.setHandler(new EchoHandler()); + httpServer.start(); + httpPort = connector1.getLocalPort(); + + proxy = new Server(); + ServerConnector connector2 = addHttpConnector(proxy); + ServletHandler servletHandler = new ServletHandler(); + ServletHolder servletHolder = servletHandler.addServletWithMapping(BasicAuthProxyServlet.class, "/*"); + servletHolder.setInitParameter("maxThreads", "20"); + proxy.setHandler(servletHandler); + proxy.start(); + proxyPort = connector2.getLocalPort(); + + LOGGER.info("Local HTTP Server (" + httpPort + "), Proxy (" + proxyPort + ") started successfully"); + } + + @AfterEach + public void tearDownGlobal() { + if (proxy != null) { + try { + proxy.stop(); + } catch (Exception e) { + LOGGER.error("Failed to properly close proxy", e); + } + } + if (httpServer != null) { + try { + httpServer.stop(); + } catch (Exception e) { + LOGGER.error("Failed to properly close server", e); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void nonPreemptiveProxyAuthWithPlainHttpTarget() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + String targetUrl = "http://localhost/" + httpPort + "/foo/bar"; + Request request = get(targetUrl) + .setProxyServer(proxyServer("127.0.0.1", proxyPort).setRealm(realm(AuthScheme.BASIC, "johndoe", "pass"))) + // .setRealm(realm(AuthScheme.BASIC, "user", "passwd")) + .build(); + Future responseFuture = client.executeRequest(request); + Response response = responseFuture.get(); + + assertEquals(response.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals("/foo/bar", response.getHeader("X-pathInfo")); + } + } + + @SuppressWarnings("serial") + public static class BasicAuthProxyServlet extends ProxyServlet { + + @Override + protected void service(final HttpServletRequest request, final HttpServletResponse response) throws ServletException, IOException { + LOGGER.debug(">>> got a request !"); + + String authorization = request.getHeader(PROXY_AUTHORIZATION.toString()); + if (authorization == null) { + response.setStatus(HttpServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED); + response.setHeader(PROXY_AUTHENTICATE.toString(), "Basic realm=\"Fake Realm\""); + response.getOutputStream().flush(); + + } else if ("Basic am9obmRvZTpwYXNz".equals(authorization)) { + super.service(request, response); + + } else { + response.setStatus(HttpServletResponse.SC_UNAUTHORIZED); + response.getOutputStream().flush(); + } + } + } +} \ No newline at end of file diff --git a/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpsTest.java b/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpsTest.java new file mode 100644 index 0000000000..51d24af7c4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/BasicHttpProxyToHttpsTest.java @@ -0,0 +1,129 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.Realm.AuthScheme; +import org.asynchttpclient.test.EchoHandler; +import org.eclipse.jetty.proxy.ConnectHandler; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.concurrent.Future; + +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHENTICATE; +import static io.netty.handler.codec.http.HttpHeaderNames.PROXY_AUTHORIZATION; +import static io.netty.handler.codec.http.HttpHeaderNames.USER_AGENT; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.asynchttpclient.Dsl.realm; +import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.defaultUserAgent; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * Test that validates that when having an HTTP proxy and trying to access an HTTPS + * through the proxy the proxy credentials and a custom user-agent (if set) should be passed during the CONNECT request. + */ +public class BasicHttpProxyToHttpsTest { + + private static final Logger LOGGER = LoggerFactory.getLogger(BasicHttpProxyToHttpsTest.class); + private static final String CUSTOM_USER_AGENT = "custom-user-agent"; + + private int httpPort; + private int proxyPort; + + private Server httpServer; + private Server proxy; + + @BeforeEach + public void setUpGlobal() throws Exception { + // HTTP server + httpServer = new Server(); + ServerConnector connector1 = addHttpsConnector(httpServer); + httpServer.setHandler(new EchoHandler()); + httpServer.start(); + httpPort = connector1.getLocalPort(); + + // proxy + proxy = new Server(); + ServerConnector connector2 = addHttpConnector(proxy); + ConnectHandler connectHandler = new ConnectHandler() { + + @Override + // This proxy receives a CONNECT request from the client before making the real request for the target host. + protected boolean handleAuthentication(HttpServletRequest request, HttpServletResponse response, String address) { + + // If the userAgent of the CONNECT request is the same as the default userAgent, + // then the custom userAgent was not properly propagated and the test should fail. + String userAgent = request.getHeader(USER_AGENT.toString()); + if (userAgent.equals(defaultUserAgent())) { + return false; + } + + // If the authentication failed, the test should also fail. + String authorization = request.getHeader(PROXY_AUTHORIZATION.toString()); + if (authorization == null) { + response.setStatus(HttpServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED); + response.setHeader(PROXY_AUTHENTICATE.toString(), "Basic realm=\"Fake Realm\""); + return false; + } + if ("Basic am9obmRvZTpwYXNz".equals(authorization)) { + return true; + } + response.setStatus(HttpServletResponse.SC_UNAUTHORIZED); + return false; + } + }; + proxy.setHandler(connectHandler); + proxy.start(); + proxyPort = connector2.getLocalPort(); + + LOGGER.info("Local HTTP Server (" + httpPort + "), Proxy (" + proxyPort + ") started successfully"); + } + + @AfterEach + public void tearDownGlobal() throws Exception { + httpServer.stop(); + proxy.stop(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void nonPreemptiveProxyAuthWithHttpsTarget() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setUseInsecureTrustManager(true))) { + String targetUrl = "https://localhost/" + httpPort + "/foo/bar"; + Request request = get(targetUrl) + .setProxyServer(proxyServer("127.0.0.1", proxyPort).setRealm(realm(AuthScheme.BASIC, "johndoe", "pass"))) + .setHeader("user-agent", CUSTOM_USER_AGENT) + // .setRealm(realm(AuthScheme.BASIC, "user", "passwd")) + .build(); + Future responseFuture = client.executeRequest(request); + Response response = responseFuture.get(); + + assertEquals(response.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals("/foo/bar", response.getHeader("X-pathInfo")); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/BasicHttpTest.java b/client/src/test/java/org/asynchttpclient/BasicHttpTest.java new file mode 100755 index 0000000000..f83cac80f4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/BasicHttpTest.java @@ -0,0 +1,1043 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.handler.codec.http.cookie.DefaultCookie; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.handler.MaxRedirectException; +import org.asynchttpclient.request.body.generator.InputStreamBodyGenerator; +import org.asynchttpclient.request.body.multipart.StringPart; +import org.asynchttpclient.test.EventCollectingHandler; +import org.asynchttpclient.testserver.HttpServer; +import org.asynchttpclient.testserver.HttpServer.EchoHandler; +import org.asynchttpclient.testserver.HttpTest; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import javax.net.ssl.SSLException; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.net.ConnectException; +import java.net.URLDecoder; +import java.net.UnknownHostException; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.CancellationException; +import java.util.concurrent.CountDownLatch; +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.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.HOST; +import static io.netty.handler.codec.http.HttpHeaderNames.TRANSFER_ENCODING; +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.concurrent.TimeUnit.SECONDS; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.head; +import static org.asynchttpclient.Dsl.post; +import static org.asynchttpclient.test.TestUtils.AsyncCompletionHandlerAdapter; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.TIMEOUT; +import static org.asynchttpclient.test.TestUtils.assertContentTypesEquals; +import static org.asynchttpclient.test.TestUtils.findFreePort; +import static org.asynchttpclient.test.TestUtils.writeResponseBody; +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; +import static org.asynchttpclient.util.ThrowableUtil.unknownStackTrace; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +public class BasicHttpTest extends HttpTest { + + public static final byte[] ACTUAL = {}; + private HttpServer server; + + @BeforeEach + public void start() throws Throwable { + server = new HttpServer(); + server.start(); + } + + @AfterEach + public void stop() throws Throwable { + server.close(); + } + + private String getTargetUrl() { + return server.getHttpUrl() + "/foo/bar"; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getRootUrl() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + String url = server.getHttpUrl(); + server.enqueueOk(); + + Response response = client.executeRequest(get(url), new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + assertEquals(response.getUri().toUrl(), url); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getUrlWithPathWithoutQuery() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueOk(); + + Response response = client.executeRequest(get(getTargetUrl()), new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + assertEquals(response.getUri().toUrl(), getTargetUrl()); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getUrlWithPathWithQuery() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + String targetUrl = getTargetUrl() + "?q=+%20x"; + Request request = get(targetUrl).build(); + assertEquals(request.getUrl(), targetUrl); + server.enqueueOk(); + + Response response = client.executeRequest(request, new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + assertEquals(response.getUri().toUrl(), targetUrl); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getUrlWithPathWithQueryParams() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueOk(); + + Response response = client.executeRequest(get(getTargetUrl()).addQueryParam("q", "a b"), new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + assertEquals(response.getUri().toUrl(), getTargetUrl() + "?q=a%20b"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getResponseBody() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final String body = "Hello World"; + + server.enqueueResponse(response -> { + response.setStatus(200); + response.setContentType(TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + writeResponseBody(response, body); + }); + + client.executeRequest(get(getTargetUrl()), new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + String contentLengthHeader = response.getHeader(CONTENT_LENGTH); + assertNotNull(contentLengthHeader); + assertEquals(Integer.parseInt(contentLengthHeader), body.length()); + assertContentTypesEquals(response.getContentType(), TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + assertEquals(response.getResponseBody(), body); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getWithHeaders() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + for (int i = 1; i < 5; i++) { + h.add("Test" + i, "Test" + i); + } + + server.enqueueEcho(); + + client.executeRequest(get(getTargetUrl()).setHeaders(h), new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + for (int i = 1; i < 5; i++) { + assertEquals(response.getHeader("X-Test" + i), "Test" + i); + } + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postWithHeadersAndFormParams() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + + Map> m = new HashMap<>(); + for (int i = 0; i < 5; i++) { + m.put("param_" + i, Collections.singletonList("value_" + i)); + } + + Request request = post(getTargetUrl()).setHeaders(h).setFormParams(m).build(); + + server.enqueueEcho(); + + client.executeRequest(request, new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + for (int i = 1; i < 5; i++) { + assertEquals(response.getHeader("X-param_" + i), "value_" + i); + } + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postChineseChar() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + + String chineseChar = "是"; + + Map> m = new HashMap<>(); + m.put("param", Collections.singletonList(chineseChar)); + + Request request = post(getTargetUrl()).setHeaders(h).setFormParams(m).build(); + + server.enqueueEcho(); + + client.executeRequest(request, new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + String value; + // headers must be encoded + value = URLDecoder.decode(response.getHeader("X-param"), UTF_8); + assertEquals(value, chineseChar); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void headHasEmptyBody() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueOk(); + + Response response = client.executeRequest(head(getTargetUrl()), new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + return response; + } + }).get(TIMEOUT, SECONDS); + + assertTrue(response.getResponseBody().isEmpty()); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void nullSchemeThrowsNPE() throws Throwable { + assertThrows(IllegalArgumentException.class, () -> withClient().run(client -> client.prepareGet("gatling.io").execute())); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void jettyRespondsWithChunkedTransferEncoding() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + client.prepareGet(getTargetUrl()) + .execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getHeader(TRANSFER_ENCODING), HttpHeaderValues.CHUNKED.toString()); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getWithCookies() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final Cookie coo = new DefaultCookie("foo", "value"); + coo.setDomain("/"); + coo.setPath("/"); + server.enqueueEcho(); + + client.prepareGet(getTargetUrl()) + .addCookie(coo) + .execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + List cookies = response.getCookies(); + assertEquals(cookies.size(), 1); + assertEquals(cookies.get(0).toString(), "foo=value"); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void defaultRequestBodyEncodingIsUtf8() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + Response response = client.preparePost(getTargetUrl()) + .setBody("\u017D\u017D\u017D\u017D\u017D\u017D") + .execute().get(); + assertArrayEquals(response.getResponseBodyAsBytes(), "\u017D\u017D\u017D\u017D\u017D\u017D".getBytes(UTF_8)); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postFormParametersAsBodyString() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < 5; i++) { + sb.append("param_").append(i).append("=value_").append(i).append('&'); + } + sb.setLength(sb.length() - 1); + + server.enqueueEcho(); + client.preparePost(getTargetUrl()) + .setHeaders(h) + .setBody(sb.toString()) + .execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + for (int i = 1; i < 5; i++) { + assertEquals(response.getHeader("X-param_" + i), "value_" + i); + + } + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postFormParametersAsBodyStream() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < 5; i++) { + sb.append("param_").append(i).append("=value_").append(i).append('&'); + } + sb.setLength(sb.length() - 1); + + server.enqueueEcho(); + client.preparePost(getTargetUrl()) + .setHeaders(h) + .setBody(new ByteArrayInputStream(sb.toString().getBytes(UTF_8))) + .execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + for (int i = 1; i < 5; i++) { + assertEquals(response.getHeader("X-param_" + i), "value_" + i); + + } + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void putFormParametersAsBodyStream() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < 5; i++) { + sb.append("param_").append(i).append("=value_").append(i).append('&'); + } + sb.setLength(sb.length() - 1); + ByteArrayInputStream is = new ByteArrayInputStream(sb.toString().getBytes()); + + server.enqueueEcho(); + client.preparePut(getTargetUrl()) + .setHeaders(h) + .setBody(is) + .execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + for (int i = 1; i < 5; i++) { + assertEquals(response.getHeader("X-param_" + i), "value_" + i); + } + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postSingleStringPart() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + client.preparePost(getTargetUrl()) + .addBodyPart(new StringPart("foo", "bar")) + .execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + String requestContentType = response.getHeader("X-" + CONTENT_TYPE); + String boundary = requestContentType.substring(requestContentType.indexOf("boundary") + "boundary".length() + 1); + assertTrue(response.getResponseBody().regionMatches(false, "--".length(), boundary, 0, boundary.length())); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postWithBody() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + client.preparePost(getTargetUrl()) + .execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getHeader("X-" + CONTENT_LENGTH), "0"); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getVirtualHost() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + String virtualHost = "localhost:" + server.getHttpPort(); + + server.enqueueEcho(); + Response response = client.prepareGet(getTargetUrl()) + .setVirtualHost(virtualHost) + .execute(new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + + assertEquals(response.getStatusCode(), 200); + if (response.getHeader("X-" + HOST) == null) { + System.err.println(response); + } + assertEquals(response.getHeader("X-" + HOST), virtualHost); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void cancelledFutureThrowsCancellationException() throws Throwable { + assertThrows(CancellationException.class, () -> { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders headers = new DefaultHttpHeaders(); + headers.add("X-Delay", 5_000); + server.enqueueEcho(); + + Future future = client.prepareGet(getTargetUrl()).setHeaders(headers).execute(new AsyncCompletionHandlerAdapter() { + @Override + public void onThrowable(Throwable t) { + } + }); + future.cancel(true); + future.get(TIMEOUT, SECONDS); + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void futureTimeOutThrowsTimeoutException() throws Throwable { + assertThrows(TimeoutException.class, () -> { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders headers = new DefaultHttpHeaders(); + headers.add("X-Delay", 5_000); + + server.enqueueEcho(); + Future future = client.prepareGet(getTargetUrl()).setHeaders(headers).execute(new AsyncCompletionHandlerAdapter() { + @Override + public void onThrowable(Throwable t) { + } + }); + + future.get(2, SECONDS); + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void connectFailureThrowsConnectException() throws Throwable { + assertThrows(ConnectException.class, () -> { + withClient().run(client -> { + int dummyPort = findFreePort(); + try { + client.preparePost(String.format("http://localhost:%d/", dummyPort)).execute(new AsyncCompletionHandlerAdapter() { + @Override + public void onThrowable(Throwable t) { + } + }).get(TIMEOUT, SECONDS); + } catch (ExecutionException ex) { + throw ex.getCause(); + } + }); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void connectFailureNotifiesHandlerWithConnectException() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final CountDownLatch l = new CountDownLatch(1); + int port = findFreePort(); + + client.prepareGet(String.format("http://localhost:%d/", port)).execute(new AsyncCompletionHandlerAdapter() { + @Override + public void onThrowable(Throwable t) { + try { + assertInstanceOf(ConnectException.class, t); + } finally { + l.countDown(); + } + } + }); + + if (!l.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void unknownHostThrowsUnknownHostException() throws Throwable { + assertThrows(UnknownHostException.class, () -> { + withClient().run(client -> + withServer(server).run(server -> { + try { + client.prepareGet("http://null.gatling.io/").execute(new AsyncCompletionHandlerAdapter() { + @Override + public void onThrowable(Throwable t) { + } + }).get(TIMEOUT, SECONDS); + } catch (ExecutionException e) { + throw e.getCause(); + } + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getEmptyBody() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueOk(); + Response response = client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter()) + .get(TIMEOUT, SECONDS); + assertTrue(response.getResponseBody().isEmpty()); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getEmptyBodyNotifiesHandler() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final AtomicBoolean handlerWasNotified = new AtomicBoolean(); + + server.enqueueOk(); + client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + handlerWasNotified.set(true); + return response; + } + }).get(TIMEOUT, SECONDS); + assertTrue(handlerWasNotified.get()); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void exceptionInOnCompletedGetNotifiedToOnThrowable() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference message = new AtomicReference<>(); + + server.enqueueOk(); + client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + throw unknownStackTrace(new IllegalStateException("FOO"), BasicHttpTest.class, "exceptionInOnCompletedGetNotifiedToOnThrowable"); + + } + + @Override + public void onThrowable(Throwable t) { + message.set(t.getMessage()); + latch.countDown(); + } + }); + + if (!latch.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + + assertEquals(message.get(), "FOO"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void exceptionInOnCompletedGetNotifiedToFuture() throws Throwable { + assertThrows(IllegalStateException.class, () -> { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueOk(); + Future whenResponse = client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + throw unknownStackTrace(new IllegalStateException("FOO"), BasicHttpTest.class, "exceptionInOnCompletedGetNotifiedToFuture"); + } + + @Override + public void onThrowable(Throwable t) { + } + }); + + try { + whenResponse.get(TIMEOUT, SECONDS); + } catch (ExecutionException e) { + throw e.getCause(); + } + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void configTimeoutNotifiesOnThrowableAndFuture() throws Throwable { + assertThrows(TimeoutException.class, () -> { + withClient(config().setRequestTimeout(Duration.ofSeconds(1))).run(client -> + withServer(server).run(server -> { + HttpHeaders headers = new DefaultHttpHeaders(); + headers.add("X-Delay", 5_000); // delay greater than timeout + + final AtomicBoolean onCompletedWasNotified = new AtomicBoolean(); + final AtomicBoolean onThrowableWasNotifiedWithTimeoutException = new AtomicBoolean(); + final CountDownLatch latch = new CountDownLatch(1); + + server.enqueueEcho(); + Future whenResponse = client.prepareGet(getTargetUrl()).setHeaders(headers).execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + onCompletedWasNotified.set(true); + latch.countDown(); + return response; + } + + @Override + public void onThrowable(Throwable t) { + onThrowableWasNotifiedWithTimeoutException.set(t instanceof TimeoutException); + latch.countDown(); + } + }); + + if (!latch.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + + assertFalse(onCompletedWasNotified.get()); + assertTrue(onThrowableWasNotifiedWithTimeoutException.get()); + + try { + whenResponse.get(TIMEOUT, SECONDS); + } catch (ExecutionException e) { + throw e.getCause(); + } + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void configRequestTimeoutHappensInDueTime() throws Throwable { + assertThrows(TimeoutException.class, () -> { + withClient(config().setRequestTimeout(Duration.ofSeconds(1))).run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + h.add("X-Delay", 2_000); + + server.enqueueEcho(); + long start = unpreciseMillisTime(); + try { + client.prepareGet(getTargetUrl()).setHeaders(h).setUrl(getTargetUrl()).execute().get(); + } catch (Throwable ex) { + final long elapsedTime = unpreciseMillisTime() - start; + assertTrue(elapsedTime >= 1_000 && elapsedTime <= 1_500); + throw ex.getCause(); + } + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getProperPathAndQueryString() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + client.prepareGet(getTargetUrl() + "?foo=bar").execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertNotNull(response.getHeader("X-PathInfo")); + assertNotNull(response.getHeader("X-QueryString")); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void connectionIsReusedForSequentialRequests() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final CountDownLatch l = new CountDownLatch(2); + + AsyncCompletionHandler handler = new AsyncCompletionHandlerAdapter() { + + volatile String clientPort; + + @Override + public Response onCompleted(Response response) { + try { + assertEquals(response.getStatusCode(), 200); + if (clientPort == null) { + clientPort = response.getHeader("X-ClientPort"); + } else { + // verify that the server saw the same client remote address/port + // so the same connection was used + assertEquals(response.getHeader("X-ClientPort"), clientPort); + } + } finally { + l.countDown(); + } + return response; + } + }; + + server.enqueueEcho(); + client.prepareGet(getTargetUrl()).execute(handler).get(TIMEOUT, SECONDS); + server.enqueueEcho(); + client.prepareGet(getTargetUrl()).execute(handler); + + if (!l.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void reachingMaxRedirectThrowsMaxRedirectException() throws Throwable { + assertThrows(MaxRedirectException.class, () -> { + withClient(config().setMaxRedirects(1).setFollowRedirect(true)).run(client -> + withServer(server).run(server -> { + try { + // max redirect is 1, so second redirect will fail + server.enqueueRedirect(301, getTargetUrl()); + server.enqueueRedirect(301, getTargetUrl()); + client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + fail("Should not be here"); + return response; + } + + @Override + public void onThrowable(Throwable t) { + } + }).get(TIMEOUT, SECONDS); + } catch (ExecutionException e) { + throw e.getCause(); + } + })); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void nonBlockingNestedRequestsFromIoThreadAreFine() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + final int maxNested = 5; + final CountDownLatch latch = new CountDownLatch(2); + + final AsyncCompletionHandlerAdapter handler = new AsyncCompletionHandlerAdapter() { + private final AtomicInteger nestedCount = new AtomicInteger(0); + + @Override + public Response onCompleted(Response response) { + try { + if (nestedCount.getAndIncrement() < maxNested) { + client.prepareGet(getTargetUrl()).execute(this); + } + } finally { + latch.countDown(); + } + return response; + } + }; + + for (int i = 0; i < maxNested + 1; i++) { + server.enqueueOk(); + } + + client.prepareGet(getTargetUrl()).execute(handler); + + if (!latch.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void optionsIsSupported() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + Response response = client.prepareOptions(getTargetUrl()).execute().get(); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getHeader("Allow"), "GET,HEAD,POST,OPTIONS,TRACE"); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void cancellingFutureNotifiesOnThrowableWithCancellationException() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + h.add("X-Delay", 2_000); + + CountDownLatch latch = new CountDownLatch(1); + + Future future = client.preparePost(getTargetUrl()).setHeaders(h).setBody("Body").execute(new AsyncCompletionHandlerAdapter() { + + @Override + public void onThrowable(Throwable t) { + if (t instanceof CancellationException) { + latch.countDown(); + } + } + }); + + future.cancel(true); + if (!latch.await(TIMEOUT, SECONDS)) { + fail("Timed out"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getShouldAllowBody() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> + client.prepareGet(getTargetUrl()).setBody("Boo!").execute())); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void malformedUriThrowsException() throws Throwable { + assertThrows(IllegalArgumentException.class, () -> { + withClient().run(client -> + withServer(server).run(server -> client.prepareGet(String.format("http:localhost:%d/foo/test", server.getHttpPort())).build())); + }); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void emptyResponseBodyBytesAreEmpty() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + Response response = client.prepareGet(getTargetUrl()).execute().get(); + assertEquals(response.getStatusCode(), 200); + assertArrayEquals(response.getResponseBodyAsBytes(), ACTUAL); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void newConnectionEventsAreFired() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + + Request request = get(getTargetUrl()).build(); + + EventCollectingHandler handler = new EventCollectingHandler(); + client.executeRequest(request, handler).get(3, SECONDS); + handler.waitForCompletion(3, SECONDS); + + Object[] expectedEvents = { + CONNECTION_POOL_EVENT, + HOSTNAME_RESOLUTION_EVENT, + HOSTNAME_RESOLUTION_SUCCESS_EVENT, + CONNECTION_OPEN_EVENT, + CONNECTION_SUCCESS_EVENT, + REQUEST_SEND_EVENT, + HEADERS_WRITTEN_EVENT, + STATUS_RECEIVED_EVENT, + HEADERS_RECEIVED_EVENT, + CONNECTION_OFFER_EVENT, + COMPLETED_EVENT}; + + assertArrayEquals(handler.firedEvents.toArray(), expectedEvents, "Got " + Arrays.toString(handler.firedEvents.toArray())); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void requestingPlainHttpEndpointOverHttpsThrowsSslException() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + try { + client.prepareGet(getTargetUrl().replace("http", "https")).execute().get(); + fail("Request shouldn't succeed"); + } catch (ExecutionException e) { + assertInstanceOf(ConnectException.class, e.getCause(), "Cause should be a ConnectException"); + assertInstanceOf(SSLException.class, e.getCause().getCause(), "Root cause should be a SslException"); + } + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postUnboundedInputStreamAsBodyStream() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_JSON); + server.enqueue(new AbstractHandler() { + final EchoHandler chain = new EchoHandler(); + + @Override + public void handle(String target, org.eclipse.jetty.server.Request request, HttpServletRequest httpServletRequest, + HttpServletResponse httpServletResponse) throws IOException, ServletException { + + assertEquals(request.getHeader(TRANSFER_ENCODING.toString()), HttpHeaderValues.CHUNKED.toString()); + assertNull(request.getHeader(CONTENT_LENGTH.toString())); + chain.handle(target, request, httpServletRequest, httpServletResponse); + } + }); + server.enqueueEcho(); + + client.preparePost(getTargetUrl()) + .setHeaders(h) + .setBody(new ByteArrayInputStream("{}".getBytes(StandardCharsets.ISO_8859_1))) + .execute(new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getResponseBody(), "{}"); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postInputStreamWithContentLengthAsBodyGenerator() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_JSON); + server.enqueue(new AbstractHandler() { + final EchoHandler chain = new EchoHandler(); + + @Override + public void handle(String target, org.eclipse.jetty.server.Request request, HttpServletRequest httpServletRequest, + HttpServletResponse httpServletResponse) throws IOException, ServletException { + + assertNull(request.getHeader(TRANSFER_ENCODING.toString())); + assertEquals(request.getHeader(CONTENT_LENGTH.toString()), + Integer.toString("{}".getBytes(StandardCharsets.ISO_8859_1).length)); + chain.handle(target, request, httpServletRequest, httpServletResponse); + } + }); + + byte[] bodyBytes = "{}".getBytes(StandardCharsets.ISO_8859_1); + InputStream bodyStream = new ByteArrayInputStream(bodyBytes); + + client.preparePost(getTargetUrl()) + .setHeaders(h) + .setBody(new InputStreamBodyGenerator(bodyStream, bodyBytes.length)) + .execute(new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getResponseBody(), "{}"); + return response; + } + }).get(TIMEOUT, SECONDS); + })); + } +} diff --git a/client/src/test/java/org/asynchttpclient/BasicHttpsTest.java b/client/src/test/java/org/asynchttpclient/BasicHttpsTest.java new file mode 100644 index 0000000000..f932836b5a --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/BasicHttpsTest.java @@ -0,0 +1,219 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.channel.KeepAliveStrategy; +import org.asynchttpclient.test.EventCollectingHandler; +import org.asynchttpclient.testserver.HttpServer; +import org.asynchttpclient.testserver.HttpTest; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Timeout; + +import javax.net.ssl.SSLHandshakeException; +import java.time.Duration; +import java.util.Arrays; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static java.util.concurrent.TimeUnit.SECONDS; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_FILE; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE_STRING; +import static org.asynchttpclient.test.TestUtils.TIMEOUT; +import static org.asynchttpclient.test.TestUtils.createSslEngineFactory; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class BasicHttpsTest extends HttpTest { + + private HttpServer server; + + @BeforeEach + public void start() throws Throwable { + server = new HttpServer(); + server.start(); + } + + @AfterEach + public void stop() throws Throwable { + server.close(); + } + + private String getTargetUrl() { + return server.getHttpsUrl() + "/foo/bar"; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postFileOverHttps() throws Throwable { + logger.debug(">>> postBodyOverHttps"); + withClient(config().setSslEngineFactory(createSslEngineFactory())).run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + + Response resp = client.preparePost(getTargetUrl()).setBody(SIMPLE_TEXT_FILE).setHeader(CONTENT_TYPE, "text/html").execute().get(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + })); + logger.debug("<<< postBodyOverHttps"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postLargeFileOverHttps() throws Throwable { + logger.debug(">>> postLargeFileOverHttps"); + withClient(config().setSslEngineFactory(createSslEngineFactory())).run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + + Response resp = client.preparePost(getTargetUrl()).setBody(LARGE_IMAGE_FILE).setHeader(CONTENT_TYPE, "image/png").execute().get(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBodyAsBytes().length, LARGE_IMAGE_FILE.length()); + })); + logger.debug("<<< postLargeFileOverHttps"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void multipleSequentialPostRequestsOverHttps() throws Throwable { + logger.debug(">>> multipleSequentialPostRequestsOverHttps"); + withClient(config().setSslEngineFactory(createSslEngineFactory())).run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + server.enqueueEcho(); + + String body = "hello there"; + Response response = client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute().get(TIMEOUT, SECONDS); + assertEquals(response.getResponseBody(), body); + + response = client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute().get(TIMEOUT, SECONDS); + assertEquals(response.getResponseBody(), body); + })); + logger.debug("<<< multipleSequentialPostRequestsOverHttps"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void multipleConcurrentPostRequestsOverHttpsWithDisabledKeepAliveStrategy() throws Throwable { + logger.debug(">>> multipleConcurrentPostRequestsOverHttpsWithDisabledKeepAliveStrategy"); + + KeepAliveStrategy keepAliveStrategy = (remoteAddress, ahcRequest, nettyRequest, nettyResponse) -> !ahcRequest.getUri().isSecured(); + + withClient(config().setSslEngineFactory(createSslEngineFactory()).setKeepAliveStrategy(keepAliveStrategy)).run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + server.enqueueEcho(); + server.enqueueEcho(); + + String body = "hello there"; + + client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute(); + client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute(); + + Response response = client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute().get(); + assertEquals(response.getResponseBody(), body); + })); + + logger.debug("<<< multipleConcurrentPostRequestsOverHttpsWithDisabledKeepAliveStrategy"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void reconnectAfterFailedCertificationPath() throws Throwable { + logger.debug(">>> reconnectAfterFailedCertificationPath"); + + AtomicBoolean trust = new AtomicBoolean(); + + withClient(config().setMaxRequestRetry(0).setSslEngineFactory(createSslEngineFactory(trust))).run(client -> + withServer(server).run(server -> { + server.enqueueEcho(); + server.enqueueEcho(); + + String body = "hello there"; + + // first request fails because server certificate is rejected + Throwable cause = null; + try { + client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute().get(TIMEOUT, SECONDS); + } catch (final ExecutionException e) { + cause = e.getCause(); + } + assertNotNull(cause); + + // second request should succeed + trust.set(true); + Response response = client.preparePost(getTargetUrl()).setBody(body).setHeader(CONTENT_TYPE, "text/html").execute().get(TIMEOUT, SECONDS); + + assertEquals(response.getResponseBody(), body); + })); + logger.debug("<<< reconnectAfterFailedCertificationPath"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 2000) + public void failInstantlyIfNotAllowedSelfSignedCertificate() throws Throwable { + logger.debug(">>> failInstantlyIfNotAllowedSelfSignedCertificate"); + + assertThrows(SSLHandshakeException.class, () -> { + withClient(config().setMaxRequestRetry(0).setRequestTimeout(Duration.ofSeconds(2))).run(client -> + withServer(server).run(server -> { + try { + client.prepareGet(getTargetUrl()).execute().get(TIMEOUT, SECONDS); + } catch (ExecutionException e) { + throw e.getCause().getCause(); + } + })); + }); + logger.debug("<<< failInstantlyIfNotAllowedSelfSignedCertificate"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNormalEventsFired() throws Throwable { + logger.debug(">>> testNormalEventsFired"); + + withClient(config().setSslEngineFactory(createSslEngineFactory())).run(client -> + withServer(server).run(server -> { + EventCollectingHandler handler = new EventCollectingHandler(); + + server.enqueueEcho(); + client.preparePost(getTargetUrl()).setBody("whatever").execute(handler).get(3, SECONDS); + handler.waitForCompletion(3, SECONDS); + + Object[] expectedEvents = { + CONNECTION_POOL_EVENT, + HOSTNAME_RESOLUTION_EVENT, + HOSTNAME_RESOLUTION_SUCCESS_EVENT, + CONNECTION_OPEN_EVENT, + CONNECTION_SUCCESS_EVENT, + TLS_HANDSHAKE_EVENT, + TLS_HANDSHAKE_SUCCESS_EVENT, + REQUEST_SEND_EVENT, + HEADERS_WRITTEN_EVENT, + STATUS_RECEIVED_EVENT, + HEADERS_RECEIVED_EVENT, + CONNECTION_OFFER_EVENT, + COMPLETED_EVENT}; + + assertArrayEquals(handler.firedEvents.toArray(), expectedEvents, "Got " + Arrays.toString(handler.firedEvents.toArray())); + })); + logger.debug("<<< testNormalEventsFired"); + } +} diff --git a/client/src/test/java/org/asynchttpclient/ByteBufferCapacityTest.java b/client/src/test/java/org/asynchttpclient/ByteBufferCapacityTest.java new file mode 100644 index 0000000000..a65cd79139 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ByteBufferCapacityTest.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.util.Enumeration; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class ByteBufferCapacityTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new BasicHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicByteBufferTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + File largeFile = createTempFile(1024 * 100 * 10); + final AtomicInteger byteReceived = new AtomicInteger(); + + Response response = c.preparePut(getTargetUrl()).setBody(largeFile).execute(new AsyncCompletionHandlerAdapter() { + @Override + public State onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { + byteReceived.addAndGet(content.getBodyByteBuffer().capacity()); + return super.onBodyPartReceived(content); + } + + }).get(); + + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(byteReceived.get(), largeFile.length()); + assertEquals(response.getResponseBody().length(), largeFile.length()); + } + } + + @Override + public String getTargetUrl() { + return String.format("http://localhost:%d/foo/test", port1); + } + + private static class BasicHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + Enumeration e = httpRequest.getHeaderNames(); + String param; + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); + } + + int size = 10 * 1024; + if (httpRequest.getContentLength() > 0) { + size = httpRequest.getContentLength(); + } + byte[] bytes = new byte[size]; + if (bytes.length > 0) { + final InputStream in = httpRequest.getInputStream(); + final OutputStream out = httpResponse.getOutputStream(); + int read; + while ((read = in.read(bytes)) != -1) { + out.write(bytes, 0, read); + } + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ClientStatsTest.java b/client/src/test/java/org/asynchttpclient/ClientStatsTest.java new file mode 100644 index 0000000000..2d8d324de8 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ClientStatsTest.java @@ -0,0 +1,184 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import org.junit.jupiter.api.Test; + +import java.time.Duration; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; + +/** + * Created by grenville on 9/25/16. + */ +public class ClientStatsTest extends AbstractBasicTest { + + private static final String hostname = "localhost"; + + @Test + public void testClientStatus() throws Throwable { + try (final AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setPooledConnectionIdleTimeout(Duration.ofSeconds(5)))) { + final String url = getTargetUrl(); + + final ClientStats emptyStats = client.getClientStats(); + + assertEquals("There are 0 total connections, 0 are active and 0 are idle.", emptyStats.toString()); + assertEquals(0, emptyStats.getTotalActiveConnectionCount()); + assertEquals(0, emptyStats.getTotalIdleConnectionCount()); + assertEquals(0, emptyStats.getTotalConnectionCount()); + assertNull(emptyStats.getStatsPerHost().get(hostname)); + + final List> futures = Stream.generate(() -> client.prepareGet(url).setHeader("LockThread", "6").execute()) + .limit(5) + .collect(Collectors.toList()); + + Thread.sleep(2000); + + final ClientStats activeStats = client.getClientStats(); + + assertEquals("There are 5 total connections, 5 are active and 0 are idle.", activeStats.toString()); + assertEquals(5, activeStats.getTotalActiveConnectionCount()); + assertEquals(0, activeStats.getTotalIdleConnectionCount()); + assertEquals(5, activeStats.getTotalConnectionCount()); + assertEquals(5, activeStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + futures.forEach(future -> future.toCompletableFuture().join()); + + Thread.sleep(1000); + + final ClientStats idleStats = client.getClientStats(); + + assertEquals("There are 5 total connections, 0 are active and 5 are idle.", idleStats.toString()); + assertEquals(0, idleStats.getTotalActiveConnectionCount()); + assertEquals(5, idleStats.getTotalIdleConnectionCount()); + assertEquals(5, idleStats.getTotalConnectionCount()); + assertEquals(5, idleStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + // Let's make sure the active count is correct when reusing cached connections. + + final List> repeatedFutures = Stream.generate(() -> client.prepareGet(url).setHeader("LockThread", "6").execute()) + .limit(3) + .collect(Collectors.toList()); + + Thread.sleep(2000); + + final ClientStats activeCachedStats = client.getClientStats(); + + assertEquals("There are 5 total connections, 3 are active and 2 are idle.", activeCachedStats.toString()); + assertEquals(3, activeCachedStats.getTotalActiveConnectionCount()); + assertEquals(2, activeCachedStats.getTotalIdleConnectionCount()); + assertEquals(5, activeCachedStats.getTotalConnectionCount()); + assertEquals(5, activeCachedStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + repeatedFutures.forEach(future -> future.toCompletableFuture().join()); + + Thread.sleep(1000); + + final ClientStats idleCachedStats = client.getClientStats(); + + assertEquals("There are 3 total connections, 0 are active and 3 are idle.", idleCachedStats.toString()); + assertEquals(0, idleCachedStats.getTotalActiveConnectionCount()); + assertEquals(3, idleCachedStats.getTotalIdleConnectionCount()); + assertEquals(3, idleCachedStats.getTotalConnectionCount()); + assertEquals(3, idleCachedStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + Thread.sleep(5000); + + final ClientStats timeoutStats = client.getClientStats(); + + assertEquals("There are 0 total connections, 0 are active and 0 are idle.", timeoutStats.toString()); + assertEquals(0, timeoutStats.getTotalActiveConnectionCount()); + assertEquals(0, timeoutStats.getTotalIdleConnectionCount()); + assertEquals(0, timeoutStats.getTotalConnectionCount()); + assertNull(timeoutStats.getStatsPerHost().get(hostname)); + } + } + + @Test + public void testClientStatusNoKeepalive() throws Throwable { + try (final AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(false).setPooledConnectionIdleTimeout(Duration.ofSeconds(1)))) { + final String url = getTargetUrl(); + + final ClientStats emptyStats = client.getClientStats(); + + assertEquals("There are 0 total connections, 0 are active and 0 are idle.", emptyStats.toString()); + assertEquals(0, emptyStats.getTotalActiveConnectionCount()); + assertEquals(0, emptyStats.getTotalIdleConnectionCount()); + assertEquals(0, emptyStats.getTotalConnectionCount()); + assertNull(emptyStats.getStatsPerHost().get(hostname)); + + final List> futures = Stream.generate(() -> client.prepareGet(url).setHeader("LockThread", "6").execute()) + .limit(5) + .collect(Collectors.toList()); + + Thread.sleep(2000); + + final ClientStats activeStats = client.getClientStats(); + + assertEquals("There are 5 total connections, 5 are active and 0 are idle.", activeStats.toString()); + assertEquals(5, activeStats.getTotalActiveConnectionCount()); + assertEquals(0, activeStats.getTotalIdleConnectionCount()); + assertEquals(5, activeStats.getTotalConnectionCount()); + assertEquals(5, activeStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + futures.forEach(future -> future.toCompletableFuture().join()); + + Thread.sleep(1000); + + final ClientStats idleStats = client.getClientStats(); + + assertEquals("There are 0 total connections, 0 are active and 0 are idle.", idleStats.toString()); + assertEquals(0, idleStats.getTotalActiveConnectionCount()); + assertEquals(0, idleStats.getTotalIdleConnectionCount()); + assertEquals(0, idleStats.getTotalConnectionCount()); + assertNull(idleStats.getStatsPerHost().get(hostname)); + + // Let's make sure the active count is correct when reusing cached connections. + + final List> repeatedFutures = Stream.generate(() -> client.prepareGet(url).setHeader("LockThread", "6").execute()) + .limit(3) + .collect(Collectors.toList()); + + Thread.sleep(2000); + + final ClientStats activeCachedStats = client.getClientStats(); + + assertEquals("There are 3 total connections, 3 are active and 0 are idle.", activeCachedStats.toString()); + assertEquals(3, activeCachedStats.getTotalActiveConnectionCount()); + assertEquals(0, activeCachedStats.getTotalIdleConnectionCount()); + assertEquals(3, activeCachedStats.getTotalConnectionCount()); + assertEquals(3, activeCachedStats.getStatsPerHost().get(hostname).getHostConnectionCount()); + + repeatedFutures.forEach(future -> future.toCompletableFuture().join()); + + Thread.sleep(1000); + + final ClientStats idleCachedStats = client.getClientStats(); + + assertEquals("There are 0 total connections, 0 are active and 0 are idle.", idleCachedStats.toString()); + assertEquals(0, idleCachedStats.getTotalActiveConnectionCount()); + assertEquals(0, idleCachedStats.getTotalIdleConnectionCount()); + assertEquals(0, idleCachedStats.getTotalConnectionCount()); + assertNull(idleCachedStats.getStatsPerHost().get(hostname)); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ComplexClientTest.java b/client/src/test/java/org/asynchttpclient/ComplexClientTest.java new file mode 100644 index 0000000000..089be3d6ad --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ComplexClientTest.java @@ -0,0 +1,65 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class ComplexClientTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void multipleRequestsTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + String body = "hello there"; + + // once + Response response = client.preparePost(getTargetUrl()) + .setBody(body) + .setHeader("Content-Type", "text/html") + .execute() + .get(TIMEOUT, TimeUnit.SECONDS); + + assertEquals(response.getResponseBody(), body); + + // twice + response = client.preparePost(getTargetUrl()) + .setBody(body) + .setHeader("Content-Type", "text/html") + .execute() + .get(TIMEOUT, TimeUnit.SECONDS); + + assertEquals(body, response.getResponseBody()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void urlWithoutSlashTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + String body = "hello there"; + Response response = client.preparePost(String.format("http://localhost:%d/foo/test", port1)) + .setBody(body) + .setHeader("Content-Type", "text/html") + .execute() + .get(TIMEOUT, TimeUnit.SECONDS); + + assertEquals(body, response.getResponseBody()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/CookieStoreTest.java b/client/src/test/java/org/asynchttpclient/CookieStoreTest.java new file mode 100644 index 0000000000..fd65322c14 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/CookieStoreTest.java @@ -0,0 +1,371 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.cookie.ClientCookieDecoder; +import io.netty.handler.codec.http.cookie.ClientCookieEncoder; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.handler.codec.http.cookie.DefaultCookie; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.cookie.ThreadSafeCookieStore; +import org.asynchttpclient.uri.Uri; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class CookieStoreTest { + + private static final Logger logger = LoggerFactory.getLogger(CookieStoreTest.class); + + @BeforeEach + public void setUpGlobal() { + logger.info("Local HTTP server started successfully"); + System.out.println("--Start"); + } + + @AfterEach + public void tearDownGlobal() { + System.out.println("--Stop"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void runAllSequentiallyBecauseNotThreadSafe() throws Exception { + addCookieWithEmptyPath(); + dontReturnCookieForAnotherDomain(); + returnCookieWhenItWasSetOnSamePath(); + returnCookieWhenItWasSetOnParentPath(); + dontReturnCookieWhenDomainMatchesButPathIsDifferent(); + dontReturnCookieWhenDomainMatchesButPathIsParent(); + returnCookieWhenDomainMatchesAndPathIsChild(); + returnCookieWhenItWasSetOnSubdomain(); + replaceCookieWhenSetOnSameDomainAndPath(); + dontReplaceCookiesWhenTheyHaveDifferentName(); + expireCookieWhenSetWithDateInThePast(); + cookieWithSameNameMustCoexistIfSetOnDifferentDomains(); + handleMissingDomainAsRequestHost(); + handleMissingPathAsSlash(); + returnTheCookieWheniTSissuedFromRequestWithSubpath(); + handleMissingPathAsRequestPathWhenFromRootDir(); + handleMissingPathAsRequestPathWhenPathIsNotEmpty(); + handleDomainInCaseInsensitiveManner(); + handleCookieNameInCaseInsensitiveManner(); + handleCookiePathInCaseSensitiveManner(); + ignoreQueryParametersInUri(); + shouldServerOnSubdomainWhenDomainMatches(); + replaceCookieWhenSetOnSamePathBySameUri(); + handleMultipleCookieOfSameNameOnDifferentPaths(); + handleTrailingSlashesInPaths(); + returnMultipleCookiesEvenIfTheyHaveSameName(); + shouldServeCookiesBasedOnTheUriScheme(); + shouldAlsoServeNonSecureCookiesBasedOnTheUriScheme(); + shouldNotServeSecureCookiesForDefaultRetrievedHttpUriScheme(); + shouldServeSecureCookiesForSpecificallyRetrievedHttpUriScheme(); + shouldCleanExpiredCookieFromUnderlyingDataStructure(); + } + + private static void addCookieWithEmptyPath() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; path=")); + assertFalse(store.get(uri).isEmpty()); + } + + private static void dontReturnCookieForAnotherDomain() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; path=")); + assertTrue(store.get(Uri.create("http://www.bar.com/")).isEmpty()); + } + + private static void returnCookieWhenItWasSetOnSamePath() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; path=/bar/")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/bar/")).size()); + } + + private static void returnCookieWhenItWasSetOnParentPath() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/bar/baz")).size()); + } + + private static void dontReturnCookieWhenDomainMatchesButPathIsDifferent() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + assertTrue(store.get(Uri.create("http://www.foo.com/baz")).isEmpty()); + } + + private static void dontReturnCookieWhenDomainMatchesButPathIsParent() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + assertTrue(store.get(Uri.create("http://www.foo.com/")).isEmpty()); + } + + private static void returnCookieWhenDomainMatchesAndPathIsChild() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/bar/baz")).size()); + } + + private static void returnCookieWhenItWasSetOnSubdomain() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=.foo.com")); + assertEquals(1, store.get(Uri.create("http://bar.foo.com/")).size()); + } + + private static void replaceCookieWhenSetOnSameDomainAndPath() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/bar/baz"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE2; Domain=www.foo.com; path=/bar")); + assertEquals(1, store.getAll().size()); + assertEquals("VALUE2", store.get(uri).get(0).value()); + } + + private static void dontReplaceCookiesWhenTheyHaveDifferentName() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/bar/baz"); + store.add(uri, ClientCookieDecoder.LAX.decode("BETA=VALUE1; Domain=www.foo.com; path=/bar")); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE2; Domain=www.foo.com; path=/bar")); + assertEquals(2, store.get(uri).size()); + } + + private static void expireCookieWhenSetWithDateInThePast() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/bar"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=EXPIRED; Domain=www.foo.com; Path=/bar; Expires=Sun, 06 Nov 1994 08:49:37 GMT")); + assertTrue(store.getAll().isEmpty()); + } + + private static void cookieWithSameNameMustCoexistIfSetOnDifferentDomains() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri1 = Uri.create("http://www.foo.com/"); + store.add(uri1, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com")); + Uri uri2 = Uri.create("http://www.bar.com/"); + store.add(uri2, ClientCookieDecoder.LAX.decode("ALPHA=VALUE2; Domain=www.bar.com")); + + assertEquals(1, store.get(uri1).size()); + assertEquals("VALUE1", store.get(uri1).get(0).value()); + + assertEquals(1, store.get(uri2).size()); + assertEquals("VALUE2", store.get(uri2).get(0).value()); + } + + private static void handleMissingDomainAsRequestHost() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Path=/")); + assertEquals(1, store.get(uri).size()); + } + + private static void handleMissingPathAsSlash() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/"); + store.add(uri, ClientCookieDecoder.LAX.decode("tooe_token=0b1d81dd02d207491a6e9b0a2af9470da9eb1dad")); + assertEquals(1, store.get(uri).size()); + } + + private static void returnTheCookieWheniTSissuedFromRequestWithSubpath() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE; path=/")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/")).size()); + } + + private static void handleMissingPathAsRequestPathWhenFromRootDir() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1")); + assertEquals(1, store.get(uri).size()); + } + + private static void handleMissingPathAsRequestPathWhenPathIsNotEmpty() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + assertTrue(store.get(Uri.create("http://www.foo.com/baz")).isEmpty()); + } + + // RFC 2965 sec. 3.3.3 + private static void handleDomainInCaseInsensitiveManner() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/bar")).size()); + } + + // RFC 2965 sec. 3.3.3 + private static void handleCookieNameInCaseInsensitiveManner() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("http://www.foo.com/bar/baz"); + store.add(uri, ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/bar")); + store.add(uri, ClientCookieDecoder.LAX.decode("alpha=VALUE2; Domain=www.foo.com; path=/bar")); + assertEquals(1, store.getAll().size()); + assertEquals("VALUE2", store.get(uri).get(0).value()); + } + + // RFC 2965 sec. 3.3.3 + private static void handleCookiePathInCaseSensitiveManner() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/foo/bar"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1")); + assertTrue(store.get(Uri.create("http://www.foo.com/Foo/bAr")).isEmpty()); + } + + private static void ignoreQueryParametersInUri() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/bar?query1"), ClientCookieDecoder.LAX.decode("ALPHA=VALUE1; Domain=www.foo.com; path=/")); + assertEquals(1, store.get(Uri.create("http://www.foo.com/bar?query2")).size()); + } + + // RFC 6265, 5.1.3. Domain Matching + private static void shouldServerOnSubdomainWhenDomainMatches() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://x.foo.org/"), ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/; Domain=foo.org;")); + assertEquals(1, store.get(Uri.create("https://y.x.foo.org/")).size()); + } + + // NOTE: Similar to replaceCookieWhenSetOnSameDomainAndPath() + private static void replaceCookieWhenSetOnSamePathBySameUri() { + CookieStore store = new ThreadSafeCookieStore(); + Uri uri = Uri.create("https://foo.org/"); + store.add(uri, ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/")); + store.add(uri, ClientCookieDecoder.LAX.decode("cookie1=VALUE2; Path=/")); + store.add(uri, ClientCookieDecoder.LAX.decode("cookie1=VALUE3; Path=/")); + assertEquals(1, store.getAll().size()); + assertEquals("VALUE3", store.get(uri).get(0).value()); + } + + private static void handleMultipleCookieOfSameNameOnDifferentPaths() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://www.foo.com/"), ClientCookieDecoder.LAX.decode("cookie=VALUE0; path=/")); + store.add(Uri.create("http://www.foo.com/foo/bar"), ClientCookieDecoder.LAX.decode("cookie=VALUE1; path=/foo/bar/")); + store.add(Uri.create("http://www.foo.com/foo/baz"), ClientCookieDecoder.LAX.decode("cookie=VALUE2; path=/foo/baz/")); + + Uri uri1 = Uri.create("http://www.foo.com/foo/bar/"); + List cookies1 = store.get(uri1); + assertEquals(2, cookies1.size()); + assertEquals(2, cookies1.stream().filter(c -> "VALUE0".equals(c.value()) || "VALUE1".equals(c.value())).count()); + + Uri uri2 = Uri.create("http://www.foo.com/foo/baz/"); + List cookies2 = store.get(uri2); + assertEquals(2, cookies2.size()); + assertEquals(2, cookies2.stream().filter(c -> "VALUE0".equals(c.value()) || "VALUE2".equals(c.value())).count()); + } + + private static void handleTrailingSlashesInPaths() { + CookieStore store = new ThreadSafeCookieStore(); + store.add( + Uri.create("https://vagrant.moolb.com/app/consumer/j_spring_cas_security_check?ticket=ST-5-Q7gzqPpvG3N3Bb02bm3q-llinder-vagrantmgr.moolb.com"), + ClientCookieDecoder.LAX.decode("JSESSIONID=211D17F016132BCBD31D9ABB31D90960; Path=/app/consumer/; HttpOnly")); + assertEquals(1, store.getAll().size()); + assertEquals("211D17F016132BCBD31D9ABB31D90960", store.get(Uri.create("https://vagrant.moolb.com/app/consumer/")).get(0).value()); + } + + private static void returnMultipleCookiesEvenIfTheyHaveSameName() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("http://foo.com/"), ClientCookieDecoder.LAX.decode("JSESSIONID=FOO; Domain=.foo.com")); + store.add(Uri.create("http://sub.foo.com/"), ClientCookieDecoder.LAX.decode("JSESSIONID=BAR; Domain=sub.foo.com")); + + Uri uri1 = Uri.create("http://sub.foo.com/"); + List cookies1 = store.get(uri1); + assertEquals(2, cookies1.size()); + assertEquals(2, cookies1.stream().filter(c -> "FOO".equals(c.value()) || "BAR".equals(c.value())).count()); + + List encodedCookieStrings = cookies1.stream().map(ClientCookieEncoder.LAX::encode).collect(Collectors.toList()); + assertTrue(encodedCookieStrings.contains("JSESSIONID=FOO")); + assertTrue(encodedCookieStrings.contains("JSESSIONID=BAR")); + } + + // rfc6265#section-1 Cookies for a given host are shared across all the ports on that host + private static void shouldServeCookiesBasedOnTheUriScheme() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://foo.org/moodle/"), ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE2; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE3; Path=/; Secure")); + + Uri uri = Uri.create("https://foo.org/moodle/login"); + assertEquals(1, store.getAll().size()); + assertEquals("VALUE3", store.get(uri).get(0).value()); + assertTrue(store.get(uri).get(0).isSecure()); + } + + // rfc6265#section-1 Cookies for a given host are shared across all the ports on that host + private static void shouldAlsoServeNonSecureCookiesBasedOnTheUriScheme() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://foo.org/moodle/"), ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE2; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE3; Path=/; HttpOnly")); + + Uri uri = Uri.create("https://foo.org/moodle/login"); + assertEquals(1, store.getAll().size()); + assertEquals("VALUE3", store.get(uri).get(0).value()); + assertFalse(store.get(uri).get(0).isSecure()); + } + + // rfc6265#section-1 Cookies for a given host are shared across all the ports on that host + private static void shouldNotServeSecureCookiesForDefaultRetrievedHttpUriScheme() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://foo.org/moodle/"), ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE2; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE3; Path=/; Secure")); + + Uri uri = Uri.create("http://foo.org/moodle/login"); + assertTrue(store.get(uri).isEmpty()); + } + + // rfc6265#section-1 Cookies for a given host are shared across all the ports on that host + private static void shouldServeSecureCookiesForSpecificallyRetrievedHttpUriScheme() { + CookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://foo.org/moodle/"), ClientCookieDecoder.LAX.decode("cookie1=VALUE1; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE2; Path=/")); + store.add(Uri.create("https://foo.org/moodle/login"), ClientCookieDecoder.LAX.decode("cookie1=VALUE3; Path=/; Secure")); + + Uri uri = Uri.create("https://foo.org/moodle/login"); + assertEquals(1, store.get(uri).size()); + assertEquals("VALUE3", store.get(uri).get(0).value()); + assertTrue(store.get(uri).get(0).isSecure()); + } + + private static void shouldCleanExpiredCookieFromUnderlyingDataStructure() throws Exception { + ThreadSafeCookieStore store = new ThreadSafeCookieStore(); + store.add(Uri.create("https://foo.org/moodle/"), getCookie("JSESSIONID", "FOO", 1)); + store.add(Uri.create("https://bar.org/moodle/"), getCookie("JSESSIONID", "BAR", 1)); + store.add(Uri.create("https://bar.org/moodle/"), new DefaultCookie("UNEXPIRED_BAR", "BAR")); + store.add(Uri.create("https://foobar.org/moodle/"), new DefaultCookie("UNEXPIRED_FOOBAR", "FOOBAR")); + + + assertEquals(4, store.getAll().size()); + Thread.sleep(2000); + store.evictExpired(); + assertEquals(2, store.getUnderlying().size()); + Collection unexpiredCookieNames = store.getAll().stream().map(Cookie::name).collect(Collectors.toList()); + assertTrue(unexpiredCookieNames.containsAll(Set.of("UNEXPIRED_BAR", "UNEXPIRED_FOOBAR"))); + } + + private static Cookie getCookie(String key, String value, int maxAge) { + DefaultCookie cookie = new DefaultCookie(key, value); + cookie.setMaxAge(maxAge); + return cookie; + } +} diff --git a/client/src/test/java/org/asynchttpclient/CustomRemoteAddressTest.java b/client/src/test/java/org/asynchttpclient/CustomRemoteAddressTest.java new file mode 100755 index 0000000000..437446f388 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/CustomRemoteAddressTest.java @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.util.internal.SocketUtils; +import org.asynchttpclient.test.TestUtils.AsyncCompletionHandlerAdapter; +import org.asynchttpclient.testserver.HttpServer; +import org.asynchttpclient.testserver.HttpTest; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import static java.util.concurrent.TimeUnit.SECONDS; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.test.TestUtils.TIMEOUT; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class CustomRemoteAddressTest extends HttpTest { + + private HttpServer server; + + @BeforeEach + public void start() throws Throwable { + server = new HttpServer(); + server.start(); + } + + @AfterEach + public void stop() throws Throwable { + server.close(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void getRootUrlWithCustomRemoteAddress() throws Throwable { + withClient().run(client -> + withServer(server).run(server -> { + String url = server.getHttpUrl(); + server.enqueueOk(); + RequestBuilder request = get(url).setAddress(SocketUtils.addressByName("localhost")); + Response response = client.executeRequest(request, new AsyncCompletionHandlerAdapter()).get(TIMEOUT, SECONDS); + assertEquals(response.getStatusCode(), 200); + })); + } +} diff --git a/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientConfigTest.java b/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientConfigTest.java new file mode 100644 index 0000000000..1548d6812f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientConfigTest.java @@ -0,0 +1,30 @@ +package org.asynchttpclient; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class DefaultAsyncHttpClientConfigTest { + @Test + void testStripAuthorizationOnRedirect_DefaultIsFalse() { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder().build(); + assertFalse(config.isStripAuthorizationOnRedirect(), "Default should be false"); + } + + @Test + void testStripAuthorizationOnRedirect_SetTrue() { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setStripAuthorizationOnRedirect(true) + .build(); + assertTrue(config.isStripAuthorizationOnRedirect(), "Should be true when set"); + } + + @Test + void testStripAuthorizationOnRedirect_SetFalse() { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setStripAuthorizationOnRedirect(false) + .build(); + assertFalse(config.isStripAuthorizationOnRedirect(), "Should be false when set to false"); + } +} diff --git a/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientTest.java b/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientTest.java new file mode 100644 index 0000000000..fc7a1c2db4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/DefaultAsyncHttpClientTest.java @@ -0,0 +1,174 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.channel.epoll.EpollEventLoopGroup; +import io.netty.channel.kqueue.KQueueEventLoopGroup; +import io.netty.incubator.channel.uring.IOUringEventLoopGroup; +import io.netty.util.Timer; +import org.asynchttpclient.cookie.CookieEvictionTask; +import org.asynchttpclient.cookie.CookieStore; +import org.asynchttpclient.cookie.ThreadSafeCookieStore; +import org.junit.jupiter.api.condition.EnabledOnOs; +import org.junit.jupiter.api.condition.OS; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyLong; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +public class DefaultAsyncHttpClientTest { + + @RepeatedIfExceptionsTest(repeats = 5) + @EnabledOnOs(OS.LINUX) + public void testNativeTransportWithEpollOnly() throws Exception { + AsyncHttpClientConfig config = config().setUseNativeTransport(true).setUseOnlyEpollNativeTransport(true).build(); + + try (DefaultAsyncHttpClient client = (DefaultAsyncHttpClient) asyncHttpClient(config)) { + assertDoesNotThrow(() -> client.prepareGet("https://www.google.com/").execute().get()); + assertInstanceOf(EpollEventLoopGroup.class, client.channelManager().getEventLoopGroup()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @EnabledOnOs(OS.LINUX) + public void testNativeTransportWithoutEpollOnly() throws Exception { + AsyncHttpClientConfig config = config().setUseNativeTransport(true).setUseOnlyEpollNativeTransport(false).build(); + try (DefaultAsyncHttpClient client = (DefaultAsyncHttpClient) asyncHttpClient(config)) { + assertDoesNotThrow(() -> client.prepareGet("https://www.google.com/").execute().get()); + assertInstanceOf(IOUringEventLoopGroup.class, client.channelManager().getEventLoopGroup()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @EnabledOnOs(OS.MAC) + public void testNativeTransportKQueueOnMacOs() throws Exception { + AsyncHttpClientConfig config = config().setUseNativeTransport(true).build(); + try (DefaultAsyncHttpClient client = (DefaultAsyncHttpClient) asyncHttpClient(config)) { + assertDoesNotThrow(() -> client.prepareGet("https://www.google.com/").execute().get()); + assertInstanceOf(KQueueEventLoopGroup.class, client.channelManager().getEventLoopGroup()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUseOnlyEpollNativeTransportButNativeTransportIsDisabled() { + assertThrows(IllegalArgumentException.class, () -> config().setUseNativeTransport(false).setUseOnlyEpollNativeTransport(true).build()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUseOnlyEpollNativeTransportAndNativeTransportIsEnabled() { + assertDoesNotThrow(() -> config().setUseNativeTransport(true).setUseOnlyEpollNativeTransport(true).build()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWithSharedNettyTimerShouldScheduleCookieEvictionOnlyOnce() throws IOException { + Timer nettyTimerMock = mock(Timer.class); + CookieStore cookieStore = new ThreadSafeCookieStore(); + AsyncHttpClientConfig config = config().setNettyTimer(nettyTimerMock).setCookieStore(cookieStore).build(); + + try (AsyncHttpClient client1 = asyncHttpClient(config)) { + try (AsyncHttpClient client2 = asyncHttpClient(config)) { + assertEquals(cookieStore.count(), 2); + verify(nettyTimerMock, times(1)).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWitDefaultConfigShouldScheduleCookieEvictionForEachAHC() throws IOException { + AsyncHttpClientConfig config1 = config().build(); + try (AsyncHttpClient client1 = asyncHttpClient(config1)) { + AsyncHttpClientConfig config2 = config().build(); + try (AsyncHttpClient client2 = asyncHttpClient(config2)) { + assertEquals(config1.getCookieStore().count(), 1); + assertEquals(config2.getCookieStore().count(), 1); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWithSharedCookieStoreButNonSharedTimerShouldScheduleCookieEvictionForFirstAHC() throws IOException { + CookieStore cookieStore = new ThreadSafeCookieStore(); + Timer nettyTimerMock1 = mock(Timer.class); + AsyncHttpClientConfig config1 = config() + .setCookieStore(cookieStore).setNettyTimer(nettyTimerMock1).build(); + + try (AsyncHttpClient client1 = asyncHttpClient(config1)) { + Timer nettyTimerMock2 = mock(Timer.class); + AsyncHttpClientConfig config2 = config() + .setCookieStore(cookieStore).setNettyTimer(nettyTimerMock2).build(); + try (AsyncHttpClient client2 = asyncHttpClient(config2)) { + assertEquals(config1.getCookieStore().count(), 2); + verify(nettyTimerMock1, times(1)).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + verify(nettyTimerMock2, never()).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + } + } + + Timer nettyTimerMock3 = mock(Timer.class); + AsyncHttpClientConfig config3 = config() + .setCookieStore(cookieStore).setNettyTimer(nettyTimerMock3).build(); + + try (AsyncHttpClient client2 = asyncHttpClient(config3)) { + assertEquals(config1.getCookieStore().count(), 1); + verify(nettyTimerMock3, times(1)).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWithSharedCookieStoreButNonSharedTimerShouldReScheduleCookieEvictionWhenFirstInstanceGetClosed() throws IOException { + CookieStore cookieStore = new ThreadSafeCookieStore(); + Timer nettyTimerMock1 = mock(Timer.class); + AsyncHttpClientConfig config1 = config() + .setCookieStore(cookieStore).setNettyTimer(nettyTimerMock1).build(); + + try (AsyncHttpClient client1 = asyncHttpClient(config1)) { + assertEquals(config1.getCookieStore().count(), 1); + verify(nettyTimerMock1, times(1)).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + } + + assertEquals(config1.getCookieStore().count(), 0); + + Timer nettyTimerMock2 = mock(Timer.class); + AsyncHttpClientConfig config2 = config() + .setCookieStore(cookieStore).setNettyTimer(nettyTimerMock2).build(); + + try (AsyncHttpClient client2 = asyncHttpClient(config2)) { + assertEquals(config1.getCookieStore().count(), 1); + verify(nettyTimerMock2, times(1)).newTimeout(any(CookieEvictionTask.class), anyLong(), any(TimeUnit.class)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDisablingCookieStore() throws IOException { + AsyncHttpClientConfig config = config() + .setCookieStore(null).build(); + try (AsyncHttpClient client = asyncHttpClient(config)) { + // + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/DigestAuthTest.java b/client/src/test/java/org/asynchttpclient/DigestAuthTest.java new file mode 100644 index 0000000000..d847396bd3 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/DigestAuthTest.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.digestAuthRealm; +import static org.asynchttpclient.test.TestUtils.ADMIN; +import static org.asynchttpclient.test.TestUtils.USER; +import static org.asynchttpclient.test.TestUtils.addDigestAuthHandler; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class DigestAuthTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + addDigestAuthHandler(server, configureHandler()); + server.start(); + port1 = connector.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SimpleHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void digestAuthTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet("http://localhost/" + port1 + '/') + .setRealm(digestAuthRealm(USER, ADMIN).setRealmName("MyRealm").build()) + .execute(); + Response resp = f.get(60, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertNotNull(resp.getHeader("X-Auth")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void digestAuthTestWithoutScheme() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet("http://localhost/" + port1 + '/') + .setRealm(digestAuthRealm(USER, ADMIN).setRealmName("MyRealm").build()) + .execute(); + Response resp = f.get(60, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertNotNull(resp.getHeader("X-Auth")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void digestAuthNegativeTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet("http://localhost/" + port1 + '/') + .setRealm(digestAuthRealm("fake", ADMIN).build()) + .execute(); + Response resp = f.get(20, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), 401); + } + } + + private static class SimpleHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + response.addHeader("X-Auth", request.getHeader("Authorization")); + response.setStatus(200); + response.getOutputStream().flush(); + response.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/EofTerminatedTest.java b/client/src/test/java/org/asynchttpclient/EofTerminatedTest.java new file mode 100644 index 0000000000..b63412df5f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/EofTerminatedTest.java @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaderValues; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.eclipse.jetty.server.handler.gzip.GzipHandler; + +import java.io.IOException; + +import static io.netty.handler.codec.http.HttpHeaderNames.ACCEPT_ENCODING; +import static io.netty.handler.codec.http.HttpHeaderNames.CONNECTION; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; + +public class EofTerminatedTest extends AbstractBasicTest { + + @Override + protected String getTargetUrl() { + return String.format("http://localhost:%d/", port1); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + GzipHandler gzipHandler = new GzipHandler(); + gzipHandler.setHandler(new StreamHandler()); + return gzipHandler; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testEolTerminatedResponse() throws Exception { + try (AsyncHttpClient ahc = asyncHttpClient(config().setMaxRequestRetry(0))) { + ahc.executeRequest(ahc.prepareGet(getTargetUrl()).setHeader(ACCEPT_ENCODING, HttpHeaderValues.GZIP_DEFLATE).setHeader(CONNECTION, HttpHeaderValues.CLOSE).build()) + .get(); + } + } + + private static class StreamHandler extends AbstractHandler { + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + request.getResponse().getHttpOutput().sendContent(EofTerminatedTest.class.getClassLoader().getResourceAsStream("SimpleTextFile.txt")); + } + } +} diff --git a/src/test/java/com/ning/http/client/async/ErrorResponseTest.java b/client/src/test/java/org/asynchttpclient/ErrorResponseTest.java similarity index 51% rename from src/test/java/com/ning/http/client/async/ErrorResponseTest.java rename to client/src/test/java/org/asynchttpclient/ErrorResponseTest.java index 0613c27ef7..59b6a07c0a 100644 --- a/src/test/java/com/ning/http/client/async/ErrorResponseTest.java +++ b/client/src/test/java/org/asynchttpclient/ErrorResponseTest.java @@ -1,7 +1,7 @@ /* * Copyright 2010 Ning, Inc. * - * Ning licenses this file to you under the Apache License, version 2.0 + * This program is licensed to you under the Apache License, version 2.0 * (the "License"); you may not use this file except in compliance with the * License. You may obtain a copy of the License at: * @@ -14,65 +14,63 @@ * under the License. * */ -package com.ning.http.client.async; +package org.asynchttpclient; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Response; +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; import org.eclipse.jetty.server.Request; import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.io.OutputStream; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; /** * Tests to reproduce issues with handling of error responses * * @author Tatu Saloranta */ -public abstract class ErrorResponseTest extends AbstractBasicTest { - final static String BAD_REQUEST_STR = "Very Bad Request! No cookies."; +public class ErrorResponseTest extends AbstractBasicTest { + static final String BAD_REQUEST_STR = "Very Bad Request! No cookies."; + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ErrorHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryParameters() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet("http://localhost/" + port1 + "/foo").addHeader("Accepts", "*/*").execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), 400); + assertEquals(resp.getResponseBody(), BAD_REQUEST_STR); + } + } private static class ErrorHandler extends AbstractHandler { - public void handle(String s, Request r, - HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { try { Thread.sleep(210L); } catch (InterruptedException e) { + // } response.setContentType("text/plain"); response.setStatus(400); OutputStream out = response.getOutputStream(); - out.write(BAD_REQUEST_STR.getBytes("UTF-8")); + out.write(BAD_REQUEST_STR.getBytes(UTF_8)); out.flush(); } } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new ErrorHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testQueryParameters() throws Exception { - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client - .prepareGet("http://127.0.0.1/" + port1 + "/foo") - .addHeader("Accepts", "*/*") - .execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), 400); - String respStr = resp.getResponseBody(); - assertEquals(BAD_REQUEST_STR, respStr); - client.close(); - } } diff --git a/client/src/test/java/org/asynchttpclient/Expect100ContinueTest.java b/client/src/test/java/org/asynchttpclient/Expect100ContinueTest.java new file mode 100644 index 0000000000..f604feeeb8 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/Expect100ContinueTest.java @@ -0,0 +1,79 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaderValues; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.Future; + +import static io.netty.handler.codec.http.HttpHeaderNames.EXPECT; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE_STRING; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +/** + * Test the Expect: 100-Continue. + */ +public class Expect100ContinueTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ZeroCopyHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void Expect100Continue() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePut("http://localhost/" + port1 + '/') + .setHeader(EXPECT, HttpHeaderValues.CONTINUE) + .setBody(SIMPLE_TEXT_FILE) + .execute(); + Response resp = f.get(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + } + } + + private static class ZeroCopyHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + int size = 10 * 1024; + if (httpRequest.getContentLength() > 0) { + size = httpRequest.getContentLength(); + } + byte[] bytes = new byte[size]; + if (bytes.length > 0) { + final int read = httpRequest.getInputStream().read(bytes); + httpResponse.getOutputStream().write(bytes, 0, read); + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/FollowingThreadTest.java b/client/src/test/java/org/asynchttpclient/FollowingThreadTest.java new file mode 100644 index 0000000000..444e13c285 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/FollowingThreadTest.java @@ -0,0 +1,99 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import org.junit.jupiter.api.Timeout; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; + +/** + * Simple stress test for exercising the follow redirect. + */ +public class FollowingThreadTest extends AbstractBasicTest { + + private static final int COUNT = 10; + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 30 * 1000) + public void testFollowRedirect() throws InterruptedException { + + final CountDownLatch countDown = new CountDownLatch(COUNT); + ExecutorService pool = Executors.newCachedThreadPool(); + try { + for (int i = 0; i < COUNT; i++) { + pool.submit(new Runnable() { + + private int status; + + @Override + public void run() { + final CountDownLatch l = new CountDownLatch(1); + try (AsyncHttpClient ahc = asyncHttpClient(config().setFollowRedirect(true))) { + ahc.prepareGet("http://www.google.com/").execute(new AsyncHandler() { + + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) { + System.out.println(new String(bodyPart.getBodyPartBytes())); + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + status = responseStatus.getStatusCode(); + System.out.println(responseStatus.getStatusText()); + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) { + return State.CONTINUE; + } + + @Override + public Integer onCompleted() { + l.countDown(); + return status; + } + }); + + l.await(); + } catch (Exception e) { + e.printStackTrace(); + } finally { + countDown.countDown(); + } + } + }); + } + countDown.await(); + } finally { + pool.shutdown(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/Head302Test.java b/client/src/test/java/org/asynchttpclient/Head302Test.java new file mode 100644 index 0000000000..7a81dad762 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/Head302Test.java @@ -0,0 +1,97 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.head; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Tests HEAD request that gets 302 response. + * + * @author Hubert Iwaniuk + */ +public class Head302Test extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new Head302handler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testHEAD302() throws Exception { + AsyncHttpClientConfig clientConfig = new DefaultAsyncHttpClientConfig.Builder().setFollowRedirect(true).build(); + try (AsyncHttpClient client = asyncHttpClient(clientConfig)) { + final CountDownLatch l = new CountDownLatch(1); + Request request = head("http://localhost/" + port1 + "/Test").build(); + + Response response = client.executeRequest(request, new AsyncCompletionHandlerBase() { + @Override + public Response onCompleted(Response response) throws Exception { + l.countDown(); + return super.onCompleted(response); + } + }).get(3, TimeUnit.SECONDS); + + if (l.await(TIMEOUT, TimeUnit.SECONDS)) { + assertEquals(response.getStatusCode(), HttpServletResponse.SC_OK); + System.out.println(response.getResponseBody()); + // TODO: 19-11-2022 PTAL +// assertTrue(response.getResponseBody().endsWith("_moved")); + } else { + fail("Timeout out"); + } + } + } + + /** + * Handler that does Found (302) in response to HEAD method. + */ + private static class Head302handler extends AbstractHandler { + @Override + public void handle(String s, org.eclipse.jetty.server.Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if ("HEAD".equalsIgnoreCase(request.getMethod())) { + // See https://github.com/AsyncHttpClient/async-http-client/issues/1728#issuecomment-700007980 + // When setFollowRedirect == TRUE, a follow-up request to a HEAD request will also be a HEAD. + // This will cause an infinite loop, which will error out once the maximum amount of redirects is hit (default 5). + // Instead, we (arbitrarily) choose to allow for 3 redirects and then return a 200. + if (request.getRequestURI().endsWith("_moved_moved_moved")) { + response.setStatus(HttpServletResponse.SC_OK); + } else { + response.setStatus(HttpServletResponse.SC_FOUND); // 302 + response.setHeader("Location", request.getPathInfo() + "_moved"); + } + } else if ("GET".equalsIgnoreCase(request.getMethod())) { + response.setStatus(HttpServletResponse.SC_OK); + } else { + response.setStatus(HttpServletResponse.SC_FORBIDDEN); + } + + r.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/HttpToHttpsRedirectTest.java b/client/src/test/java/org/asynchttpclient/HttpToHttpsRedirectTest.java new file mode 100644 index 0000000000..5795165343 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/HttpToHttpsRedirectTest.java @@ -0,0 +1,154 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.util.Enumeration; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class HttpToHttpsRedirectTest extends AbstractBasicTest { + + // FIXME super NOT threadsafe!!! + private static final AtomicBoolean redirectDone = new AtomicBoolean(false); + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + ServerConnector connector2 = addHttpsConnector(server); + server.setHandler(new Relative302Handler()); + server.start(); + port1 = connector1.getLocalPort(); + port2 = connector2.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + // FIXME find a way to make this threadsafe, other, set @RepeatedIfExceptionsTest(repeats = 5)(singleThreaded = true) + public void runAllSequentiallyBecauseNotThreadSafe() throws Exception { + httpToHttpsRedirect(); + httpToHttpsProperConfig(); + relativeLocationUrl(); + } + + // @Disabled + @RepeatedIfExceptionsTest(repeats = 5) + public void httpToHttpsRedirect() throws Exception { + redirectDone.getAndSet(false); + + AsyncHttpClientConfig cg = config() + .setMaxRedirects(5) + .setFollowRedirect(true) + .setUseInsecureTrustManager(true) + .build(); + try (AsyncHttpClient c = asyncHttpClient(cg)) { + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", getTargetUrl2()).execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getHeader("X-httpToHttps"), "PASS"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void httpToHttpsProperConfig() throws Exception { + redirectDone.getAndSet(false); + + AsyncHttpClientConfig cg = config() + .setMaxRedirects(5) + .setFollowRedirect(true) + .setUseInsecureTrustManager(true) + .build(); + try (AsyncHttpClient c = asyncHttpClient(cg)) { + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", getTargetUrl2() + "/test2").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getHeader("X-httpToHttps"), "PASS"); + + // Test if the internal channel is downgraded to clean http. + response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", getTargetUrl2() + "/foo2").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getHeader("X-httpToHttps"), "PASS"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void relativeLocationUrl() throws Exception { + redirectDone.getAndSet(false); + + AsyncHttpClientConfig cg = config() + .setMaxRedirects(5) + .setFollowRedirect(true) + .setUseInsecureTrustManager(true) + .build(); + try (AsyncHttpClient c = asyncHttpClient(cg)) { + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", "/foo/test").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getUri().toString(), getTargetUrl()); + } + } + + private static class Relative302Handler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + String param; + httpResponse.setContentType(TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + Enumeration e = httpRequest.getHeaderNames(); + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + + if (param.startsWith("X-redirect") && !redirectDone.getAndSet(true)) { + httpResponse.addHeader("Location", httpRequest.getHeader(param)); + httpResponse.setStatus(302); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + return; + } + } + + if ("https".equalsIgnoreCase(r.getScheme())) { + httpResponse.addHeader("X-httpToHttps", "PASS"); + redirectDone.getAndSet(false); + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/IdleStateHandlerTest.java b/client/src/test/java/org/asynchttpclient/IdleStateHandlerTest.java new file mode 100644 index 0000000000..f229ca5abe --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/IdleStateHandlerTest.java @@ -0,0 +1,74 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.time.Duration; +import java.util.concurrent.ExecutionException; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.fail; + +public class IdleStateHandlerTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(new IdleStateHandler()); + server.start(); + port1 = connector.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void idleStateTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setPooledConnectionIdleTimeout(Duration.ofSeconds(10)))) { + c.prepareGet(getTargetUrl()).execute().get(); + } catch (ExecutionException e) { + fail("Should allow to finish processing request.", e); + } + } + + private static class IdleStateHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + try { + Thread.sleep(20 * 1000); + } catch (InterruptedException e) { + e.printStackTrace(); + } + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ListenableFutureTest.java b/client/src/test/java/org/asynchttpclient/ListenableFutureTest.java new file mode 100644 index 0000000000..fb51bf551b --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ListenableFutureTest.java @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class ListenableFutureTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testListenableFuture() throws Exception { + final AtomicInteger statusCode = new AtomicInteger(500); + try (AsyncHttpClient ahc = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final ListenableFuture future = ahc.prepareGet(getTargetUrl()).execute(); + future.addListener(() -> { + try { + statusCode.set(future.get().getStatusCode()); + latch.countDown(); + } catch (InterruptedException | ExecutionException e) { + e.printStackTrace(); + } + }, Executors.newFixedThreadPool(1)); + + latch.await(10, TimeUnit.SECONDS); + assertEquals(statusCode.get(), 200); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testListenableFutureAfterCompletion() throws Exception { + + final CountDownLatch latch = new CountDownLatch(1); + + try (AsyncHttpClient ahc = asyncHttpClient()) { + final ListenableFuture future = ahc.prepareGet(getTargetUrl()).execute(); + future.get(); + future.addListener(latch::countDown, Runnable::run); + } + + latch.await(10, TimeUnit.SECONDS); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testListenableFutureBeforeAndAfterCompletion() throws Exception { + + final CountDownLatch latch = new CountDownLatch(2); + + try (AsyncHttpClient ahc = asyncHttpClient()) { + final ListenableFuture future = ahc.prepareGet(getTargetUrl()).execute(); + future.addListener(latch::countDown, Runnable::run); + future.get(); + future.addListener(latch::countDown, Runnable::run); + } + + latch.await(10, TimeUnit.SECONDS); + } +} diff --git a/client/src/test/java/org/asynchttpclient/MultipleHeaderTest.java b/client/src/test/java/org/asynchttpclient/MultipleHeaderTest.java new file mode 100644 index 0000000000..cf6dbc3536 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/MultipleHeaderTest.java @@ -0,0 +1,201 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import javax.net.ServerSocketFactory; +import java.io.BufferedReader; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.OutputStreamWriter; +import java.net.ServerSocket; +import java.net.Socket; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.get; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * @author Hubert Iwaniuk + */ +public class MultipleHeaderTest extends AbstractBasicTest { + private static ExecutorService executorService; + private static ServerSocket serverSocket; + private static Future voidFuture; + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + serverSocket = ServerSocketFactory.getDefault().createServerSocket(0); + port1 = serverSocket.getLocalPort(); + executorService = Executors.newFixedThreadPool(1); + voidFuture = executorService.submit(() -> { + Socket socket; + while ((socket = serverSocket.accept()) != null) { + InputStream inputStream = socket.getInputStream(); + BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream)); + String req = reader.readLine().split(" ")[1]; + int i = inputStream.available(); + long l = inputStream.skip(i); + assertEquals(l, i); + socket.shutdownInput(); + if (req.endsWith("MultiEnt")) { + OutputStreamWriter outputStreamWriter = new OutputStreamWriter(socket.getOutputStream()); + outputStreamWriter.append("HTTP/1.0 200 OK\n" + "Connection: close\n" + "Content-Type: text/plain; charset=iso-8859-1\n" + "X-Duplicated-Header: 2\n" + + "X-Duplicated-Header: 1\n" + "\n0\n"); + outputStreamWriter.flush(); + socket.shutdownOutput(); + } else if (req.endsWith("MultiOther")) { + OutputStreamWriter outputStreamWriter = new OutputStreamWriter(socket.getOutputStream()); + outputStreamWriter.append("HTTP/1.0 200 OK\n" + "Connection: close\n" + "Content-Type: text/plain; charset=iso-8859-1\n" + "Content-Length: 1\n" + + "X-Forwarded-For: abc\n" + "X-Forwarded-For: def\n" + "\n0\n"); + outputStreamWriter.flush(); + socket.shutdownOutput(); + } + } + return null; + }); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + voidFuture.cancel(true); + executorService.shutdownNow(); + serverSocket.close(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMultipleOtherHeaders() throws Exception { + final String[] xffHeaders = {null, null}; + + try (AsyncHttpClient ahc = asyncHttpClient()) { + Request req = get("http://localhost/" + port1 + "/MultiOther").build(); + final CountDownLatch latch = new CountDownLatch(1); + ahc.executeRequest(req, new AsyncHandler() { + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(System.out); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart objectHttpResponseBodyPart) { + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus objectHttpResponseStatus) { + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders response) { + int i = 0; + for (String header : response.getAll("X-Forwarded-For")) { + xffHeaders[i++] = header; + } + latch.countDown(); + return State.CONTINUE; + } + + @Override + public Void onCompleted() { + return null; + } + }).get(3, TimeUnit.SECONDS); + + if (!latch.await(2, TimeUnit.SECONDS)) { + fail("Time out"); + } + assertNotNull(xffHeaders[0]); + assertNotNull(xffHeaders[1]); + try { + assertEquals(xffHeaders[0], "abc"); + assertEquals(xffHeaders[1], "def"); + } catch (AssertionError ex) { + assertEquals(xffHeaders[1], "abc"); + assertEquals(xffHeaders[0], "def"); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMultipleEntityHeaders() throws Exception { + final String[] clHeaders = {null, null}; + + try (AsyncHttpClient ahc = asyncHttpClient()) { + Request req = get("http://localhost/" + port1 + "/MultiEnt").build(); + final CountDownLatch latch = new CountDownLatch(1); + ahc.executeRequest(req, new AsyncHandler() { + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(System.out); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart objectHttpResponseBodyPart) { + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus objectHttpResponseStatus) { + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders response) { + try { + int i = 0; + for (String header : response.getAll("X-Duplicated-Header")) { + clHeaders[i++] = header; + } + } finally { + latch.countDown(); + } + return State.CONTINUE; + } + + @Override + public Void onCompleted() { + return null; + } + }).get(3, TimeUnit.SECONDS); + + if (!latch.await(2, TimeUnit.SECONDS)) { + fail("Time out"); + } + assertNotNull(clHeaders[0]); + assertNotNull(clHeaders[1]); + + // We can predict the order + try { + assertEquals(clHeaders[0], "2"); + assertEquals(clHeaders[1], "1"); + } catch (Throwable ex) { + assertEquals(clHeaders[0], "1"); + assertEquals(clHeaders[1], "2"); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/NoNullResponseTest.java b/client/src/test/java/org/asynchttpclient/NoNullResponseTest.java new file mode 100644 index 0000000000..346f78d3ff --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/NoNullResponseTest.java @@ -0,0 +1,51 @@ +/* + * Copyright 2010-2013 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient; + +import org.junit.jupiter.api.RepeatedTest; + +import java.time.Duration; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class NoNullResponseTest extends AbstractBasicTest { + private static final String GOOGLE_HTTPS_URL = "https://www.google.com/"; + + @RepeatedTest(4) + public void multipleSslRequestsWithDelayAndKeepAlive() throws Exception { + AsyncHttpClientConfig config = config() + .setFollowRedirect(true) + .setKeepAlive(true) + .setConnectTimeout(Duration.ofSeconds(10)) + .setPooledConnectionIdleTimeout(Duration.ofMinutes(1)) + .setRequestTimeout(Duration.ofSeconds(10)) + .setMaxConnectionsPerHost(-1) + .setMaxConnections(-1) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + final BoundRequestBuilder builder = client.prepareGet(GOOGLE_HTTPS_URL); + final Response response1 = builder.execute().get(); + Thread.sleep(4000); + final Response response2 = builder.execute().get(); + assertNotNull(response1); + assertNotNull(response2); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/NonAsciiContentLengthTest.java b/client/src/test/java/org/asynchttpclient/NonAsciiContentLengthTest.java new file mode 100644 index 0000000000..0d2aa562ce --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/NonAsciiContentLengthTest.java @@ -0,0 +1,83 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.ServletOutputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class NonAsciiContentLengthTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(new AbstractHandler() { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException { + int MAX_BODY_SIZE = 1024; // Can only handle bodies of up to 1024 bytes. + byte[] b = new byte[MAX_BODY_SIZE]; + int offset = 0; + int numBytesRead; + try (ServletInputStream is = request.getInputStream()) { + while ((numBytesRead = is.read(b, offset, MAX_BODY_SIZE - offset)) != -1) { + offset += numBytesRead; + } + } + assertEquals(request.getContentLength(), offset); + response.setStatus(200); + response.setCharacterEncoding(request.getCharacterEncoding()); + response.setContentLength(request.getContentLength()); + try (ServletOutputStream os = response.getOutputStream()) { + os.write(b, 0, offset); + } + } + }); + server.start(); + port1 = connector.getLocalPort(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNonAsciiContentLength() throws Exception { + execute("test"); + execute("\u4E00"); // Unicode CJK ideograph for one + } + + protected void execute(String body) throws IOException, InterruptedException, ExecutionException { + try (AsyncHttpClient client = asyncHttpClient()) { + BoundRequestBuilder r = client.preparePost(getTargetUrl()).setBody(body).setCharset(UTF_8); + Future f = r.execute(); + Response resp = f.get(); + assertEquals(resp.getStatusCode(), 200); + assertEquals(body, resp.getResponseBody(UTF_8)); + } + } +} diff --git a/src/test/java/com/ning/http/client/async/ParamEncodingTest.java b/client/src/test/java/org/asynchttpclient/ParamEncodingTest.java similarity index 50% rename from src/test/java/com/ning/http/client/async/ParamEncodingTest.java rename to client/src/test/java/org/asynchttpclient/ParamEncodingTest.java index 02af3160ee..dcd27d46de 100644 --- a/src/test/java/com/ning/http/client/async/ParamEncodingTest.java +++ b/client/src/test/java/org/asynchttpclient/ParamEncodingTest.java @@ -1,7 +1,7 @@ /* * Copyright 2010 Ning, Inc. * - * Ning licenses this file to you under the Apache License, version 2.0 + * This program is licensed to you under the Apache License, version 2.0 * (the "License"); you may not use this file except in compliance with the * License. You may obtain a copy of the License at: * @@ -13,36 +13,50 @@ * License for the specific language governing permissions and limitations * under the License. */ -package com.ning.http.client.async; +package org.asynchttpclient; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Response; +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; import org.eclipse.jetty.server.Request; import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; import java.io.IOException; -import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; -public abstract class ParamEncodingTest extends AbstractBasicTest { +public class ParamEncodingTest extends AbstractBasicTest { - private class ParamEncoding extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { + @RepeatedIfExceptionsTest(repeats = 5) + public void testParameters() throws Exception { + + String value = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKQLMNOPQRSTUVWXYZ1234567809`~!@#$%^&*()_+-=,.<>/?;:'\"[]{}\\| "; + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost("http://localhost/" + port1).addFormParam("test", value).execute(); + Response resp = f.get(10, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("X-Param"), value.trim()); + } + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ParamEncoding(); + } + + private static class ParamEncoding extends AbstractHandler { + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { if ("POST".equalsIgnoreCase(request.getMethod())) { String p = request.getParameter("test"); - if (p != null && !p.equals("")) { + if (isNonEmpty(p)) { response.setStatus(HttpServletResponse.SC_OK); response.addHeader("X-Param", p); } else { @@ -55,25 +69,4 @@ public void handle(String s, response.getOutputStream().close(); } } - - @Test(groups = {"standalone", "default_provider"}) - public void testParameters() throws IOException, ExecutionException, TimeoutException, InterruptedException { - - String value = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKQLMNOPQRSTUVWXYZ1234567809`~!@#$%^&*()_+-=,.<>/?;:'\"[]{}\\| "; - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client - .preparePost("http://127.0.0.1/" + port1) - .addParameter("test", value) - .execute(); - Response resp = f.get(10, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("X-Param"), value.trim()); - client.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new ParamEncoding(); - } } diff --git a/client/src/test/java/org/asynchttpclient/PerRequestRelative302Test.java b/client/src/test/java/org/asynchttpclient/PerRequestRelative302Test.java new file mode 100644 index 0000000000..ae3eccf85d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/PerRequestRelative302Test.java @@ -0,0 +1,169 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.uri.Uri; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.net.ConnectException; +import java.util.Enumeration; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.findFreePort; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class PerRequestRelative302Test extends AbstractBasicTest { + + // FIXME super NOT threadsafe!!! + private static final AtomicBoolean isSet = new AtomicBoolean(false); + + private static int getPort(Uri uri) { + int port = uri.getPort(); + if (port == -1) { + port = "http".equals(uri.getScheme()) ? 80 : 443; + } + return port; + } + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + + server.setHandler(new Relative302Handler()); + server.start(); + port1 = connector.getLocalPort(); + logger.info("Local HTTP server started successfully"); + port2 = findFreePort(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + // FIXME threadsafe + public void runAllSequentiallyBecauseNotThreadSafe() throws Exception { + redirected302Test(); + notRedirected302Test(); + relativeLocationUrl(); + redirected302InvalidTest(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void redirected302Test() throws Exception { + isSet.getAndSet(false); + try (AsyncHttpClient c = asyncHttpClient()) { + Response response = c.prepareGet(getTargetUrl()).setFollowRedirect(true).setHeader("X-redirect", "https://www.google.com/").execute().get(); + + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + + String anyGooglePage = "https://www.google.com[^:]*:443"; + String baseUrl = getBaseUrl(response.getUri()); + + assertTrue(baseUrl.matches(anyGooglePage), "response does not show redirection to " + anyGooglePage); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void notRedirected302Test() throws Exception { + isSet.getAndSet(false); + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + Response response = c.prepareGet(getTargetUrl()).setFollowRedirect(false).setHeader("X-redirect", "http://www.microsoft.com/").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 302); + } + } + + private static String getBaseUrl(Uri uri) { + String url = uri.toString(); + int port = uri.getPort(); + if (port == -1) { + port = getPort(uri); + url = url.substring(0, url.length() - 1) + ':' + port; + } + return url.substring(0, url.lastIndexOf(':') + String.valueOf(port).length() + 1); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void redirected302InvalidTest() throws Exception { + isSet.getAndSet(false); + Exception e = null; + + try (AsyncHttpClient c = asyncHttpClient()) { + c.preparePost(getTargetUrl()).setFollowRedirect(true).setHeader("X-redirect", String.format("http://localhost:%d/", port2)).execute().get(); + } catch (ExecutionException ex) { + e = ex; + } + + assertNotNull(e); + Throwable cause = e.getCause(); + assertInstanceOf(ConnectException.class, cause); + assertTrue(cause.getMessage().contains(":" + port2)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void relativeLocationUrl() throws Exception { + isSet.getAndSet(false); + + try (AsyncHttpClient c = asyncHttpClient()) { + Response response = c.preparePost(getTargetUrl()).setFollowRedirect(true).setHeader("X-redirect", "/foo/test").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getUri().toString(), getTargetUrl()); + } + } + + private static class Relative302Handler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + String param; + httpResponse.setContentType(TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + Enumeration e = httpRequest.getHeaderNames(); + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + + if (param.startsWith("X-redirect") && !isSet.getAndSet(true)) { + httpResponse.addHeader("Location", httpRequest.getHeader(param)); + httpResponse.setStatus(302); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + return; + } + } + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/PerRequestTimeoutTest.java b/client/src/test/java/org/asynchttpclient/PerRequestTimeoutTest.java new file mode 100644 index 0000000000..bee7d0b676 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/PerRequestTimeoutTest.java @@ -0,0 +1,193 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.AsyncContext; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.time.Duration; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.util.DateUtils.unpreciseMillisTime; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Per request timeout configuration test. + * + * @author Hubert Iwaniuk + */ +public class PerRequestTimeoutTest extends AbstractBasicTest { + private static final String MSG = "Enough is enough."; + + private static void checkTimeoutMessage(String message, boolean requestTimeout) { + if (requestTimeout) { + assertTrue(message.startsWith("Request timeout"), "error message indicates reason of error but got: " + message); + } else { + assertTrue(message.startsWith("Read timeout"), "error message indicates reason of error but got: " + message); + } + assertTrue(message.contains("localhost"), "error message contains remote host address but got: " + message); + assertTrue(message.contains("after 100 ms"), "error message contains timeout configuration value but got: " + message); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SlowHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRequestTimeout() throws IOException { + try (AsyncHttpClient client = asyncHttpClient()) { + Future responseFuture = client.prepareGet(getTargetUrl()) + .setRequestTimeout(Duration.ofMillis(100)) + .execute(); + Response response = responseFuture.get(2000, TimeUnit.MILLISECONDS); + assertNull(response); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } catch (ExecutionException e) { + assertInstanceOf(TimeoutException.class, e.getCause()); + checkTimeoutMessage(e.getCause().getMessage(), true); + } catch (TimeoutException e) { + fail("Timeout.", e); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testReadTimeout() throws IOException { + try (AsyncHttpClient client = asyncHttpClient(config().setReadTimeout(Duration.ofMillis(100)))) { + Future responseFuture = client.prepareGet(getTargetUrl()).execute(); + Response response = responseFuture.get(2000, TimeUnit.MILLISECONDS); + assertNull(response); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } catch (ExecutionException e) { + assertInstanceOf(TimeoutException.class, e.getCause()); + checkTimeoutMessage(e.getCause().getMessage(), false); + } catch (TimeoutException e) { + fail("Timeout.", e); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGlobalDefaultPerRequestInfiniteTimeout() throws IOException { + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMillis(100)))) { + Future responseFuture = client.prepareGet(getTargetUrl()) + .setRequestTimeout(Duration.ofMillis(-1)) + .execute(); + Response response = responseFuture.get(); + assertNotNull(response); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } catch (ExecutionException e) { + assertInstanceOf(TimeoutException.class, e.getCause()); + checkTimeoutMessage(e.getCause().getMessage(), true); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGlobalRequestTimeout() throws IOException { + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMillis(100)))) { + Future responseFuture = client.prepareGet(getTargetUrl()).execute(); + Response response = responseFuture.get(2000, TimeUnit.MILLISECONDS); + assertNull(response); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } catch (ExecutionException e) { + assertInstanceOf(TimeoutException.class, e.getCause()); + checkTimeoutMessage(e.getCause().getMessage(), true); + } catch (TimeoutException e) { + fail("Timeout.", e); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGlobalIdleTimeout() throws IOException { + final long[] times = {-1, -1}; + + try (AsyncHttpClient client = asyncHttpClient(config().setPooledConnectionIdleTimeout(Duration.ofSeconds(2)))) { + Future responseFuture = client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandler() { + @Override + public Response onCompleted(Response response) { + return response; + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart content) throws Exception { + times[0] = unpreciseMillisTime(); + return super.onBodyPartReceived(content); + } + + @Override + public void onThrowable(Throwable t) { + times[1] = unpreciseMillisTime(); + super.onThrowable(t); + } + }); + Response response = responseFuture.get(); + assertNotNull(response); + assertEquals(response.getResponseBody(), MSG + MSG); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } catch (ExecutionException e) { + logger.info(String.format("\n@%dms Last body part received\n@%dms Connection killed\n %dms difference.", times[0], times[1], times[1] - times[0])); + fail("Timeouted on idle.", e); + } + } + + private static class SlowHandler extends AbstractHandler { + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, final HttpServletResponse response) throws IOException, ServletException { + response.setStatus(HttpServletResponse.SC_OK); + final AsyncContext asyncContext = request.startAsync(); + new Thread(() -> { + try { + Thread.sleep(1500); + response.getOutputStream().print(MSG); + response.getOutputStream().flush(); + } catch (InterruptedException | IOException e) { + logger.error(e.getMessage(), e); + } + }).start(); + new Thread(() -> { + try { + Thread.sleep(3000); + response.getOutputStream().print(MSG); + response.getOutputStream().flush(); + asyncContext.complete(); + } catch (InterruptedException | IOException e) { + logger.error(e.getMessage(), e); + } + }).start(); + baseRequest.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/PostRedirectGetTest.java b/client/src/test/java/org/asynchttpclient/PostRedirectGetTest.java new file mode 100644 index 0000000000..ae752760b8 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/PostRedirectGetTest.java @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2012-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.filter.FilterContext; +import org.asynchttpclient.filter.ResponseFilter; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.post; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.fail; + +public class PostRedirectGetTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new PostRedirectGetHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postRedirectGet302Test() throws Exception { + doTestPositive(302); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postRedirectGet302StrictTest() throws Exception { + doTestNegative(302, true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postRedirectGet303Test() throws Exception { + doTestPositive(303); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postRedirectGet301Test() throws Exception { + doTestPositive(301); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postRedirectGet307Test() throws Exception { + doTestNegative(307, false); + } + + // --------------------------------------------------------- Private Methods + + private void doTestNegative(final int status, boolean strict) throws Exception { + + ResponseFilter responseFilter = new ResponseFilter() { + @Override + public FilterContext filter(FilterContext ctx) { + // pass on the x-expect-get and remove the x-redirect + // headers if found in the response + ctx.getResponseHeaders().get("x-expect-post"); + ctx.getRequest().getHeaders().add("x-expect-post", "true"); + ctx.getRequest().getHeaders().remove("x-redirect"); + return ctx; + } + }; + + try (AsyncHttpClient p = asyncHttpClient(config().setFollowRedirect(true).setStrict302Handling(strict).addResponseFilter(responseFilter))) { + Request request = post(getTargetUrl()).addFormParam("q", "a b").addHeader("x-redirect", +status + "@" + "http://localhost/" + port1 + "/foo/bar/baz").addHeader("x-negative", "true").build(); + Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { + + @Override + public Integer onCompleted(Response response) { + return response.getStatusCode(); + } + + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(); + fail("Unexpected exception: " + t.getMessage(), t); + } + + }); + int statusCode = responseFuture.get(); + assertEquals(statusCode, 200); + } + } + + private void doTestPositive(final int status) throws Exception { + + ResponseFilter responseFilter = new ResponseFilter() { + @Override + public FilterContext filter(FilterContext ctx) { + // pass on the x-expect-get and remove the x-redirect + // headers if found in the response + ctx.getResponseHeaders().get("x-expect-get"); + ctx.getRequest().getHeaders().add("x-expect-get", "true"); + ctx.getRequest().getHeaders().remove("x-redirect"); + return ctx; + } + }; + + try (AsyncHttpClient p = asyncHttpClient(config().setFollowRedirect(true).addResponseFilter(responseFilter))) { + Request request = post(getTargetUrl()).addFormParam("q", "a b").addHeader("x-redirect", +status + "@" + "http://localhost/" + port1 + "/foo/bar/baz").build(); + Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { + + @Override + public Integer onCompleted(Response response) { + return response.getStatusCode(); + } + + @Override + public void onThrowable(Throwable t) { + t.printStackTrace(); + fail("Unexpected exception: " + t.getMessage(), t); + } + + }); + int statusCode = responseFuture.get(); + assertEquals(statusCode, 200); + } + } + + // ---------------------------------------------------------- Nested Classes + + public static class PostRedirectGetHandler extends AbstractHandler { + + final AtomicInteger counter = new AtomicInteger(); + + @Override + public void handle(String pathInContext, org.eclipse.jetty.server.Request request, HttpServletRequest httpRequest, + HttpServletResponse httpResponse) throws IOException, ServletException { + + final boolean expectGet = httpRequest.getHeader("x-expect-get") != null; + final boolean expectPost = httpRequest.getHeader("x-expect-post") != null; + if (expectGet) { + final String method = request.getMethod(); + if (!"GET".equals(method)) { + httpResponse.sendError(500, "Incorrect method. Expected GET, received " + method); + return; + } + httpResponse.setStatus(200); + httpResponse.getOutputStream().write("OK".getBytes()); + httpResponse.getOutputStream().flush(); + return; + } + if (expectPost) { + final String method = request.getMethod(); + if (!"POST".equals(method)) { + httpResponse.sendError(500, "Incorrect method. Expected POST, received " + method); + return; + } + httpResponse.setStatus(200); + httpResponse.getOutputStream().write("OK".getBytes()); + httpResponse.getOutputStream().flush(); + return; + } + + String header = httpRequest.getHeader("x-redirect"); + if (header != null) { + // format for header is | + String[] parts = header.split("@"); + int redirectCode; + try { + redirectCode = Integer.parseInt(parts[0]); + } catch (Exception ex) { + ex.printStackTrace(); + httpResponse.sendError(500, "Unable to parse redirect code"); + return; + } + httpResponse.setStatus(redirectCode); + if (httpRequest.getHeader("x-negative") == null) { + httpResponse.addHeader("x-expect-get", "true"); + } else { + httpResponse.addHeader("x-expect-post", "true"); + } + httpResponse.setContentLength(0); + httpResponse.addHeader("Location", parts[1] + counter.getAndIncrement()); + httpResponse.getOutputStream().flush(); + return; + } + + httpResponse.sendError(500); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/PostWithQueryStringTest.java b/client/src/test/java/org/asynchttpclient/PostWithQueryStringTest.java new file mode 100644 index 0000000000..a78ef4a848 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/PostWithQueryStringTest.java @@ -0,0 +1,123 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.ServletOutputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +/** + * Tests POST request with Query String. + * + * @author Hubert Iwaniuk + */ +public class PostWithQueryStringTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void postWithQueryString() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost("http://localhost/" + port1 + "/?a=b").setBody("abc".getBytes()).execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postWithNullQueryParam() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost("http://localhost/" + port1 + "/?a=b&c&d=e").setBody("abc".getBytes()).execute(new AsyncCompletionHandlerBase() { + + @Override + public State onStatusReceived(final HttpResponseStatus status) throws Exception { + if (!status.getUri().toUrl().equals("http://localhost/" + port1 + "/?a=b&c&d=e")) { + throw new IOException("failed to parse the query properly"); + } + return super.onStatusReceived(status); + } + + }); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void postWithEmptyParamsQueryString() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePost("http://localhost/" + port1 + "/?a=b&c=&d=e").setBody("abc".getBytes()).execute(new AsyncCompletionHandlerBase() { + + @Override + public State onStatusReceived(final HttpResponseStatus status) throws Exception { + if (!status.getUri().toUrl().equals("http://localhost/" + port1 + "/?a=b&c=&d=e")) { + throw new IOException("failed to parse the query properly"); + } + return super.onStatusReceived(status); + } + + }); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + } + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new PostWithQueryStringHandler(); + } + + /** + * POST with QueryString server part. + */ + private static class PostWithQueryStringHandler extends AbstractHandler { + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if ("POST".equalsIgnoreCase(request.getMethod())) { + String qs = request.getQueryString(); + if (isNonEmpty(qs) && request.getContentLength() == 3) { + ServletInputStream is = request.getInputStream(); + response.setStatus(HttpServletResponse.SC_OK); + byte[] buf = new byte[is.available()]; + is.readLine(buf, 0, is.available()); + ServletOutputStream os = response.getOutputStream(); + os.println(new String(buf)); + os.flush(); + os.close(); + } else { + response.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE); + } + } else { // this handler is to handle POST request + response.sendError(HttpServletResponse.SC_FORBIDDEN); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/QueryParametersTest.java b/client/src/test/java/org/asynchttpclient/QueryParametersTest.java new file mode 100644 index 0000000000..fd71cc1b95 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/QueryParametersTest.java @@ -0,0 +1,105 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.net.URLDecoder; +import java.net.URLEncoder; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.util.MiscUtils.isNonEmpty; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +/** + * Testing query parameters support. + * + * @author Hubert Iwaniuk + */ +public class QueryParametersTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new QueryStringHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryParameters() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.prepareGet("http://localhost/" + port1).addQueryParam("a", "1").addQueryParam("b", "2").execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("a"), "1"); + assertEquals(resp.getHeader("b"), "2"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUrlRequestParametersEncoding() throws Exception { + String URL = getTargetUrl() + "?q="; + String REQUEST_PARAM = "github github \ngithub"; + + try (AsyncHttpClient client = asyncHttpClient()) { + String requestUrl2 = URL + URLEncoder.encode(REQUEST_PARAM, UTF_8); + logger.info("Executing request [{}] ...", requestUrl2); + Response response = client.prepareGet(requestUrl2).execute().get(); + String s = URLDecoder.decode(response.getHeader("q"), UTF_8); + assertEquals(s, REQUEST_PARAM); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void urlWithColonTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + String query = "test:colon:"; + Response response = c.prepareGet(String.format("http://localhost:%d/foo/test/colon?q=%s", port1, query)).setHeader("Content-Type", "text/html").execute().get(TIMEOUT, TimeUnit.SECONDS); + + assertEquals(response.getHeader("q"), query); + } + } + + private static class QueryStringHandler extends AbstractHandler { + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if ("GET".equalsIgnoreCase(request.getMethod())) { + String qs = request.getQueryString(); + if (isNonEmpty(qs)) { + for (String qnv : qs.split("&")) { + String[] nv = qnv.split("="); + response.addHeader(nv[0], nv[1]); + } + response.setStatus(HttpServletResponse.SC_OK); + } else { + response.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE); + } + } else { // this handler is to handle POST request + response.sendError(HttpServletResponse.SC_FORBIDDEN); + } + r.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/RC1KTest.java b/client/src/test/java/org/asynchttpclient/RC1KTest.java new file mode 100644 index 0000000000..36f9bf1b91 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/RC1KTest.java @@ -0,0 +1,149 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Timeout; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +/** + * Reverse C1K Problem test. + * + * @author Hubert Iwaniuk + */ +public class RC1KTest extends AbstractBasicTest { + private static final int C1K = 1000; + private static final String ARG_HEADER = "Arg"; + private static final int SRV_COUNT = 10; + private static final Server[] servers = new Server[SRV_COUNT]; + private static int[] ports = new int[SRV_COUNT]; + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + ports = new int[SRV_COUNT]; + for (int i = 0; i < SRV_COUNT; i++) { + Server server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(configureHandler()); + server.start(); + servers[i] = server; + ports[i] = connector.getLocalPort(); + } + logger.info("Local HTTP servers started successfully"); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + for (Server srv : servers) { + srv.stop(); + } + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + @Override + public void handle(String s, Request r, HttpServletRequest req, HttpServletResponse resp) throws IOException { + resp.setContentType("text/pain"); + String arg = s.substring(1); + resp.setHeader(ARG_HEADER, arg); + resp.setStatus(200); + resp.getOutputStream().print(arg); + resp.getOutputStream().flush(); + resp.getOutputStream().close(); + } + }; + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 10 * 60 * 1000) + public void rc10kProblem() throws Exception { + try (AsyncHttpClient ahc = asyncHttpClient(config().setMaxConnectionsPerHost(C1K).setKeepAlive(true))) { + List> resps = new ArrayList<>(C1K); + int i = 0; + while (i < C1K) { + resps.add(ahc.prepareGet(String.format("http://localhost:%d/%d", ports[i % SRV_COUNT], i)).execute(new MyAsyncHandler(i++))); + } + i = 0; + for (Future fResp : resps) { + Integer resp = fResp.get(); + assertNotNull(resp); + assertEquals(resp.intValue(), i++); + } + } + } + + private static class MyAsyncHandler implements AsyncHandler { + private final String arg; + private final AtomicInteger result = new AtomicInteger(-1); + + MyAsyncHandler(int i) { + arg = String.format("%d", i); + } + + @Override + public void onThrowable(Throwable t) { + logger.warn("onThrowable called.", t); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart event) { + String s = new String(event.getBodyPartBytes()); + result.compareAndSet(-1, Integer.valueOf(s.trim().isEmpty() ? "-1" : s)); + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus event) { + assertEquals(event.getStatusCode(), 200); + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders event) { + assertEquals(event.get(ARG_HEADER), arg); + return State.CONTINUE; + } + + @Override + public Integer onCompleted() { + return result.get(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/RealmTest.java b/client/src/test/java/org/asynchttpclient/RealmTest.java new file mode 100644 index 0000000000..6c85ca8af5 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/RealmTest.java @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.uri.Uri; +import org.asynchttpclient.util.StringUtils; + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; + +import static java.nio.charset.StandardCharsets.UTF_16; +import static org.asynchttpclient.Dsl.basicAuthRealm; +import static org.asynchttpclient.Dsl.digestAuthRealm; +import static org.asynchttpclient.Dsl.realm; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class RealmTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testClone() { + Realm orig = basicAuthRealm("user", "pass").setCharset(UTF_16) + .setUsePreemptiveAuth(true) + .setRealmName("realm") + .setAlgorithm("algo").build(); + + Realm clone = realm(orig).build(); + assertEquals(clone.getPrincipal(), orig.getPrincipal()); + assertEquals(clone.getPassword(), orig.getPassword()); + assertEquals(clone.getCharset(), orig.getCharset()); + assertEquals(clone.isUsePreemptiveAuth(), orig.isUsePreemptiveAuth()); + assertEquals(clone.getRealmName(), orig.getRealmName()); + assertEquals(clone.getAlgorithm(), orig.getAlgorithm()); + assertEquals(clone.getScheme(), orig.getScheme()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOldDigestEmptyString() throws Exception { + testOldDigest(""); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOldDigestNull() throws Exception { + testOldDigest(null); + } + + private void testOldDigest(String qop) throws Exception { + String user = "user"; + String pass = "pass"; + String realm = "realm"; + String nonce = "nonce"; + String method = "GET"; + Uri uri = Uri.create("http://ahc.io/foo"); + Realm orig = digestAuthRealm(user, pass) + .setNonce(nonce) + .setUri(uri) + .setMethodName(method) + .setRealmName(realm) + .setQop(qop) + .build(); + + String ha1 = getMd5(user + ':' + realm + ':' + pass); + String ha2 = getMd5(method + ':' + uri.getPath()); + String expectedResponse = getMd5(ha1 + ':' + nonce + ':' + ha2); + + assertEquals(orig.getResponse(), expectedResponse); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testStrongDigest() throws Exception { + String user = "user"; + String pass = "pass"; + String realm = "realm"; + String nonce = "nonce"; + String method = "GET"; + Uri uri = Uri.create("http://ahc.io/foo"); + String qop = "auth"; + Realm orig = digestAuthRealm(user, pass) + .setNonce(nonce) + .setUri(uri) + .setMethodName(method) + .setRealmName(realm) + .setQop(qop) + .build(); + + String nc = orig.getNc(); + String cnonce = orig.getCnonce(); + String ha1 = getMd5(user + ':' + realm + ':' + pass); + String ha2 = getMd5(method + ':' + uri.getPath()); + String expectedResponse = getMd5(ha1 + ':' + nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2); + + assertEquals(orig.getResponse(), expectedResponse); + } + + private String getMd5(String what) throws Exception { + MessageDigest md = MessageDigest.getInstance("MD5"); + md.update(what.getBytes(StandardCharsets.ISO_8859_1)); + byte[] hash = md.digest(); + return StringUtils.toHexString(hash); + } +} diff --git a/client/src/test/java/org/asynchttpclient/RedirectBodyTest.java b/client/src/test/java/org/asynchttpclient/RedirectBodyTest.java new file mode 100644 index 0000000000..461c7a06a0 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/RedirectBodyTest.java @@ -0,0 +1,124 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.io.IOUtils; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderNames.LOCATION; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; + +public class RedirectBodyTest extends AbstractBasicTest { + + private static volatile boolean redirectAlreadyPerformed; + private static volatile String receivedContentType; + + @BeforeEach + public void setUp() { + redirectAlreadyPerformed = false; + receivedContentType = null; + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException { + + String redirectHeader = httpRequest.getHeader("X-REDIRECT"); + if (redirectHeader != null && !redirectAlreadyPerformed) { + redirectAlreadyPerformed = true; + httpResponse.setStatus(Integer.valueOf(redirectHeader)); + httpResponse.setContentLength(0); + httpResponse.setHeader(LOCATION.toString(), getTargetUrl()); + + } else { + receivedContentType = request.getContentType(); + httpResponse.setStatus(200); + int len = request.getContentLength(); + httpResponse.setContentLength(len); + if (len > 0) { + byte[] buffer = new byte[len]; + IOUtils.read(request.getInputStream(), buffer); + httpResponse.getOutputStream().write(buffer); + } + } + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + }; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void regular301LosesBody() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + String body = "hello there"; + String contentType = "text/plain; charset=UTF-8"; + + Response response = c.preparePost(getTargetUrl()).setHeader(CONTENT_TYPE, contentType).setBody(body).setHeader("X-REDIRECT", "301").execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), ""); + assertNull(receivedContentType); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void regular302LosesBody() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + String body = "hello there"; + String contentType = "text/plain; charset=UTF-8"; + + Response response = c.preparePost(getTargetUrl()).setHeader(CONTENT_TYPE, contentType).setBody(body).setHeader("X-REDIRECT", "302").execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), ""); + assertNull(receivedContentType); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void regular302StrictKeepsBody() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true).setStrict302Handling(true))) { + String body = "hello there"; + String contentType = "text/plain; charset=UTF-8"; + + Response response = c.preparePost(getTargetUrl()).setHeader(CONTENT_TYPE, contentType).setBody(body).setHeader("X-REDIRECT", "302").execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), body); + assertEquals(receivedContentType, contentType); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void regular307KeepsBody() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + String body = "hello there"; + String contentType = "text/plain; charset=UTF-8"; + + Response response = c.preparePost(getTargetUrl()).setHeader(CONTENT_TYPE, contentType).setBody(body).setHeader("X-REDIRECT", "307").execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), body); + assertEquals(receivedContentType, contentType); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/RedirectConnectionUsageTest.java b/client/src/test/java/org/asynchttpclient/RedirectConnectionUsageTest.java new file mode 100644 index 0000000000..01b37b86cd --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/RedirectConnectionUsageTest.java @@ -0,0 +1,126 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServlet; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.servlet.ServletHolder; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.io.OutputStream; +import java.time.Duration; +import java.util.Date; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +/** + * Test for multithreaded url fetcher calls that use two separate sets of ssl certificates. This then tests that the certificate settings do not clash (override each other), + * resulting in the peer not authenticated exception + * + * @author dominict + */ +public class RedirectConnectionUsageTest extends AbstractBasicTest { + + private String baseUrl; + private String servletEndpointRedirectUrl; + + @BeforeEach + public void setUp() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.addServlet(new ServletHolder(new MockRedirectHttpServlet()), "/redirect/*"); + context.addServlet(new ServletHolder(new MockFullResponseHttpServlet()), "/*"); + server.setHandler(context); + + server.start(); + port1 = connector.getLocalPort(); + + baseUrl = "http://localhost/" + ':' + port1; + servletEndpointRedirectUrl = baseUrl + "/redirect"; + } + + /** + * Tests that after a redirect the final url in the response reflect the redirect + */ + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetRedirectFinalUrl() throws Exception { + + AsyncHttpClientConfig config = config() + .setKeepAlive(true) + .setMaxConnectionsPerHost(1) + .setMaxConnections(1) + .setConnectTimeout(Duration.ofSeconds(1)) + .setRequestTimeout(Duration.ofSeconds(1)) + .setFollowRedirect(true) + .build(); + + try (AsyncHttpClient c = asyncHttpClient(config)) { + ListenableFuture response = c.executeRequest(get(servletEndpointRedirectUrl)); + Response res = response.get(); + assertNotNull(res.getResponseBody()); + assertEquals(res.getUri().toString(), baseUrl + "/overthere"); + } + } + + @SuppressWarnings("serial") + static + class MockRedirectHttpServlet extends HttpServlet { + @Override + public void service(HttpServletRequest req, HttpServletResponse res) throws IOException { + res.sendRedirect("/overthere"); + } + } + + @SuppressWarnings("serial") + static + class MockFullResponseHttpServlet extends HttpServlet { + + private static final String contentType = "text/xml"; + private static final String xml = ""; + + @Override + public void service(HttpServletRequest req, HttpServletResponse res) throws IOException { + String xmlToReturn = String.format(xml, new Date()); + + res.setStatus(200); + res.addHeader("Content-Type", contentType); + res.addHeader("X-Method", req.getMethod()); + res.addHeader("MultiValue", "1"); + res.addHeader("MultiValue", "2"); + res.addHeader("MultiValue", "3"); + + OutputStream os = res.getOutputStream(); + + byte[] retVal = xmlToReturn.getBytes(); + res.setContentLength(retVal.length); + os.write(retVal); + os.close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/Relative302Test.java b/client/src/test/java/org/asynchttpclient/Relative302Test.java new file mode 100644 index 0000000000..074930791f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/Relative302Test.java @@ -0,0 +1,176 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.uri.Uri; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.net.ConnectException; +import java.net.URI; +import java.util.Enumeration; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.findFreePort; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class Relative302Test extends AbstractBasicTest { + private static final AtomicBoolean isSet = new AtomicBoolean(false); + + private static int getPort(Uri uri) { + int port = uri.getPort(); + if (port == -1) { + port = "http".equals(uri.getScheme()) ? 80 : 443; + } + return port; + } + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(new Relative302Handler()); + server.start(); + port1 = connector.getLocalPort(); + logger.info("Local HTTP server started successfully"); + port2 = findFreePort(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAllSequentiallyBecauseNotThreadSafe() throws Exception { + redirected302Test(); + redirected302InvalidTest(); + absolutePathRedirectTest(); + relativePathRedirectTest(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void redirected302Test() throws Exception { + isSet.getAndSet(false); + + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", "http://www.google.com/").execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + + String baseUrl = getBaseUrl(response.getUri()); + assertTrue(baseUrl.startsWith("http://www.google./"), "response does not show redirection to a google subdomain, got " + baseUrl); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void redirected302InvalidTest() throws Exception { + isSet.getAndSet(false); + + Exception e = null; + + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + c.prepareGet(getTargetUrl()).setHeader("X-redirect", String.format("http://localhost:%d/", port2)).execute().get(); + } catch (ExecutionException ex) { + e = ex; + } + + assertNotNull(e); + Throwable cause = e.getCause(); + assertInstanceOf(ConnectException.class, cause); + assertTrue(cause.getMessage().contains(":" + port2)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void absolutePathRedirectTest() throws Exception { + isSet.getAndSet(false); + + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + String redirectTarget = "/bar/test"; + String destinationUrl = new URI(getTargetUrl()).resolve(redirectTarget).toString(); + + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", redirectTarget).execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getUri().toString(), destinationUrl); + + logger.debug("{} was redirected to {}", redirectTarget, destinationUrl); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void relativePathRedirectTest() throws Exception { + isSet.getAndSet(false); + + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + String redirectTarget = "bar/test1"; + String destinationUrl = new URI(getTargetUrl()).resolve(redirectTarget).toString(); + + Response response = c.prepareGet(getTargetUrl()).setHeader("X-redirect", redirectTarget).execute().get(); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getUri().toString(), destinationUrl); + + logger.debug("{} was redirected to {}", redirectTarget, destinationUrl); + } + } + + private static String getBaseUrl(Uri uri) { + String url = uri.toString(); + int port = uri.getPort(); + if (port == -1) { + port = getPort(uri); + url = url.substring(0, url.length() - 1) + ':' + port; + } + return url.substring(0, url.lastIndexOf(':') + String.valueOf(port).length() + 1); + } + + private static class Relative302Handler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + String param; + httpResponse.setStatus(200); + httpResponse.setContentType(TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + Enumeration e = httpRequest.getHeaderNames(); + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + + if (param.startsWith("X-redirect") && !isSet.getAndSet(true)) { + httpResponse.addHeader("Location", httpRequest.getHeader(param)); + httpResponse.setStatus(302); + break; + } + } + httpResponse.setContentLength(0); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/RequestBuilderTest.java b/client/src/test/java/org/asynchttpclient/RequestBuilderTest.java new file mode 100644 index 0000000000..34e79121d3 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/RequestBuilderTest.java @@ -0,0 +1,223 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpMethod; +import io.netty.handler.codec.http.cookie.Cookie; +import io.netty.handler.codec.http.cookie.DefaultCookie; + +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.Collections.singletonList; +import static org.asynchttpclient.Dsl.get; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class RequestBuilderTest { + + private static final String SAFE_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890-_*."; + private static final String HEX_CHARS = "0123456789ABCDEF"; + + @RepeatedIfExceptionsTest(repeats = 5) + public void testEncodesQueryParameters() { + String[] values = {"abcdefghijklmnopqrstuvwxyz", "ABCDEFGHIJKQLMNOPQRSTUVWXYZ", "1234567890", "1234567890", "`~!@#$%^&*()", "`~!@#$%^&*()", "_+-=,.<>/?", + "_+-=,.<>/?", ";:'\"[]{}\\| ", ";:'\"[]{}\\| "}; + + /* + * as per RFC-5849 (Oauth), and RFC-3986 (percent encoding) we MUST + * encode everything except for "safe" characters; and nothing but them. + * Safe includes ascii letters (upper and lower case), digits (0 - 9) + * and FOUR special characters: hyphen ('-'), underscore ('_'), tilde + * ('~') and period ('.')). Everything else must be percent-encoded, + * byte-by-byte, using UTF-8 encoding (meaning three-byte Unicode/UTF-8 + * code points are encoded as three three-letter percent-encode + * entities). + */ + for (String value : values) { + RequestBuilder builder = get("http://example.com/").addQueryParam("name", value); + + StringBuilder sb = new StringBuilder(); + for (int i = 0, len = value.length(); i < len; ++i) { + char c = value.charAt(i); + if (SAFE_CHARS.indexOf(c) >= 0) { + sb.append(c); + } else { + int hi = c >> 4; + int lo = c & 0xF; + sb.append('%').append(HEX_CHARS.charAt(hi)).append(HEX_CHARS.charAt(lo)); + } + } + String expValue = sb.toString(); + Request request = builder.build(); + assertEquals(request.getUrl(), "http://example.com/?name=" + expValue); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testChaining() { + Request request = get("http://foo.com/").addQueryParam("x", "value").build(); + Request request2 = request.toBuilder().build(); + + assertEquals(request2.getUri(), request.getUri()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testParsesQueryParams() { + Request request = get("http://foo.com/?param1=value1").addQueryParam("param2", "value2").build(); + + assertEquals(request.getUrl(), "http://foo.com/?param1=value1¶m2=value2"); + List params = request.getQueryParams(); + assertEquals(params.size(), 2); + assertEquals(params.get(0), new Param("param1", "value1")); + assertEquals(params.get(1), new Param("param2", "value2")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUserProvidedRequestMethod() { + Request req = new RequestBuilder("ABC").setUrl("http://foo.com/").build(); + assertEquals(req.getMethod(), "ABC"); + assertEquals(req.getUrl(), "http://foo.com/"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPercentageEncodedUserInfo() { + final Request req = get("http://hello:wor%20ld@foo.com/").build(); + assertEquals(req.getMethod(), "GET"); + assertEquals(req.getUrl(), "http://hello:wor%20ld@foo.com/"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testContentTypeCharsetToBodyEncoding() { + final Request req = get("http://localhost/").setHeader("Content-Type", "application/json; charset=utf-8").build(); + assertEquals(req.getCharset(), UTF_8); + final Request req2 = get("http://localhost/").setHeader("Content-Type", "application/json; charset=\"utf-8\"").build(); + assertEquals(req2.getCharset(), UTF_8); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultMethod() { + RequestBuilder requestBuilder = new RequestBuilder(); + String defaultMethodName = HttpMethod.GET.name(); + assertEquals(requestBuilder.method, defaultMethodName, "Default HTTP method should be " + defaultMethodName); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSetHeaders() { + RequestBuilder requestBuilder = new RequestBuilder(); + assertTrue(requestBuilder.headers.isEmpty(), "Headers should be empty by default."); + + Map> headers = new HashMap<>(); + headers.put("Content-Type", Collections.singleton("application/json")); + requestBuilder.setHeaders(headers); + assertTrue(requestBuilder.headers.contains("Content-Type"), "headers set by setHeaders have not been set"); + assertEquals(requestBuilder.headers.get("Content-Type"), "application/json", "header value incorrect"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAddOrReplaceCookies() { + RequestBuilder requestBuilder = new RequestBuilder(); + Cookie cookie = new DefaultCookie("name", "value"); + cookie.setDomain("google.com"); + cookie.setPath("/"); + cookie.setMaxAge(1000); + cookie.setSecure(true); + cookie.setHttpOnly(true); + requestBuilder.addOrReplaceCookie(cookie); + assertEquals(requestBuilder.cookies.size(), 1, "cookies size should be 1 after adding one cookie"); + assertEquals(requestBuilder.cookies.get(0), cookie, "cookie does not match"); + + Cookie cookie2 = new DefaultCookie("name", "value"); + cookie2.setDomain("google2.com"); + cookie2.setPath("/path"); + cookie2.setMaxAge(1001); + cookie2.setSecure(false); + cookie2.setHttpOnly(false); + + requestBuilder.addOrReplaceCookie(cookie2); + assertEquals(requestBuilder.cookies.size(), 1, "cookies size should remain 1 as we just replaced a cookie with same name"); + assertEquals(requestBuilder.cookies.get(0), cookie2, "cookie does not match"); + + Cookie cookie3 = new DefaultCookie("name2", "value"); + cookie3.setDomain("google.com"); + cookie3.setPath("/"); + cookie3.setMaxAge(1000); + cookie3.setSecure(true); + cookie3.setHttpOnly(true); + requestBuilder.addOrReplaceCookie(cookie3); + assertEquals(requestBuilder.cookies.size(), 2, "cookie size must be 2 after adding 1 more cookie i.e. cookie3"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAddIfUnsetCookies() { + RequestBuilder requestBuilder = new RequestBuilder(); + Cookie cookie = new DefaultCookie("name", "value"); + cookie.setDomain("google.com"); + cookie.setPath("/"); + cookie.setMaxAge(1000); + cookie.setSecure(true); + cookie.setHttpOnly(true); + requestBuilder.addCookieIfUnset(cookie); + assertEquals(requestBuilder.cookies.size(), 1, "cookies size should be 1 after adding one cookie"); + assertEquals(requestBuilder.cookies.get(0), cookie, "cookie does not match"); + + Cookie cookie2 = new DefaultCookie("name", "value"); + cookie2.setDomain("google2.com"); + cookie2.setPath("/path"); + cookie2.setMaxAge(1001); + cookie2.setSecure(false); + cookie2.setHttpOnly(false); + + requestBuilder.addCookieIfUnset(cookie2); + assertEquals(requestBuilder.cookies.size(), 1, "cookies size should remain 1 as we just ignored cookie2 because of a cookie with same name"); + assertEquals(requestBuilder.cookies.get(0), cookie, "cookie does not match"); + + Cookie cookie3 = new DefaultCookie("name2", "value"); + cookie3.setDomain("google.com"); + cookie3.setPath("/"); + cookie3.setMaxAge(1000); + cookie3.setSecure(true); + cookie3.setHttpOnly(true); + requestBuilder.addCookieIfUnset(cookie3); + assertEquals(requestBuilder.cookies.size(), 2, "cookie size must be 2 after adding 1 more cookie i.e. cookie3"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSettingQueryParamsBeforeUrlShouldNotProduceNPE() { + RequestBuilder requestBuilder = new RequestBuilder(); + requestBuilder.setQueryParams(singletonList(new Param("key", "value"))); + requestBuilder.setUrl("http://localhost/"); + Request request = requestBuilder.build(); + assertEquals(request.getUrl(), "http://localhost/?key=value"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSettingHeadersUsingMapWithStringKeys() { + Map> headers = new HashMap<>(); + headers.put("X-Forwarded-For", singletonList("10.0.0.1")); + + RequestBuilder requestBuilder = new RequestBuilder(); + requestBuilder.setHeaders(headers); + requestBuilder.setUrl("http://localhost/"); + Request request = requestBuilder.build(); + assertEquals(request.getHeaders().get("X-Forwarded-For"), "10.0.0.1"); + } +} diff --git a/src/test/java/com/ning/http/client/async/RetryRequestTest.java b/client/src/test/java/org/asynchttpclient/RetryRequestTest.java similarity index 65% rename from src/test/java/com/ning/http/client/async/RetryRequestTest.java rename to client/src/test/java/org/asynchttpclient/RetryRequestTest.java index 3cd92523ba..07e9f2ca86 100644 --- a/src/test/java/com/ning/http/client/async/RetryRequestTest.java +++ b/client/src/test/java/org/asynchttpclient/RetryRequestTest.java @@ -10,28 +10,50 @@ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. */ -package com.ning.http.client.async; +package org.asynchttpclient; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.exception.RemotelyClosedException; import org.eclipse.jetty.server.Request; import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.io.OutputStream; -import static org.testng.Assert.*; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.fail; + +public class RetryRequestTest extends AbstractBasicTest { + + @Override + protected String getTargetUrl() { + return String.format("http://localhost:%d/", port1); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SlowAndBigHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxRetry() { + try (AsyncHttpClient ahc = asyncHttpClient(config().setMaxRequestRetry(0))) { + ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build()).get(); + fail(); + } catch (Exception t) { + assertEquals(t.getCause(), RemotelyClosedException.INSTANCE); + } + } -public abstract class RetryRequestTest extends AbstractBasicTest { public static class SlowAndBigHandler extends AbstractHandler { - public void handle(String pathInContext, Request request, - HttpServletRequest httpRequest, HttpServletResponse httpResponse) - throws IOException, ServletException { + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { int load = 100; httpResponse.setStatus(200); @@ -40,7 +62,6 @@ public void handle(String pathInContext, Request request, httpResponse.flushBuffer(); - OutputStream os = httpResponse.getOutputStream(); for (int i = 0; i < load; i++) { os.write(i % 255); @@ -51,7 +72,6 @@ public void handle(String pathInContext, Request request, // nuku } - if (i > load / 10) { httpResponse.sendError(500); } @@ -61,31 +81,4 @@ public void handle(String pathInContext, Request request, httpResponse.getOutputStream().close(); } } - - protected String getTargetUrl() { - return String.format("http://127.0.0.1:%d/", port1); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new SlowAndBigHandler(); - } - - - @Test(groups = {"standalone", "default_provider"}) - public void testMaxRetry() throws Throwable { - AsyncHttpClient ahc = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setMaxRequestRetry(0).build()); - try { - ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build()).get(); - fail(); - } catch (Exception t) { - assertNotNull(t.getCause()); - assertEquals(t.getCause().getClass(), IOException.class); - if (!t.getCause().getMessage().startsWith("Remotely Closed")) { - fail(); - } - } - - ahc.close(); - } } diff --git a/client/src/test/java/org/asynchttpclient/StripAuthorizationOnRedirectHttpTest.java b/client/src/test/java/org/asynchttpclient/StripAuthorizationOnRedirectHttpTest.java new file mode 100644 index 0000000000..08c150c08a --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/StripAuthorizationOnRedirectHttpTest.java @@ -0,0 +1,95 @@ +package org.asynchttpclient; + +import com.sun.net.httpserver.HttpExchange; +import com.sun.net.httpserver.HttpHandler; +import com.sun.net.httpserver.HttpServer; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; + +import java.net.InetSocketAddress; +import java.util.concurrent.TimeUnit; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; + +public class StripAuthorizationOnRedirectHttpTest { + private static HttpServer server; + private static int port; + private static volatile String lastAuthHeader; + + @BeforeAll + public static void startServer() throws Exception { + server = HttpServer.create(new InetSocketAddress(0), 0); + port = server.getAddress().getPort(); + server.createContext("/redirect", new RedirectHandler()); + server.createContext("/final", new FinalHandler()); + server.start(); + } + + @AfterAll + public static void stopServer() { + server.stop(0); + } + + static class RedirectHandler implements HttpHandler { + @Override + public void handle(HttpExchange exchange) { + String auth = exchange.getRequestHeaders().getFirst("Authorization"); + lastAuthHeader = auth; + exchange.getResponseHeaders().add("Location", "http://localhost/" + port + "/final"); + try { + exchange.sendResponseHeaders(302, -1); + } catch (Exception ignored) { + } + exchange.close(); + } + } + + static class FinalHandler implements HttpHandler { + @Override + public void handle(HttpExchange exchange) { + String auth = exchange.getRequestHeaders().getFirst("Authorization"); + lastAuthHeader = auth; + try { + exchange.sendResponseHeaders(200, 0); + exchange.getResponseBody().close(); + } catch (Exception ignored) { + } + exchange.close(); + } + } + + @Test + void testAuthHeaderPropagatedByDefault() throws Exception { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setFollowRedirect(true) + .build(); + try (DefaultAsyncHttpClient client = new DefaultAsyncHttpClient(config)) { + lastAuthHeader = null; + client.prepareGet("http://localhost/" + port + "/redirect") + .setHeader("Authorization", "Bearer testtoken") + .execute() + .get(5, TimeUnit.SECONDS); + // By default, Authorization header is propagated to /final + assertEquals("Bearer testtoken", lastAuthHeader, "Authorization header should be present on redirect by default"); + } + } + + @Test + void testAuthHeaderStrippedWhenEnabled() throws Exception { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setFollowRedirect(true) + .setStripAuthorizationOnRedirect(true) + .build(); + try (DefaultAsyncHttpClient client = new DefaultAsyncHttpClient(config)) { + lastAuthHeader = null; + client.prepareGet("http://localhost/" + port + "/redirect") + .setHeader("Authorization", "Bearer testtoken") + .execute() + .get(5, TimeUnit.SECONDS); + // When enabled, Authorization header should be stripped on /final + assertNull(lastAuthHeader, "Authorization header should be stripped on redirect when enabled"); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ThreadNameTest.java b/client/src/test/java/org/asynchttpclient/ThreadNameTest.java new file mode 100644 index 0000000000..a6a151aa99 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ThreadNameTest.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.util.Arrays; +import java.util.Random; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Tests configured client name is used for thread names. + * + * @author Stepan Koltsov + */ +public class ThreadNameTest extends AbstractBasicTest { + + private static Thread[] getThreads() { + int count = Thread.activeCount() + 1; + for (; ; ) { + Thread[] threads = new Thread[count]; + int filled = Thread.enumerate(threads); + if (filled < threads.length) { + return Arrays.copyOf(threads, filled); + } + + count *= 2; + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testThreadName() throws Exception { + String threadPoolName = "ahc-" + (new Random().nextLong() & 0x7fffffffffffffffL); + try (AsyncHttpClient client = asyncHttpClient(config().setThreadPoolName(threadPoolName))) { + Future f = client.prepareGet("http://localhost/" + port1 + '/').execute(); + f.get(3, TimeUnit.SECONDS); + + // We cannot assert that all threads are created with specified name, + // so we checking that at least one thread is. + boolean found = false; + for (Thread thread : getThreads()) { + if (thread.getName().startsWith(threadPoolName)) { + found = true; + break; + } + } + + assertTrue(found, "must found threads starting with random string " + threadPoolName); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/channel/ConnectionPoolTest.java b/client/src/test/java/org/asynchttpclient/channel/ConnectionPoolTest.java new file mode 100644 index 0000000000..878a047d14 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/channel/ConnectionPoolTest.java @@ -0,0 +1,267 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.channel; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandler; +import org.asynchttpclient.AsyncCompletionHandlerBase; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.asynchttpclient.test.EventCollectingHandler; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.junit.jupiter.api.function.ThrowingSupplier; + +import java.time.Duration; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.test.EventCollectingHandler.COMPLETED_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.CONNECTION_OFFER_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.CONNECTION_POOLED_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.CONNECTION_POOL_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.HEADERS_RECEIVED_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.HEADERS_WRITTEN_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.REQUEST_SEND_EVENT; +import static org.asynchttpclient.test.EventCollectingHandler.STATUS_RECEIVED_EVENT; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.fail; + +public class ConnectionPoolTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxTotalConnections() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setMaxConnections(1))) { + String url = getTargetUrl(); + + for (int i = 0; i < 3; i++) { + logger.info("{} requesting url [{}]...", i, url); + + Response response = assertDoesNotThrow(new ThrowingSupplier() { + @Override + public Response get() throws Throwable { + return client.prepareGet(url).execute().get(); + } + }); + + assertNotNull(response); + logger.info("{} response [{}].", i, response); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxTotalConnectionsException() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setMaxConnections(1))) { + String url = getTargetUrl(); + + List> futures = new ArrayList<>(); + for (int i = 0; i < 5; i++) { + logger.info("{} requesting url [{}]...", i, url); + futures.add(client.prepareGet(url).execute()); + } + + Exception exception = null; + for (ListenableFuture future : futures) { + try { + future.get(); + } catch (Exception ex) { + exception = ex; + break; + } + } + + assertNotNull(exception); + assertInstanceOf(ExecutionException.class, exception); + } + } + + @RepeatedIfExceptionsTest(repeats = 3) + public void asyncDoGetKeepAliveHandlerTest_channelClosedDoesNotFail() throws Exception { + for (int i = 0; i < 10; i++) { + try (AsyncHttpClient client = asyncHttpClient()) { + final CountDownLatch l = new CountDownLatch(2); + final Map remoteAddresses = new ConcurrentHashMap<>(); + + AsyncCompletionHandler handler = new AsyncCompletionHandlerAdapter() { + + @Override + public Response onCompleted(Response response) { + logger.debug("ON COMPLETED INVOKED " + response.getHeader("X-KEEP-ALIVE")); + try { + assertEquals(200, response.getStatusCode()); + remoteAddresses.put(response.getHeader("X-KEEP-ALIVE"), true); + } finally { + l.countDown(); + } + return response; + } + + @Override + public void onThrowable(Throwable t) { + try { + super.onThrowable(t); + } finally { + l.countDown(); + } + } + }; + + client.prepareGet(getTargetUrl()).execute(handler).get(); + server.stop(); + + // Jetty 9.4.8 doesn't properly stop and restart (recreates ReservedThreadExecutors on start but still point to old offers threads to old ones) + // instead of restarting, we create a fresh new one and have it bind on the same port + server = new Server(); + ServerConnector newConnector = addHttpConnector(server); + // make sure connector will restart with the port as it's originally dynamically allocated + newConnector.setPort(port1); + server.setHandler(configureHandler()); + server.start(); + + client.prepareGet(getTargetUrl()).execute(handler); + + if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { + fail("Timed out"); + } + + assertEquals(remoteAddresses.size(), 2); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void multipleMaxConnectionOpenTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(Duration.ofSeconds(5)).setMaxConnections(1))) { + String body = "hello there"; + + // once + Response response = client.preparePost(getTargetUrl()).setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), body); + + // twice + assertThrows(ExecutionException.class, () -> client.preparePost(String.format("http://localhost:%d/foo/test", port2)) + .setBody(body) + .execute() + .get(TIMEOUT, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void multipleMaxConnectionOpenTestWithQuery() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(Duration.ofSeconds(5)).setMaxConnections(1))) { + String body = "hello there"; + + // once + Response response = c.preparePost(getTargetUrl() + "?foo=bar").setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); + assertEquals(response.getResponseBody(), "foo_" + body); + + // twice + response = c.preparePost(getTargetUrl()).setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); + assertNotNull(response); + assertEquals(response.getStatusCode(), 200); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncHandlerOnThrowableTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final AtomicInteger count = new AtomicInteger(); + final String THIS_IS_NOT_FOR_YOU = "This is not for you"; + final CountDownLatch latch = new CountDownLatch(16); + for (int i = 0; i < 16; i++) { + client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerBase() { + @Override + public Response onCompleted(Response response) throws Exception { + throw new Exception(THIS_IS_NOT_FOR_YOU); + } + }); + + client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerBase() { + @Override + public void onThrowable(Throwable t) { + if (t.getMessage() != null && t.getMessage().equalsIgnoreCase(THIS_IS_NOT_FOR_YOU)) { + count.incrementAndGet(); + } + } + + @Override + public Response onCompleted(Response response) { + latch.countDown(); + return response; + } + }); + } + latch.await(TIMEOUT, TimeUnit.SECONDS); + assertEquals(count.get(), 0); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void nonPoolableConnectionReleaseSemaphoresTest() throws Throwable { + + RequestBuilder request = get(getTargetUrl()).setHeader("Connection", "close"); + + try (AsyncHttpClient client = asyncHttpClient(config().setMaxConnections(6).setMaxConnectionsPerHost(3))) { + client.executeRequest(request).get(); + Thread.sleep(1000); + client.executeRequest(request).get(); + Thread.sleep(1000); + client.executeRequest(request).get(); + Thread.sleep(1000); + client.executeRequest(request).get(); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPooledEventsFired() throws Exception { + RequestBuilder request = get("http://localhost/" + port1 + "/Test"); + + try (AsyncHttpClient client = asyncHttpClient()) { + EventCollectingHandler firstHandler = new EventCollectingHandler(); + client.executeRequest(request, firstHandler).get(3, TimeUnit.SECONDS); + firstHandler.waitForCompletion(3, TimeUnit.SECONDS); + + EventCollectingHandler secondHandler = new EventCollectingHandler(); + client.executeRequest(request, secondHandler).get(3, TimeUnit.SECONDS); + secondHandler.waitForCompletion(3, TimeUnit.SECONDS); + + Object[] expectedEvents = {CONNECTION_POOL_EVENT, CONNECTION_POOLED_EVENT, REQUEST_SEND_EVENT, HEADERS_WRITTEN_EVENT, STATUS_RECEIVED_EVENT, + HEADERS_RECEIVED_EVENT, CONNECTION_OFFER_EVENT, COMPLETED_EVENT}; + + assertArrayEquals(secondHandler.firedEvents.toArray(), expectedEvents, "Got " + Arrays.toString(secondHandler.firedEvents.toArray())); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/channel/MaxConnectionsInThreadsTest.java b/client/src/test/java/org/asynchttpclient/channel/MaxConnectionsInThreadsTest.java new file mode 100644 index 0000000000..d82aa08c41 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/channel/MaxConnectionsInThreadsTest.java @@ -0,0 +1,181 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + */ +package org.asynchttpclient.channel; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServlet; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandlerBase; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.servlet.ServletHolder; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.TestInstance; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.io.OutputStream; +import java.time.Duration; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +public class MaxConnectionsInThreadsTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.setContextPath("/"); + server.setHandler(context); + context.addServlet(new ServletHolder(new MockTimeoutHttpServlet()), "/timeout/*"); + + server.start(); + port1 = connector.getLocalPort(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxConnectionsWithinThreads() throws Exception { + + String[] urls = {getTargetUrl(), getTargetUrl()}; + + AsyncHttpClientConfig config = config() + .setConnectTimeout(Duration.ofSeconds(1)) + .setRequestTimeout(Duration.ofSeconds(5)) + .setKeepAlive(true) + .setMaxConnections(1) + .setMaxConnectionsPerHost(1) + .build(); + + final CountDownLatch inThreadsLatch = new CountDownLatch(2); + final AtomicInteger failedCount = new AtomicInteger(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + for (final String url : urls) { + Thread t = new Thread() { + + @Override + public void run() { + client.prepareGet(url).execute(new AsyncCompletionHandlerBase() { + @Override + public Response onCompleted(Response response) throws Exception { + Response r = super.onCompleted(response); + inThreadsLatch.countDown(); + return r; + } + + @Override + public void onThrowable(Throwable t) { + super.onThrowable(t); + failedCount.incrementAndGet(); + inThreadsLatch.countDown(); + } + }); + } + }; + t.start(); + } + + inThreadsLatch.await(); + assertEquals(failedCount.get(), 1, "Max Connections should have been reached when launching from concurrent threads"); + + final CountDownLatch notInThreadsLatch = new CountDownLatch(2); + failedCount.set(0); + + for (final String url : urls) { + client.prepareGet(url).execute(new AsyncCompletionHandlerBase() { + @Override + public Response onCompleted(Response response) throws Exception { + Response r = super.onCompleted(response); + notInThreadsLatch.countDown(); + return r; + } + + @Override + public void onThrowable(Throwable t) { + super.onThrowable(t); + failedCount.incrementAndGet(); + notInThreadsLatch.countDown(); + } + }); + } + + notInThreadsLatch.await(); + assertEquals(failedCount.get(), 1, "Max Connections should have been reached when launching from main thread"); + } + } + + @Override + public String getTargetUrl() { + return "http://localhost/" + port1 + "/timeout/"; + } + + @SuppressWarnings("serial") + public static class MockTimeoutHttpServlet extends HttpServlet { + private static final Logger LOGGER = LoggerFactory.getLogger(MockTimeoutHttpServlet.class); + private static final String contentType = "text/plain"; + private static final long DEFAULT_TIMEOUT = 2000; + + @Override + public void service(HttpServletRequest req, HttpServletResponse res) throws IOException { + res.setStatus(200); + res.addHeader("Content-Type", contentType); + + long sleepTime; + try { + sleepTime = Integer.parseInt(req.getParameter("timeout")); + } catch (NumberFormatException e) { + sleepTime = DEFAULT_TIMEOUT; + } + + try { + LOGGER.debug("======================================="); + LOGGER.debug("Servlet is sleeping for: " + sleepTime); + LOGGER.debug("======================================="); + Thread.sleep(sleepTime); + LOGGER.debug("======================================="); + LOGGER.debug("Servlet is awake for"); + LOGGER.debug("======================================="); + } catch (Exception e) { + // + } + + res.setHeader("XXX", "TripleX"); + + byte[] retVal = "1".getBytes(); + OutputStream os = res.getOutputStream(); + + res.setContentLength(retVal.length); + os.write(retVal); + os.close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/channel/MaxTotalConnectionTest.java b/client/src/test/java/org/asynchttpclient/channel/MaxTotalConnectionTest.java new file mode 100644 index 0000000000..6094f5bdb9 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/channel/MaxTotalConnectionTest.java @@ -0,0 +1,119 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.channel; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandlerBase; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.Response; + +import java.io.IOException; +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class MaxTotalConnectionTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxTotalConnectionsExceedingException() throws IOException { + String[] urls = {"https://google.com/", "https://github.com/"}; + + AsyncHttpClientConfig config = config() + .setConnectTimeout(Duration.ofSeconds(1)) + .setRequestTimeout(Duration.ofSeconds(5)) + .setKeepAlive(false) + .setMaxConnections(1) + .setMaxConnectionsPerHost(1) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + List> futures = new ArrayList<>(); + for (String url : urls) { + futures.add(client.prepareGet(url).execute()); + } + + boolean caughtError = false; + int i; + for (i = 0; i < urls.length; i++) { + try { + futures.get(i).get(); + } catch (Exception e) { + // assert that 2nd request fails, because + // maxTotalConnections=1 + caughtError = true; + break; + } + } + + assertEquals(1, i); + assertTrue(caughtError); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMaxTotalConnections() throws Exception { + String[] urls = {"https://www.google.com/", "https://www.youtube.com/"}; + + final CountDownLatch latch = new CountDownLatch(2); + final AtomicReference ex = new AtomicReference<>(); + final AtomicReference failedUrl = new AtomicReference<>(); + + AsyncHttpClientConfig config = config() + .setConnectTimeout(Duration.ofSeconds(1)) + .setRequestTimeout(Duration.ofSeconds(5)) + .setKeepAlive(false) + .setMaxConnections(2) + .setMaxConnectionsPerHost(1) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + for (String url : urls) { + final String thisUrl = url; + client.prepareGet(url).execute(new AsyncCompletionHandlerBase() { + @Override + public Response onCompleted(Response response) throws Exception { + Response r = super.onCompleted(response); + latch.countDown(); + return r; + } + + @Override + public void onThrowable(Throwable t) { + super.onThrowable(t); + ex.set(t); + failedUrl.set(thisUrl); + latch.countDown(); + } + }); + } + + latch.await(); + assertNull(ex.get()); + assertNull(failedUrl.get()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/filter/FilterTest.java b/client/src/test/java/org/asynchttpclient/filter/FilterTest.java new file mode 100644 index 0000000000..fba6c4ec01 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/filter/FilterTest.java @@ -0,0 +1,183 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.filter; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Enumeration; +import java.util.List; +import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class FilterTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new BasicHandler(); + } + + @Override + public String getTargetUrl() { + return String.format("http://localhost:%d/foo/test", port1); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().addRequestFilter(new ThrottleRequestFilter(100)))) { + Response response = c.preparePost(getTargetUrl()).execute().get(); + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void loadThrottleTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().addRequestFilter(new ThrottleRequestFilter(10)))) { + List> futures = new ArrayList<>(); + for (int i = 0; i < 200; i++) { + futures.add(c.preparePost(getTargetUrl()).execute()); + } + + for (Future future : futures) { + Response r = future.get(); + assertNotNull(r); + assertEquals(200, r.getStatusCode()); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void maxConnectionsText() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().addRequestFilter(new ThrottleRequestFilter(0, 1000)))) { + assertThrows(Exception.class, () -> client.preparePost(getTargetUrl()).execute().get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicResponseFilterTest() throws Exception { + + ResponseFilter responseFilter = new ResponseFilter() { + @Override + public FilterContext filter(FilterContext ctx) { + return ctx; + } + }; + + try (AsyncHttpClient client = asyncHttpClient(config().addResponseFilter(responseFilter))) { + Response response = client.preparePost(getTargetUrl()).execute().get(); + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void replayResponseFilterTest() throws Exception { + final AtomicBoolean replay = new AtomicBoolean(true); + ResponseFilter responseFilter = new ResponseFilter() { + + @Override + public FilterContext filter(FilterContext ctx) { + if (replay.getAndSet(false)) { + org.asynchttpclient.Request request = ctx.getRequest().toBuilder().addHeader("X-Replay", "true").build(); + return new FilterContext.FilterContextBuilder(ctx.getAsyncHandler(), request).replayRequest(true).build(); + } + return ctx; + } + }; + + try (AsyncHttpClient client = asyncHttpClient(config().addResponseFilter(responseFilter))) { + Response response = client.preparePost(getTargetUrl()).execute().get(); + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertEquals("true", response.getHeader("X-Replay")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void replayStatusCodeResponseFilterTest() throws Exception { + final AtomicBoolean replay = new AtomicBoolean(true); + ResponseFilter responseFilter = new ResponseFilter() { + + @Override + public FilterContext filter(FilterContext ctx) { + if (ctx.getResponseStatus() != null && ctx.getResponseStatus().getStatusCode() == 200 && replay.getAndSet(false)) { + org.asynchttpclient.Request request = ctx.getRequest().toBuilder().addHeader("X-Replay", "true").build(); + return new FilterContext.FilterContextBuilder(ctx.getAsyncHandler(), request).replayRequest(true).build(); + } + return ctx; + } + }; + + try (AsyncHttpClient client = asyncHttpClient(config().addResponseFilter(responseFilter))) { + Response response = client.preparePost(getTargetUrl()).execute().get(); + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertEquals("true", response.getHeader("X-Replay")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void replayHeaderResponseFilterTest() throws Exception { + final AtomicBoolean replay = new AtomicBoolean(true); + ResponseFilter responseFilter = new ResponseFilter() { + @Override + public FilterContext filter(FilterContext ctx) { + if (ctx.getResponseHeaders() != null && "Pong".equals(ctx.getResponseHeaders().get("Ping")) && replay.getAndSet(false)) { + org.asynchttpclient.Request request = ctx.getRequest().toBuilder().addHeader("Ping", "Pong").build(); + return new FilterContext.FilterContextBuilder(ctx.getAsyncHandler(), request).replayRequest(true).build(); + } + return ctx; + } + }; + + try (AsyncHttpClient client = asyncHttpClient(config().addResponseFilter(responseFilter))) { + Response response = client.preparePost(getTargetUrl()).addHeader("Ping", "Pong").execute().get(); + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertEquals("Pong", response.getHeader("Ping")); + } + } + + private static class BasicHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + Enumeration e = httpRequest.getHeaderNames(); + String param; + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + httpResponse.addHeader(param, httpRequest.getHeader(param)); + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/handler/BodyDeferringAsyncHandlerTest.java b/client/src/test/java/org/asynchttpclient/handler/BodyDeferringAsyncHandlerTest.java new file mode 100644 index 0000000000..1705dcc636 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/handler/BodyDeferringAsyncHandlerTest.java @@ -0,0 +1,300 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.handler; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.io.IOUtils; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.BoundRequestBuilder; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.Response; +import org.asynchttpclient.exception.RemotelyClosedException; +import org.asynchttpclient.handler.BodyDeferringAsyncHandler.BodyDeferringInputStream; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.io.OutputStream; +import java.io.PipedInputStream; +import java.io.PipedOutputStream; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderValues.APPLICATION_OCTET_STREAM; +import static org.apache.commons.io.IOUtils.copy; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.findFreePort; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class BodyDeferringAsyncHandlerTest extends AbstractBasicTest { + + static final int CONTENT_LENGTH_VALUE = 100000; + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SlowAndBigHandler(); + } + + private static AsyncHttpClientConfig getAsyncHttpClientConfig() { + // for this test brevity's sake, we are limiting to 1 retries + return config().setMaxRequestRetry(0).setRequestTimeout(Duration.ofSeconds(10)).build(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void deferredSimple() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()); + + CountingOutputStream cos = new CountingOutputStream(); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); + Future f = r.execute(bdah); + Response resp = bdah.getResponse(); + assertNotNull(resp); + assertEquals(HttpServletResponse.SC_OK, resp.getStatusCode()); + assertEquals(String.valueOf(CONTENT_LENGTH_VALUE), resp.getHeader(CONTENT_LENGTH)); + + // we got headers only, it's probably not all yet here (we have BIG file + // downloading) + assertTrue(cos.getByteCount() <= CONTENT_LENGTH_VALUE); + + // now be polite and wait for body arrival too (otherwise we would be + // dropping the "line" on server) + assertDoesNotThrow(() -> f.get()); + + // it all should be here now + assertEquals(cos.getByteCount(), CONTENT_LENGTH_VALUE); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void deferredSimpleWithFailure() throws Throwable { + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + BoundRequestBuilder requestBuilder = client.prepareGet(getTargetUrl()).addHeader("X-FAIL-TRANSFER", Boolean.TRUE.toString()); + + CountingOutputStream cos = new CountingOutputStream(); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); + Future f = requestBuilder.execute(bdah); + Response resp = bdah.getResponse(); + assertNotNull(resp); + assertEquals(HttpServletResponse.SC_OK, resp.getStatusCode()); + assertEquals(String.valueOf(CONTENT_LENGTH_VALUE), resp.getHeader(CONTENT_LENGTH)); + // we got headers only, it's probably not all yet here (we have BIG file + // downloading) + assertTrue(cos.getByteCount() <= CONTENT_LENGTH_VALUE); + + // now be polite and wait for body arrival too (otherwise we would be + // dropping the "line" on server) + try { + assertThrows(ExecutionException.class, () -> f.get()); + } catch (Exception ex) { + assertInstanceOf(RemotelyClosedException.class, ex.getCause()); + } + assertNotEquals(CONTENT_LENGTH_VALUE, cos.getByteCount()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void deferredInputStreamTrick() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()); + + PipedOutputStream pos = new PipedOutputStream(); + PipedInputStream pis = new PipedInputStream(pos); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pos); + + Future f = r.execute(bdah); + + BodyDeferringInputStream is = new BodyDeferringInputStream(f, bdah, pis); + + Response resp = is.getAsapResponse(); + assertNotNull(resp); + assertEquals(HttpServletResponse.SC_OK, resp.getStatusCode()); + assertEquals(String.valueOf(CONTENT_LENGTH_VALUE), resp.getHeader(CONTENT_LENGTH)); + // "consume" the body, but our code needs input stream + CountingOutputStream cos = new CountingOutputStream(); + try { + copy(is, cos); + } finally { + is.close(); + cos.close(); + } + + // now we don't need to be polite, since consuming and closing + // BodyDeferringInputStream does all. + // it all should be here now + assertEquals(CONTENT_LENGTH_VALUE, cos.getByteCount()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void deferredInputStreamTrickWithFailure() throws Throwable { + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()).addHeader("X-FAIL-TRANSFER", Boolean.TRUE.toString()); + PipedOutputStream pos = new PipedOutputStream(); + PipedInputStream pis = new PipedInputStream(pos); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pos); + + Future f = r.execute(bdah); + + BodyDeferringInputStream is = new BodyDeferringInputStream(f, bdah, pis); + + Response resp = is.getAsapResponse(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader(CONTENT_LENGTH), String.valueOf(CONTENT_LENGTH_VALUE)); + // "consume" the body, but our code needs input stream + CountingOutputStream cos = new CountingOutputStream(); + + try (is; cos) { + copy(is, cos); + } catch (Exception ex) { + assertInstanceOf(RemotelyClosedException.class, ex.getCause()); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void deferredInputStreamTrickWithCloseConnectionAndRetry() throws Throwable { + try (AsyncHttpClient client = asyncHttpClient(config().setMaxRequestRetry(1).setRequestTimeout(Duration.ofSeconds(10)).build())) { + BoundRequestBuilder r = client.prepareGet(getTargetUrl()).addHeader("X-CLOSE-CONNECTION", Boolean.TRUE.toString()); + PipedOutputStream pos = new PipedOutputStream(); + PipedInputStream pis = new PipedInputStream(pos); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pos); + + Future f = r.execute(bdah); + + BodyDeferringInputStream is = new BodyDeferringInputStream(f, bdah, pis); + + Response resp = is.getAsapResponse(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader(CONTENT_LENGTH), String.valueOf(CONTENT_LENGTH_VALUE)); + // "consume" the body, but our code needs input stream + CountingOutputStream cos = new CountingOutputStream(); + + try (is; cos) { + copy(is, cos); + } catch (Exception ex) { + assertInstanceOf(UnsupportedOperationException.class, ex.getCause()); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testConnectionRefused() throws Exception { + int newPortWithoutAnyoneListening = findFreePort(); + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + BoundRequestBuilder r = client.prepareGet("http://localhost/" + newPortWithoutAnyoneListening + "/testConnectionRefused"); + + CountingOutputStream cos = new CountingOutputStream(); + BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); + r.execute(bdah); + assertThrows(IOException.class, () -> bdah.getResponse()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPipedStreams() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(getAsyncHttpClientConfig())) { + PipedOutputStream pout = new PipedOutputStream(); + try (PipedInputStream pin = new PipedInputStream(pout)) { + BodyDeferringAsyncHandler handler = new BodyDeferringAsyncHandler(pout); + ListenableFuture respFut = client.prepareGet(getTargetUrl()).execute(handler); + + Response resp = handler.getResponse(); + assertEquals(200, resp.getStatusCode()); + + try (BodyDeferringInputStream is = new BodyDeferringInputStream(respFut, handler, pin)) { + String body = IOUtils.toString(is, StandardCharsets.UTF_8); + System.out.println("Body: " + body); + assertTrue(body.contains("ABCDEF")); + } + } + } + } + + public static class SlowAndBigHandler extends AbstractHandler { + + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + httpResponse.setStatus(200); + httpResponse.setContentLength(CONTENT_LENGTH_VALUE); + httpResponse.setContentType(APPLICATION_OCTET_STREAM.toString()); + + httpResponse.flushBuffer(); + + final boolean wantConnectionClose = httpRequest.getHeader("X-CLOSE-CONNECTION") != null; + final boolean wantFailure = httpRequest.getHeader("X-FAIL-TRANSFER") != null; + final boolean wantSlow = httpRequest.getHeader("X-SLOW") != null; + + OutputStream os = httpResponse.getOutputStream(); + for (int i = 0; i < CONTENT_LENGTH_VALUE; i++) { + os.write(i % 255); + + if (wantSlow) { + try { + Thread.sleep(300); + } catch (InterruptedException ex) { + // nuku + } + } + + if (i > CONTENT_LENGTH_VALUE / 2) { + if (wantFailure) { + // kaboom + // yes, response is committed, but Jetty does aborts and + // drops connection + httpResponse.sendError(500); + break; + } else if (wantConnectionClose) { + // kaboom^2 + httpResponse.getOutputStream().close(); + } + } + } + + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } + + // a /dev/null but counting how many bytes it ditched + public static class CountingOutputStream extends OutputStream { + private int byteCount; + + @Override + public void write(int b) { + // /dev/null + byteCount++; + } + + int getByteCount() { + return byteCount; + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/handler/resumable/MapResumableProcessor.java b/client/src/test/java/org/asynchttpclient/handler/resumable/MapResumableProcessor.java new file mode 100644 index 0000000000..e82fa1ef87 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/handler/resumable/MapResumableProcessor.java @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.handler.resumable; + +import org.asynchttpclient.handler.resumable.ResumableAsyncHandler.ResumableProcessor; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +/** + * @author Benjamin Hanzelmann + */ +public class MapResumableProcessor implements ResumableProcessor { + + private final Map map = new HashMap<>(); + + @Override + public void put(String key, long transferredBytes) { + map.put(key, transferredBytes); + } + + @Override + public void remove(String key) { + map.remove(key); + } + + /** + * NOOP + */ + @Override + public void save(Map map) { + + } + + /** + * NOOP + */ + @Override + public Map load() { + return Collections.unmodifiableMap(map); + } +} diff --git a/client/src/test/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessorTest.java b/client/src/test/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessorTest.java new file mode 100644 index 0000000000..d8c1bd4f29 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/handler/resumable/PropertiesBasedResumableProcessorTest.java @@ -0,0 +1,53 @@ +/* + * Copyright (c) 2010 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.handler.resumable; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * @author Benjamin Hanzelmann + */ +public class PropertiesBasedResumableProcessorTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSaveLoad() { + PropertiesBasedResumableProcessor processor = new PropertiesBasedResumableProcessor(); + processor.put("http://localhost/test.url", 15L); + processor.put("http://localhost/test2.url", 50L); + processor.save(null); + processor = new PropertiesBasedResumableProcessor(); + + Map map = processor.load(); + assertEquals(2, map.size()); + assertEquals(Long.valueOf(15L), map.get("http://localhost/test.url")); + assertEquals(Long.valueOf(50L), map.get("http://localhost/test2.url")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRemove() { + PropertiesBasedResumableProcessor processor = new PropertiesBasedResumableProcessor(); + processor.put("http://localhost/test.url", 15L); + processor.put("http://localhost/test2.url", 50L); + processor.remove("http://localhost/test.url"); + processor.save(null); + processor = new PropertiesBasedResumableProcessor(); + + Map propertiesMap = processor.load(); + assertEquals(1, propertiesMap.size()); + assertEquals(Long.valueOf(50L), propertiesMap.get("http://localhost/test2.url")); + } +} diff --git a/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandlerTest.java b/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandlerTest.java new file mode 100644 index 0000000000..e142587576 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableAsyncHandlerTest.java @@ -0,0 +1,193 @@ +/* + * Copyright (c) 2010 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.handler.resumable; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHandler.State; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Request; +import org.asynchttpclient.Response; +import org.asynchttpclient.uri.Uri; + +import java.io.IOException; +import java.nio.ByteBuffer; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.RANGE; +import static org.asynchttpclient.Dsl.get; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.mockito.Mockito.any; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +/** + * @author Benjamin Hanzelmann + */ +public class ResumableAsyncHandlerTest { + + public static final byte[] T = new byte[0]; + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAdjustRange() { + MapResumableProcessor processor = new MapResumableProcessor(); + + ResumableAsyncHandler handler = new ResumableAsyncHandler(processor); + Request request = get("http://test/url").build(); + Request newRequest = handler.adjustRequestRange(request); + assertEquals(request.getUri(), newRequest.getUri()); + String rangeHeader = newRequest.getHeaders().get(RANGE); + assertNull(rangeHeader); + + processor.put("http://test/url", 5000); + newRequest = handler.adjustRequestRange(request); + assertEquals(request.getUri(), newRequest.getUri()); + rangeHeader = newRequest.getHeaders().get(RANGE); + assertEquals("bytes=5000-", rangeHeader); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnStatusReceivedOkStatus() throws Exception { + MapResumableProcessor processor = new MapResumableProcessor(); + ResumableAsyncHandler handler = new ResumableAsyncHandler(processor); + HttpResponseStatus responseStatus200 = mock(HttpResponseStatus.class); + when(responseStatus200.getStatusCode()).thenReturn(200); + when(responseStatus200.getUri()).thenReturn(mock(Uri.class)); + State state = handler.onStatusReceived(responseStatus200); + assertEquals(AsyncHandler.State.CONTINUE, state, "Status should be CONTINUE for a OK response"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnStatusReceived206Status() throws Exception { + MapResumableProcessor processor = new MapResumableProcessor(); + ResumableAsyncHandler handler = new ResumableAsyncHandler(processor); + HttpResponseStatus responseStatus206 = mock(HttpResponseStatus.class); + when(responseStatus206.getStatusCode()).thenReturn(206); + when(responseStatus206.getUri()).thenReturn(mock(Uri.class)); + State state = handler.onStatusReceived(responseStatus206); + assertEquals(AsyncHandler.State.CONTINUE, state, "Status should be CONTINUE for a 'Partial Content' response"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnStatusReceivedOkStatusWithDecoratedAsyncHandler() throws Exception { + HttpResponseStatus mockResponseStatus = mock(HttpResponseStatus.class); + when(mockResponseStatus.getStatusCode()).thenReturn(200); + when(mockResponseStatus.getUri()).thenReturn(mock(Uri.class)); + + @SuppressWarnings("unchecked") + AsyncHandler decoratedAsyncHandler = mock(AsyncHandler.class); + when(decoratedAsyncHandler.onStatusReceived(mockResponseStatus)).thenReturn(State.CONTINUE); + + ResumableAsyncHandler handler = new ResumableAsyncHandler(decoratedAsyncHandler); + + State state = handler.onStatusReceived(mockResponseStatus); + verify(decoratedAsyncHandler).onStatusReceived(mockResponseStatus); + assertEquals(State.CONTINUE, state, "State returned should be equal to the one returned from decoratedAsyncHandler"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnStatusReceived500Status() throws Exception { + MapResumableProcessor processor = new MapResumableProcessor(); + ResumableAsyncHandler handler = new ResumableAsyncHandler(processor); + HttpResponseStatus mockResponseStatus = mock(HttpResponseStatus.class); + when(mockResponseStatus.getStatusCode()).thenReturn(500); + when(mockResponseStatus.getUri()).thenReturn(mock(Uri.class)); + State state = handler.onStatusReceived(mockResponseStatus); + assertEquals(AsyncHandler.State.ABORT, state, "State should be ABORT for Internal Server Error status"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnBodyPartReceived() throws Exception { + ResumableAsyncHandler handler = new ResumableAsyncHandler(); + HttpResponseBodyPart bodyPart = mock(HttpResponseBodyPart.class); + when(bodyPart.getBodyPartBytes()).thenReturn(T); + ByteBuffer buffer = ByteBuffer.allocate(0); + when(bodyPart.getBodyByteBuffer()).thenReturn(buffer); + State state = handler.onBodyPartReceived(bodyPart); + assertEquals(AsyncHandler.State.CONTINUE, state, "State should be CONTINUE for a successful onBodyPartReceived"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnBodyPartReceivedWithResumableListenerThrowsException() throws Exception { + ResumableAsyncHandler handler = new ResumableAsyncHandler(); + + ResumableListener resumableListener = mock(ResumableListener.class); + doThrow(new IOException()).when(resumableListener).onBytesReceived(any()); + handler.setResumableListener(resumableListener); + + HttpResponseBodyPart bodyPart = mock(HttpResponseBodyPart.class); + State state = handler.onBodyPartReceived(bodyPart); + assertEquals(AsyncHandler.State.ABORT, state, + "State should be ABORT if the resumableListener threw an exception in onBodyPartReceived"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnBodyPartReceivedWithDecoratedAsyncHandler() throws Exception { + HttpResponseBodyPart bodyPart = mock(HttpResponseBodyPart.class); + when(bodyPart.getBodyPartBytes()).thenReturn(new byte[0]); + ByteBuffer buffer = ByteBuffer.allocate(0); + when(bodyPart.getBodyByteBuffer()).thenReturn(buffer); + + @SuppressWarnings("unchecked") + AsyncHandler decoratedAsyncHandler = mock(AsyncHandler.class); + when(decoratedAsyncHandler.onBodyPartReceived(bodyPart)).thenReturn(State.CONTINUE); + + // following is needed to set the url variable + HttpResponseStatus mockResponseStatus = mock(HttpResponseStatus.class); + when(mockResponseStatus.getStatusCode()).thenReturn(200); + Uri uri = Uri.create("http://non.null/"); + when(mockResponseStatus.getUri()).thenReturn(uri); + + ResumableAsyncHandler handler = new ResumableAsyncHandler(decoratedAsyncHandler); + handler.onStatusReceived(mockResponseStatus); + + State state = handler.onBodyPartReceived(bodyPart); + assertEquals(State.CONTINUE, state, "State should be equal to the state returned from decoratedAsyncHandler"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnHeadersReceived() throws Exception { + ResumableAsyncHandler handler = new ResumableAsyncHandler(); + HttpHeaders responseHeaders = new DefaultHttpHeaders(); + State status = handler.onHeadersReceived(responseHeaders); + assertEquals(AsyncHandler.State.CONTINUE, status, "State should be CONTINUE for a successful onHeadersReceived"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnHeadersReceivedWithDecoratedAsyncHandler() throws Exception { + HttpHeaders responseHeaders = new DefaultHttpHeaders(); + + @SuppressWarnings("unchecked") + AsyncHandler decoratedAsyncHandler = mock(AsyncHandler.class); + when(decoratedAsyncHandler.onHeadersReceived(responseHeaders)).thenReturn(State.CONTINUE); + + ResumableAsyncHandler handler = new ResumableAsyncHandler(decoratedAsyncHandler); + State status = handler.onHeadersReceived(responseHeaders); + assertEquals(State.CONTINUE, status, "State should be equal to the state returned from decoratedAsyncHandler"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnHeadersReceivedContentLengthMinus() throws Exception { + ResumableAsyncHandler handler = new ResumableAsyncHandler(); + HttpHeaders responseHeaders = new DefaultHttpHeaders(); + responseHeaders.add(CONTENT_LENGTH, -1); + State status = handler.onHeadersReceived(responseHeaders); + assertEquals(AsyncHandler.State.ABORT, status, "State should be ABORT for content length -1"); + } +} diff --git a/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListenerTest.java b/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListenerTest.java new file mode 100644 index 0000000000..b8a176b605 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/handler/resumable/ResumableRandomAccessFileListenerTest.java @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.handler.resumable; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.io.IOException; +import java.io.RandomAccessFile; +import java.nio.ByteBuffer; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; + +public class ResumableRandomAccessFileListenerTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnBytesReceivedBufferHasArray() throws IOException { + RandomAccessFile file = mock(RandomAccessFile.class); + ResumableRandomAccessFileListener listener = new ResumableRandomAccessFileListener(file); + byte[] array = {1, 2, 23, 33}; + ByteBuffer buf = ByteBuffer.wrap(array); + listener.onBytesReceived(buf); + verify(file).write(array, 0, 4); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testOnBytesReceivedBufferHasNoArray() throws IOException { + RandomAccessFile file = mock(RandomAccessFile.class); + ResumableRandomAccessFileListener listener = new ResumableRandomAccessFileListener(file); + + byte[] byteArray = {1, 2, 23, 33}; + ByteBuffer buf = ByteBuffer.allocateDirect(4); + buf.put(byteArray); + buf.flip(); + listener.onBytesReceived(buf); + verify(file).write(byteArray); + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/EventPipelineTest.java b/client/src/test/java/org/asynchttpclient/netty/EventPipelineTest.java new file mode 100644 index 0000000000..2a95230368 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/EventPipelineTest.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.channel.Channel; +import io.netty.channel.ChannelHandlerContext; +import io.netty.channel.ChannelInboundHandlerAdapter; +import io.netty.handler.codec.http.HttpMessage; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.function.Consumer; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class EventPipelineTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncPipelineTest() throws Exception { + Consumer httpAdditionalPipelineInitializer = channel -> channel.pipeline() + .addBefore("inflater", "copyEncodingHeader", new CopyEncodingHandler()); + + try (AsyncHttpClient client = asyncHttpClient(config().setHttpAdditionalChannelInitializer(httpAdditionalPipelineInitializer))) { + final CountDownLatch latch = new CountDownLatch(1); + client.executeRequest(get(getTargetUrl()), new AsyncCompletionHandlerAdapter() { + @Override + public Response onCompleted(Response response) { + try { + assertEquals(200, response.getStatusCode()); + assertEquals("", response.getHeader("X-Original-Content-Encoding")); + } finally { + latch.countDown(); + } + return response; + } + }).get(); + assertTrue(latch.await(TIMEOUT, TimeUnit.SECONDS)); + } + } + + private static class CopyEncodingHandler extends ChannelInboundHandlerAdapter { + @Override + public void channelRead(ChannelHandlerContext ctx, Object e) { + if (e instanceof HttpMessage) { + HttpMessage m = (HttpMessage) e; + // for test there is no Content-Encoding header so just hard + // coding value + // for verification + m.headers().set("X-Original-Content-Encoding", ""); + } + ctx.fireChannelRead(e); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/NettyAsyncResponseTest.java b/client/src/test/java/org/asynchttpclient/netty/NettyAsyncResponseTest.java new file mode 100644 index 0000000000..5172bae7af --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/NettyAsyncResponseTest.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import io.netty.handler.codec.http.cookie.Cookie; +import org.asynchttpclient.HttpResponseBodyPart; + +import java.nio.charset.StandardCharsets; +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.LinkedList; +import java.util.List; +import java.util.Locale; +import java.util.TimeZone; + +import static io.netty.handler.codec.http.HttpHeaderNames.SET_COOKIE; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class NettyAsyncResponseTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCookieParseExpires() { + // e.g. "Tue, 27 Oct 2015 12:54:24 GMT"; + SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US); + sdf.setTimeZone(TimeZone.getTimeZone("GMT")); + + Date date = new Date(System.currentTimeMillis() + 60000); + final String cookieDef = String.format("efmembercheck=true; expires=%s; path=/; domain=.eclipse.org", sdf.format(date)); + + HttpHeaders responseHeaders = new DefaultHttpHeaders().add(SET_COOKIE, cookieDef); + NettyResponse response = new NettyResponse(new NettyResponseStatus(null, null, null), responseHeaders, null); + + List cookies = response.getCookies(); + assertEquals(1, cookies.size()); + + Cookie cookie = cookies.get(0); + assertTrue(cookie.maxAge() >= 58 && cookie.maxAge() <= 60); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCookieParseMaxAge() { + final String cookieDef = "efmembercheck=true; max-age=60; path=/; domain=.eclipse.org"; + + HttpHeaders responseHeaders = new DefaultHttpHeaders().add(SET_COOKIE, cookieDef); + NettyResponse response = new NettyResponse(new NettyResponseStatus(null, null, null), responseHeaders, null); + List cookies = response.getCookies(); + assertEquals(1, cookies.size()); + + Cookie cookie = cookies.get(0); + assertEquals(60, cookie.maxAge()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCookieParseWeirdExpiresValue() { + final String cookieDef = "efmembercheck=true; expires=60; path=/; domain=.eclipse.org"; + HttpHeaders responseHeaders = new DefaultHttpHeaders().add(SET_COOKIE, cookieDef); + NettyResponse response = new NettyResponse(new NettyResponseStatus(null, null, null), responseHeaders, null); + + List cookies = response.getCookies(); + assertEquals(1, cookies.size()); + + Cookie cookie = cookies.get(0); + assertEquals(Long.MIN_VALUE, cookie.maxAge()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetResponseBodyAsByteBuffer() { + List bodyParts = new LinkedList<>(); + bodyParts.add(new LazyResponseBodyPart(Unpooled.wrappedBuffer("Hello ".getBytes()), false)); + bodyParts.add(new LazyResponseBodyPart(Unpooled.wrappedBuffer("World".getBytes()), true)); + NettyResponse response = new NettyResponse(new NettyResponseStatus(null, null, null), null, bodyParts); + + ByteBuf body = response.getResponseBodyAsByteBuf(); + assertEquals("Hello World", body.toString(StandardCharsets.UTF_8)); + body.release(); + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/NettyConnectionResetByPeerTest.java b/client/src/test/java/org/asynchttpclient/netty/NettyConnectionResetByPeerTest.java new file mode 100644 index 0000000000..484b074a3c --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/NettyConnectionResetByPeerTest.java @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.github.nettyplus.leakdetector.junit.NettyLeakDetectorExtension; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.DefaultAsyncHttpClient; +import org.asynchttpclient.DefaultAsyncHttpClientConfig; +import org.asynchttpclient.RequestBuilder; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.extension.ExtendWith; + +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.ServerSocket; +import java.net.Socket; +import java.time.Duration; +import java.util.Arrays; +import java.util.concurrent.Exchanger; +import java.util.function.Consumer; + +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +@ExtendWith(NettyLeakDetectorExtension.class) +public class NettyConnectionResetByPeerTest { + + private String resettingServerAddress; + + @BeforeEach + public void setUp() { + resettingServerAddress = createResettingServer(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAsyncHttpClientConnectionResetByPeer() throws InterruptedException { + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder() + .setRequestTimeout(Duration.ofMillis(1500)) + .build(); + try (AsyncHttpClient asyncHttpClient = new DefaultAsyncHttpClient(config)) { + asyncHttpClient.executeRequest(new RequestBuilder("GET").setUrl(resettingServerAddress)).get(); + } catch (Exception ex) { + assertInstanceOf(Exception.class, ex); + } + } + + private static String createResettingServer() { + return createServer(sock -> { + try (Socket socket = sock) { + socket.setSoLinger(true, 0); + InputStream inputStream = socket.getInputStream(); + //to not eliminate read + OutputStream os = new OutputStream() { + @Override + public void write(int b) { + // Do nothing + } + }; + os.write(startRead(inputStream)); + } catch (IOException e) { + throw new RuntimeException(e); + } + }); + } + + private static String createServer(Consumer handler) { + Exchanger portHolder = new Exchanger<>(); + Thread t = new Thread(() -> { + try (ServerSocket ss = new ServerSocket(0)) { + portHolder.exchange(ss.getLocalPort()); + while (true) { + handler.accept(ss.accept()); + } + } catch (Exception e) { + if (e instanceof InterruptedException) { + Thread.currentThread() + .interrupt(); + } + throw new RuntimeException(e); + } + }); + t.setDaemon(true); + t.start(); + return tryGetAddress(portHolder); + } + + private static String tryGetAddress(Exchanger portHolder) { + try { + return "http://localhost/" + portHolder.exchange(0); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } + } + + private static byte[] startRead(InputStream inputStream) throws IOException { + byte[] buffer = new byte[4]; + int length = inputStream.read(buffer); + return Arrays.copyOf(buffer, length); + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/NettyRequestThrottleTimeoutTest.java b/client/src/test/java/org/asynchttpclient/netty/NettyRequestThrottleTimeoutTest.java new file mode 100644 index 0000000000..eade766201 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/NettyRequestThrottleTimeoutTest.java @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.AsyncContext; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandler; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.Future; +import java.util.concurrent.Semaphore; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class NettyRequestThrottleTimeoutTest extends AbstractBasicTest { + private static final String MSG = "Enough is enough."; + private static final int SLEEPTIME_MS = 1000; + + @Override + public AbstractHandler configureHandler() throws Exception { + return new SlowHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRequestTimeout() throws IOException { + final Semaphore requestThrottle = new Semaphore(1); + final int samples = 10; + + try (AsyncHttpClient client = asyncHttpClient(config().setMaxConnections(1))) { + final CountDownLatch latch = new CountDownLatch(samples); + final List tooManyConnections = Collections.synchronizedList(new ArrayList<>(2)); + + for (int i = 0; i < samples; i++) { + new Thread(() -> { + try { + requestThrottle.acquire(); + Future responseFuture = null; + try { + responseFuture = client.prepareGet(getTargetUrl()).setRequestTimeout(Duration.ofMillis(SLEEPTIME_MS / 2)) + .execute(new AsyncCompletionHandler() { + + @Override + public Response onCompleted(Response response) { + return response; + } + + @Override + public void onThrowable(Throwable t) { + logger.error("onThrowable got an error", t); + try { + Thread.sleep(100); + } catch (InterruptedException e) { + // + } + requestThrottle.release(); + } + }); + } catch (Exception e) { + tooManyConnections.add(e); + } + + if (responseFuture != null) { + responseFuture.get(); + } + } catch (Exception e) { + // + } finally { + latch.countDown(); + } + }).start(); + } + + assertDoesNotThrow(() -> { + assertTrue(latch.await(30, TimeUnit.SECONDS)); + }); + + for (Exception e : tooManyConnections) { + logger.error("Exception while calling execute", e); + } + + assertTrue(tooManyConnections.isEmpty(), "Should not have any connection errors where too many connections have been attempted"); + } + } + + private static class SlowHandler extends AbstractHandler { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, final HttpServletResponse response) throws IOException, ServletException { + response.setStatus(HttpServletResponse.SC_OK); + final AsyncContext asyncContext = request.startAsync(); + new Thread(() -> { + try { + Thread.sleep(SLEEPTIME_MS); + response.getOutputStream().print(MSG); + response.getOutputStream().flush(); + asyncContext.complete(); + } catch (InterruptedException | IOException e) { + logger.error(e.getMessage(), e); + } + }).start(); + baseRequest.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/NettyResponseFutureTest.java b/client/src/test/java/org/asynchttpclient/netty/NettyResponseFutureTest.java new file mode 100644 index 0000000000..a052893002 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/NettyResponseFutureTest.java @@ -0,0 +1,93 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHandler; + +import java.util.concurrent.CancellationException; +import java.util.concurrent.ExecutionException; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +public class NettyResponseFutureTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCancel() { + AsyncHandler asyncHandler = mock(AsyncHandler.class); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + boolean result = nettyResponseFuture.cancel(false); + verify(asyncHandler).onThrowable(any()); + assertTrue(result, "Cancel should return true if the Future was cancelled successfully"); + assertTrue(nettyResponseFuture.isCancelled(), "isCancelled should return true for a cancelled Future"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCancelOnAlreadyCancelled() { + AsyncHandler asyncHandler = mock(AsyncHandler.class); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + nettyResponseFuture.cancel(false); + boolean result = nettyResponseFuture.cancel(false); + assertFalse(result, "cancel should return false for an already cancelled Future"); + assertTrue(nettyResponseFuture.isCancelled(), "isCancelled should return true for a cancelled Future"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetContentThrowsCancellationExceptionIfCancelled() throws Exception { + AsyncHandler asyncHandler = mock(AsyncHandler.class); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + nettyResponseFuture.cancel(false); + assertThrows(CancellationException.class, () -> nettyResponseFuture.get(), "A CancellationException must have occurred by now as 'cancel' was called before 'get'"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGet() throws Exception { + @SuppressWarnings("unchecked") + AsyncHandler asyncHandler = mock(AsyncHandler.class); + Object value = new Object(); + when(asyncHandler.onCompleted()).thenReturn(value); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + nettyResponseFuture.done(); + Object result = nettyResponseFuture.get(); + assertEquals(value, result, "The Future should return the value given by asyncHandler#onCompleted"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetThrowsExceptionThrownByAsyncHandler() throws Exception { + AsyncHandler asyncHandler = mock(AsyncHandler.class); + when(asyncHandler.onCompleted()).thenThrow(new RuntimeException()); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + nettyResponseFuture.done(); + assertThrows(ExecutionException.class, () -> nettyResponseFuture.get(), + "An ExecutionException must have occurred by now as asyncHandler threw an exception in 'onCompleted'"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetThrowsExceptionOnAbort() throws Exception { + AsyncHandler asyncHandler = mock(AsyncHandler.class); + NettyResponseFuture nettyResponseFuture = new NettyResponseFuture<>(null, asyncHandler, null, 3, null, null, null); + nettyResponseFuture.abort(new RuntimeException()); + assertThrows(ExecutionException.class, () -> nettyResponseFuture.get(), + "An ExecutionException must have occurred by now as 'abort' was called before 'get'"); + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/NettyTest.java b/client/src/test/java/org/asynchttpclient/netty/NettyTest.java new file mode 100644 index 0000000000..f80c0911e6 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/NettyTest.java @@ -0,0 +1,56 @@ +package org.asynchttpclient.netty; + +import io.netty.channel.epoll.Epoll; +import io.netty.channel.kqueue.KQueue; +import io.netty.handler.codec.compression.Brotli; +import io.netty.handler.codec.compression.Zstd; +import io.netty.incubator.channel.uring.IOUring; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.EnabledOnOs; +import org.junit.jupiter.api.condition.OS; + +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class NettyTest { + @Test + @EnabledOnOs(OS.LINUX) + public void epollIsAvailableOnLinux() { + assertTrue(Epoll.isAvailable()); + } + + @Test + @EnabledOnOs(OS.LINUX) + public void ioUringIsAvailableOnLinux() { + assertTrue(IOUring.isAvailable()); + } + + @Test + @EnabledOnOs(OS.MAC) + public void kqueueIsAvailableOnMac() { + assertTrue(KQueue.isAvailable()); + } + + @Test + @EnabledOnOs(OS.LINUX) + public void brotliIsAvailableOnLinux() { + assertTrue(Brotli.isAvailable()); + } + + @Test + @EnabledOnOs(OS.MAC) + public void brotliIsAvailableOnMac() { + assertTrue(Brotli.isAvailable()); + } + + @Test + @EnabledOnOs(OS.LINUX) + public void zstdIsAvailableOnLinux() { + assertTrue(Zstd.isAvailable()); + } + + @Test + @EnabledOnOs(OS.MAC) + public void zstdIsAvailableOnMac() { + assertTrue(Zstd.isAvailable()); + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/RetryNonBlockingIssueTest.java b/client/src/test/java/org/asynchttpclient/netty/RetryNonBlockingIssueTest.java new file mode 100644 index 0000000000..60313166a1 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/RetryNonBlockingIssueTest.java @@ -0,0 +1,209 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServlet; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.servlet.ServletHolder; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +//FIXME there's no retry actually +public class RetryNonBlockingIssueTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.setContextPath("/"); + context.addServlet(new ServletHolder(new MockExceptionServlet()), "/*"); + server.setHandler(context); + + server.start(); + port1 = connector.getLocalPort(); + } + + @Override + protected String getTargetUrl() { + return String.format("http://localhost:%d/", port1); + } + + private ListenableFuture testMethodRequest(AsyncHttpClient client, int requests, String action, String id) { + RequestBuilder r = get(getTargetUrl()) + .addQueryParam(action, "1") + .addQueryParam("maxRequests", String.valueOf(requests)) + .addQueryParam("id", id); + return client.executeRequest(r); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRetryNonBlocking() throws Exception { + AsyncHttpClientConfig config = config() + .setKeepAlive(true) + .setMaxConnections(100) + .setConnectTimeout(Duration.ofMinutes(1)) + .setRequestTimeout(Duration.ofSeconds(30)) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + List> res = new ArrayList<>(); + for (int i = 0; i < 32; i++) { + res.add(testMethodRequest(client, 3, "servlet", UUID.randomUUID().toString())); + } + + StringBuilder b = new StringBuilder(); + for (ListenableFuture r : res) { + Response theres = r.get(); + assertEquals(200, theres.getStatusCode()); + b.append("==============\r\n").append("Response Headers\r\n"); + HttpHeaders heads = theres.getHeaders(); + b.append(heads).append("\r\n").append("==============\r\n"); + } + System.out.println(b); + System.out.flush(); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRetryNonBlockingAsyncConnect() throws Exception { + AsyncHttpClientConfig config = config() + .setKeepAlive(true) + .setMaxConnections(100) + .setConnectTimeout(Duration.ofMinutes(1)) + .setRequestTimeout(Duration.ofSeconds(30)) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + List> res = new ArrayList<>(); + for (int i = 0; i < 32; i++) { + res.add(testMethodRequest(client, 3, "servlet", UUID.randomUUID().toString())); + } + + StringBuilder b = new StringBuilder(); + for (ListenableFuture r : res) { + Response theres = r.get(); + assertEquals(theres.getStatusCode(), 200); + b.append("==============\r\n").append("Response Headers\r\n"); + HttpHeaders heads = theres.getHeaders(); + b.append(heads).append("\r\n").append("==============\r\n"); + } + System.out.println(b); + System.out.flush(); + } + } + + @SuppressWarnings("serial") + public static class MockExceptionServlet extends HttpServlet { + + private final Map requests = new ConcurrentHashMap<>(); + + private synchronized int increment(String id) { + int val; + if (requests.containsKey(id)) { + Integer i = requests.get(id); + val = i + 1; + requests.put(id, val); + } else { + requests.put(id, 1); + val = 1; + } + System.out.println("REQUESTS: " + requests); + return val; + } + + @Override + public void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { + String maxRequests = req.getParameter("maxRequests"); + int max; + try { + max = Integer.parseInt(maxRequests); + } catch (NumberFormatException e) { + max = 3; + } + + String id = req.getParameter("id"); + int requestNo = increment(id); + String servlet = req.getParameter("servlet"); + String io = req.getParameter("io"); + String error = req.getParameter("500"); + + if (requestNo >= max) { + res.setHeader("Success-On-Attempt", String.valueOf(requestNo)); + res.setHeader("id", id); + + if (servlet != null && servlet.trim().length() > 0) { + res.setHeader("type", "servlet"); + } + + if (error != null && error.trim().length() > 0) { + res.setHeader("type", "500"); + } + + if (io != null && io.trim().length() > 0) { + res.setHeader("type", "io"); + } + res.setStatus(200); + res.setContentLength(0); + res.flushBuffer(); + return; + } + + res.setStatus(200); + res.setContentLength(100); + res.setContentType("application/octet-stream"); + res.flushBuffer(); + + // error after flushing the status + if (servlet != null && servlet.trim().length() > 0) { + throw new ServletException("Servlet Exception"); + } + + if (io != null && io.trim().length() > 0) { + throw new IOException("IO Exception"); + } + + if (error != null && error.trim().length() > 0) { + res.sendError(500, "servlet process was 500"); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/TimeToLiveIssueTest.java b/client/src/test/java/org/asynchttpclient/netty/TimeToLiveIssueTest.java new file mode 100644 index 0000000000..a2916248d7 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/TimeToLiveIssueTest.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.netty; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Request; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.junit.jupiter.api.Disabled; + +import java.time.Duration; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; + +public class TimeToLiveIssueTest extends AbstractBasicTest { + + @Disabled("https://github.com/AsyncHttpClient/async-http-client/issues/1113") + @RepeatedIfExceptionsTest(repeats = 5) + public void testTTLBug() throws Throwable { + // The purpose of this test is to reproduce two issues: + // 1) Connections that are rejected by the pool are not closed and eventually use all available sockets. + // 2) It is possible for a connection to be closed while active by the timer task that checks for expired connections. + + try (AsyncHttpClient client = asyncHttpClient(config() + .setKeepAlive(true) + .setConnectionTtl(Duration.ofMillis(1)) + .setPooledConnectionIdleTimeout(Duration.ofMillis(1)))) { + + for (int i = 0; i < 200000; ++i) { + Request request = new RequestBuilder().setUrl(String.format("http://localhost:%d/", port1)).build(); + + Future future = client.executeRequest(request); + future.get(5, TimeUnit.SECONDS); + + // This is to give a chance to the timer task that removes expired connection + // from sometimes winning over poll for the ownership of a connection. + if (System.currentTimeMillis() % 100 == 0) { + Thread.sleep(5); + } + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreRunner.java b/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreRunner.java new file mode 100644 index 0000000000..08fbb3464d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreRunner.java @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +class SemaphoreRunner { + + final ConnectionSemaphore semaphore; + final Thread acquireThread; + + volatile long acquireTime; + volatile Exception acquireException; + + SemaphoreRunner(ConnectionSemaphore semaphore, Object partitionKey) { + this.semaphore = semaphore; + acquireThread = new Thread(() -> { + long beforeAcquire = System.currentTimeMillis(); + try { + semaphore.acquireChannelLock(partitionKey); + } catch (Exception e) { + acquireException = e; + } finally { + acquireTime = System.currentTimeMillis() - beforeAcquire; + } + }); + } + + public void acquire() { + acquireThread.start(); + } + + public void interrupt() { + acquireThread.interrupt(); + } + + public void await() { + try { + acquireThread.join(); + } catch (InterruptedException e) { + throw new RuntimeException(e); + } + } + + public boolean finished() { + return !acquireThread.isAlive(); + } + + public long getAcquireTime() { + return acquireTime; + } + + public Exception getAcquireException() { + return acquireException; + } +} diff --git a/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreTest.java b/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreTest.java new file mode 100644 index 0000000000..1c9f1db1d4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/netty/channel/SemaphoreTest.java @@ -0,0 +1,174 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.netty.channel; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.exception.TooManyConnectionsException; +import org.asynchttpclient.exception.TooManyConnectionsPerHostException; +import org.junit.jupiter.api.RepeatedTest; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.Timeout; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.MethodSource; + +import java.io.IOException; +import java.util.List; +import java.util.Objects; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +public class SemaphoreTest { + + static final int CHECK_ACQUIRE_TIME__PERMITS = 10; + static final int CHECK_ACQUIRE_TIME__TIMEOUT = 100; + + static final int NON_DETERMINISTIC__INVOCATION_COUNT = 10; + static final int NON_DETERMINISTIC__SUCCESS_PERCENT = 70; + + private final Object PK = new Object(); + + public Object[][] permitsAndRunnersCount() { + Object[][] objects = new Object[100][]; + int row = 0; + for (int i = 0; i < 10; i++) { + for (int j = 0; j < 10; j++) { + objects[row++] = new Object[]{i, j}; + } + } + return objects; + } + + @ParameterizedTest + @MethodSource("permitsAndRunnersCount") + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void maxConnectionCheckPermitCount(int permitCount, int runnerCount) { + allSemaphoresCheckPermitCount(new MaxConnectionSemaphore(permitCount, 0), permitCount, runnerCount); + } + + @ParameterizedTest + @MethodSource("permitsAndRunnersCount") + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void perHostCheckPermitCount(int permitCount, int runnerCount) { + allSemaphoresCheckPermitCount(new PerHostConnectionSemaphore(permitCount, 0), permitCount, runnerCount); + } + + @ParameterizedTest + @MethodSource("permitsAndRunnersCount") + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void combinedCheckPermitCount(int permitCount, int runnerCount) { + allSemaphoresCheckPermitCount(new CombinedConnectionSemaphore(permitCount, permitCount, 0), permitCount, runnerCount); + allSemaphoresCheckPermitCount(new CombinedConnectionSemaphore(0, permitCount, 0), permitCount, runnerCount); + allSemaphoresCheckPermitCount(new CombinedConnectionSemaphore(permitCount, 0, 0), permitCount, runnerCount); + } + + private void allSemaphoresCheckPermitCount(ConnectionSemaphore semaphore, int permitCount, int runnerCount) { + List runners = IntStream.range(0, runnerCount) + .mapToObj(i -> new SemaphoreRunner(semaphore, PK)) + .collect(Collectors.toList()); + runners.forEach(SemaphoreRunner::acquire); + runners.forEach(SemaphoreRunner::await); + + long tooManyConnectionsCount = runners.stream().map(SemaphoreRunner::getAcquireException) + .filter(Objects::nonNull) + .filter(e -> e instanceof IOException) + .count(); + + long acquired = runners.stream().map(SemaphoreRunner::getAcquireException) + .filter(Objects::isNull) + .count(); + + int expectedAcquired = permitCount > 0 ? Math.min(permitCount, runnerCount) : runnerCount; + + assertEquals(expectedAcquired, acquired); + assertEquals(runnerCount - acquired, tooManyConnectionsCount); + } + + @RepeatedTest(NON_DETERMINISTIC__INVOCATION_COUNT) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void maxConnectionCheckAcquireTime() { + checkAcquireTime(new MaxConnectionSemaphore(CHECK_ACQUIRE_TIME__PERMITS, CHECK_ACQUIRE_TIME__TIMEOUT)); + } + + @RepeatedTest(NON_DETERMINISTIC__INVOCATION_COUNT) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void perHostCheckAcquireTime() { + checkAcquireTime(new PerHostConnectionSemaphore(CHECK_ACQUIRE_TIME__PERMITS, CHECK_ACQUIRE_TIME__TIMEOUT)); + } + + @RepeatedTest(NON_DETERMINISTIC__INVOCATION_COUNT) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void combinedCheckAcquireTime() { + checkAcquireTime(new CombinedConnectionSemaphore(CHECK_ACQUIRE_TIME__PERMITS, + CHECK_ACQUIRE_TIME__PERMITS, + CHECK_ACQUIRE_TIME__TIMEOUT)); + } + + private void checkAcquireTime(ConnectionSemaphore semaphore) { + List runners = IntStream.range(0, CHECK_ACQUIRE_TIME__PERMITS * 2) + .mapToObj(i -> new SemaphoreRunner(semaphore, PK)) + .collect(Collectors.toList()); + long acquireStartTime = System.currentTimeMillis(); + runners.forEach(SemaphoreRunner::acquire); + runners.forEach(SemaphoreRunner::await); + long timeToAcquire = System.currentTimeMillis() - acquireStartTime; + + assertTrue(timeToAcquire >= CHECK_ACQUIRE_TIME__TIMEOUT - 50, "Semaphore acquired too soon: " + timeToAcquire + " ms"); //Lower Bound + assertTrue(timeToAcquire <= CHECK_ACQUIRE_TIME__TIMEOUT + 300, "Semaphore acquired too late: " + timeToAcquire + " ms"); //Upper Bound + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void maxConnectionCheckRelease() throws IOException { + checkRelease(new MaxConnectionSemaphore(1, 0)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void perHostCheckRelease() throws IOException { + checkRelease(new PerHostConnectionSemaphore(1, 0)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 1000) + public void combinedCheckRelease() throws IOException { + checkRelease(new CombinedConnectionSemaphore(1, 1, 0)); + } + + private void checkRelease(ConnectionSemaphore semaphore) throws IOException { + semaphore.acquireChannelLock(PK); + boolean tooManyCaught = false; + try { + semaphore.acquireChannelLock(PK); + } catch (TooManyConnectionsException | TooManyConnectionsPerHostException e) { + tooManyCaught = true; + } + assertTrue(tooManyCaught); + tooManyCaught = false; + semaphore.releaseChannelLock(PK); + try { + semaphore.acquireChannelLock(PK); + } catch (TooManyConnectionsException | TooManyConnectionsPerHostException e) { + tooManyCaught = true; + } + assertFalse(tooManyCaught); + } +} diff --git a/client/src/test/java/org/asynchttpclient/ntlm/NtlmTest.java b/client/src/test/java/org/asynchttpclient/ntlm/NtlmTest.java new file mode 100644 index 0000000000..0bce17d4c7 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ntlm/NtlmTest.java @@ -0,0 +1,236 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ntlm; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.io.output.ByteArrayOutputStream; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Response; +import org.asynchttpclient.ntlm.NtlmEngine.Type2Message; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.util.Base64; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.ntlmAuthRealm; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class NtlmTest extends AbstractBasicTest { + + private static byte[] longToBytes(long x) { + ByteBuffer buffer = ByteBuffer.allocate(Long.BYTES); + buffer.putLong(x); + return buffer.array(); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new NTLMHandler(); + } + + private static Realm.Builder realmBuilderBase() { + return ntlmAuthRealm("Zaphod", "Beeblebrox") + .setNtlmDomain("Ursa-Minor") + .setNtlmHost("LightCity"); + } + + private void ntlmAuthTest(Realm.Builder realmBuilder) throws IOException, InterruptedException, ExecutionException { + try (AsyncHttpClient client = asyncHttpClient(config().setRealm(realmBuilder))) { + Future responseFuture = client.executeRequest(get(getTargetUrl())); + int status = responseFuture.get().getStatusCode(); + assertEquals(200, status); + } + } + + @Test + public void testUnicodeLittleUnmarkedEncoding() { + final Charset unicodeLittleUnmarked = Charset.forName("UnicodeLittleUnmarked"); + final Charset utf16le = StandardCharsets.UTF_16LE; + assertEquals(unicodeLittleUnmarked, utf16le); + assertArrayEquals("Test @ テスト".getBytes(unicodeLittleUnmarked), "Test @ テスト".getBytes(utf16le)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void lazyNTLMAuthTest() throws Exception { + ntlmAuthTest(realmBuilderBase()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void preemptiveNTLMAuthTest() throws Exception { + ntlmAuthTest(realmBuilderBase().setUsePreemptiveAuth(true)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType1Msg() { + NtlmEngine engine = new NtlmEngine(); + String message = engine.generateType1Msg(); + assertEquals(message, "TlRMTVNTUAABAAAAAYIIogAAAAAoAAAAAAAAACgAAAAFASgKAAAADw==", "Incorrect type1 message generated"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType3MsgThrowsExceptionWhenChallengeTooShort() { + NtlmEngine engine = new NtlmEngine(); + assertThrows(NtlmEngineException.class, () -> NtlmEngine.generateType3Msg("username", "password", "localhost", "workstation", + Base64.getEncoder().encodeToString("a".getBytes())), + "An NtlmEngineException must have occurred as challenge length is too short"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType3MsgThrowsExceptionWhenChallengeDoesNotFollowCorrectFormat() { + NtlmEngine engine = new NtlmEngine(); + assertThrows(NtlmEngineException.class, () -> NtlmEngine.generateType3Msg("username", "password", "localhost", "workstation", + Base64.getEncoder().encodeToString("challenge".getBytes())), + "An NtlmEngineException must have occurred as challenge length is too short"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType3MsgThworsExceptionWhenType2IndicatorNotPresent() throws IOException { + try (ByteArrayOutputStream buf = new ByteArrayOutputStream()) { + buf.write("NTLMSSP".getBytes(StandardCharsets.US_ASCII)); + buf.write(0); + // type 2 indicator + buf.write(3); + buf.write(0); + buf.write(0); + buf.write(0); + buf.write("challenge".getBytes()); + NtlmEngine engine = new NtlmEngine(); + assertThrows(NtlmEngineException.class, () -> NtlmEngine.generateType3Msg("username", "password", "localhost", "workstation", + Base64.getEncoder().encodeToString(buf.toByteArray())), "An NtlmEngineException must have occurred as type 2 indicator is incorrect"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType3MsgThrowsExceptionWhenUnicodeSupportNotIndicated() throws IOException { + try (ByteArrayOutputStream buf = new ByteArrayOutputStream()) { + buf.write("NTLMSSP".getBytes(StandardCharsets.US_ASCII)); + buf.write(0); + // type 2 indicator + buf.write(2); + buf.write(0); + buf.write(0); + buf.write(0); + + buf.write(longToBytes(1L)); // we want to write a Long + + // flags + buf.write(0);// unicode support indicator + buf.write(0); + buf.write(0); + buf.write(0); + + buf.write(longToBytes(1L));// challenge + NtlmEngine engine = new NtlmEngine(); + assertThrows(NtlmEngineException.class, () -> NtlmEngine.generateType3Msg("username", "password", "localhost", "workstation", + Base64.getEncoder().encodeToString(buf.toByteArray())), + "An NtlmEngineException must have occurred as unicode support is not indicated"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType2Msg() { + Type2Message type2Message = new Type2Message("TlRMTVNTUAACAAAAAAAAACgAAAABggAAU3J2Tm9uY2UAAAAAAAAAAA=="); + assertEquals(40, type2Message.getMessageLength(), "This is a sample challenge that should return 40"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGenerateType3Msg() throws IOException { + try (ByteArrayOutputStream buf = new ByteArrayOutputStream()) { + buf.write("NTLMSSP".getBytes(StandardCharsets.US_ASCII)); + buf.write(0); + // type 2 indicator + buf.write(2); + buf.write(0); + buf.write(0); + buf.write(0); + + buf.write(longToBytes(0L)); // we want to write a Long + + // flags + buf.write(1);// unicode support indicator + buf.write(0); + buf.write(0); + buf.write(0); + + buf.write(longToBytes(1L));// challenge + NtlmEngine engine = new NtlmEngine(); + String type3Msg = NtlmEngine.generateType3Msg("username", "password", "localhost", "workstation", + Base64.getEncoder().encodeToString(buf.toByteArray())); + assertEquals(type3Msg, + "TlRMTVNTUAADAAAAGAAYAEgAAAAYABgAYAAAABIAEgB4AAAAEAAQAIoAAAAWABYAmgAAAAAAAACwAAAAAQAAAgUBKAoAAAAP1g6lqqN1HZ0wSSxeQ5riQkyh7/UexwVlCPQm0SHU2vsDQm2wM6NbT2zPonPzLJL0TABPAEMAQQBMAEgATwBTAFQAdQBzAGUAcgBuAGEAbQBlAFcATwBSAEsAUwBUAEEAVABJAE8ATgA=", + "Incorrect type3 message generated"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWriteULong() { + // test different combinations so that different positions in the byte array will be written + byte[] buffer = new byte[4]; + NtlmEngine.writeULong(buffer, 1, 0); + assertArrayEquals(new byte[]{1, 0, 0, 0}, buffer, "Unsigned long value 1 was not written correctly to the buffer"); + + buffer = new byte[4]; + NtlmEngine.writeULong(buffer, 257, 0); + assertArrayEquals(new byte[]{1, 1, 0, 0}, buffer, "Unsigned long value 257 was not written correctly to the buffer"); + + buffer = new byte[4]; + NtlmEngine.writeULong(buffer, 16777216, 0); + assertArrayEquals(new byte[]{0, 0, 0, 1}, buffer, "Unsigned long value 16777216 was not written correctly to the buffer"); + } + + public static class NTLMHandler extends AbstractHandler { + + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + String authorization = httpRequest.getHeader("Authorization"); + if (authorization == null) { + httpResponse.setStatus(401); + httpResponse.setHeader("WWW-Authenticate", "NTLM"); + + } else if ("NTLM TlRMTVNTUAABAAAAAYIIogAAAAAoAAAAAAAAACgAAAAFASgKAAAADw==".equals(authorization)) { + httpResponse.setStatus(401); + httpResponse.setHeader("WWW-Authenticate", "NTLM TlRMTVNTUAACAAAAAAAAACgAAAABggAAU3J2Tm9uY2UAAAAAAAAAAA=="); + + } else if ("NTLM TlRMTVNTUAADAAAAGAAYAEgAAAAYABgAYAAAABQAFAB4AAAADAAMAIwAAAASABIAmAAAAAAAAACqAAAAAYIAAgUBKAoAAAAPrYfKbe/jRoW5xDxHeoxC1gBmfWiS5+iX4OAN4xBKG/IFPwfH3agtPEia6YnhsADTVQBSAFMAQQAtAE0ASQBOAE8AUgBaAGEAcABoAG8AZABMAEkARwBIAFQAQwBJAFQAWQA=" + .equals(authorization)) { + httpResponse.setStatus(200); + } else { + httpResponse.setStatus(401); + } + + httpResponse.setContentLength(0); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/proxy/CustomHeaderProxyTest.java b/client/src/test/java/org/asynchttpclient/proxy/CustomHeaderProxyTest.java new file mode 100644 index 0000000000..3448bcae7e --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/proxy/CustomHeaderProxyTest.java @@ -0,0 +1,127 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.proxy; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.Response; +import org.asynchttpclient.request.body.generator.ByteArrayBodyGenerator; +import org.asynchttpclient.test.EchoHandler; +import org.asynchttpclient.util.HttpConstants; +import org.eclipse.jetty.proxy.ConnectHandler; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.post; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_BYTES; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * Proxy usage tests. + */ +public class CustomHeaderProxyTest extends AbstractBasicTest { + + private Server server2; + + private static final String customHeaderName = "Custom-Header"; + private static final String customHeaderValue = "Custom-Value"; + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ProxyHandler(customHeaderName, customHeaderValue); + } + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(configureHandler()); + server.start(); + port1 = connector.getLocalPort(); + + server2 = new Server(); + ServerConnector connector2 = addHttpsConnector(server2); + server2.setHandler(new EchoHandler()); + server2.start(); + port2 = connector2.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + server.stop(); + server2.stop(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testHttpProxy() throws Exception { + AsyncHttpClientConfig config = config() + .setFollowRedirect(true) + .setProxyServer( + proxyServer("localhost", port1) + .setCustomHeaders(req -> new DefaultHttpHeaders().add(customHeaderName, customHeaderValue)) + .build() + ) + .setUseInsecureTrustManager(true) + .build(); + try (AsyncHttpClient asyncHttpClient = asyncHttpClient(config)) { + Response r = asyncHttpClient.executeRequest(post(getTargetUrl2()).setBody(new ByteArrayBodyGenerator(LARGE_IMAGE_BYTES))).get(); + assertEquals(200, r.getStatusCode()); + } + } + + public static class ProxyHandler extends ConnectHandler { + String customHeaderName; + String customHeaderValue; + + public ProxyHandler(String customHeaderName, String customHeaderValue) { + this.customHeaderName = customHeaderName; + this.customHeaderValue = customHeaderValue; + } + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if (HttpConstants.Methods.CONNECT.equalsIgnoreCase(request.getMethod())) { + if (request.getHeader(customHeaderName).equals(customHeaderValue)) { + response.setStatus(HttpServletResponse.SC_OK); + super.handle(s, r, request, response); + } else { + response.setStatus(HttpServletResponse.SC_BAD_REQUEST); + r.setHandled(true); + } + } else { + super.handle(s, r, request, response); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/proxy/HttpsProxyTest.java b/client/src/test/java/org/asynchttpclient/proxy/HttpsProxyTest.java new file mode 100644 index 0000000000..9bd5ca911c --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/proxy/HttpsProxyTest.java @@ -0,0 +1,214 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.proxy; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; + +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.asynchttpclient.proxy.ProxyServer.Builder; +import org.asynchttpclient.request.body.generator.ByteArrayBodyGenerator; +import org.asynchttpclient.test.EchoHandler; +import org.asynchttpclient.util.HttpConstants; +import org.eclipse.jetty.proxy.ConnectHandler; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.post; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_BYTES; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrowsExactly; + +import java.io.IOException; +import java.util.concurrent.ExecutionException; + +/** + * Proxy usage tests. + */ +public class HttpsProxyTest extends AbstractBasicTest { + + private Server server2; + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ProxyHandler(); + } + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(configureHandler()); + server.start(); + port1 = connector.getLocalPort(); + + server2 = new Server(); + ServerConnector connector2 = addHttpsConnector(server2); + server2.setHandler(new EchoHandler()); + server2.start(); + port2 = connector2.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @Override + @AfterEach + public void tearDownGlobal() throws Exception { + server.stop(); + server2.stop(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRequestProxy() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setFollowRedirect(true).setUseInsecureTrustManager(true))) { + RequestBuilder rb = get(getTargetUrl2()).setProxyServer(proxyServer("localhost", port1)); + Response response = client.executeRequest(rb.build()).get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testConfigProxy() throws Exception { + AsyncHttpClientConfig config = config() + .setFollowRedirect(true) + .setProxyServer(proxyServer("localhost", port1).build()) + .setUseInsecureTrustManager(true) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + Response response = client.executeRequest(get(getTargetUrl2())).get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNoDirectRequestBodyWithProxy() throws Exception { + AsyncHttpClientConfig config = config() + .setFollowRedirect(true) + .setProxyServer(proxyServer("localhost", port1).build()) + .setUseInsecureTrustManager(true) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + Response response = client.executeRequest(post(getTargetUrl2()).setBody(new ByteArrayBodyGenerator(LARGE_IMAGE_BYTES))).get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDecompressBodyWithProxy() throws Exception { + AsyncHttpClientConfig config = config() + .setFollowRedirect(true) + .setProxyServer(proxyServer("localhost", port1).build()) + .setUseInsecureTrustManager(true) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + String body = "hello world"; + Response response = client.executeRequest(post(getTargetUrl2()) + .setHeader("X-COMPRESS", "true") + .setBody(body)).get(); + + assertEquals(200, response.getStatusCode()); + assertEquals(body, response.getResponseBody()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPooledConnectionsWithProxy() throws Exception { + try (AsyncHttpClient asyncHttpClient = asyncHttpClient(config().setFollowRedirect(true).setUseInsecureTrustManager(true).setKeepAlive(true))) { + RequestBuilder rb = get(getTargetUrl2()).setProxyServer(proxyServer("localhost", port1)); + + Response response1 = asyncHttpClient.executeRequest(rb.build()).get(); + assertEquals(200, response1.getStatusCode()); + + Response response2 = asyncHttpClient.executeRequest(rb.build()).get(); + assertEquals(200, response2.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testFailedConnectWithProxy() throws Exception { + try (AsyncHttpClient asyncHttpClient = asyncHttpClient(config().setFollowRedirect(true).setUseInsecureTrustManager(true).setKeepAlive(true))) { + Builder proxyServer = proxyServer("localhost", port1); + proxyServer.setCustomHeaders(r -> new DefaultHttpHeaders().set(ProxyHandler.HEADER_FORBIDDEN, "1")); + RequestBuilder rb = get(getTargetUrl2()).setProxyServer(proxyServer); + + Response response1 = asyncHttpClient.executeRequest(rb.build()).get(); + assertEquals(403, response1.getStatusCode()); + + Response response2 = asyncHttpClient.executeRequest(rb.build()).get(); + assertEquals(403, response2.getStatusCode()); + + Response response3 = asyncHttpClient.executeRequest(rb.build()).get(); + assertEquals(403, response3.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testClosedConnectionWithProxy() throws Exception { + try (AsyncHttpClient asyncHttpClient = asyncHttpClient( + config().setFollowRedirect(true).setUseInsecureTrustManager(true).setKeepAlive(true))) { + Builder proxyServer = proxyServer("localhost", port1); + proxyServer.setCustomHeaders(r -> new DefaultHttpHeaders().set(ProxyHandler.HEADER_FORBIDDEN, "2")); + RequestBuilder rb = get(getTargetUrl2()).setProxyServer(proxyServer); + + assertThrowsExactly(ExecutionException.class, () -> asyncHttpClient.executeRequest(rb.build()).get()); + assertThrowsExactly(ExecutionException.class, () -> asyncHttpClient.executeRequest(rb.build()).get()); + assertThrowsExactly(ExecutionException.class, () -> asyncHttpClient.executeRequest(rb.build()).get()); + } + } + + public static class ProxyHandler extends ConnectHandler { + final static String HEADER_FORBIDDEN = "X-REJECT-REQUEST"; + + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if (HttpConstants.Methods.CONNECT.equalsIgnoreCase(request.getMethod())) { + String headerValue = request.getHeader(HEADER_FORBIDDEN); + if (headerValue == null) { + headerValue = ""; + } + switch (headerValue) { + case "1": + response.setStatus(HttpServletResponse.SC_FORBIDDEN); + r.setHandled(true); + return; + case "2": + r.getHttpChannel().getConnection().close(); + r.setHandled(true); + return; + } + } + super.handle(s, r, request, response); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/proxy/NTLMProxyTest.java b/client/src/test/java/org/asynchttpclient/proxy/NTLMProxyTest.java new file mode 100644 index 0000000000..d3e5b54c7d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/proxy/NTLMProxyTest.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.proxy; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Realm; +import org.asynchttpclient.Response; +import org.eclipse.jetty.http.HttpStatus; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.ntlmAuthRealm; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class NTLMProxyTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new NTLMProxyHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void ntlmProxyTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + org.asynchttpclient.Request request = get("http://localhost/").setProxyServer(ntlmProxy()).build(); + Future responseFuture = client.executeRequest(request); + int status = responseFuture.get().getStatusCode(); + assertEquals(200, status); + } + } + + private ProxyServer ntlmProxy() { + Realm realm = ntlmAuthRealm("Zaphod", "Beeblebrox") + .setNtlmDomain("Ursa-Minor") + .setNtlmHost("LightCity") + .build(); + return proxyServer("localhost", port2).setRealm(realm).build(); + } + + public static class NTLMProxyHandler extends AbstractHandler { + + private final AtomicInteger state = new AtomicInteger(); + + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + String authorization = httpRequest.getHeader("Proxy-Authorization"); + boolean asExpected = false; + + switch (state.getAndIncrement()) { + case 0: + if (authorization == null) { + httpResponse.setStatus(HttpStatus.PROXY_AUTHENTICATION_REQUIRED_407); + httpResponse.setHeader("Proxy-Authenticate", "NTLM"); + asExpected = true; + } + break; + case 1: + if ("NTLM TlRMTVNTUAABAAAAAYIIogAAAAAoAAAAAAAAACgAAAAFASgKAAAADw==".equals(authorization)) { + httpResponse.setStatus(HttpStatus.PROXY_AUTHENTICATION_REQUIRED_407); + httpResponse.setHeader("Proxy-Authenticate", "NTLM TlRMTVNTUAACAAAAAAAAACgAAAABggAAU3J2Tm9uY2UAAAAAAAAAAA=="); + asExpected = true; + } + break; + case 2: + if ("NTLM TlRMTVNTUAADAAAAGAAYAEgAAAAYABgAYAAAABQAFAB4AAAADAAMAIwAAAASABIAmAAAAAAAAACqAAAAAYIAAgUBKAoAAAAPrYfKbe/jRoW5xDxHeoxC1gBmfWiS5+iX4OAN4xBKG/IFPwfH3agtPEia6YnhsADTVQBSAFMAQQAtAE0ASQBOAE8AUgBaAGEAcABoAG8AZABMAEkARwBIAFQAQwBJAFQAWQA=" + .equals(authorization)) { + httpResponse.setStatus(HttpStatus.OK_200); + asExpected = true; + } + break; + default: + } + + if (!asExpected) { + httpResponse.setStatus(HttpStatus.FORBIDDEN_403); + } + httpResponse.setContentLength(0); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/proxy/ProxyTest.java b/client/src/test/java/org/asynchttpclient/proxy/ProxyTest.java new file mode 100644 index 0000000000..14da96360f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/proxy/ProxyTest.java @@ -0,0 +1,355 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.proxy; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandler; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Request; +import org.asynchttpclient.Response; +import org.asynchttpclient.config.AsyncHttpClientConfigDefaults; +import org.asynchttpclient.config.AsyncHttpClientConfigHelper; +import org.asynchttpclient.testserver.SocksProxy; +import org.asynchttpclient.util.ProxyUtils; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.net.ConnectException; +import java.net.InetSocketAddress; +import java.net.Proxy; +import java.net.ProxySelector; +import java.net.SocketAddress; +import java.net.URI; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static io.netty.handler.codec.http.HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.get; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Proxy usage tests. + * + * @author Hubert Iwaniuk + */ +public class ProxyTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ProxyHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRequestLevelProxy() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + String target = "http://localhost:1234/"; + Future f = client.prepareGet(target).setProxyServer(proxyServer("localhost", port1)).execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(HttpServletResponse.SC_OK, resp.getStatusCode()); + assertEquals("/", resp.getHeader("target")); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void asyncDoPostProxyTest() throws Throwable { + try (AsyncHttpClient client = asyncHttpClient(config().setProxyServer(proxyServer("localhost", port2).build()))) { + HttpHeaders h = new DefaultHttpHeaders(); + h.add(CONTENT_TYPE, APPLICATION_X_WWW_FORM_URLENCODED); + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < 5; i++) { + sb.append("param_").append(i).append("=value_").append(i).append('&'); + } + sb.setLength(sb.length() - 1); + + Response response = client.preparePost(getTargetUrl()) + .setHeaders(h) + .setBody(sb.toString()) + .execute(new AsyncCompletionHandler() { + @Override + public Response onCompleted(Response response) { + return response; + } + + @Override + public void onThrowable(Throwable t) { + } + }).get(); + + assertEquals(200, response.getStatusCode()); + assertEquals(APPLICATION_X_WWW_FORM_URLENCODED.toString(), response.getHeader("X-" + CONTENT_TYPE)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGlobalProxy() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setProxyServer(proxyServer("localhost", port1)))) { + String target = "http://localhost:1234/"; + Future f = client.prepareGet(target).execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testBothProxies() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setProxyServer(proxyServer("localhost", port1 - 1)))) { + String target = "http://localhost:1234/"; + Future f = client.prepareGet(target).setProxyServer(proxyServer("localhost", port1)).execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNonProxyHost() { + // // should avoid, it's in non-proxy hosts + Request req = get("http://somewhere.com/foo").build(); + ProxyServer proxyServer = proxyServer("localhost", 1234).setNonProxyHost("somewhere.com").build(); + assertTrue(proxyServer.isIgnoredForHost(req.getUri().getHost())); + // + // // should avoid, it's in non-proxy hosts (with "*") + req = get("http://sub.somewhere.com/foo").build(); + proxyServer = proxyServer("localhost", 1234).setNonProxyHost("*.somewhere.com").build(); + assertTrue(proxyServer.isIgnoredForHost(req.getUri().getHost())); + + // should use it + req = get("http://sub.somewhere.com/foo").build(); + proxyServer = proxyServer("localhost", 1234).setNonProxyHost("*.somewhere.com").build(); + assertTrue(proxyServer.isIgnoredForHost(req.getUri().getHost())); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNonProxyHostsRequestOverridesConfig() throws Exception { + ProxyServer configProxy = proxyServer("localhost", port1 - 1).build(); + ProxyServer requestProxy = proxyServer("localhost", port1).setNonProxyHost("localhost").build(); + + try (AsyncHttpClient client = asyncHttpClient(config().setProxyServer(configProxy))) { + client.prepareGet("http://localhost:1234/").setProxyServer(requestProxy).execute().get(); + } catch (Exception ex) { + assertInstanceOf(ConnectException.class, ex.getCause()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRequestNonProxyHost() throws Exception { + ProxyServer proxy = proxyServer("localhost", port1 - 1).setNonProxyHost("localhost").build(); + try (AsyncHttpClient client = asyncHttpClient()) { + String target = "http://localhost/" + port1 + '/'; + Future f = client.prepareGet(target).setProxyServer(proxy).execute(); + Response resp = f.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void runSequentiallyBecauseNotThreadSafe() throws Exception { + testProxyProperties(); + testIgnoreProxyPropertiesByDefault(); + testProxyActivationProperty(); + testWildcardNonProxyHosts(); + testUseProxySelector(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testProxyProperties() throws IOException, ExecutionException, TimeoutException, InterruptedException { + // FIXME not threadsafe! + Properties originalProps = new Properties(); + originalProps.putAll(System.getProperties()); + System.setProperty(ProxyUtils.PROXY_HOST, "127.0.0.1"); + System.setProperty(ProxyUtils.PROXY_PORT, String.valueOf(port1)); + System.setProperty(ProxyUtils.PROXY_NONPROXYHOSTS, "localhost"); + AsyncHttpClientConfigHelper.reloadProperties(); + + try (AsyncHttpClient client = asyncHttpClient(config().setUseProxyProperties(true))) { + String proxifiedtarget = "http://127.0.0.1:1234/"; + Future responseFuture = client.prepareGet(proxifiedtarget).execute(); + Response resp = responseFuture.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + + String nonProxifiedtarget = "http://localhost:1234/"; + final Future secondResponseFuture = client.prepareGet(nonProxifiedtarget).execute(); + + assertThrows(Exception.class, () -> secondResponseFuture.get(3, TimeUnit.SECONDS)); + } finally { + System.setProperties(originalProps); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIgnoreProxyPropertiesByDefault() throws IOException, TimeoutException, InterruptedException { + // FIXME not threadsafe! + Properties originalProps = new Properties(); + originalProps.putAll(System.getProperties()); + System.setProperty(ProxyUtils.PROXY_HOST, "localhost"); + System.setProperty(ProxyUtils.PROXY_PORT, String.valueOf(port1)); + System.setProperty(ProxyUtils.PROXY_NONPROXYHOSTS, "localhost"); + AsyncHttpClientConfigHelper.reloadProperties(); + + try (AsyncHttpClient client = asyncHttpClient()) { + String target = "http://localhost:1234/"; + final Future responseFuture = client.prepareGet(target).execute(); + assertThrows(Exception.class, () -> responseFuture.get(3, TimeUnit.SECONDS)); + } finally { + System.setProperties(originalProps); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testProxyActivationProperty() throws IOException, ExecutionException, TimeoutException, InterruptedException { + // FIXME not threadsafe! + Properties originalProps = new Properties(); + originalProps.putAll(System.getProperties()); + System.setProperty(ProxyUtils.PROXY_HOST, "127.0.0.1"); + System.setProperty(ProxyUtils.PROXY_PORT, String.valueOf(port1)); + System.setProperty(ProxyUtils.PROXY_NONPROXYHOSTS, "localhost"); + System.setProperty(AsyncHttpClientConfigDefaults.ASYNC_CLIENT_CONFIG_ROOT + "useProxyProperties", "true"); + AsyncHttpClientConfigHelper.reloadProperties(); + + try (AsyncHttpClient client = asyncHttpClient()) { + String proxifiedTarget = "http://127.0.0.1:1234/"; + Future responseFuture = client.prepareGet(proxifiedTarget).execute(); + Response resp = responseFuture.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + + String nonProxifiedTarget = "http://localhost:1234/"; + Future secondResponseFuture = client.prepareGet(nonProxifiedTarget).execute(); + assertThrows(Exception.class, () -> secondResponseFuture.get(3, TimeUnit.SECONDS)); + } finally { + System.setProperties(originalProps); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWildcardNonProxyHosts() throws IOException, TimeoutException, InterruptedException { + // FIXME not threadsafe! + Properties originalProps = new Properties(); + originalProps.putAll(System.getProperties()); + System.setProperty(ProxyUtils.PROXY_HOST, "127.0.0.1"); + System.setProperty(ProxyUtils.PROXY_PORT, String.valueOf(port1)); + System.setProperty(ProxyUtils.PROXY_NONPROXYHOSTS, "127.*"); + AsyncHttpClientConfigHelper.reloadProperties(); + + try (AsyncHttpClient client = asyncHttpClient(config().setUseProxyProperties(true))) { + String nonProxifiedTarget = "http://127.0.0.1:1234/"; + Future secondResponseFuture = client.prepareGet(nonProxifiedTarget).execute(); + assertThrows(Exception.class, () -> secondResponseFuture.get(3, TimeUnit.SECONDS)); + } finally { + System.setProperties(originalProps); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUseProxySelector() throws IOException, ExecutionException, TimeoutException, InterruptedException { + ProxySelector originalProxySelector = ProxySelector.getDefault(); + ProxySelector.setDefault(new ProxySelector() { + @Override + public List select(URI uri) { + if ("127.0.0.1".equals(uri.getHost())) { + return List.of(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", port1))); + } else { + return Collections.singletonList(Proxy.NO_PROXY); + } + } + + @Override + public void connectFailed(URI uri, SocketAddress sa, IOException ioe) { + // NO-OP + } + }); + + try (AsyncHttpClient client = asyncHttpClient(config().setUseProxySelector(true))) { + String proxifiedTarget = "http://127.0.0.1:1234/"; + Future responseFuture = client.prepareGet(proxifiedTarget).execute(); + Response resp = responseFuture.get(3, TimeUnit.SECONDS); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getHeader("target"), "/"); + + String nonProxifiedTarget = "http://localhost:1234/"; + Future secondResponseFuture = client.prepareGet(nonProxifiedTarget).execute(); + assertThrows(Exception.class, () -> secondResponseFuture.get(3, TimeUnit.SECONDS)); + } finally { + // FIXME not threadsafe + ProxySelector.setDefault(originalProxySelector); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void runSocksProxy() throws Exception { + new Thread(() -> { + try { + new SocksProxy(60000); + } catch (IOException e) { + logger.error("Failed to establish SocksProxy", e); + } + }).start(); + + try (AsyncHttpClient client = asyncHttpClient()) { + String target = "http://localhost/" + port1 + '/'; + Future f = client.prepareGet(target) + .setProxyServer(new ProxyServer.Builder("localhost", 8000).setProxyType(ProxyType.SOCKS_V4)) + .execute(); + + assertEquals(200, f.get(60, TimeUnit.SECONDS).getStatusCode()); + } + } + + public static class ProxyHandler extends AbstractHandler { + + @Override + public void handle(String s, org.eclipse.jetty.server.Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if ("GET".equalsIgnoreCase(request.getMethod())) { + response.addHeader("target", r.getHttpURI().getPath()); + response.setStatus(HttpServletResponse.SC_OK); + } else if ("POST".equalsIgnoreCase(request.getMethod())) { + response.addHeader("X-" + CONTENT_TYPE, APPLICATION_X_WWW_FORM_URLENCODED.toString()); + } else { + response.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED); + } + r.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/BodyChunkTest.java b/client/src/test/java/org/asynchttpclient/request/body/BodyChunkTest.java new file mode 100644 index 0000000000..b33eb382ed --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/BodyChunkTest.java @@ -0,0 +1,61 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.RequestBuilder; +import org.asynchttpclient.Response; +import org.asynchttpclient.request.body.generator.InputStreamBodyGenerator; + +import java.io.ByteArrayInputStream; +import java.time.Duration; +import java.util.concurrent.Future; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.post; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class BodyChunkTest extends AbstractBasicTest { + + private static final String MY_MESSAGE = "my message"; + + @RepeatedIfExceptionsTest(repeats = 5) + public void negativeContentTypeTest() throws Exception { + + AsyncHttpClientConfig config = config() + .setConnectTimeout(Duration.ofMillis(100)) + .setMaxConnections(50) + .setRequestTimeout(Duration.ofMinutes(5)) + .build(); + + try (AsyncHttpClient client = asyncHttpClient(config)) { + RequestBuilder requestBuilder = post(getTargetUrl()) + .setHeader("Content-Type", "message/rfc822") + .setBody(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes()))); + + Future future = client.executeRequest(requestBuilder.build()); + + System.out.println("waiting for response"); + Response response = future.get(); + assertEquals(200, response.getStatusCode()); + assertEquals(MY_MESSAGE, response.getResponseBody()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/ChunkingTest.java b/client/src/test/java/org/asynchttpclient/request/body/ChunkingTest.java new file mode 100755 index 0000000000..8fc32e08d2 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/ChunkingTest.java @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.DefaultAsyncHttpClientConfig; +import org.asynchttpclient.ListenableFuture; +import org.asynchttpclient.Request; +import org.asynchttpclient.Response; +import org.asynchttpclient.request.body.generator.FeedableBodyGenerator; +import org.asynchttpclient.request.body.generator.InputStreamBodyGenerator; +import org.asynchttpclient.request.body.generator.UnboundedQueueFeedableBodyGenerator; + +import java.io.BufferedInputStream; +import java.io.InputStream; +import java.nio.file.Files; +import java.time.Duration; +import java.util.concurrent.ExecutionException; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.post; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_BYTES; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_FILE; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +public class ChunkingTest extends AbstractBasicTest { + + // So we can just test the returned data is the image, + // and doesn't contain the chunked delimiters. + @RepeatedIfExceptionsTest(repeats = 5) + public void testBufferLargerThanFileWithStreamBodyGenerator() throws Throwable { + doTestWithInputStreamBodyGenerator(new BufferedInputStream(Files.newInputStream(LARGE_IMAGE_FILE.toPath()), 400000)); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testBufferSmallThanFileWithStreamBodyGenerator() throws Throwable { + doTestWithInputStreamBodyGenerator(new BufferedInputStream(Files.newInputStream(LARGE_IMAGE_FILE.toPath()))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDirectFileWithStreamBodyGenerator() throws Throwable { + doTestWithInputStreamBodyGenerator(Files.newInputStream(LARGE_IMAGE_FILE.toPath())); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDirectFileWithFeedableBodyGenerator() throws Throwable { + doTestWithFeedableBodyGenerator(Files.newInputStream(LARGE_IMAGE_FILE.toPath())); + } + + private void doTestWithInputStreamBodyGenerator(InputStream is) throws Throwable { + try { + try (AsyncHttpClient c = asyncHttpClient(httpClientBuilder())) { + ListenableFuture responseFuture = c.executeRequest(post(getTargetUrl()).setBody(new InputStreamBodyGenerator(is))); + waitForAndAssertResponse(responseFuture); + } + } finally { + is.close(); + } + } + + private void doTestWithFeedableBodyGenerator(InputStream is) throws Throwable { + try { + try (AsyncHttpClient c = asyncHttpClient(httpClientBuilder())) { + final FeedableBodyGenerator feedableBodyGenerator = new UnboundedQueueFeedableBodyGenerator(); + Request r = post(getTargetUrl()).setBody(feedableBodyGenerator).build(); + ListenableFuture responseFuture = c.executeRequest(r); + feed(feedableBodyGenerator, is); + waitForAndAssertResponse(responseFuture); + } + } finally { + is.close(); + } + } + + private static void feed(FeedableBodyGenerator feedableBodyGenerator, InputStream is) throws Exception { + try (InputStream inputStream = is) { + byte[] buffer = new byte[512]; + for (int i; (i = inputStream.read(buffer)) > -1; ) { + byte[] chunk = new byte[i]; + System.arraycopy(buffer, 0, chunk, 0, i); + feedableBodyGenerator.feed(Unpooled.wrappedBuffer(chunk), false); + } + } + feedableBodyGenerator.feed(Unpooled.EMPTY_BUFFER, true); + } + + private static DefaultAsyncHttpClientConfig.Builder httpClientBuilder() { + return config() + .setKeepAlive(true) + .setMaxConnectionsPerHost(1) + .setMaxConnections(1) + .setConnectTimeout(Duration.ofSeconds(1)) + .setRequestTimeout(Duration.ofSeconds(1)) + .setFollowRedirect(true); + } + + private static void waitForAndAssertResponse(ListenableFuture responseFuture) throws InterruptedException, ExecutionException { + Response response = responseFuture.get(); + if (500 == response.getStatusCode()) { + logger.debug("==============\n" + + "500 response from call\n" + + "Headers:" + response.getHeaders() + '\n' + + "==============\n"); + assertEquals(500, response.getStatusCode(), "Should have 500 status code"); + assertTrue(response.getHeader("X-Exception").contains("invalid.chunk.length"), "Should have failed due to chunking"); + fail("HARD Failing the test due to provided InputStreamBodyGenerator, chunking incorrectly:" + response.getHeader("X-Exception")); + } else { + assertArrayEquals(LARGE_IMAGE_BYTES, response.getResponseBodyAsBytes()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/EmptyBodyTest.java b/client/src/test/java/org/asynchttpclient/request/body/EmptyBodyTest.java new file mode 100644 index 0000000000..ca3ac69300 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/EmptyBodyTest.java @@ -0,0 +1,147 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +/** + * Tests case where response doesn't have body. + * + * @author Hubert Iwaniuk + */ +public class EmptyBodyTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new NoBodyResponseHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testEmptyBody() throws IOException { + try (AsyncHttpClient ahc = asyncHttpClient()) { + final AtomicBoolean err = new AtomicBoolean(false); + final LinkedBlockingQueue queue = new LinkedBlockingQueue<>(); + final AtomicBoolean status = new AtomicBoolean(false); + final AtomicInteger headers = new AtomicInteger(0); + final CountDownLatch latch = new CountDownLatch(1); + + ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build(), new AsyncHandler() { + + @Override + public void onThrowable(Throwable t) { + fail("Got throwable.", t); + err.set(true); + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart e) throws Exception { + byte[] bytes = e.getBodyPartBytes(); + + if (bytes.length != 0) { + String s = new String(bytes); + logger.info("got part: {}", s); + logger.warn("Sampling stacktrace.", new Throwable("trace that, we should not get called for empty body.")); + queue.put(s); + } + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus e) { + status.set(true); + return AsyncHandler.State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders e) throws Exception { + if (headers.incrementAndGet() == 2) { + throw new Exception("Analyze this."); + } + return State.CONTINUE; + } + + @Override + public Object onCompleted() { + latch.countDown(); + return null; + } + }); + + try { + assertTrue(latch.await(1, TimeUnit.SECONDS), "Latch failed."); + } catch (InterruptedException e) { + fail("Interrupted.", e); + } + assertFalse(err.get()); + assertEquals(0, queue.size()); + assertTrue(status.get()); + assertEquals(1, headers.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutEmptyBody() throws Exception { + try (AsyncHttpClient ahc = asyncHttpClient()) { + Response response = ahc.preparePut(getTargetUrl()).setBody("String").execute().get(); + + assertNotNull(response); + assertEquals(204, response.getStatusCode()); + assertEquals("", response.getResponseBody()); + assertNotNull(response.getResponseBodyAsStream()); + assertEquals(-1, response.getResponseBodyAsStream().read()); + } + } + + private static class NoBodyResponseHandler extends AbstractHandler { + + @Override + public void handle(String s, Request request, HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException { + + if (!"PUT".equalsIgnoreCase(req.getMethod())) { + resp.setStatus(HttpServletResponse.SC_OK); + } else { + resp.setStatus(204); + } + request.setHandled(true); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/FilePartLargeFileTest.java b/client/src/test/java/org/asynchttpclient/request/body/FilePartLargeFileTest.java new file mode 100644 index 0000000000..4cf1d2ee4e --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/FilePartLargeFileTest.java @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.asynchttpclient.request.body.multipart.FilePart; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.File; +import java.io.IOException; +import java.time.Duration; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_FILE; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class FilePartLargeFileTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest req, HttpServletResponse resp) throws IOException { + + ServletInputStream in = req.getInputStream(); + byte[] b = new byte[8192]; + + int count; + int total = 0; + while ((count = in.read(b)) != -1) { + b = new byte[8192]; + total += count; + } + resp.setStatus(200); + resp.addHeader("X-TRANSFERRED", String.valueOf(total)); + resp.getOutputStream().flush(); + resp.getOutputStream().close(); + + baseRequest.setHandled(true); + } + }; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutImageFile() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + Response response = client.preparePut(getTargetUrl()) + .addBodyPart(new FilePart("test", LARGE_IMAGE_FILE, "application/octet-stream", UTF_8)) + .execute() + .get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutLargeTextFile() throws Exception { + File file = createTempFile(1024 * 1024); + + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + Response response = client.preparePut(getTargetUrl()) + .addBodyPart(new FilePart("test", file, "application/octet-stream", UTF_8)) + .execute() + .get(); + assertEquals(200, response.getStatusCode()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/InputStreamPartLargeFileTest.java b/client/src/test/java/org/asynchttpclient/request/body/InputStreamPartLargeFileTest.java new file mode 100644 index 0000000000..e0fdfcbbdd --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/InputStreamPartLargeFileTest.java @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.asynchttpclient.request.body.multipart.InputStreamPart; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.time.Duration; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.LARGE_IMAGE_FILE; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class InputStreamPartLargeFileTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest req, HttpServletResponse resp) throws IOException { + + ServletInputStream in = req.getInputStream(); + byte[] b = new byte[8192]; + + int count; + int total = 0; + while ((count = in.read(b)) != -1) { + b = new byte[8192]; + total += count; + } + resp.setStatus(200); + resp.addHeader("X-TRANSFERRED", String.valueOf(total)); + resp.getOutputStream().flush(); + resp.getOutputStream().close(); + + baseRequest.setHandled(true); + } + }; + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutImageFile() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + InputStream inputStream = new BufferedInputStream(new FileInputStream(LARGE_IMAGE_FILE)); + Response response = client.preparePut(getTargetUrl()).addBodyPart(new InputStreamPart("test", inputStream, LARGE_IMAGE_FILE.getName(), + LARGE_IMAGE_FILE.length(), "application/octet-stream", UTF_8)).execute().get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutImageFileUnknownSize() throws Exception { + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + InputStream inputStream = new BufferedInputStream(new FileInputStream(LARGE_IMAGE_FILE)); + Response response = client.preparePut(getTargetUrl()).addBodyPart(new InputStreamPart("test", inputStream, LARGE_IMAGE_FILE.getName(), + -1, "application/octet-stream", UTF_8)).execute().get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutLargeTextFile() throws Exception { + File file = createTempFile(1024 * 1024); + InputStream inputStream = new BufferedInputStream(new FileInputStream(file)); + + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + Response response = client.preparePut(getTargetUrl()) + .addBodyPart(new InputStreamPart("test", inputStream, file.getName(), file.length(), + "application/octet-stream", UTF_8)).execute().get(); + assertEquals(200, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutLargeTextFileUnknownSize() throws Exception { + File file = createTempFile(1024 * 1024); + InputStream inputStream = new BufferedInputStream(new FileInputStream(file)); + + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofMinutes(10)))) { + Response response = client.preparePut(getTargetUrl()) + .addBodyPart(new InputStreamPart("test", inputStream, file.getName(), -1, + "application/octet-stream", UTF_8)).execute().get(); + assertEquals(200, response.getStatusCode()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/InputStreamTest.java b/client/src/test/java/org/asynchttpclient/request/body/InputStreamTest.java new file mode 100644 index 0000000000..55cff4323d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/InputStreamTest.java @@ -0,0 +1,108 @@ +/* + * Copyright 2010 Ning, Inc. + * + * This program is licensed to you under the Apache License, version 2.0 + * (the "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaderValues; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_TYPE; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class InputStreamTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new InputStreamHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testInvalidInputStream() throws Exception { + + try (AsyncHttpClient client = asyncHttpClient()) { + HttpHeaders httpHeaders = new DefaultHttpHeaders().add(CONTENT_TYPE, HttpHeaderValues.APPLICATION_X_WWW_FORM_URLENCODED); + + InputStream inputStream = new InputStream() { + + int readAllowed; + + @Override + public int available() { + return 1; // Fake + } + + @Override + public int read() { + int fakeCount = readAllowed++; + if (fakeCount == 0) { + return 'a'; + } else if (fakeCount == 1) { + return 'b'; + } else if (fakeCount == 2) { + return 'c'; + } else { + return -1; + } + } + }; + + Response resp = client.preparePost(getTargetUrl()).setHeaders(httpHeaders).setBody(inputStream).execute().get(); + assertNotNull(resp); + // TODO: 18-11-2022 Revisit + assertEquals(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, resp.getStatusCode()); +// assertEquals(resp.getHeader("X-Param"), "abc"); + } + } + + private static class InputStreamHandler extends AbstractHandler { + @Override + public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + if ("POST".equalsIgnoreCase(request.getMethod())) { + byte[] bytes = new byte[3]; + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + int read = 0; + while (read > -1) { + read = request.getInputStream().read(bytes); + if (read > 0) { + bos.write(bytes, 0, read); + } + } + + response.setStatus(HttpServletResponse.SC_OK); + response.addHeader("X-Param", bos.toString()); + } else { // this handler is to handle POST request + response.sendError(HttpServletResponse.SC_FORBIDDEN); + } + response.getOutputStream().flush(); + response.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/PutByteBufTest.java b/client/src/test/java/org/asynchttpclient/request/body/PutByteBufTest.java new file mode 100644 index 0000000000..3260604d3f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/PutByteBufTest.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.Arrays; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class PutByteBufTest extends AbstractBasicTest { + + private void put(String message) throws Exception { + ByteBuf byteBuf = Unpooled.wrappedBuffer(message.getBytes()); + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofSeconds(2)))) { + Response response = client.preparePut(getTargetUrl()).setBody(byteBuf).execute().get(); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getResponseBody(), message); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutSmallBody() throws Exception { + put("Hello Test"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutBigBody() throws Exception { + byte[] array = new byte[2048]; + Arrays.fill(array, (byte) 97); + String longString = new String(array, StandardCharsets.UTF_8); + + put(longString); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + + @Override + public void handle(String s, Request request, HttpServletRequest httpRequest, HttpServletResponse response) throws IOException { + int size = 1024; + if (request.getContentLength() > 0) { + size = request.getContentLength(); + } + byte[] bytes = new byte[size]; + if (bytes.length > 0) { + final int read = request.getInputStream().read(bytes); + response.getOutputStream().write(bytes, 0, read); + } + + response.setStatus(200); + response.getOutputStream().flush(); + } + }; + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/PutFileTest.java b/client/src/test/java/org/asynchttpclient/request/body/PutFileTest.java new file mode 100644 index 0000000000..30100f6586 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/PutFileTest.java @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.time.Duration; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class PutFileTest extends AbstractBasicTest { + + private void put(int fileSize) throws Exception { + File file = createTempFile(fileSize); + try (AsyncHttpClient client = asyncHttpClient(config().setRequestTimeout(Duration.ofSeconds(2)))) { + Response response = client.preparePut(getTargetUrl()).setBody(file).execute().get(); + assertEquals(response.getStatusCode(), 200); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutLargeFile() throws Exception { + put(1024 * 1024); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPutSmallFile() throws Exception { + put(1024); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new AbstractHandler() { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException { + + InputStream is = baseRequest.getInputStream(); + int read; + do { + // drain upload + read = is.read(); + } while (read >= 0); + + response.setStatus(200); + response.getOutputStream().flush(); + response.getOutputStream().close(); + baseRequest.setHandled(true); + } + }; + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/TransferListenerTest.java b/client/src/test/java/org/asynchttpclient/request/body/TransferListenerTest.java new file mode 100644 index 0000000000..e4cffadd0f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/TransferListenerTest.java @@ -0,0 +1,257 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Response; +import org.asynchttpclient.handler.TransferCompletionHandler; +import org.asynchttpclient.handler.TransferListener; +import org.asynchttpclient.request.body.generator.FileBodyGenerator; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.File; +import java.io.IOException; +import java.time.Duration; +import java.util.Enumeration; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; + +public class TransferListenerTest extends AbstractBasicTest { + + @Override + public AbstractHandler configureHandler() throws Exception { + return new BasicHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicGetTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final AtomicReference throwable = new AtomicReference<>(); + final AtomicReference hSent = new AtomicReference<>(); + final AtomicReference hRead = new AtomicReference<>(); + final AtomicReference bb = new AtomicReference<>(); + final AtomicBoolean completed = new AtomicBoolean(false); + + TransferCompletionHandler tl = new TransferCompletionHandler(); + tl.addTransferListener(new TransferListener() { + + @Override + public void onRequestHeadersSent(HttpHeaders headers) { + hSent.set(headers); + } + + @Override + public void onResponseHeadersReceived(HttpHeaders headers) { + hRead.set(headers); + } + + @Override + public void onBytesReceived(byte[] b) { + if (b.length != 0) { + bb.set(b); + } + } + + @Override + public void onBytesSent(long amount, long current, long total) { + } + + @Override + public void onRequestResponseCompleted() { + completed.set(true); + } + + @Override + public void onThrowable(Throwable t) { + throwable.set(t); + } + }); + + Response response = c.prepareGet(getTargetUrl()).execute(tl).get(); + + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertNotNull(hRead.get()); + assertNotNull(hSent.get()); + assertNull(bb.get()); + assertNull(throwable.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicPutFileTest() throws Exception { + final AtomicReference throwable = new AtomicReference<>(); + final AtomicReference hSent = new AtomicReference<>(); + final AtomicReference hRead = new AtomicReference<>(); + final AtomicInteger bbReceivedLength = new AtomicInteger(0); + final AtomicLong bbSentLength = new AtomicLong(0L); + + final AtomicBoolean completed = new AtomicBoolean(false); + + File file = createTempFile(1024 * 100 * 10); + + long timeout = file.length() / 1000; + + try (AsyncHttpClient client = asyncHttpClient(config().setConnectTimeout(Duration.ofMillis(timeout)))) { + TransferCompletionHandler tl = new TransferCompletionHandler(); + tl.addTransferListener(new TransferListener() { + + @Override + public void onRequestHeadersSent(HttpHeaders headers) { + hSent.set(headers); + } + + @Override + public void onResponseHeadersReceived(HttpHeaders headers) { + hRead.set(headers); + } + + @Override + public void onBytesReceived(byte[] b) { + bbReceivedLength.addAndGet(b.length); + } + + @Override + public void onBytesSent(long amount, long current, long total) { + bbSentLength.addAndGet(amount); + } + + @Override + public void onRequestResponseCompleted() { + completed.set(true); + } + + @Override + public void onThrowable(Throwable t) { + throwable.set(t); + } + }); + + Response response = client.preparePut(getTargetUrl()).setBody(file).execute(tl).get(); + + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertNotNull(hRead.get()); + assertNotNull(hSent.get()); + assertEquals(file.length(), bbReceivedLength.get(), "Number of received bytes incorrect"); + assertEquals(file.length(), bbSentLength.get(), "Number of sent bytes incorrect"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void basicPutFileBodyGeneratorTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final AtomicReference throwable = new AtomicReference<>(); + final AtomicReference hSent = new AtomicReference<>(); + final AtomicReference hRead = new AtomicReference<>(); + final AtomicInteger bbReceivedLength = new AtomicInteger(0); + final AtomicLong bbSentLength = new AtomicLong(0L); + + final AtomicBoolean completed = new AtomicBoolean(false); + + File file = createTempFile(1024 * 100 * 10); + + TransferCompletionHandler tl = new TransferCompletionHandler(); + tl.addTransferListener(new TransferListener() { + + @Override + public void onRequestHeadersSent(HttpHeaders headers) { + hSent.set(headers); + } + + @Override + public void onResponseHeadersReceived(HttpHeaders headers) { + hRead.set(headers); + } + + @Override + public void onBytesReceived(byte[] b) { + bbReceivedLength.addAndGet(b.length); + } + + @Override + public void onBytesSent(long amount, long current, long total) { + bbSentLength.addAndGet(amount); + } + + @Override + public void onRequestResponseCompleted() { + completed.set(true); + } + + @Override + public void onThrowable(Throwable t) { + throwable.set(t); + } + }); + + Response response = client.preparePut(getTargetUrl()).setBody(new FileBodyGenerator(file)).execute(tl).get(); + + assertNotNull(response); + assertEquals(200, response.getStatusCode()); + assertNotNull(hRead.get()); + assertNotNull(hSent.get()); + assertEquals(file.length(), bbReceivedLength.get(), "Number of received bytes incorrect"); + assertEquals(file.length(), bbSentLength.get(), "Number of sent bytes incorrect"); + } + } + + private static class BasicHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + Enumeration e = httpRequest.getHeaderNames(); + String param; + while (e.hasMoreElements()) { + param = e.nextElement().toString(); + httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); + } + + int size = 10 * 1024; + if (httpRequest.getContentLength() > 0) { + size = httpRequest.getContentLength(); + } + byte[] bytes = new byte[size]; + if (bytes.length > 0) { + int read = 0; + while (read != -1) { + read = httpRequest.getInputStream().read(bytes); + if (read > 0) { + httpResponse.getOutputStream().write(bytes, 0, read); + } + } + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/ZeroCopyFileTest.java b/client/src/test/java/org/asynchttpclient/request/body/ZeroCopyFileTest.java new file mode 100644 index 0000000000..374c1e121d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/ZeroCopyFileTest.java @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncCompletionHandler; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.BasicHttpsTest; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.File; +import java.io.IOException; +import java.io.OutputStream; +import java.nio.file.Files; +import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE; +import static org.asynchttpclient.test.TestUtils.SIMPLE_TEXT_FILE_STRING; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Zero copy test which use FileChannel.transfer under the hood . The same SSL test is also covered in {@link BasicHttpsTest} + */ +public class ZeroCopyFileTest extends AbstractBasicTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void zeroCopyPostTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final AtomicBoolean headerSent = new AtomicBoolean(false); + final AtomicBoolean operationCompleted = new AtomicBoolean(false); + + Response resp = client.preparePost("http://localhost/" + port1 + '/').setBody(SIMPLE_TEXT_FILE).execute(new AsyncCompletionHandler() { + + @Override + public State onHeadersWritten() { + headerSent.set(true); + return State.CONTINUE; + } + + @Override + public State onContentWritten() { + operationCompleted.set(true); + return State.CONTINUE; + } + + @Override + public Response onCompleted(Response response) { + return response; + } + }).get(); + + assertNotNull(resp); + assertEquals(HttpServletResponse.SC_OK, resp.getStatusCode()); + assertEquals(SIMPLE_TEXT_FILE_STRING, resp.getResponseBody()); + assertTrue(operationCompleted.get()); + assertTrue(headerSent.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void zeroCopyPutTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + Future f = client.preparePut("http://localhost/" + port1 + '/').setBody(SIMPLE_TEXT_FILE).execute(); + Response resp = f.get(); + assertNotNull(resp); + assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); + assertEquals(resp.getResponseBody(), SIMPLE_TEXT_FILE_STRING); + } + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new ZeroCopyHandler(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void zeroCopyFileTest() throws Exception { + File tmp = new File(System.getProperty("java.io.tmpdir") + File.separator + "zeroCopy.txt"); + tmp.deleteOnExit(); + try (AsyncHttpClient client = asyncHttpClient()) { + try (OutputStream stream = Files.newOutputStream(tmp.toPath())) { + Response resp = client.preparePost("http://localhost/" + port1 + '/').setBody(SIMPLE_TEXT_FILE).execute(new AsyncHandler() { + + @Override + public void onThrowable(Throwable t) { + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { + stream.write(bodyPart.getBodyPartBytes()); + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) { + return State.CONTINUE; + } + + @Override + public Response onCompleted() { + return null; + } + }).get(); + + assertNull(resp); + assertEquals(SIMPLE_TEXT_FILE.length(), tmp.length()); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void zeroCopyFileWithBodyManipulationTest() throws Exception { + File tmp = new File(System.getProperty("java.io.tmpdir") + File.separator + "zeroCopy.txt"); + tmp.deleteOnExit(); + try (AsyncHttpClient client = asyncHttpClient()) { + try (OutputStream stream = Files.newOutputStream(tmp.toPath())) { + Response resp = client.preparePost("http://localhost/" + port1 + '/').setBody(SIMPLE_TEXT_FILE).execute(new AsyncHandler() { + + @Override + public void onThrowable(Throwable t) { + } + + @Override + public State onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { + stream.write(bodyPart.getBodyPartBytes()); + + if (bodyPart.getBodyPartBytes().length == 0) { + return State.ABORT; + } + + return State.CONTINUE; + } + + @Override + public State onStatusReceived(HttpResponseStatus responseStatus) { + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(HttpHeaders headers) { + return State.CONTINUE; + } + + @Override + public Response onCompleted() { + return null; + } + }).get(); + assertNull(resp); + assertEquals(SIMPLE_TEXT_FILE.length(), tmp.length()); + } + } + } + + private static class ZeroCopyHandler extends AbstractHandler { + + @Override + public void handle(String s, Request r, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + int size = 10 * 1024; + if (httpRequest.getContentLength() > 0) { + size = httpRequest.getContentLength(); + } + byte[] bytes = new byte[size]; + if (bytes.length > 0) { + httpRequest.getInputStream().read(bytes); + httpResponse.getOutputStream().write(bytes); + } + + httpResponse.setStatus(200); + httpResponse.getOutputStream().flush(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGeneratorTest.java b/client/src/test/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGeneratorTest.java new file mode 100644 index 0000000000..81da4d7341 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/generator/ByteArrayBodyGeneratorTest.java @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body.generator; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.request.body.Body; +import org.asynchttpclient.request.body.Body.BodyState; + +import java.io.IOException; +import java.util.Random; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * @author Bryan Davis bpd@keynetics.com + */ +public class ByteArrayBodyGeneratorTest { + + private final Random random = new Random(); + private static final int CHUNK_SIZE = 1024 * 8; + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSingleRead() throws IOException { + final int srcArraySize = CHUNK_SIZE - 1; + final byte[] srcArray = new byte[srcArraySize]; + random.nextBytes(srcArray); + + final ByteArrayBodyGenerator babGen = new ByteArrayBodyGenerator(srcArray); + final Body body = babGen.createBody(); + + final ByteBuf chunkBuffer = Unpooled.buffer(CHUNK_SIZE); + + try { + // should take 1 read to get through the srcArray + body.transferTo(chunkBuffer); + assertEquals(srcArraySize, chunkBuffer.readableBytes(), "bytes read"); + chunkBuffer.clear(); + + assertEquals(BodyState.STOP, body.transferTo(chunkBuffer), "body at EOF"); + } finally { + chunkBuffer.release(); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testMultipleReads() throws IOException { + final int srcArraySize = 3 * CHUNK_SIZE + 42; + final byte[] srcArray = new byte[srcArraySize]; + random.nextBytes(srcArray); + + final ByteArrayBodyGenerator babGen = new ByteArrayBodyGenerator(srcArray); + final Body body = babGen.createBody(); + + final ByteBuf chunkBuffer = Unpooled.buffer(CHUNK_SIZE); + + try { + int reads = 0; + int bytesRead = 0; + while (body.transferTo(chunkBuffer) != BodyState.STOP) { + reads += 1; + bytesRead += chunkBuffer.readableBytes(); + chunkBuffer.clear(); + } + assertEquals(4, reads, "reads to drain generator"); + assertEquals(srcArraySize, bytesRead, "bytes read"); + } finally { + chunkBuffer.release(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/generator/FeedableBodyGeneratorTest.java b/client/src/test/java/org/asynchttpclient/request/body/generator/FeedableBodyGeneratorTest.java new file mode 100755 index 0000000000..7c2a3579bf --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/generator/FeedableBodyGeneratorTest.java @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.generator; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.request.body.Body; +import org.asynchttpclient.request.body.Body.BodyState; +import org.junit.jupiter.api.BeforeEach; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class FeedableBodyGeneratorTest { + + private UnboundedQueueFeedableBodyGenerator feedableBodyGenerator; + private TestFeedListener listener; + + @BeforeEach + public void setUp() { + feedableBodyGenerator = new UnboundedQueueFeedableBodyGenerator(); + listener = new TestFeedListener(); + feedableBodyGenerator.setListener(listener); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void feedNotifiesListener() throws Exception { + feedableBodyGenerator.feed(Unpooled.EMPTY_BUFFER, false); + feedableBodyGenerator.feed(Unpooled.EMPTY_BUFFER, true); + assertEquals(2, listener.getCalls()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void readingBytesReturnsFedContentWithoutChunkBoundaries() throws Exception { + byte[] content = "Test123".getBytes(StandardCharsets.US_ASCII); + + ByteBuf source = Unpooled.wrappedBuffer(content); + ByteBuf target = Unpooled.buffer(1); + + try { + feedableBodyGenerator.feed(source, true); + Body body = feedableBodyGenerator.createBody(); + assertArrayEquals("Test123".getBytes(StandardCharsets.US_ASCII), readFromBody(body)); + assertEquals(body.transferTo(target), BodyState.STOP); + } finally { + source.release(); + target.release(); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void returnZeroToSuspendStreamWhenNothingIsInQueue() throws Exception { + byte[] content = "Test123".getBytes(StandardCharsets.US_ASCII); + + ByteBuf source = Unpooled.wrappedBuffer(content); + ByteBuf target = Unpooled.buffer(1); + + try { + feedableBodyGenerator.feed(source, false); + + Body body = feedableBodyGenerator.createBody(); + assertArrayEquals("Test123".getBytes(StandardCharsets.US_ASCII), readFromBody(body)); + assertEquals(body.transferTo(target), BodyState.SUSPEND); + } finally { + source.release(); + target.release(); + } + } + + private static byte[] readFromBody(Body body) throws IOException { + ByteBuf byteBuf = Unpooled.buffer(512); + try { + body.transferTo(byteBuf); + byte[] readBytes = new byte[byteBuf.readableBytes()]; + byteBuf.readBytes(readBytes); + return readBytes; + } finally { + byteBuf.release(); + } + } + + private static class TestFeedListener implements FeedListener { + + private int calls; + + @Override + public void onContentAdded() { + calls++; + } + + @Override + public void onError(Throwable t) { + } + + int getCalls() { + return calls; + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBasicAuthTest.java b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBasicAuthTest.java new file mode 100644 index 0000000000..1941ea5494 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBasicAuthTest.java @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.BasicAuthTest; +import org.asynchttpclient.BoundRequestBuilder; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.function.Function; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.EXPECT; +import static io.netty.handler.codec.http.HttpHeaderValues.APPLICATION_OCTET_STREAM; +import static io.netty.handler.codec.http.HttpHeaderValues.CONTINUE; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.basicAuthRealm; +import static org.asynchttpclient.test.TestUtils.ADMIN; +import static org.asynchttpclient.test.TestUtils.USER; +import static org.asynchttpclient.test.TestUtils.addBasicAuthHandler; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.createTempFile; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class MultipartBasicAuthTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + addBasicAuthHandler(server, configureHandler()); + server.start(); + port1 = connector1.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @Override + public AbstractHandler configureHandler() throws Exception { + return new BasicAuthTest.SimpleHandler(); + } + + private void expectHttpResponse(Function f, int expectedResponseCode) throws Throwable { + File file = createTempFile(1024 * 1024); + + try (AsyncHttpClient client = asyncHttpClient()) { + Response response = f.apply(client.preparePut(getTargetUrl()).addBodyPart(new FilePart("test", file, APPLICATION_OCTET_STREAM.toString(), UTF_8))) + .execute() + .get(); + assertEquals(expectedResponseCode, response.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 3) + public void noRealmCausesServerToCloseSocket() throws Throwable { + expectHttpResponse(rb -> rb, 401); + } + + @RepeatedIfExceptionsTest(repeats = 3) + public void unauthorizedNonPreemptiveRealmCausesServerToCloseSocket() throws Throwable { + expectHttpResponse(rb -> rb.setRealm(basicAuthRealm(USER, "NOT-ADMIN")), 401); + } + + private void expectSuccess(Function f) throws Exception { + File file = createTempFile(1024 * 1024); + + try (AsyncHttpClient client = asyncHttpClient()) { + for (int i = 0; i < 20; i++) { + Response response = f.apply(client.preparePut(getTargetUrl()) + .addBodyPart(new FilePart("test", file, APPLICATION_OCTET_STREAM.toString(), UTF_8))) + .execute().get(); + assertEquals(response.getStatusCode(), 200); + assertEquals(response.getResponseBodyAsBytes().length, Integer.valueOf(response.getHeader("X-" + CONTENT_LENGTH)).intValue()); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void authorizedPreemptiveRealmWorks() throws Exception { + expectSuccess(rb -> rb.setRealm(basicAuthRealm(USER, ADMIN).setUsePreemptiveAuth(true))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void authorizedNonPreemptiveRealmWorksWithExpectContinue() throws Exception { + expectSuccess(rb -> rb.setRealm(basicAuthRealm(USER, ADMIN)).setHeader(EXPECT, CONTINUE)); + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBodyTest.java b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBodyTest.java new file mode 100644 index 0000000000..f31046ea2f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartBodyTest.java @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.handler.codec.http.EmptyHttpHeaders; +import org.asynchttpclient.request.body.Body.BodyState; + +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.ByteBuffer; +import java.nio.channels.WritableByteChannel; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.atomic.AtomicLong; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class MultipartBodyTest { + + private static final List PARTS = new ArrayList<>(); + private static final long MAX_MULTIPART_CONTENT_LENGTH_ESTIMATE; + + static { + try { + PARTS.add(new FilePart("filePart", getTestfile())); + } catch (URISyntaxException e) { + throw new ExceptionInInitializerError(e); + } + PARTS.add(new ByteArrayPart("baPart", "testMultiPart".getBytes(UTF_8), "application/test", UTF_8, "fileName")); + PARTS.add(new StringPart("stringPart", "testString")); + } + + static { + try (MultipartBody dummyBody = buildMultipart()) { + // separator is random + MAX_MULTIPART_CONTENT_LENGTH_ESTIMATE = dummyBody.getContentLength() + 100; + } + } + + private static File getTestfile() throws URISyntaxException { + final ClassLoader cl = MultipartBodyTest.class.getClassLoader(); + final URL url = cl.getResource("textfile.txt"); + assertNotNull(url); + return new File(url.toURI()); + } + + private static MultipartBody buildMultipart() { + List parts = new ArrayList<>(PARTS); + try { + File testFile = getTestfile(); + InputStream inputStream = new BufferedInputStream(new FileInputStream(testFile)); + parts.add(new InputStreamPart("isPart", inputStream, testFile.getName(), testFile.length())); + } catch (URISyntaxException | FileNotFoundException e) { + throw new ExceptionInInitializerError(e); + } + return MultipartUtils.newMultipartBody(parts, EmptyHttpHeaders.INSTANCE); + } + + private static long transferWithCopy(MultipartBody multipartBody, int bufferSize) throws IOException { + long transferred = 0; + final ByteBuf buffer = Unpooled.buffer(bufferSize); + try { + while (multipartBody.transferTo(buffer) != BodyState.STOP) { + transferred += buffer.readableBytes(); + buffer.clear(); + } + return transferred; + } finally { + buffer.release(); + } + } + + private static long transferZeroCopy(MultipartBody multipartBody, int bufferSize) throws IOException { + + final ByteBuffer buffer = ByteBuffer.allocate(bufferSize); + final AtomicLong transferred = new AtomicLong(); + + WritableByteChannel mockChannel = new WritableByteChannel() { + @Override + public boolean isOpen() { + return true; + } + + @Override + public void close() { + } + + @Override + public int write(ByteBuffer src) { + int written = src.remaining(); + transferred.set(transferred.get() + written); + src.position(src.limit()); + return written; + } + }; + + while (transferred.get() < multipartBody.getContentLength()) { + multipartBody.transferTo(mockChannel); + buffer.clear(); + } + return transferred.get(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void transferWithCopy() throws Exception { + for (int bufferLength = 1; bufferLength < MAX_MULTIPART_CONTENT_LENGTH_ESTIMATE + 1; bufferLength++) { + try (MultipartBody multipartBody = buildMultipart()) { + long transferred = transferWithCopy(multipartBody, bufferLength); + assertEquals(multipartBody.getContentLength(), transferred); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void transferZeroCopy() throws Exception { + for (int bufferLength = 1; bufferLength < MAX_MULTIPART_CONTENT_LENGTH_ESTIMATE + 1; bufferLength++) { + try (MultipartBody multipartBody = buildMultipart()) { + long transferred = transferZeroCopy(multipartBody, bufferLength); + assertEquals(multipartBody.getContentLength(), transferred); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartUploadTest.java b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartUploadTest.java new file mode 100644 index 0000000000..4a79e52dce --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/multipart/MultipartUploadTest.java @@ -0,0 +1,429 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.request.body.multipart; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServlet; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.fileupload2.FileItemIterator; +import org.apache.commons.fileupload2.FileItemStream; +import org.apache.commons.fileupload2.FileUploadException; +import org.apache.commons.fileupload2.jaksrvlt.JakSrvltFileUpload; +import org.apache.commons.fileupload2.util.Streams; +import org.apache.commons.io.FileUtils; +import org.apache.commons.io.IOUtils; +import org.asynchttpclient.AbstractBasicTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.Request; +import org.asynchttpclient.Response; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.servlet.ServletHolder; +import org.junit.jupiter.api.BeforeEach; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.BufferedInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.Writer; +import java.nio.file.Files; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.UUID; +import java.util.concurrent.ExecutionException; +import java.util.zip.GZIPInputStream; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.post; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.getClasspathFile; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * @author dominict + */ +public class MultipartUploadTest extends AbstractBasicTest { + + @BeforeEach + public void setUp() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.addServlet(new ServletHolder(new MockMultipartUploadServlet()), "/upload"); + server.setHandler(context); + server.start(); + port1 = connector.getLocalPort(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendingSmallFilesAndByteArray() throws Exception { + String expectedContents = "filecontent: hello"; + String expectedContents2 = "gzipcontent: hello"; + String expectedContents3 = "filecontent: hello2"; + String testResource1 = "textfile.txt"; + String testResource2 = "gzip.txt.gz"; + String testResource3 = "textfile2.txt"; + + File testResource1File = getClasspathFile(testResource1); + File testResource2File = getClasspathFile(testResource2); + File testResource3File = getClasspathFile(testResource3); + InputStream inputStreamFile1 = new BufferedInputStream(new FileInputStream(testResource1File)); + InputStream inputStreamFile2 = new BufferedInputStream(new FileInputStream(testResource2File)); + InputStream inputStreamFile3 = new BufferedInputStream(new FileInputStream(testResource3File)); + + List testFiles = new ArrayList<>(); + testFiles.add(testResource1File); + testFiles.add(testResource2File); + testFiles.add(testResource3File); + testFiles.add(testResource3File); + testFiles.add(testResource2File); + testFiles.add(testResource1File); + + List expected = new ArrayList<>(); + expected.add(expectedContents); + expected.add(expectedContents2); + expected.add(expectedContents3); + expected.add(expectedContents3); + expected.add(expectedContents2); + expected.add(expectedContents); + + List gzipped = new ArrayList<>(); + gzipped.add(false); + gzipped.add(true); + gzipped.add(false); + gzipped.add(false); + gzipped.add(true); + gzipped.add(false); + + File tmpFile = File.createTempFile("textbytearray", ".txt"); + try (OutputStream os = Files.newOutputStream(tmpFile.toPath())) { + IOUtils.write(expectedContents.getBytes(UTF_8), os); + + testFiles.add(tmpFile); + expected.add(expectedContents); + gzipped.add(false); + } + + try (AsyncHttpClient c = asyncHttpClient(config())) { + Request r = post("http://localhost/" + ':' + port1 + "/upload") + .addBodyPart(new FilePart("file1", testResource1File, "text/plain", UTF_8)) + .addBodyPart(new FilePart("file2", testResource2File, "application/x-gzip", null)) + .addBodyPart(new StringPart("Name", "Dominic")) + .addBodyPart(new FilePart("file3", testResource3File, "text/plain", UTF_8)) + .addBodyPart(new StringPart("Age", "3")).addBodyPart(new StringPart("Height", "shrimplike")) + .addBodyPart(new InputStreamPart("inputStream3", inputStreamFile3, testResource3File.getName(), testResource3File.length(), "text/plain", UTF_8)) + .addBodyPart(new InputStreamPart("inputStream2", inputStreamFile2, testResource2File.getName(), testResource2File.length(), "application/x-gzip", null)) + .addBodyPart(new StringPart("Hair", "ridiculous")).addBodyPart(new ByteArrayPart("file4", + expectedContents.getBytes(UTF_8), "text/plain", UTF_8, "bytearray.txt")) + .addBodyPart(new InputStreamPart("inputStream1", inputStreamFile1, testResource1File.getName(), testResource1File.length(), "text/plain", UTF_8)) + .build(); + + Response res = c.executeRequest(r).get(); + + assertEquals(200, res.getStatusCode()); + + testSentFile(expected, testFiles, res, gzipped); + } + } + + private void sendEmptyFile0(boolean disableZeroCopy) throws Exception { + File file = getClasspathFile("empty.txt"); + try (AsyncHttpClient client = asyncHttpClient(config().setDisableZeroCopy(disableZeroCopy))) { + Request r = post("http://localhost/" + ':' + port1 + "/upload") + .addBodyPart(new FilePart("file", file, "text/plain", UTF_8)).build(); + + Response res = client.executeRequest(r).get(); + assertEquals(res.getStatusCode(), 200); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void sendEmptyFile() throws Exception { + sendEmptyFile0(true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void sendEmptyFileZeroCopy() throws Exception { + sendEmptyFile0(false); + } + + private void sendEmptyFileInputStream(boolean disableZeroCopy) throws Exception { + File file = getClasspathFile("empty.txt"); + try (AsyncHttpClient client = asyncHttpClient(config().setDisableZeroCopy(disableZeroCopy)); + InputStream inputStream = new BufferedInputStream(new FileInputStream(file))) { + Request r = post("http://localhost/" + ':' + port1 + "/upload") + .addBodyPart(new InputStreamPart("file", inputStream, file.getName(), file.length(), "text/plain", UTF_8)).build(); + + Response res = client.executeRequest(r).get(); + assertEquals(200, res.getStatusCode()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendEmptyFileInputStream() throws Exception { + sendEmptyFileInputStream(true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendEmptyFileInputStreamZeroCopy() throws Exception { + sendEmptyFileInputStream(false); + } + + private void sendFileInputStream(boolean useContentLength, boolean disableZeroCopy) throws Exception { + File file = getClasspathFile("textfile.txt"); + try (AsyncHttpClient c = asyncHttpClient(config().setDisableZeroCopy(disableZeroCopy)); + InputStream inputStream = new BufferedInputStream(new FileInputStream(file))) { + + InputStreamPart part; + if (useContentLength) { + part = new InputStreamPart("file", inputStream, file.getName(), file.length()); + } else { + part = new InputStreamPart("file", inputStream, file.getName()); + } + Request r = post("http://localhost/" + ':' + port1 + "/upload").addBodyPart(part).build(); + + Response res = c.executeRequest(r).get(); + assertEquals(200, res.getStatusCode()); + } catch (ExecutionException ex) { + ex.getCause().printStackTrace(); + throw ex; + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendFileInputStreamUnknownContentLength() throws Exception { + sendFileInputStream(false, true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendFileInputStreamZeroCopyUnknownContentLength() throws Exception { + sendFileInputStream(false, false); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendFileInputStreamKnownContentLength() throws Exception { + sendFileInputStream(true, true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSendFileInputStreamZeroCopyKnownContentLength() throws Exception { + sendFileInputStream(true, false); + } + + /** + * Test that the files were sent, based on the response from the servlet + */ + private static void testSentFile(List expectedContents, List sourceFiles, Response r, + List deflate) throws IOException { + String content = r.getResponseBody(); + assertNotNull(content); + logger.debug(content); + + String[] contentArray = content.split("\\|\\|"); + // TODO: this fail on win32 + assertEquals(contentArray.length, 2); + + String tmpFiles = contentArray[1]; + assertNotNull(tmpFiles); + assertTrue(tmpFiles.trim().length() > 2); + tmpFiles = tmpFiles.substring(1, tmpFiles.length() - 1); + + String[] responseFiles = tmpFiles.split(","); + assertNotNull(responseFiles); + assertEquals(responseFiles.length, sourceFiles.size()); + + logger.debug(Arrays.toString(responseFiles)); + + int i = 0; + for (File sourceFile : sourceFiles) { + + File tmp = null; + try { + + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + byte[] sourceBytes; + try (InputStream instream = Files.newInputStream(sourceFile.toPath())) { + byte[] buf = new byte[8092]; + int len; + while ((len = instream.read(buf)) > 0) { + baos.write(buf, 0, len); + } + logger.debug("================"); + logger.debug("Length of file: " + baos.toByteArray().length); + logger.debug("Contents: " + Arrays.toString(baos.toByteArray())); + logger.debug("================"); + System.out.flush(); + sourceBytes = baos.toByteArray(); + } + + tmp = new File(responseFiles[i].trim()); + logger.debug("=============================="); + logger.debug(tmp.getAbsolutePath()); + logger.debug("=============================="); + System.out.flush(); + assertTrue(tmp.exists()); + + byte[] bytes; + try (InputStream instream = Files.newInputStream(tmp.toPath())) { + ByteArrayOutputStream baos2 = new ByteArrayOutputStream(); + byte[] buf = new byte[8092]; + int len; + while ((len = instream.read(buf)) > 0) { + baos2.write(buf, 0, len); + } + bytes = baos2.toByteArray(); + assertArrayEquals(bytes, sourceBytes); + } + + if (!deflate.get(i)) { + String helloString = new String(bytes); + assertEquals(helloString, expectedContents.get(i)); + } else { + try (InputStream instream = Files.newInputStream(tmp.toPath())) { + ByteArrayOutputStream baos3 = new ByteArrayOutputStream(); + GZIPInputStream deflater = new GZIPInputStream(instream); + try { + byte[] buf3 = new byte[8092]; + int len3; + while ((len3 = deflater.read(buf3)) > 0) { + baos3.write(buf3, 0, len3); + } + } finally { + deflater.close(); + } + + String helloString = baos3.toString(); + + assertEquals(expectedContents.get(i), helloString); + } + } + } catch (Exception e) { + throw e; + } finally { + if (tmp != null) { + FileUtils.deleteQuietly(tmp); + } + i++; + } + } + } + + + public static class MockMultipartUploadServlet extends HttpServlet { + + private static final Logger LOGGER = LoggerFactory.getLogger(MockMultipartUploadServlet.class); + + private static final long serialVersionUID = 1L; + private int filesProcessed; + private int stringsProcessed; + + MockMultipartUploadServlet() { + stringsProcessed = 0; + } + + synchronized void resetFilesProcessed() { + filesProcessed = 0; + } + + private synchronized int incrementFilesProcessed() { + return ++filesProcessed; + } + + int getFilesProcessed() { + return filesProcessed; + } + + synchronized void resetStringsProcessed() { + stringsProcessed = 0; + } + + private synchronized int incrementStringsProcessed() { + return ++stringsProcessed; + + } + + public int getStringsProcessed() { + return stringsProcessed; + } + + @Override + public void service(HttpServletRequest request, HttpServletResponse response) throws IOException { + // Check that we have a file upload request + boolean isMultipart = JakSrvltFileUpload.isMultipartContent(request); + if (isMultipart) { + List files = new ArrayList<>(); + JakSrvltFileUpload upload = new JakSrvltFileUpload(); + // Parse the request + FileItemIterator iter; + try { + iter = upload.getItemIterator(request); + while (iter.hasNext()) { + FileItemStream item = iter.next(); + String name = item.getFieldName(); + try (InputStream stream = item.openStream()) { + + if (item.isFormField()) { + LOGGER.debug("Form field " + name + " with value " + Streams.asString(stream) + " detected."); + incrementStringsProcessed(); + } else { + LOGGER.debug("File field " + name + " with file name " + item.getName() + " detected."); + // Process the input stream + File tmpFile = File.createTempFile(UUID.randomUUID() + "_MockUploadServlet", + ".tmp"); + tmpFile.deleteOnExit(); + try (OutputStream os = Files.newOutputStream(tmpFile.toPath())) { + byte[] buffer = new byte[4096]; + int bytesRead; + while ((bytesRead = stream.read(buffer)) != -1) { + os.write(buffer, 0, bytesRead); + } + incrementFilesProcessed(); + files.add(tmpFile.getAbsolutePath()); + } + } + } + } + } catch (FileUploadException e) { + // + } + try (Writer w = response.getWriter()) { + w.write(Integer.toString(getFilesProcessed())); + resetFilesProcessed(); + resetStringsProcessed(); + w.write("||"); + w.write(files.toString()); + } + } else { + try (Writer w = response.getWriter()) { + w.write(Integer.toString(getFilesProcessed())); + resetFilesProcessed(); + resetStringsProcessed(); + w.write("||"); + } + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/request/body/multipart/part/MultipartPartTest.java b/client/src/test/java/org/asynchttpclient/request/body/multipart/part/MultipartPartTest.java new file mode 100644 index 0000000000..a5711015de --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/request/body/multipart/part/MultipartPartTest.java @@ -0,0 +1,279 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.request.body.multipart.part; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufAllocator; +import io.netty.handler.codec.http.DefaultHttpHeaders; +import io.netty.handler.codec.http.HttpHeaders; +import org.apache.commons.io.FileUtils; +import org.asynchttpclient.request.body.multipart.FileLikePart; +import org.asynchttpclient.request.body.multipart.MultipartBody; +import org.asynchttpclient.request.body.multipart.MultipartUtils; +import org.asynchttpclient.request.body.multipart.Part; +import org.asynchttpclient.request.body.multipart.StringPart; +import org.asynchttpclient.request.body.multipart.part.PartVisitor.CounterPartVisitor; +import org.asynchttpclient.test.TestUtils; + +import java.nio.channels.WritableByteChannel; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class MultipartPartTest { + + public static final byte[] EMPTY_BYTE_ARRAY = new byte[0]; + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitStart() { + TestFileLikePart fileLikePart = new TestFileLikePart("Name"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, new byte[10])) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitStart(counterVisitor); + assertEquals(12, counterVisitor.getCount(), "CounterPartVisitor count for visitStart should match EXTRA_BYTES count plus boundary bytes count"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitStartZeroSizedByteArray() { + TestFileLikePart fileLikePart = new TestFileLikePart("Name"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitStart(counterVisitor); + assertEquals(2, counterVisitor.getCount(), "CounterPartVisitor count for visitStart should match EXTRA_BYTES count when boundary byte array is of size zero"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitDispositionHeaderWithoutFileName() { + TestFileLikePart fileLikePart = new TestFileLikePart("Name"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitDispositionHeader(counterVisitor); + assertEquals(45, counterVisitor.getCount(), "CounterPartVisitor count for visitDispositionHeader should be equal to " + + "CRLF_BYTES length + CONTENT_DISPOSITION_BYTES length + part name length when file name is not specified"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitDispositionHeaderWithFileName() { + TestFileLikePart fileLikePart = new TestFileLikePart("baPart", null, null, null, null, "fileName"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitDispositionHeader(counterVisitor); + assertEquals(68, counterVisitor.getCount(), "CounterPartVisitor count for visitDispositionHeader should be equal to " + + "CRLF_BYTES length + CONTENT_DISPOSITION_BYTES length + part name length + file name length when" + " both part name and file name are present"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitDispositionHeaderWithoutName() { + // with fileName + TestFileLikePart fileLikePart = new TestFileLikePart(null, null, null, null, null, "fileName"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitDispositionHeader(counterVisitor); + assertEquals(53, counterVisitor.getCount(), "CounterPartVisitor count for visitDispositionHeader should be equal to " + + "CRLF_BYTES length + CONTENT_DISPOSITION_BYTES length + file name length when part name is not specified"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitContentTypeHeaderWithCharset() { + TestFileLikePart fileLikePart = new TestFileLikePart(null, "application/test", UTF_8, null, null); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitContentTypeHeader(counterVisitor); + assertEquals(47, counterVisitor.getCount(), "CounterPartVisitor count for visitContentTypeHeader should be equal to " + + "CRLF_BYTES length + CONTENT_TYPE_BYTES length + contentType length + charset length"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitContentTypeHeaderWithoutCharset() { + TestFileLikePart fileLikePart = new TestFileLikePart(null, "application/test"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitContentTypeHeader(counterVisitor); + assertEquals(32, counterVisitor.getCount(), "CounterPartVisitor count for visitContentTypeHeader should be equal to " + + "CRLF_BYTES length + CONTENT_TYPE_BYTES length + contentType length when charset is not specified"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitTransferEncodingHeader() { + TestFileLikePart fileLikePart = new TestFileLikePart(null, null, null, null, "transferEncoding"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitTransferEncodingHeader(counterVisitor); + assertEquals(45, counterVisitor.getCount(), "CounterPartVisitor count for visitTransferEncodingHeader should be equal to " + + "CRLF_BYTES length + CONTENT_TRANSFER_ENCODING_BYTES length + transferEncoding length"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitContentIdHeader() { + TestFileLikePart fileLikePart = new TestFileLikePart(null, null, null, "contentId"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitContentIdHeader(counterVisitor); + assertEquals(23, counterVisitor.getCount(), "CounterPartVisitor count for visitContentIdHeader should be equal to" + + "CRLF_BYTES length + CONTENT_ID_BYTES length + contentId length"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitCustomHeadersWhenNoCustomHeaders() { + TestFileLikePart fileLikePart = new TestFileLikePart(null); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitCustomHeaders(counterVisitor); + assertEquals(0, counterVisitor.getCount(), "CounterPartVisitor count for visitCustomHeaders should be zero for visitCustomHeaders " + + "when there are no custom headers"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitCustomHeaders() { + TestFileLikePart fileLikePart = new TestFileLikePart(null); + fileLikePart.addCustomHeader("custom-header", "header-value"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitCustomHeaders(counterVisitor); + assertEquals(29, counterVisitor.getCount(), "CounterPartVisitor count for visitCustomHeaders should include the length of the custom headers"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitEndOfHeaders() { + TestFileLikePart fileLikePart = new TestFileLikePart(null); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitEndOfHeaders(counterVisitor); + assertEquals(4, counterVisitor.getCount(), "CounterPartVisitor count for visitEndOfHeaders should be equal to 4"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitPreContent() { + TestFileLikePart fileLikePart = new TestFileLikePart("Name", "application/test", UTF_8, "contentId", "transferEncoding", "fileName"); + fileLikePart.addCustomHeader("custom-header", "header-value"); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitPreContent(counterVisitor); + assertEquals(216, counterVisitor.getCount(), "CounterPartVisitor count for visitPreContent should " + "be equal to the sum of the lengths of precontent"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testVisitPostContents() { + TestFileLikePart fileLikePart = new TestFileLikePart(null); + try (TestMultipartPart multipartPart = new TestMultipartPart(fileLikePart, EMPTY_BYTE_ARRAY)) { + CounterPartVisitor counterVisitor = new CounterPartVisitor(); + multipartPart.visitPostContent(counterVisitor); + assertEquals(2, counterVisitor.getCount(), "CounterPartVisitor count for visitPostContent should be equal to 2"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void transferToShouldWriteStringPart() throws Exception { + String text = FileUtils.readFileToString(TestUtils.resourceAsFile("test_sample_message.eml"), UTF_8); + + List parts = new ArrayList<>(); + parts.add(new StringPart("test_sample_message.eml", text)); + + HttpHeaders headers = new DefaultHttpHeaders(); + headers.set("Cookie", + "open-xchange-public-session-d41d8cd98f00b204e9800998ecf8427e=bfb98150b24f42bd844fc9ef2a9eaad5; open-xchange-secret-TSlq4Cm4nCBnDpBL1Px2A=9a49b76083e34c5ba2ef5c47362313fd; JSESSIONID=6883138728830405130.OX2"); + headers.set("Content-Length", "9241"); + headers.set("Content-Type", "multipart/form-data; boundary=5gigAKQyqDCVdlZ1fCkeLlEDDauTNoOOEhRnFg"); + headers.set("Host", "appsuite.qa.open-xchange.com"); + headers.set("Accept", "*/*"); + + String boundary = "uwyqQolZaSmme019O2kFKvAeHoC14Npp"; + + List> multipartParts = MultipartUtils.generateMultipartParts(parts, boundary.getBytes()); + try (MultipartBody multipartBody = new MultipartBody(multipartParts, "multipart/form-data; boundary=" + boundary, boundary.getBytes())) { + + ByteBuf byteBuf = ByteBufAllocator.DEFAULT.buffer(8 * 1024); + multipartBody.transferTo(byteBuf); + try { + byteBuf.toString(UTF_8); + } finally { + byteBuf.release(); + } + } + } + + /** + * Concrete implementation of {@link FileLikePart} for use in unit tests + */ + private static class TestFileLikePart extends FileLikePart { + + TestFileLikePart(String name) { + this(name, null, null, null, null); + } + + TestFileLikePart(String name, String contentType) { + this(name, contentType, null); + } + + TestFileLikePart(String name, String contentType, Charset charset) { + this(name, contentType, charset, null); + } + + TestFileLikePart(String name, String contentType, Charset charset, String contentId) { + this(name, contentType, charset, contentId, null); + } + + TestFileLikePart(String name, String contentType, Charset charset, String contentId, String transferEncoding) { + this(name, contentType, charset, contentId, transferEncoding, null); + } + + TestFileLikePart(String name, String contentType, Charset charset, String contentId, String transferEncoding, String fileName) { + super(name, contentType, charset, fileName, contentId, transferEncoding); + } + } + + /** + * Concrete implementation of MultipartPart for use in unit tests. + */ + private static class TestMultipartPart extends FileLikeMultipartPart { + + TestMultipartPart(TestFileLikePart part, byte[] boundary) { + super(part, boundary); + } + + @Override + protected long getContentLength() { + return 0; + } + + @Override + protected long transferContentTo(ByteBuf target) { + return 0; + } + + @Override + protected long transferContentTo(WritableByteChannel target) { + return 0; + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/spnego/SpnegoEngineTest.java b/client/src/test/java/org/asynchttpclient/spnego/SpnegoEngineTest.java new file mode 100644 index 0000000000..523ca40c84 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/spnego/SpnegoEngineTest.java @@ -0,0 +1,195 @@ +/* + * Copyright (c) 2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.spnego; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.apache.commons.io.FileUtils; +import org.apache.kerby.kerberos.kerb.server.SimpleKdcServer; +import org.asynchttpclient.AbstractBasicTest; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.io.File; +import java.util.HashMap; +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class SpnegoEngineTest extends AbstractBasicTest { + private SimpleKdcServer kerbyServer; + + private String basedir; + private String alice; + private String bob; + private File aliceKeytab; + private File bobKeytab; + private File loginConfig; + + @BeforeEach + public void startServers() throws Exception { + basedir = System.getProperty("basedir"); + if (basedir == null) { + basedir = new File(".").getCanonicalPath(); + } + + // System.setProperty("sun.security.krb5.debug", "true"); + System.setProperty("java.security.krb5.conf", + new File(basedir + File.separator + "target" + File.separator + "krb5.conf").getCanonicalPath()); + loginConfig = new File(basedir + File.separator + "target" + File.separator + "kerberos.jaas"); + System.setProperty("java.security.auth.login.config", loginConfig.getCanonicalPath()); + + kerbyServer = new SimpleKdcServer(); + + kerbyServer.setKdcRealm("service.ws.apache.org"); + kerbyServer.setAllowUdp(false); + kerbyServer.setWorkDir(new File(basedir, "target")); + + //kerbyServer.setInnerKdcImpl(new NettyKdcServerImpl(kerbyServer.getKdcSetting())); + + kerbyServer.init(); + + // Create principals + alice = "alice@service.ws.apache.org"; + bob = "bob/service.ws.apache.org@service.ws.apache.org"; + + kerbyServer.createPrincipal(alice, "alice"); + kerbyServer.createPrincipal(bob, "bob"); + + aliceKeytab = new File(basedir + File.separator + "target" + File.separator + "alice.keytab"); + bobKeytab = new File(basedir + File.separator + "target" + File.separator + "bob.keytab"); + kerbyServer.exportPrincipal(alice, aliceKeytab); + kerbyServer.exportPrincipal(bob, bobKeytab); + + kerbyServer.start(); + + FileUtils.copyInputStreamToFile(SpnegoEngine.class.getResourceAsStream("/kerberos.jaas"), loginConfig); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSpnegoGenerateTokenWithUsernamePassword() throws Exception { + SpnegoEngine spnegoEngine = new SpnegoEngine("alice", + "alice", + "bob", + "service.ws.apache.org", + false, + null, + "alice", + null); + String token = spnegoEngine.generateToken("localhost"); + assertNotNull(token); + assertTrue(token.startsWith("YII")); + } + + @Test + public void testSpnegoGenerateTokenWithNullPasswordFail() { + SpnegoEngine spnegoEngine = new SpnegoEngine("alice", + null, + "bob", + "service.ws.apache.org", + false, + null, + "alice", + null); + assertThrows(SpnegoEngineException.class, () -> spnegoEngine.generateToken("localhost"), "No password provided"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSpnegoGenerateTokenWithUsernamePasswordFail() throws Exception { + SpnegoEngine spnegoEngine = new SpnegoEngine("alice", + "wrong password", + "bob", + "service.ws.apache.org", + false, + null, + "alice", + null); + assertThrows(SpnegoEngineException.class, () -> spnegoEngine.generateToken("localhost")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSpnegoGenerateTokenWithCustomLoginConfig() throws Exception { + Map loginConfig = new HashMap<>(); + loginConfig.put("useKeyTab", "true"); + loginConfig.put("storeKey", "true"); + loginConfig.put("refreshKrb5Config", "true"); + loginConfig.put("keyTab", aliceKeytab.getCanonicalPath()); + loginConfig.put("principal", alice); + loginConfig.put("debug", String.valueOf(true)); + SpnegoEngine spnegoEngine = new SpnegoEngine(null, + null, + "bob", + "service.ws.apache.org", + false, + loginConfig, + null, + null); + + String token = spnegoEngine.generateToken("localhost"); + assertNotNull(token); + assertTrue(token.startsWith("YII")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetCompleteServicePrincipalName() throws Exception { + { + SpnegoEngine spnegoEngine = new SpnegoEngine(null, + null, + "bob", + "service.ws.apache.org", + false, + null, + null, + null); + assertEquals("bob@service.ws.apache.org", spnegoEngine.getCompleteServicePrincipalName("localhost")); + } + { + SpnegoEngine spnegoEngine = new SpnegoEngine(null, + null, + null, + "service.ws.apache.org", + true, + null, + null, + null); + assertTrue(spnegoEngine.getCompleteServicePrincipalName("localhost").startsWith("HTTP@")); + } + { + SpnegoEngine spnegoEngine = new SpnegoEngine(null, + null, + null, + "service.ws.apache.org", + false, + null, + null, + null); + assertEquals("HTTP@localhost", spnegoEngine.getCompleteServicePrincipalName("localhost")); + } + } + + @AfterEach + public void cleanup() throws Exception { + if (kerbyServer != null) { + kerbyServer.stop(); + } + FileUtils.deleteQuietly(aliceKeytab); + FileUtils.deleteQuietly(bobKeytab); + FileUtils.deleteQuietly(loginConfig); + } +} diff --git a/client/src/test/java/org/asynchttpclient/test/EchoHandler.java b/client/src/test/java/org/asynchttpclient/test/EchoHandler.java new file mode 100644 index 0000000000..2005cfb5fb --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/test/EchoHandler.java @@ -0,0 +1,173 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.test; + +import jakarta.servlet.ServletException; +import jakarta.servlet.http.Cookie; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.io.IOUtils; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Enumeration; +import java.util.zip.Deflater; + +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_ENCODING; +import static io.netty.handler.codec.http.HttpHeaderNames.CONTENT_LENGTH; +import static io.netty.handler.codec.http.HttpHeaderNames.TRANSFER_ENCODING; +import static io.netty.handler.codec.http.HttpHeaderValues.CHUNKED; +import static io.netty.handler.codec.http.HttpHeaderValues.DEFLATE; + +public class EchoHandler extends AbstractHandler { + + private static final Logger LOGGER = LoggerFactory.getLogger(EchoHandler.class); + + @Override + public void handle(String pathInContext, Request request, HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws IOException, ServletException { + + LOGGER.debug("Echo received request {} on path {}", request, pathInContext); + + if (httpRequest.getHeader("X-HEAD") != null) { + httpResponse.setContentLength(1); + } + + if (httpRequest.getHeader("X-ISO") != null) { + httpResponse.setContentType(TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_ISO_8859_1_CHARSET); + } else { + httpResponse.setContentType(TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + } + + if ("OPTIONS".equalsIgnoreCase(request.getMethod())) { + httpResponse.addHeader("Allow", "GET,HEAD,POST,OPTIONS,TRACE"); + } + + Enumeration e = httpRequest.getHeaderNames(); + String headerName; + while (e.hasMoreElements()) { + headerName = e.nextElement(); + if (headerName.startsWith("LockThread")) { + final int sleepTime = httpRequest.getIntHeader(headerName); + try { + Thread.sleep(sleepTime == -1 ? 40 : sleepTime * 1000L); + } catch (InterruptedException ex) { + // + } + } + + if (headerName.startsWith("X-redirect")) { + httpResponse.sendRedirect(httpRequest.getHeader("X-redirect")); + return; + } + if (headerName.startsWith("X-fail")) { + byte[] body = "custom error message".getBytes(StandardCharsets.US_ASCII); + httpResponse.addHeader(CONTENT_LENGTH.toString(), String.valueOf(body.length)); + httpResponse.setStatus(HttpServletResponse.SC_EXPECTATION_FAILED); + httpResponse.getOutputStream().write(body); + httpResponse.getOutputStream().flush(); + httpResponse.getOutputStream().close(); + return; + } + httpResponse.addHeader("X-" + headerName, httpRequest.getHeader(headerName)); + } + + String pathInfo = httpRequest.getPathInfo(); + if (pathInfo != null) { + httpResponse.addHeader("X-pathInfo", pathInfo); + } + + String queryString = httpRequest.getQueryString(); + if (queryString != null) { + httpResponse.addHeader("X-queryString", queryString); + } + + httpResponse.addHeader("X-KEEP-ALIVE", httpRequest.getRemoteAddr() + ':' + httpRequest.getRemotePort()); + + Cookie[] cs = httpRequest.getCookies(); + if (cs != null) { + for (Cookie c : cs) { + httpResponse.addCookie(c); + } + } + + Enumeration i = httpRequest.getParameterNames(); + if (i.hasMoreElements()) { + StringBuilder requestBody = new StringBuilder(); + while (i.hasMoreElements()) { + headerName = i.nextElement(); + httpResponse.addHeader("X-" + headerName, httpRequest.getParameter(headerName)); + requestBody.append(headerName); + requestBody.append('_'); + } + + if (requestBody.length() > 0) { + String body = requestBody.toString(); + httpResponse.getOutputStream().write(body.getBytes()); + } + } + + if (httpRequest.getHeader("X-COMPRESS") != null) { + byte[] compressed = deflate(IOUtils.toByteArray(httpRequest.getInputStream())); + httpResponse.addIntHeader(CONTENT_LENGTH.toString(), compressed.length); + httpResponse.addHeader(CONTENT_ENCODING.toString(), DEFLATE.toString()); + httpResponse.getOutputStream().write(compressed, 0, compressed.length); + + } else { + httpResponse.addHeader(TRANSFER_ENCODING.toString(), CHUNKED.toString()); + int size = 16384; + if (httpRequest.getContentLength() > 0) { + size = httpRequest.getContentLength(); + } + if (size > 0) { + int read = 0; + while (read > -1) { + byte[] bytes = new byte[size]; + read = httpRequest.getInputStream().read(bytes); + if (read > 0) { + httpResponse.getOutputStream().write(bytes, 0, read); + } + } + } + } + + request.setHandled(true); + httpResponse.getOutputStream().flush(); + // FIXME don't always close, depends on the test, cf ReactiveStreamsTest + httpResponse.getOutputStream().close(); + } + + private static byte[] deflate(byte[] input) throws IOException { + Deflater compressor = new Deflater(); + compressor.setLevel(Deflater.BEST_COMPRESSION); + + compressor.setInput(input); + compressor.finish(); + + try (ByteArrayOutputStream bos = new ByteArrayOutputStream(input.length)) { + byte[] buf = new byte[1024]; + while (!compressor.finished()) { + int count = compressor.deflate(buf); + bos.write(buf, 0, count); + } + return bos.toByteArray(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/test/EventCollectingHandler.java b/client/src/test/java/org/asynchttpclient/test/EventCollectingHandler.java new file mode 100644 index 0000000000..2568b7ae11 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/test/EventCollectingHandler.java @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.test; + +import io.netty.channel.Channel; +import io.netty.handler.codec.http.HttpHeaders; +import org.asynchttpclient.AsyncCompletionHandlerBase; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.asynchttpclient.netty.request.NettyRequest; + +import javax.net.ssl.SSLSession; +import java.net.InetSocketAddress; +import java.util.List; +import java.util.Queue; +import java.util.concurrent.ConcurrentLinkedQueue; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.fail; + +public class EventCollectingHandler extends AsyncCompletionHandlerBase { + + public static final String COMPLETED_EVENT = "Completed"; + public static final String STATUS_RECEIVED_EVENT = "StatusReceived"; + public static final String HEADERS_RECEIVED_EVENT = "HeadersReceived"; + public static final String HEADERS_WRITTEN_EVENT = "HeadersWritten"; + private static final String CONTENT_WRITTEN_EVENT = "ContentWritten"; + private static final String CONNECTION_OPEN_EVENT = "ConnectionOpen"; + private static final String HOSTNAME_RESOLUTION_EVENT = "HostnameResolution"; + private static final String HOSTNAME_RESOLUTION_SUCCESS_EVENT = "HostnameResolutionSuccess"; + private static final String HOSTNAME_RESOLUTION_FAILURE_EVENT = "HostnameResolutionFailure"; + private static final String CONNECTION_SUCCESS_EVENT = "ConnectionSuccess"; + private static final String CONNECTION_FAILURE_EVENT = "ConnectionFailure"; + private static final String TLS_HANDSHAKE_EVENT = "TlsHandshake"; + private static final String TLS_HANDSHAKE_SUCCESS_EVENT = "TlsHandshakeSuccess"; + private static final String TLS_HANDSHAKE_FAILURE_EVENT = "TlsHandshakeFailure"; + public static final String CONNECTION_POOL_EVENT = "ConnectionPool"; + public static final String CONNECTION_POOLED_EVENT = "ConnectionPooled"; + public static final String CONNECTION_OFFER_EVENT = "ConnectionOffer"; + public static final String REQUEST_SEND_EVENT = "RequestSend"; + private static final String RETRY_EVENT = "Retry"; + + public Queue firedEvents = new ConcurrentLinkedQueue<>(); + private final CountDownLatch completionLatch = new CountDownLatch(1); + + public void waitForCompletion(int timeout, TimeUnit unit) throws InterruptedException { + if (!completionLatch.await(timeout, unit)) { + fail("Timeout out"); + } + } + + @Override + public Response onCompleted(Response response) throws Exception { + firedEvents.add(COMPLETED_EVENT); + try { + return super.onCompleted(response); + } finally { + completionLatch.countDown(); + } + } + + @Override + public State onStatusReceived(HttpResponseStatus status) throws Exception { + firedEvents.add(STATUS_RECEIVED_EVENT); + return super.onStatusReceived(status); + } + + @Override + public State onHeadersReceived(HttpHeaders headers) throws Exception { + firedEvents.add(HEADERS_RECEIVED_EVENT); + return super.onHeadersReceived(headers); + } + + @Override + public State onHeadersWritten() { + firedEvents.add(HEADERS_WRITTEN_EVENT); + return super.onHeadersWritten(); + } + + @Override + public State onContentWritten() { + firedEvents.add(CONTENT_WRITTEN_EVENT); + return super.onContentWritten(); + } + + @Override + public void onTcpConnectAttempt(InetSocketAddress address) { + firedEvents.add(CONNECTION_OPEN_EVENT); + } + + @Override + public void onTcpConnectSuccess(InetSocketAddress address, Channel connection) { + firedEvents.add(CONNECTION_SUCCESS_EVENT); + } + + @Override + public void onTcpConnectFailure(InetSocketAddress address, Throwable t) { + firedEvents.add(CONNECTION_FAILURE_EVENT); + } + + @Override + public void onHostnameResolutionAttempt(String name) { + firedEvents.add(HOSTNAME_RESOLUTION_EVENT); + } + + @Override + public void onHostnameResolutionSuccess(String name, List addresses) { + firedEvents.add(HOSTNAME_RESOLUTION_SUCCESS_EVENT); + } + + @Override + public void onHostnameResolutionFailure(String name, Throwable cause) { + firedEvents.add(HOSTNAME_RESOLUTION_FAILURE_EVENT); + } + + @Override + public void onTlsHandshakeAttempt() { + firedEvents.add(TLS_HANDSHAKE_EVENT); + } + + @Override + public void onTlsHandshakeSuccess(SSLSession sslSession) { + assertNotNull(sslSession); + firedEvents.add(TLS_HANDSHAKE_SUCCESS_EVENT); + } + + @Override + public void onTlsHandshakeFailure(Throwable cause) { + firedEvents.add(TLS_HANDSHAKE_FAILURE_EVENT); + } + + @Override + public void onConnectionPoolAttempt() { + firedEvents.add(CONNECTION_POOL_EVENT); + } + + @Override + public void onConnectionPooled(Channel connection) { + firedEvents.add(CONNECTION_POOLED_EVENT); + } + + @Override + public void onConnectionOffer(Channel connection) { + firedEvents.add(CONNECTION_OFFER_EVENT); + } + + @Override + public void onRequestSend(NettyRequest request) { + firedEvents.add(REQUEST_SEND_EVENT); + } + + @Override + public void onRetry() { + firedEvents.add(RETRY_EVENT); + } +} diff --git a/client/src/test/java/org/asynchttpclient/test/Slf4jJuliLog.java b/client/src/test/java/org/asynchttpclient/test/Slf4jJuliLog.java new file mode 100644 index 0000000000..14b8527715 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/test/Slf4jJuliLog.java @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.test; + +import org.apache.juli.logging.Log; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class Slf4jJuliLog implements Log { + + private final Logger logger; + + // just so that ServiceLoader doesn't crash, unused + public Slf4jJuliLog() { + logger = null; + } + + // actual constructor + public Slf4jJuliLog(String name) { + logger = LoggerFactory.getLogger(name); + } + + @Override + public void debug(Object arg0) { + logger.debug(arg0.toString()); + } + + @Override + public void debug(Object arg0, Throwable arg1) { + logger.debug(arg0.toString(), arg1); + } + + @Override + public void error(Object arg0) { + logger.error(arg0.toString()); + } + + @Override + public void error(Object arg0, Throwable arg1) { + logger.error(arg0.toString(), arg1); + } + + @Override + public void fatal(Object arg0) { + logger.error(arg0.toString()); + } + + @Override + public void fatal(Object arg0, Throwable arg1) { + logger.error(arg0.toString(), arg1); + } + + @Override + public void info(Object arg0) { + logger.info(arg0.toString()); + } + + @Override + public void info(Object arg0, Throwable arg1) { + logger.info(arg0.toString(), arg1); + } + + @Override + public boolean isDebugEnabled() { + return logger.isDebugEnabled(); + } + + @Override + public boolean isErrorEnabled() { + return logger.isErrorEnabled(); + } + + @Override + public boolean isFatalEnabled() { + return logger.isErrorEnabled(); + } + + @Override + public boolean isInfoEnabled() { + return logger.isInfoEnabled(); + } + + @Override + public boolean isTraceEnabled() { + return logger.isTraceEnabled(); + } + + @Override + public boolean isWarnEnabled() { + return logger.isWarnEnabled(); + } + + @Override + public void trace(Object arg0) { + logger.trace(arg0.toString()); + } + + @Override + public void trace(Object arg0, Throwable arg1) { + logger.trace(arg0.toString(), arg1); + } + + @Override + public void warn(Object arg0) { + logger.warn(arg0.toString()); + } + + @Override + public void warn(Object arg0, Throwable arg1) { + logger.warn(arg0.toString(), arg1); + } +} diff --git a/client/src/test/java/org/asynchttpclient/test/TestUtils.java b/client/src/test/java/org/asynchttpclient/test/TestUtils.java new file mode 100644 index 0000000000..4995628245 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/test/TestUtils.java @@ -0,0 +1,385 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.test; + +import io.netty.handler.codec.http.HttpHeaders; +import jakarta.servlet.http.HttpServletResponse; +import org.apache.commons.io.FileUtils; +import org.asynchttpclient.AsyncCompletionHandler; +import org.asynchttpclient.AsyncHandler; +import org.asynchttpclient.HttpResponseBodyPart; +import org.asynchttpclient.HttpResponseStatus; +import org.asynchttpclient.Response; +import org.asynchttpclient.SslEngineFactory; +import org.asynchttpclient.netty.ssl.JsseSslEngineFactory; +import org.asynchttpclient.util.MessageDigestUtils; +import org.eclipse.jetty.security.ConstraintMapping; +import org.eclipse.jetty.security.ConstraintSecurityHandler; +import org.eclipse.jetty.security.HashLoginService; +import org.eclipse.jetty.security.LoginService; +import org.eclipse.jetty.security.authentication.BasicAuthenticator; +import org.eclipse.jetty.security.authentication.DigestAuthenticator; +import org.eclipse.jetty.security.authentication.LoginAuthenticator; +import org.eclipse.jetty.server.Handler; +import org.eclipse.jetty.server.HttpConfiguration; +import org.eclipse.jetty.server.HttpConnectionFactory; +import org.eclipse.jetty.server.SecureRequestCustomizer; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.SslConnectionFactory; +import org.eclipse.jetty.util.security.Constraint; +import org.eclipse.jetty.util.ssl.SslContextFactory; + +import javax.net.ServerSocketFactory; +import javax.net.ssl.KeyManager; +import javax.net.ssl.KeyManagerFactory; +import javax.net.ssl.SSLContext; +import javax.net.ssl.TrustManager; +import javax.net.ssl.TrustManagerFactory; +import javax.net.ssl.X509TrustManager; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.ServerSocket; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.security.GeneralSecurityException; +import java.security.KeyStore; +import java.security.MessageDigest; +import java.security.SecureRandom; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.Base64; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.atomic.AtomicBoolean; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.fail; + +public final class TestUtils { + + public static final int TIMEOUT = 30; + public static final String USER = "user"; + public static final String ADMIN = "admin"; + public static final String TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET = "text/html;charset=UTF-8"; + public static final String TEXT_HTML_CONTENT_TYPE_WITH_ISO_8859_1_CHARSET = "text/html;charset=ISO-8859-1"; + public static final File TMP_DIR = new File(System.getProperty("java.io.tmpdir"), "ahc-tests-" + UUID.randomUUID().toString().substring(0, 8)); + private static final byte[] PATTERN_BYTES = "FooBarBazQixFooBarBazQixFooBarBazQixFooBarBazQixFooBarBazQixFooBarBazQix".getBytes(StandardCharsets.UTF_16); + public static final File LARGE_IMAGE_FILE; + public static final byte[] LARGE_IMAGE_BYTES; + public static final String LARGE_IMAGE_BYTES_MD5; + public static final File SIMPLE_TEXT_FILE; + public static final String SIMPLE_TEXT_FILE_STRING; + private static final LoginService LOGIN_SERVICE = new HashLoginService("MyRealm", "src/test/resources/realm.properties"); + + static { + try { + TMP_DIR.mkdirs(); + TMP_DIR.deleteOnExit(); + LARGE_IMAGE_FILE = resourceAsFile("300k.png"); + LARGE_IMAGE_BYTES = FileUtils.readFileToByteArray(LARGE_IMAGE_FILE); + LARGE_IMAGE_BYTES_MD5 = md5(LARGE_IMAGE_BYTES); + SIMPLE_TEXT_FILE = resourceAsFile("SimpleTextFile.txt"); + SIMPLE_TEXT_FILE_STRING = FileUtils.readFileToString(SIMPLE_TEXT_FILE, UTF_8); + } catch (Exception e) { + throw new ExceptionInInitializerError(e); + } + } + + private TestUtils() { + } + + public static synchronized int findFreePort() throws IOException { + try (ServerSocket socket = ServerSocketFactory.getDefault().createServerSocket(0)) { + return socket.getLocalPort(); + } + } + + public static File resourceAsFile(String path) throws URISyntaxException, IOException { + ClassLoader cl = TestUtils.class.getClassLoader(); + URI uri = cl.getResource(path).toURI(); + if (uri.isAbsolute() && !uri.isOpaque()) { + return new File(uri); + } else { + File tmpFile = File.createTempFile("tmpfile-", ".data", TMP_DIR); + tmpFile.deleteOnExit(); + try (InputStream is = cl.getResourceAsStream(path)) { + FileUtils.copyInputStreamToFile(is, tmpFile); + return tmpFile; + } + } + } + + public static File createTempFile(int approxSize) throws IOException { + long repeats = approxSize / PATTERN_BYTES.length + 1; + File tmpFile = File.createTempFile("tmpfile-", ".data", TMP_DIR); + tmpFile.deleteOnExit(); + try (OutputStream out = Files.newOutputStream(tmpFile.toPath())) { + for (int i = 0; i < repeats; i++) { + out.write(PATTERN_BYTES); + } + + long expectedFileSize = PATTERN_BYTES.length * repeats; + assertEquals(expectedFileSize, tmpFile.length(), "Invalid file length"); + + return tmpFile; + } + } + + public static ServerConnector addHttpConnector(Server server) { + ServerConnector connector = new ServerConnector(server); + server.addConnector(connector); + return connector; + } + + public static ServerConnector addHttpsConnector(Server server) throws IOException, URISyntaxException { + String keyStoreFile = resourceAsFile("ssltest-keystore.jks").getAbsolutePath(); + SslContextFactory.Server sslContextFactory = new SslContextFactory.Server(); + sslContextFactory.setKeyStorePath(keyStoreFile); + sslContextFactory.setKeyStorePassword("changeit"); + + String trustStoreFile = resourceAsFile("ssltest-cacerts.jks").getAbsolutePath(); + sslContextFactory.setTrustStorePath(trustStoreFile); + sslContextFactory.setTrustStorePassword("changeit"); + + HttpConfiguration httpsConfig = new HttpConfiguration(); + httpsConfig.setSecureScheme("https"); + httpsConfig.addCustomizer(new SecureRequestCustomizer()); + + ServerConnector connector = new ServerConnector(server, new SslConnectionFactory(sslContextFactory, "http/1.1"), new HttpConnectionFactory(httpsConfig)); + + server.addConnector(connector); + return connector; + } + + public static void addBasicAuthHandler(Server server, Handler handler) { + addAuthHandler(server, Constraint.__BASIC_AUTH, new BasicAuthenticator(), handler); + } + + public static void addDigestAuthHandler(Server server, Handler handler) { + addAuthHandler(server, Constraint.__DIGEST_AUTH, new DigestAuthenticator(), handler); + } + + private static void addAuthHandler(Server server, String auth, LoginAuthenticator authenticator, Handler handler) { + server.addBean(LOGIN_SERVICE); + + Constraint constraint = new Constraint(); + constraint.setName(auth); + constraint.setRoles(new String[]{USER, ADMIN}); + constraint.setAuthenticate(true); + + ConstraintMapping mapping = new ConstraintMapping(); + mapping.setConstraint(constraint); + mapping.setPathSpec("/*"); + + Set knownRoles = new HashSet<>(); + knownRoles.add(USER); + knownRoles.add(ADMIN); + + List cm = new ArrayList<>(); + cm.add(mapping); + + ConstraintSecurityHandler security = new ConstraintSecurityHandler(); + security.setConstraintMappings(cm, knownRoles); + security.setAuthenticator(authenticator); + security.setLoginService(LOGIN_SERVICE); + security.setHandler(handler); + server.setHandler(security); + } + + private static KeyManager[] createKeyManagers() throws GeneralSecurityException, IOException { + KeyStore ks = KeyStore.getInstance("JKS"); + try (InputStream keyStoreStream = TestUtils.class.getClassLoader().getResourceAsStream("ssltest-cacerts.jks")) { + char[] keyStorePassword = "changeit".toCharArray(); + ks.load(keyStoreStream, keyStorePassword); + } + assert ks.size() > 0; + + // Set up key manager factory to use our key store + char[] certificatePassword = "changeit".toCharArray(); + KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509"); + kmf.init(ks, certificatePassword); + + // Initialize the SSLContext to work with our key managers. + return kmf.getKeyManagers(); + } + + private static TrustManager[] createTrustManagers() throws GeneralSecurityException, IOException { + KeyStore ks = KeyStore.getInstance("JKS"); + try (InputStream keyStoreStream = TestUtils.class.getClassLoader().getResourceAsStream("ssltest-keystore.jks")) { + char[] keyStorePassword = "changeit".toCharArray(); + ks.load(keyStoreStream, keyStorePassword); + } + assert ks.size() > 0; + + TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()); + tmf.init(ks); + return tmf.getTrustManagers(); + } + + public static SslEngineFactory createSslEngineFactory() { + return createSslEngineFactory(new AtomicBoolean(true)); + } + + public static SslEngineFactory createSslEngineFactory(AtomicBoolean trust) { + try { + KeyManager[] keyManagers = createKeyManagers(); + TrustManager[] trustManagers = {dummyTrustManager(trust, (X509TrustManager) createTrustManagers()[0])}; + SecureRandom secureRandom = new SecureRandom(); + + SSLContext sslContext = SSLContext.getInstance("TLS"); + sslContext.init(keyManagers, trustManagers, secureRandom); + + return new JsseSslEngineFactory(sslContext); + + } catch (Exception e) { + throw new ExceptionInInitializerError(e); + } + } + + private static TrustManager dummyTrustManager(final AtomicBoolean trust, final X509TrustManager tm) { + return new DummyTrustManager(trust, tm); + + } + + public static File getClasspathFile(String file) throws FileNotFoundException { + ClassLoader cl = null; + try { + cl = Thread.currentThread().getContextClassLoader(); + } catch (Throwable ex) { + // + } + if (cl == null) { + cl = TestUtils.class.getClassLoader(); + } + URL resourceUrl = cl.getResource(file); + + try { + return new File(new URI(resourceUrl.toString()).getSchemeSpecificPart()); + } catch (URISyntaxException e) { + throw new FileNotFoundException(file); + } + } + + public static void assertContentTypesEquals(String actual, String expected) { + assertEquals(actual.replace("; ", "").toLowerCase(Locale.ENGLISH), + expected.replace("; ", "").toLowerCase(Locale.ENGLISH), "Unexpected content-type"); + } + + public static void writeResponseBody(HttpServletResponse response, String body) { + response.setContentLength(body.length()); + try { + response.getOutputStream().print(body); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + + public static String md5(byte[] bytes) { + return md5(bytes, 0, bytes.length); + } + + public static String md5(byte[] bytes, int offset, int len) { + try { + MessageDigest md = MessageDigestUtils.pooledMd5MessageDigest(); + md.update(bytes, offset, len); + return Base64.getEncoder().encodeToString(md.digest()); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + + public static class DummyTrustManager implements X509TrustManager { + + private final X509TrustManager tm; + private final AtomicBoolean trust; + + DummyTrustManager(final AtomicBoolean trust, final X509TrustManager tm) { + this.trust = trust; + this.tm = tm; + } + + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { + tm.checkClientTrusted(chain, authType); + } + + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { + if (!trust.get()) { + throw new CertificateException("Server certificate not trusted."); + } + tm.checkServerTrusted(chain, authType); + } + + @Override + public X509Certificate[] getAcceptedIssuers() { + return tm.getAcceptedIssuers(); + } + } + + public static class AsyncCompletionHandlerAdapter extends AsyncCompletionHandler { + + @Override + public Response onCompleted(Response response) throws Exception { + return response; + } + + @Override + public void onThrowable(Throwable t) { + fail("Unexpected exception: " + t.getMessage(), t); + } + } + + public static class AsyncHandlerAdapter implements AsyncHandler { + + @Override + public void onThrowable(Throwable t) { + fail("Unexpected exception", t); + } + + @Override + public State onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { + return State.CONTINUE; + } + + @Override + public State onStatusReceived(final HttpResponseStatus responseStatus) { + return State.CONTINUE; + } + + @Override + public State onHeadersReceived(final HttpHeaders headers) throws Exception { + return State.CONTINUE; + } + + @Override + public String onCompleted() throws Exception { + return ""; + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/testserver/HttpServer.java b/client/src/test/java/org/asynchttpclient/testserver/HttpServer.java new file mode 100644 index 0000000000..b0848cad31 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/testserver/HttpServer.java @@ -0,0 +1,269 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.testserver; + +import jakarta.servlet.ServletException; +import jakarta.servlet.http.Cookie; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.eclipse.jetty.server.Handler; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; + +import java.io.Closeable; +import java.io.IOException; +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.Enumeration; +import java.util.Map.Entry; +import java.util.concurrent.ConcurrentLinkedQueue; + +import static io.netty.handler.codec.http.HttpHeaderNames.LOCATION; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_ISO_8859_1_CHARSET; +import static org.asynchttpclient.test.TestUtils.TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; + +public class HttpServer implements Closeable { + + private final ConcurrentLinkedQueue handlers = new ConcurrentLinkedQueue<>(); + private int httpPort; + private int httpsPort; + private Server server; + + public HttpServer() { + } + + public HttpServer(int httpPort, int httpsPort) { + this.httpPort = httpPort; + this.httpsPort = httpsPort; + } + + public void start() throws Exception { + server = new Server(); + + ServerConnector httpConnector = addHttpConnector(server); + if (httpPort != 0) { + httpConnector.setPort(httpPort); + } + + server.setHandler(new QueueHandler()); + ServerConnector httpsConnector = addHttpsConnector(server); + if (httpsPort != 0) { + httpsConnector.setPort(httpsPort); + } + + server.start(); + + httpPort = httpConnector.getLocalPort(); + httpsPort = httpsConnector.getLocalPort(); + } + + public void enqueue(Handler handler) { + handlers.offer(handler); + } + + public void enqueueOk() { + enqueueResponse(response -> response.setStatus(200)); + } + + public void enqueueResponse(HttpServletResponseConsumer c) { + handlers.offer(new ConsumerHandler(c)); + } + + public void enqueueEcho() { + handlers.offer(new EchoHandler()); + } + + public void enqueueRedirect(int status, String location) { + enqueueResponse(response -> { + response.setStatus(status); + response.setHeader(LOCATION.toString(), location); + }); + } + + public int getHttpPort() { + return httpPort; + } + + public int getsHttpPort() { + return httpsPort; + } + + public String getHttpUrl() { + return "http://localhost/" + httpPort; + } + + public String getHttpsUrl() { + return "https://localhost/" + httpsPort; + } + + public void reset() { + handlers.clear(); + } + + @Override + public void close() throws IOException { + if (server != null) { + try { + server.stop(); + } catch (Exception e) { + throw new IOException(e); + } + } + } + + @FunctionalInterface + public interface HttpServletResponseConsumer { + + void apply(HttpServletResponse response) throws IOException, ServletException; + } + + public abstract static class AutoFlushHandler extends AbstractHandler { + + private final boolean closeAfterResponse; + + AutoFlushHandler() { + this(false); + } + + AutoFlushHandler(boolean closeAfterResponse) { + this.closeAfterResponse = closeAfterResponse; + } + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + handle0(target, baseRequest, request, response); + response.getOutputStream().flush(); + if (closeAfterResponse) { + response.getOutputStream().close(); + } + } + + protected abstract void handle0(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException; + } + + private static class ConsumerHandler extends AutoFlushHandler { + + private final HttpServletResponseConsumer c; + + ConsumerHandler(HttpServletResponseConsumer c) { + this(c, false); + } + + ConsumerHandler(HttpServletResponseConsumer c, boolean closeAfterResponse) { + super(closeAfterResponse); + this.c = c; + } + + @Override + protected void handle0(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + c.apply(response); + } + } + + public static class EchoHandler extends AutoFlushHandler { + + @Override + protected void handle0(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + + String delay = request.getHeader("X-Delay"); + if (delay != null) { + try { + Thread.sleep(Long.parseLong(delay)); + } catch (NumberFormatException | InterruptedException e1) { + throw new ServletException(e1); + } + } + + response.setStatus(200); + + if ("OPTIONS".equalsIgnoreCase(request.getMethod())) { + response.addHeader("Allow", "GET,HEAD,POST,OPTIONS,TRACE"); + } + + response.setContentType(request.getHeader("X-IsoCharset") != null ? TEXT_HTML_CONTENT_TYPE_WITH_ISO_8859_1_CHARSET : TEXT_HTML_CONTENT_TYPE_WITH_UTF_8_CHARSET); + + response.addHeader("X-ClientPort", String.valueOf(request.getRemotePort())); + + String pathInfo = request.getPathInfo(); + if (pathInfo != null) { + response.addHeader("X-PathInfo", pathInfo); + } + + String queryString = request.getQueryString(); + if (queryString != null) { + response.addHeader("X-QueryString", queryString); + } + + Enumeration headerNames = request.getHeaderNames(); + while (headerNames.hasMoreElements()) { + String headerName = headerNames.nextElement(); + response.addHeader("X-" + headerName, request.getHeader(headerName)); + } + + StringBuilder requestBody = new StringBuilder(); + for (Entry e : baseRequest.getParameterMap().entrySet()) { + response.addHeader("X-" + e.getKey(), URLEncoder.encode(e.getValue()[0], StandardCharsets.UTF_8)); + } + + Cookie[] cs = request.getCookies(); + if (cs != null) { + for (Cookie c : cs) { + response.addCookie(c); + } + } + + if (requestBody.length() > 0) { + response.getOutputStream().write(requestBody.toString().getBytes()); + } + + int size = 16384; + if (request.getContentLength() > 0) { + size = request.getContentLength(); + } + if (size > 0) { + int read = 0; + while (read > -1) { + byte[] bytes = new byte[size]; + read = request.getInputStream().read(bytes); + if (read > 0) { + response.getOutputStream().write(bytes, 0, read); + } + } + } + } + } + + private class QueueHandler extends AbstractHandler { + + @Override + public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { + + Handler handler = handlers.poll(); + if (handler == null) { + response.sendError(500, "No handler enqueued"); + response.getOutputStream().flush(); + response.getOutputStream().close(); + + } else { + handler.handle(target, baseRequest, request, response); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/testserver/HttpTest.java b/client/src/test/java/org/asynchttpclient/testserver/HttpTest.java new file mode 100644 index 0000000000..b41b6ab1b6 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/testserver/HttpTest.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2016-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.testserver; + +import io.github.nettyplus.leakdetector.junit.NettyLeakDetectorExtension; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.AsyncHttpClientConfig; +import org.asynchttpclient.DefaultAsyncHttpClientConfig; +import org.junit.jupiter.api.extension.ExtendWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; + +@ExtendWith(NettyLeakDetectorExtension.class) +public abstract class HttpTest { + + protected static final String COMPLETED_EVENT = "Completed"; + protected static final String STATUS_RECEIVED_EVENT = "StatusReceived"; + protected static final String HEADERS_RECEIVED_EVENT = "HeadersReceived"; + protected static final String HEADERS_WRITTEN_EVENT = "HeadersWritten"; + protected static final String CONNECTION_OPEN_EVENT = "ConnectionOpen"; + protected static final String HOSTNAME_RESOLUTION_EVENT = "HostnameResolution"; + protected static final String HOSTNAME_RESOLUTION_SUCCESS_EVENT = "HostnameResolutionSuccess"; + protected static final String CONNECTION_SUCCESS_EVENT = "ConnectionSuccess"; + protected static final String TLS_HANDSHAKE_EVENT = "TlsHandshake"; + protected static final String TLS_HANDSHAKE_SUCCESS_EVENT = "TlsHandshakeSuccess"; + protected static final String CONNECTION_POOL_EVENT = "ConnectionPool"; + protected static final String CONNECTION_OFFER_EVENT = "ConnectionOffer"; + protected static final String REQUEST_SEND_EVENT = "RequestSend"; + protected final Logger logger = LoggerFactory.getLogger(getClass()); + + protected ClientTestBody withClient() { + return withClient(config().setMaxRedirects(0)); + } + + protected ClientTestBody withClient(DefaultAsyncHttpClientConfig.Builder builder) { + return withClient(builder.build()); + } + + private ClientTestBody withClient(AsyncHttpClientConfig config) { + return new ClientTestBody(config); + } + + protected ServerTestBody withServer(HttpServer server) { + return new ServerTestBody(server); + } + + @FunctionalInterface + protected interface ClientFunction { + void apply(AsyncHttpClient client) throws Throwable; + } + + @FunctionalInterface + protected interface ServerFunction { + void apply(HttpServer server) throws Throwable; + } + + protected static class ClientTestBody { + + private final AsyncHttpClientConfig config; + + private ClientTestBody(AsyncHttpClientConfig config) { + this.config = config; + } + + public void run(ClientFunction f) throws Throwable { + try (AsyncHttpClient client = asyncHttpClient(config)) { + f.apply(client); + } + } + } + + protected static class ServerTestBody { + + private final HttpServer server; + + private ServerTestBody(HttpServer server) { + this.server = server; + } + + public void run(ServerFunction f) throws Throwable { + try { + f.apply(server); + } finally { + server.reset(); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/testserver/SocksProxy.java b/client/src/test/java/org/asynchttpclient/testserver/SocksProxy.java new file mode 100644 index 0000000000..b8e67b79f5 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/testserver/SocksProxy.java @@ -0,0 +1,203 @@ +/* + * SOCKS Proxy in JAVA + * By Gareth Owen + * drgowen@gmail.com + * MIT Licence + */ + +package org.asynchttpclient.testserver; + +// NOTES : LISTENS ON PORT 8000 + +import java.io.IOException; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.ByteBuffer; +import java.nio.channels.SelectionKey; +import java.nio.channels.Selector; +import java.nio.channels.ServerSocketChannel; +import java.nio.channels.SocketChannel; +import java.util.ArrayList; +import java.util.Set; + +public class SocksProxy { + + private static final ArrayList clients = new ArrayList<>(); + + public SocksProxy(int runningTime) throws IOException { + ServerSocketChannel socks = ServerSocketChannel.open(); + socks.socket().bind(new InetSocketAddress(8000)); + socks.configureBlocking(false); + Selector select = Selector.open(); + socks.register(select, SelectionKey.OP_ACCEPT); + + int lastClients = clients.size(); + // select loop + for (long end = System.currentTimeMillis() + runningTime; System.currentTimeMillis() < end; ) { + select.select(5000); + + Set keys = select.selectedKeys(); + for (SelectionKey k : keys) { + + if (!k.isValid()) { + continue; + } + + // new connection? + if (k.isAcceptable() && k.channel() == socks) { + // server socket + SocketChannel csock = socks.accept(); + if (csock == null) { + continue; + } + addClient(csock); + csock.register(select, SelectionKey.OP_READ); + } else if (k.isReadable()) { + // new data on a client/remote socket + for (int i = 0; i < clients.size(); i++) { + SocksClient cl = clients.get(i); + try { + if (k.channel() == cl.client) // from client (e.g. socks client) + { + cl.newClientData(select); + } else if (k.channel() == cl.remote) { // from server client is connected to (e.g. website) + cl.newRemoteData(); + } + } catch (IOException e) { // error occurred - remove client + cl.client.close(); + if (cl.remote != null) { + cl.remote.close(); + } + k.cancel(); + clients.remove(cl); + } + + } + } + } + + // client timeout check + for (int i = 0; i < clients.size(); i++) { + SocksClient cl = clients.get(i); + if (System.currentTimeMillis() - cl.lastData > 30000L) { + cl.client.close(); + if (cl.remote != null) { + cl.remote.close(); + } + clients.remove(cl); + } + } + if (clients.size() != lastClients) { + System.out.println(clients.size()); + lastClients = clients.size(); + } + } + } + + // utility function + private void addClient(SocketChannel s) { + SocksClient cl; + try { + cl = new SocksClient(s); + } catch (IOException e) { + e.printStackTrace(); + return; + } + clients.add(cl); + } + + // socks client class - one per client connection + class SocksClient { + SocketChannel client, remote; + boolean connected; + long lastData; + + SocksClient(SocketChannel c) throws IOException { + client = c; + client.configureBlocking(false); + lastData = System.currentTimeMillis(); + } + + void newRemoteData() throws IOException { + ByteBuffer buf = ByteBuffer.allocate(1024); + if (remote.read(buf) == -1) { + throw new IOException("disconnected"); + } + lastData = System.currentTimeMillis(); + buf.flip(); + client.write(buf); + } + + void newClientData(Selector selector) throws IOException { + if (!connected) { + ByteBuffer inbuf = ByteBuffer.allocate(512); + if (client.read(inbuf) < 1) { + return; + } + inbuf.flip(); + + // read socks header + int ver = inbuf.get(); + if (ver != 4) { + throw new IOException("incorrect version" + ver); + } + int cmd = inbuf.get(); + + // check supported command + if (cmd != 1) { + throw new IOException("incorrect version"); + } + + final int port = inbuf.getShort() & 0xffff; + + final byte[] ip = new byte[4]; + // fetch IP + inbuf.get(ip); + + InetAddress remoteAddr = InetAddress.getByAddress(ip); + + while (inbuf.get() != 0) { + ; // username + } + + // hostname provided, not IP + if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] != 0) { // host provided + StringBuilder host = new StringBuilder(); + byte b; + while ((b = inbuf.get()) != 0) { + host.append(b); + } + remoteAddr = InetAddress.getByName(host.toString()); + System.out.println(host.toString() + remoteAddr); + } + + remote = SocketChannel.open(new InetSocketAddress(remoteAddr, port)); + + ByteBuffer out = ByteBuffer.allocate(20); + out.put((byte) 0); + out.put((byte) (remote.isConnected() ? 0x5a : 0x5b)); + out.putShort((short) port); + out.put(remoteAddr.getAddress()); + out.flip(); + client.write(out); + + if (!remote.isConnected()) { + throw new IOException("connect failed"); + } + + remote.configureBlocking(false); + remote.register(selector, SelectionKey.OP_READ); + + connected = true; + } else { + ByteBuffer buf = ByteBuffer.allocate(1024); + if (client.read(buf) == -1) { + throw new IOException("disconnected"); + } + lastData = System.currentTimeMillis(); + buf.flip(); + remote.write(buf); + } + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/uri/UriParserTest.java b/client/src/test/java/org/asynchttpclient/uri/UriParserTest.java new file mode 100644 index 0000000000..1e314f56db --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/uri/UriParserTest.java @@ -0,0 +1,121 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.uri; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import java.net.URI; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class UriParserTest { + + private static void assertUriEquals(UriParser parser, URI uri) { + assertEquals(uri.getScheme(), parser.scheme); + assertEquals(uri.getUserInfo(), parser.userInfo); + assertEquals(uri.getHost(), parser.host); + assertEquals(uri.getPort(), parser.port); + assertEquals(uri.getPath(), parser.path); + assertEquals(uri.getQuery(), parser.query); + } + + private static void validateAgainstAbsoluteURI(String url) { + final UriParser parser = UriParser.parse(null, url); + assertUriEquals(parser, URI.create(url)); + } + + private static void validateAgainstRelativeURI(Uri uriContext, String urlContext, String url) { + final UriParser parser = UriParser.parse(uriContext, url); + assertUriEquals(parser, URI.create(urlContext).resolve(URI.create(url))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUrlWithPathAndQuery() { + validateAgainstAbsoluteURI("http://example.com:8080/test?q=1"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testFragmentTryingToTrickAuthorityAsBasicAuthCredentials() { + validateAgainstAbsoluteURI("http://1.2.3.4:81/#@5.6.7.8:82/aaa/b?q=xxx"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testUrlHasLeadingAndTrailingWhiteSpace() { + String url = " http://user@example.com:8080/test?q=1 "; + final UriParser parser = UriParser.parse(null, url); + assertUriEquals(parser, URI.create(url.trim())); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testResolveAbsoluteUriAgainstContext() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "", null); + validateAgainstRelativeURI(context, "https://example.com:80/path", "http://example.com/path"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRootRelativePath() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "/relativeUrl"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCurrentDirRelativePath() { + Uri context = new Uri("https", null, "example.com", 80, "/foo/bar", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/foo/bar?q=2", "relativeUrl"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testFragmentOnly() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "#test"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUrlWithQuery() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "/relativePath?q=3"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUrlWithQueryOnly() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "?q=3"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeURLWithDots() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "./relative/./url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeURLWithTwoEmbeddedDots() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "./relative/../url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeURLWithTwoTrailingDots() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "./relative/url/.."); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeURLWithOneTrailingDot() { + Uri context = new Uri("https", null, "example.com", 80, "/path", "q=2", null); + validateAgainstRelativeURI(context, "https://example.com:80/path?q=2", "./relative/url/."); + } +} diff --git a/client/src/test/java/org/asynchttpclient/uri/UriTest.java b/client/src/test/java/org/asynchttpclient/uri/UriTest.java new file mode 100644 index 0000000000..f766854e13 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/uri/UriTest.java @@ -0,0 +1,355 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.uri; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.junit.jupiter.api.Disabled; + +import java.net.URI; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class UriTest { + + private static void assertUriEquals(Uri uri, URI javaUri) { + assertEquals(javaUri.getScheme(), uri.getScheme()); + assertEquals(javaUri.getUserInfo(), uri.getUserInfo()); + assertEquals(javaUri.getHost(), uri.getHost()); + assertEquals(javaUri.getPort(), uri.getPort()); + assertEquals(javaUri.getPath(), uri.getPath()); + assertEquals(javaUri.getQuery(), uri.getQuery()); + } + + private static void validateAgainstAbsoluteURI(String url) { + assertUriEquals(Uri.create(url), URI.create(url)); + } + + private static void validateAgainstRelativeURI(String context, String url) { + assertUriEquals(Uri.create(Uri.create(context), url), URI.create(context).resolve(URI.create(url))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testSimpleParsing() { + validateAgainstAbsoluteURI("https://graph.facebook.com/750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRootRelativeURIWithRootContext() { + validateAgainstRelativeURI("https://graph.facebook.com/", "/750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRootRelativeURIWithNonRootContext() { + validateAgainstRelativeURI("https://graph.facebook.com/foo/bar", "/750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testNonRootRelativeURIWithNonRootContext() { + validateAgainstRelativeURI("https://graph.facebook.com/foo/bar", "750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @Disabled + @RepeatedIfExceptionsTest(repeats = 5) + // FIXME weird: java.net.URI#getPath return "750198471659552/accounts/test-users" without a "/"?! + public void testNonRootRelativeURIWithRootContext() { + validateAgainstRelativeURI("https://graph.facebook.com/", "750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testAbsoluteURIWithContext() { + validateAgainstRelativeURI("https://hello.com/foo/bar", + "https://graph.facebook.com/750198471659552/accounts/test-users?method=get&access_token=750198471659552lleveCvbUu_zqBa9tkT3tcgaPh4"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithDots() { + validateAgainstRelativeURI("https://hello.com/level1/level2/", "../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithDotsAboveRoot() { + validateAgainstRelativeURI("https://hello.com/level1", "../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithAbsoluteDots() { + validateAgainstRelativeURI("https://hello.com/level1/", "/../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDots() { + validateAgainstRelativeURI("https://hello.com/level1/level2/", "../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDotsAboveRoot() { + validateAgainstRelativeURI("https://hello.com/level1/level2", "../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithAbsoluteConsecutiveDots() { + validateAgainstRelativeURI("https://hello.com/level1/level2/", "/../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDotsFromRoot() { + validateAgainstRelativeURI("https://hello.com/", "../../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDotsFromRootResource() { + validateAgainstRelativeURI("https://hello.com/level1", "../../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDotsFromSubrootResource() { + validateAgainstRelativeURI("https://hello.com/level1/level2", "../../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithConsecutiveDotsFromLevel3Resource() { + validateAgainstRelativeURI("https://hello.com/level1/level2/level3", "../../../other/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testRelativeUriWithNoScheme() { + validateAgainstRelativeURI("https://hello.com/level1", "//world.org/content/img.png"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testCreateAndToUrl() { + String url = "https://hello.com/level1/level2/level3"; + Uri uri = Uri.create(url); + assertEquals(url, uri.toUrl(), "url used to create uri and url returned from toUrl do not match"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testToUrlWithUserInfoPortPathAndQuery() { + Uri uri = new Uri("http", "user", "example.com", 44, "/path/path2", "query=4", null); + assertEquals("http://user@example.com:44/path/path2?query=4", uri.toUrl(), "toUrl returned incorrect url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryWithNonRootPath() { + Uri uri = Uri.create("http://hello.com/foo?query=value"); + assertEquals("/foo", uri.getPath()); + assertEquals("query=value", uri.getQuery()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryWithNonRootPathAndTrailingSlash() { + Uri uri = Uri.create("http://hello.com/foo/?query=value"); + assertEquals("/foo/", uri.getPath()); + assertEquals("query=value", uri.getQuery()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryWithRootPath() { + Uri uri = Uri.create("http://hello.com/?query=value"); + assertEquals("", uri.getPath()); + assertEquals("query=value", uri.getQuery()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testQueryWithRootPathAndTrailingSlash() { + Uri uri = Uri.create("http://hello.com/?query=value"); + assertEquals("/", uri.getPath()); + assertEquals("query=value", uri.getQuery()); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWithNewScheme() { + Uri uri = new Uri("http", "user", "example.com", 44, "/path/path2", "query=4", null); + Uri newUri = uri.withNewScheme("https"); + assertEquals("https", newUri.getScheme()); + assertEquals("https://user@example.com:44/path/path2?query=4", newUri.toUrl(), "toUrl returned incorrect url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testWithNewQuery() { + Uri uri = new Uri("http", "user", "example.com", 44, "/path/path2", "query=4", null); + Uri newUri = uri.withNewQuery("query2=10&query3=20"); + assertEquals(newUri.getQuery(), "query2=10&query3=20"); + assertEquals("http://user@example.com:44/path/path2?query2=10&query3=20", newUri.toUrl(), "toUrl returned incorrect url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testToRelativeUrl() { + Uri uri = new Uri("http", "user", "example.com", 44, "/path/path2", "query=4", null); + String relativeUrl = uri.toRelativeUrl(); + assertEquals("/path/path2?query=4", relativeUrl, "toRelativeUrl returned incorrect url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testToRelativeUrlWithEmptyPath() { + Uri uri = new Uri("http", "user", "example.com", 44, null, "query=4", null); + String relativeUrl = uri.toRelativeUrl(); + assertEquals("/?query=4", relativeUrl, "toRelativeUrl returned incorrect url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetSchemeDefaultPortHttpScheme() { + String url = "https://hello.com/level1/level2/level3"; + Uri uri = Uri.create(url); + assertEquals(443, uri.getSchemeDefaultPort(), "schema default port should be 443 for https url"); + + String url2 = "http://hello.com/level1/level2/level3"; + Uri uri2 = Uri.create(url2); + assertEquals(80, uri2.getSchemeDefaultPort(), "schema default port should be 80 for http url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetSchemeDefaultPortWebSocketScheme() { + String url = "wss://hello.com/level1/level2/level3"; + Uri uri = Uri.create(url); + assertEquals(443, uri.getSchemeDefaultPort(), "schema default port should be 443 for wss url"); + + String url2 = "ws://hello.com/level1/level2/level3"; + Uri uri2 = Uri.create(url2); + assertEquals(80, uri2.getSchemeDefaultPort(), "schema default port should be 80 for ws url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetExplicitPort() { + String url = "http://hello.com/level1/level2/level3"; + Uri uri = Uri.create(url); + assertEquals(80, uri.getExplicitPort(), "getExplicitPort should return port 80 for http url when port is not specified in url"); + + String url2 = "http://hello.com:8080/level1/level2/level3"; + Uri uri2 = Uri.create(url2); + assertEquals(8080, uri2.getExplicitPort(), "getExplicitPort should return the port given in the url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testEquals() { + String url = "http://user@hello.com:8080/level1/level2/level3?q=1"; + Uri createdUri = Uri.create(url); + Uri constructedUri = new Uri("http", "user", "hello.com", 8080, "/level1/level2/level3", "q=1", null); + assertEquals(createdUri, constructedUri, "The equals method returned false for two equal urls"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + void testFragment() { + String url = "http://user@hello.com:8080/level1/level2/level3?q=1"; + String fragment = "foo"; + String urlWithFragment = url + '#' + fragment; + Uri uri = Uri.create(urlWithFragment); + assertEquals(uri.getFragment(), fragment, "Fragment should be extracted"); + assertEquals(url, uri.toUrl(), "toUrl should return without fragment"); + assertEquals(urlWithFragment, uri.toFullUrl(), "toFullUrl should return with fragment"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + void testRelativeFragment() { + Uri uri = Uri.create(Uri.create("http://user@hello.com:8080/"), "/level1/level2/level3?q=1#foo"); + assertEquals("foo", uri.getFragment(), "fragment should be kept when computing a relative url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIsWebsocket() { + String url = "http://user@hello.com:8080/level1/level2/level3?q=1"; + Uri uri = Uri.create(url); + assertFalse(uri.isWebSocket(), "isWebSocket should return false for http url"); + + url = "https://user@hello.com:8080/level1/level2/level3?q=1"; + uri = Uri.create(url); + assertFalse(uri.isWebSocket(), "isWebSocket should return false for https url"); + + url = "ws://user@hello.com:8080/level1/level2/level3?q=1"; + uri = Uri.create(url); + assertTrue(uri.isWebSocket(), "isWebSocket should return true for ws url"); + + url = "wss://user@hello.com:8080/level1/level2/level3?q=1"; + uri = Uri.create(url); + assertTrue(uri.isWebSocket(), "isWebSocket should return true for wss url"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void creatingUriWithDefinedSchemeAndHostWorks() { + Uri.create("http://localhost/"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void creatingUriWithMissingSchemeThrowsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> Uri.create("localhost")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void creatingUriWithMissingHostThrowsIllegalArgumentException() { + assertThrows(IllegalArgumentException.class, () -> Uri.create("http://")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetAuthority() { + Uri uri = Uri.create("http://stackoverflow.com/questions/17814461/jacoco-maven-testng-0-test-coverage"); + assertEquals("stackoverflow.com:80", uri.getAuthority(), "Incorrect authority returned from getAuthority"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetAuthorityWithPortInUrl() { + Uri uri = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + assertEquals("stackoverflow.com:8443", uri.getAuthority(), "Incorrect authority returned from getAuthority"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetBaseUrl() { + Uri uri = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + assertEquals("http://stackoverflow.com:8443/", uri.getBaseUrl(), "Incorrect base URL returned from getBaseURL"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIsSameBaseUrlReturnsFalseWhenPortDifferent() { + Uri uri1 = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + Uri uri2 = Uri.create("http://stackoverflow.com:8442/questions/1057564/pretty-git-branch-graphs"); + assertFalse(uri1.isSameBase(uri2), "Base URLs should be different, but true was returned from isSameBase"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIsSameBaseUrlReturnsFalseWhenSchemeDifferent() { + Uri uri1 = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + Uri uri2 = Uri.create("ws://stackoverflow.com:8443/questions/1057564/pretty-git-branch-graphs"); + assertFalse(uri1.isSameBase(uri2), "Base URLs should be different, but true was returned from isSameBase"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIsSameBaseUrlReturnsFalseWhenHostDifferent() { + Uri uri1 = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + Uri uri2 = Uri.create("http://example.com:8443/questions/1057564/pretty-git-branch-graphs"); + assertFalse(uri1.isSameBase(uri2), "Base URLs should be different, but true was returned from isSameBase"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testIsSameBaseUrlReturnsTrueWhenOneUriHasDefaultPort() { + Uri uri1 = Uri.create("http://stackoverflow.com/questions/17814461/jacoco-maven-testng-0-test-coverage"); + Uri uri2 = Uri.create("http://stackoverflow.com/questions/1057564/pretty-git-branch-graphs"); + assertTrue(uri1.isSameBase(uri2), "Base URLs should be same, but false was returned from isSameBase"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetPathWhenPathIsNonEmpty() { + Uri uri = Uri.create("http://stackoverflow.com:8443/questions/17814461/jacoco-maven-testng-0-test-coverage"); + assertEquals("/questions/17814461/jacoco-maven-testng-0-test-coverage", uri.getNonEmptyPath(), "Incorrect path returned from getNonEmptyPath"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetPathWhenPathIsEmpty() { + Uri uri = Uri.create("http://stackoverflow.com/"); + assertEquals("/", uri.getNonEmptyPath(), "Incorrect path returned from getNonEmptyPath"); + } +} diff --git a/client/src/test/java/org/asynchttpclient/util/HttpUtilsTest.java b/client/src/test/java/org/asynchttpclient/util/HttpUtilsTest.java new file mode 100644 index 0000000000..57d031498d --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/util/HttpUtilsTest.java @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import io.github.artsok.RepeatedIfExceptionsTest; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.asynchttpclient.DefaultAsyncHttpClientConfig; +import org.asynchttpclient.Dsl; +import org.asynchttpclient.Param; +import org.asynchttpclient.Request; +import org.asynchttpclient.uri.Uri; + +import java.net.URLEncoder; +import java.nio.ByteBuffer; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; + +import static io.netty.handler.codec.http.HttpHeaderValues.APPLICATION_JSON; +import static java.nio.charset.StandardCharsets.ISO_8859_1; +import static java.nio.charset.StandardCharsets.US_ASCII; +import static java.nio.charset.StandardCharsets.UTF_8; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class HttpUtilsTest { + + private static String toUsAsciiString(ByteBuffer buf) { + ByteBuf bb = Unpooled.wrappedBuffer(buf); + try { + return bb.toString(US_ASCII); + } finally { + bb.release(); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testExtractCharsetWithoutQuotes() { + Charset charset = HttpUtils.extractContentTypeCharsetAttribute("text/html; charset=iso-8859-1"); + assertEquals(ISO_8859_1, charset); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testExtractCharsetWithSingleQuotes() { + Charset charset = HttpUtils.extractContentTypeCharsetAttribute("text/html; charset='iso-8859-1'"); + assertEquals(ISO_8859_1, charset); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testExtractCharsetWithDoubleQuotes() { + Charset charset = HttpUtils.extractContentTypeCharsetAttribute("text/html; charset=\"iso-8859-1\""); + assertEquals(ISO_8859_1, charset); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testExtractCharsetWithDoubleQuotesAndSpaces() { + Charset charset = HttpUtils.extractContentTypeCharsetAttribute("text/html; charset= \"iso-8859-1\" "); + assertEquals(ISO_8859_1, charset); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testExtractCharsetFallsBackToUtf8() { + Charset charset = HttpUtils.extractContentTypeCharsetAttribute(APPLICATION_JSON.toString()); + assertNull(charset); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetHostHeader() { + Uri uri = Uri.create("https://stackoverflow.com/questions/1057564/pretty-git-branch-graphs"); + String hostHeader = HttpUtils.hostHeader(uri); + assertEquals("stackoverflow.com", hostHeader, "Incorrect hostHeader returned"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testDefaultFollowRedirect() { + Request request = Dsl.get("https://shieldblaze.com/").setVirtualHost("shieldblaze.com").setFollowRedirect(false).build(); + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder().build(); + boolean followRedirect = HttpUtils.followRedirect(config, request); + assertFalse(followRedirect, "Default value of redirect should be false"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetFollowRedirectInRequest() { + Request request = Dsl.get("https://stackoverflow.com/questions/1057564").setFollowRedirect(true).build(); + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder().build(); + boolean followRedirect = HttpUtils.followRedirect(config, request); + assertTrue(followRedirect, "Follow redirect must be true as set in the request"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetFollowRedirectInConfig() { + Request request = Dsl.get("https://stackoverflow.com/questions/1057564").build(); + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder().setFollowRedirect(true).build(); + boolean followRedirect = HttpUtils.followRedirect(config, request); + assertTrue(followRedirect, "Follow redirect should be equal to value specified in config when not specified in request"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testGetFollowRedirectPriorityGivenToRequest() { + Request request = Dsl.get("https://stackoverflow.com/questions/1057564").setFollowRedirect(false).build(); + DefaultAsyncHttpClientConfig config = new DefaultAsyncHttpClientConfig.Builder().setFollowRedirect(true).build(); + boolean followRedirect = HttpUtils.followRedirect(config, request); + assertFalse(followRedirect, "Follow redirect value set in request should be given priority"); + } + + private static void formUrlEncoding(Charset charset) throws Exception { + String key = "key"; + String value = "中文"; + List params = new ArrayList<>(); + params.add(new Param(key, value)); + ByteBuffer ahcBytes = HttpUtils.urlEncodeFormParams(params, charset); + String ahcString = toUsAsciiString(ahcBytes); + String jdkString = key + '=' + URLEncoder.encode(value, charset); + assertEquals(ahcString, jdkString); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void formUrlEncodingShouldSupportUtf8Charset() throws Exception { + formUrlEncoding(UTF_8); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void formUrlEncodingShouldSupportNonUtf8Charset() throws Exception { + formUrlEncoding(Charset.forName("GBK")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForPlainUriWithImplicitPort() { + assertEquals("http://foo.com/", HttpUtils.originHeader(Uri.create("ws://foo.com/bar"))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForPlainUriWithDefaultPort() { + assertEquals("http://foo.com/", HttpUtils.originHeader(Uri.create("ws://foo.com:80/bar"))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForPlainUriWithNonDefaultPort() { + assertEquals("http://foo.com:81/", HttpUtils.originHeader(Uri.create("ws://foo.com:81/bar"))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForSecuredUriWithImplicitPort() { + assertEquals("https://foo.com/", HttpUtils.originHeader(Uri.create("wss://foo.com/bar"))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForSecuredUriWithDefaultPort() { + assertEquals("https://foo.com/", HttpUtils.originHeader(Uri.create("wss://foo.com:443/bar"))); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void computeOriginForSecuredUriWithNonDefaultPort() { + assertEquals("https://foo.com:444/", HttpUtils.originHeader(Uri.create("wss://foo.com:444/bar"))); + } +} diff --git a/client/src/test/java/org/asynchttpclient/util/Utf8UrlEncoderTest.java b/client/src/test/java/org/asynchttpclient/util/Utf8UrlEncoderTest.java new file mode 100644 index 0000000000..ee3966cf0f --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/util/Utf8UrlEncoderTest.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2018-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.util; + +import io.github.artsok.RepeatedIfExceptionsTest; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class Utf8UrlEncoderTest { + + @RepeatedIfExceptionsTest(repeats = 5) + public void testBasics() { + assertEquals("foobar", Utf8UrlEncoder.encodeQueryElement("foobar")); + assertEquals("a%26b", Utf8UrlEncoder.encodeQueryElement("a&b")); + assertEquals("a%2Bb", Utf8UrlEncoder.encodeQueryElement("a+b")); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void testPercentageEncoding() { + assertEquals("foobar", Utf8UrlEncoder.percentEncodeQueryElement("foobar")); + assertEquals("foo%2Abar", Utf8UrlEncoder.percentEncodeQueryElement("foo*bar")); + assertEquals("foo~b_ar", Utf8UrlEncoder.percentEncodeQueryElement("foo~b_ar")); + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/AbstractBasicWebSocketTest.java b/client/src/test/java/org/asynchttpclient/ws/AbstractBasicWebSocketTest.java new file mode 100644 index 0000000000..4e1ea362de --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/AbstractBasicWebSocketTest.java @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +import org.asynchttpclient.AbstractBasicTest; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.websocket.server.config.JettyWebSocketServletContainerInitializer; +import org.junit.jupiter.api.BeforeEach; + +import static org.asynchttpclient.test.TestUtils.addHttpConnector; + +public abstract class AbstractBasicWebSocketTest extends AbstractBasicTest { + + @Override + @BeforeEach + public void setUpGlobal() throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(configureHandler()); + server.start(); + port1 = connector.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @Override + public void tearDownGlobal() throws Exception { + if (server != null) { + server.stop(); + } + } + + @Override + protected String getTargetUrl() { + return String.format("ws://localhost:%d/", port1); + } + + @Override + public AbstractHandler configureHandler() { + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.setContextPath("/"); + server.setHandler(context); + + // Configure specific websocket behavior + JettyWebSocketServletContainerInitializer.configure(context, (servletContext, wsContainer) -> { + // Configure default max size + wsContainer.setMaxTextMessageSize(65535); + + // Add websockets + wsContainer.addMapping("/", EchoWebSocket.class); + }); + return context; + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/ByteMessageTest.java b/client/src/test/java/org/asynchttpclient/ws/ByteMessageTest.java new file mode 100644 index 0000000000..a265376494 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/ByteMessageTest.java @@ -0,0 +1,211 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHttpClient; + +import java.nio.charset.StandardCharsets; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; + +public class ByteMessageTest extends AbstractBasicWebSocketTest { + + private static final byte[] ECHO_BYTES = "ECHO".getBytes(StandardCharsets.UTF_8); + public static final byte[] BYTES = new byte[0]; + + private void echoByte0(boolean enableCompression) throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setEnablewebSocketCompression(enableCompression))) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference receivedBytes = new AtomicReference<>(BYTES); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + + @Override + public void onBinaryFrame(byte[] frame, boolean finalFragment, int rsv) { + receivedBytes.set(frame); + latch.countDown(); + } + }).build()).get(); + + websocket.sendBinaryFrame(ECHO_BYTES); + + latch.await(); + assertArrayEquals(ECHO_BYTES, receivedBytes.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoByte() throws Exception { + echoByte0(false); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoByteCompressed() throws Exception { + echoByte0(true); + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoTwoMessagesTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(2); + final AtomicReference text = new AtomicReference<>(null); + + WebSocket websocket = client.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + + @Override + public void onBinaryFrame(byte[] frame, boolean finalFragment, int rsv) { + if (text.get() == null) { + text.set(frame); + } else { + byte[] n = new byte[text.get().length + frame.length]; + System.arraycopy(text.get(), 0, n, 0, text.get().length); + System.arraycopy(frame, 0, n, text.get().length, frame.length); + text.set(n); + } + latch.countDown(); + } + + }).build()).get(); + + websocket.sendBinaryFrame(ECHO_BYTES); + websocket.sendBinaryFrame(ECHO_BYTES); + + latch.await(); + assertArrayEquals("ECHOECHO".getBytes(), text.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoOnOpenMessagesTest() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(2); + final AtomicReference text = new AtomicReference<>(null); + + client.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + websocket.sendBinaryFrame(ECHO_BYTES); + websocket.sendBinaryFrame(ECHO_BYTES); + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + + @Override + public void onBinaryFrame(byte[] frame, boolean finalFragment, int rsv) { + if (text.get() == null) { + text.set(frame); + } else { + byte[] n = new byte[text.get().length + frame.length]; + System.arraycopy(text.get(), 0, n, 0, text.get().length); + System.arraycopy(frame, 0, n, text.get().length, frame.length); + text.set(n); + } + latch.countDown(); + } + + }).build()).get(); + + latch.await(); + assertArrayEquals(text.get(), "ECHOECHO".getBytes()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoFragments() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(null); + + WebSocket websocket = client.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + + @Override + public void onBinaryFrame(byte[] frame, boolean finalFragment, int rsv) { + if (text.get() == null) { + text.set(frame); + } else { + byte[] n = new byte[text.get().length + frame.length]; + System.arraycopy(text.get(), 0, n, 0, text.get().length); + System.arraycopy(frame, 0, n, text.get().length, frame.length); + text.set(n); + } + latch.countDown(); + } + + }).build()).get(); + websocket.sendBinaryFrame(ECHO_BYTES, false, 0); + websocket.sendContinuationFrame(ECHO_BYTES, true, 0); + latch.await(); + assertArrayEquals("ECHOECHO".getBytes(), text.get()); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/CloseCodeReasonMessageTest.java b/client/src/test/java/org/asynchttpclient/ws/CloseCodeReasonMessageTest.java new file mode 100644 index 0000000000..c87dcc2b16 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/CloseCodeReasonMessageTest.java @@ -0,0 +1,173 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHttpClient; +import org.junit.jupiter.api.Timeout; + +import java.io.IOException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +public class CloseCodeReasonMessageTest extends AbstractBasicWebSocketTest { + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onCloseWithCode() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new Listener(latch, text)).build()).get(); + + websocket.sendCloseFrame(); + + latch.await(); + assertTrue(text.get().startsWith("1000"), "Expected a 1000 code but got " + text.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onCloseWithCodeServerClose() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new Listener(latch, text)).build()).get(); + + latch.await(); + assertEquals("1001-Connection Idle Timeout", text.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void getWebSocketThrowsException() throws Throwable { + final CountDownLatch latch = new CountDownLatch(1); + try (AsyncHttpClient client = asyncHttpClient()) { + assertThrows(Exception.class, () -> { + client.prepareGet("http://apache.org/").execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + } + + @Override + public void onError(Throwable t) { + latch.countDown(); + } + }).build()).get(); + }); + } + + latch.await(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void wrongStatusCode() throws Exception { + try (AsyncHttpClient client = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference throwable = new AtomicReference<>(); + + client.prepareGet("ws://apache.org").execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + } + + @Override + public void onError(Throwable t) { + throwable.set(t); + latch.countDown(); + } + }).build()); + + latch.await(); + assertInstanceOf(Exception.class, throwable.get()); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void wrongProtocolCode() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference throwable = new AtomicReference<>(); + + c.prepareGet("ws://www.google.com").execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + } + + @Override + public void onError(Throwable t) { + throwable.set(t); + latch.countDown(); + } + }).build()); + + latch.await(); + assertInstanceOf(IOException.class, throwable.get()); + } + } + + public static final class Listener implements WebSocketListener { + + final CountDownLatch latch; + final AtomicReference text; + + Listener(CountDownLatch latch, AtomicReference text) { + this.latch = latch; + this.text = text; + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + text.set(code + "-" + reason); + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/EchoWebSocket.java b/client/src/test/java/org/asynchttpclient/ws/EchoWebSocket.java new file mode 100644 index 0000000000..0161564fc1 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/EchoWebSocket.java @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2015-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import org.eclipse.jetty.websocket.api.Session; +import org.eclipse.jetty.websocket.api.WebSocketAdapter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.time.Duration; + +import static java.nio.charset.StandardCharsets.UTF_8; + +public class EchoWebSocket extends WebSocketAdapter { + + private static final Logger LOGGER = LoggerFactory.getLogger(EchoWebSocket.class); + + @Override + public void onWebSocketConnect(Session sess) { + super.onWebSocketConnect(sess); + sess.setIdleTimeout(Duration.ofMillis(10_000)); + } + + @Override + public void onWebSocketClose(int statusCode, String reason) { + getSession().close(); + super.onWebSocketClose(statusCode, reason); + } + + @Override + public void onWebSocketBinary(byte[] payload, int offset, int len) { + if (isNotConnected()) { + return; + } + try { + LOGGER.debug("Received binary frame of size {}: {}", len, new String(payload, offset, len, UTF_8)); + getRemote().sendBytes(ByteBuffer.wrap(payload, offset, len)); + } catch (IOException e) { + e.printStackTrace(); + } + } + + @Override + public void onWebSocketText(String message) { + if (isNotConnected()) { + return; + } + + if ("CLOSE".equals(message)) { + getSession().close(); + return; + } + + try { + LOGGER.debug("Received text frame of size: {}", message); + getRemote().sendString(message); + } catch (IOException e) { + e.printStackTrace(); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/ProxyTunnellingTest.java b/client/src/test/java/org/asynchttpclient/ws/ProxyTunnellingTest.java new file mode 100644 index 0000000000..ce9cda3dc4 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/ProxyTunnellingTest.java @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHttpClient; +import org.asynchttpclient.proxy.ProxyServer; +import org.eclipse.jetty.proxy.ConnectHandler; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.eclipse.jetty.servlet.ServletContextHandler; +import org.eclipse.jetty.websocket.server.config.JettyWebSocketServletContainerInitializer; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Timeout; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.Dsl.proxyServer; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.asynchttpclient.test.TestUtils.addHttpsConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +/** + * Proxy usage tests. + */ +public class ProxyTunnellingTest extends AbstractBasicWebSocketTest { + + private Server server2; + + @Override + @BeforeAll + public void setUpGlobal() throws Exception { + // Don't call Global + } + + @Override + @AfterAll + public void tearDownGlobal() throws Exception { + server.stop(); + server2.stop(); + } + + @AfterEach + public void cleanup() throws Exception { + super.tearDownGlobal(); + server2.stop(); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void echoWSText() throws Exception { + runTest(false); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void echoWSSText() throws Exception { + runTest(true); + } + + private void runTest(boolean secure) throws Exception { + setUpServers(secure); + String targetUrl = String.format("%s://localhost:%d/", secure ? "wss" : "ws", port2); + + // CONNECT happens over HTTP, not HTTPS + ProxyServer ps = proxyServer("localhost", port1).build(); + try (AsyncHttpClient asyncHttpClient = asyncHttpClient(config().setProxyServer(ps).setUseInsecureTrustManager(true))) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = asyncHttpClient.prepareGet(targetUrl).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + websocket.sendTextFrame("ECHO"); + + latch.await(); + assertEquals("ECHO", text.get()); + } + } + + private void setUpServers(boolean targetHttps) throws Exception { + server = new Server(); + ServerConnector connector = addHttpConnector(server); + server.setHandler(new ConnectHandler()); + server.start(); + port1 = connector.getLocalPort(); + + server2 = new Server(); + ServerConnector connector2 = targetHttps ? addHttpsConnector(server2) : addHttpConnector(server2); + server2.setHandler(configureHandler()); + server2.start(); + port2 = connector2.getLocalPort(); + + logger.info("Local HTTP server started successfully"); + } + + @Override + public AbstractHandler configureHandler() { + ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); + context.setContextPath("/"); + server2.setHandler(context); + + // Configure specific websocket behavior + JettyWebSocketServletContainerInitializer.configure(context, (servletContext, wsContainer) -> { + // Configure default max size + wsContainer.setMaxTextMessageSize(65535); + + // Add websockets + wsContainer.addMapping("/", EchoWebSocket.class); + }); + return context; + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/RedirectTest.java b/client/src/test/java/org/asynchttpclient/ws/RedirectTest.java new file mode 100644 index 0000000000..c0581d9a00 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/RedirectTest.java @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.asynchttpclient.AsyncHttpClient; +import org.eclipse.jetty.server.Request; +import org.eclipse.jetty.server.Server; +import org.eclipse.jetty.server.ServerConnector; +import org.eclipse.jetty.server.handler.AbstractHandler; +import org.eclipse.jetty.server.handler.HandlerList; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Timeout; + +import java.io.IOException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.asynchttpclient.Dsl.config; +import static org.asynchttpclient.test.TestUtils.addHttpConnector; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class RedirectTest extends AbstractBasicWebSocketTest { + + @BeforeEach + public void setUpGlobals() throws Exception { + server = new Server(); + ServerConnector connector1 = addHttpConnector(server); + ServerConnector connector2 = addHttpConnector(server); + + HandlerList list = new HandlerList(); + list.addHandler(new AbstractHandler() { + @Override + public void handle(String s, Request request, HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws IOException { + if (request.getLocalPort() == port2) { + httpServletResponse.sendRedirect(getTargetUrl()); + } + } + }); + list.addHandler(configureHandler()); + server.setHandler(list); + + server.start(); + port1 = connector1.getLocalPort(); + port2 = connector2.getLocalPort(); + logger.info("Local HTTP server started successfully"); + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void testRedirectToWSResource() throws Exception { + try (AsyncHttpClient c = asyncHttpClient(config().setFollowRedirect(true))) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getRedirectURL()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + text.set("OnOpen"); + latch.countDown(); + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + latch.await(); + assertEquals("OnOpen", text.get()); + websocket.sendCloseFrame(); + } + } + + private String getRedirectURL() { + return String.format("ws://localhost:%d/", port2); + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/TextMessageTest.java b/client/src/test/java/org/asynchttpclient/ws/TextMessageTest.java new file mode 100644 index 0000000000..f25e0e5333 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/TextMessageTest.java @@ -0,0 +1,368 @@ +/* + * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. + * + * This program is licensed to you under the Apache License Version 2.0, + * and you may not use this file except in compliance with the Apache License Version 2.0. + * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the Apache License Version 2.0 is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHttpClient; +import org.junit.jupiter.api.Timeout; + +import java.net.ConnectException; +import java.net.UnknownHostException; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicReference; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.fail; + +public class TextMessageTest extends AbstractBasicWebSocketTest { + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onOpen() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + text.set("OnOpen"); + latch.countDown(); + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + latch.await(); + assertEquals(text.get(), "OnOpen"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onEmptyListenerTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + WebSocket websocket = null; + try { + websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().build()).get(); + } catch (Throwable t) { + fail(); + } + assertNotNull(websocket); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onFailureTest() throws Throwable { + try (AsyncHttpClient c = asyncHttpClient()) { + c.prepareGet("ws://abcdefg").execute(new WebSocketUpgradeHandler.Builder().build()).get(); + } catch (ExecutionException e) { + if (!(e.getCause() instanceof UnknownHostException || e.getCause() instanceof ConnectException)) { + fail("Exception is not UnknownHostException or ConnectException but rather: " + e); + } + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onTimeoutCloseTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + text.set("OnClose"); + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + latch.await(); + assertEquals(text.get(), "OnClose"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void onClose() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + text.set("OnClose"); + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + websocket.sendCloseFrame(); + + latch.await(); + assertEquals(text.get(), "OnClose"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void echoText() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + websocket.sendTextFrame("ECHO"); + + latch.await(); + assertEquals(text.get(), "ECHO"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void echoDoubleListenerText() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(2); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(text.get() + payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + websocket.sendTextFrame("ECHO"); + + latch.await(); + assertEquals(text.get(), "ECHOECHO"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoTwoMessagesTest() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(2); + final AtomicReference text = new AtomicReference<>(""); + + c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(text.get() + payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + websocket.sendTextFrame("ECHO"); + websocket.sendTextFrame("ECHO"); + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + latch.await(); + assertEquals(text.get(), "ECHOECHO"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void echoFragments() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch latch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(payload); + latch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + latch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + latch.countDown(); + } + }).build()).get(); + + websocket.sendTextFrame("ECHO", false, 0); + websocket.sendContinuationFrame("ECHO", true, 0); + + latch.await(); + assertEquals(text.get(), "ECHOECHO"); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void echoTextAndThenClose() throws Throwable { + try (AsyncHttpClient c = asyncHttpClient()) { + final CountDownLatch textLatch = new CountDownLatch(1); + final CountDownLatch closeLatch = new CountDownLatch(1); + final AtomicReference text = new AtomicReference<>(""); + + final WebSocket websocket = c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onTextFrame(String payload, boolean finalFragment, int rsv) { + text.set(text.get() + payload); + textLatch.countDown(); + } + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + closeLatch.countDown(); + } + + @Override + public void onError(Throwable t) { + t.printStackTrace(); + closeLatch.countDown(); + } + }).build()).get(); + + websocket.sendTextFrame("ECHO"); + textLatch.await(); + + websocket.sendTextFrame("CLOSE"); + closeLatch.await(); + + assertEquals(text.get(), "ECHO"); + } + } +} diff --git a/client/src/test/java/org/asynchttpclient/ws/WebSocketWriteFutureTest.java b/client/src/test/java/org/asynchttpclient/ws/WebSocketWriteFutureTest.java new file mode 100644 index 0000000000..e0edc54998 --- /dev/null +++ b/client/src/test/java/org/asynchttpclient/ws/WebSocketWriteFutureTest.java @@ -0,0 +1,170 @@ +/* + * Copyright (c) 2017-2023 AsyncHttpClient Project. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.asynchttpclient.ws; + +import io.github.artsok.RepeatedIfExceptionsTest; +import org.asynchttpclient.AsyncHttpClient; +import org.junit.jupiter.api.Timeout; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import static org.asynchttpclient.Dsl.asyncHttpClient; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class WebSocketWriteFutureTest extends AbstractBasicWebSocketTest { + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendTextMessage() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendTextFrame("TEXT").get(10, TimeUnit.SECONDS); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendTextMessageExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendTextFrame("TEXT").get(10, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendByteMessage() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendBinaryFrame("BYTES".getBytes()).get(10, TimeUnit.SECONDS); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendByteMessageExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendBinaryFrame("BYTES".getBytes()).get(10, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendPingMessage() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendPingFrame("PING".getBytes()).get(10, TimeUnit.SECONDS); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendPingMessageExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendPingFrame("PING".getBytes()).get(10, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendPongMessage() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendPongFrame("PONG".getBytes()).get(10, TimeUnit.SECONDS); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void sendPongMessageExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendPongFrame("PONG".getBytes()).get(1, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void streamBytes() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendBinaryFrame("STREAM".getBytes(), true, 0).get(1, TimeUnit.SECONDS); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + @Timeout(unit = TimeUnit.MILLISECONDS, value = 60000) + public void streamBytesExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendBinaryFrame("STREAM".getBytes(), true, 0).get(1, TimeUnit.SECONDS)); + } + } + + @RepeatedIfExceptionsTest(repeats = 5) + public void streamText() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + getWebSocket(c).sendTextFrame("STREAM", true, 0).get(1, TimeUnit.SECONDS); + } + } + + + @RepeatedIfExceptionsTest(repeats = 5) + public void streamTextExpectFailure() throws Exception { + try (AsyncHttpClient c = asyncHttpClient()) { + CountDownLatch closeLatch = new CountDownLatch(1); + WebSocket websocket = getWebSocket(c, closeLatch); + websocket.sendCloseFrame(); + closeLatch.await(1, TimeUnit.SECONDS); + assertThrows(Exception.class, () -> websocket.sendTextFrame("STREAM", true, 0).get(1, TimeUnit.SECONDS)); + } + } + + private WebSocket getWebSocket(final AsyncHttpClient c) throws Exception { + return c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().build()).get(); + } + + private WebSocket getWebSocket(final AsyncHttpClient c, CountDownLatch closeLatch) throws Exception { + return c.prepareGet(getTargetUrl()).execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { + + @Override + public void onOpen(WebSocket websocket) { + } + + @Override + public void onError(Throwable t) { + } + + @Override + public void onClose(WebSocket websocket, int code, String reason) { + closeLatch.countDown(); + } + }).build()).get(); + } +} diff --git a/src/test/resources/300k.png b/client/src/test/resources/300k.png similarity index 100% rename from src/test/resources/300k.png rename to client/src/test/resources/300k.png diff --git a/client/src/test/resources/META-INF/services/org.apache.juli.logging.Log b/client/src/test/resources/META-INF/services/org.apache.juli.logging.Log new file mode 100644 index 0000000000..9099aa34ec --- /dev/null +++ b/client/src/test/resources/META-INF/services/org.apache.juli.logging.Log @@ -0,0 +1 @@ +org.asynchttpclient.test.Slf4jJuliLog \ No newline at end of file diff --git a/src/test/resources/SimpleTextFile.txt b/client/src/test/resources/SimpleTextFile.txt similarity index 100% rename from src/test/resources/SimpleTextFile.txt rename to client/src/test/resources/SimpleTextFile.txt diff --git a/src/test/resources/client.keystore b/client/src/test/resources/client.keystore similarity index 100% rename from src/test/resources/client.keystore rename to client/src/test/resources/client.keystore diff --git a/client/src/test/resources/empty.txt b/client/src/test/resources/empty.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/test/resources/gzip.txt.gz b/client/src/test/resources/gzip.txt.gz similarity index 100% rename from src/test/resources/gzip.txt.gz rename to client/src/test/resources/gzip.txt.gz diff --git a/client/src/test/resources/kerberos.jaas b/client/src/test/resources/kerberos.jaas new file mode 100644 index 0000000000..cd5b316bf1 --- /dev/null +++ b/client/src/test/resources/kerberos.jaas @@ -0,0 +1,8 @@ + +alice { + com.sun.security.auth.module.Krb5LoginModule required refreshKrb5Config=true useKeyTab=false principal="alice"; +}; + +bob { + com.sun.security.auth.module.Krb5LoginModule required refreshKrb5Config=true useKeyTab=false storeKey=true principal="bob/service.ws.apache.org"; +}; diff --git a/src/test/resources/logback-test.xml b/client/src/test/resources/logback-test.xml similarity index 80% rename from src/test/resources/logback-test.xml rename to client/src/test/resources/logback-test.xml index 4acf278710..4b6a087912 100644 --- a/src/test/resources/logback-test.xml +++ b/client/src/test/resources/logback-test.xml @@ -6,8 +6,9 @@ + - + - \ No newline at end of file + diff --git a/src/test/resources/realm.properties b/client/src/test/resources/realm.properties similarity index 100% rename from src/test/resources/realm.properties rename to client/src/test/resources/realm.properties diff --git a/src/test/resources/ssltest-cacerts.jks b/client/src/test/resources/ssltest-cacerts.jks similarity index 86% rename from src/test/resources/ssltest-cacerts.jks rename to client/src/test/resources/ssltest-cacerts.jks index 9c1ffbe49a..207b9646e6 100644 Binary files a/src/test/resources/ssltest-cacerts.jks and b/client/src/test/resources/ssltest-cacerts.jks differ diff --git a/client/src/test/resources/ssltest-keystore.jks b/client/src/test/resources/ssltest-keystore.jks new file mode 100644 index 0000000000..70267836e8 Binary files /dev/null and b/client/src/test/resources/ssltest-keystore.jks differ diff --git a/client/src/test/resources/test_sample_message.eml b/client/src/test/resources/test_sample_message.eml new file mode 100644 index 0000000000..79ecb11a50 --- /dev/null +++ b/client/src/test/resources/test_sample_message.eml @@ -0,0 +1,171 @@ +Return-Path: <${OX_USER_EMAIL1}> +To: ${OX_USER_FIRST_NAME} ${OX_USER_LAST_NAME} <${OX_USER_EMAIL1}> +Subject: Testing ${OX_USER_FIRST_NAME} ${OX_USER_LAST_NAME}' MIME E-mail composing and sending PHP class: HTML message +From: ${username} <${OX_USER_EMAIL1}> +Reply-To: ${username} <${OX_USER_EMAIL1}> +Sender: ${OX_USER_EMAIL1} +X-Mailer: http://www.phpclasses.org/mimemessage $Revision: 1.63 $ (mail) +MIME-Version: 1.0 +Content-Type: multipart/mixed; boundary="652b8c4dcb00cdcdda1e16af36781caf" +Message-ID: <20050430192829.0489.mlemos@acm.org> +Date: Sat, 30 Apr 2005 19:28:29 -0300 + + +--652b8c4dcb00cdcdda1e16af36781caf +Content-Type: multipart/related; boundary="6a82fb459dcaacd40ab3404529e808dc" + + +--6a82fb459dcaacd40ab3404529e808dc +Content-Type: multipart/alternative; boundary="69c1683a3ee16ef7cf16edd700694a2f" + + +--69c1683a3ee16ef7cf16edd700694a2f +Content-Type: text/plain; charset=ISO-8859-1 +Content-Transfer-Encoding: quoted-printable + +This is an HTML message. Please use an HTML capable mail program to read +this message. + +--69c1683a3ee16ef7cf16edd700694a2f +Content-Type: text/html; charset=ISO-8859-1 +Content-Transfer-Encoding: quoted-printable + + + +Testing Manuel Lemos' MIME E-mail composing and sending PHP class: H= +TML message + + + + + + + +
+

Testing Manuel Lemos' MIME E-mail composing and sending PHP cla= +ss: HTML message

+
+

Hello Manuel,

+This message is just to let you know that the MIME E-mail message composing and sending PHP class is working as expected.

+

Here is an image embedded in a message as a separate part:

= +
+
Than= +k you,
+mlemos

+
+ + +--69c1683a3ee16ef7cf16edd700694a2f-- + +--6a82fb459dcaacd40ab3404529e808dc +Content-Type: image/gif; name="logo.gif" +Content-Transfer-Encoding: base64 +Content-Disposition: inline; filename="logo.gif" +Content-ID: + +R0lGODlhlgAjAPMJAAAAAAAA/y8vLz8/P19fX19f339/f4+Pj4+Pz7+/v/////////////////// +/////yH5BAEAAAkALAAAAACWACMAQwT+MMlJq7046827/2AoHYChGAChAkBylgKgKClFyEl6xDMg +qLFBj3C5uXKplVAxIOxkA8BhdFCpDlMK1urMTrZWbAV8tVS5YsxtxmZHBVOSCcW9zaXyNhslVcto +RBp5NQYxLAYGLi8oSwoJBlE+BiSNj5E/PDQsmy4pAJWQLAKJY5+hXhZ2dDYldFWtNSFPiXssXnZR +k5+1pjpBiDMJUXG/Jo7DI4eKfMSmxsJ9GAUB1NXW19jZ2tvc3d7f4OHi2AgZN5vom1kk6F7s6u/p +m3Ab7AOIiCxOyZuBIv8AOeTJIaYQjiR/kKTr5GQNE3pYSjCJ9mUXClRUsLxaZGciC0X+OlpoOuQo +ZKdNJnIoKfnxRUQh6FLG0iLxIoYnJd0JEKISJyAQDodp3EUDC48oDnUY7HFI3wEDRjzycQJVZCQT +Ol7NK+G0qgtkAcOKHUu2rNmzYTVqRMt2bB49bHompSchqg6HcGeANSMxr8sEa2y2HexnSEUTuWri +SSbkYh7BgGVAnhB1b2REibESYaRoBgqIMYx59tFM9AvQffVG49P5NMZkMlHKhJPJb0knmSKZ6kSX +JtbeF3Am7ocok6c7cM7pU5xcXiJJETUz16qPrzEfaFgZpvzn7h86YV5r/1mxXeAUMVyEIpnVUGpN +RlG2ka9b3lP3pm2l6u7P+l/YLj3+RlEHbz1C0kRxSITQaAcilVBMEzmkkEQO8oSOBNg9SN+AX6hV +z1pjgJiAhwCRsY8ZIp6xj1ruqCgeGeKNGEZwLnIwzTg45qjjjjz2GEA5hAUp5JBEFmnkkSCoWEcZ +X8yohZNK1pFGPQS4hx0qNSLJlk9wCQORYu5QiMd7bUzGVyNlRiOHSlpuKdGEItHQ3HZ18beRRyws +YSY/waDTiHf/tWlWUBAJiMJ1/Z0XXU7N0FnREpKM4NChCgbyRDq9XYpOplaKopN9NMkDnBbG+UMC +QwLWIeaiglES6AjGARcPHCWoVAiatcTnGTABZoLPaPG1phccPv366mEvWEFSLnj+2QaonECwcJt/ +e1Zw3lJvVMmftBdVNQS3UngLCA85YHIQOy6JO9N4eZW7KJwtOUZmGwOMWqejwVW6RQzaikRHX3yI +osKhDAq8wmnKSmdMwNidSOof9ZG2DoV0RfTVmLFtGmNk+CoZna0HQnPHS3AhRbIeDpqmR09E0bsu +soeaw994z+rwQVInvqLenBftYjLOVphLFHhV9qsnez8AEUbQRgO737AxChjmyANxuEFHSGi7hFCV +4jxLst2N8sRJYU+SHiAKjlmCgz2IffbLI5aaQR71hnkxq1ZfHSfKata6YDCJDMAQwY7wOgzhjxgj +VFQnKB5uX4mr9qJ79pann+VcfcSzsSCd2mw5scqRRvlQ6TgcUelYhu75iPE4JejrsJOFQAG01277 +7bjnrvvuvPfu++/ABy887hfc6OPxyCevPDdAVoDA89BHL/301Fdv/fXYZ6/99tx3Pz0FEQAAOw== + +--6a82fb459dcaacd40ab3404529e808dc +Content-Type: image/gif; name="background.gif" +Content-Transfer-Encoding: base64 +Content-Disposition: inline; filename="background.gif" +Content-ID: <4c837ed463ad29c820668e835a270e8a.gif> + +R0lGODlh+wHCAPMAAKPFzKLEy6HDyqHCyaDByJ/Ax56/xp2+xZ28xJy7w5u6wpq5wZm4wJm3v5i2 +vpe1vSwAAAAA+wHCAEME/hDISau9OOvNu/9gKI5kaZ5oqq5s675wLM90bd94ru987//AoHBILBqP +yKRyyWw6n9CodEqtWq+gwSHReHgfjobY8X00FIc019tIHAYS7dqcQCDm3vC4fD4QAhUBBFsMZF8O +hnkLCAYFW11tb1iTlJWWOXJdZZtmC24Eg3hgYntfbXainJ2fgBSZbG5wFAG0E6+RoAZ3CbwJCgya +p3cMbAyevQcFAgMGCcRmxr1uyszOxQq+wF4MdcPFx7zJApfk5eYhr3SSGemRsu3dc+4iAqELhZwO +0X6hkHUHCBRoGtUg0RkEAAUeKhhGAcICBQIODIPooIEBzCTmKcjGYSNd/go3VvQo65zJkyhTqlzJ +sqXLlzBjypxJs6bNmzhz6tzJs6fPn0CDCh1KtKjRo0iTKl3KtKnTp1CXBhhAwECaq1gPNCIwANDU +qmkMcG311apWULmyZt3alcPXAma1FgAlgCxVq2LbRt3LF0Y7hwWoEjLEDZUmff8AOjMkTB5gwYu3 +JbhIQUDEZw+4+aE1aNc0R2vcDYjoDBgpBoUDj95yzzRqbH7qgW4t5vUnAfVAoj7NwOOf1QloN7Ad +u1Xf41b+IlCNsa6rR7DWwTPccTnG5sYvCEKwgPGiZI64A9OsK/Q/BM/0YfuFz13VOwsULLhHps+f +98Hl0zeDRk0X9Qih/vLPWPjFN197aPyB3IJVBLDMdc5t4OB1A0QowYQQ0vIgdilgyGEgG1roYV0j +GufhhyBSWGF2s2yIYosqWsjgjDTWaOONOOao44489ujjj0AGKeSQRBZp5JFIJqnkkkw26eSTUMJU +llpYseXVXWGNdSGWZ6EVF5VWukUVXFdtRUCEU+bFYpRslqNcYKHgk1k8hxWWxjCM0VkdnINJRtkE +lqH3hWZ/CKJYOBBBJxppu/FWh2qzNUrcmQRE6lpvt+UWUKPD9cbIb5bWhmlxbbL5JoUywiMddHRQ +x591GWqwXXdsfJeoeMO5UZ4/AaaHKXv1xVKgfghuNuyB9fUHHYAA/u2CEIHlGbiffWuWyuSJMmKA +bXbbbtuhi9kCUOIEJY57oYsraoduuOfGWO2J6Vor77z01mvvvfjmq+++/Pbr778AByzwwAQXbPDB +CCfcZDobldLRVfLEEgerjQ1EEEemJMiioZEdkggYizSiqMQKl5wCw6qswg+rDTvc6h0Wq9KAJ5tV +oGpJF9YysXn8lCfNL8HE88xw4EyzTDNDR4MMNUhfk40mhXkDTdHimHzjzRpgDcB0MEeHswf1sCZn +GfrQDMrIAYZEkEEOJTQRQweBp5FIDTGCEUiHYWwRXHOPMpLdVgcu+OCEF2744YgnrvjijDfu+OOQ +Ry755JRXbvnl/phnrvnmnHfu+eegZ57RAqSUzptv75E+M+Bb66L6InZwZ7rpr31aLQBhb2pap548 +e7TsIX8dOr/pIIZQQphFHfGqEbtq/J2/DDrZ13Ga0jt8h/XX9TxvfRmmuPVUatb34INCplxakjtm +XOQ7aP74c+k1fE4MD7fefvxBbLEeLldsyq/4o9ZzHOOHylBFS7f4RJxQMx/8MeB4ggIDA02ziLno +wlfGoOByKnUAhZQNWfkzwAXzMEExVFB+86NJ/TDVC4SIZRzFs5Ni5OQ/p7XwLOOwQDXSswgFiYuD +Z4GMP8AjtvGgJk9aYU2davdCeyzRU2LpBwkb2KjvWCU4T/TN/u1S+BKtYUBrXFue8DYQKFoVAzXa +eJh/XiYPpZEOFhAMTnzkk8aQWQU+c7yHJkIGkGd4SkDhMJ9i5qMAOu4RAWfiYk1yxwvfaYCRA8oh +JF14x0bGhgSyaZY07JCMRDLyWWnxTOyc1UmweMaSL5zSKf/xQgnk5lA3TCWWVunCRCrylrjMpS53 +ycte+vKXwAymMIdJzGIa85jITKYyl8nMZjrzmdCMpjSnSc1qWvOa2MymvkY3u9IxMReyW92fuLm6 +2Kmum53SIgZyxx7e9C423AyeNnkUw8RsSnqumsfWKKYnCdozen6iHiGsF483gkF7PIND96oUP7KE +73zteyj8/tK3JfGVqaHkkmhYMDrPJqzwfjRUlij4hzE4ds1pdGSMxgYYjAQZEBRtSeDKSmMMEGYG +ghjU4+osGEF9ZNCEG3SEB2s6LTSIsKcl3CkKO2qEj24Sh/ucw/NmmCdXQQMbsbSlzZoGMkSSBYh5 +kWIkEhWc3aARiVc0qE+hSCklkvCbUpQgFTWYRCy+la1bZGoQvHgBMPIznyT7QBkNgsY05m+NNSQa +Lwx6ijvJsZB69IIdB5nHOjKij9twCCAVGJ7HGlKyiMyhXo0wyUtmoLS2LK0ID+XIEWRys5ycyzg+ +yQ9TtjB2lpyLbZ8qy91mVZK+ReWZVCkNVmp1tMhNrnKX/svc5jr3udCNrnSnS93qWve62M2udrfL +3e5697vgDa94x0ve8pr3vOhNr3rXy972uve98I2vfOdLXxrBS0Uv8lZGUaUh/OKXXRmAV7jMVV+X +QLK4vD0TaoHLWq1UEsEJFu0FXknLh3iyM5EssEtQlrK98ZN5QbNqyl71pwqEza752MfZEqrhljg1 +pYMKkBh3FuKTXtUX+LupMkwcETNCA40D6QNiA3tfdunXAkdOEX+1Ba68tjiqLbVOnKp60oNAam6J +fcyUvTYLAnDHOw8Jjx7Js71YTKWzxX1IV76iyayuWTCwDSIgKJxmqLI5zmp6sg5ZNdV7bkPGQWYh +0EzR/s8+A1THEt6hIrx6IbByRawKHKjfpEfExVREpUEdzKX3dJe5UaQ6UdT0p18VGCfPF2X8S4QD +QgaamI24hi1TtTxZyuVZ6AzK6gBnIbE66DmhImlzxAYouUq0XQ+oUhG039P+rAZgG7u1erYFyy6W +Tt85ddkmHak3PWVaWuePAC9F4Mh6dgdjB/A8tCqbscUxWLmumxp8jsa5A5RuY7xbwtHGtT+Phz69 +nGo0WC60DPt9u0AljxWG8kylh9hsRKw1jbiwx24cDsUKSRwYFPdIq2347NoWkSEAKnG++brnGes7 +sYH1QPVqVdDsOZZXUlN2WYO1soCA9JBoScjNQdvs/n3fKXaxYefOH9BDfD+Z5Db78Dv+WuWUd4Bj +YwPDx1bNiI03BoO7yRi9CzJBBLlQdj5tTbKIOFQqikHjruN6Bovlw5GnXZxjtMXbZ01O2NnhdawL +ASOFw8BIxpOSuutUYWfmBjW0U1S+gczhqy0Wzuhmd7Ur5RYW/01Tz3dKcpYVl/Isrs2jBSyZJ4H7 +LIq+4VYUL2NZaCMgQiY1LXSjFH09wWexvovGvvawX2q+d8/73vv+98APvvCHT/ziG//4yE++8pfP +/OY7//nQj770p0/96lv/+tjPvva3z/3ue//74A+/+MdP/vKb//zoT7/6e3Lf/3KryTDKUPvdBQIB +/q+JwOuPwYEhbFzcYDjDuPN/lARL/FdLRlcZwdUNnTRbGAZt+fcCHCYzGqd0NJZtrsYJFjFGJ2ZQ +m1A2kcZiD+gXLKNsMMZsTQdiFvg/IJUID7RjldFjhAVkGaM/6lASRfYu8KcuS6aDO4hkOfh7p7Jl +bBRlVxYSWSZlfVKDXfZltRJmADFmulJmb3BmBJhbb9YZp1RLV9hmwtUWdBZhnYeFCaZ7Rxdv/5Q8 +gKaCvNBrQ0hCZxhjLhgHXEV1PiQIjhBEkDZT6VFSmkFWhbBppMZBljZqVtZpIUGIqCNqevMYlhdf +qEYKslZ10zZibbgQDkN1IndyTkcLxiFTulZI/muYRsrjbKA4bNYwNR1nPsn2K6J4PKdYbKXYbSM3 +bSQVeWdybWwIa9Rmi0b3FwUEKAcUU+MGTr4AivP2hGSgbqDIbjDobssIb1IlbzSEbslob894gGUY +jYkxeyf3GABnhAK3jeTDYxE0J5uRcEtjdYUnaoMXHStGGxlnNxs4cYgARRt3Y8UobB5XVhhXjyTR +e0jnbfoURkGzDh+wcquACmqFUDD3iiw0LZFmczhmWTknkZ9FdK5IDH0GdArWGaB4kUXHewEpbSZH +kLX2AVA3dVPHamgjNQ8XZG0Ddl2XLF9HOmF3RPmTKGV3IGdXdWl3k2zXiPBVd3nXV3PHOkRpgk5A +lYlgg2F8Fw3WlnZW9HiCB2Q0Y3ic8k2Kl5V4JQhUiXgWFgqUh1e9h3mcpy2epxdm+XnjQ1EiMHoQ +pVtogiWuV3urBxGod4Xnw41huJfjKHvtg3t8GYKEWZiGeZiImZiKuZiM2ZiO+ZiQGZmSOZmUWZmW +eZmYmZmauZmc2ZlCEQEAOw== + +--6a82fb459dcaacd40ab3404529e808dc-- + +--652b8c4dcb00cdcdda1e16af36781caf +Content-Type: text/plain; name="attachment.txt" +Content-Transfer-Encoding: base64 +Content-Disposition: attachment; filename="attachment.txt" + +VGhpcyBpcyBqdXN0IGEgcGxhaW4gdGV4dCBhdHRhY2htZW50IGZpbGUgbmFtZWQgYXR0YWNobWVu +dC50eHQgLg== + +--652b8c4dcb00cdcdda1e16af36781caf-- + diff --git a/src/test/resources/textfile.txt b/client/src/test/resources/textfile.txt similarity index 100% rename from src/test/resources/textfile.txt rename to client/src/test/resources/textfile.txt diff --git a/src/test/resources/textfile2.txt b/client/src/test/resources/textfile2.txt similarity index 100% rename from src/test/resources/textfile2.txt rename to client/src/test/resources/textfile2.txt diff --git a/mvnw b/mvnw new file mode 100755 index 0000000000..5643201c7d --- /dev/null +++ b/mvnw @@ -0,0 +1,316 @@ +#!/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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + export JAVA_HOME="`/usr/libexec/java_home`" + else + export JAVA_HOME="/Library/Java/Home" + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="`\\unset -f command; \\command -v java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=`cd "$wdir/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ -n "$MVNW_REPOURL" ]; then + jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + else + jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl -o "$wrapperJarPath" "$jarUrl" -f + else + curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f + fi + + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +fi +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000000..23b7079a3d --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,188 @@ +@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 Maven Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml index e1287dfb2c..e55fe8a26b 100644 --- a/pom.xml +++ b/pom.xml @@ -1,625 +1,459 @@ - - - org.sonatype.oss - oss-parent - 5 - + + 4.0.0 - com.ning - async-http-client - Asynchronous Http Client - 1.8.0-SNAPSHOT - jar + + org.asynchttpclient + async-http-client-project + 3.0.2 + pom + + AHC/Project - Async Http Client library purpose is to allow Java applications to easily execute HTTP requests and - asynchronously process the HTTP responses. + The Async Http Client (AHC) library's purpose is to allow Java + applications to easily execute HTTP requests and + asynchronously process the response. - http://github.com/sonatype/async-http-client + + https://github.com/AsyncHttpClient/async-http-client + + + + The Apache Software License, Version 2.0 + https://www.apache.org/licenses/LICENSE-2.0.txt + + + + + 11 + 11 + 11 + UTF-8 + + 4.1.119.Final + 0.0.26.Final + 1.18.0 + 2.0.16 + 1.5.7-2 + 2.0.1 + 1.5.18 + 26.0.2 + + + + + hyperxpro + Aayush Atharva + aayush@shieldblaze.com + + + - scm:git:git@github.com:sonatype/async-http-client.git - https://github.com/sonatype/async-http-client - scm:git:git@github.com:sonatype/async-http-client.git + scm:git:git@github.com:AsyncHttpClient/async-http-client.git + scm:git:git@github.com:AsyncHttpClient/async-http-client.git + https://github.com/AsyncHttpClient/async-http-client/tree/master + HEAD + + + + sonatype-nexus-staging + https://oss.sonatype.org/content/repositories/snapshots + + + sonatype-nexus-staging + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + - jira - https://issues.sonatype.org/browse/AHC + github + https://github.com/AsyncHttpClient/async-http-client/issues + asynchttpclient - http://groups.google.com/group/asynchttpclient/topics - http://groups.google.com/group/asynchttpclient/subscribe - http://groups.google.com/group/asynchttpclient/subscribe + https://groups.google.com/group/asynchttpclient/topics + https://groups.google.com/group/asynchttpclient/subscribe + https://groups.google.com/group/asynchttpclient/subscribe asynchttpclient@googlegroups.com - - 2.0.9 - - - - brianm - Brian McCallister - brianm@skife.org - - - jfarcand - Jeanfrancois Arcand - jfarcand@apache.org - - - thomd - Thomas Dudziak - tomdz@apache.org - - - neotyk - Hubert Iwaniuk - - - - - Simone Tripodi - simonetripodi@apache.org - - - - - Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0.html - repo - - + + client + + + + + + org.junit + junit-bom + 5.11.4 + pom + import + + + io.github.nettyplus + netty-leak-detector-junit-extension + 0.2.0 + + + + io.netty - netty - 3.3.1.Final - - - javax.servlet - servlet-api - - - commons-logging - commons-logging - - - org.slf4j - slf4j-api - - - log4j - log4j - - + netty-buffer + ${netty.version} - org.slf4j - slf4j-api - 1.6.2 + io.netty + netty-codec-http + ${netty.version} - - ch.qos.logback - logback-classic - 0.9.26 - test + io.netty + netty-codec + ${netty.version} + - log4j - log4j - 1.2.13 - test + io.netty + netty-codec-socks + ${netty.version} + - org.testng - testng - 5.8 - test - jdk15 + io.netty + netty-handler-proxy + ${netty.version} + - org.eclipse.jetty - jetty-server - 8.1.1.v20120215 - test + io.netty + netty-common + ${netty.version} + - org.eclipse.jetty - jetty-servlet - 8.1.1.v20120215 - test + io.netty + netty-transport + ${netty.version} + - org.eclipse.jetty - jetty-websocket - 8.1.1.v20120215 - test + io.netty + netty-handler + ${netty.version} + - org.eclipse.jetty - jetty-servlets - 8.1.1.v20120215 - test + io.netty + netty-resolver-dns + ${netty.version} + - org.eclipse.jetty - jetty-security - 8.1.1.v20120215 - test + io.netty + netty-transport-native-epoll + linux-x86_64 + ${netty.version} + true + - org.apache.tomcat - coyote - 6.0.29 - test + io.netty + netty-transport-native-epoll + linux-aarch_64 + ${netty.version} + true + - org.apache.tomcat - catalina - 6.0.29 - test - - - servlet-api - org.apache.tomcat - - + io.netty + netty-transport-native-kqueue + osx-x86_64 + ${netty.version} + true + + + + io.netty + netty-transport-native-kqueue + osx-aarch_64 + ${netty.version} + true - commons-io - commons-io - 2.0.1 - test + io.netty.incubator + netty-incubator-transport-native-io_uring + ${netty.iouring} + linux-x86_64 + true + + + + io.netty.incubator + netty-incubator-transport-native-io_uring + ${netty.iouring} + linux-aarch_64 + true + - commons-fileupload - commons-fileupload - 1.2.2 - test + com.github.luben + zstd-jni + ${zstd-jni.version} + true - - commons-httpclient - commons-httpclient - 3.1 + com.aayushatharva.brotli4j + brotli4j + ${brotli4j.version} + true + + + com.aayushatharva.brotli4j + native-linux-x86_64 + ${brotli4j.version} + true + + + com.aayushatharva.brotli4j + native-linux-aarch64 + ${brotli4j.version} + true + + + com.aayushatharva.brotli4j + native-linux-riscv64 + ${brotli4j.version} true - commons-lang - commons-lang - 2.4 + com.aayushatharva.brotli4j + native-osx-x86_64 + ${brotli4j.version} true - commons-logging - commons-logging - 1.1.1 + com.aayushatharva.brotli4j + native-osx-aarch64 + ${brotli4j.version} true + + com.aayushatharva.brotli4j + native-windows-x86_64 + ${brotli4j.version} + true + + + + org.slf4j + slf4j-api + ${slf4j.version} + + + + com.sun.activation + jakarta.activation + ${activation.version} + + + org.jetbrains + annotations + ${jetbrains-annotations.version} + + - - - - org.apache.maven.wagon - wagon-ssh-external - 1.0-beta-6 - - - org.apache.maven.scm - maven-scm-provider-gitexe - 1.6 - - - org.apache.maven.scm - maven-scm-manager-plexus - 1.6 - - - org.kathrynhuxtable.maven.wagon - wagon-gitsite - 0.3.1 - - - install org.apache.maven.plugins maven-compiler-plugin - 2.3.2 + 3.14.0 - ${source.property} - ${target.property} - 1024m - - ${compiler.exclude} - - - ${test.compiler.exclude} - + 11 + 11 + UTF-8 + + -XDcompilePolicy=simple + -Xplugin:ErrorProne + -Xep:JavaTimeDefaultTimeZone:ERROR + -Xep:JavaUtilDate:ERROR + -Xep:DateChecker:ERROR + -Xep:DateFormatConstant:ERROR + -Xep:EmptyBlockTag:ERROR + -Xep:VariableNameSameAsType:ERROR + -Xep:DoubleCheckedLocking:ERROR + -Xep:DefaultCharset:ERROR + -Xep:NullablePrimitive:ERROR + -Xep:NullOptional:ERROR + -XepExcludedPaths:.*/src/test/java/.* + -XepOpt:NullAway:AnnotatedPackages=org.asynchttpclient + -XepOpt:NullAway:UnannotatedSubPackages=org.asynchttpclient.netty,org.asynchttpclient.request + -XepOpt:NullAway:AcknowledgeRestrictiveAnnotations=true + -Xep:NullAway:ERROR + + + + + com.google.errorprone + error_prone_core + 2.31.0 + + + com.uber.nullaway + nullaway + 0.12.6 + + + + org.apache.maven.plugins maven-surefire-plugin - ${surefire.version} + 3.5.2 - ${surefire.redirectTestOutputToFile} + + @{argLine} --add-exports java.base/jdk.internal.misc=ALL-UNNAMED + + - org.codehaus.mojo - animal-sniffer-maven-plugin - 1.6 - - - org.codehaus.mojo.signature - java15 - 1.0 - - - - - check-java-1.5-compat - process-classes - - check - - - - - - org.apache.felix - maven-bundle-plugin - 2.3.4 - true - - META-INF - - $(replace;$(project.version);-SNAPSHOT;.$(tstamp;yyyyMMdd-HHmm)) - - Sonatype - - org.jboss.netty.*;resolution:=optional, - org.apache.commons.httpclient;resolution:=optional, - org.apache.commons.httpclient.*;resolution:=optional, - * - - - com.ning.http.*;version="$(replace;$(project.version);-SNAPSHOT;"")" - - - - - - osgi-bundle - package - - bundle - - - - - - org.apache.maven.plugins - maven-enforcer-plugin - 1.0-beta-1 + org.jacoco + jacoco-maven-plugin + 0.8.12 - enforce-versions - enforce + prepare-agent - - - - 2.0.9 - - - 1.5 - - - - - - - org.apache.maven.plugins - maven-resources-plugin - 2.4.3 - - UTF-8 - - - - org.apache.maven.plugins - maven-release-plugin - 2.1 - - - org.apache.maven.plugins - maven-jar-plugin - 2.3.1 - + report + test - test-jar + report + org.apache.maven.plugins maven-source-plugin - 2.1.2 + 3.2.1 - attach-sources - verify jar-no-fork - - org.apache.maven.plugins - maven-site-plugin - 3.0 - + org.apache.maven.plugins maven-javadoc-plugin - 2.8.1 - - true - 1.6 - UTF-8 - 1g - - http://java.sun.com/javase/6/docs/api/ - - ${javadoc.package.exclude} - + 3.11.1 attach-javadocs - verify jar + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.7.0 + true + + ossrh + https://oss.sonatype.org/ + false + false + + + org.apache.maven.plugins - maven-shade-plugin - 1.2.1 + maven-gpg-plugin + 3.2.7 - package + sign-artifacts + verify - shade + sign - true - shaded - - - commons-codec:commons-codec - commons-lang:commons-lang - commons-logging:commons-logging - junit:junit - log4j:log4j - commons-httpclient:commons-httpclient - - - - - - - + + + --pinentry-mode + loopback + + false + - org.codehaus.mojo - clirr-maven-plugin - 2.3 + com.github.siom79.japicmp + japicmp-maven-plugin + 0.23.1 - - **/NettyAsyncHttpProvider$* - **/AsyncHandler$STATE - **/ProxyServer$Protocol - **/Realm$AuthScheme - **/SimpleAsyncHttpClient$ErrorDocumentBehaviour - **/SpnegoEngine - **/Request - **/Request$EntityWriter - **/RequestBuilderBase - **/Response - **/Response$ - **/FilterContext - **/NettyResponseFuture - **/**ResponseBodyPart - **/**WebSocket - + + RELEASE + ${project.version} + + + true + true + true + false + public + - check-api-compat - verify - check-no-fork + cmp + verify - - - - org.apache.maven.plugins - maven-javadoc-plugin - 2.8.1 - - true - 1.6 - UTF-8 - 1g - - http://java.sun.com/javase/6/docs/api/ - - ${javadoc.package.exclude} - ${sun.boot.class.path} - com.google.doclava.Doclava - false - -J-Xmx1024m - - com.google.doclava - doclava - 1.0.3 - - - -hdf project.name "${project.name} ${project.version}" - -d ${project.reporting.outputDirectory}/apidocs - - - - - default - - javadoc - - - - - - org.apache.maven.plugins - maven-surefire-report-plugin - ${surefire.version} - - - - - - grizzly - - [1.6,) - - - asdfasfd/** - asdfasdf/** - asdfasdf - 1.5 - - - - org.glassfish.grizzly - grizzly-websockets - 2.2.1 - true - - - - - release-sign-artifacts - - - performRelease - true - - - - - - org.apache.maven.plugins - maven-gpg-plugin - - - sign-artifacts - verify - - sign - - - - - - - - - offline-testing - - - - org.apache.maven.plugins - maven-surefire-plugin - - standalone - ${surefire.redirectTestOutputToFile} - - - - - - - online-testing - - - - org.apache.maven.plugins - maven-surefire-plugin - - standalone, online - ${surefire.redirectTestOutputToFile} - - - - - - - test-output - - false - - - - - - sonatype-nexus-staging - Sonatype Release - http://oss.sonatype.org/service/local/staging/deploy/maven2 - - - sonatype-nexus-snapshots - sonatype-nexus-snapshots - ${distMgmtSnapshotsUrl} - - - github - gitsite:git@github.com/sonatype/async-http-client.git - - - - http://oss.sonatype.org/content/repositories/snapshots - true - com/ning/http/client/providers/grizzly/*.java - com/ning/http/client/async/grizzly/*.java - com.ning.http.client.providers.grizzly - 1.5 - 1.5 - 2.12 - - diff --git a/src/main/java/com/ning/http/client/AsyncCompletionHandler.java b/src/main/java/com/ning/http/client/AsyncCompletionHandler.java deleted file mode 100644 index ebc171d07c..0000000000 --- a/src/main/java/com/ning/http/client/AsyncCompletionHandler.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * An {@link AsyncHandler} augmented with an {@link #onCompleted(Response)} convenience method which gets called - * when the {@link Response} processing is finished. This class also implement the {@link ProgressAsyncHandler} callback, - * all doing nothing except returning {@link com.ning.http.client.AsyncHandler.STATE#CONTINUE} - * - * @param Type of the value that will be returned by the associated {@link java.util.concurrent.Future} - */ -public abstract class AsyncCompletionHandler implements AsyncHandler, ProgressAsyncHandler { - - private final Logger log = LoggerFactory.getLogger(AsyncCompletionHandlerBase.class); - private final Response.ResponseBuilder builder = new Response.ResponseBuilder(); - - /** - * {@inheritDoc} - */ - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - builder.accumulate(content); - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - public STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - builder.reset(); - builder.accumulate(status); - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - public STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - builder.accumulate(headers); - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - public final T onCompleted() throws Exception { - return onCompleted(builder.build()); - } - - /** - * {@inheritDoc} - */ - public void onThrowable(Throwable t) { - log.debug(t.getMessage(), t); - } - - /** - * Invoked once the HTTP response processing is finished. - *

- *

- * Gets always invoked as last callback method. - * - * @param response The {@link Response} - * @return T Value that will be returned by the associated {@link java.util.concurrent.Future} - * @throws Exception if something wrong happens - */ - abstract public T onCompleted(Response response) throws Exception; - - /** - * Invoked when the content (a {@link java.io.File}, {@link String} or {@link java.io.FileInputStream} has been fully - * written on the I/O socket. - * - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. - */ - public STATE onHeaderWriteCompleted() { - return STATE.CONTINUE; - } - - /** - * Invoked when the content (a {@link java.io.File}, {@link String} or {@link java.io.FileInputStream} has been fully - * written on the I/O socket. - * - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. - */ - public STATE onContentWriteCompleted() { - return STATE.CONTINUE; - } - - /** - * Invoked when the I/O operation associated with the {@link Request} body as been progressed. - * - * @param amount The amount of bytes to transfer. - * @param current The amount of bytes transferred - * @param total The total number of bytes transferred - * @return a {@link com.ning.http.client.AsyncHandler.STATE} telling to CONTINUE or ABORT the current processing. - */ - public STATE onContentWriteProgress(long amount, long current, long total) { - return STATE.CONTINUE; - } -} diff --git a/src/main/java/com/ning/http/client/AsyncHandler.java b/src/main/java/com/ning/http/client/AsyncHandler.java deleted file mode 100644 index ec9bc77022..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHandler.java +++ /dev/null @@ -1,109 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -/** - * An asynchronous handler or callback which gets invoked as soon as some data is available when - * processing an asynchronous response.
- * Callback methods get invoked in the following order: - *

    - *
  1. {@link #onStatusReceived(HttpResponseStatus)},
  2. - *
  3. {@link #onHeadersReceived(HttpResponseHeaders)},
  4. - *
  5. {@link #onBodyPartReceived(HttpResponseBodyPart)}, which could be invoked multiple times,
  6. - *
  7. {@link #onCompleted()}, once the response has been fully read.
  8. - *
- *

- * Returning a {@link AsyncHandler.STATE#ABORT} from any of those callback methods will interrupt asynchronous response - * processing, after that only {@link #onCompleted()} is going to be called. - *

- *

- * AsyncHandler aren't thread safe, hence you should avoid re-using the same instance when doing concurrent requests. - * As an exmaple, the following may produce unexpected results: - *

- *   AsyncHandler ah = new AsyncHandler() {....};
- *   AsyncHttpClient client = new AsyncHttpClient();
- *   client.prepareGet("http://.../").execute(ah);
- *   client.prepareGet("http://.../").execute(ah);
- * 
- * It is recommended to create a new instance instead. - * - * @param Type of object returned by the {@link java.util.concurrent.Future#get} - */ -public interface AsyncHandler { - - public static enum STATE { - - /** - * Stop the processing. - */ - ABORT, - /** - * Continue the processing - */ - CONTINUE, - /** - * Upgrade the protocol. When specified, the AsyncHttpProvider will try to invoke the {@link UpgradeHandler#onReady} - */ - UPGRADE - } - - /** - * Invoked when an unexpected exception occurs during the processing of the response. The exception may have been - * produced by implementation of onXXXReceived method invocation. - * - * @param t a {@link Throwable} - */ - void onThrowable(Throwable t); - - /** - * Invoked as soon as some response body part are received. Could be invoked many times. - * - * @param bodyPart response's body part. - * @return a {@link STATE} telling to CONTINUE or ABORT the current processing. - * @throws Exception if something wrong happens - */ - STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception; - - /** - * Invoked as soon as the HTTP status line has been received - * - * @param responseStatus the status code and test of the response - * @return a {@link STATE} telling to CONTINUE or ABORT the current processing. - * @throws Exception if something wrong happens - */ - STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception; - - /** - * Invoked as soon as the HTTP headers has been received. Can potentially be invoked more than once if a broken server - * sent trailing headers. - * - * @param headers the HTTP headers. - * @return a {@link STATE} telling to CONTINUE or ABORT the current processing. - * @throws Exception if something wrong happens - */ - STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception; - - /** - * Invoked once the HTTP response processing is finished. - *

- *

- * Gets always invoked as last callback method. - * - * @return T Value that will be returned by the associated {@link java.util.concurrent.Future} - * @throws Exception if something wrong happens - */ - T onCompleted() throws Exception; -} diff --git a/src/main/java/com/ning/http/client/AsyncHttpClient.java b/src/main/java/com/ning/http/client/AsyncHttpClient.java deleted file mode 100755 index 1433805bb3..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHttpClient.java +++ /dev/null @@ -1,582 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import com.ning.http.client.Request.EntityWriter; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.RequestFilter; -import com.ning.http.client.providers.jdk.JDKAsyncHttpProvider; -import com.ning.http.client.resumable.ResumableAsyncHandler; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Collection; -import java.util.Map; -import java.util.concurrent.Future; -import java.util.concurrent.atomic.AtomicBoolean; - -/** - * This class support asynchronous and synchronous HTTP request. - *

- * To execute synchronous HTTP request, you just need to do - *

- *    AsyncHttpClient c = new AsyncHttpClient();
- *    Future f = c.prepareGet("http://www.ning.com/").execute();
- * 
- * The code above will block until the response is fully received. To execute asynchronous HTTP request, you - * create an {@link AsyncHandler} or its abstract implementation, {@link com.ning.http.client.AsyncCompletionHandler} - *

- *

- *       AsyncHttpClient c = new AsyncHttpClient();
- *       Future f = c.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler() {
- * 

- * @Override - * public Response onCompleted(Response response) throws IOException { - * // Do something - * return response; - * } - *

- * @Override - * public void onThrowable(Throwable t) { - * } - * }); - * Response response = f.get(); - *

- * // We are just interested to retrieve the status code. - * Future f = c.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler() { - *

- * @Override - * public Integer onCompleted(Response response) throws IOException { - * // Do something - * return response.getStatusCode(); - * } - *

- * @Override - * public void onThrowable(Throwable t) { - * } - * }); - * Integer statusCode = f.get(); - *

- * You can also have more control about the how the response is asynchronously processed by using a {@link AsyncHandler} - *
- *      AsyncHttpClient c = new AsyncHttpClient();
- *      Future f = c.prepareGet("http://www.ning.com/").execute(new AsyncHandler() {
- *          private StringBuilder builder = new StringBuilder();
- * 

- * @Override - * public STATE onStatusReceived(HttpResponseStatus s) throws Exception { - * // return STATE.CONTINUE or STATE.ABORT - * return STATE.CONTINUE - * } - *

- * @Override - * public STATE onHeadersReceived(HttpResponseHeaders bodyPart) throws Exception { - * // return STATE.CONTINUE or STATE.ABORT - * return STATE.CONTINUE - *

- * } - * @Override - *

- * public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - * builder.append(new String(bodyPart)); - * // return STATE.CONTINUE or STATE.ABORT - * return STATE.CONTINUE - * } - *

- * @Override - * public String onCompleted() throws Exception { - * // Will be invoked once the response has been fully read or a ResponseComplete exception - * // has been thrown. - * return builder.toString(); - * } - *

- * @Override - * public void onThrowable(Throwable t) { - * } - * }); - *

- * String bodyResponse = f.get(); - *

- * This class can also be used without the need of {@link AsyncHandler}

- *
- *      AsyncHttpClient c = new AsyncHttpClient();
- *      Future f = c.prepareGet(TARGET_URL).execute();
- *      Response r = f.get();
- * 
- *

- * Finally, you can configure the AsyncHttpClient using an {@link AsyncHttpClientConfig} instance

- *
- *      AsyncHttpClient c = new AsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(...).build());
- *      Future f = c.prepareGet(TARGET_URL).execute();
- *      Response r = f.get();
- * 
- *

- * An instance of this class will cache every HTTP 1.1 connections and close them when the {@link AsyncHttpClientConfig#getIdleConnectionTimeoutInMs()} - * expires. This object can hold many persistent connections to different host. - */ -public class AsyncHttpClient { - - private final static String DEFAULT_PROVIDER = "com.ning.http.client.providers.netty.NettyAsyncHttpProvider"; - private final AsyncHttpProvider httpProvider; - private final AsyncHttpClientConfig config; - private final static Logger logger = LoggerFactory.getLogger(AsyncHttpClient.class); - private final AtomicBoolean isClosed = new AtomicBoolean(false); - - /** - * Default signature calculator to use for all requests constructed by this client instance. - * - * @since 1.1 - */ - protected SignatureCalculator signatureCalculator; - - /** - * Create a new HTTP Asynchronous Client using the default {@link AsyncHttpClientConfig} configuration. The - * default {@link AsyncHttpProvider} will be used ({@link com.ning.http.client.providers.netty.NettyAsyncHttpProvider} - */ - public AsyncHttpClient() { - this(new AsyncHttpClientConfig.Builder().build()); - } - - /** - * Create a new HTTP Asynchronous Client using an implementation of {@link AsyncHttpProvider} and - * the default {@link AsyncHttpClientConfig} configuration. - * - * @param provider a {@link AsyncHttpProvider} - */ - public AsyncHttpClient(AsyncHttpProvider provider) { - this(provider, new AsyncHttpClientConfig.Builder().build()); - } - - /** - * Create a new HTTP Asynchronous Client using a {@link AsyncHttpClientConfig} configuration and the - * {@link #DEFAULT_PROVIDER} - * - * @param config a {@link AsyncHttpClientConfig} - */ - public AsyncHttpClient(AsyncHttpClientConfig config) { - this(loadDefaultProvider(DEFAULT_PROVIDER, config), config); - } - - /** - * Create a new HTTP Asynchronous Client using a {@link AsyncHttpClientConfig} configuration and - * and a {@link AsyncHttpProvider}. - * - * @param config a {@link AsyncHttpClientConfig} - * @param httpProvider a {@link AsyncHttpProvider} - */ - public AsyncHttpClient(AsyncHttpProvider httpProvider, AsyncHttpClientConfig config) { - this.config = config; - this.httpProvider = httpProvider; - } - - /** - * Create a new HTTP Asynchronous Client using a {@link AsyncHttpClientConfig} configuration and - * and a AsyncHttpProvider class' name. - * - * @param config a {@link AsyncHttpClientConfig} - * @param providerClass a {@link AsyncHttpProvider} - */ - public AsyncHttpClient(String providerClass, AsyncHttpClientConfig config) { - this.config = new AsyncHttpClientConfig.Builder().build(); - this.httpProvider = loadDefaultProvider(providerClass, config); - } - - public class BoundRequestBuilder extends RequestBuilderBase { - /** - * Calculator used for calculating request signature for the request being - * built, if any. - */ - protected SignatureCalculator signatureCalculator; - - /** - * URL used as the base, not including possibly query parameters. Needed for - * signature calculation - */ - protected String baseURL; - - private BoundRequestBuilder(String reqType, boolean useRawUrl) { - super(BoundRequestBuilder.class, reqType, useRawUrl); - } - - private BoundRequestBuilder(Request prototype) { - super(BoundRequestBuilder.class, prototype); - } - - public ListenableFuture execute(AsyncHandler handler) throws IOException { - return AsyncHttpClient.this.executeRequest(build(), handler); - } - - public ListenableFuture execute() throws IOException { - return AsyncHttpClient.this.executeRequest(build(), new AsyncCompletionHandlerBase()); - } - - // Note: For now we keep the delegates in place even though they are not needed - // since otherwise Clojure (and maybe other languages) won't be able to - // access these methods - see Clojure tickets 126 and 259 - - @Override - public BoundRequestBuilder addBodyPart(Part part) throws IllegalArgumentException { - return super.addBodyPart(part); - } - - @Override - public BoundRequestBuilder addCookie(Cookie cookie) { - return super.addCookie(cookie); - } - - @Override - public BoundRequestBuilder addHeader(String name, String value) { - return super.addHeader(name, value); - } - - @Override - public BoundRequestBuilder addParameter(String key, String value) throws IllegalArgumentException { - return super.addParameter(key, value); - } - - @Override - public BoundRequestBuilder addQueryParameter(String name, String value) { - return super.addQueryParameter(name, value); - } - - @Override - public Request build() { - /* Let's first calculate and inject signature, before finalizing actual build - * (order does not matter with current implementation but may in future) - */ - if (signatureCalculator != null) { - String url = baseURL; - // Should not include query parameters, ensure: - int i = url.indexOf('?'); - if (i >= 0) { - url = url.substring(0, i); - } - signatureCalculator.calculateAndAddSignature(url, request, this); - } - return super.build(); - } - - @Override - public BoundRequestBuilder setBody(byte[] data) throws IllegalArgumentException { - return super.setBody(data); - } - - @Override - public BoundRequestBuilder setBody(EntityWriter dataWriter, long length) throws IllegalArgumentException { - return super.setBody(dataWriter, length); - } - - @Override - public BoundRequestBuilder setBody(EntityWriter dataWriter) { - return super.setBody(dataWriter); - } - - @Override - public BoundRequestBuilder setBody(InputStream stream) throws IllegalArgumentException { - return super.setBody(stream); - } - - @Override - public BoundRequestBuilder setBody(String data) throws IllegalArgumentException { - return super.setBody(data); - } - - @Override - public BoundRequestBuilder setHeader(String name, String value) { - return super.setHeader(name, value); - } - - @Override - public BoundRequestBuilder setHeaders(FluentCaseInsensitiveStringsMap headers) { - return super.setHeaders(headers); - } - - @Override - public BoundRequestBuilder setHeaders(Map> headers) { - return super.setHeaders(headers); - } - - @Override - public BoundRequestBuilder setParameters(Map> parameters) throws IllegalArgumentException { - return super.setParameters(parameters); - } - - @Override - public BoundRequestBuilder setParameters(FluentStringsMap parameters) throws IllegalArgumentException { - return super.setParameters(parameters); - } - - @Override - public BoundRequestBuilder setUrl(String url) { - baseURL = url; - return super.setUrl(url); - } - - @Override - public BoundRequestBuilder setVirtualHost(String virtualHost) { - return super.setVirtualHost(virtualHost); - } - - public BoundRequestBuilder setSignatureCalculator(SignatureCalculator signatureCalculator) { - this.signatureCalculator = signatureCalculator; - return this; - } - } - - - /** - * Return the asynchronous {@link com.ning.http.client.AsyncHttpProvider} - * - * @return an {@link com.ning.http.client.AsyncHttpProvider} - */ - public AsyncHttpProvider getProvider() { - return httpProvider; - } - - /** - * Close the underlying connections. - */ - public void close() { - httpProvider.close(); - isClosed.set(true); - } - - @Override - protected void finalize() throws Throwable { - try { - if (!isClosed.get()) { - logger.warn("AsyncHttpClient.close() hasn't been invoked, which may produce file descriptor leaks"); - } - } finally { - super.finalize(); - } - } - - /** - * Return true if closed - * - * @return true if closed - */ - public boolean isClosed() { - return isClosed.get(); - } - - /** - * Return the {@link com.ning.http.client.AsyncHttpClientConfig} - * - * @return {@link com.ning.http.client.AsyncHttpClientConfig} - */ - public AsyncHttpClientConfig getConfig() { - return config; - } - - /** - * Set default signature calculator to use for requests build by this client instance - */ - public AsyncHttpClient setSignatureCalculator(SignatureCalculator signatureCalculator) { - this.signatureCalculator = signatureCalculator; - return this; - } - - /** - * Prepare an HTTP client GET request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareGet(String url) { - return requestBuilder("GET", url); - } - - /** - * Prepare an HTTP client CONNECT request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareConnect(String url) { - return requestBuilder("CONNECT", url); - } - - /** - * Prepare an HTTP client OPTIONS request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareOptions(String url) { - return requestBuilder("OPTIONS", url); - } - - /** - * Prepare an HTTP client HEAD request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareHead(String url) { - return requestBuilder("HEAD", url); - } - - /** - * Prepare an HTTP client POST request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder preparePost(String url) { - return requestBuilder("POST", url); - } - - /** - * Prepare an HTTP client PUT request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder preparePut(String url) { - return requestBuilder("PUT", url); - } - - /** - * Prepare an HTTP client DELETE request. - * - * @param url A well formed URL. - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareDelete(String url) { - return requestBuilder("DELETE", url); - } - - /** - * Construct a {@link RequestBuilder} using a {@link Request} - * - * @param request a {@link Request} - * @return {@link RequestBuilder} - */ - public BoundRequestBuilder prepareRequest(Request request) { - return requestBuilder(request); - } - - /** - * Execute an HTTP request. - * - * @param request {@link Request} - * @param handler an instance of {@link AsyncHandler} - * @param Type of the value that will be returned by the associated {@link java.util.concurrent.Future} - * @return a {@link Future} of type T - * @throws IOException - */ - public ListenableFuture executeRequest(Request request, AsyncHandler handler) throws IOException { - - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(handler).request(request).build(); - fc = preProcessRequest(fc); - - return httpProvider.execute(fc.getRequest(), fc.getAsyncHandler()); - } - - /** - * Execute an HTTP request. - * - * @param request {@link Request} - * @return a {@link Future} of type Response - * @throws IOException - */ - public ListenableFuture executeRequest(Request request) throws IOException { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(new AsyncCompletionHandlerBase()).request(request).build(); - fc = preProcessRequest(fc); - return httpProvider.execute(fc.getRequest(), fc.getAsyncHandler()); - } - - /** - * Configure and execute the associated {@link RequestFilter}. This class may decorate the {@link Request} and {@link AsyncHandler} - * - * @param fc {@link FilterContext} - * @return {@link FilterContext} - */ - private FilterContext preProcessRequest(FilterContext fc) throws IOException { - for (RequestFilter asyncFilter : config.getRequestFilters()) { - try { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } catch (FilterException e) { - IOException ex = new IOException(); - ex.initCause(e); - throw ex; - } - } - - Request request = fc.getRequest(); - if (ResumableAsyncHandler.class.isAssignableFrom(fc.getAsyncHandler().getClass())) { - request = ResumableAsyncHandler.class.cast(fc.getAsyncHandler()).adjustRequestRange(request); - } - - if (request.getRangeOffset() != 0) { - RequestBuilder builder = new RequestBuilder(request); - builder.setHeader("Range", "bytes=" + request.getRangeOffset() + "-"); - request = builder.build(); - } - fc = new FilterContext.FilterContextBuilder(fc).request(request).build(); - return fc; - } - - @SuppressWarnings("unchecked") - private final static AsyncHttpProvider loadDefaultProvider(String className, AsyncHttpClientConfig config) { - try { - Class providerClass = (Class) Thread.currentThread() - .getContextClassLoader().loadClass(className); - return providerClass.getDeclaredConstructor( - new Class[]{AsyncHttpClientConfig.class}).newInstance(new Object[]{config}); - } catch (Throwable t) { - - // Let's try with another classloader - try { - Class providerClass = (Class) - AsyncHttpClient.class.getClassLoader().loadClass(className); - return providerClass.getDeclaredConstructor( - new Class[]{AsyncHttpClientConfig.class}).newInstance(new Object[]{config}); - } catch (Throwable t2) { - } - - if (logger.isDebugEnabled()) { - logger.debug("Default provider not found {}. Using the {}", DEFAULT_PROVIDER, - JDKAsyncHttpProvider.class.getName()); - } - return new JDKAsyncHttpProvider(config); - } - } - - protected BoundRequestBuilder requestBuilder(String reqType, String url) { - return new BoundRequestBuilder(reqType, config.isUseRawUrl()).setUrl(url).setSignatureCalculator(signatureCalculator); - } - - protected BoundRequestBuilder requestBuilder(Request prototype) { - return new BoundRequestBuilder(prototype).setSignatureCalculator(signatureCalculator); - } -} diff --git a/src/main/java/com/ning/http/client/AsyncHttpClientConfig.java b/src/main/java/com/ning/http/client/AsyncHttpClientConfig.java deleted file mode 100644 index b3fb5bac1c..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHttpClientConfig.java +++ /dev/null @@ -1,1052 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import com.ning.http.client.filter.IOExceptionFilter; -import com.ning.http.client.filter.RequestFilter; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.util.AllowAllHostnameVerifier; -import com.ning.http.util.ProxyUtils; - -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLEngine; -import java.security.GeneralSecurityException; -import java.util.Collections; -import java.util.LinkedList; -import java.util.List; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.ThreadFactory; - -/** - * Configuration class to use with a {@link AsyncHttpClient}. System property can be also used to configure this - * object default behavior by doing: - *

- * -Dcom.ning.http.client.AsyncHttpClientConfig.nameOfTheProperty - * ex: - *

- * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultMaxTotalConnections - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultMaxTotalConnections - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultMaxConnectionsPerHost - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultConnectionTimeoutInMS - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultIdleConnectionInPoolTimeoutInMS - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultRequestTimeoutInMS - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultRedirectsEnabled - * -Dcom.ning.http.client.AsyncHttpClientConfig.defaultMaxRedirects - */ -public class AsyncHttpClientConfig { - - protected final static String ASYNC_CLIENT = AsyncHttpClientConfig.class.getName() + "."; - - protected int maxTotalConnections; - protected int maxConnectionPerHost; - protected int connectionTimeOutInMs; - protected int webSocketIdleTimeoutInMs; - protected int idleConnectionInPoolTimeoutInMs; - protected int idleConnectionTimeoutInMs; - protected int requestTimeoutInMs; - protected boolean redirectEnabled; - protected int maxDefaultRedirects; - protected boolean compressionEnabled; - protected String userAgent; - protected boolean allowPoolingConnection; - protected ScheduledExecutorService reaper; - protected ExecutorService applicationThreadPool; - protected ProxyServer proxyServer; - protected SSLContext sslContext; - protected SSLEngineFactory sslEngineFactory; - protected AsyncHttpProviderConfig providerConfig; - protected ConnectionsPool connectionsPool; - protected Realm realm; - protected List requestFilters; - protected List responseFilters; - protected List ioExceptionFilters; - protected int requestCompressionLevel; - protected int maxRequestRetry; - protected boolean allowSslConnectionPool; - protected boolean useRawUrl; - protected boolean removeQueryParamOnRedirect; - protected HostnameVerifier hostnameVerifier; - protected int ioThreadMultiplier; - protected boolean strict302Handling; - - protected AsyncHttpClientConfig() { - } - - private AsyncHttpClientConfig(int maxTotalConnections, - int maxConnectionPerHost, - int connectionTimeOutInMs, - int webSocketTimeoutInMs, - int idleConnectionInPoolTimeoutInMs, - int idleConnectionTimeoutInMs, - int requestTimeoutInMs, - boolean redirectEnabled, - int maxDefaultRedirects, - boolean compressionEnabled, - String userAgent, - boolean keepAlive, - ScheduledExecutorService reaper, - ExecutorService applicationThreadPool, - ProxyServer proxyServer, - SSLContext sslContext, - SSLEngineFactory sslEngineFactory, - AsyncHttpProviderConfig providerConfig, - ConnectionsPool connectionsPool, Realm realm, - List requestFilters, - List responseFilters, - List ioExceptionFilters, - int requestCompressionLevel, - int maxRequestRetry, - boolean allowSslConnectionCaching, - boolean useRawUrl, - boolean removeQueryParamOnRedirect, - HostnameVerifier hostnameVerifier, - int ioThreadMultiplier, - boolean strict302Handling) { - - this.maxTotalConnections = maxTotalConnections; - this.maxConnectionPerHost = maxConnectionPerHost; - this.connectionTimeOutInMs = connectionTimeOutInMs; - this.webSocketIdleTimeoutInMs = webSocketTimeoutInMs; - this.idleConnectionInPoolTimeoutInMs = idleConnectionInPoolTimeoutInMs; - this.idleConnectionTimeoutInMs = idleConnectionTimeoutInMs; - this.requestTimeoutInMs = requestTimeoutInMs; - this.redirectEnabled = redirectEnabled; - this.maxDefaultRedirects = maxDefaultRedirects; - this.compressionEnabled = compressionEnabled; - this.userAgent = userAgent; - this.allowPoolingConnection = keepAlive; - this.sslContext = sslContext; - this.sslEngineFactory = sslEngineFactory; - this.providerConfig = providerConfig; - this.connectionsPool = connectionsPool; - this.realm = realm; - this.requestFilters = requestFilters; - this.responseFilters = responseFilters; - this.ioExceptionFilters = ioExceptionFilters; - this.requestCompressionLevel = requestCompressionLevel; - this.maxRequestRetry = maxRequestRetry; - this.reaper = reaper; - this.allowSslConnectionPool = allowSslConnectionCaching; - this.removeQueryParamOnRedirect = removeQueryParamOnRedirect; - this.hostnameVerifier = hostnameVerifier; - this.ioThreadMultiplier = ioThreadMultiplier; - this.strict302Handling = strict302Handling; - - if (applicationThreadPool == null) { - this.applicationThreadPool = Executors.newCachedThreadPool(); - } else { - this.applicationThreadPool = applicationThreadPool; - } - this.proxyServer = proxyServer; - this.useRawUrl = useRawUrl; - } - - /** - * A {@link ScheduledExecutorService} used to expire idle connections. - * - * @return {@link ScheduledExecutorService} - */ - public ScheduledExecutorService reaper() { - return reaper; - } - - /** - * Return the maximum number of connections an {@link com.ning.http.client.AsyncHttpClient} can handle. - * - * @return the maximum number of connections an {@link com.ning.http.client.AsyncHttpClient} can handle. - */ - public int getMaxTotalConnections() { - return maxTotalConnections; - } - - /** - * Return the maximum number of connections per hosts an {@link com.ning.http.client.AsyncHttpClient} can handle. - * - * @return the maximum number of connections per host an {@link com.ning.http.client.AsyncHttpClient} can handle. - */ - public int getMaxConnectionPerHost() { - return maxConnectionPerHost; - } - - /** - * Return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can wait when connecting to a remote host - * - * @return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can wait when connecting to a remote host - */ - public int getConnectionTimeoutInMs() { - return connectionTimeOutInMs; - } - - /** - * Return the maximum time, in milliseconds, a {@link com.ning.http.client.websocket.WebSocket} may be idle before being timed out. - * @return the maximum time, in milliseconds, a {@link com.ning.http.client.websocket.WebSocket} may be idle before being timed out. - */ - public int getWebSocketIdleTimeoutInMs() { - return webSocketIdleTimeoutInMs; - } - - /** - * Return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can stay idle. - * - * @return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can stay idle. - */ - public int getIdleConnectionTimeoutInMs() { - return idleConnectionTimeoutInMs; - } - - /** - * Return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection - * in pool. - * - * @return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection - * in pool. - */ - public int getIdleConnectionInPoolTimeoutInMs() { - return idleConnectionInPoolTimeoutInMs; - } - - /** - * Return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} wait for a response - * - * @return the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} wait for a response - */ - public int getRequestTimeoutInMs() { - return requestTimeoutInMs; - } - - /** - * Is HTTP redirect enabled - * - * @return true if enabled. - */ - public boolean isRedirectEnabled() { - return redirectEnabled; - } - - /** - * Get the maximum number of HTTP redirect - * - * @return the maximum number of HTTP redirect - */ - public int getMaxRedirects() { - return maxDefaultRedirects; - } - - /** - * Is the {@link ConnectionsPool} support enabled. - * - * @return true if keep-alive is enabled - */ - public boolean getAllowPoolingConnection() { - return allowPoolingConnection; - } - - /** - * Is the {@link ConnectionsPool} support enabled. - * - * @return true if keep-alive is enabled - * @deprecated - Use {@link AsyncHttpClientConfig#getAllowPoolingConnection()} - */ - public boolean getKeepAlive() { - return allowPoolingConnection; - } - - /** - * Return the USER_AGENT header value - * - * @return the USER_AGENT header value - */ - public String getUserAgent() { - return userAgent; - } - - /** - * Is HTTP compression enabled. - * - * @return true if compression is enabled - */ - public boolean isCompressionEnabled() { - return compressionEnabled; - } - - /** - * Return the {@link java.util.concurrent.ExecutorService} an {@link AsyncHttpClient} use for handling - * asynchronous response. - * - * @return the {@link java.util.concurrent.ExecutorService} an {@link AsyncHttpClient} use for handling - * asynchronous response. - */ - public ExecutorService executorService() { - return applicationThreadPool; - } - - /** - * An instance of {@link com.ning.http.client.ProxyServer} used by an {@link AsyncHttpClient} - * - * @return instance of {@link com.ning.http.client.ProxyServer} - */ - public ProxyServer getProxyServer() { - return proxyServer; - } - - /** - * Return an instance of {@link SSLContext} used for SSL connection. - * - * @return an instance of {@link SSLContext} used for SSL connection. - */ - public SSLContext getSSLContext() { - return sslContext; - } - - /** - * Return an instance of {@link ConnectionsPool} - * - * @return an instance of {@link ConnectionsPool} - */ - public ConnectionsPool getConnectionsPool() { - return connectionsPool; - } - - /** - * Return an instance of {@link SSLEngineFactory} used for SSL connection. - * - * @return an instance of {@link SSLEngineFactory} used for SSL connection. - */ - public SSLEngineFactory getSSLEngineFactory() { - if (sslEngineFactory == null) { - return new SSLEngineFactory() { - public SSLEngine newSSLEngine() { - if (sslContext != null) { - SSLEngine sslEngine = sslContext.createSSLEngine(); - sslEngine.setUseClientMode(true); - return sslEngine; - } else { - return null; - } - } - }; - } - return sslEngineFactory; - } - - /** - * Return the {@link com.ning.http.client.AsyncHttpProviderConfig} - * - * @return the {@link com.ning.http.client.AsyncHttpProviderConfig} - */ - public AsyncHttpProviderConfig getAsyncHttpProviderConfig() { - return providerConfig; - } - - /** - * Return the current {@link Realm}} - * - * @return the current {@link Realm}} - */ - public Realm getRealm() { - return realm; - } - - /** - * Return the list of {@link RequestFilter} - * - * @return Unmodifiable list of {@link ResponseFilter} - */ - public List getRequestFilters() { - return Collections.unmodifiableList(requestFilters); - } - - /** - * Return the list of {@link ResponseFilter} - * - * @return Unmodifiable list of {@link ResponseFilter} - */ - public List getResponseFilters() { - return Collections.unmodifiableList(responseFilters); - } - - /** - * Return the list of {@link java.io.IOException} - * - * @return Unmodifiable list of {@link java.io.IOException} - */ - public List getIOExceptionFilters() { - return Collections.unmodifiableList(ioExceptionFilters); - } - - /** - * Return the compression level, or -1 if no compression is used. - * - * @return the compression level, or -1 if no compression is use - */ - public int getRequestCompressionLevel() { - return requestCompressionLevel; - } - - /** - * Return the number of time the library will retry when an {@link java.io.IOException} is throw by the remote server - * - * @return the number of time the library will retry when an {@link java.io.IOException} is throw by the remote server - */ - public int getMaxRequestRetry() { - return maxRequestRetry; - } - - /** - * Return true is SSL connection polling is enabled. Default is true. - * - * @return true is enabled. - */ - public boolean isSslConnectionPoolEnabled() { - return allowSslConnectionPool; - } - - - /** - * @return the useRawUrl - */ - public boolean isUseRawUrl() { - return useRawUrl; - } - - /** - * Return true if the query parameters will be stripped from the request when a redirect is requested. - * - * @return true if the query parameters will be stripped from the request when a redirect is requested. - */ - public boolean isRemoveQueryParamOnRedirect() { - return removeQueryParamOnRedirect; - } - - /** - * Return true if one of the {@link java.util.concurrent.ExecutorService} has been shutdown. - * - * @return true if one of the {@link java.util.concurrent.ExecutorService} has been shutdown. - */ - public boolean isClosed() { - return applicationThreadPool.isShutdown() || reaper.isShutdown(); - } - - /** - * Return the {@link HostnameVerifier} - * - * @return the {@link HostnameVerifier} - */ - public HostnameVerifier getHostnameVerifier() { - return hostnameVerifier; - } - - /** - * @return number to multiply by availableProcessors() that will determine # of NioWorkers to use - */ - public int getIoThreadMultiplier() { - return ioThreadMultiplier; - } - - /** - *

- * In the case of a POST/Redirect/Get scenario where the server uses a 302 - * for the redirect, should AHC respond to the redirect with a GET or - * whatever the original method was. Unless configured otherwise, - * for a 302, AHC, will use a GET for this case. - *

- * - * @return true if string 302 handling is to be used, - * otherwise false. - * - * @since 1.7.2 - */ - public boolean isStrict302Handling() { - return strict302Handling; - } - - /** - * Builder for an {@link AsyncHttpClient} - */ - public static class Builder { - private int defaultMaxTotalConnections = Integer.getInteger(ASYNC_CLIENT + "defaultMaxTotalConnections", -1); - private int defaultMaxConnectionPerHost = Integer.getInteger(ASYNC_CLIENT + "defaultMaxConnectionsPerHost", -1); - private int defaultConnectionTimeOutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultConnectionTimeoutInMS", 60 * 1000); - private int defaultWebsocketIdleTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultWebsocketTimoutInMS", 15 * 60 * 1000); - private int defaultIdleConnectionInPoolTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionInPoolTimeoutInMS", 60 * 1000); - private int defaultIdleConnectionTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionTimeoutInMS", 60 * 1000); - private int defaultRequestTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultRequestTimeoutInMS", 60 * 1000); - private boolean redirectEnabled = Boolean.getBoolean(ASYNC_CLIENT + "defaultRedirectsEnabled"); - private int maxDefaultRedirects = Integer.getInteger(ASYNC_CLIENT + "defaultMaxRedirects", 5); - private boolean compressionEnabled = Boolean.getBoolean(ASYNC_CLIENT + "compressionEnabled"); - private String userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "NING/1.0"); - private boolean useProxyProperties = Boolean.getBoolean(ASYNC_CLIENT + "useProxyProperties"); - private boolean allowPoolingConnection = true; - private ScheduledExecutorService reaper = Executors.newScheduledThreadPool(Runtime.getRuntime().availableProcessors(), new ThreadFactory() { - public Thread newThread(Runnable r) { - Thread t = new Thread(r, "AsyncHttpClient-Reaper"); - t.setDaemon(true); - return t; - } - }); - private ExecutorService applicationThreadPool = Executors.newCachedThreadPool(new ThreadFactory() { - public Thread newThread(Runnable r) { - Thread t = new Thread(r, "AsyncHttpClient-Callback"); - t.setDaemon(true); - return t; - } - }); - private ProxyServer proxyServer = null; - private SSLContext sslContext; - private SSLEngineFactory sslEngineFactory; - private AsyncHttpProviderConfig providerConfig; - private ConnectionsPool connectionsPool; - private Realm realm; - private int requestCompressionLevel = -1; - private int maxRequestRetry = 5; - private final List requestFilters = new LinkedList(); - private final List responseFilters = new LinkedList(); - private final List ioExceptionFilters = new LinkedList(); - private boolean allowSslConnectionPool = true; - private boolean useRawUrl = false; - private boolean removeQueryParamOnRedirect = true; - private HostnameVerifier hostnameVerifier = new AllowAllHostnameVerifier(); - private int ioThreadMultiplier = 2; - private boolean strict302Handling; - - public Builder() { - } - - /** - * Set the maximum number of connections an {@link com.ning.http.client.AsyncHttpClient} can handle. - * - * @param defaultMaxTotalConnections the maximum number of connections an {@link com.ning.http.client.AsyncHttpClient} can handle. - * @return a {@link Builder} - */ - public Builder setMaximumConnectionsTotal(int defaultMaxTotalConnections) { - this.defaultMaxTotalConnections = defaultMaxTotalConnections; - return this; - } - - /** - * Set the maximum number of connections per hosts an {@link com.ning.http.client.AsyncHttpClient} can handle. - * - * @param defaultMaxConnectionPerHost the maximum number of connections per host an {@link com.ning.http.client.AsyncHttpClient} can handle. - * @return a {@link Builder} - */ - public Builder setMaximumConnectionsPerHost(int defaultMaxConnectionPerHost) { - this.defaultMaxConnectionPerHost = defaultMaxConnectionPerHost; - return this; - } - - /** - * Set the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can wait when connecting to a remote host - * - * @param defaultConnectionTimeOutInMs the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can wait when connecting to a remote host - * @return a {@link Builder} - */ - public Builder setConnectionTimeoutInMs(int defaultConnectionTimeOutInMs) { - this.defaultConnectionTimeOutInMs = defaultConnectionTimeOutInMs; - return this; - } - - /** - * Set the maximum time in millisecond an {@link com.ning.http.client.websocket.WebSocket} can stay idle. - * - * @param defaultWebSocketIdleTimeoutInMs - * the maximum time in millisecond an {@link com.ning.http.client.websocket.WebSocket} can stay idle. - * @return a {@link Builder} - */ - public Builder setWebSocketIdleTimeoutInMs(int defaultWebSocketIdleTimeoutInMs) { - this.defaultWebsocketIdleTimeoutInMs = defaultWebSocketIdleTimeoutInMs; - return this; - } - - /** - * Set the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can stay idle. - * - * @param defaultIdleConnectionTimeoutInMs - * the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} can stay idle. - * @return a {@link Builder} - */ - public Builder setIdleConnectionTimeoutInMs(int defaultIdleConnectionTimeoutInMs) { - this.defaultIdleConnectionTimeoutInMs = defaultIdleConnectionTimeoutInMs; - return this; - } - - /** - * Set the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection - * idle in pool. - * - * @param defaultIdleConnectionInPoolTimeoutInMs - * the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} will keep connection - * idle in pool. - * @return a {@link Builder} - */ - public Builder setIdleConnectionInPoolTimeoutInMs(int defaultIdleConnectionInPoolTimeoutInMs) { - this.defaultIdleConnectionInPoolTimeoutInMs = defaultIdleConnectionInPoolTimeoutInMs; - return this; - } - - /** - * Set the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} wait for a response - * - * @param defaultRequestTimeoutInMs the maximum time in millisecond an {@link com.ning.http.client.AsyncHttpClient} wait for a response - * @return a {@link Builder} - */ - public Builder setRequestTimeoutInMs(int defaultRequestTimeoutInMs) { - this.defaultRequestTimeoutInMs = defaultRequestTimeoutInMs; - return this; - } - - /** - * Set to true to enable HTTP redirect - * - * @param redirectEnabled true if enabled. - * @return a {@link Builder} - */ - public Builder setFollowRedirects(boolean redirectEnabled) { - this.redirectEnabled = redirectEnabled; - return this; - } - - /** - * Set the maximum number of HTTP redirect - * - * @param maxDefaultRedirects the maximum number of HTTP redirect - * @return a {@link Builder} - */ - public Builder setMaximumNumberOfRedirects(int maxDefaultRedirects) { - this.maxDefaultRedirects = maxDefaultRedirects; - return this; - } - - /** - * Enable HTTP compression. - * - * @param compressionEnabled true if compression is enabled - * @return a {@link Builder} - */ - public Builder setCompressionEnabled(boolean compressionEnabled) { - this.compressionEnabled = compressionEnabled; - return this; - } - - /** - * Set the USER_AGENT header value - * - * @param userAgent the USER_AGENT header value - * @return a {@link Builder} - */ - public Builder setUserAgent(String userAgent) { - this.userAgent = userAgent; - return this; - } - - /** - * Set true if connection can be pooled by a {@link ConnectionsPool}. Default is true. - * - * @param allowPoolingConnection true if connection can be pooled by a {@link ConnectionsPool} - * @return a {@link Builder} - */ - public Builder setAllowPoolingConnection(boolean allowPoolingConnection) { - this.allowPoolingConnection = allowPoolingConnection; - return this; - } - - /** - * Set true if connection can be pooled by a {@link ConnectionsPool}. Default is true. - * - * @param allowPoolingConnection true if connection can be pooled by a {@link ConnectionsPool} - * @return a {@link Builder} - * @deprecated - Use {@link com.ning.http.client.AsyncHttpClientConfig.Builder#setAllowPoolingConnection(boolean)} - */ - public Builder setKeepAlive(boolean allowPoolingConnection) { - this.allowPoolingConnection = allowPoolingConnection; - return this; - } - - /** - * Set the{@link ScheduledExecutorService} used to expire idle connections. - * - * @param reaper the{@link ScheduledExecutorService} used to expire idle connections. - * @return a {@link Builder} - */ - public Builder setScheduledExecutorService(ScheduledExecutorService reaper) { - if (this.reaper != null) this.reaper.shutdown(); - this.reaper = reaper; - return this; - } - - /** - * Set the {@link java.util.concurrent.ExecutorService} an {@link AsyncHttpClient} use for handling - * asynchronous response. - * - * @param applicationThreadPool the {@link java.util.concurrent.ExecutorService} an {@link AsyncHttpClient} use for handling - * asynchronous response. - * @return a {@link Builder} - */ - public Builder setExecutorService(ExecutorService applicationThreadPool) { - if (this.applicationThreadPool != null) this.applicationThreadPool.shutdown(); - this.applicationThreadPool = applicationThreadPool; - return this; - } - - /** - * Set an instance of {@link com.ning.http.client.ProxyServer} used by an {@link AsyncHttpClient} - * - * @param proxyServer instance of {@link com.ning.http.client.ProxyServer} - * @return a {@link Builder} - */ - public Builder setProxyServer(ProxyServer proxyServer) { - this.proxyServer = proxyServer; - return this; - } - - /** - * Set the {@link SSLEngineFactory} for secure connection. - * - * @param sslEngineFactory the {@link SSLEngineFactory} for secure connection - * @return a {@link Builder} - */ - public Builder setSSLEngineFactory(SSLEngineFactory sslEngineFactory) { - this.sslEngineFactory = sslEngineFactory; - return this; - } - - /** - * Set the {@link SSLContext} for secure connection. - * - * @param sslContext the {@link SSLContext} for secure connection - * @return a {@link Builder} - */ - public Builder setSSLContext(final SSLContext sslContext) { - this.sslEngineFactory = new SSLEngineFactory() { - public SSLEngine newSSLEngine() throws GeneralSecurityException { - SSLEngine sslEngine = sslContext.createSSLEngine(); - sslEngine.setUseClientMode(true); - return sslEngine; - } - }; - this.sslContext = sslContext; - return this; - } - - /** - * Set the {@link com.ning.http.client.AsyncHttpProviderConfig} - * - * @param providerConfig the {@link com.ning.http.client.AsyncHttpProviderConfig} - * @return a {@link Builder} - */ - public Builder setAsyncHttpClientProviderConfig(AsyncHttpProviderConfig providerConfig) { - this.providerConfig = providerConfig; - return this; - } - - /** - * Set the {@link ConnectionsPool} - * - * @param connectionsPool the {@link ConnectionsPool} - * @return a {@link Builder} - */ - public Builder setConnectionsPool(ConnectionsPool connectionsPool) { - this.connectionsPool = connectionsPool; - return this; - } - - /** - * Set the {@link Realm} that will be used for all requests. - * - * @param realm the {@link Realm} - * @return a {@link Builder} - */ - public Builder setRealm(Realm realm) { - this.realm = realm; - return this; - } - - /** - * Add an {@link com.ning.http.client.filter.RequestFilter} that will be invoked before {@link com.ning.http.client.AsyncHttpClient#executeRequest(Request)} - * - * @param requestFilter {@link com.ning.http.client.filter.RequestFilter} - * @return this - */ - public Builder addRequestFilter(RequestFilter requestFilter) { - requestFilters.add(requestFilter); - return this; - } - - /** - * Remove an {@link com.ning.http.client.filter.RequestFilter} that will be invoked before {@link com.ning.http.client.AsyncHttpClient#executeRequest(Request)} - * - * @param requestFilter {@link com.ning.http.client.filter.RequestFilter} - * @return this - */ - public Builder removeRequestFilter(RequestFilter requestFilter) { - requestFilters.remove(requestFilter); - return this; - } - - /** - * Add an {@link com.ning.http.client.filter.ResponseFilter} that will be invoked as soon as the response is - * received, and before {@link AsyncHandler#onStatusReceived(HttpResponseStatus)}. - * - * @param responseFilter an {@link com.ning.http.client.filter.ResponseFilter} - * @return this - */ - public Builder addResponseFilter(ResponseFilter responseFilter) { - responseFilters.add(responseFilter); - return this; - } - - /** - * Remove an {@link com.ning.http.client.filter.ResponseFilter} that will be invoked as soon as the response is - * received, and before {@link AsyncHandler#onStatusReceived(HttpResponseStatus)}. - * - * @param responseFilter an {@link com.ning.http.client.filter.ResponseFilter} - * @return this - */ - public Builder removeResponseFilter(ResponseFilter responseFilter) { - responseFilters.remove(responseFilter); - return this; - } - - /** - * Add an {@link com.ning.http.client.filter.IOExceptionFilter} that will be invoked when an {@link java.io.IOException} - * occurs during the download/upload operations. - * - * @param ioExceptionFilter an {@link com.ning.http.client.filter.ResponseFilter} - * @return this - */ - public Builder addIOExceptionFilter(IOExceptionFilter ioExceptionFilter) { - ioExceptionFilters.add(ioExceptionFilter); - return this; - } - - /** - * Remove an {@link com.ning.http.client.filter.IOExceptionFilter} tthat will be invoked when an {@link java.io.IOException} - * occurs during the download/upload operations. - * - * @param ioExceptionFilter an {@link com.ning.http.client.filter.ResponseFilter} - * @return this - */ - public Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter) { - ioExceptionFilters.remove(ioExceptionFilter); - return this; - } - - /** - * Return the compression level, or -1 if no compression is used. - * - * @return the compression level, or -1 if no compression is use - */ - public int getRequestCompressionLevel() { - return requestCompressionLevel; - } - - /** - * Set the compression level, or -1 if no compression is used. - * - * @param requestCompressionLevel compression level, or -1 if no compression is use - * @return this - */ - public Builder setRequestCompressionLevel(int requestCompressionLevel) { - this.requestCompressionLevel = requestCompressionLevel; - return this; - } - - /** - * Set the number of time a request will be retried when an {@link java.io.IOException} occurs because of a Network exception. - * - * @param maxRequestRetry the number of time a request will be retried - * @return this - */ - public Builder setMaxRequestRetry(int maxRequestRetry) { - this.maxRequestRetry = maxRequestRetry; - return this; - } - - /** - * Return true is if connections pooling is enabled. - * - * @param allowSslConnectionPool true if enabled - * @return this - */ - public Builder setAllowSslConnectionPool(boolean allowSslConnectionPool) { - this.allowSslConnectionPool = allowSslConnectionPool; - return this; - } - - /** - * Allows use unescaped URLs in requests - * useful for retrieving data from broken sites - * - * @param useRawUrl - * @return this - */ - public Builder setUseRawUrl(boolean useRawUrl) { - this.useRawUrl = useRawUrl; - return this; - } - - /** - * Set to false if you don't want the query parameters removed when a redirect occurs. - * - * @param removeQueryParamOnRedirect - * @return this - */ - public Builder setRemoveQueryParamsOnRedirect(boolean removeQueryParamOnRedirect) { - this.removeQueryParamOnRedirect = removeQueryParamOnRedirect; - return this; - } - - /** - * Sets whether AHC should use the default http.proxy* system properties - * to obtain proxy information. - *

- * If useProxyProperties is set to true but {@link #setProxyServer(ProxyServer)} was used - * to explicitly set a proxy server, the latter is preferred. - *

- * See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html - */ - public Builder setUseProxyProperties(boolean useProxyProperties) { - this.useProxyProperties = useProxyProperties; - return this; - } - - public Builder setIOThreadMultiplier(int multiplier) { - this.ioThreadMultiplier = multiplier; - return this; - } - - /** - * Set the {@link HostnameVerifier} - * - * @param hostnameVerifier {@link HostnameVerifier} - * @return this - */ - public Builder setHostnameVerifier(HostnameVerifier hostnameVerifier) { - this.hostnameVerifier = hostnameVerifier; - return this; - } - - /** - * Configures this AHC instance to be strict in it's handling of 302 redirects - * in a POST/Redirect/GET situation. - * - * @param strict302Handling strict handling - * - * @return this - * - * @since 1.7.2 - */ - public Builder setStrict302Handling(final boolean strict302Handling) { - this.strict302Handling = strict302Handling; - return this; - } - - /** - * Create a config builder with values taken from the given prototype configuration. - * - * @param prototype the configuration to use as a prototype. - */ - public Builder(AsyncHttpClientConfig prototype) { - allowPoolingConnection = prototype.getAllowPoolingConnection(); - providerConfig = prototype.getAsyncHttpProviderConfig(); - connectionsPool = prototype.getConnectionsPool(); - defaultConnectionTimeOutInMs = prototype.getConnectionTimeoutInMs(); - defaultIdleConnectionInPoolTimeoutInMs = prototype.getIdleConnectionInPoolTimeoutInMs(); - defaultIdleConnectionTimeoutInMs = prototype.getIdleConnectionTimeoutInMs(); - defaultMaxConnectionPerHost = prototype.getMaxConnectionPerHost(); - maxDefaultRedirects = prototype.getMaxRedirects(); - defaultMaxTotalConnections = prototype.getMaxTotalConnections(); - proxyServer = prototype.getProxyServer(); - realm = prototype.getRealm(); - defaultRequestTimeoutInMs = prototype.getRequestTimeoutInMs(); - sslContext = prototype.getSSLContext(); - sslEngineFactory = prototype.getSSLEngineFactory(); - userAgent = prototype.getUserAgent(); - redirectEnabled = prototype.isRedirectEnabled(); - compressionEnabled = prototype.isCompressionEnabled(); - reaper = prototype.reaper(); - applicationThreadPool = prototype.executorService(); - - requestFilters.clear(); - responseFilters.clear(); - ioExceptionFilters.clear(); - - requestFilters.addAll(prototype.getRequestFilters()); - responseFilters.addAll(prototype.getResponseFilters()); - ioExceptionFilters.addAll(prototype.getIOExceptionFilters()); - - requestCompressionLevel = prototype.getRequestCompressionLevel(); - useRawUrl = prototype.isUseRawUrl(); - ioThreadMultiplier = prototype.getIoThreadMultiplier(); - maxRequestRetry = prototype.getMaxRequestRetry(); - allowSslConnectionPool = prototype.getAllowPoolingConnection(); - removeQueryParamOnRedirect = prototype.isRemoveQueryParamOnRedirect(); - hostnameVerifier = prototype.getHostnameVerifier(); - strict302Handling = prototype.isStrict302Handling(); - } - - /** - * Build an {@link AsyncHttpClientConfig} - * - * @return an {@link AsyncHttpClientConfig} - */ - public AsyncHttpClientConfig build() { - - if (applicationThreadPool.isShutdown()) { - throw new IllegalStateException("ExecutorServices closed"); - } - - if (proxyServer == null && useProxyProperties) { - proxyServer = ProxyUtils.createProxy(System.getProperties()); - } - - return new AsyncHttpClientConfig(defaultMaxTotalConnections, - defaultMaxConnectionPerHost, - defaultConnectionTimeOutInMs, - defaultWebsocketIdleTimeoutInMs, - defaultIdleConnectionInPoolTimeoutInMs, - defaultIdleConnectionTimeoutInMs, - defaultRequestTimeoutInMs, - redirectEnabled, - maxDefaultRedirects, - compressionEnabled, - userAgent, - allowPoolingConnection, - reaper, - applicationThreadPool, - proxyServer, - sslContext, - sslEngineFactory, - providerConfig, - connectionsPool, - realm, - requestFilters, - responseFilters, - ioExceptionFilters, - requestCompressionLevel, - maxRequestRetry, - allowSslConnectionPool, - useRawUrl, - removeQueryParamOnRedirect, - hostnameVerifier, - ioThreadMultiplier, - strict302Handling); - } - } -} - diff --git a/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java b/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java deleted file mode 100644 index 0924d4d760..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java +++ /dev/null @@ -1,244 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client; - -import com.ning.http.client.filter.IOExceptionFilter; -import com.ning.http.client.filter.RequestFilter; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.util.ProxyUtils; - -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLSession; -import java.util.LinkedList; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.ThreadFactory; - -/** - * Simple JavaBean version of {@link AsyncHttpClientConfig} - */ -public class AsyncHttpClientConfigBean extends AsyncHttpClientConfig { - - public AsyncHttpClientConfigBean() { - configureExecutors(); - configureDefaults(); - configureFilters(); - } - - void configureFilters() { - requestFilters = new LinkedList(); - responseFilters = new LinkedList(); - ioExceptionFilters = new LinkedList(); - } - - void configureDefaults() { - maxTotalConnections = Integer.getInteger(ASYNC_CLIENT + "defaultMaxTotalConnections", -1); - maxConnectionPerHost = Integer.getInteger(ASYNC_CLIENT + "defaultMaxConnectionsPerHost", -1); - connectionTimeOutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultConnectionTimeoutInMS", 60 * 1000); - idleConnectionInPoolTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionInPoolTimeoutInMS", 60 * 1000); - idleConnectionTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultIdleConnectionTimeoutInMS", 60 * 1000); - requestTimeoutInMs = Integer.getInteger(ASYNC_CLIENT + "defaultRequestTimeoutInMS", 60 * 1000); - redirectEnabled = Boolean.getBoolean(ASYNC_CLIENT + "defaultRedirectsEnabled"); - maxDefaultRedirects = Integer.getInteger(ASYNC_CLIENT + "defaultMaxRedirects", 5); - compressionEnabled = Boolean.getBoolean(ASYNC_CLIENT + "compressionEnabled"); - userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "NING/1.0"); - - boolean useProxyProperties = Boolean.getBoolean(ASYNC_CLIENT + "useProxyProperties"); - if (useProxyProperties) { - proxyServer = ProxyUtils.createProxy(System.getProperties()); - } - - allowPoolingConnection = true; - requestCompressionLevel = -1; - maxRequestRetry = 5; - allowSslConnectionPool = true; - useRawUrl = false; - removeQueryParamOnRedirect = true; - hostnameVerifier = new HostnameVerifier() { - - public boolean verify(String s, SSLSession sslSession) { - return true; - } - }; - } - - void configureExecutors() { - reaper = Executors.newScheduledThreadPool(Runtime.getRuntime().availableProcessors(), new ThreadFactory() { - public Thread newThread(Runnable r) { - Thread t = new Thread(r, "AsyncHttpClient-Reaper"); - t.setDaemon(true); - return t; - } - }); - applicationThreadPool = Executors.newCachedThreadPool(new ThreadFactory() { - public Thread newThread(Runnable r) { - Thread t = new Thread(r, "AsyncHttpClient-Callback"); - t.setDaemon(true); - return t; - } - }); - } - - public AsyncHttpClientConfigBean setMaxTotalConnections(int maxTotalConnections) { - this.maxTotalConnections = maxTotalConnections; - return this; - } - - public AsyncHttpClientConfigBean setMaxConnectionPerHost(int maxConnectionPerHost) { - this.maxConnectionPerHost = maxConnectionPerHost; - return this; - } - - public AsyncHttpClientConfigBean setConnectionTimeOutInMs(int connectionTimeOutInMs) { - this.connectionTimeOutInMs = connectionTimeOutInMs; - return this; - } - - public AsyncHttpClientConfigBean setIdleConnectionInPoolTimeoutInMs(int idleConnectionInPoolTimeoutInMs) { - this.idleConnectionInPoolTimeoutInMs = idleConnectionInPoolTimeoutInMs; - return this; - } - - public AsyncHttpClientConfigBean setIdleConnectionTimeoutInMs(int idleConnectionTimeoutInMs) { - this.idleConnectionTimeoutInMs = idleConnectionTimeoutInMs; - return this; - } - - public AsyncHttpClientConfigBean setRequestTimeoutInMs(int requestTimeoutInMs) { - this.requestTimeoutInMs = requestTimeoutInMs; - return this; - } - - public AsyncHttpClientConfigBean setRedirectEnabled(boolean redirectEnabled) { - this.redirectEnabled = redirectEnabled; - return this; - } - - public AsyncHttpClientConfigBean setMaxDefaultRedirects(int maxDefaultRedirects) { - this.maxDefaultRedirects = maxDefaultRedirects; - return this; - } - - public AsyncHttpClientConfigBean setCompressionEnabled(boolean compressionEnabled) { - this.compressionEnabled = compressionEnabled; - return this; - } - - public AsyncHttpClientConfigBean setUserAgent(String userAgent) { - this.userAgent = userAgent; - return this; - } - - public AsyncHttpClientConfigBean setAllowPoolingConnection(boolean allowPoolingConnection) { - this.allowPoolingConnection = allowPoolingConnection; - return this; - } - - public AsyncHttpClientConfigBean setReaper(ScheduledExecutorService reaper) { - if (this.reaper != null) { - this.reaper.shutdownNow(); - } - this.reaper = reaper; - return this; - } - - public AsyncHttpClientConfigBean setApplicationThreadPool(ExecutorService applicationThreadPool) { - if (this.applicationThreadPool != null) { - this.applicationThreadPool.shutdownNow(); - } - this.applicationThreadPool = applicationThreadPool; - return this; - } - - public AsyncHttpClientConfigBean setProxyServer(ProxyServer proxyServer) { - this.proxyServer = proxyServer; - return this; - } - - public AsyncHttpClientConfigBean setSslContext(SSLContext sslContext) { - this.sslContext = sslContext; - return this; - } - - public AsyncHttpClientConfigBean setSslEngineFactory(SSLEngineFactory sslEngineFactory) { - this.sslEngineFactory = sslEngineFactory; - return this; - } - - public AsyncHttpClientConfigBean setProviderConfig(AsyncHttpProviderConfig providerConfig) { - this.providerConfig = providerConfig; - return this; - } - - public AsyncHttpClientConfigBean setConnectionsPool(ConnectionsPool connectionsPool) { - this.connectionsPool = connectionsPool; - return this; - } - - public AsyncHttpClientConfigBean setRealm(Realm realm) { - this.realm = realm; - return this; - } - - public AsyncHttpClientConfigBean addRequestFilter(RequestFilter requestFilter) { - requestFilters.add(requestFilter); - return this; - } - - public AsyncHttpClientConfigBean addResponseFilters(ResponseFilter responseFilter) { - responseFilters.add(responseFilter); - return this; - } - - public AsyncHttpClientConfigBean addIoExceptionFilters(IOExceptionFilter ioExceptionFilter) { - ioExceptionFilters.add(ioExceptionFilter); - return this; - } - - public AsyncHttpClientConfigBean setRequestCompressionLevel(int requestCompressionLevel) { - this.requestCompressionLevel = requestCompressionLevel; - return this; - } - - public AsyncHttpClientConfigBean setMaxRequestRetry(int maxRequestRetry) { - this.maxRequestRetry = maxRequestRetry; - return this; - } - - public AsyncHttpClientConfigBean setAllowSslConnectionPool(boolean allowSslConnectionPool) { - this.allowSslConnectionPool = allowSslConnectionPool; - return this; - } - - public AsyncHttpClientConfigBean setUseRawUrl(boolean useRawUrl) { - this.useRawUrl = useRawUrl; - return this; - } - - public AsyncHttpClientConfigBean setRemoveQueryParamOnRedirect(boolean removeQueryParamOnRedirect) { - this.removeQueryParamOnRedirect = removeQueryParamOnRedirect; - return this; - } - - public AsyncHttpClientConfigBean setHostnameVerifier(HostnameVerifier hostnameVerifier) { - this.hostnameVerifier = hostnameVerifier; - return this; - } - - public AsyncHttpClientConfigBean setIoThreadMultiplier(int ioThreadMultiplier) { - this.ioThreadMultiplier = ioThreadMultiplier; - return this; - } -} diff --git a/src/main/java/com/ning/http/client/AsyncHttpProvider.java b/src/main/java/com/ning/http/client/AsyncHttpProvider.java deleted file mode 100644 index 1689bc137e..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHttpProvider.java +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import java.io.IOException; -import java.util.Collection; - -/** - * Interface to be used when implementing custom asynchronous I/O HTTP client. - * By default, the {@link com.ning.http.client.providers.netty.NettyAsyncHttpProvider} is used. - */ -public interface AsyncHttpProvider { - - /** - * Execute the request and invoke the {@link AsyncHandler} when the response arrive. - * - * @param handler an instance of {@link AsyncHandler} - * @return a {@link ListenableFuture} of Type T. - * @throws IOException - */ - public ListenableFuture execute(Request request, AsyncHandler handler) throws IOException; - - /** - * Close the current underlying TCP/HTTP connection. - */ - public void close(); - - /** - * Prepare a {@link Response} - * - * @param status {@link HttpResponseStatus} - * @param headers {@link HttpResponseHeaders} - * @param bodyParts list of {@link HttpResponseBodyPart} - * @return a {@link Response} - */ - public Response prepareResponse(HttpResponseStatus status, - HttpResponseHeaders headers, - Collection bodyParts); - -} diff --git a/src/main/java/com/ning/http/client/AsyncHttpProviderConfig.java b/src/main/java/com/ning/http/client/AsyncHttpProviderConfig.java deleted file mode 100644 index ea5e0f8911..0000000000 --- a/src/main/java/com/ning/http/client/AsyncHttpProviderConfig.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client; - -import java.util.Map; -import java.util.Set; - -/** - * {@link com.ning.http.client.AsyncHttpProvider} proprietary configurable properties. Note that properties are - * AsyncHttpProvider dependent, so make sure you consult the AsyncHttpProvider's documentation - * about what is supported and what's not. - */ -public interface AsyncHttpProviderConfig { - - /** - * Add a property that will be used when the AsyncHttpClient initialize its {@link com.ning.http.client.AsyncHttpProvider} - * - * @param name the name of the property - * @param value the value of the property - * @return this instance of AsyncHttpProviderConfig - */ - public AsyncHttpProviderConfig addProperty(U name, V value); - - /** - * Return the value associated with the property's name - * - * @param name - * @return this instance of AsyncHttpProviderConfig - */ - public V getProperty(U name); - - /** - * Remove the value associated with the property's name - * - * @param name - * @return true if removed - */ - public V removeProperty(U name); - - /** - * Return the curent entry set. - * - * @return a the curent entry set. - */ - public Set> propertiesSet(); -} diff --git a/src/main/java/com/ning/http/client/Body.java b/src/main/java/com/ning/http/client/Body.java deleted file mode 100644 index 309fbec5ae..0000000000 --- a/src/main/java/com/ning/http/client/Body.java +++ /dev/null @@ -1,47 +0,0 @@ -/* -* Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. -* -* This program is licensed to you under the Apache License Version 2.0, -* and you may not use this file except in compliance with the Apache License Version 2.0. -* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the Apache License Version 2.0 is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. -*/ - -package com.ning.http.client; - -import java.io.IOException; -import java.nio.ByteBuffer; - -/** - * A request body. - */ -public interface Body { - - /** - * Gets the length of the body. - * - * @return The length of the body in bytes, or negative if unknown. - */ - long getContentLength(); - - /** - * Reads the next chunk of bytes from the body. - * - * @param buffer The buffer to store the chunk in, must not be {@code null}. - * @return The non-negative number of bytes actually read or {@code -1} if the body has been read completely. - * @throws IOException If the chunk could not be read. - */ - long read(ByteBuffer buffer) throws IOException; - - /** - * Releases any resources associated with this body. - * - * @throws IOException - */ - void close() throws IOException; - -} diff --git a/src/main/java/com/ning/http/client/ByteArrayPart.java b/src/main/java/com/ning/http/client/ByteArrayPart.java deleted file mode 100644 index 3d7c73186c..0000000000 --- a/src/main/java/com/ning/http/client/ByteArrayPart.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -public class ByteArrayPart implements Part { - private String name; - private String fileName; - private byte[] data; - private String mimeType; - private String charSet; - - public ByteArrayPart(String name, String fileName, byte[] data, String mimeType, String charSet) { - this.name = name; - this.fileName = fileName; - this.data = data; - this.mimeType = mimeType; - this.charSet = charSet; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public String getName() { - return name; - } - - public String getFileName() { - return fileName; - } - - public byte[] getData() { - return data; - } - - public String getMimeType() { - return mimeType; - } - - public String getCharSet() { - return charSet; - } -} diff --git a/src/main/java/com/ning/http/client/ConnectionsPool.java b/src/main/java/com/ning/http/client/ConnectionsPool.java deleted file mode 100644 index 1feb843d8b..0000000000 --- a/src/main/java/com/ning/http/client/ConnectionsPool.java +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -/** - * An interface used by an {@link AsyncHttpProvider} for caching http connections. - */ -public interface ConnectionsPool { - - /** - * Add a connection tpo the pool - * - * @param uri a uri used to retrieve the cached connection - * @param connection an I/O connection - * @return true if added. - */ - public boolean offer(U uri, V connection); - - /** - * Remove the connection associated with the uri. - * - * @param uri the uri used when invoking addConnection - * @return the connection associated with the uri - */ - public V poll(U uri); - - /** - * Remove all connections from the cache. A connection might have been associated with several uri. - * - * @param connection a connection - * @return the true if the connection has been removed - */ - public boolean removeAll(V connection); - - /** - * Return true if a connection can be cached. A implementation can decide based on some rules to allow caching - * Calling this method is equivalent of checking the returned value of {@link ConnectionsPool#offer(Object, Object)} - * - * @return true if a connection can be cached. - */ - public boolean canCacheConnection(); - - /** - * Destroy all connections that has been cached by this instance. - */ - public void destroy(); -} diff --git a/src/main/java/com/ning/http/client/Cookie.java b/src/main/java/com/ning/http/client/Cookie.java deleted file mode 100644 index 26fd46920f..0000000000 --- a/src/main/java/com/ning/http/client/Cookie.java +++ /dev/null @@ -1,131 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.util.Collections; -import java.util.Set; -import java.util.TreeSet; - -public class Cookie { - private final String domain; - private final String name; - private final String value; - private final String path; - private final int maxAge; - private final boolean secure; - private final int version; - private Set ports = Collections.emptySet(); - private Set unmodifiablePorts = ports; - - public Cookie(String domain, String name, String value, String path, int maxAge, boolean secure) { - this.domain = domain; - this.name = name; - this.value = value; - this.path = path; - this.maxAge = maxAge; - this.secure = secure; - this.version = 1; - } - - public Cookie(String domain, String name, String value, String path, int maxAge, boolean secure, int version) { - this.domain = domain; - this.name = name; - this.value = value; - this.path = path; - this.maxAge = maxAge; - this.secure = secure; - this.version = version; - } - - public String getDomain() { - return domain; - } - - public String getName() { - return name == null ? "" : name; - } - - public String getValue() { - return value == null ? "" : value; - } - - public String getPath() { - return path; - } - - public int getMaxAge() { - return maxAge; - } - - public boolean isSecure() { - return secure; - } - - public int getVersion() { - return version; - } - - public Set getPorts() { - if (unmodifiablePorts == null) { - unmodifiablePorts = Collections.unmodifiableSet(ports); - } - return unmodifiablePorts; - } - - public void setPorts(int... ports) { - if (ports == null) { - throw new NullPointerException("ports"); - } - - int[] portsCopy = ports.clone(); - if (portsCopy.length == 0) { - unmodifiablePorts = this.ports = Collections.emptySet(); - } else { - Set newPorts = new TreeSet(); - for (int p : portsCopy) { - if (p <= 0 || p > 65535) { - throw new IllegalArgumentException("port out of range: " + p); - } - newPorts.add(Integer.valueOf(p)); - } - this.ports = newPorts; - unmodifiablePorts = null; - } - } - - public void setPorts(Iterable ports) { - Set newPorts = new TreeSet(); - for (int p : ports) { - if (p <= 0 || p > 65535) { - throw new IllegalArgumentException("port out of range: " + p); - } - newPorts.add(Integer.valueOf(p)); - } - if (newPorts.isEmpty()) { - unmodifiablePorts = this.ports = Collections.emptySet(); - } else { - this.ports = newPorts; - unmodifiablePorts = null; - } - } - - @Override - public String toString() { - return String.format("Cookie: domain=%s, name=%s, value=%s, path=%s, maxAge=%d, secure=%s", - domain, name, value, path, maxAge, secure); - } -} diff --git a/src/main/java/com/ning/http/client/FilePart.java b/src/main/java/com/ning/http/client/FilePart.java deleted file mode 100644 index 714395a745..0000000000 --- a/src/main/java/com/ning/http/client/FilePart.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.io.File; - -/** - * A file multipart part. - */ -public class FilePart implements Part { - private String name; - private File file; - private String mimeType; - private String charSet; - - public FilePart(String name, File file, String mimeType, String charSet) { - this.name = name; - this.file = file; - this.mimeType = mimeType; - this.charSet = charSet; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public String getName() { - return name; - } - - public File getFile() { - return file; - } - - public String getMimeType() { - return mimeType; - } - - public String getCharSet() { - return charSet; - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/FluentCaseInsensitiveStringsMap.java b/src/main/java/com/ning/http/client/FluentCaseInsensitiveStringsMap.java deleted file mode 100644 index 009af7e43f..0000000000 --- a/src/main/java/com/ning/http/client/FluentCaseInsensitiveStringsMap.java +++ /dev/null @@ -1,507 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Iterator; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; -import java.util.Set; - -/** - * An implementation of a {@code String -> List} map that adds a fluent interface, i.e. methods that - * return this instance. This class differs from {@link FluentStringsMap} in that keys are treated in an - * case-insensitive matter, i.e. case of the key doesn't matter when retrieving values or changing the map. - * However, the map preserves the key case (of the first insert or replace) and returns the keys in their - * original case in the appropriate methods (e.g. {@link FluentCaseInsensitiveStringsMap#keySet()}). - */ -public class FluentCaseInsensitiveStringsMap implements Map>, Iterable>> { - private final Map> values = new LinkedHashMap>(); - private final Map keyLookup = new LinkedHashMap(); - - public FluentCaseInsensitiveStringsMap() { - } - - public FluentCaseInsensitiveStringsMap(FluentCaseInsensitiveStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - add(header.getKey(), header.getValue()); - } - } - } - - public FluentCaseInsensitiveStringsMap(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - add(header.getKey(), header.getValue()); - } - } - } - - /** - * Adds the specified values and returns this object. - * - * @param key The key - * @param values The value(s); if null then this method has no effect. Use the empty string to - * generate an empty value - * @return This object - */ - public FluentCaseInsensitiveStringsMap add(String key, String... values) { - if ((values != null) && (values.length > 0)) { - add(key, Arrays.asList(values)); - } - return this; - } - - private List fetchValues(Collection values) { - List result = null; - - if (values != null) { - for (String value : values) { - if (value == null) { - value = ""; - } - if (result == null) { - // lazy initialization - result = new ArrayList(); - } - result.add(value); - } - } - return result; - } - - /** - * Adds the specified values and returns this object. - * - * @param key The key - * @param values The value(s); if null then this method has no effect. Use an empty collection - * to generate an empty value - * @return This object - */ - public FluentCaseInsensitiveStringsMap add(String key, Collection values) { - if (key != null) { - List nonNullValues = fetchValues(values); - - if (nonNullValues != null) { - String lcKey = key.toLowerCase(); - String realKey = keyLookup.get(lcKey); - List curValues = null; - - if (realKey == null) { - realKey = key; - keyLookup.put(lcKey, key); - } else { - curValues = this.values.get(realKey); - } - - if (curValues == null) { - curValues = new ArrayList(); - this.values.put(realKey, curValues); - } - curValues.addAll(nonNullValues); - } - } - return this; - } - - /** - * Adds all key-values pairs from the given object to this object and returns this object. - * - * @param src The source object - * @return This object - */ - public FluentCaseInsensitiveStringsMap addAll(FluentCaseInsensitiveStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - add(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Adds all key-values pairs from the given map to this object and returns this object. - * - * @param src The source map - * @return This object - */ - public FluentCaseInsensitiveStringsMap addAll(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - add(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Replaces the values for the given key with the given values. - * - * @param key The key - * @param values The new values - * @return This object - */ - public FluentCaseInsensitiveStringsMap replace(final String key, final String... values) { - return replace(key, Arrays.asList(values)); - } - - /** - * Replaces the values for the given key with the given values. - * - * @param key The key - * @param values The new values - * @return This object - */ - public FluentCaseInsensitiveStringsMap replace(final String key, final Collection values) { - if (key != null) { - List nonNullValues = fetchValues(values); - String lcKkey = key.toLowerCase(); - String realKey = keyLookup.get(lcKkey); - - if (nonNullValues == null) { - keyLookup.remove(lcKkey); - if (realKey != null) { - this.values.remove(realKey); - } - } else { - if (!key.equals(realKey)) { - keyLookup.put(lcKkey, key); - this.values.remove(realKey); - } - this.values.put(key, nonNullValues); - } - } - return this; - } - - /** - * Replace the values for all keys from the given map that are also present in this object, with the values from the given map. - * All key-values from the given object that are not present in this object, will be added to it. - * - * @param src The source object - * @return This object - */ - public FluentCaseInsensitiveStringsMap replaceAll(FluentCaseInsensitiveStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - replace(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Replace the values for all keys from the given map that are also present in this object, with the values from the given map. - * All key-values from the given object that are not present in this object, will be added to it. - * - * @param src The source map - * @return This object - */ - public FluentCaseInsensitiveStringsMap replaceAll(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - replace(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List put(String key, List value) { - if (key == null) { - throw new NullPointerException("Null keys are not allowed"); - } - - List oldValue = get(key); - - replace(key, value); - return oldValue; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void putAll(Map> values) { - replaceAll(values); - } - - /** - * Removes the values for the given key if present and returns this object. - * - * @param key The key - * @return This object - */ - public FluentCaseInsensitiveStringsMap delete(String key) { - if (key != null) { - String lcKey = key.toLowerCase(); - String realKey = keyLookup.remove(lcKey); - - if (realKey != null) { - values.remove(realKey); - } - } - return this; - } - - /** - * Removes the values for the given keys if present and returns this object. - * - * @param keys The keys - * @return This object - */ - public FluentCaseInsensitiveStringsMap deleteAll(String... keys) { - if (keys != null) { - for (String key : keys) { - remove(key); - } - } - return this; - } - - /** - * Removes the values for the given keys if present and returns this object. - * - * @param keys The keys - * @return This object - */ - public FluentCaseInsensitiveStringsMap deleteAll(Collection keys) { - if (keys != null) { - for (String key : keys) { - remove(key); - } - } - return this; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List remove(Object key) { - if (key == null) { - return null; - } else { - List oldValues = get(key.toString()); - - delete(key.toString()); - return oldValues; - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void clear() { - keyLookup.clear(); - values.clear(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Iterator>> iterator() { - return Collections.unmodifiableSet(values.entrySet()).iterator(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Set keySet() { - return new LinkedHashSet(keyLookup.values()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Set>> entrySet() { - return values.entrySet(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public int size() { - return values.size(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean isEmpty() { - return values.isEmpty(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean containsKey(Object key) { - return key == null ? false : keyLookup.containsKey(key.toString().toLowerCase()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean containsValue(Object value) { - return values.containsValue(value); - } - - /** - * Returns the value for the given key. If there are multiple values for this key, - * then only the first one will be returned. - * - * @param key The key - * @return The first value - */ - public String getFirstValue(String key) { - List values = get(key); - - if (values == null) { - return null; - } else if (values.isEmpty()) { - return ""; - } else { - return values.get(0); - } - } - - /** - * Returns the values for the given key joined into a single string using the given delimiter. - * - * @param key The key - * @return The value as a single string - */ - public String getJoinedValue(String key, String delimiter) { - List values = get(key); - - if (values == null) { - return null; - } else if (values.size() == 1) { - return values.get(0); - } else { - StringBuilder result = new StringBuilder(); - - for (String value : values) { - if (result.length() > 0) { - result.append(delimiter); - } - result.append(value); - } - return result.toString(); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List get(Object key) { - if (key == null) { - return null; - } - - String lcKey = key.toString().toLowerCase(); - String realKey = keyLookup.get(lcKey); - - if (realKey == null) { - return null; - } else { - return values.get(realKey); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Collection> values() { - return values.values(); - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - - final FluentCaseInsensitiveStringsMap other = (FluentCaseInsensitiveStringsMap) obj; - - if (values == null) { - if (other.values != null) { - return false; - } - } else if (!values.equals(other.values)) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return values == null ? 0 : values.hashCode(); - } - - @Override - public String toString() { - StringBuilder result = new StringBuilder(); - - for (Map.Entry> entry : values.entrySet()) { - if (result.length() > 0) { - result.append("; "); - } - result.append("\""); - result.append(entry.getKey()); - result.append("="); - - boolean needsComma = false; - - for (String value : entry.getValue()) { - if (needsComma) { - result.append(", "); - } else { - needsComma = true; - } - result.append(value); - } - result.append("\""); - } - return result.toString(); - } -} diff --git a/src/main/java/com/ning/http/client/FluentStringsMap.java b/src/main/java/com/ning/http/client/FluentStringsMap.java deleted file mode 100644 index 5c71428614..0000000000 --- a/src/main/java/com/ning/http/client/FluentStringsMap.java +++ /dev/null @@ -1,469 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Iterator; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; - -/** - * An implementation of a {@code String -> List} map that adds a fluent interface, i.e. methods that - * return this instance. - */ -public class FluentStringsMap implements Map>, Iterable>> { - private final Map> values = new LinkedHashMap>(); - - public FluentStringsMap() { - } - - public FluentStringsMap(FluentStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - add(header.getKey(), header.getValue()); - } - } - } - - public FluentStringsMap(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - add(header.getKey(), header.getValue()); - } - } - } - - /** - * Adds the specified values and returns this object. - * - * @param key The key - * @param values The value(s); if null then this method has no effect. Use the empty string to - * generate an empty value - * @return This object - */ - public FluentStringsMap add(String key, String... values) { - if ((values != null) && (values.length > 0)) { - add(key, Arrays.asList(values)); - } - return this; - } - - private List fetchValues(Collection values) { - List result = null; - - if (values != null) { - for (String value : values) { - if (value == null) { - value = ""; - } - if (result == null) { - // lazy initialization - result = new ArrayList(); - } - result.add(value); - } - } - return result; - } - - /** - * Adds the specified values and returns this object. - * - * @param key The key - * @param values The value(s); if null then this method has no effect. Use an empty collection - * to generate an empty value - * @return This object - */ - public FluentStringsMap add(String key, Collection values) { - if (key != null) { - List nonNullValues = fetchValues(values); - - if (nonNullValues != null) { - List curValues = this.values.get(key); - - if (curValues == null) { - curValues = new ArrayList(); - this.values.put(key, curValues); - } - curValues.addAll(nonNullValues); - } - } - return this; - } - - /** - * Adds all key-values pairs from the given object to this object and returns this object. - * - * @param src The source object - * @return This object - */ - public FluentStringsMap addAll(FluentStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - add(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Adds all key-values pairs from the given map to this object and returns this object. - * - * @param src The source map - * @return This object - */ - public FluentStringsMap addAll(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - add(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Replaces the values for the given key with the given values. - * - * @param key The key - * @param values The new values - * @return This object - */ - public FluentStringsMap replace(final String key, final String... values) { - return replace(key, Arrays.asList(values)); - } - - /** - * Replaces the values for the given key with the given values. - * - * @param key The key - * @param values The new values - * @return This object - */ - public FluentStringsMap replace(final String key, final Collection values) { - if (key != null) { - List nonNullValues = fetchValues(values); - - if (nonNullValues == null) { - this.values.remove(key); - } else { - this.values.put(key, nonNullValues); - } - } - return this; - } - - /** - * Replace the values for all keys from the given map that are also present in this object, with the values from the given map. - * All key-values from the given object that are not present in this object, will be added to it. - * - * @param src The source object - * @return This object - */ - public FluentStringsMap replaceAll(FluentStringsMap src) { - if (src != null) { - for (Map.Entry> header : src) { - replace(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * Replace the values for all keys from the given map that are also present in this object, with the values from the given map. - * All key-values from the given object that are not present in this object, will be added to it. - * - * @param src The source map - * @return This object - */ - public FluentStringsMap replaceAll(Map> src) { - if (src != null) { - for (Map.Entry> header : src.entrySet()) { - replace(header.getKey(), header.getValue()); - } - } - return this; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List put(String key, List value) { - if (key == null) { - throw new NullPointerException("Null keys are not allowed"); - } - - List oldValue = get(key); - - replace(key, value); - return oldValue; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void putAll(Map> values) { - replaceAll(values); - } - - /** - * Removes the values for the given key if present and returns this object. - * - * @param key The key - * @return This object - */ - public FluentStringsMap delete(String key) { - values.remove(key); - return this; - } - - /** - * Removes the values for the given keys if present and returns this object. - * - * @param keys The keys - * @return This object - */ - public FluentStringsMap deleteAll(String... keys) { - if (keys != null) { - for (String key : keys) { - remove(key); - } - } - return this; - } - - /** - * Removes the values for the given keys if present and returns this object. - * - * @param keys The keys - * @return This object - */ - public FluentStringsMap deleteAll(Collection keys) { - if (keys != null) { - for (String key : keys) { - remove(key); - } - } - return this; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List remove(Object key) { - if (key == null) { - return null; - } else { - List oldValues = get(key.toString()); - - delete(key.toString()); - return oldValues; - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void clear() { - values.clear(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Iterator>> iterator() { - return Collections.unmodifiableSet(values.entrySet()).iterator(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Set keySet() { - return Collections.unmodifiableSet(values.keySet()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Set>> entrySet() { - return values.entrySet(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public int size() { - return values.size(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean isEmpty() { - return values.isEmpty(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean containsKey(Object key) { - return key == null ? false : values.containsKey(key.toString()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean containsValue(Object value) { - return values.containsValue(value); - } - - /** - * Returns the value for the given key. If there are multiple values for this key, - * then only the first one will be returned. - * - * @param key The key - * @return The first value - */ - public String getFirstValue(String key) { - List values = get(key); - - if (values == null) { - return null; - } else if (values.isEmpty()) { - return ""; - } else { - return values.get(0); - } - } - - /** - * Returns the values for the given key joined into a single string using the given delimiter. - * - * @param key The key - * @return The value as a single string - */ - public String getJoinedValue(String key, String delimiter) { - List values = get(key); - - if (values == null) { - return null; - } else if (values.size() == 1) { - return values.get(0); - } else { - StringBuilder result = new StringBuilder(); - - for (String value : values) { - if (result.length() > 0) { - result.append(delimiter); - } - result.append(value); - } - return result.toString(); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public List get(Object key) { - if (key == null) { - return null; - } - - return values.get(key.toString()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Collection> values() { - return values.values(); - } - - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj == null) { - return false; - } - if (getClass() != obj.getClass()) { - return false; - } - - final FluentStringsMap other = (FluentStringsMap) obj; - - if (values == null) { - if (other.values != null) { - return false; - } - } else if (!values.equals(other.values)) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return values == null ? 0 : values.hashCode(); - } - - @Override - public String toString() { - StringBuilder result = new StringBuilder(); - - for (Map.Entry> entry : values.entrySet()) { - if (result.length() > 0) { - result.append("; "); - } - result.append("\""); - result.append(entry.getKey()); - result.append("="); - - boolean needsComma = false; - - for (String value : entry.getValue()) { - if (needsComma) { - result.append(", "); - } else { - needsComma = true; - } - result.append(value); - } - result.append("\""); - } - return result.toString(); - } -} diff --git a/src/main/java/com/ning/http/client/HttpContent.java b/src/main/java/com/ning/http/client/HttpContent.java deleted file mode 100644 index 334def9239..0000000000 --- a/src/main/java/com/ning/http/client/HttpContent.java +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import java.net.URI; - -/** - * Base class for callback class used by {@link com.ning.http.client.AsyncHandler} - */ -public class HttpContent { - protected final AsyncHttpProvider provider; - protected final URI uri; - - protected HttpContent(URI url, AsyncHttpProvider provider) { - this.provider = provider; - this.uri = url; - } - - /** - * Return the current {@link AsyncHttpProvider} - * - * @return the current {@link AsyncHttpProvider} - */ - public final AsyncHttpProvider provider() { - return provider; - } - - /** - * Return the request {@link URI} - * - * @return the request {@link URI} - */ - public final URI getUrl() { - return uri; - } -} diff --git a/src/main/java/com/ning/http/client/HttpResponseBodyPart.java b/src/main/java/com/ning/http/client/HttpResponseBodyPart.java deleted file mode 100644 index ca73d4824b..0000000000 --- a/src/main/java/com/ning/http/client/HttpResponseBodyPart.java +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.nio.ByteBuffer; - -/** - * A callback class used when an HTTP response body is received. - */ -public abstract class HttpResponseBodyPart extends HttpContent { - - public HttpResponseBodyPart(URI uri, AsyncHttpProvider provider) { - super(uri, provider); - } - - /** - * Return the response body's part bytes received. - * - * @return the response body's part bytes received. - */ - abstract public byte[] getBodyPartBytes(); - - /** - * Write the available bytes to the {@link java.io.OutputStream} - * - * @param outputStream - * @return The number of bytes written - * @throws IOException - */ - abstract public int writeTo(OutputStream outputStream) throws IOException; - - /** - * Return a {@link ByteBuffer} that wraps the actual bytes read from the response's chunk. The {@link ByteBuffer} - * capacity is equal to the number of bytes available. - * - * @return {@link ByteBuffer} - */ - abstract public ByteBuffer getBodyByteBuffer(); - - /** - * Return true if this is the last part. - * - * @return true if this is the last part. - */ - abstract public boolean isLast(); - - /** - * Close the underlying connection once the processing has completed. Invoking that method means the - * underlying TCP connection will be closed as soon as the processing of the response is completed. That - * means the underlying connection will never get pooled. - */ - abstract public void markUnderlyingConnectionAsClosed(); - - /** - * Return true of the underlying connection will be closed once the response has been fully processed. - * - * @return true of the underlying connection will be closed once the response has been fully processed. - */ - abstract public boolean closeUnderlyingConnection(); - -} diff --git a/src/main/java/com/ning/http/client/HttpResponseHeaders.java b/src/main/java/com/ning/http/client/HttpResponseHeaders.java deleted file mode 100644 index c3842cf122..0000000000 --- a/src/main/java/com/ning/http/client/HttpResponseHeaders.java +++ /dev/null @@ -1,52 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import java.net.URI; - -/** - * A class that represent the HTTP headers. - */ -public abstract class HttpResponseHeaders extends HttpContent { - - private final boolean traillingHeaders; - - public HttpResponseHeaders(URI uri, AsyncHttpProvider provider) { - super(uri, provider); - this.traillingHeaders = false; - } - - public HttpResponseHeaders(URI uri, AsyncHttpProvider provider, boolean traillingHeaders) { - super(uri, provider); - this.traillingHeaders = traillingHeaders; - } - - /** - * Return the HTTP header - * - * @return an {@link FluentCaseInsensitiveStringsMap} - */ - abstract public FluentCaseInsensitiveStringsMap getHeaders(); - - /** - * Return true is headers has been received after the response body. - * - * @return true is headers has been received after the response body. - */ - public boolean isTraillingHeadersReceived() { - return traillingHeaders; - } -} diff --git a/src/main/java/com/ning/http/client/HttpResponseStatus.java b/src/main/java/com/ning/http/client/HttpResponseStatus.java deleted file mode 100644 index f90b30c5a7..0000000000 --- a/src/main/java/com/ning/http/client/HttpResponseStatus.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.net.URI; - -/** - * A class that represent the HTTP response' status line (code + text) - */ -public abstract class HttpResponseStatus extends HttpContent { - - public HttpResponseStatus(URI uri, AsyncHttpProvider provider) { - super(uri, provider); - } - - /** - * Return the response status code - * - * @return the response status code - */ - abstract public int getStatusCode(); - - /** - * Return the response status text - * - * @return the response status text - */ - abstract public String getStatusText(); - - /** - * Protocol name from status line. - * - * @return Protocol name. - */ - abstract public String getProtocolName(); - - /** - * Protocol major version. - * - * @return Major version. - */ - abstract public int getProtocolMajorVersion(); - - /** - * Protocol minor version. - * - * @return Minor version. - */ - abstract public int getProtocolMinorVersion(); - - /** - * Full protocol name + version - * - * @return protocol name + version - */ - abstract public String getProtocolText(); -} diff --git a/src/main/java/com/ning/http/client/ListenableFuture.java b/src/main/java/com/ning/http/client/ListenableFuture.java deleted file mode 100755 index 74dfcb70f0..0000000000 --- a/src/main/java/com/ning/http/client/ListenableFuture.java +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -/* - * Copyright (C) 2007 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package com.ning.http.client; - -import java.util.concurrent.Callable; -import java.util.concurrent.Executor; -import java.util.concurrent.Future; - -/** - * Extended {@link Future} - * - * @param Type of the value that will be returned. - */ -public interface ListenableFuture extends Future { - - /** - * Execute a {@link Callable} and if there is no exception, mark this Future as done and release the internal lock. - * - * @param callable - */ - void done(Callable callable); - - /** - * Abort the current processing, and propagate the {@link Throwable} to the {@link AsyncHandler} or {@link Future} - * - * @param t - */ - void abort(Throwable t); - - /** - * Set the content that will be returned by this instance - * - * @param v the content that will be returned by this instance - */ - void content(V v); - - /** - * Touch the current instance to prevent external service to times out. - */ - void touch(); - - /** - * Write the {@link Request} headers - */ - boolean getAndSetWriteHeaders(boolean writeHeader); - - /** - * Write the {@link Request} body - */ - boolean getAndSetWriteBody(boolean writeBody); - - /** - *

Adds a listener and executor to the ListenableFuture. - * The listener will be {@linkplain java.util.concurrent.Executor#execute(Runnable) passed - * to the executor} for execution when the {@code Future}'s computation is - * {@linkplain Future#isDone() complete}. - *

- *

There is no guaranteed ordering of execution of listeners, they may get - * called in the order they were added and they may get called out of order, - * but any listener added through this method is guaranteed to be called once - * the computation is complete. - * - * @param listener the listener to run when the computation is complete. - * @param exec the executor to run the listener in. - * @return this Future - * @throws NullPointerException if the executor or listener was null. - * @throws java.util.concurrent.RejectedExecutionException - * if we tried to execute the listener - * immediately but the executor rejected it. - */ - ListenableFuture addListener(Runnable listener, Executor exec); -} diff --git a/src/main/java/com/ning/http/client/MaxRedirectException.java b/src/main/java/com/ning/http/client/MaxRedirectException.java deleted file mode 100644 index bdffe02368..0000000000 --- a/src/main/java/com/ning/http/client/MaxRedirectException.java +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -/** - * Thrown when the {@link AsyncHttpClientConfig#getMaxRedirects()} has been reached. - */ -public class MaxRedirectException extends Exception { - private static final long serialVersionUID = 1L; - - public MaxRedirectException() { - super(); - } - - public MaxRedirectException(String msg) { - super(msg); - } - - public MaxRedirectException(Throwable cause) { - super(cause); - } - - public MaxRedirectException(String message, Throwable cause) { - super(message, cause); - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/Part.java b/src/main/java/com/ning/http/client/Part.java deleted file mode 100644 index 95e34eeca7..0000000000 --- a/src/main/java/com/ning/http/client/Part.java +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -/** - * Interface for the parts in a multipart request. - */ -public interface Part { - public String getName(); -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/PerRequestConfig.java b/src/main/java/com/ning/http/client/PerRequestConfig.java deleted file mode 100644 index 9f0d84395d..0000000000 --- a/src/main/java/com/ning/http/client/PerRequestConfig.java +++ /dev/null @@ -1,48 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -/** - * Per request configuration. - * - * @author Hubert Iwaniuk - * @deprecated Per request properties are set on request directly or via builder. This class will be gone in next major release. - */ -public class PerRequestConfig { - private final ProxyServer proxyServer; - private int requestTimeoutInMs; - - public PerRequestConfig() { - this(null, 0); - } - - public PerRequestConfig(ProxyServer proxyServer, int requestTimeoutInMs) { - this.proxyServer = proxyServer; - this.requestTimeoutInMs = requestTimeoutInMs; - } - - public ProxyServer getProxyServer() { - return proxyServer; - } - - public int getRequestTimeoutInMs() { - return requestTimeoutInMs; - } - - public void setRequestTimeoutInMs(int requestTimeoutInMs) { - this.requestTimeoutInMs = requestTimeoutInMs; - } -} diff --git a/src/main/java/com/ning/http/client/ProxyServer.java b/src/main/java/com/ning/http/client/ProxyServer.java deleted file mode 100644 index 79cc5e1eee..0000000000 --- a/src/main/java/com/ning/http/client/ProxyServer.java +++ /dev/null @@ -1,137 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; - -/** - * Represents a proxy server. - */ -public class ProxyServer { - - public enum Protocol { - HTTP("http"), HTTPS("https"), NTLM("NTLM"), KERBEROS("KERBEROS"), SPNEGO("SPNEGO"); - - private final String protocol; - - private Protocol(final String protocol) { - this.protocol = protocol; - } - - public String getProtocol() { - return protocol; - } - - @Override - public String toString() { - return getProtocol(); - } - } - - private String encoding = "UTF-8"; - private final List nonProxyHosts = new ArrayList(); - private final Protocol protocol; - private final String host; - private final String principal; - private final String password; - private int port; - private String ntlmDomain = System.getProperty("http.auth.ntlm.domain", ""); - - public ProxyServer(final Protocol protocol, final String host, final int port, String principal, String password) { - this.protocol = protocol; - this.host = host; - this.port = port; - this.principal = principal; - this.password = password; - } - - public ProxyServer(final String host, final int port, String principal, String password) { - this(Protocol.HTTP, host, port, principal, password); - } - - public ProxyServer(final Protocol protocol, final String host, final int port) { - this(protocol, host, port, null, null); - } - - public ProxyServer(final String host, final int port) { - this(Protocol.HTTP, host, port, null, null); - } - - public Protocol getProtocol() { - return protocol; - } - - public String getProtocolAsString() { - return protocol.toString(); - } - - public String getHost() { - return host; - } - - public int getPort() { - return port; - } - - public String getPrincipal() { - return principal; - } - - public String getPassword() { - return password; - } - - public ProxyServer setEncoding(String encoding) { - this.encoding = encoding; - return this; - } - - public String getEncoding() { - return encoding; - } - - public ProxyServer addNonProxyHost(String uri) { - nonProxyHosts.add(uri); - return this; - } - - public ProxyServer removeNonProxyHost(String uri) { - nonProxyHosts.remove(uri); - return this; - } - - public List getNonProxyHosts() { - return Collections.unmodifiableList(nonProxyHosts); - } - - public ProxyServer setNtlmDomain(String ntlmDomain) { - this.ntlmDomain = ntlmDomain; - return this; - } - - public String getNtlmDomain() { - return ntlmDomain; - } - - @Override - public String toString() { - return String.format("%s://%s:%d", protocol.toString(), host, port); - } -} - diff --git a/src/main/java/com/ning/http/client/RandomAccessBody.java b/src/main/java/com/ning/http/client/RandomAccessBody.java deleted file mode 100644 index c4ee2f2332..0000000000 --- a/src/main/java/com/ning/http/client/RandomAccessBody.java +++ /dev/null @@ -1,37 +0,0 @@ -/* -* Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. -* -* This program is licensed to you under the Apache License Version 2.0, -* and you may not use this file except in compliance with the Apache License Version 2.0. -* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the Apache License Version 2.0 is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. -*/ - -package com.ning.http.client; - -import java.io.IOException; -import java.nio.channels.WritableByteChannel; - -/** - * A request body which supports random access to its contents. - */ -public interface RandomAccessBody - extends Body { - - /** - * Transfers the specified chunk of bytes from this body to the specified channel. - * - * @param position The zero-based byte index from which to start the transfer, must not be negative. - * @param count The maximum number of bytes to transfer, must not be negative. - * @param target The destination channel to transfer the body chunk to, must not be {@code null}. - * @return The non-negative number of bytes actually transferred. - * @throws IOException If the body chunk could not be transferred. - */ - long transferTo(long position, long count, WritableByteChannel target) - throws IOException; - -} diff --git a/src/main/java/com/ning/http/client/Realm.java b/src/main/java/com/ning/http/client/Realm.java deleted file mode 100644 index 07c84bfa3a..0000000000 --- a/src/main/java/com/ning/http/client/Realm.java +++ /dev/null @@ -1,612 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.UnsupportedEncodingException; -import java.security.MessageDigest; -import java.security.NoSuchAlgorithmException; - -/** - * This class is required when authentication is needed. The class support DIGEST and BASIC. - */ -public class Realm { - - private static final String NC = "00000001"; - - private final String principal; - private final String password; - private final AuthScheme scheme; - private final String realmName; - private final String nonce; - private final String algorithm; - private final String response; - private final String opaque; - private final String qop; - private final String nc; - private final String cnonce; - private final String uri; - private final String methodName; - private final boolean usePreemptiveAuth; - private final String enc; - private final String host; - private final boolean messageType2Received; - - private final String domain; - - public enum AuthScheme { - DIGEST, - BASIC, - NTLM, - SPNEGO, - KERBEROS, - NONE - } - - private Realm(AuthScheme scheme, - String principal, - String password, - String realmName, - String nonce, - String algorithm, - String response, - String qop, - String nc, - String cnonce, - String uri, - String method, - boolean usePreemptiveAuth, - String domain, String enc, String host, boolean messageType2Received, - String opaque) { - - this.principal = principal; - this.password = password; - this.scheme = scheme; - this.realmName = realmName; - this.nonce = nonce; - this.algorithm = algorithm; - this.response = response; - this.opaque = opaque; - this.qop = qop; - this.nc = nc; - this.cnonce = cnonce; - this.uri = uri; - this.methodName = method; - this.usePreemptiveAuth = usePreemptiveAuth; - this.domain = domain; - this.enc = enc; - this.host = host; - this.messageType2Received = messageType2Received; - } - - public String getPrincipal() { - return principal; - } - - public String getPassword() { - return password; - } - - public AuthScheme getAuthScheme() { - return scheme; - } - - public AuthScheme getScheme() { - - return scheme; - } - - public String getRealmName() { - return realmName; - } - - public String getNonce() { - return nonce; - } - - public String getAlgorithm() { - return algorithm; - } - - public String getResponse() { - return response; - } - - public String getOpaque() { - return opaque; - } - - public String getQop() { - return qop; - } - - public String getNc() { - return nc; - } - - public String getCnonce() { - return cnonce; - } - - public String getUri() { - return uri; - } - - public String getEncoding() { - return enc; - } - - public String getMethodName() { - return methodName; - } - - /** - * Return true is preemptive authentication is enabled - * - * @return true is preemptive authentication is enabled - */ - public boolean getUsePreemptiveAuth() { - return usePreemptiveAuth; - } - - /** - * Return the NTLM domain to use. This value should map the JDK - * - * @return the NTLM domain - * @deprecated - use getNtlmDomain() - */ - public String getDomain() { - return domain; - } - - /** - * Return the NTLM domain to use. This value should map the JDK - * - * @return the NTLM domain - */ - public String getNtlmDomain() { - return domain; - } - - /** - * Return the NTLM host. - * - * @return the NTLM host - */ - public String getNtlmHost() { - return host; - } - - public boolean isNtlmMessageType2Received() { - return messageType2Received; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Realm realm = (Realm) o; - - if (algorithm != null ? !algorithm.equals(realm.algorithm) : realm.algorithm != null) return false; - if (cnonce != null ? !cnonce.equals(realm.cnonce) : realm.cnonce != null) return false; - if (nc != null ? !nc.equals(realm.nc) : realm.nc != null) return false; - if (nonce != null ? !nonce.equals(realm.nonce) : realm.nonce != null) return false; - if (password != null ? !password.equals(realm.password) : realm.password != null) return false; - if (principal != null ? !principal.equals(realm.principal) : realm.principal != null) return false; - if (qop != null ? !qop.equals(realm.qop) : realm.qop != null) return false; - if (realmName != null ? !realmName.equals(realm.realmName) : realm.realmName != null) return false; - if (response != null ? !response.equals(realm.response) : realm.response != null) return false; - if (scheme != realm.scheme) return false; - if (uri != null ? !uri.equals(realm.uri) : realm.uri != null) return false; - - return true; - } - - @Override - public String toString() { - return "Realm{" + - "principal='" + principal + '\'' + - ", password='" + password + '\'' + - ", scheme=" + scheme + - ", realmName='" + realmName + '\'' + - ", nonce='" + nonce + '\'' + - ", algorithm='" + algorithm + '\'' + - ", response='" + response + '\'' + - ", qop='" + qop + '\'' + - ", nc='" + nc + '\'' + - ", cnonce='" + cnonce + '\'' + - ", uri='" + uri + '\'' + - ", methodName='" + methodName + '\'' + - '}'; - } - - @Override - public int hashCode() { - int result = principal != null ? principal.hashCode() : 0; - result = 31 * result + (password != null ? password.hashCode() : 0); - result = 31 * result + (scheme != null ? scheme.hashCode() : 0); - result = 31 * result + (realmName != null ? realmName.hashCode() : 0); - result = 31 * result + (nonce != null ? nonce.hashCode() : 0); - result = 31 * result + (algorithm != null ? algorithm.hashCode() : 0); - result = 31 * result + (response != null ? response.hashCode() : 0); - result = 31 * result + (qop != null ? qop.hashCode() : 0); - result = 31 * result + (nc != null ? nc.hashCode() : 0); - result = 31 * result + (cnonce != null ? cnonce.hashCode() : 0); - result = 31 * result + (uri != null ? uri.hashCode() : 0); - return result; - } - - /** - * A builder for {@link Realm} - */ - public static class RealmBuilder { - - private static final Logger logger = LoggerFactory.getLogger(RealmBuilder.class); - - // - // Portions of code (newCnonce, newResponse) are highly inspired be Jetty 6 BasicAuthentication.java class. - // This code is already Apache licenced. - // - - private String principal = ""; - private String password = ""; - private AuthScheme scheme = AuthScheme.NONE; - private String realmName = ""; - private String nonce = ""; - private String algorithm = "MD5"; - private String response = ""; - private String opaque = ""; - private String qop = "auth"; - private String nc = "00000001"; - private String cnonce = ""; - private String uri = ""; - private String methodName = "GET"; - private boolean usePreemptive = false; - private String domain = System.getProperty("http.auth.ntlm.domain", ""); - private String enc = "UTF-8"; - private String host = "localhost"; - private boolean messageType2Received = false; - - @Deprecated - public String getDomain() { - return domain; - } - - @Deprecated - public RealmBuilder setDomain(String domain) { - this.domain = domain; - return this; - } - - public String getNtlmDomain() { - return domain; - } - - public RealmBuilder setNtlmDomain(String domain) { - this.domain = domain; - return this; - } - - public String getNtlmHost() { - return host; - } - - public RealmBuilder setNtlmHost(String host) { - this.host = host; - return this; - } - - - public String getPrincipal() { - return principal; - } - - public RealmBuilder setPrincipal(String principal) { - this.principal = principal; - return this; - } - - public String getPassword() { - return password; - } - - public RealmBuilder setPassword(String password) { - this.password = password; - return this; - } - - public AuthScheme getScheme() { - return scheme; - } - - public RealmBuilder setScheme(AuthScheme scheme) { - this.scheme = scheme; - return this; - } - - public String getRealmName() { - return realmName; - } - - public RealmBuilder setRealmName(String realmName) { - this.realmName = realmName; - return this; - } - - public String getNonce() { - return nonce; - } - - public RealmBuilder setNonce(String nonce) { - this.nonce = nonce; - return this; - } - - public String getAlgorithm() { - return algorithm; - } - - public RealmBuilder setAlgorithm(String algorithm) { - this.algorithm = algorithm; - return this; - } - - public String getResponse() { - return response; - } - - public RealmBuilder setResponse(String response) { - this.response = response; - return this; - } - - public String getOpaque() { - return this.opaque; - } - - public RealmBuilder setOpaque(String opaque) { - this.opaque = opaque; - return this; - } - - public String getQop() { - return qop; - } - - public RealmBuilder setQop(String qop) { - this.qop = qop; - return this; - } - - public String getNc() { - return nc; - } - - public RealmBuilder setNc(String nc) { - this.nc = nc; - return this; - } - - public String getUri() { - return uri; - } - - public RealmBuilder setUri(String uri) { - this.uri = uri; - return this; - } - - public String getMethodName() { - return methodName; - } - - public RealmBuilder setMethodName(String methodName) { - this.methodName = methodName; - return this; - } - - public boolean getUsePreemptiveAuth() { - return usePreemptive; - } - - public RealmBuilder setUsePreemptiveAuth(boolean usePreemptiveAuth) { - this.usePreemptive = usePreemptiveAuth; - return this; - } - - public RealmBuilder parseWWWAuthenticateHeader(String headerLine) { - setRealmName(match(headerLine, "realm")); - setNonce(match(headerLine, "nonce")); - setAlgorithm(match(headerLine, "algorithm")); - setOpaque(match(headerLine, "opaque")); - setQop(match(headerLine, "qop")); - if (getNonce() != null && !getNonce().equalsIgnoreCase("")) { - setScheme(AuthScheme.DIGEST); - } else { - setScheme(AuthScheme.BASIC); - } - return this; - } - - public RealmBuilder setNtlmMessageType2Received(boolean messageType2Received) { - this.messageType2Received = messageType2Received; - return this; - } - - public RealmBuilder clone(Realm clone) { - setRealmName(clone.getRealmName()); - setAlgorithm(clone.getAlgorithm()); - setMethodName(clone.getMethodName()); - setNc(clone.getNc()); - setNonce(clone.getNonce()); - setPassword(clone.getPassword()); - setPrincipal(clone.getPrincipal()); - setEnconding(clone.getEncoding()); - setOpaque(clone.getOpaque()); - setQop(clone.getQop()); - setScheme(clone.getScheme()); - setUri(clone.getUri()); - setUsePreemptiveAuth(clone.getUsePreemptiveAuth()); - setNtlmDomain(clone.getNtlmDomain()); - setNtlmHost(clone.getNtlmHost()); - setNtlmMessageType2Received(clone.isNtlmMessageType2Received()); - return this; - } - - private void newCnonce() { - try { - MessageDigest md = MessageDigest.getInstance("MD5"); - byte[] b = md.digest(String.valueOf(System.currentTimeMillis()).getBytes("ISO-8859-1")); - cnonce = toHexString(b); - } catch (Exception e) { - throw new SecurityException(e); - } - } - - /** - * TODO: A Pattern/Matcher may be better. - */ - private String match(String headerLine, String token) { - if (headerLine == null) { - return ""; - } - - int match = headerLine.indexOf(token); - if (match <= 0) return ""; - - // = to skip - match += token.length() + 1; - int traillingComa = headerLine.indexOf(",", match); - String value = headerLine.substring(match, traillingComa > 0 ? traillingComa : headerLine.length()); - value = value.endsWith("\"") ? value.substring(0, value.length() - 1) : value; - return value.startsWith("\"") ? value.substring(1) : value; - } - - public String getEncoding() { - return enc; - } - - public RealmBuilder setEnconding(String enc) { - this.enc = enc; - return this; - } - - private void newResponse() throws UnsupportedEncodingException { - MessageDigest md = null; - try { - md = MessageDigest.getInstance("MD5"); - } catch (NoSuchAlgorithmException e) { - throw new SecurityException(e); - } - md.update(new StringBuilder(principal) - .append(":") - .append(realmName) - .append(":") - .append(password) - .toString().getBytes("ISO-8859-1")); - byte[] ha1 = md.digest(); - - md.reset(); - md.update(new StringBuilder(methodName) - .append(':') - .append(uri).toString().getBytes("ISO-8859-1")); - byte[] ha2 = md.digest(); - - md.update(new StringBuilder(toBase16(ha1)) - .append(':') - .append(nonce) - .append(':') - .append(NC) - .append(':') - .append(cnonce) - .append(':') - .append(qop) - .append(':') - .append(toBase16(ha2)).toString().getBytes("ISO-8859-1")); - byte[] digest = md.digest(); - - response = toHexString(digest); - } - - private static String toHexString(byte[] data) { - StringBuilder buffer = new StringBuilder(); - for (int i = 0; i < data.length; i++) { - buffer.append(Integer.toHexString((data[i] & 0xf0) >>> 4)); - buffer.append(Integer.toHexString(data[i] & 0x0f)); - } - return buffer.toString(); - } - - private static String toBase16(byte[] bytes) { - int base = 16; - StringBuilder buf = new StringBuilder(); - for (byte b : bytes) { - int bi = 0xff & b; - int c = '0' + (bi / base) % base; - if (c > '9') - c = 'a' + (c - '0' - 10); - buf.append((char) c); - c = '0' + bi % base; - if (c > '9') - c = 'a' + (c - '0' - 10); - buf.append((char) c); - } - return buf.toString(); - } - - /** - * Build a {@link Realm} - * - * @return a {@link Realm} - */ - public Realm build() { - - // Avoid generating - if (nonce != null && !nonce.equals("")) { - newCnonce(); - try { - newResponse(); - } catch (UnsupportedEncodingException e) { - throw new RuntimeException(e); - } - } - - return new Realm(scheme, - principal, - password, - realmName, - nonce, - algorithm, - response, - qop, - nc, - cnonce, - uri, - methodName, - usePreemptive, - domain, - enc, - host, - messageType2Received, - opaque); - } - } - -} diff --git a/src/main/java/com/ning/http/client/Request.java b/src/main/java/com/ning/http/client/Request.java deleted file mode 100644 index 52ef0cbb72..0000000000 --- a/src/main/java/com/ning/http/client/Request.java +++ /dev/null @@ -1,233 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.net.InetAddress; -import java.util.Collection; -import java.util.List; - -/** - * The Request class can be used to construct HTTP request: - *

- *   Request r = new RequestBuilder().setUrl("url")
- *                      .setRealm((new Realm.RealmBuilder()).setPrincipal(user)
- *                      .setPassword(admin)
- *                      .setRealmName("MyRealm")
- *                      .setScheme(Realm.AuthScheme.DIGEST).build());
- *   r.execute();
- * 
- */ -public interface Request { - - /** - * An entity that can be used to manipulate the Request's body output before it get sent. - */ - public static interface EntityWriter { - public void writeEntity(OutputStream out) throws IOException; - } - - /** - * Return the request's type (GET, POST, etc.) - * - * @return the request's type (GET, POST, etc.) - * @deprecated - use getMethod - */ - public String getReqType(); - - /** - * Return the request's method name (GET, POST, etc.) - * - * @return the request's method name (GET, POST, etc.) - */ - public String getMethod(); - - /** - * Return the decoded url - * - * @return the decoded url - */ - public String getUrl(); - - /** - * Return the InetAddress to override - * - * @return the InetAddress - */ - public InetAddress getInetAddress(); - - /** - * Return the undecoded url - * - * @return the undecoded url - */ - public String getRawUrl(); - - /** - * Return the current set of Headers. - * - * @return a {@link FluentCaseInsensitiveStringsMap} contains headers. - */ - public FluentCaseInsensitiveStringsMap getHeaders(); - - /** - * Return Coookie. - * - * @return an unmodifiable Collection of Cookies - */ - public Collection getCookies(); - - /** - * Return the current request's body as a byte array - * - * @return a byte array of the current request's body. - */ - public byte[] getByteData(); - - /** - * Return the current request's body as a string - * - * @return an String representation of the current request's body. - */ - public String getStringData(); - - /** - * Return the current request's body as an InputStream - * - * @return an InputStream representation of the current request's body. - */ - public InputStream getStreamData(); - - /** - * Return the current request's body as an EntityWriter - * - * @return an EntityWriter representation of the current request's body. - */ - public EntityWriter getEntityWriter(); - - /** - * Return the current request's body generator. - * - * @return A generator for the request body. - */ - public BodyGenerator getBodyGenerator(); - - /** - * Return the current size of the content-lenght header based on the body's size. - * - * @return the current size of the content-lenght header based on the body's size. - * @deprecated - */ - public long getLength(); - - /** - * Return the current size of the content-lenght header based on the body's size. - * - * @return the current size of the content-lenght header based on the body's size. - */ - public long getContentLength(); - - /** - * Return the current parameters. - * - * @return a {@link FluentStringsMap} of parameters. - */ - public FluentStringsMap getParams(); - - /** - * Return the current {@link Part} - * - * @return the current {@link Part} - */ - public List getParts(); - - /** - * Return the virtual host value. - * - * @return the virtual host value. - */ - public String getVirtualHost(); - - /** - * Return the query params. - * - * @return {@link FluentStringsMap} of query string - */ - public FluentStringsMap getQueryParams(); - - /** - * Return the {@link ProxyServer} - * - * @return the {@link ProxyServer} - */ - public ProxyServer getProxyServer(); - - /** - * Return the {@link Realm} - * - * @return the {@link Realm} - */ - public Realm getRealm(); - - /** - * Return the {@link File} to upload. - * - * @return the {@link File} to upload. - */ - public File getFile(); - - /** - * Return the true> to follow redirect - * - * @return the true> to follow redirect - */ - public boolean isRedirectEnabled(); - - /** - * - * @return true> if request's redirectEnabled setting - * should be used in place of client's - */ - public boolean isRedirectOverrideSet(); - - /** - * Return Per request configuration. - * - * @return Per request configuration. - */ - public PerRequestConfig getPerRequestConfig(); - - /** - * Return the HTTP Range header value, or - * - * @return the range header value, or 0 is not set. - */ - public long getRangeOffset(); - - /** - * Return the encoding value used when encoding the request's body. - * - * @return the encoding value used when encoding the request's body. - */ - public String getBodyEncoding(); - - public boolean isUseRawUrl(); - -} diff --git a/src/main/java/com/ning/http/client/RequestBuilder.java b/src/main/java/com/ning/http/client/RequestBuilder.java deleted file mode 100644 index 50aaad585f..0000000000 --- a/src/main/java/com/ning/http/client/RequestBuilder.java +++ /dev/null @@ -1,174 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import com.ning.http.client.Request.EntityWriter; - -import java.io.InputStream; -import java.util.Collection; -import java.util.Map; - -/** - * Builder for a {@link Request}. - */ -public class RequestBuilder extends RequestBuilderBase { - - public RequestBuilder() { - super(RequestBuilder.class, "GET", false); - } - - public RequestBuilder(String method) { - super(RequestBuilder.class, method, false); - } - - public RequestBuilder(String method, boolean useRawUrl) { - super(RequestBuilder.class, method, useRawUrl); - } - - public RequestBuilder(Request prototype) { - super(RequestBuilder.class, prototype); - } - - // Note: For now we keep the delegates in place even though they are not needed - // since otherwise Clojure (and maybe other languages) won't be able to - // access these methods - see Clojure tickets 126 and 259 - - @Override - public RequestBuilder addBodyPart(Part part) throws IllegalArgumentException { - return super.addBodyPart(part); - } - - @Override - public RequestBuilder addCookie(Cookie cookie) { - return super.addCookie(cookie); - } - - @Override - public RequestBuilder addHeader(String name, String value) { - return super.addHeader(name, value); - } - - @Override - public RequestBuilder addParameter(String key, String value) throws IllegalArgumentException { - return super.addParameter(key, value); - } - - @Override - public RequestBuilder addQueryParameter(String name, String value) { - return super.addQueryParameter(name, value); - } - - @Override - public RequestBuilder setQueryParameters(FluentStringsMap parameters) { - return super.setQueryParameters(parameters); - } - - @Override - public Request build() { - return super.build(); - } - - @Override - public RequestBuilder setBody(byte[] data) throws IllegalArgumentException { - return super.setBody(data); - } - - @Override - public RequestBuilder setBody(EntityWriter dataWriter, long length) throws IllegalArgumentException { - return super.setBody(dataWriter, length); - } - - @Override - public RequestBuilder setBody(EntityWriter dataWriter) { - return super.setBody(dataWriter); - } - - /** - * Deprecated - Use setBody(new InputStreamBodyGenerator(inputStream)). - * - * @param stream - An {@link InputStream} - * @return a {@link RequestBuilder} - * @throws IllegalArgumentException - * @see #setBody(BodyGenerator) InputStreamBodyGenerator(inputStream) - * @see com.ning.http.client.generators.InputStreamBodyGenerator - * @deprecated {@link #setBody(BodyGenerator)} setBody(new InputStreamBodyGenerator(inputStream)) - */ - @Override - @Deprecated - public RequestBuilder setBody(InputStream stream) throws IllegalArgumentException { - return super.setBody(stream); - } - - @Override - public RequestBuilder setBody(String data) throws IllegalArgumentException { - return super.setBody(data); - } - - @Override - public RequestBuilder setHeader(String name, String value) { - return super.setHeader(name, value); - } - - @Override - public RequestBuilder setHeaders(FluentCaseInsensitiveStringsMap headers) { - return super.setHeaders(headers); - } - - @Override - public RequestBuilder setHeaders(Map> headers) { - return super.setHeaders(headers); - } - - @Override - public RequestBuilder setParameters(Map> parameters) throws IllegalArgumentException { - return super.setParameters(parameters); - } - - @Override - public RequestBuilder setParameters(FluentStringsMap parameters) throws IllegalArgumentException { - return super.setParameters(parameters); - } - - @Override - public RequestBuilder setMethod(String method) { - return super.setMethod(method); - } - - @Override - public RequestBuilder setUrl(String url) { - return super.setUrl(url); - } - - @Override - public RequestBuilder setProxyServer(ProxyServer proxyServer) { - return super.setProxyServer(proxyServer); - } - - @Override - public RequestBuilder setVirtualHost(String virtualHost) { - return super.setVirtualHost(virtualHost); - } - - @Override - public RequestBuilder setFollowRedirects(boolean followRedirects) { - return super.setFollowRedirects(followRedirects); - } - - @Override - public RequestBuilder addOrReplaceCookie(Cookie c) { - return super.addOrReplaceCookie(c); - } -} diff --git a/src/main/java/com/ning/http/client/RequestBuilderBase.java b/src/main/java/com/ning/http/client/RequestBuilderBase.java deleted file mode 100644 index aef61c55ba..0000000000 --- a/src/main/java/com/ning/http/client/RequestBuilderBase.java +++ /dev/null @@ -1,627 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import com.ning.http.client.Request.EntityWriter; -import com.ning.http.util.UTF8UrlEncoder; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.File; -import java.io.InputStream; -import java.io.UnsupportedEncodingException; -import java.net.InetAddress; -import java.net.URI; -import java.net.URLDecoder; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; - -/** - * Builder for {@link Request} - * - * @param - */ -public abstract class RequestBuilderBase> { - private final static Logger logger = LoggerFactory.getLogger(RequestBuilderBase.class); - - private static final class RequestImpl implements Request { - private String method; - private String url = null; - private InetAddress address = null; - private FluentCaseInsensitiveStringsMap headers = new FluentCaseInsensitiveStringsMap(); - private Collection cookies = new ArrayList(); - private byte[] byteData; - private String stringData; - private InputStream streamData; - private EntityWriter entityWriter; - private BodyGenerator bodyGenerator; - private FluentStringsMap params; - private List parts; - private String virtualHost; - private long length = -1; - public FluentStringsMap queryParams; - public ProxyServer proxyServer; - private Realm realm; - private File file; - private Boolean followRedirects; - private PerRequestConfig perRequestConfig; - private long rangeOffset = 0; - public String charset; - private boolean useRawUrl = false; - - public RequestImpl(boolean useRawUrl) { - this.useRawUrl = useRawUrl; - } - - public RequestImpl(Request prototype) { - if (prototype != null) { - this.method = prototype.getMethod(); - int pos = prototype.getUrl().indexOf("?"); - this.url = pos > 0 ? prototype.getUrl().substring(0, pos) : prototype.getUrl(); - this.address = prototype.getInetAddress(); - this.headers = new FluentCaseInsensitiveStringsMap(prototype.getHeaders()); - this.cookies = new ArrayList(prototype.getCookies()); - this.byteData = prototype.getByteData(); - this.stringData = prototype.getStringData(); - this.streamData = prototype.getStreamData(); - this.entityWriter = prototype.getEntityWriter(); - this.bodyGenerator = prototype.getBodyGenerator(); - this.params = (prototype.getParams() == null ? null : new FluentStringsMap(prototype.getParams())); - this.queryParams = (prototype.getQueryParams() == null ? null : new FluentStringsMap(prototype.getQueryParams())); - this.parts = (prototype.getParts() == null ? null : new ArrayList(prototype.getParts())); - this.virtualHost = prototype.getVirtualHost(); - this.length = prototype.getContentLength(); - this.proxyServer = prototype.getProxyServer(); - this.realm = prototype.getRealm(); - this.file = prototype.getFile(); - this.followRedirects = prototype.isRedirectOverrideSet()? prototype.isRedirectEnabled() : null; - this.perRequestConfig = prototype.getPerRequestConfig(); - this.rangeOffset = prototype.getRangeOffset(); - this.charset = prototype.getBodyEncoding(); - this.useRawUrl = prototype.isUseRawUrl(); - } - } - - /* @Override */ - - public String getReqType() { - return getMethod(); - } - - public String getMethod() { - return method; - } - - /* @Override */ - - public String getUrl() { - return toUrl(true); - } - - public InetAddress getInetAddress() { - return address; - } - - private String toUrl(boolean encode) { - - if (url == null) { - logger.debug("setUrl hasn't been invoked. Using http://localhost"); - url = "http://localhost/"; - } - - String uri = url; - if (!uri.startsWith("ws")) { - try { - uri = URI.create(url).toURL().toString(); - } catch (Throwable e) { - throw new IllegalArgumentException("Illegal URL: " + url, e); - } - } - - if (queryParams != null && !queryParams.isEmpty()) { - - StringBuilder builder = new StringBuilder(); - if (!url.substring(8).contains("/")) { // no other "/" than http[s]:// -> http://localhost:1234 - builder.append("/"); - } - builder.append("?"); - - for (Iterator>> i = queryParams.iterator(); i.hasNext(); ) { - Map.Entry> param = i.next(); - String name = param.getKey(); - for (Iterator j = param.getValue().iterator(); j.hasNext(); ) { - String value = j.next(); - if (encode) { - UTF8UrlEncoder.appendEncoded(builder, name); - } else { - builder.append(name); - } - if (value != null && !value.equals("")) { - builder.append('='); - if (encode) { - UTF8UrlEncoder.appendEncoded(builder, value); - } else { - builder.append(value); - } - } - if (j.hasNext()) { - builder.append('&'); - } - } - if (i.hasNext()) { - builder.append('&'); - } - } - uri += builder.toString(); - } - return uri; - } - - /* @Override */ - public String getRawUrl() { - return toUrl(false); - } - - /* @Override */ - public FluentCaseInsensitiveStringsMap getHeaders() { - return headers; - } - - /* @Override */ - public Collection getCookies() { - return Collections.unmodifiableCollection(cookies); - } - - /* @Override */ - public byte[] getByteData() { - return byteData; - } - - /* @Override */ - public String getStringData() { - return stringData; - } - - /* @Override */ - public InputStream getStreamData() { - return streamData; - } - - /* @Override */ - public EntityWriter getEntityWriter() { - return entityWriter; - } - - /* @Override */ - public BodyGenerator getBodyGenerator() { - return bodyGenerator; - } - - /* @Override */ - - /** - * @return - * @deprecated - */ - public long getLength() { - return length; - } - - public long getContentLength() { - return length; - } - - /* @Override */ - public FluentStringsMap getParams() { - return params; - } - - /* @Override */ - public List getParts() { - return parts; - } - - /* @Override */ - public String getVirtualHost() { - return virtualHost; - } - - public FluentStringsMap getQueryParams() { - return queryParams; - } - - public ProxyServer getProxyServer() { - return proxyServer; - } - - public Realm getRealm() { - return realm; - } - - public File getFile() { - return file; - } - - public boolean isRedirectEnabled() { - return (followRedirects != null && followRedirects); - } - - public boolean isRedirectOverrideSet(){ - return followRedirects != null; - } - - public PerRequestConfig getPerRequestConfig() { - return perRequestConfig; - } - - public long getRangeOffset() { - return rangeOffset; - } - - public String getBodyEncoding() { - return charset; - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(url); - - sb.append("\t"); - sb.append(method); - for (String name : headers.keySet()) { - sb.append("\t"); - sb.append(name); - sb.append(":"); - sb.append(headers.getJoinedValue(name, ", ")); - } - - return sb.toString(); - } - - public boolean isUseRawUrl() { - return useRawUrl; - } - } - - private final Class derived; - protected final RequestImpl request; - protected boolean useRawUrl = false; - - protected RequestBuilderBase(Class derived, String method, boolean rawUrls) { - this.derived = derived; - request = new RequestImpl(rawUrls); - request.method = method; - this.useRawUrl = rawUrls; - } - - protected RequestBuilderBase(Class derived, Request prototype) { - this.derived = derived; - request = new RequestImpl(prototype); - this.useRawUrl = prototype.isUseRawUrl(); - } - - public T setUrl(String url) { - request.url = buildUrl(url); - return derived.cast(this); - } - - public T setInetAddress(InetAddress address) { - request.address = address; - return derived.cast(this); - } - - private String buildUrl(String url) { - URI uri = URI.create(url); - StringBuilder buildedUrl = new StringBuilder(); - - if (uri.getScheme() != null) { - buildedUrl.append(uri.getScheme()); - buildedUrl.append("://"); - } - - if (uri.getAuthority() != null) { - buildedUrl.append(uri.getAuthority()); - } - if (uri.getRawPath() != null) { - buildedUrl.append(uri.getRawPath()); - } else { - // AHC-96 - // Let's try to derive it - if (url.indexOf("://") == -1) { - String s = buildedUrl.toString(); - url = s + url.substring(uri.getScheme().length() + 1); - return buildUrl(url); - } else { - throw new IllegalArgumentException("Invalid url " + uri.toString()); - } - } - - if (uri.getRawQuery() != null && !uri.getRawQuery().equals("")) { - String[] queries = uri.getRawQuery().split("&"); - int pos; - for (String query : queries) { - pos = query.indexOf("="); - if (pos <= 0) { - addQueryParameter(query, null); - } else { - try { - if (this.useRawUrl) { - addQueryParameter(query.substring(0, pos), query.substring(pos + 1)); - } else { - addQueryParameter(URLDecoder.decode(query.substring(0, pos), "UTF-8"), URLDecoder.decode(query.substring(pos + 1), "UTF-8")); - } - } catch (UnsupportedEncodingException e) { - throw new RuntimeException(e); - } - } - } - } - return buildedUrl.toString(); - } - - - public T setVirtualHost(String virtualHost) { - request.virtualHost = virtualHost; - return derived.cast(this); - } - - public T setHeader(String name, String value) { - request.headers.replace(name, value); - return derived.cast(this); - } - - public T addHeader(String name, String value) { - if (value == null) { - logger.warn("Value was null, set to \"\""); - value = ""; - } - - request.headers.add(name, value); - return derived.cast(this); - } - - public T setHeaders(FluentCaseInsensitiveStringsMap headers) { - request.headers = (headers == null ? new FluentCaseInsensitiveStringsMap() : new FluentCaseInsensitiveStringsMap(headers)); - return derived.cast(this); - } - - public T setHeaders(Map> headers) { - request.headers = (headers == null ? new FluentCaseInsensitiveStringsMap() : new FluentCaseInsensitiveStringsMap(headers)); - return derived.cast(this); - } - - public T setContentLength(int length) { - request.length = length; - return derived.cast(this); - } - - public T addCookie(Cookie cookie) { - request.cookies.add(cookie); - return derived.cast(this); - } - - private void resetParameters() { - request.params = null; - } - - private void resetNonMultipartData() { - request.byteData = null; - request.stringData = null; - request.streamData = null; - request.entityWriter = null; - request.length = -1; - } - - private void resetMultipartData() { - request.parts = null; - } - - private void checkIfBodyAllowed() { - if ("GET".equals(request.method) || "HEAD".equals(request.method)) { - throw new IllegalArgumentException("Can NOT set Body on HTTP Request Method GET nor HEAD."); - } - } - - public T setBody(File file) { - checkIfBodyAllowed(); - request.file = file; - return derived.cast(this); - } - - public T setBody(byte[] data) throws IllegalArgumentException { - checkIfBodyAllowed(); - resetParameters(); - resetNonMultipartData(); - resetMultipartData(); - request.byteData = data; - return derived.cast(this); - } - - public T setBody(String data) throws IllegalArgumentException { - checkIfBodyAllowed(); - resetParameters(); - resetNonMultipartData(); - resetMultipartData(); - request.stringData = data; - return derived.cast(this); - } - - public T setBody(InputStream stream) throws IllegalArgumentException { - checkIfBodyAllowed(); - resetParameters(); - resetNonMultipartData(); - resetMultipartData(); - request.streamData = stream; - return derived.cast(this); - } - - public T setBody(EntityWriter dataWriter) { - return setBody(dataWriter, -1); - } - - public T setBody(EntityWriter dataWriter, long length) throws IllegalArgumentException { - checkIfBodyAllowed(); - resetParameters(); - resetNonMultipartData(); - resetMultipartData(); - request.entityWriter = dataWriter; - request.length = length; - return derived.cast(this); - } - - public T setBody(BodyGenerator bodyGenerator) { - checkIfBodyAllowed(); - request.bodyGenerator = bodyGenerator; - return derived.cast(this); - } - - public T addQueryParameter(String name, String value) { - if (request.queryParams == null) { - request.queryParams = new FluentStringsMap(); - } - request.queryParams.add(name, value); - return derived.cast(this); - } - - public T setQueryParameters(FluentStringsMap parameters) { - if (parameters == null) { - request.queryParams = null; - } else { - request.queryParams = new FluentStringsMap(parameters); - } - return derived.cast(this); - } - - public T addParameter(String key, String value) throws IllegalArgumentException { - resetNonMultipartData(); - resetMultipartData(); - if (request.params == null) { - request.params = new FluentStringsMap(); - } - request.params.add(key, value); - return derived.cast(this); - } - - public T setParameters(FluentStringsMap parameters) throws IllegalArgumentException { - resetNonMultipartData(); - resetMultipartData(); - request.params = new FluentStringsMap(parameters); - return derived.cast(this); - } - - public T setParameters(Map> parameters) throws IllegalArgumentException { - resetNonMultipartData(); - resetMultipartData(); - request.params = new FluentStringsMap(parameters); - return derived.cast(this); - } - - public T addBodyPart(Part part) throws IllegalArgumentException { - resetParameters(); - resetNonMultipartData(); - if (request.parts == null) { - request.parts = new ArrayList(); - } - request.parts.add(part); - return derived.cast(this); - } - - public T setProxyServer(ProxyServer proxyServer) { - request.proxyServer = proxyServer; - return derived.cast(this); - } - - public T setRealm(Realm realm) { - request.realm = realm; - return derived.cast(this); - } - - public T setFollowRedirects(boolean followRedirects) { - request.followRedirects = followRedirects; - return derived.cast(this); - } - - public T setPerRequestConfig(PerRequestConfig perRequestConfig) { - request.perRequestConfig = perRequestConfig; - return derived.cast(this); - } - - public T setRangeOffset(long rangeOffset) { - request.rangeOffset = rangeOffset; - return derived.cast(this); - } - - public T setMethod(String method) { - request.method = method; - return derived.cast(this); - } - - public T setBodyEncoding(String charset) { - request.charset = charset; - return derived.cast(this); - } - - public Request build() { - if ((request.length < 0) && (request.streamData == null) && allowBody(request.getMethod())) { - // can't concatenate content-length - String contentLength = request.headers.getFirstValue("Content-Length"); - - if (contentLength != null) { - try { - request.length = Long.parseLong(contentLength); - } catch (NumberFormatException e) { - // NoOp -- we wdn't specify length so it will be chunked? - } - } - } - return request; - } - - private boolean allowBody(String method) { - if (method.equalsIgnoreCase("GET") || method.equalsIgnoreCase("OPTIONS") - && method.equalsIgnoreCase("TRACE") - && method.equalsIgnoreCase("HEAD")) { - return false; - } else { - return true; - } - } - - public T addOrReplaceCookie(Cookie cookie) { - String cookieKey = cookie.getName(); - boolean replace = false; - int index = 0; - for (Cookie c : request.cookies) { - if (c.getName().equals(cookieKey)) { - replace = true; - break; - } - - index++; - } - if (replace) { - ((ArrayList) request.cookies).set(index, cookie); - } else { - request.cookies.add(cookie); - } - return derived.cast(this); - } -} diff --git a/src/main/java/com/ning/http/client/Response.java b/src/main/java/com/ning/http/client/Response.java deleted file mode 100644 index 17da422110..0000000000 --- a/src/main/java/com/ning/http/client/Response.java +++ /dev/null @@ -1,222 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; - -/** - * Represents the asynchronous HTTP response callback for an {@link com.ning.http.client.AsyncCompletionHandler} - */ -public interface Response { - /** - * Returns the status code for the request. - * - * @return The status code - */ - public int getStatusCode(); - - /** - * Returns the status text for the request. - * - * @return The status text - */ - public String getStatusText(); - - /** - * Return the entire response body as a byte[]. - * - * @return the entire response body as a byte[]. - * @throws IOException - */ - public byte[] getResponseBodyAsBytes() throws IOException; - - /** - * Returns an input stream for the response body. Note that you should not try to get this more than once, - * and that you should not close the stream. - * - * @return The input stream - * @throws java.io.IOException - */ - public InputStream getResponseBodyAsStream() throws IOException; - - /** - * Returns the first maxLength bytes of the response body as a string. Note that this does not check - * whether the content type is actually a textual one, but it will use the charset if present in the content - * type header. - * - * @param maxLength The maximum number of bytes to read - * @param charset the charset to use when decoding the stream - * @return The response body - * @throws java.io.IOException - */ - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException; - - /** - * Return the entire response body as a String. - * - * @param charset the charset to use when decoding the stream - * @return the entire response body as a String. - * @throws IOException - */ - public String getResponseBody(String charset) throws IOException; - - /** - * Returns the first maxLength bytes of the response body as a string. Note that this does not check - * whether the content type is actually a textual one, but it will use the charset if present in the content - * type header. - * - * @param maxLength The maximum number of bytes to read - * @return The response body - * @throws java.io.IOException - */ - public String getResponseBodyExcerpt(int maxLength) throws IOException; - - /** - * Return the entire response body as a String. - * - * @return the entire response body as a String. - * @throws IOException - */ - public String getResponseBody() throws IOException; - - /** - * Return the request {@link URI}. Note that if the request got redirected, the value of the {@link URI} will be - * the last valid redirect url. - * - * @return the request {@link URI}. - * @throws MalformedURLException - */ - public URI getUri() throws MalformedURLException; - - /** - * Return the content-type header value. - * - * @return the content-type header value. - */ - public String getContentType(); - - /** - * Return the response header - * - * @return the response header - */ - public String getHeader(String name); - - /** - * Return a {@link List} of the response header value. - * - * @return the response header - */ - public List getHeaders(String name); - - public FluentCaseInsensitiveStringsMap getHeaders(); - - /** - * Return true if the response redirects to another object. - * - * @return True if the response redirects to another object. - */ - boolean isRedirected(); - - /** - * Subclasses SHOULD implement toString() in a way that identifies the request for logging. - * - * @return The textual representation - */ - public String toString(); - - /** - * Return the list of {@link Cookie}. - */ - public List getCookies(); - - /** - * Return true if the response's status has been computed by an {@link AsyncHandler} - * - * @return true if the response's status has been computed by an {@link AsyncHandler} - */ - public boolean hasResponseStatus(); - - /** - * Return true if the response's headers has been computed by an {@link AsyncHandler} It will return false if the - * either {@link com.ning.http.client.AsyncHandler#onStatusReceived(HttpResponseStatus)} - * or {@link AsyncHandler#onHeadersReceived(HttpResponseHeaders)} returned {@link com.ning.http.client.AsyncHandler.STATE#ABORT} - * - * @return true if the response's headers has been computed by an {@link AsyncHandler} - */ - public boolean hasResponseHeaders(); - - /** - * Return true if the response's body has been computed by an {@link AsyncHandler}. It will return false if the - * either {@link com.ning.http.client.AsyncHandler#onStatusReceived(HttpResponseStatus)} - * or {@link AsyncHandler#onHeadersReceived(HttpResponseHeaders)} returned {@link com.ning.http.client.AsyncHandler.STATE#ABORT} - * - * @return true if the response's body has been computed by an {@link AsyncHandler} - */ - public boolean hasResponseBody(); - - - public static class ResponseBuilder { - private final Collection bodies = - Collections.synchronizedCollection(new ArrayList()); - private HttpResponseStatus status; - private HttpResponseHeaders headers; - - /** - * Accumulate {@link HttpContent} in order to build a {@link Response} - * - * @param httpContent {@link HttpContent} - * @return this - */ - public ResponseBuilder accumulate(HttpContent httpContent) { - if (httpContent instanceof HttpResponseStatus) { - status = (HttpResponseStatus) httpContent; - } else if (httpContent instanceof HttpResponseHeaders) { - headers = (HttpResponseHeaders) httpContent; - } else if (httpContent instanceof HttpResponseBodyPart) { - bodies.add((HttpResponseBodyPart) httpContent); - } - return this; - } - - /** - * Build a {@link Response} instance - * - * @return a {@link Response} instance - */ - public Response build() { - return status == null ? null : status.provider().prepareResponse(status, headers, bodies); - } - - /** - * Reset the internal state of this builder. - */ - public void reset() { - bodies.clear(); - status = null; - headers = null; - } - } - -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/ResumableBodyConsumer.java b/src/main/java/com/ning/http/client/ResumableBodyConsumer.java deleted file mode 100644 index 018bd648e4..0000000000 --- a/src/main/java/com/ning/http/client/ResumableBodyConsumer.java +++ /dev/null @@ -1,38 +0,0 @@ -/* -* Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. -* -* This program is licensed to you under the Apache License Version 2.0, -* and you may not use this file except in compliance with the Apache License Version 2.0. -* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the Apache License Version 2.0 is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. -*/ - -package com.ning.http.client; - -import java.io.IOException; - -/** - * @author Benjamin Hanzelmann - */ -public interface ResumableBodyConsumer extends BodyConsumer { - - /** - * Prepare this consumer to resume a download, for example by seeking to the end of the underlying file. - * - * @throws IOException - */ - void resume() throws IOException; - - /** - * Get the previously transferred bytes, for example the current file size. - * - * @throws IOException - */ - long getTransferredBytes() throws IOException; - - -} diff --git a/src/main/java/com/ning/http/client/SSLEngineFactory.java b/src/main/java/com/ning/http/client/SSLEngineFactory.java deleted file mode 100644 index 1e5fc5873f..0000000000 --- a/src/main/java/com/ning/http/client/SSLEngineFactory.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client; - -import javax.net.ssl.SSLEngine; -import java.security.GeneralSecurityException; - -/** - * Factory that creates an {@link SSLEngine} to be used for a single SSL connection. - */ -public interface SSLEngineFactory { - /** - * Creates new {@link SSLEngine}. - * - * @return new engine - * @throws GeneralSecurityException if the SSLEngine cannot be created - */ - SSLEngine newSSLEngine() throws GeneralSecurityException; -} diff --git a/src/main/java/com/ning/http/client/SimpleAsyncHttpClient.java b/src/main/java/com/ning/http/client/SimpleAsyncHttpClient.java deleted file mode 100644 index ea03362bad..0000000000 --- a/src/main/java/com/ning/http/client/SimpleAsyncHttpClient.java +++ /dev/null @@ -1,861 +0,0 @@ -/* - * Copyright (c) 2010 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client; - -import com.ning.http.client.resumable.ResumableAsyncHandler; -import com.ning.http.client.resumable.ResumableIOExceptionFilter; -import com.ning.http.client.simple.HeaderMap; -import com.ning.http.client.simple.SimpleAHCTransferListener; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.net.ssl.SSLContext; -import java.io.IOException; -import java.util.Collection; -import java.util.Map; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; -import java.util.concurrent.ScheduledExecutorService; - -/** - * Simple implementation of {@link AsyncHttpClient} and it's related builders ({@link com.ning.http.client.AsyncHttpClientConfig}, - * {@link Realm}, {@link com.ning.http.client.ProxyServer} and {@link com.ning.http.client.AsyncHandler}. You can - * build powerful application by just using this class. - *

- * This class rely on {@link BodyGenerator} and {@link BodyConsumer} for handling the request and response body. No - * {@link AsyncHandler} are required. As simple as: - *

- * SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder()
- * .setIdleConnectionInPoolTimeoutInMs(100)
- * .setMaximumConnectionsTotal(50)
- * .setRequestTimeoutInMs(5 * 60 * 1000)
- * .setUrl(getTargetUrl())
- * .setHeader("Content-Type", "text/html").build();
- * 

- * StringBuilder s = new StringBuilder(); - * Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())), new AppendableBodyConsumer(s)); - *

- * or - *
- * public void ByteArrayOutputStreamBodyConsumerTest() throws Throwable {
- * 

- * SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder() - * .setUrl(getTargetUrl()) - * .build(); - *

- * ByteArrayOutputStream o = new ByteArrayOutputStream(10); - * Future future = client.post(new FileodyGenerator(myFile), new OutputStreamBodyConsumer(o)); - *

- */ -public class SimpleAsyncHttpClient { - - private final static Logger logger = LoggerFactory.getLogger(SimpleAsyncHttpClient.class); - private final AsyncHttpClientConfig config; - private final RequestBuilder requestBuilder; - private AsyncHttpClient asyncHttpClient; - private final ThrowableHandler defaultThrowableHandler; - private final boolean resumeEnabled; - private final ErrorDocumentBehaviour errorDocumentBehaviour; - private final SimpleAHCTransferListener listener; - private final boolean derived; - - private SimpleAsyncHttpClient(AsyncHttpClientConfig config, RequestBuilder requestBuilder, ThrowableHandler defaultThrowableHandler, ErrorDocumentBehaviour errorDocumentBehaviour, boolean resumeEnabled, AsyncHttpClient ahc, SimpleAHCTransferListener listener) { - this.config = config; - this.requestBuilder = requestBuilder; - this.defaultThrowableHandler = defaultThrowableHandler; - this.resumeEnabled = resumeEnabled; - this.errorDocumentBehaviour = errorDocumentBehaviour; - this.asyncHttpClient = ahc; - this.listener = listener; - - this.derived = ahc != null; - } - - public Future post(Part... parts) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - - for (Part part : parts) { - r.addBodyPart(part); - } - - return execute(r, null, null); - } - - public Future post(BodyConsumer consumer, Part... parts) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - - for (Part part : parts) { - r.addBodyPart(part); - } - - return execute(r, consumer, null); - } - - public Future post(BodyGenerator bodyGenerator) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - r.setBody(bodyGenerator); - return execute(r, null, null); - } - - public Future post(BodyGenerator bodyGenerator, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - r.setBody(bodyGenerator); - return execute(r, null, throwableHandler); - } - - public Future post(BodyGenerator bodyGenerator, BodyConsumer bodyConsumer) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - r.setBody(bodyGenerator); - return execute(r, bodyConsumer, null); - } - - public Future post(BodyGenerator bodyGenerator, BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - r.setBody(bodyGenerator); - return execute(r, bodyConsumer, throwableHandler); - } - - public Future put(Part... parts) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - - for (Part part : parts) { - r.addBodyPart(part); - } - - return execute(r, null, null); - } - - public Future put(BodyConsumer consumer, Part... parts) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("POST"); - - for (Part part : parts) { - r.addBodyPart(part); - } - - return execute(r, consumer, null); - } - - public Future put(BodyGenerator bodyGenerator, BodyConsumer bodyConsumer) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("PUT"); - r.setBody(bodyGenerator); - return execute(r, bodyConsumer, null); - } - - public Future put(BodyGenerator bodyGenerator, BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("PUT"); - r.setBody(bodyGenerator); - return execute(r, bodyConsumer, throwableHandler); - } - - public Future put(BodyGenerator bodyGenerator) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("PUT"); - r.setBody(bodyGenerator); - return execute(r, null, null); - } - - public Future put(BodyGenerator bodyGenerator, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("PUT"); - r.setBody(bodyGenerator); - return execute(r, null, throwableHandler); - } - - public Future get() throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - return execute(r, null, null); - } - - public Future get(ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - return execute(r, null, throwableHandler); - } - - public Future get(BodyConsumer bodyConsumer) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - return execute(r, bodyConsumer, null); - } - - public Future get(BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - return execute(r, bodyConsumer, throwableHandler); - } - - public Future delete() throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("DELETE"); - return execute(r, null, null); - } - - public Future delete(ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("DELETE"); - return execute(r, null, throwableHandler); - } - - public Future delete(BodyConsumer bodyConsumer) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("DELETE"); - return execute(r, bodyConsumer, null); - } - - public Future delete(BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("DELETE"); - return execute(r, bodyConsumer, throwableHandler); - } - - public Future head() throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("HEAD"); - return execute(r, null, null); - } - - public Future head(ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("HEAD"); - return execute(r, null, throwableHandler); - } - - public Future options() throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("OPTIONS"); - return execute(r, null, null); - } - - public Future options(ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("OPTIONS"); - return execute(r, null, throwableHandler); - } - - public Future options(BodyConsumer bodyConsumer) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("OPTIONS"); - return execute(r, bodyConsumer, null); - } - - public Future options(BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - RequestBuilder r = rebuildRequest(requestBuilder.build()); - r.setMethod("OPTIONS"); - return execute(r, bodyConsumer, throwableHandler); - } - - private RequestBuilder rebuildRequest(Request rb) { - return new RequestBuilder(rb); - } - - private Future execute(RequestBuilder rb, BodyConsumer bodyConsumer, ThrowableHandler throwableHandler) throws IOException { - if (throwableHandler == null) { - throwableHandler = defaultThrowableHandler; - } - - Request request = rb.build(); - ProgressAsyncHandler handler = new BodyConsumerAsyncHandler(bodyConsumer, throwableHandler, errorDocumentBehaviour, request.getUrl(), listener); - - if (resumeEnabled && request.getMethod().equals("GET") && - bodyConsumer != null && bodyConsumer instanceof ResumableBodyConsumer) { - ResumableBodyConsumer fileBodyConsumer = (ResumableBodyConsumer) bodyConsumer; - long length = fileBodyConsumer.getTransferredBytes(); - fileBodyConsumer.resume(); - handler = new ResumableBodyConsumerAsyncHandler(length, handler); - } - - return asyncHttpClient().executeRequest(request, handler); - } - - private AsyncHttpClient asyncHttpClient() { - synchronized (config) { - if (asyncHttpClient == null) { - asyncHttpClient = new AsyncHttpClient(config); - } - } - return asyncHttpClient; - } - - /** - * Close the underlying AsyncHttpClient for this instance. - *

- * If this instance is derived from another instance, this method does - * nothing as the client instance is managed by the original - * SimpleAsyncHttpClient. - * - * @see #derive() - * @see AsyncHttpClient#close() - */ - public void close() { - if (!derived && asyncHttpClient != null) { - asyncHttpClient.close(); - } - } - - /** - * Returns a Builder for a derived SimpleAsyncHttpClient that uses the same - * instance of {@link AsyncHttpClient} to execute requests. - *

- *

- *

- * The original SimpleAsyncHttpClient is responsible for managing the - * underlying AsyncHttpClient. For the derived instance, {@link #close()} is - * a NOOP. If the original SimpleAsyncHttpClient is closed, all derived - * instances become invalid. - * - * @return a Builder for a derived SimpleAsyncHttpClient that uses the same - * instance of {@link AsyncHttpClient} to execute requests, never - * {@code null}. - */ - public DerivedBuilder derive() { - return new Builder(this); - } - - public enum ErrorDocumentBehaviour { - /** - * Write error documents as usual via - * {@link BodyConsumer#consume(java.nio.ByteBuffer)}. - */ - WRITE, - - /** - * Accumulate error documents in memory but do not consume. - */ - ACCUMULATE, - - /** - * Omit error documents. An error document will neither be available in - * the response nor written via a {@link BodyConsumer}. - */ - OMIT; - } - - /** - * This interface contains possible configuration changes for a derived SimpleAsyncHttpClient. - * - * @see SimpleAsyncHttpClient#derive() - */ - public interface DerivedBuilder { - - DerivedBuilder setFollowRedirects(boolean followRedirects); - - DerivedBuilder setVirtualHost(String virtualHost); - - DerivedBuilder setUrl(String url); - - DerivedBuilder setParameters(FluentStringsMap parameters) throws IllegalArgumentException; - - DerivedBuilder setParameters(Map> parameters) throws IllegalArgumentException; - - DerivedBuilder setHeaders(Map> headers); - - DerivedBuilder setHeaders(FluentCaseInsensitiveStringsMap headers); - - DerivedBuilder setHeader(String name, String value); - - DerivedBuilder addQueryParameter(String name, String value); - - DerivedBuilder addParameter(String key, String value) throws IllegalArgumentException; - - DerivedBuilder addHeader(String name, String value); - - DerivedBuilder addCookie(Cookie cookie); - - DerivedBuilder addBodyPart(Part part) throws IllegalArgumentException; - - DerivedBuilder setResumableDownload(boolean resume); - - SimpleAsyncHttpClient build(); - } - - public final static class Builder implements DerivedBuilder { - - private final RequestBuilder requestBuilder; - private final AsyncHttpClientConfig.Builder configBuilder = new AsyncHttpClientConfig.Builder(); - private Realm.RealmBuilder realmBuilder = null; - private ProxyServer.Protocol proxyProtocol = null; - private String proxyHost = null; - private String proxyPrincipal = null; - private String proxyPassword = null; - private int proxyPort = 80; - private ThrowableHandler defaultThrowableHandler = null; - private boolean enableResumableDownload = false; - private ErrorDocumentBehaviour errorDocumentBehaviour = ErrorDocumentBehaviour.WRITE; - private AsyncHttpClient ahc = null; - private SimpleAHCTransferListener listener = null; - - public Builder() { - requestBuilder = new RequestBuilder("GET", false); - } - - private Builder(SimpleAsyncHttpClient client) { - this.requestBuilder = new RequestBuilder(client.requestBuilder.build()); - this.defaultThrowableHandler = client.defaultThrowableHandler; - this.errorDocumentBehaviour = client.errorDocumentBehaviour; - this.enableResumableDownload = client.resumeEnabled; - this.ahc = client.asyncHttpClient(); - this.listener = client.listener; - } - - public Builder addBodyPart(Part part) throws IllegalArgumentException { - requestBuilder.addBodyPart(part); - return this; - } - - public Builder addCookie(Cookie cookie) { - requestBuilder.addCookie(cookie); - return this; - } - - public Builder addHeader(String name, String value) { - requestBuilder.addHeader(name, value); - return this; - } - - public Builder addParameter(String key, String value) throws IllegalArgumentException { - requestBuilder.addParameter(key, value); - return this; - } - - public Builder addQueryParameter(String name, String value) { - requestBuilder.addQueryParameter(name, value); - return this; - } - - public Builder setHeader(String name, String value) { - requestBuilder.setHeader(name, value); - return this; - } - - public Builder setHeaders(FluentCaseInsensitiveStringsMap headers) { - requestBuilder.setHeaders(headers); - return this; - } - - public Builder setHeaders(Map> headers) { - requestBuilder.setHeaders(headers); - return this; - } - - public Builder setParameters(Map> parameters) throws IllegalArgumentException { - requestBuilder.setParameters(parameters); - return this; - } - - public Builder setParameters(FluentStringsMap parameters) throws IllegalArgumentException { - requestBuilder.setParameters(parameters); - return this; - } - - public Builder setUrl(String url) { - requestBuilder.setUrl(url); - return this; - } - - public Builder setVirtualHost(String virtualHost) { - requestBuilder.setVirtualHost(virtualHost); - return this; - } - - public Builder setFollowRedirects(boolean followRedirects) { - requestBuilder.setFollowRedirects(followRedirects); - return this; - } - - public Builder setMaximumConnectionsTotal(int defaultMaxTotalConnections) { - configBuilder.setMaximumConnectionsTotal(defaultMaxTotalConnections); - return this; - } - - public Builder setMaximumConnectionsPerHost(int defaultMaxConnectionPerHost) { - configBuilder.setMaximumConnectionsPerHost(defaultMaxConnectionPerHost); - return this; - } - - public Builder setConnectionTimeoutInMs(int connectionTimeuot) { - configBuilder.setConnectionTimeoutInMs(connectionTimeuot); - return this; - } - - public Builder setIdleConnectionInPoolTimeoutInMs(int defaultIdleConnectionInPoolTimeoutInMs) { - configBuilder.setIdleConnectionInPoolTimeoutInMs(defaultIdleConnectionInPoolTimeoutInMs); - return this; - } - - public Builder setRequestTimeoutInMs(int defaultRequestTimeoutInMs) { - configBuilder.setRequestTimeoutInMs(defaultRequestTimeoutInMs); - return this; - } - - public Builder setMaximumNumberOfRedirects(int maxDefaultRedirects) { - configBuilder.setMaximumNumberOfRedirects(maxDefaultRedirects); - return this; - } - - public Builder setCompressionEnabled(boolean compressionEnabled) { - configBuilder.setCompressionEnabled(compressionEnabled); - return this; - } - - public Builder setUserAgent(String userAgent) { - configBuilder.setUserAgent(userAgent); - return this; - } - - public Builder setAllowPoolingConnection(boolean allowPoolingConnection) { - configBuilder.setAllowPoolingConnection(allowPoolingConnection); - return this; - } - - public Builder setScheduledExecutorService(ScheduledExecutorService reaper) { - configBuilder.setScheduledExecutorService(reaper); - return this; - } - - public Builder setExecutorService(ExecutorService applicationThreadPool) { - configBuilder.setExecutorService(applicationThreadPool); - return this; - } - - public Builder setSSLEngineFactory(SSLEngineFactory sslEngineFactory) { - configBuilder.setSSLEngineFactory(sslEngineFactory); - return this; - } - - public Builder setSSLContext(final SSLContext sslContext) { - configBuilder.setSSLContext(sslContext); - return this; - } - - public Builder setRequestCompressionLevel(int requestCompressionLevel) { - configBuilder.setRequestCompressionLevel(requestCompressionLevel); - return this; - } - - public Builder setRealmDomain(String domain) { - realm().setDomain(domain); - return this; - } - - public Builder setRealmPrincipal(String principal) { - realm().setPrincipal(principal); - return this; - } - - public Builder setRealmPassword(String password) { - realm().setPassword(password); - return this; - } - - public Builder setRealmScheme(Realm.AuthScheme scheme) { - realm().setScheme(scheme); - return this; - } - - public Builder setRealmName(String realmName) { - realm().setRealmName(realmName); - return this; - } - - public Builder setRealmUsePreemptiveAuth(boolean usePreemptiveAuth) { - realm().setUsePreemptiveAuth(usePreemptiveAuth); - return this; - } - - public Builder setRealmEnconding(String enc) { - realm().setEnconding(enc); - return this; - } - - public Builder setProxyProtocol(ProxyServer.Protocol protocol) { - this.proxyProtocol = protocol; - return this; - } - - public Builder setProxyHost(String host) { - this.proxyHost = host; - return this; - } - - public Builder setProxyPrincipal(String principal) { - this.proxyPrincipal = principal; - return this; - } - - public Builder setProxyPassword(String password) { - this.proxyPassword = password; - return this; - } - - public Builder setProxyPort(int port) { - this.proxyPort = port; - return this; - } - - public Builder setDefaultThrowableHandler(ThrowableHandler throwableHandler) { - this.defaultThrowableHandler = throwableHandler; - return this; - } - - /** - * This setting controls whether an error document should be written via - * the {@link BodyConsumer} after an error status code was received (e.g. - * 404). Default is {@link ErrorDocumentBehaviour#WRITE}. - */ - public Builder setErrorDocumentBehaviour(ErrorDocumentBehaviour behaviour) { - this.errorDocumentBehaviour = behaviour; - return this; - } - - /** - * Enable resumable downloads for the SimpleAHC. Resuming downloads will only work for GET requests - * with an instance of {@link ResumableBodyConsumer}. - */ - public Builder setResumableDownload(boolean enableResumableDownload) { - this.enableResumableDownload = enableResumableDownload; - return this; - } - - private Realm.RealmBuilder realm() { - if (realmBuilder == null) { - realmBuilder = new Realm.RealmBuilder(); - } - return realmBuilder; - } - - /** - * Set the listener to notify about connection progress. - */ - public Builder setListener(SimpleAHCTransferListener listener) { - this.listener = listener; - return this; - } - - /** - * Set the number of time a request will be retried when an {@link java.io.IOException} occurs because of a Network exception. - * - * @param maxRequestRetry the number of time a request will be retried - * @return this - */ - public Builder setMaxRequestRetry(int maxRequestRetry) { - configBuilder.setMaxRequestRetry(maxRequestRetry); - return this; - } - - public SimpleAsyncHttpClient build() { - - if (realmBuilder != null) { - configBuilder.setRealm(realmBuilder.build()); - } - - if (proxyHost != null) { - configBuilder.setProxyServer(new ProxyServer(proxyProtocol, proxyHost, proxyPort, proxyPrincipal, proxyPassword)); - } - - configBuilder.addIOExceptionFilter(new ResumableIOExceptionFilter()); - - SimpleAsyncHttpClient sc = new SimpleAsyncHttpClient(configBuilder.build(), requestBuilder, defaultThrowableHandler, errorDocumentBehaviour, enableResumableDownload, ahc, listener); - - return sc; - } - } - - private final static class ResumableBodyConsumerAsyncHandler - extends ResumableAsyncHandler - implements ProgressAsyncHandler { - - private final ProgressAsyncHandler delegate; - - public ResumableBodyConsumerAsyncHandler(long byteTransferred, ProgressAsyncHandler delegate) { - super(byteTransferred, delegate); - this.delegate = delegate; - } - - public com.ning.http.client.AsyncHandler.STATE onHeaderWriteCompleted() { - return delegate.onHeaderWriteCompleted(); - } - - public com.ning.http.client.AsyncHandler.STATE onContentWriteCompleted() { - return delegate.onContentWriteCompleted(); - } - - public com.ning.http.client.AsyncHandler.STATE onContentWriteProgress(long amount, long current, long total) { - return delegate.onContentWriteProgress(amount, current, total); - } - } - - private final static class BodyConsumerAsyncHandler extends AsyncCompletionHandlerBase { - - private final BodyConsumer bodyConsumer; - private final ThrowableHandler exceptionHandler; - private final ErrorDocumentBehaviour errorDocumentBehaviour; - private final String url; - private final SimpleAHCTransferListener listener; - - private boolean accumulateBody = false; - private boolean omitBody = false; - private int amount = 0; - private long total = -1; - - public BodyConsumerAsyncHandler(BodyConsumer bodyConsumer, ThrowableHandler exceptionHandler, ErrorDocumentBehaviour errorDocumentBehaviour, String url, SimpleAHCTransferListener listener) { - this.bodyConsumer = bodyConsumer; - this.exceptionHandler = exceptionHandler; - this.errorDocumentBehaviour = errorDocumentBehaviour; - this.url = url; - this.listener = listener; - } - - @Override - public void onThrowable(Throwable t) { - try { - if (exceptionHandler != null) { - exceptionHandler.onThrowable(t); - } else { - super.onThrowable(t); - } - } finally { - closeConsumer(); - } - } - - /** - * {@inheritDoc} - */ - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - fireReceived(content); - if (omitBody) { - return STATE.CONTINUE; - } - - if (!accumulateBody && bodyConsumer != null) { - bodyConsumer.consume(content.getBodyByteBuffer()); - } else { - return super.onBodyPartReceived(content); - } - return STATE.CONTINUE; - } - - - /** - * {@inheritDoc} - */ - @Override - public Response onCompleted(Response response) throws Exception { - fireCompleted(response); - closeConsumer(); - return super.onCompleted(response); - } - - private void closeConsumer() { - try { - if (bodyConsumer != null) { - bodyConsumer.close(); - } - } catch (IOException ex) { - logger.warn("Unable to close a BodyConsumer {}", bodyConsumer); - } - } - - @Override - public STATE onStatusReceived(HttpResponseStatus status) - throws Exception { - fireStatus(status); - - if (isErrorStatus(status)) { - switch (errorDocumentBehaviour) { - case ACCUMULATE: - accumulateBody = true; - break; - case OMIT: - omitBody = true; - break; - default: - break; - } - } - return super.onStatusReceived(status); - } - - private boolean isErrorStatus(HttpResponseStatus status) { - return status.getStatusCode() >= 400; - } - - @Override - public STATE onHeadersReceived(HttpResponseHeaders headers) - throws Exception { - calculateTotal(headers); - - fireHeaders(headers); - - return super.onHeadersReceived(headers); - } - - private void calculateTotal(HttpResponseHeaders headers) { - String length = headers.getHeaders().getFirstValue("Content-Length"); - - try { - total = Integer.valueOf(length); - } catch (Exception e) { - total = -1; - } - } - - @Override - public STATE onContentWriteProgress(long amount, long current, long total) { - fireSent(url, amount, current, total); - return super.onContentWriteProgress(amount, current, total); - } - - private void fireStatus(HttpResponseStatus status) { - if (listener != null) { - listener.onStatus(url, status.getStatusCode(), status.getStatusText()); - } - } - - private void fireReceived(HttpResponseBodyPart content) { - int remaining = content.getBodyByteBuffer().remaining(); - - amount += remaining; - - if (listener != null) { - listener.onBytesReceived(url, amount, remaining, total); - } - } - - private void fireHeaders(HttpResponseHeaders headers) { - if (listener != null) { - listener.onHeaders(url, new HeaderMap(headers.getHeaders())); - } - } - - private void fireSent(String url, long amount, long current, long total) { - if (listener != null) { - listener.onBytesSent(url, amount, current, total); - } - } - - private void fireCompleted(Response response) { - if (listener != null) { - listener.onCompleted(url, response.getStatusCode(), response.getStatusText()); - } - } - } - -} diff --git a/src/main/java/com/ning/http/client/StringPart.java b/src/main/java/com/ning/http/client/StringPart.java deleted file mode 100644 index acdb49b192..0000000000 --- a/src/main/java/com/ning/http/client/StringPart.java +++ /dev/null @@ -1,55 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client; - -/** - * A string multipart part. - */ -public class StringPart implements Part { - private final String name; - private final String value; - private final String charset; - - public StringPart(String name, String value, String charset) { - this.name = name; - this.value = value; - this.charset = charset; - } - - public StringPart(String name, String value) { - this.name = name; - this.value = value; - this.charset = "UTF-8"; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public String getName() { - return name; - } - - public String getValue() { - return value; - } - - public String getCharset() { - return charset; - } - -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/ThrowableHandler.java b/src/main/java/com/ning/http/client/ThrowableHandler.java deleted file mode 100644 index 5f017fd4b7..0000000000 --- a/src/main/java/com/ning/http/client/ThrowableHandler.java +++ /dev/null @@ -1,23 +0,0 @@ -/* -* Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. -* -* This program is licensed to you under the Apache License Version 2.0, -* and you may not use this file except in compliance with the Apache License Version 2.0. -* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the Apache License Version 2.0 is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. -*/ - -package com.ning.http.client; - -/** - * Simple {@link Throwable} handler to be used with {@link SimpleAsyncHttpClient} - */ -public interface ThrowableHandler { - - void onThrowable(Throwable t); - -} diff --git a/src/main/java/com/ning/http/client/UpgradeHandler.java b/src/main/java/com/ning/http/client/UpgradeHandler.java deleted file mode 100644 index 889c4895e1..0000000000 --- a/src/main/java/com/ning/http/client/UpgradeHandler.java +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client; - -/** - * Invoked when an {@link AsyncHandler.STATE#UPGRADE} is returned. Currently the library only support {@link WebSocket} - * as type. - * - * @param - */ -public interface UpgradeHandler { - - /** - * If the HTTP Upgrade succeed (response's status code equals 101), the {@link AsyncHttpProvider} will invoke that - * method - * - * @param t an Upgradable entity - */ - void onSuccess(T t); - - /** - * If the upgrade fail. - * @param t a {@link Throwable} - */ - void onFailure(Throwable t); - -} diff --git a/src/main/java/com/ning/http/client/consumers/AppendableBodyConsumer.java b/src/main/java/com/ning/http/client/consumers/AppendableBodyConsumer.java deleted file mode 100644 index ef04f9b8da..0000000000 --- a/src/main/java/com/ning/http/client/consumers/AppendableBodyConsumer.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.consumers; - -import com.ning.http.client.BodyConsumer; - -import java.io.Closeable; -import java.io.IOException; -import java.nio.ByteBuffer; - -/** - * An {@link Appendable} customer for {@link ByteBuffer} - */ -public class AppendableBodyConsumer implements BodyConsumer { - - private final Appendable appendable; - private final String encoding; - - public AppendableBodyConsumer(Appendable appendable, String encoding) { - this.appendable = appendable; - this.encoding = encoding; - } - - public AppendableBodyConsumer(Appendable appendable) { - this.appendable = appendable; - this.encoding = "UTF-8"; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void consume(ByteBuffer byteBuffer) throws IOException { - appendable.append(new String(byteBuffer.array(), encoding)); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void close() throws IOException { - if (Closeable.class.isAssignableFrom(appendable.getClass())) { - Closeable.class.cast(appendable).close(); - } - } -} diff --git a/src/main/java/com/ning/http/client/consumers/ByteBufferBodyConsumer.java b/src/main/java/com/ning/http/client/consumers/ByteBufferBodyConsumer.java deleted file mode 100644 index e1d07bbaa4..0000000000 --- a/src/main/java/com/ning/http/client/consumers/ByteBufferBodyConsumer.java +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.consumers; - -import com.ning.http.client.BodyConsumer; - -import java.io.IOException; -import java.nio.ByteBuffer; - -/** - * A {@link ByteBuffer} implementation of {@link BodyConsumer} - */ -public class ByteBufferBodyConsumer implements BodyConsumer { - - private final ByteBuffer byteBuffer; - - public ByteBufferBodyConsumer(ByteBuffer byteBuffer) { - this.byteBuffer = byteBuffer; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void consume(ByteBuffer byteBuffer) throws IOException { - byteBuffer.put(byteBuffer); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void close() throws IOException { - byteBuffer.flip(); - } -} diff --git a/src/main/java/com/ning/http/client/consumers/FileBodyConsumer.java b/src/main/java/com/ning/http/client/consumers/FileBodyConsumer.java deleted file mode 100644 index ad8b7e288f..0000000000 --- a/src/main/java/com/ning/http/client/consumers/FileBodyConsumer.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.consumers; - -import com.ning.http.client.ResumableBodyConsumer; - -import java.io.IOException; -import java.io.RandomAccessFile; -import java.nio.ByteBuffer; - -/** - * A {@link RandomAccessFile} that can be used as a {@link ResumableBodyConsumer} - */ -public class FileBodyConsumer implements ResumableBodyConsumer { - - private final RandomAccessFile file; - - public FileBodyConsumer(RandomAccessFile file) { - this.file = file; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void consume(ByteBuffer byteBuffer) throws IOException { - // TODO: Channel.transferFrom may be a good idea to investigate. - file.write(byteBuffer.array()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void close() throws IOException { - file.close(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public long getTransferredBytes() throws IOException { - return file.length(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void resume() throws IOException { - file.seek(getTransferredBytes()); - } -} diff --git a/src/main/java/com/ning/http/client/consumers/OutputStreamBodyConsumer.java b/src/main/java/com/ning/http/client/consumers/OutputStreamBodyConsumer.java deleted file mode 100644 index d1e806ca43..0000000000 --- a/src/main/java/com/ning/http/client/consumers/OutputStreamBodyConsumer.java +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.consumers; - -import com.ning.http.client.BodyConsumer; - -import java.io.IOException; -import java.io.OutputStream; -import java.nio.ByteBuffer; - -/** - * A simple {@link OutputStream} implementation for {@link BodyConsumer} - */ -public class OutputStreamBodyConsumer implements BodyConsumer { - - private final OutputStream outputStream; - - public OutputStreamBodyConsumer(OutputStream outputStream) { - this.outputStream = outputStream; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void consume(ByteBuffer byteBuffer) throws IOException { - outputStream.write(byteBuffer.array()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void close() throws IOException { - outputStream.close(); - } -} diff --git a/src/main/java/com/ning/http/client/extra/ThrottleRequestFilter.java b/src/main/java/com/ning/http/client/extra/ThrottleRequestFilter.java deleted file mode 100644 index 6289d2f284..0000000000 --- a/src/main/java/com/ning/http/client/extra/ThrottleRequestFilter.java +++ /dev/null @@ -1,133 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.extra; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.RequestFilter; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.concurrent.Semaphore; -import java.util.concurrent.TimeUnit; - -/** - * A {@link com.ning.http.client.filter.RequestFilter} throttles requests and block when the number of permits is reached, waiting for - * the response to arrives before executing the next request. - */ -public class ThrottleRequestFilter implements RequestFilter { - private final static Logger logger = LoggerFactory.getLogger(ThrottleRequestFilter.class); - private final int maxConnections; - private final Semaphore available; - private final int maxWait; - - public ThrottleRequestFilter(int maxConnections) { - this.maxConnections = maxConnections; - this.maxWait = Integer.MAX_VALUE; - available = new Semaphore(maxConnections, true); - } - - public ThrottleRequestFilter(int maxConnections, int maxWait) { - this.maxConnections = maxConnections; - this.maxWait = maxWait; - available = new Semaphore(maxConnections, true); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public FilterContext filter(FilterContext ctx) throws FilterException { - - try { - if (logger.isDebugEnabled()) { - logger.debug("Current Throttling Status {}", available.availablePermits()); - } - if (!available.tryAcquire(maxWait, TimeUnit.MILLISECONDS)) { - throw new FilterException( - String.format("No slot available for processing Request %s with AsyncHandler %s", - ctx.getRequest(), ctx.getAsyncHandler())); - } - ; - } catch (InterruptedException e) { - throw new FilterException( - String.format("Interrupted Request %s with AsyncHandler %s", ctx.getRequest(), ctx.getAsyncHandler())); - } - - return new FilterContext.FilterContextBuilder(ctx).asyncHandler(new AsyncHandlerWrapper(ctx.getAsyncHandler())).build(); - } - - private class AsyncHandlerWrapper implements AsyncHandler { - - private final AsyncHandler asyncHandler; - - public AsyncHandlerWrapper(AsyncHandler asyncHandler) { - this.asyncHandler = asyncHandler; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void onThrowable(Throwable t) { - try { - asyncHandler.onThrowable(t); - } finally { - available.release(); - if (logger.isDebugEnabled()) { - logger.debug("Current Throttling Status after onThrowable {}", available.availablePermits()); - } - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - return asyncHandler.onBodyPartReceived(bodyPart); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - return asyncHandler.onStatusReceived(responseStatus); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return asyncHandler.onHeadersReceived(headers); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public T onCompleted() throws Exception { - available.release(); - if (logger.isDebugEnabled()) { - logger.debug("Current Throttling Status {}", available.availablePermits()); - } - return asyncHandler.onCompleted(); - } - } -} diff --git a/src/main/java/com/ning/http/client/filter/FilterException.java b/src/main/java/com/ning/http/client/filter/FilterException.java deleted file mode 100644 index c8e68ee731..0000000000 --- a/src/main/java/com/ning/http/client/filter/FilterException.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.filter; - -/** - * An exception that can be thrown by an {@link com.ning.http.client.AsyncHandler} to interrupt invocation of - * the {@link RequestFilter} and {@link ResponseFilter}. It also interrupt the request and response processing. - */ -public class FilterException extends Exception { - - /** - * @param message - */ - public FilterException(final String message) { - super(message); - } - - /** - * @param message - * @param cause - */ - public FilterException(final String message, final Throwable cause) { - super(message, cause); - } -} diff --git a/src/main/java/com/ning/http/client/generators/FileBodyGenerator.java b/src/main/java/com/ning/http/client/generators/FileBodyGenerator.java deleted file mode 100644 index c1ff9ef88a..0000000000 --- a/src/main/java/com/ning/http/client/generators/FileBodyGenerator.java +++ /dev/null @@ -1,112 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.generators; - -import com.ning.http.client.BodyGenerator; -import com.ning.http.client.RandomAccessBody; - -import java.io.File; -import java.io.IOException; -import java.io.RandomAccessFile; -import java.nio.ByteBuffer; -import java.nio.channels.FileChannel; -import java.nio.channels.WritableByteChannel; - -/** - * Creates a request body from the contents of a file. - */ -public class FileBodyGenerator - implements BodyGenerator { - - private final File file; - private final long regionSeek; - private final long regionLength; - - public FileBodyGenerator(File file) { - if (file == null) { - throw new IllegalArgumentException("no file specified"); - } - this.file = file; - this.regionLength = file.length(); - this.regionSeek = 0; - } - - public FileBodyGenerator(File file, long regionSeek, long regionLength) { - if (file == null) { - throw new IllegalArgumentException("no file specified"); - } - this.file = file; - this.regionLength = regionLength; - this.regionSeek = regionSeek; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public RandomAccessBody createBody() - throws IOException { - return new FileBody(file, regionSeek, regionLength); - } - - protected static class FileBody - implements RandomAccessBody { - - private final RandomAccessFile file; - - private final FileChannel channel; - - private final long length; - - public FileBody(File file) - throws IOException { - this.file = new RandomAccessFile(file, "r"); - channel = this.file.getChannel(); - length = file.length(); - } - - public FileBody(File file, long regionSeek, long regionLength) - throws IOException { - this.file = new RandomAccessFile(file, "r"); - channel = this.file.getChannel(); - length = regionLength; - if (regionSeek > 0) { - this.file.seek(regionSeek); - } - } - - public long getContentLength() { - return length; - } - - public long read(ByteBuffer buffer) - throws IOException { - return channel.read(buffer); - } - - public long transferTo(long position, long count, WritableByteChannel target) - throws IOException { - if (count > length) { - count = length; - } - return channel.transferTo(position, count, target); - } - - public void close() - throws IOException { - file.close(); - } - - } - -} diff --git a/src/main/java/com/ning/http/client/generators/InputStreamBodyGenerator.java b/src/main/java/com/ning/http/client/generators/InputStreamBodyGenerator.java deleted file mode 100644 index 12660ca438..0000000000 --- a/src/main/java/com/ning/http/client/generators/InputStreamBodyGenerator.java +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.generators; - -import com.ning.http.client.Body; -import com.ning.http.client.BodyGenerator; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.io.InputStream; -import java.nio.ByteBuffer; - -/** - * A {@link BodyGenerator} which use an {@link InputStream} for reading bytes, without having to read the entire - * stream in memory. - *

- * NOTE: The {@link InputStream} must support the {@link InputStream#mark} and {@link java.io.InputStream#reset()} operation. - * If not, mechanisms like authentication, redirect, or resumable download will not works. - */ -public class InputStreamBodyGenerator implements BodyGenerator { - - private final static byte[] END_PADDING = "\r\n".getBytes(); - private final static byte[] ZERO = "0".getBytes(); - private final InputStream inputStream; - private final static Logger logger = LoggerFactory.getLogger(InputStreamBodyGenerator.class); - private boolean patchNettyChunkingIssue = false; - - public InputStreamBodyGenerator(InputStream inputStream) { - this.inputStream = inputStream; - - if (inputStream.markSupported()) { - inputStream.mark(0); - } else { - logger.warn("inputStream.markSupported() not supported. Some features will not works"); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public Body createBody() throws IOException { - return new ISBody(); - } - - protected class ISBody implements Body { - private boolean eof = false; - private int endDataCount = 0; - private byte[] chunk; - - public long getContentLength() { - return -1; - } - - public long read(ByteBuffer buffer) throws IOException { - - // To be safe. - chunk = new byte[buffer.remaining() - 10]; - - - int read = -1; - try { - read = inputStream.read(chunk); - } catch (IOException ex) { - logger.warn("Unable to read", ex); - } - - if (patchNettyChunkingIssue) { - if (read == -1) { - // Since we are chuncked, we must output extra bytes before considering the input stream closed. - // chunking requires to end the chunking: - // - A Terminating chunk of "0\r\n".getBytes(), - // - Then a separate packet of "\r\n".getBytes() - if (!eof) { - endDataCount++; - if (endDataCount == 2) - eof = true; - - if (endDataCount == 1) - buffer.put(ZERO); - - buffer.put(END_PADDING); - - - return buffer.position(); - } else { - if (inputStream.markSupported()) { - inputStream.reset(); - } - eof = false; - } - return -1; - } - - /** - * Netty 3.2.3 doesn't support chunking encoding properly, so we chunk encoding ourself. - */ - - buffer.put(Integer.toHexString(read).getBytes()); - // Chunking is separated by "\r\n" - buffer.put(END_PADDING); - buffer.put(chunk, 0, read); - // Was missing the final chunk \r\n. - buffer.put(END_PADDING); - } else { - if (read > 0) { - buffer.put(chunk, 0, read); - } - } - return read; - } - - public void close() throws IOException { - inputStream.close(); - } - } - - /** - * HACK: This is required because Netty has issues with chunking. - * - * @param patchNettyChunkingIssue - */ - public void patchNettyChunkingIssue(boolean patchNettyChunkingIssue) { - this.patchNettyChunkingIssue = patchNettyChunkingIssue; - } -} diff --git a/src/main/java/com/ning/http/client/listenable/AbstractListenableFuture.java b/src/main/java/com/ning/http/client/listenable/AbstractListenableFuture.java deleted file mode 100644 index a0f9575e6a..0000000000 --- a/src/main/java/com/ning/http/client/listenable/AbstractListenableFuture.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -/* - * Copyright (C) 2007 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.ning.http.client.listenable; - -import com.ning.http.client.ListenableFuture; - -import java.util.concurrent.Executor; - -/** - *

An abstract base implementation of the listener support provided by - * {@link ListenableFuture}. This class uses an {@link ExecutionList} to - * guarantee that all registered listeners will be executed. Listener/Executor - * pairs are stored in the execution list and executed in the order in which - * they were added, but because of thread scheduling issues there is no - * guarantee that the JVM will execute them in order. In addition, listeners - * added after the task is complete will be executed immediately, even if some - * previously added listeners have not yet been executed. - * - * @author Sven Mawson - * @since 1 - */ -public abstract class AbstractListenableFuture implements ListenableFuture { - - // The execution list to hold our executors. - private final ExecutionList executionList = new ExecutionList(); - - /* - * Adds a listener/executor pair to execution list to execute when this task - * is completed. - */ - - public ListenableFuture addListener(Runnable listener, Executor exec) { - executionList.add(listener, exec); - return this; - } - - /* - * Override the done method to execute the execution list. - */ - protected void done() { - executionList.run(); - } -} diff --git a/src/main/java/com/ning/http/client/listenable/ExecutionList.java b/src/main/java/com/ning/http/client/listenable/ExecutionList.java deleted file mode 100644 index 84d9bef13a..0000000000 --- a/src/main/java/com/ning/http/client/listenable/ExecutionList.java +++ /dev/null @@ -1,138 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -/* - * Copyright (C) 2007 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.ning.http.client.listenable; - -import java.util.Queue; -import java.util.concurrent.Executor; -import java.util.concurrent.LinkedBlockingQueue; -import java.util.logging.Level; -import java.util.logging.Logger; - -/** - *

A list of ({@code Runnable}, {@code Executor}) pairs that guarantees - * that every {@code Runnable} that is added using the add method will be - * executed in its associated {@code Executor} after {@link #run()} is called. - * {@code Runnable}s added after {@code run} is called are still guaranteed to - * execute. - * - * @author Nishant Thakkar - * @author Sven Mawson - * @since 1 - */ -public final class ExecutionList implements Runnable { - - // Logger to log exceptions caught when running runnables. - private static final Logger log = - Logger.getLogger(ExecutionList.class.getName()); - - // The runnable,executor pairs to execute. - private final Queue runnables = new LinkedBlockingQueue(); - - // Boolean we use mark when execution has started. Only accessed from within - // synchronized blocks. - private boolean executed = false; - - /** - * Add the runnable/executor pair to the list of pairs to execute. Executes - * the pair immediately if we've already started execution. - */ - public void add(Runnable runnable, Executor executor) { - - if (runnable == null) { - throw new NullPointerException("Runnable is null"); - } - - if (executor == null) { - throw new NullPointerException("Executor is null"); - } - - boolean executeImmediate = false; - - // Lock while we check state. We must maintain the lock while adding the - // new pair so that another thread can't run the list out from under us. - // We only add to the list if we have not yet started execution. - synchronized (runnables) { - if (!executed) { - runnables.add(new RunnableExecutorPair(runnable, executor)); - } else { - executeImmediate = true; - } - } - - // Execute the runnable immediately. Because of scheduling this may end up - // getting called before some of the previously added runnables, but we're - // ok with that. If we want to change the contract to guarantee ordering - // among runnables we'd have to modify the logic here to allow it. - if (executeImmediate) { - executor.execute(runnable); - } - } - - /** - * Runs this execution list, executing all pairs in the order they were - * added. Pairs added after this method has started executing the list will - * be executed immediately. - */ - public void run() { - - // Lock while we update our state so the add method above will finish adding - // any listeners before we start to run them. - synchronized (runnables) { - executed = true; - } - - // At this point the runnables will never be modified by another - // thread, so we are safe using it outside of the synchronized block. - while (!runnables.isEmpty()) { - runnables.poll().execute(); - } - } - - private static class RunnableExecutorPair { - final Runnable runnable; - final Executor executor; - - RunnableExecutorPair(Runnable runnable, Executor executor) { - this.runnable = runnable; - this.executor = executor; - } - - void execute() { - try { - executor.execute(runnable); - } catch (RuntimeException e) { - // Log it and keep going, bad runnable and/or executor. Don't - // punish the other runnables if we're given a bad one. We only - // catch RuntimeException because we want Errors to propagate up. - log.log(Level.SEVERE, "RuntimeException while executing runnable " - + runnable + " with executor " + executor, e); - } - } - } -} diff --git a/src/main/java/com/ning/http/client/listener/TransferCompletionHandler.java b/src/main/java/com/ning/http/client/listener/TransferCompletionHandler.java deleted file mode 100644 index 6d71cbd238..0000000000 --- a/src/main/java/com/ning/http/client/listener/TransferCompletionHandler.java +++ /dev/null @@ -1,290 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.listener; - -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.Response; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.nio.ByteBuffer; -import java.util.List; -import java.util.concurrent.ConcurrentLinkedQueue; -import java.util.concurrent.atomic.AtomicLong; - -/** - * A {@link com.ning.http.client.AsyncHandler} that can be used to notify a set of {@link com.ning.http.client.listener.TransferListener} - *

- *

- * AsyncHttpClient client = new AsyncHttpClient();
- * TransferCompletionHandler tl = new TransferCompletionHandler();
- * tl.addTransferListener(new TransferListener() {
- * 

- * public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers) { - * } - *

- * public void onResponseHeadersReceived(FluentCaseInsensitiveStringsMap headers) { - * } - *

- * public void onBytesReceived(ByteBuffer buffer) { - * } - *

- * public void onBytesSent(ByteBuffer buffer) { - * } - *

- * public void onRequestResponseCompleted() { - * } - *

- * public void onThrowable(Throwable t) { - * } - * }); - *

- * Response response = httpClient.prepareGet("http://.../").execute(tl).get(); - *

- */ -public class TransferCompletionHandler extends AsyncCompletionHandlerBase { - private final static Logger logger = LoggerFactory.getLogger(TransferCompletionHandler.class); - private final ConcurrentLinkedQueue listeners = new ConcurrentLinkedQueue(); - private final boolean accumulateResponseBytes; - private TransferAdapter transferAdapter; - private AtomicLong bytesTransferred = new AtomicLong(); - private AtomicLong totalBytesToTransfer = new AtomicLong(0); - - /** - * Create a TransferCompletionHandler that will not accumulate bytes. The resulting {@link com.ning.http.client.Response#getResponseBody()}, - * {@link com.ning.http.client.Response#getResponseBodyAsStream()} and {@link Response#getResponseBodyExcerpt(int)} will - * throw an IllegalStateException if called. - */ - public TransferCompletionHandler() { - this(false); - } - - /** - * Create a TransferCompletionHandler that can or cannot accumulate bytes and make it available when - * {@link com.ning.http.client.Response#getResponseBody()} get called. The default is false. - * - * @param accumulateResponseBytes true to accumulates bytes in memory. - */ - public TransferCompletionHandler(boolean accumulateResponseBytes) { - this.accumulateResponseBytes = accumulateResponseBytes; - } - - /** - * Add a {@link com.ning.http.client.listener.TransferListener} - * - * @param t a {@link com.ning.http.client.listener.TransferListener} - * @return this - */ - public TransferCompletionHandler addTransferListener(TransferListener t) { - listeners.offer(t); - return this; - } - - /** - * Remove a {@link com.ning.http.client.listener.TransferListener} - * - * @param t a {@link com.ning.http.client.listener.TransferListener} - * @return this - */ - public TransferCompletionHandler removeTransferListener(TransferListener t) { - listeners.remove(t); - return this; - } - - /** - * Associate a {@link com.ning.http.client.listener.TransferCompletionHandler.TransferAdapter} with this listener. - * - * @param transferAdapter {@link TransferAdapter} - */ - public void transferAdapter(TransferAdapter transferAdapter) { - this.transferAdapter = transferAdapter; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - fireOnHeaderReceived(headers.getHeaders()); - return super.onHeadersReceived(headers); - } - - @Override - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - STATE s = STATE.CONTINUE; - if (accumulateResponseBytes) { - s = super.onBodyPartReceived(content); - } - fireOnBytesReceived(content.getBodyPartBytes()); - return s; - } - - @Override - public Response onCompleted(Response response) throws Exception { - fireOnEnd(); - return response; - } - - /** - * {@inheritDoc} - */ - public STATE onHeaderWriteCompleted() { - List list = transferAdapter.getHeaders().get("Content-Length"); - if (list != null && list.size() > 0 && list.get(0) != "") { - totalBytesToTransfer.set(Long.valueOf(list.get(0))); - } - - fireOnHeadersSent(transferAdapter.getHeaders()); - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - public STATE onContentWriteCompleted() { - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - public STATE onContentWriteProgress(long amount, long current, long total) { - if (bytesTransferred.get() == -1) { - return STATE.CONTINUE; - } - - if (totalBytesToTransfer.get() == 0) { - totalBytesToTransfer.set(total); - } - - // We need to track the count because all is asynchronous and Netty may not invoke us on time. - bytesTransferred.addAndGet(amount); - - if (transferAdapter != null) { - byte[] bytes = new byte[(int) (amount)]; - transferAdapter.getBytes(bytes); - fireOnBytesSent(bytes); - } - return STATE.CONTINUE; - } - - - @Override - public void onThrowable(Throwable t) { - fireOnThrowable(t); - } - - private void fireOnHeadersSent(FluentCaseInsensitiveStringsMap headers) { - for (TransferListener l : listeners) { - try { - l.onRequestHeadersSent(headers); - } catch (Throwable t) { - l.onThrowable(t); - } - } - } - - private void fireOnHeaderReceived(FluentCaseInsensitiveStringsMap headers) { - for (TransferListener l : listeners) { - try { - l.onResponseHeadersReceived(headers); - } catch (Throwable t) { - l.onThrowable(t); - } - } - } - - private void fireOnEnd() { - // There is a probability that the asynchronous listener never gets called, so we fake it at the end once - // we are 100% sure the response has been received. - long count = bytesTransferred.getAndSet(-1); - if (count != totalBytesToTransfer.get()) { - if (transferAdapter != null) { - byte[] bytes = new byte[8192]; - int leftBytes = (int) (totalBytesToTransfer.get() - count); - int length = 8192; - while (leftBytes > 0) { - if (leftBytes > 8192) { - leftBytes -= 8192; - } else { - length = leftBytes; - leftBytes = 0; - } - - if (length < 8192) { - bytes = new byte[length]; - } - - transferAdapter.getBytes(bytes); - fireOnBytesSent(bytes); - } - } - } - - for (TransferListener l : listeners) { - try { - l.onRequestResponseCompleted(); - } catch (Throwable t) { - l.onThrowable(t); - } - } - } - - private void fireOnBytesReceived(byte[] b) { - for (TransferListener l : listeners) { - try { - l.onBytesReceived(ByteBuffer.wrap(b)); - } catch (Throwable t) { - l.onThrowable(t); - } - } - } - - private void fireOnBytesSent(byte[] b) { - for (TransferListener l : listeners) { - try { - l.onBytesSent(ByteBuffer.wrap(b)); - } catch (Throwable t) { - l.onThrowable(t); - } - } - } - - private void fireOnThrowable(Throwable t) { - for (TransferListener l : listeners) { - try { - l.onThrowable(t); - } catch (Throwable t2) { - logger.warn("onThrowable", t2); - } - } - } - - public abstract static class TransferAdapter { - private final FluentCaseInsensitiveStringsMap headers; - - public TransferAdapter(FluentCaseInsensitiveStringsMap headers) throws IOException { - this.headers = headers; - } - - public FluentCaseInsensitiveStringsMap getHeaders() { - return headers; - } - - public abstract void getBytes(byte[] bytes); - } -} diff --git a/src/main/java/com/ning/http/client/ntlm/NTLMEngine.java b/src/main/java/com/ning/http/client/ntlm/NTLMEngine.java deleted file mode 100644 index a56c9bf141..0000000000 --- a/src/main/java/com/ning/http/client/ntlm/NTLMEngine.java +++ /dev/null @@ -1,1350 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -/* - * ==================================================================== - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * . - * - */ - -package com.ning.http.client.ntlm; - -import com.ning.http.util.Base64; - -import javax.crypto.Cipher; -import javax.crypto.spec.SecretKeySpec; -import java.io.UnsupportedEncodingException; -import java.security.Key; -import java.security.MessageDigest; -import java.util.Arrays; -import java.util.Locale; - -/** - * Provides an implementation for NTLMv1, NTLMv2, and NTLM2 Session forms of the NTLM - * authentication protocol. - * - * @since 4.1 - */ -public class NTLMEngine { - - // Flags we use - protected final static int FLAG_UNICODE_ENCODING = 0x00000001; - protected final static int FLAG_TARGET_DESIRED = 0x00000004; - protected final static int FLAG_NEGOTIATE_SIGN = 0x00000010; - protected final static int FLAG_NEGOTIATE_SEAL = 0x00000020; - protected final static int FLAG_NEGOTIATE_NTLM = 0x00000200; - protected final static int FLAG_NEGOTIATE_ALWAYS_SIGN = 0x00008000; - protected final static int FLAG_NEGOTIATE_NTLM2 = 0x00080000; - protected final static int FLAG_NEGOTIATE_128 = 0x20000000; - protected final static int FLAG_NEGOTIATE_KEY_EXCH = 0x40000000; - - /** - * 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 (Exception ignored) { - } - RND_GEN = rnd; - } - - /** - * Character encoding - */ - static final String DEFAULT_CHARSET = "ASCII"; - - /** - * The character set to use for encoding the credentials - */ - private String credentialCharset = DEFAULT_CHARSET; - - /** - * The signature string as bytes in the default encoding - */ - private static byte[] SIGNATURE; - - static { - byte[] bytesWithoutNull = new byte[0]; - try { - bytesWithoutNull = "NTLMSSP".getBytes("ASCII"); - } catch (UnsupportedEncodingException e) { - e.printStackTrace(); - } - SIGNATURE = new byte[bytesWithoutNull.length + 1]; - System.arraycopy(bytesWithoutNull, 0, SIGNATURE, 0, bytesWithoutNull.length); - SIGNATURE[bytesWithoutNull.length] = (byte) 0x00; - } - - /** - * 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. - * @throws NTLMEngineException If the messages cannot be retrieved. - */ - final String getResponseFor(String message, String username, String password, - String host, String domain) throws NTLMEngineException { - - final String response; - if (message == null || message.trim().equals("")) { - response = getType1Message(host, domain); - } else { - Type2Message t2m = new Type2Message(message); - response = getType3Message(username, password, host, domain, t2m.getChallenge(), t2m - .getFlags(), t2m.getTarget(), t2m.getTargetInfo()); - } - 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. - */ - String getType1Message(String host, String domain) throws NTLMEngineException { - try { - return new Type1Message(domain, host).getResponse(); - } catch (UnsupportedEncodingException e) { - throw new NTLMEngineException("Unsupported encoding", e); - } - } - - /** - * 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 {@encrypt(byte[],byte[])} fails. - */ - String getType3Message(String user, String password, String host, String domain, - byte[] nonce, int type2Flags, String target, byte[] targetInformation) - throws NTLMEngineException { - try { - return new Type3Message(domain, host, user, password, nonce, type2Flags, target, - targetInformation).getResponse(); - } catch (UnsupportedEncodingException e) { - throw new NTLMEngineException("Unsupported encoding", e); - } - } - - /** - * @return Returns the credentialCharset. - */ - String getCredentialCharset() { - return credentialCharset; - } - - /** - * @param credentialCharset The credentialCharset to set. - */ - void setCredentialCharset(String credentialCharset) { - this.credentialCharset = credentialCharset; - } - - /** - * Strip dot suffix from a name - */ - private static String stripDotSuffix(String value) { - int index = value.indexOf("."); - if (index != -1) - return value.substring(0, index); - return value; - } - - /** - * Convert host to standard form - */ - private static String convertHost(String host) { - return stripDotSuffix(host); - } - - /** - * Convert domain to standard form - */ - private static String convertDomain(String domain) { - return stripDotSuffix(domain); - } - - private static int readULong(byte[] src, int index) throws NTLMEngineException { - if (src.length < index + 4) - throw new NTLMEngineException("NTLM authentication - buffer too small for DWORD"); - return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8) - | ((src[index + 2] & 0xff) << 16) | ((src[index + 3] & 0xff) << 24); - } - - private static int readUShort(byte[] src, int index) throws NTLMEngineException { - if (src.length < index + 2) - throw new NTLMEngineException("NTLM authentication - buffer too small for WORD"); - return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8); - } - - private static byte[] readSecurityBuffer(byte[] src, int index) throws NTLMEngineException { - int length = readUShort(src, index); - int offset = readULong(src, index + 4); - if (src.length < offset + length) - throw new NTLMEngineException( - "NTLM authentication - buffer too small for data item"); - byte[] buffer = new byte[length]; - System.arraycopy(src, offset, buffer, 0, length); - return buffer; - } - - /** - * Calculate a challenge block - */ - private static byte[] makeRandomChallenge() throws NTLMEngineException { - if (RND_GEN == null) { - throw new NTLMEngineException("Random generator not available"); - } - byte[] rval = new byte[8]; - synchronized (RND_GEN) { - RND_GEN.nextBytes(rval); - } - return rval; - } - - /** - * Calculate an NTLM2 challenge block - */ - private static byte[] makeNTLM2RandomChallenge() throws NTLMEngineException { - if (RND_GEN == null) { - throw new NTLMEngineException("Random generator not available"); - } - byte[] rval = new byte[24]; - synchronized (RND_GEN) { - RND_GEN.nextBytes(rval); - } - // 8-byte challenge, padded with zeros to 24 bytes. - Arrays.fill(rval, 8, 24, (byte) 0x00); - return rval; - } - - /** - * Calculates the LM Response for the given challenge, using the specified - * password. - * - * @param password The user's password. - * @param challenge The Type 2 challenge from the server. - * @return The LM Response. - */ - static byte[] getLMResponse(String password, byte[] challenge) - throws NTLMEngineException { - byte[] lmHash = lmHash(password); - return lmResponse(lmHash, challenge); - } - - /** - * Calculates the NTLM Response for the given challenge, using the specified - * password. - * - * @param password The user's password. - * @param challenge The Type 2 challenge from the server. - * @return The NTLM Response. - */ - static byte[] getNTLMResponse(String password, byte[] challenge) - throws NTLMEngineException { - byte[] ntlmHash = ntlmHash(password); - return lmResponse(ntlmHash, challenge); - } - - /** - * Calculates the NTLMv2 Response for the given challenge, using the - * specified authentication target, username, password, target information - * block, and client challenge. - * - * @param target The authentication target (i.e., domain). - * @param user The username. - * @param password The user's password. - * @param targetInformation The target information block from the Type 2 message. - * @param challenge The Type 2 challenge from the server. - * @param clientChallenge The random 8-byte client challenge. - * @return The NTLMv2 Response. - */ - static byte[] getNTLMv2Response(String target, String user, String password, - byte[] challenge, byte[] clientChallenge, byte[] targetInformation) - throws NTLMEngineException { - byte[] ntlmv2Hash = ntlmv2Hash(target, user, password); - byte[] blob = createBlob(clientChallenge, targetInformation); - return lmv2Response(ntlmv2Hash, challenge, blob); - } - - /** - * Calculates the LMv2 Response for the given challenge, using the specified - * authentication target, username, password, and client challenge. - * - * @param target The authentication target (i.e., domain). - * @param user The username. - * @param password The user's password. - * @param challenge The Type 2 challenge from the server. - * @param clientChallenge The random 8-byte client challenge. - * @return The LMv2 Response. - */ - static byte[] getLMv2Response(String target, String user, String password, - byte[] challenge, byte[] clientChallenge) throws NTLMEngineException { - byte[] ntlmv2Hash = ntlmv2Hash(target, user, password); - return lmv2Response(ntlmv2Hash, challenge, clientChallenge); - } - - /** - * Calculates the NTLM2 Session Response for the given challenge, using the - * specified password and client challenge. - * - * @param password The user's password. - * @param challenge The Type 2 challenge from the server. - * @param clientChallenge The random 8-byte 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[] getNTLM2SessionResponse(String password, byte[] challenge, - byte[] clientChallenge) throws NTLMEngineException { - try { - byte[] ntlmHash = ntlmHash(password); - - // Look up MD5 algorithm (was necessary on jdk 1.4.2) - // This used to be needed, but java 1.5.0_07 includes the MD5 - // algorithm (finally) - // Class x = Class.forName("gnu.crypto.hash.MD5"); - // Method updateMethod = x.getMethod("update",new - // Class[]{byte[].class}); - // Method digestMethod = x.getMethod("digest",new Class[0]); - // Object mdInstance = x.newInstance(); - // updateMethod.invoke(mdInstance,new Object[]{challenge}); - // updateMethod.invoke(mdInstance,new Object[]{clientChallenge}); - // byte[] digest = (byte[])digestMethod.invoke(mdInstance,new - // Object[0]); - - MessageDigest md5 = MessageDigest.getInstance("MD5"); - md5.update(challenge); - md5.update(clientChallenge); - byte[] digest = md5.digest(); - - byte[] sessionHash = new byte[8]; - System.arraycopy(digest, 0, sessionHash, 0, 8); - return lmResponse(ntlmHash, sessionHash); - } catch (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(String password) throws NTLMEngineException { - try { - byte[] oemPassword = password.toUpperCase(Locale.ENGLISH).getBytes("US-ASCII"); - int length = Math.min(oemPassword.length, 14); - byte[] keyBytes = new byte[14]; - System.arraycopy(oemPassword, 0, keyBytes, 0, length); - Key lowKey = createDESKey(keyBytes, 0); - Key highKey = createDESKey(keyBytes, 7); - byte[] magicConstant = "KGS!@#$%".getBytes("US-ASCII"); - Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); - des.init(Cipher.ENCRYPT_MODE, lowKey); - byte[] lowHash = des.doFinal(magicConstant); - des.init(Cipher.ENCRYPT_MODE, highKey); - byte[] highHash = des.doFinal(magicConstant); - byte[] lmHash = new byte[16]; - System.arraycopy(lowHash, 0, lmHash, 0, 8); - System.arraycopy(highHash, 0, lmHash, 8, 8); - return lmHash; - } catch (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(String password) throws NTLMEngineException { - try { - byte[] unicodePassword = password.getBytes("UnicodeLittleUnmarked"); - MD4 md4 = new MD4(); - md4.update(unicodePassword); - return md4.getOutput(); - } catch (java.io.UnsupportedEncodingException e) { - throw new NTLMEngineException("Unicode not supported: " + e.getMessage(), e); - } - } - - /** - * Creates the NTLMv2 Hash of the user's password. - * - * @param target The authentication target (i.e., domain). - * @param user The username. - * @param password The password. - * @return The NTLMv2 Hash, used in the calculation of the NTLMv2 and LMv2 - * Responses. - */ - private static byte[] ntlmv2Hash(String target, String user, String password) - throws NTLMEngineException { - try { - byte[] ntlmHash = ntlmHash(password); - HMACMD5 hmacMD5 = new HMACMD5(ntlmHash); - // Upper case username, mixed case target!! - hmacMD5.update(user.toUpperCase(Locale.ENGLISH).getBytes("UnicodeLittleUnmarked")); - hmacMD5.update(target.getBytes("UnicodeLittleUnmarked")); - return hmacMD5.getOutput(); - } catch (java.io.UnsupportedEncodingException e) { - throw new NTLMEngineException("Unicode not supported! " + e.getMessage(), e); - } - } - - /** - * 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(byte[] hash, byte[] challenge) throws NTLMEngineException { - try { - byte[] keyBytes = new byte[21]; - System.arraycopy(hash, 0, keyBytes, 0, 16); - Key lowKey = createDESKey(keyBytes, 0); - Key middleKey = createDESKey(keyBytes, 7); - Key highKey = createDESKey(keyBytes, 14); - Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); - des.init(Cipher.ENCRYPT_MODE, lowKey); - byte[] lowResponse = des.doFinal(challenge); - des.init(Cipher.ENCRYPT_MODE, middleKey); - byte[] middleResponse = des.doFinal(challenge); - des.init(Cipher.ENCRYPT_MODE, highKey); - byte[] highResponse = des.doFinal(challenge); - 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 (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(byte[] hash, byte[] challenge, byte[] clientData) - throws NTLMEngineException { - HMACMD5 hmacMD5 = new HMACMD5(hash); - hmacMD5.update(challenge); - hmacMD5.update(clientData); - byte[] mac = hmacMD5.getOutput(); - 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; - } - - /** - * 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(byte[] clientChallenge, byte[] targetInformation) { - byte[] blobSignature = new byte[]{(byte) 0x01, (byte) 0x01, (byte) 0x00, (byte) 0x00}; - byte[] reserved = new byte[]{(byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00}; - byte[] unknown1 = new byte[]{(byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00}; - long time = System.currentTimeMillis(); - time += 11644473600000l; // milliseconds from January 1, 1601 -> epoch. - time *= 10000; // tenths of a microsecond. - // convert to little-endian byte array. - byte[] timestamp = new byte[8]; - for (int i = 0; i < 8; i++) { - timestamp[i] = (byte) time; - time >>>= 8; - } - byte[] blob = new byte[blobSignature.length + reserved.length + timestamp.length + 8 - + unknown1.length + targetInformation.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); - 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(byte[] bytes, int offset) { - byte[] keyBytes = new byte[7]; - System.arraycopy(bytes, offset, keyBytes, 0, 7); - 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(byte[] bytes) { - for (int i = 0; i < bytes.length; i++) { - byte b = bytes[i]; - 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; - } - } - } - - /** - * NTLM message generation, base class - */ - static class NTLMMessage { - /** - * The current response - */ - private byte[] messageContents = null; - - /** - * The current output position - */ - private int currentOutputPosition = 0; - - /** - * Constructor to use when message contents are not yet known - */ - NTLMMessage() { - } - - /** - * Constructor to use when message contents are known - */ - NTLMMessage(String messageBody, int expectedType) throws NTLMEngineException { - messageContents = Base64.decode(messageBody); - - // 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 - int type = readULong(SIGNATURE.length); - if (type != expectedType) - throw new NTLMEngineException("NTLM type " + Integer.toString(expectedType) - + " message expected - instead got type " + Integer.toString(type)); - - currentOutputPosition = messageContents.length; - } - - /** - * Get the length of the signature and flags, so calculations can adjust - * offsets accordingly. - */ - protected int getPreambleLength() { - return SIGNATURE.length + 4; - } - - /** - * Get the message length - */ - protected int getMessageLength() { - return currentOutputPosition; - } - - /** - * Read a byte from a position within the message buffer - */ - protected byte readByte(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 - */ - protected void readBytes(byte[] buffer, 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 - */ - protected int readUShort(int position) throws NTLMEngineException { - return NTLMEngine.readUShort(messageContents, position); - } - - /** - * Read a ulong from a position within the message buffer - */ - protected int readULong(int position) throws NTLMEngineException { - return NTLMEngine.readULong(messageContents, position); - } - - /** - * Read a security buffer from a position within the message buffer - */ - protected byte[] readSecurityBuffer(int position) throws NTLMEngineException { - return NTLMEngine.readSecurityBuffer(messageContents, position); - } - - /** - * Prepares the object to create a response of the given length. - * - * @param maxlength the maximum length of the response to prepare, not - * including the type and the signature (which this method - * adds). - */ - protected void prepareResponse(int maxlength, 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. - */ - protected void addByte(byte b) { - messageContents[currentOutputPosition] = b; - currentOutputPosition++; - } - - /** - * Adds the given bytes to the response. - * - * @param bytes the bytes to add. - */ - protected void addBytes(byte[] bytes) { - for (int i = 0; i < bytes.length; i++) { - messageContents[currentOutputPosition] = bytes[i]; - currentOutputPosition++; - } - } - - /** - * Adds a USHORT to the response - */ - protected void addUShort(int value) { - addByte((byte) (value & 0xff)); - addByte((byte) (value >> 8 & 0xff)); - } - - /** - * Adds a ULong to the response - */ - protected void addULong(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() throws UnsupportedEncodingException { - byte[] resp; - if (messageContents.length > currentOutputPosition) { - byte[] tmp = new byte[currentOutputPosition]; - for (int i = 0; i < currentOutputPosition; i++) { - tmp[i] = messageContents[i]; - } - resp = tmp; - } else { - resp = messageContents; - } - return Base64.encode(resp); - } - - } - - /** - * Type 1 message assembly class - */ - static class Type1Message extends NTLMMessage { - protected byte[] hostBytes; - protected byte[] domainBytes; - - /** - * Constructor. Include the arguments the message will need - */ - Type1Message(String domain, String host) throws NTLMEngineException { - super(); - try { - // Strip off domain name from the host! - host = convertHost(host); - // Use only the base domain name! - domain = convertDomain(domain); - - hostBytes = host.getBytes("UnicodeLittleUnmarked"); - domainBytes = domain.toUpperCase(Locale.ENGLISH).getBytes("UnicodeLittleUnmarked"); - } catch (java.io.UnsupportedEncodingException e) { - throw new NTLMEngineException("Unicode unsupported: " + e.getMessage(), e); - } - } - - /** - * Getting the response involves building the message before returning - * it - */ - @Override - String getResponse() throws UnsupportedEncodingException { - // Now, build the message. Calculate its length first, including - // signature or type. - int finalLength = 32 + hostBytes.length + domainBytes.length; - - // 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(FLAG_NEGOTIATE_NTLM | FLAG_NEGOTIATE_NTLM2 | FLAG_NEGOTIATE_SIGN - | FLAG_NEGOTIATE_SEAL | - /* - * FLAG_NEGOTIATE_ALWAYS_SIGN | FLAG_NEGOTIATE_KEY_EXCH | - */ - FLAG_UNICODE_ENCODING | FLAG_TARGET_DESIRED | FLAG_NEGOTIATE_128); - - // Domain length (two times). - addUShort(domainBytes.length); - addUShort(domainBytes.length); - - // Domain offset. - addULong(hostBytes.length + 32); - - // Host length (two times). - addUShort(hostBytes.length); - addUShort(hostBytes.length); - - // Host offset (always 32). - addULong(32); - - // Host String. - addBytes(hostBytes); - - // Domain String. - addBytes(domainBytes); - - return super.getResponse(); - } - - } - - /** - * Type 2 message class - */ - static class Type2Message extends NTLMMessage { - protected byte[] challenge; - protected String target; - protected byte[] targetInfo; - protected int flags; - - Type2Message(String message) throws NTLMEngineException { - super(message, 2); - - // 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); - if ((flags & FLAG_UNICODE_ENCODING) == 0) - throw new NTLMEngineException( - "NTLM type 2 message has flags that make no sense: " - + Integer.toString(flags)); - // 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) { - byte[] bytes = readSecurityBuffer(12); - if (bytes.length != 0) { - try { - target = new String(bytes, "UnicodeLittleUnmarked"); - } catch (java.io.UnsupportedEncodingException e) { - throw new NTLMEngineException(e.getMessage(), e); - } - } - } - - // Do the target info! - targetInfo = null; - // TARGET_DESIRED flag cannot be relied on, so use packet length - if (getMessageLength() >= 40 + 8) { - 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 { - // Response flags from the type2 message - protected int type2Flags; - - protected byte[] domainBytes; - protected byte[] hostBytes; - protected byte[] userBytes; - - protected byte[] lmResp; - protected byte[] ntResp; - - /** - * Constructor. Pass the arguments we will need - */ - Type3Message(String domain, String host, String user, String password, byte[] nonce, - int type2Flags, String target, byte[] targetInformation) - throws NTLMEngineException { - // Save the flags - this.type2Flags = type2Flags; - - // Strip off domain name from the host! - host = convertHost(host); - // Use only the base domain name! - domain = convertDomain(domain); - - // Use the new code to calculate the responses, including v2 if that - // seems warranted. - try { - if (targetInformation != null && target != null) { - byte[] clientChallenge = makeRandomChallenge(); - ntResp = getNTLMv2Response(target, user, password, nonce, clientChallenge, - targetInformation); - lmResp = getLMv2Response(target, user, password, nonce, clientChallenge); - } else { - if ((type2Flags & FLAG_NEGOTIATE_NTLM2) != 0) { - // NTLM2 session stuff is requested - byte[] clientChallenge = makeNTLM2RandomChallenge(); - - ntResp = getNTLM2SessionResponse(password, nonce, clientChallenge); - lmResp = clientChallenge; - - // All the other flags we send (signing, sealing, key - // exchange) are supported, but they don't do anything - // at all in an - // NTLM2 context! So we're done at this point. - } else { - ntResp = getNTLMResponse(password, nonce); - lmResp = getLMResponse(password, nonce); - } - } - } catch (NTLMEngineException e) { - // This likely means we couldn't find the MD4 hash algorithm - - // fail back to just using LM - ntResp = new byte[0]; - lmResp = getLMResponse(password, nonce); - } - - try { - domainBytes = domain.toUpperCase(Locale.ENGLISH).getBytes("UnicodeLittleUnmarked"); - hostBytes = host.getBytes("UnicodeLittleUnmarked"); - userBytes = user.getBytes("UnicodeLittleUnmarked"); - } catch (java.io.UnsupportedEncodingException e) { - throw new NTLMEngineException("Unicode not supported: " + e.getMessage(), e); - } - } - - /** - * Assemble the response - */ - @Override - String getResponse() throws UnsupportedEncodingException { - int ntRespLen = ntResp.length; - int lmRespLen = lmResp.length; - - int domainLen = domainBytes.length; - int hostLen = hostBytes.length; - int userLen = userBytes.length; - - // Calculate the layout within the packet - int lmRespOffset = 64; - int ntRespOffset = lmRespOffset + lmRespLen; - int domainOffset = ntRespOffset + ntRespLen; - int userOffset = domainOffset + domainLen; - int hostOffset = userOffset + userLen; - int finalLength = hostOffset + hostLen; - - // 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); - - // 4 bytes of zeros - not sure what this is - addULong(0); - - // Message length - addULong(finalLength); - - // Flags. Currently: NEGOTIATE_NTLM + UNICODE_ENCODING + - // TARGET_DESIRED + NEGOTIATE_128 - addULong(FLAG_NEGOTIATE_NTLM | FLAG_UNICODE_ENCODING | FLAG_TARGET_DESIRED - | FLAG_NEGOTIATE_128 | (type2Flags & FLAG_NEGOTIATE_NTLM2) - | (type2Flags & FLAG_NEGOTIATE_SIGN) | (type2Flags & FLAG_NEGOTIATE_SEAL) - | (type2Flags & FLAG_NEGOTIATE_KEY_EXCH) - | (type2Flags & FLAG_NEGOTIATE_ALWAYS_SIGN)); - - // Add the actual data - addBytes(lmResp); - addBytes(ntResp); - addBytes(domainBytes); - addBytes(userBytes); - addBytes(hostBytes); - - return super.getResponse(); - } - } - - static void writeULong(byte[] buffer, int value, 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(int x, int y, int z) { - return ((x & y) | (~x & z)); - } - - static int G(int x, int y, int z) { - return ((x & y) | (x & z) | (y & z)); - } - - static int H(int x, int y, int z) { - return (x ^ y ^ z); - } - - static int rotintlft(int val, int numbits) { - return ((val << numbits) | (val >>> (32 - numbits))); - } - - /** - * 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 { - protected int A = 0x67452301; - protected int B = 0xefcdab89; - protected int C = 0x98badcfe; - protected int D = 0x10325476; - protected long count = 0L; - protected byte[] dataBuffer = new byte[64]; - - MD4() { - } - - void update(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 - 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) { - int transferAmt = input.length - inputIndex; - System.arraycopy(input, inputIndex, dataBuffer, curBufferPos, transferAmt); - count += transferAmt; - } - } - - byte[] getOutput() { - // Feed pad/length data into engine. This must round out the input - // to a multiple of 512 bits. - int bufferIndex = (int) (count & 63L); - int padLen = (bufferIndex < 56) ? (56 - bufferIndex) : (120 - bufferIndex); - 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 - byte[] result = new byte[16]; - writeULong(result, A, 0); - writeULong(result, B, 4); - writeULong(result, C, 8); - writeULong(result, D, 12); - return result; - } - - protected void processBuffer() { - // Convert current buffer to 16 ulongs - 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 - int AA = A; - int BB = B; - int CC = C; - int DD = D; - round1(d); - round2(d); - round3(d); - A += AA; - B += BB; - C += CC; - D += DD; - - } - - protected void round1(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); - } - - protected void round2(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); - - } - - protected void round3(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 { - protected byte[] ipad; - protected byte[] opad; - protected MessageDigest md5; - - HMACMD5(byte[] key) throws NTLMEngineException { - try { - md5 = MessageDigest.getInstance("MD5"); - } catch (Exception ex) { - // Umm, the algorithm doesn't exist - throw an - // NTLMEngineException! - throw new NTLMEngineException( - "Error getting md5 message digest implementation: " + ex.getMessage(), ex); - } - - // 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: update the digest with the ipad buffer - md5.reset(); - md5.update(ipad); - - } - - /** - * Grab the current digest. This is the "answer". - */ - byte[] getOutput() { - byte[] digest = md5.digest(); - md5.update(opad); - return md5.digest(digest); - } - - /** - * Update by adding a complete array - */ - void update(byte[] input) { - md5.update(input); - } - - /** - * Update the algorithm - */ - void update(byte[] input, int offset, int length) { - md5.update(input, offset, length); - } - - } - - public String generateType1Msg( - final String domain, - final String workstation) throws NTLMEngineException { - return getType1Message(workstation, domain); - } - - public String generateType3Msg( - final String username, - final String password, - final String domain, - final String workstation, - final String challenge) throws NTLMEngineException { - Type2Message t2m = new Type2Message(challenge); - return getType3Message( - username, - password, - workstation, - domain, - t2m.getChallenge(), - t2m.getFlags(), - t2m.getTarget(), - t2m.getTargetInfo()); - } - -} diff --git a/src/main/java/com/ning/http/client/oauth/ConsumerKey.java b/src/main/java/com/ning/http/client/oauth/ConsumerKey.java deleted file mode 100644 index 91f846827d..0000000000 --- a/src/main/java/com/ning/http/client/oauth/ConsumerKey.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.oauth; - -/** - * Value class for OAuth consumer keys. - */ -public class ConsumerKey { - private final String key; - private final String secret; - - public ConsumerKey(String key, String secret) { - this.key = key; - this.secret = secret; - } - - public String getKey() { - return key; - } - - public String getSecret() { - return secret; - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder("{Consumer key, key="); - appendValue(sb, key); - sb.append(", secret="); - appendValue(sb, secret); - sb.append("}"); - return sb.toString(); - } - - private void appendValue(StringBuilder sb, String value) { - if (value == null) { - sb.append("null"); - } else { - sb.append('"'); - sb.append(value); - sb.append('"'); - } - } - - @Override - public int hashCode() { - return key.hashCode() + secret.hashCode(); - } - - @Override - public boolean equals(Object o) { - if (o == this) return true; - if (o == null || o.getClass() != getClass()) return false; - ConsumerKey other = (ConsumerKey) o; - return key.equals(other.key) && secret.equals(other.secret); - } -} diff --git a/src/main/java/com/ning/http/client/oauth/OAuthSignatureCalculator.java b/src/main/java/com/ning/http/client/oauth/OAuthSignatureCalculator.java deleted file mode 100644 index e33ad87c73..0000000000 --- a/src/main/java/com/ning/http/client/oauth/OAuthSignatureCalculator.java +++ /dev/null @@ -1,284 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.oauth; - - -import com.ning.http.client.FluentStringsMap; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilderBase; -import com.ning.http.client.SignatureCalculator; -import com.ning.http.util.Base64; -import com.ning.http.util.UTF8Codec; -import com.ning.http.util.UTF8UrlEncoder; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.Map; -import java.util.Random; - -/** - * Simple OAuth signature calculator that can used for constructing client signatures - * for accessing services that use OAuth for authorization. - *

- * Supports most common signature inclusion and calculation methods: HMAC-SHA1 for - * calculation, and Header inclusion as inclusion method. Nonce generation uses - * simple random numbers with base64 encoding. - * - * @author tatu (tatu.saloranta@iki.fi) - */ -public class OAuthSignatureCalculator - implements SignatureCalculator { - public final static String HEADER_AUTHORIZATION = "Authorization"; - - private static final String KEY_OAUTH_CONSUMER_KEY = "oauth_consumer_key"; - private static final String KEY_OAUTH_NONCE = "oauth_nonce"; - private static final String KEY_OAUTH_SIGNATURE = "oauth_signature"; - private static final String KEY_OAUTH_SIGNATURE_METHOD = "oauth_signature_method"; - private static final String KEY_OAUTH_TIMESTAMP = "oauth_timestamp"; - private static final String KEY_OAUTH_TOKEN = "oauth_token"; - private static final String KEY_OAUTH_VERSION = "oauth_version"; - - private static final String OAUTH_VERSION_1_0 = "1.0"; - private static final String OAUTH_SIGNATURE_METHOD = "HMAC-SHA1"; - - /** - * To generate Nonce, need some (pseudo)randomness; no need for - * secure variant here. - */ - protected final Random random; - - protected final byte[] nonceBuffer = new byte[16]; - - protected final ThreadSafeHMAC mac; - - protected final ConsumerKey consumerAuth; - - protected final RequestToken userAuth; - - /** - * @param consumerAuth Consumer key to use for signature calculation - * @param userAuth Request/access token to use for signature calculation - */ - public OAuthSignatureCalculator(ConsumerKey consumerAuth, RequestToken userAuth) { - mac = new ThreadSafeHMAC(consumerAuth, userAuth); - this.consumerAuth = consumerAuth; - this.userAuth = userAuth; - random = new Random(System.identityHashCode(this) + System.currentTimeMillis()); - } - - //@Override // silly 1.5; doesn't allow this for interfaces - - public void calculateAndAddSignature(String baseURL, Request request, RequestBuilderBase requestBuilder) { - String method = request.getMethod(); // POST etc - String nonce = generateNonce(); - long timestamp = System.currentTimeMillis() / 1000L; - String signature = calculateSignature(method, baseURL, timestamp, nonce, request.getParams(), request.getQueryParams()); - String headerValue = constructAuthHeader(signature, nonce, timestamp); - requestBuilder.setHeader(HEADER_AUTHORIZATION, headerValue); - } - - /** - * Method for calculating OAuth signature using HMAC/SHA-1 method. - */ - public String calculateSignature(String method, String baseURL, long oauthTimestamp, String nonce, - FluentStringsMap formParams, FluentStringsMap queryParams) { - StringBuilder signedText = new StringBuilder(100); - signedText.append(method); // POST / GET etc (nothing to URL encode) - signedText.append('&'); - - /* 07-Oct-2010, tatu: URL may contain default port number; if so, need to extract - * from base URL. - */ - if (baseURL.startsWith("http:")) { - int i = baseURL.indexOf(":80/", 4); - if (i > 0) { - baseURL = baseURL.substring(0, i) + baseURL.substring(i + 3); - } - } else if (baseURL.startsWith("https:")) { - int i = baseURL.indexOf(":443/", 5); - if (i > 0) { - baseURL = baseURL.substring(0, i) + baseURL.substring(i + 4); - } - } - signedText.append(UTF8UrlEncoder.encode(baseURL)); - - /** - * List of all query and form parameters added to this request; needed - * for calculating request signature - */ - OAuthParameterSet allParameters = new OAuthParameterSet(); - - // start with standard OAuth parameters we need - allParameters.add(KEY_OAUTH_CONSUMER_KEY, consumerAuth.getKey()); - allParameters.add(KEY_OAUTH_NONCE, nonce); - allParameters.add(KEY_OAUTH_SIGNATURE_METHOD, OAUTH_SIGNATURE_METHOD); - allParameters.add(KEY_OAUTH_TIMESTAMP, String.valueOf(oauthTimestamp)); - allParameters.add(KEY_OAUTH_TOKEN, userAuth.getKey()); - allParameters.add(KEY_OAUTH_VERSION, OAUTH_VERSION_1_0); - - if (formParams != null) { - for (Map.Entry> entry : formParams) { - String key = entry.getKey(); - for (String value : entry.getValue()) { - allParameters.add(key, value); - } - } - } - if (queryParams != null) { - for (Map.Entry> entry : queryParams) { - String key = entry.getKey(); - for (String value : entry.getValue()) { - allParameters.add(key, value); - } - } - } - String encodedParams = allParameters.sortAndConcat(); - - // and all that needs to be URL encoded (... again!) - signedText.append('&'); - UTF8UrlEncoder.appendEncoded(signedText, encodedParams); - - byte[] rawBase = UTF8Codec.toUTF8(signedText.toString()); - byte[] rawSignature = mac.digest(rawBase); - // and finally, base64 encoded... phew! - return Base64.encode(rawSignature); - } - - /** - * Method used for constructing - */ - public String constructAuthHeader(String signature, String nonce, long oauthTimestamp) { - StringBuilder sb = new StringBuilder(200); - sb.append("OAuth "); - sb.append(KEY_OAUTH_CONSUMER_KEY).append("=\"").append(consumerAuth.getKey()).append("\", "); - sb.append(KEY_OAUTH_TOKEN).append("=\"").append(userAuth.getKey()).append("\", "); - sb.append(KEY_OAUTH_SIGNATURE_METHOD).append("=\"").append(OAUTH_SIGNATURE_METHOD).append("\", "); - - // careful: base64 has chars that need URL encoding: - sb.append(KEY_OAUTH_SIGNATURE).append("=\""); - UTF8UrlEncoder.appendEncoded(sb, signature).append("\", "); - sb.append(KEY_OAUTH_TIMESTAMP).append("=\"").append(oauthTimestamp).append("\", "); - - // also: nonce may contain things that need URL encoding (esp. when using base64): - sb.append(KEY_OAUTH_NONCE).append("=\""); - UTF8UrlEncoder.appendEncoded(sb, nonce); - sb.append("\", "); - - sb.append(KEY_OAUTH_VERSION).append("=\"").append(OAUTH_VERSION_1_0).append("\""); - return sb.toString(); - } - - private synchronized String generateNonce() { - random.nextBytes(nonceBuffer); - // let's use base64 encoding over hex, slightly more compact than hex or decimals - return Base64.encode(nonceBuffer); -// return String.valueOf(Math.abs(random.nextLong())); - } - - /** - * Container for parameters used for calculating OAuth signature. - * About the only confusing aspect is that of whether entries are to be sorted - * before encoded or vice versa: if my reading is correct, encoding is to occur - * first, then sorting; although this should rarely matter (since sorting is primary - * by key, which usually has nothing to encode)... of course, rarely means that - * when it would occur it'd be harder to track down. - */ - final static class OAuthParameterSet { - final private ArrayList allParameters = new ArrayList(); - - public OAuthParameterSet() { - } - - public OAuthParameterSet add(String key, String value) { - Parameter p = new Parameter(UTF8UrlEncoder.encode(key), UTF8UrlEncoder.encode(value)); - allParameters.add(p); - return this; - } - - public String sortAndConcat() { - // then sort them (AFTER encoding, important) - Parameter[] params = allParameters.toArray(new Parameter[allParameters.size()]); - Arrays.sort(params); - - // and build parameter section using pre-encoded pieces: - StringBuilder encodedParams = new StringBuilder(100); - for (Parameter param : params) { - if (encodedParams.length() > 0) { - encodedParams.append('&'); - } - encodedParams.append(param.key()).append('=').append(param.value()); - } - return encodedParams.toString(); - } - } - - /** - * Helper class for sorting query and form parameters that we need - */ - final static class Parameter implements Comparable { - private final String key, value; - - public Parameter(String key, String value) { - this.key = key; - this.value = value; - } - - public String key() { - return key; - } - - public String value() { - return value; - } - - //@Override // silly 1.5; doesn't allow this for interfaces - - public int compareTo(Parameter other) { - int diff = key.compareTo(other.key); - if (diff == 0) { - diff = value.compareTo(other.value); - } - return diff; - } - - @Override - public String toString() { - return key + "=" + value; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Parameter parameter = (Parameter) o; - - if (!key.equals(parameter.key)) return false; - if (!value.equals(parameter.value)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = key.hashCode(); - result = 31 * result + value.hashCode(); - return result; - } - } -} diff --git a/src/main/java/com/ning/http/client/oauth/RequestToken.java b/src/main/java/com/ning/http/client/oauth/RequestToken.java deleted file mode 100644 index 8607f8a9ec..0000000000 --- a/src/main/java/com/ning/http/client/oauth/RequestToken.java +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.oauth; - -/** - * Value class used for OAuth tokens (request secret, access secret); - * simple container with two parts, public id part ("key") and - * confidential ("secret") part. - */ -public class RequestToken { - private final String key; - private final String secret; - - public RequestToken(String key, String token) { - this.key = key; - this.secret = token; - } - - public String getKey() { - return key; - } - - public String getSecret() { - return secret; - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder("{ key="); - appendValue(sb, key); - sb.append(", secret="); - appendValue(sb, secret); - sb.append("}"); - return sb.toString(); - } - - private void appendValue(StringBuilder sb, String value) { - if (value == null) { - sb.append("null"); - } else { - sb.append('"'); - sb.append(value); - sb.append('"'); - } - } - - @Override - public int hashCode() { - return key.hashCode() + secret.hashCode(); - } - - @Override - public boolean equals(Object o) { - if (o == this) return true; - if (o == null || o.getClass() != getClass()) return false; - RequestToken other = (RequestToken) o; - return key.equals(other.key) && secret.equals(other.secret); - } -} diff --git a/src/main/java/com/ning/http/client/oauth/ThreadSafeHMAC.java b/src/main/java/com/ning/http/client/oauth/ThreadSafeHMAC.java deleted file mode 100644 index 0157a9df77..0000000000 --- a/src/main/java/com/ning/http/client/oauth/ThreadSafeHMAC.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.oauth; - -import com.ning.http.util.UTF8Codec; - -import javax.crypto.Mac; -import javax.crypto.spec.SecretKeySpec; - -/** - * Since cloning (of MAC instances) is not necessarily supported on all platforms - * (and specifically seems to fail on MacOS), let's wrap synchronization/reuse details here. - * Assumption is that this is bit more efficient (even considering synchronization) - * than locating and reconstructing instance each time. - * In future we may want to use soft references and thread local instance. - * - * @author tatu (tatu.saloranta@iki.fi) - */ -public class ThreadSafeHMAC { - private static final String HMAC_SHA1_ALGORITHM = "HmacSHA1"; - - private final Mac mac; - - public ThreadSafeHMAC(ConsumerKey consumerAuth, RequestToken userAuth) { - byte[] keyBytes = UTF8Codec.toUTF8(consumerAuth.getSecret() + "&" + userAuth.getSecret()); - SecretKeySpec signingKey = new SecretKeySpec(keyBytes, HMAC_SHA1_ALGORITHM); - - // Get an hmac_sha1 instance and initialize with the signing key - try { - mac = Mac.getInstance(HMAC_SHA1_ALGORITHM); - mac.init(signingKey); - } catch (Exception e) { - throw new IllegalArgumentException(e); - } - - } - - public synchronized byte[] digest(byte[] message) { - mac.reset(); - return mac.doFinal(message); - } -} diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProvider.java b/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProvider.java deleted file mode 100644 index b96b66fdf6..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProvider.java +++ /dev/null @@ -1,882 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.Body; -import com.ning.http.client.ByteArrayPart; -import com.ning.http.client.Cookie; -import com.ning.http.client.FilePart; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.MaxRedirectException; -import com.ning.http.client.Part; -import com.ning.http.client.PerRequestConfig; -import com.ning.http.client.ProgressAsyncHandler; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Realm; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.StringPart; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.IOExceptionFilter; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.client.listener.TransferCompletionHandler; -import com.ning.http.client.resumable.ResumableAsyncHandler; -import com.ning.http.util.AsyncHttpProviderUtils; -import com.ning.http.util.ProxyUtils; -import com.ning.http.util.UTF8UrlEncoder; -import org.apache.commons.httpclient.CircularRedirectException; -import org.apache.commons.httpclient.Credentials; -import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler; -import org.apache.commons.httpclient.Header; -import org.apache.commons.httpclient.HttpClient; -import org.apache.commons.httpclient.HttpMethodBase; -import org.apache.commons.httpclient.MultiThreadedHttpConnectionManager; -import org.apache.commons.httpclient.NoHttpResponseException; -import org.apache.commons.httpclient.ProxyHost; -import org.apache.commons.httpclient.UsernamePasswordCredentials; -import org.apache.commons.httpclient.auth.AuthScope; -import org.apache.commons.httpclient.cookie.CookiePolicy; -import org.apache.commons.httpclient.methods.ByteArrayRequestEntity; -import org.apache.commons.httpclient.methods.DeleteMethod; -import org.apache.commons.httpclient.methods.EntityEnclosingMethod; -import org.apache.commons.httpclient.methods.GetMethod; -import org.apache.commons.httpclient.methods.HeadMethod; -import org.apache.commons.httpclient.methods.InputStreamRequestEntity; -import org.apache.commons.httpclient.methods.OptionsMethod; -import org.apache.commons.httpclient.methods.PostMethod; -import org.apache.commons.httpclient.methods.PutMethod; -import org.apache.commons.httpclient.methods.StringRequestEntity; -import org.apache.commons.httpclient.methods.multipart.ByteArrayPartSource; -import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity; -import org.apache.commons.httpclient.methods.multipart.PartSource; -import org.apache.commons.httpclient.params.HttpClientParams; -import org.apache.commons.httpclient.params.HttpConnectionParams; -import org.apache.commons.httpclient.params.HttpMethodParams; -import org.apache.commons.httpclient.protocol.Protocol; -import org.apache.commons.httpclient.protocol.ProtocolSocketFactory; -import org.apache.commons.httpclient.util.IdleConnectionTimeoutThread; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.net.SocketFactory; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLHandshakeException; -import javax.net.ssl.SSLSocketFactory; -import javax.net.ssl.TrustManager; -import javax.net.ssl.X509TrustManager; -import java.io.ByteArrayInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.net.ConnectException; -import java.net.InetAddress; -import java.net.Socket; -import java.net.URI; -import java.net.UnknownHostException; -import java.nio.ByteBuffer; -import java.security.KeyManagementException; -import java.security.NoSuchAlgorithmException; -import java.security.SecureRandom; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; -import java.util.Collection; -import java.util.List; -import java.util.Map; -import java.util.concurrent.Callable; -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.AtomicInteger; -import java.util.zip.GZIPInputStream; - -import static com.ning.http.util.AsyncHttpProviderUtils.DEFAULT_CHARSET; - - -/** - * An {@link com.ning.http.client.AsyncHttpProvider} for Apache Http Client 3.1 - */ -public class ApacheAsyncHttpProvider implements AsyncHttpProvider { - private final static Logger logger = LoggerFactory.getLogger(ApacheAsyncHttpProvider.class); - - private final AsyncHttpClientConfig config; - private final AtomicBoolean isClose = new AtomicBoolean(false); - private IdleConnectionTimeoutThread idleConnectionTimeoutThread; - private final AtomicInteger maxConnections = new AtomicInteger(); - private final MultiThreadedHttpConnectionManager connectionManager; - private final HttpClientParams params; - - static { - final SocketFactory factory = new TrustingSSLSocketFactory(); - Protocol.registerProtocol("https", new Protocol("https", new ProtocolSocketFactory() { - public Socket createSocket(String string, int i, InetAddress inetAddress, int i1) throws IOException { - return factory.createSocket(string, i, inetAddress, i1); - } - - public Socket createSocket(String string, int i, InetAddress inetAddress, int i1, HttpConnectionParams httpConnectionParams) - throws IOException { - return factory.createSocket(string, i, inetAddress, i1); - } - - public Socket createSocket(String string, int i) throws IOException { - return factory.createSocket(string, i); - } - }, 443)); - } - - public ApacheAsyncHttpProvider(AsyncHttpClientConfig config) { - this.config = config; - connectionManager = new MultiThreadedHttpConnectionManager(); - - params = new HttpClientParams(); - params.setParameter(HttpMethodParams.SINGLE_COOKIE_HEADER, Boolean.TRUE); - params.setCookiePolicy(CookiePolicy.BROWSER_COMPATIBILITY); - params.setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler()); - - AsyncHttpProviderConfig providerConfig = config.getAsyncHttpProviderConfig(); - if (providerConfig != null && ApacheAsyncHttpProvider.class.isAssignableFrom(providerConfig.getClass())) { - configure(ApacheAsyncHttpProviderConfig.class.cast(providerConfig)); - } - } - - private void configure(ApacheAsyncHttpProviderConfig config) { - } - - public ListenableFuture execute(Request request, AsyncHandler handler) throws IOException { - if (isClose.get()) { - throw new IOException("Closed"); - } - - if (ResumableAsyncHandler.class.isAssignableFrom(handler.getClass())) { - request = ResumableAsyncHandler.class.cast(handler).adjustRequestRange(request); - } - - if (config.getMaxTotalConnections() > -1 && (maxConnections.get() + 1) > config.getMaxTotalConnections()) { - throw new IOException(String.format("Too many connections %s", config.getMaxTotalConnections())); - } - - if (idleConnectionTimeoutThread != null) { - idleConnectionTimeoutThread.shutdown(); - idleConnectionTimeoutThread = null; - } - - int requestTimeout = requestTimeout(config, request.getPerRequestConfig()); - if (config.getIdleConnectionTimeoutInMs() > 0 && requestTimeout != -1 && requestTimeout < config.getIdleConnectionTimeoutInMs()) { - idleConnectionTimeoutThread = new IdleConnectionTimeoutThread(); - idleConnectionTimeoutThread.setConnectionTimeout(config.getIdleConnectionTimeoutInMs()); - idleConnectionTimeoutThread.addConnectionManager(connectionManager); - idleConnectionTimeoutThread.start(); - } - - HttpClient httpClient = new HttpClient(params, connectionManager); - - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - if (realm != null) { - httpClient.getParams().setAuthenticationPreemptive(realm.getUsePreemptiveAuth()); - Credentials defaultcreds = new UsernamePasswordCredentials(realm.getPrincipal(), realm.getPassword()); - httpClient.getState().setCredentials(new AuthScope(null, -1, AuthScope.ANY_REALM), defaultcreds); - } - - HttpMethodBase method = createMethod(httpClient, request); - ApacheResponseFuture f = new ApacheResponseFuture(handler, requestTimeout, request, method); - f.touch(); - - f.setInnerFuture(config.executorService().submit(new ApacheClientRunnable(request, handler, method, f, httpClient))); - maxConnections.incrementAndGet(); - return f; - } - - public void close() { - if (idleConnectionTimeoutThread != null) { - idleConnectionTimeoutThread.shutdown(); - idleConnectionTimeoutThread = null; - } - if (connectionManager != null) { - try { - connectionManager.shutdown(); - } catch (Exception e) { - logger.error("Error shutting down connection manager", e); - } - } - } - - public Response prepareResponse(HttpResponseStatus status, HttpResponseHeaders headers, Collection bodyParts) { - return new ApacheResponse(status, headers, bodyParts); - } - - private HttpMethodBase createMethod(HttpClient client, Request request) throws IOException, FileNotFoundException { - String methodName = request.getMethod(); - HttpMethodBase method = null; - if (methodName.equalsIgnoreCase("POST") || methodName.equalsIgnoreCase("PUT")) { - EntityEnclosingMethod post = methodName.equalsIgnoreCase("POST") ? new PostMethod(request.getUrl()) : new PutMethod(request.getUrl()); - - String bodyCharset = request.getBodyEncoding() == null ? DEFAULT_CHARSET : request.getBodyEncoding(); - - post.getParams().setContentCharset("ISO-8859-1"); - if (request.getByteData() != null) { - post.setRequestEntity(new ByteArrayRequestEntity(request.getByteData())); - post.setRequestHeader("Content-Length", String.valueOf(request.getByteData().length)); - } else if (request.getStringData() != null) { - post.setRequestEntity(new StringRequestEntity(request.getStringData(), "text/xml", bodyCharset)); - post.setRequestHeader("Content-Length", String.valueOf(request.getStringData().getBytes(bodyCharset).length)); - } else if (request.getStreamData() != null) { - InputStreamRequestEntity r = new InputStreamRequestEntity(request.getStreamData()); - post.setRequestEntity(r); - post.setRequestHeader("Content-Length", String.valueOf(r.getContentLength())); - - } else if (request.getParams() != null) { - StringBuilder sb = new StringBuilder(); - for (final Map.Entry> paramEntry : request.getParams()) { - final String key = paramEntry.getKey(); - for (final String value : paramEntry.getValue()) { - if (sb.length() > 0) { - sb.append("&"); - } - UTF8UrlEncoder.appendEncoded(sb, key); - sb.append("="); - UTF8UrlEncoder.appendEncoded(sb, value); - } - } - - post.setRequestHeader("Content-Length", String.valueOf(sb.length())); - post.setRequestEntity(new StringRequestEntity(sb.toString(), "text/xml", "ISO-8859-1")); - - if (!request.getHeaders().containsKey("Content-Type")) { - post.setRequestHeader("Content-Type", "application/x-www-form-urlencoded"); - } - } else if (request.getParts() != null) { - MultipartRequestEntity mre = createMultipartRequestEntity(bodyCharset, request.getParts(), post.getParams()); - post.setRequestEntity(mre); - post.setRequestHeader("Content-Type", mre.getContentType()); - post.setRequestHeader("Content-Length", String.valueOf(mre.getContentLength())); - } else if (request.getEntityWriter() != null) { - post.setRequestEntity(new EntityWriterRequestEntity(request.getEntityWriter(), computeAndSetContentLength(request, post))); - } else if (request.getFile() != null) { - File file = request.getFile(); - if (!file.isFile()) { - throw new IOException(String.format(Thread.currentThread() - + "File %s is not a file or doesn't exist", file.getAbsolutePath())); - } - post.setRequestHeader("Content-Length", String.valueOf(file.length())); - - FileInputStream fis = new FileInputStream(file); - try { - InputStreamRequestEntity r = new InputStreamRequestEntity(fis); - post.setRequestEntity(r); - post.setRequestHeader("Content-Length", String.valueOf(r.getContentLength())); - } finally { - fis.close(); - } - } else if (request.getBodyGenerator() != null) { - Body body = request.getBodyGenerator().createBody(); - try { - int length = (int) body.getContentLength(); - if (length < 0) { - length = (int) request.getContentLength(); - } - - // TODO: This is suboptimal - if (length >= 0) { - post.setRequestHeader("Content-Length", String.valueOf(length)); - - // This is totally sub optimal - byte[] bytes = new byte[length]; - ByteBuffer buffer = ByteBuffer.wrap(bytes); - for (; ; ) { - buffer.clear(); - if (body.read(buffer) < 0) { - break; - } - } - post.setRequestEntity(new ByteArrayRequestEntity(bytes)); - } - } finally { - try { - body.close(); - } catch (IOException e) { - logger.warn("Failed to close request body: {}", e.getMessage(), e); - } - } - } - - if (request.getHeaders().getFirstValue("Expect") != null - && request.getHeaders().getFirstValue("Expect").equalsIgnoreCase("100-Continue")) { - post.setUseExpectHeader(true); - } - method = post; - } else if (methodName.equalsIgnoreCase("DELETE")) { - method = new DeleteMethod(request.getUrl()); - } else if (methodName.equalsIgnoreCase("HEAD")) { - method = new HeadMethod(request.getUrl()); - } else if (methodName.equalsIgnoreCase("GET")) { - method = new GetMethod(request.getUrl()); - } else if (methodName.equalsIgnoreCase("OPTIONS")) { - method = new OptionsMethod(request.getUrl()); - } else { - throw new IllegalStateException(String.format("Invalid Method", methodName)); - } - - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, request); - if (!avoidProxy) { - - if (proxyServer.getPrincipal() != null) { - Credentials defaultcreds = new UsernamePasswordCredentials(proxyServer.getPrincipal(), proxyServer.getPassword()); - client.getState().setCredentials(new AuthScope(null, -1, AuthScope.ANY_REALM), defaultcreds); - } - - ProxyHost proxyHost = proxyServer == null ? null : new ProxyHost(proxyServer.getHost(), proxyServer.getPort()); - client.getHostConfiguration().setProxyHost(proxyHost); - } - - method.setFollowRedirects(false); - if ((request.getCookies() != null) && !request.getCookies().isEmpty()) { - for (Cookie cookie : request.getCookies()) { - method.setRequestHeader("Cookie", AsyncHttpProviderUtils.encodeCookies(request.getCookies())); - } - } - - if (request.getHeaders() != null) { - for (String name : request.getHeaders().keySet()) { - if (!"host".equalsIgnoreCase(name)) { - for (String value : request.getHeaders().get(name)) { - method.setRequestHeader(name, value); - } - } - } - } - - if (request.getHeaders().getFirstValue("User-Agent") != null) { - method.setRequestHeader("User-Agent", request.getHeaders().getFirstValue("User-Agent")); - } else if (config.getUserAgent() != null) { - method.setRequestHeader("User-Agent", config.getUserAgent()); - } else { - method.setRequestHeader("User-Agent", AsyncHttpProviderUtils.constructUserAgent(ApacheAsyncHttpProvider.class)); - } - - if (config.isCompressionEnabled()) { - Header acceptableEncodingHeader = method.getRequestHeader("Accept-Encoding"); - if (acceptableEncodingHeader != null) { - String acceptableEncodings = acceptableEncodingHeader.getValue(); - if (acceptableEncodings.indexOf("gzip") == -1) { - StringBuilder buf = new StringBuilder(acceptableEncodings); - if (buf.length() > 1) { - buf.append(","); - } - buf.append("gzip"); - method.setRequestHeader("Accept-Encoding", buf.toString()); - } - } else { - method.setRequestHeader("Accept-Encoding", "gzip"); - } - } - - if (request.getVirtualHost() != null) { - - String vs = request.getVirtualHost(); - int index = vs.indexOf(":"); - if (index > 0) { - vs = vs.substring(0, index); - } - method.getParams().setVirtualHost(vs); - } - - return method; - } - - private final static int computeAndSetContentLength(Request request, HttpMethodBase m) { - int lenght = (int) request.getContentLength(); - if (lenght == -1 && m.getRequestHeader("Content-Length") != null) { - lenght = Integer.valueOf(m.getRequestHeader("Content-Length").getValue()); - } - - if (lenght != -1) { - m.setRequestHeader("Content-Length", String.valueOf(lenght)); - } - return lenght; - } - - public class ApacheClientRunnable implements Callable { - - private final AsyncHandler asyncHandler; - private HttpMethodBase method; - private final ApacheResponseFuture future; - private Request request; - private final HttpClient httpClient; - private int currentRedirectCount; - private AtomicBoolean isAuth = new AtomicBoolean(false); - private boolean terminate = true; - - public ApacheClientRunnable(Request request, AsyncHandler asyncHandler, HttpMethodBase method, ApacheResponseFuture future, HttpClient httpClient) { - this.asyncHandler = asyncHandler; - this.method = method; - this.future = future; - this.request = request; - this.httpClient = httpClient; - } - - public T call() { - terminate = true; - AsyncHandler.STATE state = AsyncHandler.STATE.ABORT; - try { - URI uri = null; - try { - uri = AsyncHttpProviderUtils.createUri(request.getRawUrl()); - } catch (IllegalArgumentException u) { - uri = AsyncHttpProviderUtils.createUri(request.getUrl()); - } - - int delay = requestTimeout(config, future.getRequest().getPerRequestConfig()); - if (delay != -1) { - ReaperFuture reaperFuture = new ReaperFuture(future); - Future scheduledFuture = config.reaper().scheduleAtFixedRate(reaperFuture, delay, 500, TimeUnit.MILLISECONDS); - reaperFuture.setScheduledFuture(scheduledFuture); - future.setReaperFuture(reaperFuture); - } - - if (TransferCompletionHandler.class.isAssignableFrom(asyncHandler.getClass())) { - throw new IllegalStateException(TransferCompletionHandler.class.getName() + "not supported by this provider"); - } - - int statusCode = 200; - try { - statusCode = httpClient.executeMethod(method); - } catch (CircularRedirectException ex) { - // Quite ugly, but this is needed to unify - statusCode = 302; - currentRedirectCount = config.getMaxRedirects(); - } - - ApacheResponseStatus status = new ApacheResponseStatus(uri, method, ApacheAsyncHttpProvider.this); - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(asyncHandler).request(request).responseStatus(status).build(); - for (ResponseFilter asyncFilter : config.getResponseFilters()) { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } - - // The request has changed - if (fc.replayRequest()) { - request = fc.getRequest(); - method = createMethod(httpClient, request); - terminate = false; - return call(); - } - - logger.debug("\n\nRequest {}\n\nResponse {}\n", request, method); - - boolean redirectEnabled = (request.isRedirectEnabled() || config.isRedirectEnabled()); - if (redirectEnabled && (statusCode == 302 || statusCode == 301)) { - - isAuth.set(false); - - if (currentRedirectCount++ < config.getMaxRedirects()) { - String location = method.getResponseHeader("Location").getValue(); - URI rediUri = AsyncHttpProviderUtils.getRedirectUri(uri, location); - String newUrl = rediUri.toString(); - - if (!newUrl.equals(uri.toString())) { - RequestBuilder builder = new RequestBuilder(request); - - logger.debug("Redirecting to {}", newUrl); - - request = builder.setUrl(newUrl).build(); - method = createMethod(httpClient, request); - terminate = false; - return call(); - } - } else { - throw new MaxRedirectException("Maximum redirect reached: " + config.getMaxRedirects()); - } - } - - state = asyncHandler.onStatusReceived(status); - if (state == AsyncHandler.STATE.CONTINUE) { - state = asyncHandler.onHeadersReceived(new ApacheResponseHeaders(uri, method, ApacheAsyncHttpProvider.this)); - } - - if (state == AsyncHandler.STATE.CONTINUE) { - InputStream is = method.getResponseBodyAsStream(); - if (is != null) { - Header h = method.getResponseHeader("Content-Encoding"); - if (h != null) { - String contentEncoding = h.getValue(); - boolean isGZipped = contentEncoding == null ? false : "gzip".equalsIgnoreCase(contentEncoding); - if (isGZipped) { - is = new GZIPInputStream(is); - } - } - - int byteToRead = (int) method.getResponseContentLength(); - InputStream stream = is; - if (byteToRead <= 0) { - int[] lengthWrapper = new int[1]; - byte[] bytes = AsyncHttpProviderUtils.readFully(is, lengthWrapper); - stream = new ByteArrayInputStream(bytes, 0, lengthWrapper[0]); - byteToRead = lengthWrapper[0]; - } - - if (byteToRead > 0) { - int minBytes = Math.min(8192, byteToRead); - byte[] bytes = new byte[minBytes]; - int leftBytes = minBytes < 8192 ? minBytes : byteToRead; - int read = 0; - while (leftBytes > -1) { - - try { - read = stream.read(bytes); - } catch (IOException ex) { - logger.warn("Connection closed", ex); - read = -1; - } - - if (read == -1) { - break; - } - - future.touch(); - - byte[] b = new byte[read]; - System.arraycopy(bytes, 0, b, 0, read); - leftBytes -= read; - - asyncHandler.onBodyPartReceived(new ApacheResponseBodyPart(uri, b, ApacheAsyncHttpProvider.this, leftBytes > -1)); - - } - } - } - - if (method.getName().equalsIgnoreCase("HEAD")) { - asyncHandler.onBodyPartReceived(new ApacheResponseBodyPart(uri, "".getBytes(), ApacheAsyncHttpProvider.this, true)); - } - } - - if (ProgressAsyncHandler.class.isAssignableFrom(asyncHandler.getClass())) { - ProgressAsyncHandler.class.cast(asyncHandler).onHeaderWriteCompleted(); - ProgressAsyncHandler.class.cast(asyncHandler).onContentWriteCompleted(); - } - - try { - return asyncHandler.onCompleted(); - } catch (Throwable t) { - RuntimeException ex = new RuntimeException(); - ex.initCause(t); - throw ex; - } - } catch (Throwable t) { - - if (IOException.class.isAssignableFrom(t.getClass()) && config.getIOExceptionFilters().size() > 0) { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(asyncHandler) - .request(future.getRequest()).ioException(IOException.class.cast(t)).build(); - - try { - fc = handleIoException(fc); - } catch (FilterException e) { - if (config.getMaxTotalConnections() != -1) { - maxConnections.decrementAndGet(); - } - future.done(null); - method.releaseConnection(); - } - - if (fc.replayRequest()) { - request = fc.getRequest(); - return call(); - } - } - - if (method.isAborted()) { - return null; - } - - logger.debug(t.getMessage(), t); - - try { - future.abort(filterException(t)); - } catch (Throwable t2) { - logger.error(t2.getMessage(), t2); - } - } finally { - if (terminate) { - if (config.getMaxTotalConnections() != -1) { - maxConnections.decrementAndGet(); - } - future.done(null); - - // Crappy Apache HttpClient who blocks forever here with large files. - config.executorService().submit(new Runnable() { - - public void run() { - method.releaseConnection(); - } - }); - } - } - return null; - } - - private Throwable filterException(Throwable t) { - if (UnknownHostException.class.isAssignableFrom(t.getClass())) { - t = new ConnectException(t.getMessage()); - } - - if (NoHttpResponseException.class.isAssignableFrom(t.getClass())) { - int responseTimeoutInMs = config.getRequestTimeoutInMs(); - - if (request.getPerRequestConfig() != null && request.getPerRequestConfig().getRequestTimeoutInMs() != -1) { - responseTimeoutInMs = request.getPerRequestConfig().getRequestTimeoutInMs(); - } - t = new TimeoutException(String.format("No response received after %s", responseTimeoutInMs)); - } - - if (SSLHandshakeException.class.isAssignableFrom(t.getClass())) { - Throwable t2 = new ConnectException(); - t2.initCause(t); - t = t2; - } - - return t; - } - - private FilterContext handleIoException(FilterContext fc) throws FilterException { - for (IOExceptionFilter asyncFilter : config.getIOExceptionFilters()) { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } - return fc; - } - } - - private MultipartRequestEntity createMultipartRequestEntity(String charset, List params, HttpMethodParams methodParams) throws FileNotFoundException { - org.apache.commons.httpclient.methods.multipart.Part[] parts = new org.apache.commons.httpclient.methods.multipart.Part[params.size()]; - int i = 0; - - for (Part part : params) { - if (part instanceof StringPart) { - parts[i] = new org.apache.commons.httpclient.methods.multipart.StringPart(part.getName(), - ((StringPart) part).getValue(), - charset); - } else if (part instanceof FilePart) { - parts[i] = new org.apache.commons.httpclient.methods.multipart.FilePart(part.getName(), - ((FilePart) part).getFile(), - ((FilePart) part).getMimeType(), - ((FilePart) part).getCharSet()); - - } else if (part instanceof ByteArrayPart) { - PartSource source = new ByteArrayPartSource(((ByteArrayPart) part).getFileName(), ((ByteArrayPart) part).getData()); - parts[i] = new org.apache.commons.httpclient.methods.multipart.FilePart(part.getName(), - source, - ((ByteArrayPart) part).getMimeType(), - ((ByteArrayPart) part).getCharSet()); - - } else if (part == null) { - throw new NullPointerException("Part cannot be null"); - } else { - throw new IllegalArgumentException(String.format("Unsupported part type for multipart parameter %s", - part.getName())); - } - ++i; - } - return new MultipartRequestEntity(parts, methodParams); - } - - public class EntityWriterRequestEntity implements org.apache.commons.httpclient.methods.RequestEntity { - private Request.EntityWriter entityWriter; - private long contentLength; - - public EntityWriterRequestEntity(Request.EntityWriter entityWriter, long contentLength) { - this.entityWriter = entityWriter; - this.contentLength = contentLength; - } - - public long getContentLength() { - return contentLength; - } - - public String getContentType() { - return null; - } - - public boolean isRepeatable() { - return false; - } - - public void writeRequest(OutputStream out) throws IOException { - entityWriter.writeEntity(out); - } - } - - private static class TrustingSSLSocketFactory extends SSLSocketFactory { - private SSLSocketFactory delegate; - - private TrustingSSLSocketFactory() { - try { - SSLContext sslcontext = SSLContext.getInstance("SSL"); - - sslcontext.init(null, new TrustManager[]{new TrustEveryoneTrustManager()}, new SecureRandom()); - delegate = sslcontext.getSocketFactory(); - } catch (KeyManagementException e) { - throw new IllegalStateException(); - } catch (NoSuchAlgorithmException e) { - throw new IllegalStateException(); - } - } - - @Override - public Socket createSocket(String s, int i) throws IOException, UnknownHostException { - return delegate.createSocket(s, i); - } - - @Override - public Socket createSocket(String s, int i, InetAddress inetAddress, int i1) throws IOException, UnknownHostException { - return delegate.createSocket(s, i, inetAddress, i1); - } - - @Override - public Socket createSocket(InetAddress inetAddress, int i) throws IOException { - return delegate.createSocket(inetAddress, i); - } - - @Override - public Socket createSocket(InetAddress inetAddress, int i, InetAddress inetAddress1, int i1) throws IOException { - return delegate.createSocket(inetAddress, i, inetAddress1, i1); - } - - @Override - public String[] getDefaultCipherSuites() { - return delegate.getDefaultCipherSuites(); - } - - @Override - public String[] getSupportedCipherSuites() { - return delegate.getSupportedCipherSuites(); - } - - @Override - public Socket createSocket(Socket socket, String s, int i, boolean b) throws IOException { - return delegate.createSocket(socket, s, i, b); - } - } - - private static class TrustEveryoneTrustManager implements X509TrustManager { - public void checkClientTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException { - // do nothing - } - - public void checkServerTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException { - // do nothing - } - - public X509Certificate[] getAcceptedIssuers() { - return new X509Certificate[0]; - } - } - - private final class ReaperFuture implements Future, Runnable { - private Future scheduledFuture; - private ApacheResponseFuture apacheResponseFuture; - - public ReaperFuture(ApacheResponseFuture apacheResponseFuture) { - this.apacheResponseFuture = apacheResponseFuture; - } - - public void setScheduledFuture(Future scheduledFuture) { - this.scheduledFuture = scheduledFuture; - } - - /** - * @Override - */ - public synchronized boolean cancel(boolean mayInterruptIfRunning) { - //cleanup references to allow gc to reclaim memory independently - //of this Future lifecycle - this.apacheResponseFuture = null; - return this.scheduledFuture.cancel(mayInterruptIfRunning); - } - - /** - * @Override - */ - public Object get() throws InterruptedException, ExecutionException { - return this.scheduledFuture.get(); - } - - /** - * @Override - */ - public Object get(long timeout, TimeUnit unit) - throws InterruptedException, ExecutionException, - TimeoutException { - return this.scheduledFuture.get(timeout, unit); - } - - /** - * @Override - */ - public boolean isCancelled() { - return this.scheduledFuture.isCancelled(); - } - - /** - * @Override - */ - public boolean isDone() { - return this.scheduledFuture.isDone(); - } - - /** - * @Override - */ - public synchronized void run() { - if (this.apacheResponseFuture != null && this.apacheResponseFuture.hasExpired()) { - logger.debug("Request Timeout expired for " + this.apacheResponseFuture); - - int requestTimeout = config.getRequestTimeoutInMs(); - PerRequestConfig p = this.apacheResponseFuture.getRequest().getPerRequestConfig(); - if (p != null && p.getRequestTimeoutInMs() != -1) { - requestTimeout = p.getRequestTimeoutInMs(); - } - apacheResponseFuture.abort(new TimeoutException(String.format("No response received after %s", requestTimeout))); - - this.apacheResponseFuture = null; - } - } - } - - protected static int requestTimeout(AsyncHttpClientConfig config, PerRequestConfig perRequestConfig) { - int result; - if (perRequestConfig != null) { - int prRequestTimeout = perRequestConfig.getRequestTimeoutInMs(); - result = (prRequestTimeout != 0 ? prRequestTimeout : config.getRequestTimeoutInMs()); - } else { - result = config.getRequestTimeoutInMs(); - } - return result; - } -} diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProviderConfig.java b/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProviderConfig.java deleted file mode 100644 index 8b2aee6d07..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProviderConfig.java +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHttpProviderConfig; - -import java.util.Map; -import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; - -public class ApacheAsyncHttpProviderConfig implements AsyncHttpProviderConfig { - - private final ConcurrentHashMap properties = new ConcurrentHashMap(); - - - public AsyncHttpProviderConfig addProperty(String name, String value) { - properties.put(name, value); - return this; - } - - public String getProperty(String name) { - return properties.get(name); - } - - public String removeProperty(String name) { - return properties.remove(name); - } - - public Set> propertiesSet() { - return properties.entrySet(); - } -} diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheResponse.java b/src/main/java/com/ning/http/client/providers/apache/ApacheResponse.java deleted file mode 100644 index b6e63db99d..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheResponse.java +++ /dev/null @@ -1,214 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import com.ning.http.util.AsyncHttpProviderUtils; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; -import java.util.Map; - - -public class ApacheResponse implements Response { - private final static String DEFAULT_CHARSET = "ISO-8859-1"; - private final static String HEADERS_NOT_COMPUTED = "Response's headers hasn't been computed by your AsyncHandler."; - - private final URI uri; - private final Collection bodyParts; - private final HttpResponseHeaders headers; - private final HttpResponseStatus status; - private final List cookies = new ArrayList(); - - public ApacheResponse(HttpResponseStatus status, - HttpResponseHeaders headers, - Collection bodyParts) { - - this.bodyParts = bodyParts; - this.headers = headers; - this.status = status; - - uri = this.status.getUrl(); - } - - /* @Override */ - - public int getStatusCode() { - return status.getStatusCode(); - } - - /* @Override */ - - public String getStatusText() { - return status.getStatusText(); - } - - /* @Override */ - public byte[] getResponseBodyAsBytes() throws IOException { - return AsyncHttpProviderUtils.contentToByte(bodyParts); - } - - /* @Override */ - public String getResponseBody() throws IOException { - return getResponseBody(DEFAULT_CHARSET); - } - - public String getResponseBody(String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - return AsyncHttpProviderUtils.contentToString(bodyParts, charset); - } - - /* @Override */ - public InputStream getResponseBodyAsStream() throws IOException { - if (bodyParts.size() > 0) { - return new ByteArrayInputStream(bodyParts.toArray(new HttpResponseBodyPart[bodyParts.size()])[0].getBodyPartBytes()); - } else { - return new ByteArrayInputStream("".getBytes()); - } - } - - /* @Override */ - - public String getResponseBodyExcerpt(int maxLength) throws IOException { - return getResponseBodyExcerpt(maxLength, DEFAULT_CHARSET); - } - - /* @Override */ - - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - String response = AsyncHttpProviderUtils.contentToString(bodyParts, charset); - return response.length() <= maxLength ? response : response.substring(0, maxLength); - } - - /* @Override */ - - public URI getUri() throws MalformedURLException { - return uri; - } - - /* @Override */ - - public String getContentType() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().getFirstValue("Content-Type"); - } - - /* @Override */ - - public String getHeader(String name) { - if (headers == null) { - throw new IllegalStateException(); - } - return headers.getHeaders().getFirstValue(name); - } - - /* @Override */ - - public List getHeaders(String name) { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().get(name); - } - - /* @Override */ - - public FluentCaseInsensitiveStringsMap getHeaders() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders(); - } - - /* @Override */ - - public boolean isRedirected() { - return (status.getStatusCode() >= 300) && (status.getStatusCode() <= 399); - } - - /* @Override */ - - public List getCookies() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - if (cookies.isEmpty()) { - for (Map.Entry> header : headers.getHeaders().entrySet()) { - if (header.getKey().equalsIgnoreCase("Set-Cookie")) { - // TODO: ask for parsed header - List v = header.getValue(); - for (String value : v) { - Cookie cookie = AsyncHttpProviderUtils.parseCookie(value); - cookies.add(cookie); - } - } - } - } - return Collections.unmodifiableList(cookies); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseStatus() { - return (bodyParts != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseHeaders() { - return (headers != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseBody() { - return (bodyParts != null && bodyParts.size() > 0 ? true : false); - } -} diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseBodyPart.java b/src/main/java/com/ning/http/client/providers/apache/ApacheResponseBodyPart.java deleted file mode 100644 index c66823baeb..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseBodyPart.java +++ /dev/null @@ -1,81 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseBodyPart; - -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.nio.ByteBuffer; - -/** - * A callback class used when an HTTP response body is received. - */ -public class ApacheResponseBodyPart extends HttpResponseBodyPart { - - private final byte[] chunk; - private final boolean isLast; - private boolean closeConnection; - - public ApacheResponseBodyPart(URI uri, byte[] chunk, AsyncHttpProvider provider, boolean last) { - super(uri, provider); - this.chunk = chunk; - isLast = last; - } - - /** - * Return the response body's part bytes received. - * - * @return the response body's part bytes received. - */ - public byte[] getBodyPartBytes() { - return chunk; - } - - @Override - public int writeTo(OutputStream outputStream) throws IOException { - outputStream.write(chunk); - return chunk.length; - } - - @Override - public ByteBuffer getBodyByteBuffer() { - return ByteBuffer.wrap(chunk); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean isLast() { - return isLast; - } - - /** - * {@inheritDoc} - */ - @Override - public void markUnderlyingConnectionAsClosed() { - closeConnection = true; - } - - /** - * {@inheritDoc} - */ - @Override - public boolean closeUnderlyingConnection() { - return closeConnection; - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseFuture.java b/src/main/java/com/ning/http/client/providers/apache/ApacheResponseFuture.java deleted file mode 100644 index 0b8abff3e9..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseFuture.java +++ /dev/null @@ -1,231 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.Request; -import com.ning.http.client.listenable.AbstractListenableFuture; -import org.apache.commons.httpclient.HttpMethodBase; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.concurrent.Callable; -import java.util.concurrent.CancellationException; -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.AtomicLong; -import java.util.concurrent.atomic.AtomicReference; - - -public class ApacheResponseFuture extends AbstractListenableFuture { - - private final static Logger logger = LoggerFactory.getLogger(ApacheResponseFuture.class); - - private Future innerFuture; - private final AsyncHandler asyncHandler; - private final int responseTimeoutInMs; - private final AtomicBoolean cancelled = new AtomicBoolean(false); - private final AtomicBoolean timedOut = new AtomicBoolean(false); - private final AtomicBoolean isDone = new AtomicBoolean(false); - private final AtomicReference exception = new AtomicReference(); - private final AtomicLong touch = new AtomicLong(System.currentTimeMillis()); - private final AtomicBoolean contentProcessed = new AtomicBoolean(false); - private final Request request; - private final HttpMethodBase method; - private Future reaperFuture; - private boolean writeHeaders; - private boolean writeBody; - - public ApacheResponseFuture(AsyncHandler asyncHandler, int responseTimeoutInMs, Request request, HttpMethodBase method) { - this.asyncHandler = asyncHandler; - this.responseTimeoutInMs = responseTimeoutInMs == -1 ? Integer.MAX_VALUE : responseTimeoutInMs; - this.request = request; - this.method = method; - writeHeaders = true; - writeBody = true; - } - - protected void setInnerFuture(Future innerFuture) { - this.innerFuture = innerFuture; - } - - public void done(Callable callable) { - isDone.set(true); - if (reaperFuture != null) { - reaperFuture.cancel(true); - } - super.done(); - } - - /** - * TODO. - * - * @param v The new content - */ - public void content(V v) { - } - - protected void setReaperFuture(Future reaperFuture) { - if (this.reaperFuture != null) { - this.reaperFuture.cancel(true); - } - this.reaperFuture = reaperFuture; - } - - @Override - public String toString() { - return "ApacheResponseFuture{" + - "innerFuture=" + innerFuture + - ", asyncHandler=" + asyncHandler + - ", responseTimeoutInMs=" + responseTimeoutInMs + - ", cancelled=" + cancelled + - ", timedOut=" + timedOut + - ", isDone=" + isDone + - ", exception=" + exception + - ", touch=" + touch + - ", contentProcessed=" + contentProcessed + - ", request=" + request + - ", method=" + method + - ", reaperFuture=" + reaperFuture + - '}'; - } - - public void abort(Throwable t) { - exception.set(t); - if (innerFuture != null) { - innerFuture.cancel(true); - } - - if (method != null) { - method.abort(); - } - - if (reaperFuture != null) { - reaperFuture.cancel(true); - } - if (!timedOut.get() && !cancelled.get()) { - try { - asyncHandler.onThrowable(t); - } catch (Throwable t2) { - logger.debug("asyncHandler.onThrowable", t2); - } - } - super.done(); - } - - public boolean cancel(boolean mayInterruptIfRunning) { - if (!cancelled.get() && innerFuture != null) { - method.abort(); - try { - asyncHandler.onThrowable(new CancellationException()); - } catch (Throwable t) { - logger.debug("asyncHandler.onThrowable", t); - } - cancelled.set(true); - if (reaperFuture != null) { - reaperFuture.cancel(true); - } - super.done(); - return innerFuture.cancel(mayInterruptIfRunning); - } else { - super.done(); - return false; - } - } - - public boolean isCancelled() { - if (innerFuture != null) { - return innerFuture.isCancelled(); - } else { - return false; - } - } - - public boolean isDone() { - contentProcessed.set(true); - return innerFuture.isDone(); - } - - public V get() throws InterruptedException, ExecutionException { - try { - return get(responseTimeoutInMs, TimeUnit.MILLISECONDS); - } catch (TimeoutException e) { - throw new ExecutionException(e); - } - } - - public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { - V content = null; - try { - if (innerFuture != null) { - content = innerFuture.get(timeout, unit); - } - } catch (TimeoutException t) { - if (!contentProcessed.get() && timeout != -1 && ((System.currentTimeMillis() - touch.get()) <= responseTimeoutInMs)) { - return get(timeout, unit); - } - - if (exception.get() == null) { - timedOut.set(true); - throw new ExecutionException(new TimeoutException(String.format("No response received after %s", responseTimeoutInMs))); - } - } catch (CancellationException ce) { - } - - if (exception.get() != null) { - throw new ExecutionException(exception.get()); - } - return content; - } - - /** - * Is the Future still valid - * - * @return true if response has expired and should be terminated. - */ - public boolean hasExpired() { - return responseTimeoutInMs != -1 && ((System.currentTimeMillis() - touch.get()) >= responseTimeoutInMs); - } - - public void touch() { - touch.set(System.currentTimeMillis()); - } - - public Request getRequest() { - return request; - } - - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteHeaders(boolean writeHeaders) { - boolean b = this.writeHeaders; - this.writeHeaders = writeHeaders; - return b; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteBody(boolean writeBody) { - boolean b = this.writeBody; - this.writeBody = writeBody; - return b; - } -} diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseHeaders.java b/src/main/java/com/ning/http/client/providers/apache/ApacheResponseHeaders.java deleted file mode 100644 index 1940f4c971..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseHeaders.java +++ /dev/null @@ -1,67 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseHeaders; -import org.apache.commons.httpclient.Header; -import org.apache.commons.httpclient.HttpMethodBase; - -import java.net.URI; - -/** - * A class that represent the HTTP headers. - */ -public class ApacheResponseHeaders extends HttpResponseHeaders { - - private final HttpMethodBase method; - private final FluentCaseInsensitiveStringsMap headers; - - public ApacheResponseHeaders(URI uri, HttpMethodBase method, AsyncHttpProvider provider) { - super(uri, provider, false); - this.method = method; - headers = computerHeaders(); - } - - private FluentCaseInsensitiveStringsMap computerHeaders() { - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - - Header[] uh = method.getResponseHeaders(); - - for (Header e : uh) { - if (e.getName() != null) { - h.add(e.getName(), e.getValue()); - } - } - - uh = method.getResponseFooters(); - for (Header e : uh) { - if (e.getName() != null) { - h.add(e.getName(), e.getValue()); - } - } - - return h; - } - - /** - * Return the HTTP header - * - * @return an {@link com.ning.http.client.FluentCaseInsensitiveStringsMap} - */ - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return headers; - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseStatus.java b/src/main/java/com/ning/http/client/providers/apache/ApacheResponseStatus.java deleted file mode 100644 index 64702c75a8..0000000000 --- a/src/main/java/com/ning/http/client/providers/apache/ApacheResponseStatus.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.apache; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseStatus; -import org.apache.commons.httpclient.HttpMethodBase; - -import java.net.URI; - -/** - * A class that represent the HTTP response' status line (code + text) - */ -public class ApacheResponseStatus extends HttpResponseStatus { - - private final HttpMethodBase method; - - public ApacheResponseStatus(URI uri, HttpMethodBase method, AsyncHttpProvider provider) { - super(uri, provider); - this.method = method; - } - - /** - * Return the response status code - * - * @return the response status code - */ - public int getStatusCode() { - return method.getStatusCode(); - } - - /** - * Return the response status text - * - * @return the response status text - */ - public String getStatusText() { - return method.getStatusText(); - } - - @Override - public String getProtocolName() { - return method.getStatusLine().getHttpVersion(); - } - - @Override - public int getProtocolMajorVersion() { - return 1; //TODO - } - - @Override - public int getProtocolMinorVersion() { - return 1; //TODO - } - - @Override - public String getProtocolText() { - return ""; //TODO - } - -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/grizzly/FeedableBodyGenerator.java b/src/main/java/com/ning/http/client/providers/grizzly/FeedableBodyGenerator.java deleted file mode 100644 index 4e509964db..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/FeedableBodyGenerator.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.Body; -import com.ning.http.client.BodyGenerator; -import java.io.IOException; -import java.nio.ByteBuffer; -import java.util.Queue; -import java.util.concurrent.ConcurrentLinkedQueue; -import java.util.concurrent.atomic.AtomicInteger; -import org.glassfish.grizzly.Buffer; -import org.glassfish.grizzly.filterchain.FilterChainContext; -import org.glassfish.grizzly.http.HttpContent; -import org.glassfish.grizzly.http.HttpRequestPacket; - -/** - * {@link BodyGenerator} which may return just part of the payload at the time - * handler is requesting it. If it happens - PartialBodyGenerator becomes responsible - * for finishing payload transferring asynchronously. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class FeedableBodyGenerator implements BodyGenerator { - private final Queue queue = new ConcurrentLinkedQueue(); - private final AtomicInteger queueSize = new AtomicInteger(); - - private volatile HttpRequestPacket requestPacket; - private volatile FilterChainContext context; - - @Override - public Body createBody() throws IOException { - return new EmptyBody(); - } - - public void feed(final Buffer buffer, final boolean isLast) - throws IOException { - queue.offer(new BodyPart(buffer, isLast)); - queueSize.incrementAndGet(); - - if (context != null) { - flushQueue(); - } - } - - void initializeAsynchronousTransfer(final FilterChainContext context, - final HttpRequestPacket requestPacket) throws IOException { - this.context = context; - this.requestPacket = requestPacket; - flushQueue(); - } - - private void flushQueue() throws IOException { - if (queueSize.get() > 0) { - synchronized(this) { - while(queueSize.get() > 0) { - final BodyPart bodyPart = queue.poll(); - queueSize.decrementAndGet(); - final HttpContent content = - requestPacket.httpContentBuilder() - .content(bodyPart.buffer) - .last(bodyPart.isLast) - .build(); - context.write(content, ((!requestPacket.isCommitted()) ? - context.getTransportContext().getCompletionHandler() : - null)); - - } - } - } - } - - private final class EmptyBody implements Body { - - @Override - public long getContentLength() { - return -1; - } - - @Override - public long read(final ByteBuffer buffer) throws IOException { - return 0; - } - - @Override - public void close() throws IOException { - context.completeAndRecycle(); - context = null; - requestPacket = null; - } - } - - private final static class BodyPart { - private final boolean isLast; - private final Buffer buffer; - - public BodyPart(final Buffer buffer, final boolean isLast) { - this.buffer = buffer; - this.isLast = isLast; - } - } -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProvider.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProvider.java deleted file mode 100644 index 4b1a655aba..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProvider.java +++ /dev/null @@ -1,2711 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.Body; -import com.ning.http.client.BodyGenerator; -import com.ning.http.client.ConnectionsPool; -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.FluentStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.MaxRedirectException; -import com.ning.http.client.Part; -import com.ning.http.client.PerRequestConfig; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Realm; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.UpgradeHandler; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.client.listener.TransferCompletionHandler; -import com.ning.http.client.websocket.WebSocket; -import com.ning.http.client.websocket.WebSocketByteListener; -import com.ning.http.client.websocket.WebSocketListener; -import com.ning.http.client.websocket.WebSocketPingListener; -import com.ning.http.client.websocket.WebSocketPongListener; -import com.ning.http.client.websocket.WebSocketTextListener; -import com.ning.http.client.websocket.WebSocketUpgradeHandler; -import com.ning.http.multipart.MultipartRequestEntity; -import com.ning.http.util.AsyncHttpProviderUtils; -import com.ning.http.util.AuthenticatorUtils; -import com.ning.http.util.ProxyUtils; -import com.ning.http.util.SslUtils; - -import org.glassfish.grizzly.Buffer; -import org.glassfish.grizzly.CompletionHandler; -import org.glassfish.grizzly.Connection; -import org.glassfish.grizzly.EmptyCompletionHandler; -import org.glassfish.grizzly.FileTransfer; -import org.glassfish.grizzly.Grizzly; -import org.glassfish.grizzly.WriteResult; -import org.glassfish.grizzly.attributes.Attribute; -import org.glassfish.grizzly.attributes.AttributeStorage; -import org.glassfish.grizzly.filterchain.BaseFilter; -import org.glassfish.grizzly.filterchain.FilterChainBuilder; -import org.glassfish.grizzly.filterchain.FilterChainContext; -import org.glassfish.grizzly.filterchain.FilterChainEvent; -import org.glassfish.grizzly.filterchain.NextAction; -import org.glassfish.grizzly.filterchain.TransportFilter; -import org.glassfish.grizzly.http.ContentEncoding; -import org.glassfish.grizzly.http.EncodingFilter; -import org.glassfish.grizzly.http.GZipContentEncoding; -import org.glassfish.grizzly.http.HttpClientFilter; -import org.glassfish.grizzly.http.HttpContent; -import org.glassfish.grizzly.http.HttpHeader; -import org.glassfish.grizzly.http.HttpRequestPacket; -import org.glassfish.grizzly.http.HttpResponsePacket; -import org.glassfish.grizzly.http.Method; -import org.glassfish.grizzly.http.Protocol; -import org.glassfish.grizzly.impl.FutureImpl; -import org.glassfish.grizzly.utils.Charsets; -import org.glassfish.grizzly.http.util.CookieSerializerUtils; -import org.glassfish.grizzly.http.util.DataChunk; -import org.glassfish.grizzly.http.util.Header; -import org.glassfish.grizzly.http.util.HttpStatus; -import org.glassfish.grizzly.http.util.MimeHeaders; -import org.glassfish.grizzly.impl.SafeFutureImpl; -import org.glassfish.grizzly.memory.Buffers; -import org.glassfish.grizzly.memory.MemoryManager; -import org.glassfish.grizzly.nio.transport.TCPNIOConnectorHandler; -import org.glassfish.grizzly.nio.transport.TCPNIOTransport; -import org.glassfish.grizzly.nio.transport.TCPNIOTransportBuilder; -import org.glassfish.grizzly.ssl.SSLEngineConfigurator; -import org.glassfish.grizzly.ssl.SSLFilter; -import org.glassfish.grizzly.strategies.SameThreadIOStrategy; -import org.glassfish.grizzly.strategies.WorkerThreadIOStrategy; -import org.glassfish.grizzly.utils.BufferOutputStream; -import org.glassfish.grizzly.utils.DelayedExecutor; -import org.glassfish.grizzly.utils.Futures; -import org.glassfish.grizzly.utils.IdleTimeoutFilter; -import org.glassfish.grizzly.websockets.DataFrame; -import org.glassfish.grizzly.websockets.DefaultWebSocket; -import org.glassfish.grizzly.websockets.HandShake; -import org.glassfish.grizzly.websockets.ProtocolHandler; -import org.glassfish.grizzly.websockets.Version; -import org.glassfish.grizzly.websockets.WebSocketEngine; -import org.glassfish.grizzly.websockets.WebSocketFilter; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.net.ssl.SSLContext; -import java.io.EOFException; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.UnsupportedEncodingException; -import java.net.InetSocketAddress; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URLEncoder; -import java.security.NoSuchAlgorithmException; -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Semaphore; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.concurrent.atomic.AtomicLong; - -import static com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProviderConfig.Property.TRANSPORT_CUSTOMIZER; - -/** - * A Grizzly 2.0-based implementation of {@link AsyncHttpProvider}. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyAsyncHttpProvider implements AsyncHttpProvider { - - private final static Logger LOGGER = LoggerFactory.getLogger(GrizzlyAsyncHttpProvider.class); - private static final boolean SEND_FILE_SUPPORT; - static { - SEND_FILE_SUPPORT = configSendFileSupport(); - } - private final Attribute REQUEST_STATE_ATTR = - Grizzly.DEFAULT_ATTRIBUTE_BUILDER.createAttribute(HttpTransactionContext.class.getName()); - - private final BodyHandlerFactory bodyHandlerFactory = new BodyHandlerFactory(); - - private final TCPNIOTransport clientTransport; - private final AsyncHttpClientConfig clientConfig; - private final ConnectionManager connectionManager; - - DelayedExecutor.Resolver resolver; - private DelayedExecutor timeoutExecutor; - - - - - // ------------------------------------------------------------ Constructors - - - public GrizzlyAsyncHttpProvider(final AsyncHttpClientConfig clientConfig) { - - this.clientConfig = clientConfig; - final TCPNIOTransportBuilder builder = TCPNIOTransportBuilder.newInstance(); - clientTransport = builder.build(); - initializeTransport(clientConfig); - connectionManager = new ConnectionManager(this, clientTransport); - try { - clientTransport.start(); - } catch (IOException ioe) { - throw new RuntimeException(ioe); - } - - } - - - // ------------------------------------------ Methods from AsyncHttpProvider - - - /** - * {@inheritDoc} - */ - @SuppressWarnings({"unchecked"}) - public ListenableFuture execute(final Request request, - final AsyncHandler handler) throws IOException { - - final GrizzlyResponseFuture future = - new GrizzlyResponseFuture(this, request, handler); - future.setDelegate(SafeFutureImpl.create()); - final CompletionHandler connectHandler = new CompletionHandler() { - @Override - public void cancelled() { - future.cancel(true); - } - - @Override - public void failed(final Throwable throwable) { - future.abort(throwable); - } - - @Override - public void completed(final Connection c) { - try { - execute(c, request, handler, future); - } catch (Exception e) { - if (e instanceof RuntimeException) { - failed(e); - } else if (e instanceof IOException) { - failed(e); - } - if (LOGGER.isWarnEnabled()) { - LOGGER.warn(e.toString(), e); - } - } - } - - @Override - public void updated(final Connection c) { - // no-op - } - }; - - try { - connectionManager.doAsyncTrackedConnection(request, future, connectHandler); - } catch (Exception e) { - if (e instanceof RuntimeException) { - throw (RuntimeException) e; - } else if (e instanceof IOException) { - throw (IOException) e; - } - if (LOGGER.isWarnEnabled()) { - LOGGER.warn(e.toString(), e); - } - } - - return future; - } - - /** - * {@inheritDoc} - */ - public void close() { - - try { - connectionManager.destroy(); - clientTransport.stop(); - final ExecutorService service = clientConfig.executorService(); - if (service != null) { - service.shutdown(); - } - if (timeoutExecutor != null) { - timeoutExecutor.stop(); - } - } catch (IOException ignored) { } - - } - - - /** - * {@inheritDoc} - */ - public Response prepareResponse(HttpResponseStatus status, - HttpResponseHeaders headers, - Collection bodyParts) { - - return new GrizzlyResponse(status, headers, bodyParts); - - } - - - // ------------------------------------------------------- Protected Methods - - - @SuppressWarnings({"unchecked"}) - protected ListenableFuture execute(final Connection c, - final Request request, - final AsyncHandler handler, - final GrizzlyResponseFuture future) - throws IOException { - - try { - if (getHttpTransactionContext(c) == null) { - setHttpTransactionContext(c, - new HttpTransactionContext(future, request, handler)); - } - c.write(request, createWriteCompletionHandler(future)); - } catch (Exception e) { - if (e instanceof RuntimeException) { - throw (RuntimeException) e; - } else if (e instanceof IOException) { - throw (IOException) e; - } - if (LOGGER.isWarnEnabled()) { - LOGGER.warn(e.toString(), e); - } - } - - return future; - } - - - protected void initializeTransport(final AsyncHttpClientConfig clientConfig) { - - final FilterChainBuilder fcb = FilterChainBuilder.stateless(); - fcb.add(new AsyncHttpClientTransportFilter()); - - final int timeout = clientConfig.getRequestTimeoutInMs(); - if (timeout > 0) { - int delay = 500; - if (timeout < delay) { - delay = timeout - 10; - } - timeoutExecutor = IdleTimeoutFilter.createDefaultIdleDelayedExecutor(delay, TimeUnit.MILLISECONDS); - timeoutExecutor.start(); - final IdleTimeoutFilter.TimeoutResolver timeoutResolver = - new IdleTimeoutFilter.TimeoutResolver() { - @Override - public long getTimeout(FilterChainContext ctx) { - final HttpTransactionContext context = - GrizzlyAsyncHttpProvider.this.getHttpTransactionContext(ctx.getConnection()); - if (context != null) { - if (context.isWSRequest) { - return clientConfig.getWebSocketIdleTimeoutInMs(); - } - final PerRequestConfig config = context.request.getPerRequestConfig(); - if (config != null) { - final long timeout = config.getRequestTimeoutInMs(); - if (timeout > 0) { - return timeout; - } - } - } - return timeout; - } - }; - final IdleTimeoutFilter timeoutFilter = new IdleTimeoutFilter(timeoutExecutor, - timeoutResolver, - new IdleTimeoutFilter.TimeoutHandler() { - public void onTimeout(Connection connection) { - timeout(connection); - } - }); - fcb.add(timeoutFilter); - resolver = timeoutFilter.getResolver(); - } - - SSLContext context = clientConfig.getSSLContext(); - boolean defaultSecState = (context != null); - if (context == null) { - try { - context = SslUtils.getSSLContext(); - } catch (Exception e) { - throw new IllegalStateException(e); - } - } - final SSLEngineConfigurator configurator = - new SSLEngineConfigurator(context, - true, - false, - false); - final SwitchingSSLFilter filter = new SwitchingSSLFilter(configurator, defaultSecState); - fcb.add(filter); - final AsyncHttpClientEventFilter eventFilter = new - AsyncHttpClientEventFilter(this); - final AsyncHttpClientFilter clientFilter = - new AsyncHttpClientFilter(clientConfig); - ContentEncoding[] encodings = eventFilter.getContentEncodings(); - if (encodings.length > 0) { - for (ContentEncoding encoding : encodings) { - eventFilter.removeContentEncoding(encoding); - } - } - if (clientConfig.isCompressionEnabled()) { - eventFilter.addContentEncoding( - new GZipContentEncoding(512, - 512, - new ClientEncodingFilter())); - } - fcb.add(eventFilter); - fcb.add(clientFilter); - - GrizzlyAsyncHttpProviderConfig providerConfig = - (GrizzlyAsyncHttpProviderConfig) clientConfig.getAsyncHttpProviderConfig(); - if (providerConfig != null) { - final TransportCustomizer customizer = (TransportCustomizer) - providerConfig.getProperty(TRANSPORT_CUSTOMIZER); - if (customizer != null) { - customizer.customize(clientTransport, fcb); - } else { - doDefaultTransportConfig(); - } - } else { - doDefaultTransportConfig(); - } - fcb.add(new WebSocketFilter()); - - clientTransport.setProcessor(fcb.build()); - - } - - - // ------------------------------------------------- Package Private Methods - - - void touchConnection(final Connection c, final Request request) { - - final PerRequestConfig config = request.getPerRequestConfig(); - if (config != null) { - final long timeout = config.getRequestTimeoutInMs(); - if (timeout > 0) { - final long newTimeout = System.currentTimeMillis() + timeout; - if (resolver != null) { - resolver.setTimeoutMillis(c, newTimeout); - } - } - } else { - final long timeout = clientConfig.getRequestTimeoutInMs(); - if (timeout > 0) { - if (resolver != null) { - resolver.setTimeoutMillis(c, System.currentTimeMillis() + timeout); - } - } - } - - } - - - // --------------------------------------------------------- Private Methods - - - private static boolean configSendFileSupport() { - - return !((System.getProperty("os.name").equalsIgnoreCase("linux") - && !linuxSendFileSupported()) - || System.getProperty("os.name").equalsIgnoreCase("HP-UX")); - } - - - private static boolean linuxSendFileSupported() { - final String version = System.getProperty("java.version"); - if (version.startsWith("1.6")) { - int idx = version.indexOf('_'); - if (idx == -1) { - return false; - } - final int patchRev = Integer.parseInt(version.substring(idx + 1)); - return (patchRev >= 18); - } else { - return version.startsWith("1.7") || version.startsWith("1.8"); - } - } - - private void doDefaultTransportConfig() { - final ExecutorService service = clientConfig.executorService(); - if (service != null) { - clientTransport.setIOStrategy(WorkerThreadIOStrategy.getInstance()); - clientTransport.setWorkerThreadPool(service); - } else { - clientTransport.setIOStrategy(SameThreadIOStrategy.getInstance()); - } - } - - - private CompletionHandler createWriteCompletionHandler(final GrizzlyResponseFuture future) { - return new CompletionHandler() { - - public void cancelled() { - future.cancel(true); - } - - public void failed(Throwable throwable) { - future.abort(throwable); - } - - public void completed(WriteResult result) { - } - - public void updated(WriteResult result) { - // no-op - } - - }; - } - - - void setHttpTransactionContext(final AttributeStorage storage, - final HttpTransactionContext httpTransactionState) { - - if (httpTransactionState == null) { - REQUEST_STATE_ATTR.remove(storage); - } else { - REQUEST_STATE_ATTR.set(storage, httpTransactionState); - } - - } - - HttpTransactionContext getHttpTransactionContext(final AttributeStorage storage) { - - return REQUEST_STATE_ATTR.get(storage); - - } - - - void timeout(final Connection c) { - - final HttpTransactionContext context = getHttpTransactionContext(c); - setHttpTransactionContext(c, null); - context.abort(new TimeoutException("Timeout exceeded")); - - } - - static int getPort(final URI uri, final int p) { - int port = p; - if (port == -1) { - final String protocol = uri.getScheme().toLowerCase(); - if ("http".equals(protocol)) { - port = 80; - } else if ("https".equals(protocol)) { - port = 443; - } else { - throw new IllegalArgumentException("Unknown protocol: " + protocol); - } - } - return port; - } - - - @SuppressWarnings({"unchecked"}) - boolean sendRequest(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - boolean isWriteComplete = true; - - if (requestHasEntityBody(request)) { - final HttpTransactionContext context = getHttpTransactionContext(ctx.getConnection()); - BodyHandler handler = bodyHandlerFactory.getBodyHandler(request); - if (requestPacket.getHeaders().contains(Header.Expect) - && requestPacket.getHeaders().getValue(1).equalsIgnoreCase("100-Continue")) { - handler = new ExpectHandler(handler); - } - context.bodyHandler = handler; - isWriteComplete = handler.doHandle(ctx, request, requestPacket); - } else { - ctx.write(requestPacket, ctx.getTransportContext().getCompletionHandler()); - } - if (LOGGER.isDebugEnabled()) { - LOGGER.debug("REQUEST: " + requestPacket.toString()); - } - - return isWriteComplete; - } - - - private static boolean requestHasEntityBody(final Request request) { - - final String method = request.getMethod(); - return (Method.POST.matchesMethod(method) - || Method.PUT.matchesMethod(method) - || Method.PATCH.matchesMethod(method) - || Method.DELETE.matchesMethod(method)); - - } - - - // ----------------------------------------------------------- Inner Classes - - - private interface StatusHandler { - - public enum InvocationStatus { - CONTINUE, - STOP - } - - boolean handleStatus(final HttpResponsePacket httpResponse, - final HttpTransactionContext httpTransactionContext, - final FilterChainContext ctx); - - boolean handlesStatus(final int statusCode); - - } // END StatusHandler - - - final class HttpTransactionContext { - - final AtomicInteger redirectCount = new AtomicInteger(0); - - final int maxRedirectCount; - final boolean redirectsAllowed; - final GrizzlyAsyncHttpProvider provider = - GrizzlyAsyncHttpProvider.this; - - Request request; - String requestUrl; - AsyncHandler handler; - BodyHandler bodyHandler; - StatusHandler statusHandler; - StatusHandler.InvocationStatus invocationStatus = - StatusHandler.InvocationStatus.CONTINUE; - GrizzlyResponseStatus responseStatus; - GrizzlyResponseFuture future; - String lastRedirectURI; - AtomicLong totalBodyWritten = new AtomicLong(); - AsyncHandler.STATE currentState; - - String wsRequestURI; - boolean isWSRequest; - HandShake handshake; - ProtocolHandler protocolHandler; - WebSocket webSocket; - - - // -------------------------------------------------------- Constructors - - - HttpTransactionContext(final GrizzlyResponseFuture future, - final Request request, - final AsyncHandler handler) { - - this.future = future; - this.request = request; - this.handler = handler; - redirectsAllowed = provider.clientConfig.isRedirectEnabled(); - maxRedirectCount = provider.clientConfig.getMaxRedirects(); - this.requestUrl = request.getUrl(); - - } - - - // ----------------------------------------------------- Private Methods - - - HttpTransactionContext copy() { - final HttpTransactionContext newContext = - new HttpTransactionContext(future, - request, - handler); - newContext.invocationStatus = invocationStatus; - newContext.bodyHandler = bodyHandler; - newContext.currentState = currentState; - newContext.statusHandler = statusHandler; - newContext.lastRedirectURI = lastRedirectURI; - newContext.redirectCount.set(redirectCount.get()); - return newContext; - - } - - - void abort(final Throwable t) { - if (future != null) { - future.abort(t); - } - } - - void done(final Callable c) { - if (future != null) { - future.done(c); - } - } - - @SuppressWarnings({"unchecked"}) - void result(Object result) { - if (future != null) { - future.delegate.result(result); - future.done(null); - } - } - - - } // END HttpTransactionContext - - - // ---------------------------------------------------------- Nested Classes - - private static final class ContinueEvent implements FilterChainEvent { - - private final HttpTransactionContext context; - - - // -------------------------------------------------------- Constructors - - - ContinueEvent(final HttpTransactionContext context) { - - this.context = context; - - } - - - // --------------------------------------- Methods from FilterChainEvent - - - @Override - public Object type() { - return ContinueEvent.class; - } - - } // END ContinueEvent - - - private final class AsyncHttpClientTransportFilter extends TransportFilter { - - @Override - public NextAction handleRead(FilterChainContext ctx) throws IOException { - final HttpTransactionContext context = getHttpTransactionContext(ctx.getConnection()); - if (context == null) { - return super.handleRead(ctx); - } - ctx.getTransportContext().setCompletionHandler(new CompletionHandler() { - @Override - public void cancelled() { - - } - - @Override - public void failed(Throwable throwable) { - if (throwable instanceof EOFException) { - context.abort(new IOException("Remotely Closed")); - } - context.abort(throwable); - } - - @Override - public void completed(Object result) { - } - - @Override - public void updated(Object result) { - } - }); - return super.handleRead(ctx); - } - - } // END AsyncHttpClientTransportFilter - - - private final class AsyncHttpClientFilter extends BaseFilter { - - - private final AsyncHttpClientConfig config; - - - // -------------------------------------------------------- Constructors - - - AsyncHttpClientFilter(final AsyncHttpClientConfig config) { - - this.config = config; - - } - - - // --------------------------------------------- Methods from BaseFilter - - - @Override - public NextAction handleWrite(final FilterChainContext ctx) - throws IOException { - - Object message = ctx.getMessage(); - if (message instanceof Request) { - ctx.setMessage(null); - if (!sendAsGrizzlyRequest((Request) message, ctx)) { - return ctx.getSuspendAction(); - } - } else if (message instanceof Buffer) { - return ctx.getInvokeAction(); - } - - return ctx.getStopAction(); - } - - @Override - public NextAction handleEvent(final FilterChainContext ctx, - final FilterChainEvent event) - throws IOException { - - final Object type = event.type(); - if (type == ContinueEvent.class) { - final ContinueEvent continueEvent = (ContinueEvent) event; - ((ExpectHandler) continueEvent.context.bodyHandler).finish(ctx); - } - - return ctx.getStopAction(); - - } - -// @Override -// public NextAction handleRead(FilterChainContext ctx) throws IOException { -// Object message = ctx.getMessage(); -// if (HttpPacket.isHttp(message)) { -// final HttpPacket packet = (HttpPacket) message; -// HttpResponsePacket responsePacket; -// if (HttpContent.isContent(packet)) { -// responsePacket = (HttpResponsePacket) ((HttpContent) packet).getHttpHeader(); -// } else { -// responsePacket = (HttpResponsePacket) packet; -// } -// if (HttpStatus.SWITCHING_PROTOCOLS_101.statusMatches(responsePacket.getStatus())) { -// return ctx.getStopAction(); -// } -// } -// return super.handleRead(ctx); -// } - - // ----------------------------------------------------- Private Methods - - - private boolean sendAsGrizzlyRequest(final Request request, - final FilterChainContext ctx) - throws IOException { - - final HttpTransactionContext httpCtx = getHttpTransactionContext(ctx.getConnection()); - if (isUpgradeRequest(httpCtx.handler) && isWSRequest(httpCtx.requestUrl)) { - httpCtx.isWSRequest = true; - convertToUpgradeRequest(httpCtx); - } - final URI uri = AsyncHttpProviderUtils.createUri(httpCtx.requestUrl); - final HttpRequestPacket.Builder builder = HttpRequestPacket.builder(); - boolean secure = "https".equals(uri.getScheme()); - builder.method(request.getMethod()); - builder.protocol(Protocol.HTTP_1_1); - String host = request.getVirtualHost(); - if (host != null) { - builder.header(Header.Host, host); - } else { - if (uri.getPort() == -1) { - builder.header(Header.Host, uri.getHost()); - } else { - builder.header(Header.Host, uri.getHost() + ':' + uri.getPort()); - } - } - final ProxyServer proxy = getProxyServer(request); - final boolean useProxy = (proxy != null); - if (useProxy) { - if (secure) { - builder.method(Method.CONNECT); - builder.uri(AsyncHttpProviderUtils.getAuthority(uri)); - } else { - builder.uri(uri.toString()); - } - } else { - builder.uri(uri.getPath()); - } - if (requestHasEntityBody(request)) { - final long contentLength = request.getContentLength(); - if (contentLength > 0) { - builder.contentLength(contentLength); - builder.chunked(false); - } else { - builder.chunked(true); - } - } - - HttpRequestPacket requestPacket; - if (httpCtx.isWSRequest) { - try { - final URI wsURI = new URI(httpCtx.wsRequestURI); - httpCtx.protocolHandler = Version.DRAFT17.createHandler(true); - httpCtx.handshake = httpCtx.protocolHandler.createHandShake(wsURI); - requestPacket = (HttpRequestPacket) - httpCtx.handshake.composeHeaders().getHttpHeader(); - } catch (URISyntaxException e) { - throw new IllegalArgumentException("Invalid WS URI: " + httpCtx.wsRequestURI); - } - } else { - requestPacket = builder.build(); - } - requestPacket.setSecure(true); - if (!useProxy && !httpCtx.isWSRequest) { - addQueryString(request, requestPacket); - } - addHeaders(request, requestPacket); - addCookies(request, requestPacket); - - if (useProxy) { - boolean avoidProxy = ProxyUtils.avoidProxy(proxy, request); - if (!avoidProxy) { - if (!requestPacket.getHeaders().contains(Header.ProxyConnection)) { - requestPacket.setHeader(Header.ProxyConnection, "keep-alive"); - } - - if (proxy.getPrincipal() != null) { - requestPacket.setHeader(Header.ProxyAuthorization, - AuthenticatorUtils.computeBasicAuthentication(proxy)); - } - } - } - final AsyncHandler h = httpCtx.handler; - if (h != null) { - if (TransferCompletionHandler.class.isAssignableFrom(h.getClass())) { - final FluentCaseInsensitiveStringsMap map = - new FluentCaseInsensitiveStringsMap(request.getHeaders()); - TransferCompletionHandler.class.cast(h).transferAdapter(new GrizzlyTransferAdapter(map)); - } - } - return sendRequest(ctx, request, requestPacket); - - } - - - private boolean isUpgradeRequest(final AsyncHandler handler) { - return (handler instanceof UpgradeHandler); - } - - - private boolean isWSRequest(final String requestUri) { - return (requestUri.charAt(0) == 'w' && requestUri.charAt(1) == 's'); - } - - - private void convertToUpgradeRequest(final HttpTransactionContext ctx) { - final int colonIdx = ctx.requestUrl.indexOf(':'); - - if (colonIdx < 2 || colonIdx > 3) { - throw new IllegalArgumentException("Invalid websocket URL: " + ctx.requestUrl); - } - - final StringBuilder sb = new StringBuilder(ctx.requestUrl); - sb.replace(0, colonIdx, ((colonIdx == 2) ? "http" : "https")); - ctx.wsRequestURI = ctx.requestUrl; - ctx.requestUrl = sb.toString(); - } - - - private ProxyServer getProxyServer(Request request) { - - ProxyServer proxyServer = request.getProxyServer(); - if (proxyServer == null) { - proxyServer = config.getProxyServer(); - } - return proxyServer; - - } - - - private void addHeaders(final Request request, - final HttpRequestPacket requestPacket) { - - final FluentCaseInsensitiveStringsMap map = request.getHeaders(); - if (map != null && !map.isEmpty()) { - for (final Map.Entry> entry : map.entrySet()) { - final String headerName = entry.getKey(); - final List headerValues = entry.getValue(); - if (headerValues != null && !headerValues.isEmpty()) { - for (final String headerValue : headerValues) { - requestPacket.addHeader(headerName, headerValue); - } - } - } - } - - final MimeHeaders headers = requestPacket.getHeaders(); - if (!headers.contains(Header.Connection)) { - requestPacket.addHeader(Header.Connection, "keep-alive"); - } - - if (!headers.contains(Header.Accept)) { - requestPacket.addHeader(Header.Accept, "*/*"); - } - - if (!headers.contains(Header.UserAgent)) { - requestPacket.addHeader(Header.UserAgent, config.getUserAgent()); - } - - - } - - - private void addCookies(final Request request, - final HttpRequestPacket requestPacket) { - - final Collection cookies = request.getCookies(); - if (cookies != null && !cookies.isEmpty()) { - StringBuilder sb = new StringBuilder(128); - org.glassfish.grizzly.http.Cookie[] gCookies = - new org.glassfish.grizzly.http.Cookie[cookies.size()]; - convertCookies(cookies, gCookies); - CookieSerializerUtils.serializeClientCookies(sb, gCookies); - requestPacket.addHeader(Header.Cookie, sb.toString()); - } - - } - - - private void convertCookies(final Collection cookies, - final org.glassfish.grizzly.http.Cookie[] gCookies) { - int idx = 0; - for (final Cookie cookie : cookies) { - final org.glassfish.grizzly.http.Cookie gCookie = - new org.glassfish.grizzly.http.Cookie(cookie.getName(), cookie.getValue()); - gCookie.setDomain(cookie.getDomain()); - gCookie.setPath(cookie.getPath()); - gCookie.setVersion(cookie.getVersion()); - gCookie.setMaxAge(cookie.getMaxAge()); - gCookie.setSecure(cookie.isSecure()); - gCookies[idx] = gCookie; - idx++; - } - - } - - - private void addQueryString(final Request request, - final HttpRequestPacket requestPacket) { - - final FluentStringsMap map = request.getQueryParams(); - if (map != null && !map.isEmpty()) { - StringBuilder sb = new StringBuilder(128); - for (final Map.Entry> entry : map.entrySet()) { - final String name = entry.getKey(); - final List values = entry.getValue(); - if (values != null && !values.isEmpty()) { - try { - for (int i = 0, len = values.size(); i < len; i++) { - final String value = values.get(i); - if (value != null && value.length() > 0) { - sb.append(URLEncoder.encode(name, "UTF-8")).append('=') - .append(URLEncoder.encode(values.get(i), "UTF-8")).append('&'); - } else { - sb.append(URLEncoder.encode(name, "UTF-8")).append('&'); - } - } - } catch (UnsupportedEncodingException ignored) { - } - } - } - String queryString = sb.deleteCharAt((sb.length() - 1)).toString(); - - requestPacket.setQueryString(queryString); - } - - } - - } // END AsyncHttpClientFiler - - - private static final class AsyncHttpClientEventFilter extends HttpClientFilter { - - private final Map HANDLER_MAP = new HashMap(); - - - private final GrizzlyAsyncHttpProvider provider; - - - // -------------------------------------------------------- Constructors - - - AsyncHttpClientEventFilter(final GrizzlyAsyncHttpProvider provider) { - - this.provider = provider; - HANDLER_MAP.put(HttpStatus.UNAUTHORIZED_401.getStatusCode(), - AuthorizationHandler.INSTANCE); - HANDLER_MAP.put(HttpStatus.MOVED_PERMANENTLY_301.getStatusCode(), - RedirectHandler.INSTANCE); - HANDLER_MAP.put(HttpStatus.FOUND_302.getStatusCode(), - RedirectHandler.INSTANCE); - HANDLER_MAP.put(HttpStatus.TEMPORARY_REDIRECT_307.getStatusCode(), - RedirectHandler.INSTANCE); - - } - - - // --------------------------------------- Methods from HttpClientFilter - - - @Override - public void exceptionOccurred(FilterChainContext ctx, Throwable error) { - - provider.getHttpTransactionContext(ctx.getConnection()).abort(error); - - } - - - @Override - protected void onHttpContentParsed(HttpContent content, - FilterChainContext ctx) { - - final HttpTransactionContext context = - provider.getHttpTransactionContext(ctx.getConnection()); - final AsyncHandler handler = context.handler; - if (handler != null && context.currentState != AsyncHandler.STATE.ABORT) { - try { - context.currentState = handler.onBodyPartReceived( - new GrizzlyResponseBodyPart(content, - null, - ctx.getConnection(), - provider)); - } catch (Exception e) { - handler.onThrowable(e); - } - } - - } - - @Override - protected void onHttpHeadersEncoded(HttpHeader httpHeader, FilterChainContext ctx) { - final HttpTransactionContext context = provider.getHttpTransactionContext(ctx.getConnection()); - final AsyncHandler handler = context.handler; - if (handler != null) { - if (TransferCompletionHandler.class.isAssignableFrom(handler.getClass())) { - ((TransferCompletionHandler) handler).onHeaderWriteCompleted(); - } - } - } - - @Override - protected void onHttpContentEncoded(HttpContent content, FilterChainContext ctx) { - final HttpTransactionContext context = provider.getHttpTransactionContext(ctx.getConnection()); - final AsyncHandler handler = context.handler; - if (handler != null) { - if (TransferCompletionHandler.class.isAssignableFrom(handler.getClass())) { - final int written = content.getContent().remaining(); - final long total = context.totalBodyWritten.addAndGet(written); - ((TransferCompletionHandler) handler).onContentWriteProgress( - written, - total, - content.getHttpHeader().getContentLength()); - } - } - } - - @Override - protected void onInitialLineParsed(HttpHeader httpHeader, - FilterChainContext ctx) { - - super.onInitialLineParsed(httpHeader, ctx); - if (httpHeader.isSkipRemainder()) { - return; - } - final HttpTransactionContext context = - provider.getHttpTransactionContext(ctx.getConnection()); - final int status = ((HttpResponsePacket) httpHeader).getStatus(); - if (HttpStatus.CONINTUE_100.statusMatches(status)) { - ctx.notifyUpstream(new ContinueEvent(context)); - return; - } - - if (context.statusHandler != null && !context.statusHandler.handlesStatus(status)) { - context.statusHandler = null; - context.invocationStatus = StatusHandler.InvocationStatus.CONTINUE; - } else { - context.statusHandler = null; - } - if (context.invocationStatus == StatusHandler.InvocationStatus.CONTINUE) { - if (HANDLER_MAP.containsKey(status)) { - context.statusHandler = HANDLER_MAP.get(status); - } - if (context.statusHandler instanceof RedirectHandler) { - if (!isRedirectAllowed(context)) { - context.statusHandler = null; - } - } - } - if (isRedirectAllowed(context)) { - if (isRedirect(status)) { - if (context.statusHandler == null) { - context.statusHandler = RedirectHandler.INSTANCE; - } - context.redirectCount.incrementAndGet(); - if (redirectCountExceeded(context)) { - httpHeader.setSkipRemainder(true); - context.abort(new MaxRedirectException()); - } - } else { - if (context.redirectCount.get() > 0) { - context.redirectCount.set(0); - } - } - } - final GrizzlyResponseStatus responseStatus = - new GrizzlyResponseStatus((HttpResponsePacket) httpHeader, - getURI(context.requestUrl), - provider); - context.responseStatus = responseStatus; - if (context.statusHandler != null) { - return; - } - if (context.currentState != AsyncHandler.STATE.ABORT) { - - try { - final AsyncHandler handler = context.handler; - if (handler != null) { - context.currentState = handler.onStatusReceived(responseStatus); - } - } catch (Exception e) { - httpHeader.setSkipRemainder(true); - context.abort(e); - } - } - - } - - - @Override - protected void onHttpHeaderError(final HttpHeader httpHeader, - final FilterChainContext ctx, - final Throwable t) throws IOException { - - t.printStackTrace(); - httpHeader.setSkipRemainder(true); - final HttpTransactionContext context = - provider.getHttpTransactionContext(ctx.getConnection()); - context.abort(t); - } - - @SuppressWarnings({"unchecked"}) - @Override - protected void onHttpHeadersParsed(HttpHeader httpHeader, - FilterChainContext ctx) { - - super.onHttpHeadersParsed(httpHeader, ctx); - if (LOGGER.isDebugEnabled()) { - LOGGER.debug("RESPONSE: " + httpHeader.toString()); - } - if (httpHeader.containsHeader(Header.Connection)) { - if ("close".equals(httpHeader.getHeader(Header.Connection))) { - ConnectionManager.markConnectionAsDoNotCache(ctx.getConnection()); - } - } - if (httpHeader.isSkipRemainder()) { - return; - } - final HttpTransactionContext context = - provider.getHttpTransactionContext(ctx.getConnection()); - final AsyncHandler handler = context.handler; - final List filters = context.provider.clientConfig.getResponseFilters(); - final GrizzlyResponseHeaders responseHeaders = new GrizzlyResponseHeaders((HttpResponsePacket) httpHeader, - null, - provider); - if (!filters.isEmpty()) { - FilterContext fc = new FilterContext.FilterContextBuilder() - .asyncHandler(handler).request(context.request) - .responseHeaders(responseHeaders) - .responseStatus(context.responseStatus).build(); - try { - for (final ResponseFilter f : filters) { - fc = f.filter(fc); - } - } catch (Exception e) { - context.abort(e); - } - if (fc.replayRequest()) { - httpHeader.setSkipRemainder(true); - final Request newRequest = fc.getRequest(); - final AsyncHandler newHandler = fc.getAsyncHandler(); - try { - final ConnectionManager m = - context.provider.connectionManager; - final Connection c = - m.obtainConnection(newRequest, - context.future); - final HttpTransactionContext newContext = - context.copy(); - context.future = null; - provider.setHttpTransactionContext(c, newContext); - try { - context.provider.execute(c, - newRequest, - newHandler, - context.future); - } catch (IOException ioe) { - newContext.abort(ioe); - } - } catch (Exception e) { - context.abort(e); - } - return; - } - } - if (context.statusHandler != null && context.invocationStatus == StatusHandler.InvocationStatus.CONTINUE) { - final boolean result = context.statusHandler.handleStatus(((HttpResponsePacket) httpHeader), - context, - ctx); - if (!result) { - httpHeader.setSkipRemainder(true); - return; - } - } - - if (context.currentState != AsyncHandler.STATE.ABORT) { - boolean upgrade = context.currentState == AsyncHandler.STATE.UPGRADE; - try { - context.currentState = handler.onHeadersReceived( - responseHeaders); - } catch (Exception e) { - httpHeader.setSkipRemainder(true); - context.abort(e); - return; - } - if (upgrade) { - try { - context.protocolHandler.setConnection(ctx.getConnection()); - DefaultWebSocket ws = new DefaultWebSocket(context.protocolHandler); - ws.onConnect(); - context.webSocket = new GrizzlyWebSocketAdapter(ws); - WebSocketEngine.getEngine().setWebSocketHolder(ctx.getConnection(), - context.protocolHandler, - ws); - ((WebSocketUpgradeHandler) context.handler).onSuccess(context.webSocket); - final int wsTimeout = context.provider.clientConfig.getWebSocketIdleTimeoutInMs(); - IdleTimeoutFilter.setCustomTimeout(ctx.getConnection(), - ((wsTimeout <= 0) - ? IdleTimeoutFilter.FOREVER - : wsTimeout), - TimeUnit.MILLISECONDS); - context.result(handler.onCompleted()); - } catch (Exception e) { - httpHeader.setSkipRemainder(true); - context.abort(e); - } - } - } - - } - - - @SuppressWarnings({"unchecked"}) - @Override - protected boolean onHttpPacketParsed(HttpHeader httpHeader, FilterChainContext ctx) { - - boolean result; - if (httpHeader.isSkipRemainder()) { - clearResponse(ctx.getConnection()); - cleanup(ctx, provider); - return false; - } - - result = super.onHttpPacketParsed(httpHeader, ctx); - - final HttpTransactionContext context = cleanup(ctx, provider); - - final AsyncHandler handler = context.handler; - if (handler != null) { - try { - context.result(handler.onCompleted()); - } catch (Exception e) { - context.abort(e); - } - } else { - context.done(null); - } - - return result; - } - - - // ----------------------------------------------------- Private Methods - - - private static boolean isRedirectAllowed(final HttpTransactionContext ctx) { - boolean allowed = ctx.request.isRedirectEnabled(); - if (ctx.request.isRedirectOverrideSet()) { - return allowed; - } - if (!allowed) { - allowed = ctx.redirectsAllowed; - } - return allowed; - } - - private static HttpTransactionContext cleanup(final FilterChainContext ctx, - final GrizzlyAsyncHttpProvider provider) { - - final Connection c = ctx.getConnection(); - final HttpTransactionContext context = - provider.getHttpTransactionContext(c); - context.provider.setHttpTransactionContext(c, null); - if (!context.provider.connectionManager.canReturnConnection(c)) { - context.abort(new IOException("Maximum pooled connections exceeded")); - } else { - if (!context.provider.connectionManager.returnConnection(context.requestUrl, c)) { - ctx.getConnection().close().markForRecycle(true); - } - } - - return context; - - } - - - private static URI getURI(String url) { - - return AsyncHttpProviderUtils.createUri(url); - - } - - - private static boolean redirectCountExceeded(final HttpTransactionContext context) { - - return (context.redirectCount.get() > context.maxRedirectCount); - - } - - - private static boolean isRedirect(final int status) { - - return HttpStatus.MOVED_PERMANENTLY_301.statusMatches(status) - || HttpStatus.FOUND_302.statusMatches(status) - || HttpStatus.SEE_OTHER_303.statusMatches(status) - || HttpStatus.TEMPORARY_REDIRECT_307.statusMatches(status); - - } - - - // ------------------------------------------------------- Inner Classes - - - private static final class AuthorizationHandler implements StatusHandler { - - private static final AuthorizationHandler INSTANCE = - new AuthorizationHandler(); - - // -------------------------------------- Methods from StatusHandler - - - public boolean handlesStatus(int statusCode) { - return (HttpStatus.UNAUTHORIZED_401.statusMatches(statusCode)); - } - - @SuppressWarnings({"unchecked"}) - public boolean handleStatus(final HttpResponsePacket responsePacket, - final HttpTransactionContext httpTransactionContext, - final FilterChainContext ctx) { - - final String auth = responsePacket.getHeader(Header.WWWAuthenticate); - if (auth == null) { - throw new IllegalStateException("401 response received, but no WWW-Authenticate header was present"); - } - - Realm realm = httpTransactionContext.request.getRealm(); - if (realm == null) { - realm = httpTransactionContext.provider.clientConfig.getRealm(); - } - if (realm == null) { - httpTransactionContext.invocationStatus = InvocationStatus.STOP; - return true; - } - - responsePacket.setSkipRemainder(true); // ignore the remainder of the response - - final Request req = httpTransactionContext.request; - realm = new Realm.RealmBuilder().clone(realm) - .setScheme(realm.getAuthScheme()) - .setUri(URI.create(httpTransactionContext.requestUrl).getPath()) - .setMethodName(req.getMethod()) - .setUsePreemptiveAuth(true) - .parseWWWAuthenticateHeader(auth) - .build(); - if (auth.toLowerCase().startsWith("basic")) { - req.getHeaders().remove(Header.Authorization.toString()); - try { - req.getHeaders().add(Header.Authorization.toString(), - AuthenticatorUtils.computeBasicAuthentication(realm)); - } catch (UnsupportedEncodingException ignored) { - } - } else if (auth.toLowerCase().startsWith("digest")) { - req.getHeaders().remove(Header.Authorization.toString()); - try { - req.getHeaders().add(Header.Authorization.toString(), - AuthenticatorUtils.computeDigestAuthentication(realm)); - } catch (NoSuchAlgorithmException e) { - throw new IllegalStateException("Digest authentication not supported", e); - } catch (UnsupportedEncodingException e) { - throw new IllegalStateException("Unsupported encoding.", e); - } - } else { - throw new IllegalStateException("Unsupported authorization method: " + auth); - } - - final ConnectionManager m = httpTransactionContext.provider.connectionManager; - try { - final Connection c = m.obtainConnection(req, - httpTransactionContext.future); - final HttpTransactionContext newContext = - httpTransactionContext.copy(); - httpTransactionContext.future = null; - httpTransactionContext.provider.setHttpTransactionContext(c, newContext); - newContext.invocationStatus = InvocationStatus.STOP; - try { - httpTransactionContext.provider.execute(c, - req, - httpTransactionContext.handler, - httpTransactionContext.future); - return false; - } catch (IOException ioe) { - newContext.abort(ioe); - return false; - } - } catch (Exception e) { - httpTransactionContext.abort(e); - } - httpTransactionContext.invocationStatus = InvocationStatus.STOP; - return false; - } - - } // END AuthorizationHandler - - - private static final class RedirectHandler implements StatusHandler { - - private static final RedirectHandler INSTANCE = new RedirectHandler(); - - - // ------------------------------------------ Methods from StatusHandler - - - public boolean handlesStatus(int statusCode) { - return (isRedirect(statusCode)); - } - - @SuppressWarnings({"unchecked"}) - public boolean handleStatus(final HttpResponsePacket responsePacket, - final HttpTransactionContext httpTransactionContext, - final FilterChainContext ctx) { - - final String redirectURL = responsePacket.getHeader(Header.Location); - if (redirectURL == null) { - throw new IllegalStateException("redirect received, but no location header was present"); - } - - URI orig; - if (httpTransactionContext.lastRedirectURI == null) { - orig = AsyncHttpProviderUtils.createUri(httpTransactionContext.requestUrl); - } else { - orig = AsyncHttpProviderUtils.getRedirectUri(AsyncHttpProviderUtils.createUri(httpTransactionContext.requestUrl), - httpTransactionContext.lastRedirectURI); - } - httpTransactionContext.lastRedirectURI = redirectURL; - Request requestToSend; - URI uri = AsyncHttpProviderUtils.getRedirectUri(orig, redirectURL); - if (!uri.toString().equalsIgnoreCase(orig.toString())) { - requestToSend = newRequest(uri, - responsePacket, - httpTransactionContext, - sendAsGet(responsePacket, httpTransactionContext)); - } else { - httpTransactionContext.statusHandler = null; - httpTransactionContext.invocationStatus = InvocationStatus.CONTINUE; - try { - httpTransactionContext.handler.onStatusReceived(httpTransactionContext.responseStatus); - } catch (Exception e) { - httpTransactionContext.abort(e); - } - return true; - } - - final ConnectionManager m = httpTransactionContext.provider.connectionManager; - try { - final Connection c = m.obtainConnection(requestToSend, - httpTransactionContext.future); - if (switchingSchemes(orig, uri)) { - try { - notifySchemeSwitch(ctx, c, uri); - } catch (IOException ioe) { - httpTransactionContext.abort(ioe); - } - } - final HttpTransactionContext newContext = - httpTransactionContext.copy(); - httpTransactionContext.future = null; - newContext.invocationStatus = InvocationStatus.CONTINUE; - newContext.request = requestToSend; - newContext.requestUrl = requestToSend.getUrl(); - httpTransactionContext.provider.setHttpTransactionContext(c, newContext); - httpTransactionContext.provider.execute(c, - requestToSend, - newContext.handler, - newContext.future); - return false; - } catch (Exception e) { - httpTransactionContext.abort(e); - } - - httpTransactionContext.invocationStatus = InvocationStatus.CONTINUE; - return true; - - } - - - // ------------------------------------------------- Private Methods - - private boolean sendAsGet(final HttpResponsePacket response, - final HttpTransactionContext ctx) { - final int statusCode = response.getStatus(); - return !(statusCode < 302 || statusCode > 303) - && !(statusCode == 302 - && ctx.provider.clientConfig.isStrict302Handling()); - } - - - private boolean switchingSchemes(final URI oldUri, - final URI newUri) { - - return !oldUri.getScheme().equals(newUri.getScheme()); - - } - - private void notifySchemeSwitch(final FilterChainContext ctx, - final Connection c, - final URI uri) throws IOException { - - ctx.notifyDownstream(new SwitchingSSLFilter.SSLSwitchingEvent( - "https".equals(uri.getScheme()), c)); - } - - } // END RedirectHandler - - - // ----------------------------------------------------- Private Methods - - - private static Request newRequest(final URI uri, - final HttpResponsePacket response, - final HttpTransactionContext ctx, - boolean asGet) { - - final RequestBuilder builder = new RequestBuilder(ctx.request); - if (asGet) { - builder.setMethod("GET"); - } - builder.setUrl(uri.toString()); - - if (ctx.provider.clientConfig.isRemoveQueryParamOnRedirect()) { - builder.setQueryParameters(null); - } - for (String cookieStr : response.getHeaders().values(Header.Cookie)) { - Cookie c = AsyncHttpProviderUtils.parseCookie(cookieStr); - builder.addOrReplaceCookie(c); - } - return builder.build(); - - } - - - } // END AsyncHttpClientEventFilter - - - private static final class ClientEncodingFilter implements EncodingFilter { - - - // ----------------------------------------- Methods from EncodingFilter - - - public boolean applyEncoding(HttpHeader httpPacket) { - - httpPacket.addHeader(Header.AcceptEncoding, "gzip"); - return true; - - } - - - public boolean applyDecoding(HttpHeader httpPacket) { - - final HttpResponsePacket httpResponse = (HttpResponsePacket) httpPacket; - final DataChunk bc = httpResponse.getHeaders().getValue(Header.ContentEncoding); - return bc != null && bc.indexOf("gzip", 0) != -1; - - } - - - } // END ClientContentEncoding - - - private static final class NonCachingPool implements ConnectionsPool { - - - // ---------------------------------------- Methods from ConnectionsPool - - - public boolean offer(String uri, Connection connection) { - return false; - } - - public Connection poll(String uri) { - return null; - } - - public boolean removeAll(Connection connection) { - return false; - } - - public boolean canCacheConnection() { - return true; - } - - public void destroy() { - // no-op - } - - } // END NonCachingPool - - - private static interface BodyHandler { - - static int MAX_CHUNK_SIZE = 8192; - - boolean handlesBodyType(final Request request); - - boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) throws IOException; - - } // END BodyHandler - - - private final class BodyHandlerFactory { - - private final BodyHandler[] HANDLERS = new BodyHandler[] { - new StringBodyHandler(), - new ByteArrayBodyHandler(), - new ParamsBodyHandler(), - new EntityWriterBodyHandler(), - new StreamDataBodyHandler(), - new PartsBodyHandler(), - new FileBodyHandler(), - new BodyGeneratorBodyHandler() - }; - - public BodyHandler getBodyHandler(final Request request) { - for (final BodyHandler h : HANDLERS) { - if (h.handlesBodyType(request)) { - return h; - } - } - return new NoBodyHandler(); - } - - } // END BodyHandlerFactory - - - private static final class ExpectHandler implements BodyHandler { - - private final BodyHandler delegate; - private Request request; - private HttpRequestPacket requestPacket; - - // -------------------------------------------------------- Constructors - - - private ExpectHandler(final BodyHandler delegate) { - - this.delegate = delegate; - - } - - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(Request request) { - return delegate.handlesBodyType(request); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(FilterChainContext ctx, Request request, HttpRequestPacket requestPacket) throws IOException { - this.request = request; - this.requestPacket = requestPacket; - ctx.write(requestPacket, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - return true; - } - - public void finish(final FilterChainContext ctx) throws IOException { - delegate.doHandle(ctx, request, requestPacket); - } - - } // END ContinueHandler - - - private final class ByteArrayBodyHandler implements BodyHandler { - - - // -------------------------------------------- Methods from BodyHandler - - public boolean handlesBodyType(final Request request) { - return (request.getByteData() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - String charset = request.getBodyEncoding(); - if (charset == null) { - charset = Charsets.DEFAULT_CHARACTER_ENCODING; - } - final byte[] data = new String(request.getByteData(), charset).getBytes(charset); - final MemoryManager mm = ctx.getMemoryManager(); - final Buffer gBuffer = Buffers.wrap(mm, data); - if (requestPacket.getContentLength() == -1) { - if (!clientConfig.isCompressionEnabled()) { - requestPacket.setContentLengthLong(data.length); - } - } - final HttpContent content = requestPacket.httpContentBuilder().content(gBuffer).build(); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - return true; - } - } - - - private final class StringBodyHandler implements BodyHandler { - - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return (request.getStringData() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - String charset = request.getBodyEncoding(); - if (charset == null) { - charset = Charsets.DEFAULT_CHARACTER_ENCODING; - } - final byte[] data = request.getStringData().getBytes(charset); - final MemoryManager mm = ctx.getMemoryManager(); - final Buffer gBuffer = Buffers.wrap(mm, data); - if (requestPacket.getContentLength() == -1) { - if (!clientConfig.isCompressionEnabled()) { - requestPacket.setContentLengthLong(data.length); - } - } - final HttpContent content = requestPacket.httpContentBuilder().content(gBuffer).build(); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - return true; - } - - } // END StringBodyHandler - - - private static final class NoBodyHandler implements BodyHandler { - - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return false; - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - final HttpContent content = requestPacket.httpContentBuilder().content(Buffers.EMPTY_BUFFER).build(); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - return true; - } - - } // END NoBodyHandler - - - private final class ParamsBodyHandler implements BodyHandler { - - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - final FluentStringsMap params = request.getParams(); - return (params != null && !params.isEmpty()); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - if (requestPacket.getContentType() == null) { - requestPacket.setContentType("application/x-www-form-urlencoded"); - } - StringBuilder sb = null; - String charset = request.getBodyEncoding(); - if (charset == null) { - charset = Charsets.DEFAULT_CHARACTER_ENCODING; - } - final FluentStringsMap params = request.getParams(); - if (!params.isEmpty()) { - for (Map.Entry> entry : params.entrySet()) { - String name = entry.getKey(); - List values = entry.getValue(); - if (values != null && !values.isEmpty()) { - if (sb == null) { - sb = new StringBuilder(128); - } - for (String value : values) { - if (sb.length() > 0) { - sb.append('&'); - } - sb.append(URLEncoder.encode(name, charset)) - .append('=').append(URLEncoder.encode(value, charset)); - } - } - } - } - if (sb != null) { - final byte[] data = sb.toString().getBytes(charset); - final MemoryManager mm = ctx.getMemoryManager(); - final Buffer gBuffer = Buffers.wrap(mm, data); - final HttpContent content = requestPacket.httpContentBuilder().content(gBuffer).build(); - if (requestPacket.getContentLength() == -1) { - if (!clientConfig.isCompressionEnabled()) { - requestPacket.setContentLengthLong(data.length); - } - } - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - return true; - } - - } // END ParamsBodyHandler - - - private static final class EntityWriterBodyHandler implements BodyHandler { - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return (request.getEntityWriter() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - final MemoryManager mm = ctx.getMemoryManager(); - Buffer b = mm.allocate(512); - BufferOutputStream o = new BufferOutputStream(mm, b, true); - final Request.EntityWriter writer = request.getEntityWriter(); - writer.writeEntity(o); - b = o.getBuffer(); - b.trim(); - if (b.hasRemaining()) { - final HttpContent content = requestPacket.httpContentBuilder().content(b).build(); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - - return true; - } - - } // END EntityWriterBodyHandler - - - private static final class StreamDataBodyHandler implements BodyHandler { - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return (request.getStreamData() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - final MemoryManager mm = ctx.getMemoryManager(); - Buffer buffer = mm.allocate(512); - final byte[] b = new byte[512]; - int read; - final InputStream in = request.getStreamData(); - try { - in.reset(); - } catch (IOException ioe) { - if (LOGGER.isDebugEnabled()) { - LOGGER.debug(ioe.toString(), ioe); - } - } - if (in.markSupported()) { - in.mark(0); - } - - while ((read = in.read(b)) != -1) { - if (read > buffer.remaining()) { - buffer = mm.reallocate(buffer, buffer.capacity() + 512); - } - buffer.put(b, 0, read); - } - buffer.trim(); - if (buffer.hasRemaining()) { - final HttpContent content = requestPacket.httpContentBuilder().content(buffer).build(); - buffer.allowBufferDispose(false); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - - return true; - } - - } // END StreamDataBodyHandler - - - private static final class PartsBodyHandler implements BodyHandler { - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - final List parts = request.getParts(); - return (parts != null && !parts.isEmpty()); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - MultipartRequestEntity mre = - AsyncHttpProviderUtils.createMultipartRequestEntity( - request.getParts(), - request.getParams()); - requestPacket.setContentLengthLong(mre.getContentLength()); - requestPacket.setContentType(mre.getContentType()); - final MemoryManager mm = ctx.getMemoryManager(); - Buffer b = mm.allocate(512); - BufferOutputStream o = new BufferOutputStream(mm, b, true); - mre.writeRequest(o); - b = o.getBuffer(); - b.trim(); - if (b.hasRemaining()) { - final HttpContent content = requestPacket.httpContentBuilder().content(b).build(); - content.setLast(true); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - - return true; - } - - } // END PartsBodyHandler - - - private final class FileBodyHandler implements BodyHandler { - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return (request.getFile() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - final File f = request.getFile(); - requestPacket.setContentLengthLong(f.length()); - final HttpTransactionContext context = getHttpTransactionContext(ctx.getConnection()); - if (!SEND_FILE_SUPPORT || requestPacket.isSecure()) { - final FileInputStream fis = new FileInputStream(request.getFile()); - final MemoryManager mm = ctx.getMemoryManager(); - AtomicInteger written = new AtomicInteger(); - boolean last = false; - try { - for (byte[] buf = new byte[MAX_CHUNK_SIZE]; !last; ) { - Buffer b = null; - int read; - if ((read = fis.read(buf)) < 0) { - last = true; - b = Buffers.EMPTY_BUFFER; - } - if (b != Buffers.EMPTY_BUFFER) { - written.addAndGet(read); - b = Buffers.wrap(mm, buf, 0, read); - } - - final HttpContent content = - requestPacket.httpContentBuilder().content(b). - last(last).build(); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - } finally { - try { - fis.close(); - } catch (IOException ignored) { - } - } - } else { - // write the headers - ctx.write(requestPacket, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - ctx.write(new FileTransfer(f), new EmptyCompletionHandler() { - - @Override - public void updated(WriteResult result) { - final AsyncHandler handler = context.handler; - if (handler != null) { - if (TransferCompletionHandler.class.isAssignableFrom(handler.getClass())) { - final long written = result.getWrittenSize(); - final long total = context.totalBodyWritten.addAndGet(written); - ((TransferCompletionHandler) handler).onContentWriteProgress( - written, - total, - requestPacket.getContentLength()); - } - } - } - }); - } - - return true; - } - - } // END FileBodyHandler - - - private static final class BodyGeneratorBodyHandler implements BodyHandler { - - // -------------------------------------------- Methods from BodyHandler - - - public boolean handlesBodyType(final Request request) { - return (request.getBodyGenerator() != null); - } - - @SuppressWarnings({"unchecked"}) - public boolean doHandle(final FilterChainContext ctx, - final Request request, - final HttpRequestPacket requestPacket) - throws IOException { - - final BodyGenerator generator = request.getBodyGenerator(); - final Body bodyLocal = generator.createBody(); - final long len = bodyLocal.getContentLength(); - if (len > 0) { - requestPacket.setContentLengthLong(len); - } else { - requestPacket.setChunked(true); - } - - final MemoryManager mm = ctx.getMemoryManager(); - boolean last = false; - - while (!last) { - Buffer buffer = mm.allocate(MAX_CHUNK_SIZE); - buffer.allowBufferDispose(true); - - final long readBytes = bodyLocal.read(buffer.toByteBuffer()); - if (readBytes > 0) { - buffer.position((int) readBytes); - buffer.trim(); - } else { - buffer.dispose(); - - if (readBytes < 0) { - last = true; - buffer = Buffers.EMPTY_BUFFER; - } else { - // pass the context to bodyLocal to be able to - // continue body transferring once more data is available - if (generator instanceof FeedableBodyGenerator) { - ((FeedableBodyGenerator) generator).initializeAsynchronousTransfer(ctx, requestPacket); - return false; - } else { - throw new IllegalStateException("BodyGenerator unexpectedly returned 0 bytes available"); - } - } - } - - final HttpContent content = - requestPacket.httpContentBuilder().content(buffer). - last(last).build(); - ctx.write(content, ((!requestPacket.isCommitted()) ? ctx.getTransportContext().getCompletionHandler() : null)); - } - - return true; - } - - } // END BodyGeneratorBodyHandler - - - static class ConnectionManager { - - private static final Attribute DO_NOT_CACHE = - Grizzly.DEFAULT_ATTRIBUTE_BUILDER.createAttribute(ConnectionManager.class.getName()); - private final ConnectionsPool pool; - private final TCPNIOConnectorHandler connectionHandler; - private final ConnectionMonitor connectionMonitor; - private final GrizzlyAsyncHttpProvider provider; - - // -------------------------------------------------------- Constructors - - ConnectionManager(final GrizzlyAsyncHttpProvider provider, - final TCPNIOTransport transport) { - - ConnectionsPool connectionPool; - this.provider = provider; - final AsyncHttpClientConfig config = provider.clientConfig; - if (config.getAllowPoolingConnection()) { - ConnectionsPool pool = config.getConnectionsPool(); - if (pool != null) { - //noinspection unchecked - connectionPool = (ConnectionsPool) pool; - } else { - connectionPool = new GrizzlyConnectionsPool((config)); - } - } else { - connectionPool = new NonCachingPool(); - } - pool = connectionPool; - connectionHandler = TCPNIOConnectorHandler.builder(transport).build(); - final int maxConns = provider.clientConfig.getMaxTotalConnections(); - connectionMonitor = new ConnectionMonitor(maxConns); - - - } - - // ----------------------------------------------------- Private Methods - - static void markConnectionAsDoNotCache(final Connection c) { - DO_NOT_CACHE.set(c, Boolean.TRUE); - } - - static boolean isConnectionCacheable(final Connection c) { - final Boolean canCache = DO_NOT_CACHE.get(c); - return ((canCache != null) ? canCache : false); - } - - void doAsyncTrackedConnection(final Request request, - final GrizzlyResponseFuture requestFuture, - final CompletionHandler connectHandler) - throws IOException, ExecutionException, InterruptedException { - final String url = request.getUrl(); - Connection c = pool.poll(AsyncHttpProviderUtils.getBaseUrl(url)); - if (c == null) { - if (!connectionMonitor.acquire()) { - throw new IOException("Max connections exceeded"); - } - doAsyncConnect(url, request, requestFuture, connectHandler); - } else { - provider.touchConnection(c, request); - connectHandler.completed(c); - } - - } - - Connection obtainConnection(final Request request, - final GrizzlyResponseFuture requestFuture) - throws IOException, ExecutionException, InterruptedException, TimeoutException { - - final Connection c = (obtainConnection0(request.getUrl(), - request, - requestFuture)); - DO_NOT_CACHE.set(c, Boolean.TRUE); - return c; - - } - - void doAsyncConnect(final String url, - final Request request, - final GrizzlyResponseFuture requestFuture, - final CompletionHandler connectHandler) - throws IOException, ExecutionException, InterruptedException { - - final URI uri = AsyncHttpProviderUtils.createUri(url); - ProxyServer proxy = getProxyServer(request); - if (ProxyUtils.avoidProxy(proxy, request)) { - proxy = null; - } - String host = ((proxy != null) ? proxy.getHost() : uri.getHost()); - int port = ((proxy != null) ? proxy.getPort() : uri.getPort()); - connectionHandler.connect(new InetSocketAddress(host, getPort(uri, port)), - createConnectionCompletionHandler(request, requestFuture, connectHandler)); - - } - - private Connection obtainConnection0(final String url, - final Request request, - final GrizzlyResponseFuture requestFuture) - throws IOException, ExecutionException, InterruptedException, TimeoutException { - - final URI uri = AsyncHttpProviderUtils.createUri(url); - ProxyServer proxy = getProxyServer(request); - if (ProxyUtils.avoidProxy(proxy, request)) { - proxy = null; - } - String host = ((proxy != null) ? proxy.getHost() : uri.getHost()); - int port = ((proxy != null) ? proxy.getPort() : uri.getPort()); - int cTimeout = provider.clientConfig.getConnectionTimeoutInMs(); - FutureImpl future = Futures.createSafeFuture(); - CompletionHandler ch = Futures.toCompletionHandler(future, - createConnectionCompletionHandler(request, requestFuture, null)); - if (cTimeout > 0) { - connectionHandler.connect(new InetSocketAddress(host, getPort(uri, port)), - ch); - return future.get(cTimeout, TimeUnit.MILLISECONDS); - } else { - connectionHandler.connect(new InetSocketAddress(host, getPort(uri, port)), - ch); - return future.get(); - } - } - - private ProxyServer getProxyServer(Request request) { - - ProxyServer proxyServer = request.getProxyServer(); - if (proxyServer == null) { - proxyServer = provider.clientConfig.getProxyServer(); - } - return proxyServer; - - } - - boolean returnConnection(final String url, final Connection c) { - final boolean result = (DO_NOT_CACHE.get(c) == null - && pool.offer(AsyncHttpProviderUtils.getBaseUrl(url), c)); - if (result) { - if (provider.resolver != null) { - provider.resolver.setTimeoutMillis(c, IdleTimeoutFilter.FOREVER); - } - } - return result; - - } - - - boolean canReturnConnection(final Connection c) { - - return (DO_NOT_CACHE.get(c) != null || pool.canCacheConnection()); - - } - - - void destroy() { - - pool.destroy(); - - } - - CompletionHandler createConnectionCompletionHandler(final Request request, - final GrizzlyResponseFuture future, - final CompletionHandler wrappedHandler) { - return new CompletionHandler() { - public void cancelled() { - if (wrappedHandler != null) { - wrappedHandler.cancelled(); - } else { - future.cancel(true); - } - } - - public void failed(Throwable throwable) { - if (wrappedHandler != null) { - wrappedHandler.failed(throwable); - } else { - future.abort(throwable); - } - } - - public void completed(Connection connection) { - future.setConnection(connection); - provider.touchConnection(connection, request); - if (wrappedHandler != null) { - connection.addCloseListener(connectionMonitor); - wrappedHandler.completed(connection); - } - } - - public void updated(Connection result) { - if (wrappedHandler != null) { - wrappedHandler.updated(result); - } - } - }; - } - - // ------------------------------------------------------ Nested Classes - - private static class ConnectionMonitor implements Connection.CloseListener { - - private final Semaphore connections; - - // ------------------------------------------------------------ Constructors - - - ConnectionMonitor(final int maxConnections) { - if (maxConnections != -1) { - connections = new Semaphore(maxConnections); - } else { - connections = null; - } - } - - // ----------------------------------- Methods from Connection.CloseListener - - - public boolean acquire() { - - return (connections == null || connections.tryAcquire()); - - } - - @Override - public void onClosed(Connection connection, Connection.CloseType closeType) throws IOException { - - if (connections != null) { - connections.release(); - } - - } - - } // END ConnectionMonitor - - } // END ConnectionManager - - static final class SwitchingSSLFilter extends SSLFilter { - - private final boolean secureByDefault; - final Attribute CONNECTION_IS_SECURE = - Grizzly.DEFAULT_ATTRIBUTE_BUILDER.createAttribute(SwitchingSSLFilter.class.getName()); - - // -------------------------------------------------------- Constructors - - - SwitchingSSLFilter(final SSLEngineConfigurator clientConfig, - final boolean secureByDefault) { - - super(null, clientConfig); - this.secureByDefault = secureByDefault; - - } - - - // ---------------------------------------------- Methods from SSLFilter - - - @Override - public NextAction handleEvent(FilterChainContext ctx, FilterChainEvent event) throws IOException { - - if (event.type() == SSLSwitchingEvent.class) { - final SSLSwitchingEvent se = (SSLSwitchingEvent) event; - CONNECTION_IS_SECURE.set(se.connection, se.secure); - return ctx.getStopAction(); - } - return ctx.getInvokeAction(); - - } - - @Override - public NextAction handleRead(FilterChainContext ctx) throws IOException { - - if (isSecure(ctx.getConnection())) { - return super.handleRead(ctx); - } - return ctx.getInvokeAction(); - - } - - @Override - public NextAction handleWrite(FilterChainContext ctx) throws IOException { - - if (isSecure(ctx.getConnection())) { - return super.handleWrite(ctx); - } - return ctx.getInvokeAction(); - - } - - - // ----------------------------------------------------- Private Methods - - - private boolean isSecure(final Connection c) { - - Boolean secStatus = CONNECTION_IS_SECURE.get(c); - if (secStatus == null) { - secStatus = secureByDefault; - } - return secStatus; - - } - - - // ------------------------------------------------------ Nested Classes - - static final class SSLSwitchingEvent implements FilterChainEvent { - - final boolean secure; - final Connection connection; - - // ---------------------------------------------------- Constructors - - - SSLSwitchingEvent(final boolean secure, final Connection c) { - - this.secure = secure; - connection = c; - - } - - // ----------------------------------- Methods from FilterChainEvent - - - @Override - public Object type() { - return SSLSwitchingEvent.class; - } - - } // END SSLSwitchingEvent - - } // END SwitchingSSLFilter - - private static final class GrizzlyTransferAdapter extends TransferCompletionHandler.TransferAdapter { - - - // -------------------------------------------------------- Constructors - - - public GrizzlyTransferAdapter(FluentCaseInsensitiveStringsMap headers) throws IOException { - super(headers); - } - - - // ---------------------------------------- Methods from TransferAdapter - - - @Override - public void getBytes(byte[] bytes) { - // TODO implement - } - - } // END GrizzlyTransferAdapter - - - private static final class GrizzlyWebSocketAdapter implements WebSocket { - - private final org.glassfish.grizzly.websockets.WebSocket gWebSocket; - - // -------------------------------------------------------- Constructors - - - GrizzlyWebSocketAdapter(final org.glassfish.grizzly.websockets.WebSocket gWebSocket) { - this.gWebSocket = gWebSocket; - } - - - // ------------------------------------------ Methods from AHC WebSocket - - - @Override - public WebSocket sendMessage(byte[] message) { - gWebSocket.send(message); - return this; - } - - @Override - public WebSocket stream(byte[] fragment, boolean last) { - if (fragment != null && fragment.length > 0) { - gWebSocket.stream(last, fragment, 0, fragment.length); - } - return this; - } - - @Override - public WebSocket stream(byte[] fragment, int offset, int len, boolean last) { - if (fragment != null && fragment.length > 0) { - gWebSocket.stream(last, fragment, offset, len); - } - return this; - } - - @Override - public WebSocket sendTextMessage(String message) { - gWebSocket.send(message); - return this; - } - - @Override - public WebSocket streamText(String fragment, boolean last) { - gWebSocket.stream(last, fragment); - return this; - } - - @Override - public WebSocket sendPing(byte[] payload) { - gWebSocket.sendPing(payload); - return this; - } - - @Override - public WebSocket sendPong(byte[] payload) { - gWebSocket.sendPong(payload); - return this; - } - - @Override - public WebSocket addWebSocketListener(WebSocketListener l) { - gWebSocket.add(new AHCWebSocketListenerAdapter(l, this)); - return this; - } - - @Override - public boolean isOpen() { - return gWebSocket.isConnected(); - } - - @Override - public void close() { - gWebSocket.close(); - } - - } // END GrizzlyWebSocketAdapter - - - private static final class AHCWebSocketListenerAdapter implements org.glassfish.grizzly.websockets.WebSocketListener { - - private final WebSocketListener ahcListener; - private final WebSocket webSocket; - - // -------------------------------------------------------- Constructors - - - AHCWebSocketListenerAdapter(final WebSocketListener ahcListener, WebSocket webSocket) { - this.ahcListener = ahcListener; - this.webSocket = webSocket; - } - - - // ------------------------------ Methods from Grizzly WebSocketListener - - - @Override - public void onClose(org.glassfish.grizzly.websockets.WebSocket gWebSocket, DataFrame dataFrame) { - ahcListener.onClose(webSocket); - } - - @Override - public void onConnect(org.glassfish.grizzly.websockets.WebSocket gWebSocket) { - ahcListener.onOpen(webSocket); - } - - @Override - public void onMessage(org.glassfish.grizzly.websockets.WebSocket webSocket, String s) { - if (WebSocketTextListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketTextListener.class.cast(ahcListener).onMessage(s); - } - } - - @Override - public void onMessage(org.glassfish.grizzly.websockets.WebSocket webSocket, byte[] bytes) { - if (WebSocketByteListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketByteListener.class.cast(ahcListener).onMessage(bytes); - } - } - - @Override - public void onPing(org.glassfish.grizzly.websockets.WebSocket webSocket, byte[] bytes) { - if (WebSocketPingListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketPingListener.class.cast(ahcListener).onPing(bytes); - } - } - - @Override - public void onPong(org.glassfish.grizzly.websockets.WebSocket webSocket, byte[] bytes) { - if (WebSocketPongListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketPongListener.class.cast(ahcListener).onPong(bytes); - } - } - - @Override - public void onFragment(org.glassfish.grizzly.websockets.WebSocket webSocket, String s, boolean b) { - if (WebSocketTextListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketTextListener.class.cast(ahcListener).onFragment(s, b); - } - } - - @Override - public void onFragment(org.glassfish.grizzly.websockets.WebSocket webSocket, byte[] bytes, boolean b) { - if (WebSocketByteListener.class.isAssignableFrom(ahcListener.getClass())) { - WebSocketByteListener.class.cast(ahcListener).onFragment(bytes, b); - } - } - - } // END AHCWebSocketListenerAdapter - -} - - - diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProviderConfig.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProviderConfig.java deleted file mode 100644 index 70b7425391..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyAsyncHttpProviderConfig.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHttpProviderConfig; -import org.glassfish.grizzly.nio.transport.TCPNIOTransport; - -import java.util.HashMap; -import java.util.Map; -import java.util.Set; - -/** - * {@link AsyncHttpProviderConfig} implementation that allows customization - * of the Grizzly runtime outside of the scope of what the - * {@link com.ning.http.client.AsyncHttpClientConfig} offers. - * - * @see Property - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyAsyncHttpProviderConfig implements AsyncHttpProviderConfig { - - /** - * Grizzly-specific customization properties. Each property describes - * what it's used for, what the default value is (if any), and what - * the expected type the value of the property should be. - */ - public static enum Property { - - /** - * If this property is specified with a custom {@link TransportCustomizer} - * instance, the {@link TCPNIOTransport} instance that is created by - * {@link GrizzlyAsyncHttpProvider} will be passed to the customizer - * bypassing all default configuration of the transport typically performed - * by the provider. The type of the value associated with this property - * must be TransportCustomizer.class. - * - * @see TransportCustomizer - */ - TRANSPORT_CUSTOMIZER(TransportCustomizer.class); - - - final Object defaultValue; - final Class type; - - private Property(final Class type, final Object defaultValue) { - this.type = type; - this.defaultValue = defaultValue; - } - - private Property(final Class type) { - this(type, null); - } - - boolean hasDefaultValue() { - return (defaultValue != null); - } - - - } // END PROPERTY - - private final Map attributes = new HashMap(); - - // ------------------------------------ Methods from AsyncHttpProviderConfig - - /** - * {@inheritDoc} - * - * @throws IllegalArgumentException if the type of the specified value - * does not match the expected type of the specified {@link Property}. - */ - @Override - public AsyncHttpProviderConfig addProperty(Property name, Object value) { - if (name == null) { - return this; - } - if (value == null) { - if (name.hasDefaultValue()) { - value = name.defaultValue; - } else { - return this; - } - } else { - if (!name.type.isAssignableFrom(value.getClass())) { - throw new IllegalArgumentException( - String.format( - "The value of property [%s] must be of type [%s]. Type of value provided: [%s].", - name.name(), - name.type.getName(), - value.getClass().getName())); - } - } - attributes.put(name, value); - return this; - } - - /** - * {@inheritDoc} - */ - @Override - public Object getProperty(Property name) { - Object ret = attributes.get(name); - if (ret == null) { - if (name.hasDefaultValue()) { - ret = name.defaultValue; - } - } - return ret; - } - - /** - * {@inheritDoc} - */ - @Override - public Object removeProperty(Property name) { - if (name == null) { - return null; - } - return attributes.remove(name); - } - - /** - * {@inheritDoc} - */ - @Override - public Set> propertiesSet() { - return attributes.entrySet(); - } - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyConnectionsPool.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyConnectionsPool.java deleted file mode 100644 index e3478e5769..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyConnectionsPool.java +++ /dev/null @@ -1,469 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ConnectionsPool; - -import org.glassfish.grizzly.Connection; -import org.glassfish.grizzly.Grizzly; -import org.glassfish.grizzly.attributes.Attribute; -import org.glassfish.grizzly.attributes.NullaryFunction; -import org.glassfish.grizzly.utils.DataStructures; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.util.Iterator; -import java.util.Map; -import java.util.concurrent.BlockingQueue; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ConcurrentLinkedQueue; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; - -/** - * {@link ConnectionsPool} implementation. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyConnectionsPool implements ConnectionsPool { - - private final static Logger LOG = LoggerFactory.getLogger(GrizzlyConnectionsPool.class); - - private final ConcurrentHashMap connectionsPool = - new ConcurrentHashMap(); - private final AtomicBoolean closed = new AtomicBoolean(false); - private final AtomicInteger totalCachedConnections = new AtomicInteger(0); - private final boolean cacheSSLConnections; - private final int maxConnectionsPerHost; - private final int maxConnections; - private final boolean unlimitedConnections; - private final long timeout; - private final DelayedExecutor delayedExecutor; - private final Connection.CloseListener listener; - - - // ------------------------------------------------------------ Constructors - - - public GrizzlyConnectionsPool(final AsyncHttpClientConfig config) { - - cacheSSLConnections = config.isSslConnectionPoolEnabled(); - timeout = config.getIdleConnectionInPoolTimeoutInMs(); - maxConnectionsPerHost = config.getMaxConnectionPerHost(); - maxConnections = config.getMaxTotalConnections(); - unlimitedConnections = (maxConnections == -1); - delayedExecutor = new DelayedExecutor(Executors.newSingleThreadExecutor()); - delayedExecutor.start(); - listener = new Connection.CloseListener() { - @Override - public void onClosed(Connection connection, Connection.CloseType closeType) throws IOException { - if (closeType == Connection.CloseType.REMOTELY) { - if (LOG.isInfoEnabled()) { - LOG.info("Remote closed connection ({}). Removing from cache", connection.toString()); - } - } - GrizzlyConnectionsPool.this.removeAll(connection); - } - }; - - } - - - // -------------------------------------------- Methods from ConnectionsPool - - - /** - * {@inheritDoc} - */ - public boolean offer(String uri, Connection connection) { - - if (cacheSSLConnections && isSecure(uri)) { - return false; - } - - DelayedExecutor.IdleConnectionQueue conQueue = connectionsPool.get(uri); - if (conQueue == null) { - if (LOG.isDebugEnabled()) { - LOG.debug("Creating new Connection queue for uri [{}] and connection [{}]", - new Object[]{uri, connection}); - } - DelayedExecutor.IdleConnectionQueue newPool = - delayedExecutor.createIdleConnectionQueue(timeout); - conQueue = connectionsPool.putIfAbsent(uri, newPool); - if (conQueue == null) { - conQueue = newPool; - } - } - - final int size = conQueue.size(); - if (maxConnectionsPerHost == -1 || size < maxConnectionsPerHost) { - conQueue.offer(connection); - connection.addCloseListener(listener); - final int total = totalCachedConnections.incrementAndGet(); - if (LOG.isDebugEnabled()) { - LOG.debug("[offer] Pooling connection [{}] for uri [{}]. Current size (for host; before pooling): [{}]. Max size (for host): [{}]. Total number of cached connections: [{}].", - new Object[]{connection, uri, size, maxConnectionsPerHost, total}); - } - return true; - } - if (LOG.isDebugEnabled()) { - LOG.debug("[offer] Unable to pool connection [{}] for uri [{}]. Current size (for host): [{}]. Max size (for host): [{}]. Total number of cached connections: [{}].", - new Object[]{connection, uri, size, maxConnectionsPerHost, totalCachedConnections.get()}); - } - - return false; - } - - - /** - * {@inheritDoc} - */ - public Connection poll(String uri) { - - if (!cacheSSLConnections && isSecure(uri)) { - return null; - } - - Connection connection = null; - DelayedExecutor.IdleConnectionQueue conQueue = connectionsPool.get(uri); - if (conQueue != null) { - boolean poolEmpty = false; - while (!poolEmpty && connection == null) { - if (!conQueue.isEmpty()) { - connection = conQueue.poll(); - } - - if (connection == null) { - poolEmpty = true; - } else if (!connection.isOpen()) { - removeAll(connection); - connection = null; - } - } - } else { - if (LOG.isDebugEnabled()) { - LOG.debug("[poll] No existing queue for uri [{}].", - new Object[]{uri}); - } - } - if (connection != null) { - if (LOG.isDebugEnabled()) { - LOG.debug("[poll] Found pooled connection [{}] for uri [{}].", - new Object[]{connection, uri}); - } - totalCachedConnections.decrementAndGet(); - connection.removeCloseListener(listener); - } - return connection; - - } - - - /** - * {@inheritDoc} - */ - public boolean removeAll(Connection connection) { - - if (connection == null || closed.get()) { - return false; - } - connection.removeCloseListener(listener); - boolean isRemoved = false; - for (Map.Entry entry : connectionsPool.entrySet()) { - boolean removed = entry.getValue().remove(connection); - isRemoved |= removed; - } - return isRemoved; - - } - - - /** - * {@inheritDoc} - */ - public boolean canCacheConnection() { - - return !(!closed.get() - && !unlimitedConnections - && totalCachedConnections.get() >= maxConnections); - - } - - /** - * {@inheritDoc} - */ - public void destroy() { - - if (closed.getAndSet(true)) { - return; - } - - for (Map.Entry entry : connectionsPool.entrySet()) { - entry.getValue().destroy(); - } - connectionsPool.clear(); - delayedExecutor.stop(); - delayedExecutor.getThreadPool().shutdownNow(); - - } - - - // --------------------------------------------------------- Private Methods - - - private boolean isSecure(String uri) { - - return (uri.charAt(0) == 'h' && uri.charAt(4) == 's'); - - } - - - // ---------------------------------------------------------- Nested Classes - - - private static final class DelayedExecutor { - - public final static long UNSET_TIMEOUT = -1; - private final ExecutorService threadPool; - private final DelayedRunnable runnable = new DelayedRunnable(); - private final BlockingQueue queues = - DataStructures.getLTQInstance(IdleConnectionQueue.class); - private final Object sync = new Object(); - private volatile boolean isStarted; - private final long checkIntervalMs; - - - // -------------------------------------------------------- Constructors - - - private DelayedExecutor(final ExecutorService threadPool) { - this(threadPool, 1000, TimeUnit.MILLISECONDS); - } - - - // ----------------------------------------------------- Private Methods - - private DelayedExecutor(final ExecutorService threadPool, - final long checkInterval, - final TimeUnit timeunit) { - this.threadPool = threadPool; - this.checkIntervalMs = TimeUnit.MILLISECONDS.convert(checkInterval, timeunit); - } - - private void start() { - synchronized (sync) { - if (!isStarted) { - isStarted = true; - threadPool.execute(runnable); - } - } - } - - private void stop() { - synchronized (sync) { - if (isStarted) { - isStarted = false; - sync.notify(); - } - } - } - - private ExecutorService getThreadPool() { - return threadPool; - } - - private IdleConnectionQueue createIdleConnectionQueue(final long timeout) { - final IdleConnectionQueue queue = new IdleConnectionQueue(timeout); - queues.add(queue); - return queue; - } - - @SuppressWarnings({"NumberEquality"}) - private static boolean wasModified(final Long l1, final Long l2) { - return l1 != l2 && (l1 != null ? !l1.equals(l2) : !l2.equals(l1)); - } - - - // ------------------------------------------------------- Inner Classes - - - private class DelayedRunnable implements Runnable { - - @SuppressWarnings("unchecked") - @Override - public void run() { - while (isStarted) { - final long currentTimeMs = System.currentTimeMillis(); - - for (final IdleConnectionQueue delayQueue : queues) { - if (delayQueue.queue.isEmpty()) continue; - - final TimeoutResolver resolver = delayQueue.resolver; - - for (Iterator it = delayQueue.queue.iterator(); it.hasNext(); ) { - final Connection element = it.next(); - final Long timeoutMs = resolver.getTimeoutMs(element); - - if (timeoutMs == null || timeoutMs == UNSET_TIMEOUT) { - it.remove(); - if (wasModified(timeoutMs, - resolver.getTimeoutMs(element))) { - delayQueue.queue.offer(element); - } - } else if (currentTimeMs - timeoutMs >= 0) { - it.remove(); - if (wasModified(timeoutMs, - resolver.getTimeoutMs(element))) { - delayQueue.queue.offer(element); - } else { - try { - if (LOG.isDebugEnabled()) { - LOG.debug("Idle connection ({}) detected. Removing from cache.", element.toString()); - } - element.close().markForRecycle(true); - } catch (Exception ignored) { - } - } - } - } - } - - synchronized (sync) { - if (!isStarted) return; - - try { - sync.wait(checkIntervalMs); - } catch (InterruptedException ignored) { - } - } - } - } - - } // END DelayedRunnable - - - final class IdleConnectionQueue { - final ConcurrentLinkedQueue queue = - new ConcurrentLinkedQueue(); - - - final TimeoutResolver resolver = new TimeoutResolver(); - final long timeout; - final AtomicInteger count = new AtomicInteger(0); - - // ---------------------------------------------------- Constructors - - - public IdleConnectionQueue(final long timeout) { - this.timeout = timeout; - } - - - // ------------------------------------------------- Private Methods - - - void offer(final Connection c) { - if (timeout >= 0) { - resolver.setTimeoutMs(c, System.currentTimeMillis() + timeout); - } - queue.offer(c); - count.incrementAndGet(); - } - - Connection poll() { - count.decrementAndGet(); - return queue.poll(); - } - - boolean remove(final Connection c) { - if (timeout >= 0) { - resolver.removeTimeout(c); - - } - count.decrementAndGet(); - return queue.remove(c); - } - - int size() { - return count.get(); - } - - boolean isEmpty() { - return (count.get() == 0); - } - - void destroy() { - for (Connection c : queue) { - c.close().markForRecycle(true); - } - queue.clear(); - queues.remove(this); - } - - } // END IdleConnectionQueue - - - // ------------------------------------------------------ Nested Classes - - - static final class TimeoutResolver { - - private static final String IDLE_ATTRIBUTE_NAME = "grizzly-ahc-conn-pool-idle-attribute"; - private static final Attribute IDLE_ATTR = - Grizzly.DEFAULT_ATTRIBUTE_BUILDER.createAttribute( - IDLE_ATTRIBUTE_NAME, new NullaryFunction() { - - @Override - public IdleRecord evaluate() { - return new IdleRecord(); - } - }); - - - // ------------------------------------------------- Private Methods - - - boolean removeTimeout(final Connection c) { - IDLE_ATTR.get(c).timeoutMs = 0; - return true; - } - - Long getTimeoutMs(final Connection c) { - return IDLE_ATTR.get(c).timeoutMs; - } - - void setTimeoutMs(final Connection c, final long timeoutMs) { - IDLE_ATTR.get(c).timeoutMs = timeoutMs; - } - - - // -------------------------------------------------- Nested Classes - - static final class IdleRecord { - - volatile long timeoutMs; - - } // END IdleRecord - - } // END TimeoutResolver - - } // END DelayedExecutor - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponse.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponse.java deleted file mode 100644 index 8d803efff4..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponse.java +++ /dev/null @@ -1,339 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import com.ning.http.util.AsyncHttpProviderUtils; - -import org.glassfish.grizzly.Buffer; -import org.glassfish.grizzly.http.CookiesBuilder; -import org.glassfish.grizzly.utils.Charsets; -import org.glassfish.grizzly.memory.Buffers; -import org.glassfish.grizzly.memory.MemoryManager; -import org.glassfish.grizzly.utils.BufferInputStream; - -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.nio.charset.Charset; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; - -/** - * {@link com.ning.http.client.HttpResponseBodyPart} implementation using the Grizzly 2.0 HTTP client - * codec. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyResponse implements Response { - - private final HttpResponseStatus status; - private final HttpResponseHeaders headers; - private final Collection bodyParts; - private final Buffer responseBody; - - private List cookies; - - - // ------------------------------------------------------------ Constructors - - - public GrizzlyResponse(final HttpResponseStatus status, - final HttpResponseHeaders headers, - final Collection bodyParts) { - - this.status = status; - this.headers = headers; - this.bodyParts = bodyParts; - - if (bodyParts != null && !bodyParts.isEmpty()) { - HttpResponseBodyPart[] parts = - bodyParts.toArray(new HttpResponseBodyPart[bodyParts.size()]); - if (parts.length == 1) { - responseBody = ((GrizzlyResponseBodyPart) parts[0]).getBodyBuffer(); - } else { - final Buffer firstBuffer = ((GrizzlyResponseBodyPart) parts[0]).getBodyBuffer(); - final MemoryManager mm = MemoryManager.DEFAULT_MEMORY_MANAGER; - Buffer constructedBodyBuffer = firstBuffer; - for (int i = 1, len = parts.length; i < len; i++) { - constructedBodyBuffer = - Buffers.appendBuffers(mm, - constructedBodyBuffer, - ((GrizzlyResponseBodyPart) parts[i]).getBodyBuffer()); - } - responseBody = constructedBodyBuffer; - } - } else { - responseBody = Buffers.EMPTY_BUFFER; - } - - } - - - // --------------------------------------------------- Methods from Response - - - /** - * {@inheritDoc} - */ - public int getStatusCode() { - - return status.getStatusCode(); - - } - - - /** - * {@inheritDoc} - */ - public String getStatusText() { - - return status.getStatusText(); - - } - - - /** - * {@inheritDoc} - */ - public InputStream getResponseBodyAsStream() throws IOException { - - return new BufferInputStream(responseBody); - - } - - - /** - * {@inheritDoc} - */ - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException { - - final int len = Math.min(responseBody.remaining(), maxLength); - final int pos = responseBody.position(); - return responseBody.toStringContent(getCharset(charset), pos, len + pos); - - } - - - /** - * {@inheritDoc} - */ - public String getResponseBody(String charset) throws IOException { - - return responseBody.toStringContent(getCharset(charset)); - - } - - - /** - * {@inheritDoc} - */ - public String getResponseBodyExcerpt(int maxLength) throws IOException { - - // TODO FIX NULL - return getResponseBodyExcerpt(maxLength, null); - - } - - - /** - * {@inheritDoc} - */ - public String getResponseBody() throws IOException { - - return getResponseBody(Charsets.DEFAULT_CHARACTER_ENCODING); - - } - - - /** - * {@inheritDoc} - */ - public byte[] getResponseBodyAsBytes() throws IOException { - - return getResponseBody().getBytes(Charsets.DEFAULT_CHARACTER_ENCODING); - - } - - - /** - * {@inheritDoc} - */ - public URI getUri() throws MalformedURLException { - - return status.getUrl(); - - } - - - /** - * {@inheritDoc} - */ - public String getContentType() { - - return headers.getHeaders().getFirstValue("Content-Type"); - - } - - - /** - * {@inheritDoc} - */ - public String getHeader(String name) { - - return headers.getHeaders().getFirstValue(name); - - } - - - /** - * {@inheritDoc} - */ - public List getHeaders(String name) { - - return headers.getHeaders().get(name); - - } - - - /** - * {@inheritDoc} - */ - public FluentCaseInsensitiveStringsMap getHeaders() { - - return headers.getHeaders(); - - } - - - /** - * {@inheritDoc} - */ - public boolean isRedirected() { - - return between(status.getStatusCode(), 300, 399); - - } - - - /** - * {@inheritDoc} - */ - public List getCookies() { - - if (headers == null) { - return Collections.emptyList(); - } - - if (cookies == null) { - List values = headers.getHeaders().get("set-cookie"); - if (values != null && !values.isEmpty()) { - CookiesBuilder.ServerCookiesBuilder builder = - new CookiesBuilder.ServerCookiesBuilder(false); - for (String header : values) { - builder.parse(header); - } - cookies = convertCookies(builder.build()); - - } else { - cookies = Collections.unmodifiableList(Collections.emptyList()); - } - } - return cookies; - - } - - - /** - * {@inheritDoc} - */ - public boolean hasResponseStatus() { - return (status != null); - } - - - /** - * {@inheritDoc} - */ - public boolean hasResponseHeaders() { - return (headers != null && !headers.getHeaders().isEmpty()); - } - - - /** - * {@inheritDoc} - */ - public boolean hasResponseBody() { - return (bodyParts != null && !bodyParts.isEmpty()); - } - - - // --------------------------------------------------------- Private Methods - - - private List convertCookies(final List grizzlyCookies) { - - List cookies = new ArrayList(grizzlyCookies.size()); - for (org.glassfish.grizzly.http.Cookie gCookie : grizzlyCookies) { - cookies.add(new Cookie(gCookie.getDomain(), - gCookie.getName(), - gCookie.getValue(), - gCookie.getPath(), - gCookie.getMaxAge(), - gCookie.isSecure(), - gCookie.getVersion())); - } - return Collections.unmodifiableList(cookies); - - } - - - private Charset getCharset(final String charset) { - - String charsetLocal = charset; - - if (charsetLocal == null) { - String contentType = getContentType(); - if (contentType != null) { - charsetLocal = AsyncHttpProviderUtils.parseCharset(contentType); - } - } - - if (charsetLocal == null) { - charsetLocal = Charsets.DEFAULT_CHARACTER_ENCODING; - } - - return Charsets.lookupCharset(charsetLocal); - - } - - - private boolean between(final int value, - final int lowerBound, - final int upperBound) { - - return (value >= lowerBound && value <= upperBound); - - } - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseBodyPart.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseBodyPart.java deleted file mode 100644 index 4692cfe071..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseBodyPart.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseBodyPart; - -import org.glassfish.grizzly.Buffer; -import org.glassfish.grizzly.Connection; -import org.glassfish.grizzly.http.HttpContent; - -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.nio.ByteBuffer; -import java.util.concurrent.atomic.AtomicReference; - -import static com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider.ConnectionManager.*; - -/** - * {@link HttpResponseBodyPart} implementation using the Grizzly 2.0 HTTP client - * codec. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyResponseBodyPart extends HttpResponseBodyPart { - - private final HttpContent content; - private final Connection connection; - private final AtomicReference contentBytes = - new AtomicReference(); - - - // ------------------------------------------------------------ Constructors - - - public GrizzlyResponseBodyPart(final HttpContent content, - final URI uri, - final Connection connection, - final AsyncHttpProvider provider) { - super(uri, provider); - this.content = content; - this.connection = connection; - - } - - - // --------------------------------------- Methods from HttpResponseBodyPart - - - /** - * {@inheritDoc} - */ - @Override - public byte[] getBodyPartBytes() { - - byte[] bytes = contentBytes.get(); - if (bytes != null) { - return bytes; - } - final Buffer b = content.getContent(); - final int origPos = b.position(); - bytes = new byte[b.remaining()]; - b.get(bytes); - b.flip(); - b.position(origPos); - contentBytes.compareAndSet(null, bytes); - return bytes; - - } - - - /** - * {@inheritDoc} - */ - @Override - public int writeTo(OutputStream outputStream) throws IOException { - - final byte[] bytes = getBodyPartBytes(); - outputStream.write(getBodyPartBytes()); - return bytes.length; - - } - - - /** - * {@inheritDoc} - */ - @Override - public ByteBuffer getBodyByteBuffer() { - - return ByteBuffer.wrap(getBodyPartBytes()); - - } - - /** - * {@inheritDoc} - */ - @Override - public boolean isLast() { - return content.isLast(); - } - - /** - * {@inheritDoc} - */ - @Override - public void markUnderlyingConnectionAsClosed() { - markConnectionAsDoNotCache(connection); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean closeUnderlyingConnection() { - return !isConnectionCacheable(connection); - } - - - // ----------------------------------------------- Package Protected Methods - - - Buffer getBodyBuffer() { - - return content.getContent(); - - } - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseFuture.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseFuture.java deleted file mode 100644 index 239b677206..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseFuture.java +++ /dev/null @@ -1,191 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.Request; -import com.ning.http.client.listenable.AbstractListenableFuture; - -import org.glassfish.grizzly.Connection; -import org.glassfish.grizzly.impl.FutureImpl; - -import java.io.IOException; -import java.util.concurrent.Callable; -import java.util.concurrent.CancellationException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicBoolean; - -/** - * {@link AbstractListenableFuture} implementation adaptation of Grizzly's - * {@link FutureImpl}. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyResponseFuture extends AbstractListenableFuture { - - private final AtomicBoolean done = new AtomicBoolean(false); - private final AsyncHandler handler; - private final GrizzlyAsyncHttpProvider provider; - private final Request request; - - private Connection connection; - - FutureImpl delegate; - - - // ------------------------------------------------------------ Constructors - - - GrizzlyResponseFuture(final GrizzlyAsyncHttpProvider provider, - final Request request, - final AsyncHandler handler) { - - this.provider = provider; - this.request = request; - this.handler = handler; - - } - - - // ----------------------------------- Methods from AbstractListenableFuture - - - public void done(Callable callable) { - - done.compareAndSet(false, true); - super.done(); - - } - - - public void abort(Throwable t) { - - delegate.failure(t); - if (handler != null) { - handler.onThrowable(t); - } - closeConnection(); - done(); - - } - - - public void content(V v) { - - delegate.result(v); - - } - - - public void touch() { - - provider.touchConnection(connection, request); - - } - - - public boolean getAndSetWriteHeaders(boolean writeHeaders) { - - // TODO This doesn't currently do anything - and may not make sense - // with our implementation. Needs further analysis. - return writeHeaders; - - } - - - public boolean getAndSetWriteBody(boolean writeBody) { - - // TODO This doesn't currently do anything - and may not make sense - // with our implementation. Needs further analysis. - return writeBody; - - } - - - // ----------------------------------------------------- Methods from Future - - - public boolean cancel(boolean mayInterruptIfRunning) { - - handler.onThrowable(new CancellationException()); - done(); - return delegate.cancel(mayInterruptIfRunning); - - } - - - public boolean isCancelled() { - - return delegate.isCancelled(); - - } - - - public boolean isDone() { - - return delegate.isDone(); - - } - - - public V get() throws InterruptedException, ExecutionException { - - return delegate.get(); - - } - - - public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { - - if (!delegate.isCancelled() || !delegate.isDone()) { - return delegate.get(timeout, unit); - } else { - return null; - } - - } - - - // ------------------------------------------------- Package Private Methods - - - void setConnection(final Connection connection) { - - this.connection = connection; - - } - - - void setDelegate(final FutureImpl delegate) { - - this.delegate = delegate; - - } - - - // --------------------------------------------------------- Private Methods - - - private void closeConnection() { - - if (connection != null && !connection.isOpen()) { - connection.close().markForRecycle(true); - } - - } - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseHeaders.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseHeaders.java deleted file mode 100644 index 03e175f1ab..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseHeaders.java +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseHeaders; - -import org.glassfish.grizzly.http.HttpResponsePacket; -import org.glassfish.grizzly.http.util.MimeHeaders; - -import java.net.URI; - - -/** - * {@link HttpResponseHeaders} implementation using the Grizzly 2.0 HTTP client - * codec. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyResponseHeaders extends HttpResponseHeaders { - - private final FluentCaseInsensitiveStringsMap headers = - new FluentCaseInsensitiveStringsMap(); - private final HttpResponsePacket response; - private volatile boolean initialized; - - // ------------------------------------------------------------ Constructors - - - public GrizzlyResponseHeaders(final HttpResponsePacket response, - final URI uri, - final AsyncHttpProvider provider) { - - super(uri, provider); - this.response = response; - - } - - - // ---------------------------------------- Methods from HttpResponseHeaders - - - /** - * {@inheritDoc} - */ - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - if (!initialized) { - synchronized (headers) { - if (!initialized) { - initialized = true; - final MimeHeaders headersLocal = response.getHeaders(); - for (String name : headersLocal.names()) { - for (String header : headersLocal.values(name)) { - headers.add(name, header); - } - } - } - } - } - return headers; - } - - - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseStatus.java b/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseStatus.java deleted file mode 100644 index 2f25d35d6c..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/GrizzlyResponseStatus.java +++ /dev/null @@ -1,114 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseStatus; - -import org.glassfish.grizzly.http.HttpResponsePacket; - -import java.net.URI; - -/** - * {@link HttpResponseStatus} implementation using the Grizzly 2.0 HTTP client - * codec. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public class GrizzlyResponseStatus extends HttpResponseStatus { - - private final HttpResponsePacket response; - - - // ------------------------------------------------------------ Constructors - - - public GrizzlyResponseStatus(final HttpResponsePacket response, - final URI uri, - final AsyncHttpProvider provider) { - - super(uri, provider); - this.response = response; - - } - - - // ----------------------------------------- Methods from HttpResponseStatus - - - /** - * {@inheritDoc} - */ - @Override - public int getStatusCode() { - - return response.getStatus(); - - } - - - /** - * {@inheritDoc} - */ - @Override - public String getStatusText() { - - return response.getReasonPhrase(); - - } - - - /** - * {@inheritDoc} - */ - @Override - public String getProtocolName() { - - return "http"; - - } - - - /** - * {@inheritDoc} - */ - @Override - public int getProtocolMajorVersion() { - - return response.getProtocol().getMajorVersion(); - - } - - - /** - * {@inheritDoc} - */ - @Override - public int getProtocolMinorVersion() { - - return response.getProtocol().getMinorVersion(); - - } - - - /** - * {@inheritDoc} - */ - @Override - public String getProtocolText() { - return response.getProtocolString(); - } - -} diff --git a/src/main/java/com/ning/http/client/providers/grizzly/TransportCustomizer.java b/src/main/java/com/ning/http/client/providers/grizzly/TransportCustomizer.java deleted file mode 100644 index 504fcc42dd..0000000000 --- a/src/main/java/com/ning/http/client/providers/grizzly/TransportCustomizer.java +++ /dev/null @@ -1,44 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.grizzly; - -import org.glassfish.grizzly.filterchain.FilterChainBuilder; -import org.glassfish.grizzly.nio.transport.TCPNIOTransport; - -/** - * This class may be provided as an option to the {@link GrizzlyAsyncHttpProviderConfig} - * and allows low-level customization of the {@link TCPNIOTransport} beyond the - * defaults typically used. - * - * @author The Grizzly Team - * @since 1.7.0 - */ -public interface TransportCustomizer { - - /** - * Customizes the configuration of the provided {@link TCPNIOTransport} - * and {@link FilterChainBuilder} instances. - * - * @param transport the {@link TCPNIOTransport} instance for this client. - * @param filterChainBuilder the {@link FilterChainBuilder} that will - * produce the {@link org.glassfish.grizzly.filterchain.FilterChain} that - * will be used to send/receive data. The FilterChain will be populated - * with the Filters typically used for processing HTTP client requests. - * These filters should generally be left alone. But this does allow - * adding additional filters to the chain to add additional features. - */ - void customize(final TCPNIOTransport transport, - final FilterChainBuilder filterChainBuilder); - -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProvider.java b/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProvider.java deleted file mode 100644 index 37c8af7748..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProvider.java +++ /dev/null @@ -1,749 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.Body; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.MaxRedirectException; -import com.ning.http.client.PerRequestConfig; -import com.ning.http.client.ProgressAsyncHandler; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Realm; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.IOExceptionFilter; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.client.listener.TransferCompletionHandler; -import com.ning.http.multipart.MultipartRequestEntity; -import com.ning.http.util.AsyncHttpProviderUtils; -import com.ning.http.util.AuthenticatorUtils; -import com.ning.http.util.ProxyUtils; -import com.ning.http.util.SslUtils; -import com.ning.http.util.UTF8UrlEncoder; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.naming.AuthenticationException; -import javax.net.ssl.HttpsURLConnection; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLHandshakeException; -import java.io.ByteArrayInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.lang.reflect.Field; -import java.net.Authenticator; -import java.net.ConnectException; -import java.net.HttpURLConnection; -import java.net.InetSocketAddress; -import java.net.PasswordAuthentication; -import java.net.Proxy; -import java.net.SocketAddress; -import java.net.SocketTimeoutException; -import java.net.URI; -import java.net.UnknownHostException; -import java.nio.ByteBuffer; -import java.security.GeneralSecurityException; -import java.security.NoSuchAlgorithmException; -import java.util.Collection; -import java.util.List; -import java.util.Map; -import java.util.concurrent.Callable; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.zip.GZIPInputStream; - -import static com.ning.http.util.AsyncHttpProviderUtils.DEFAULT_CHARSET; - -public class JDKAsyncHttpProvider implements AsyncHttpProvider { - private final static Logger logger = LoggerFactory.getLogger(JDKAsyncHttpProvider.class); - - private final static String NTLM_DOMAIN = "http.auth.ntlm.domain"; - - private final AsyncHttpClientConfig config; - - private final AtomicBoolean isClose = new AtomicBoolean(false); - - private final static int MAX_BUFFERED_BYTES = 8192; - - private final AtomicInteger maxConnections = new AtomicInteger(); - - private String jdkNtlmDomain; - - private Authenticator jdkAuthenticator; - - private boolean bufferResponseInMemory = false; - - public JDKAsyncHttpProvider(AsyncHttpClientConfig config) { - - this.config = config; - AsyncHttpProviderConfig providerConfig = config.getAsyncHttpProviderConfig(); - if (providerConfig != null && JDKAsyncHttpProviderConfig.class.isAssignableFrom(providerConfig.getClass())) { - configure(JDKAsyncHttpProviderConfig.class.cast(providerConfig)); - } - } - - private void configure(JDKAsyncHttpProviderConfig config) { - for (Map.Entry e : config.propertiesSet()) { - System.setProperty(e.getKey(), e.getValue()); - } - - if (config.getProperty(JDKAsyncHttpProviderConfig.FORCE_RESPONSE_BUFFERING) != null) { - bufferResponseInMemory = true; - } - } - - public ListenableFuture execute(Request request, AsyncHandler handler) throws IOException { - return execute(request, handler, null); - } - - public ListenableFuture execute(Request request, AsyncHandler handler, ListenableFuture future) throws IOException { - if (isClose.get()) { - throw new IOException("Closed"); - } - - if (config.getMaxTotalConnections() > -1 && (maxConnections.get() + 1) > config.getMaxTotalConnections()) { - throw new IOException(String.format("Too many connections %s", config.getMaxTotalConnections())); - } - - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, request); - Proxy proxy = null; - if (!avoidProxy && (proxyServer != null || realm != null)) { - try { - proxy = configureProxyAndAuth(proxyServer, realm); - } catch (AuthenticationException e) { - throw new IOException(e.getMessage()); - } - } - - HttpURLConnection urlConnection = createUrlConnection(request); - - PerRequestConfig conf = request.getPerRequestConfig(); - int requestTimeout = (conf != null && conf.getRequestTimeoutInMs() != 0) ? - conf.getRequestTimeoutInMs() : config.getRequestTimeoutInMs(); - - JDKDelegateFuture delegate = null; - if (future != null) { - delegate = new JDKDelegateFuture(handler, requestTimeout, future, urlConnection); - } - - JDKFuture f = delegate == null ? new JDKFuture(handler, requestTimeout, urlConnection) : delegate; - f.touch(); - - f.setInnerFuture(config.executorService().submit(new AsyncHttpUrlConnection(urlConnection, request, handler, f))); - maxConnections.incrementAndGet(); - - return f; - } - - private HttpURLConnection createUrlConnection(Request request) throws IOException { - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, request); - Proxy proxy = null; - if (!avoidProxy && proxyServer != null || realm != null) { - try { - proxy = configureProxyAndAuth(proxyServer, realm); - } catch (AuthenticationException e) { - throw new IOException(e.getMessage()); - } - } - - HttpURLConnection urlConnection = null; - if (proxy == null) { - urlConnection = - (HttpURLConnection) AsyncHttpProviderUtils.createUri(request.getUrl()).toURL().openConnection(Proxy.NO_PROXY); - } else { - urlConnection = (HttpURLConnection) AsyncHttpProviderUtils.createUri(request.getUrl()).toURL().openConnection(proxy); - } - - if (request.getUrl().startsWith("https")) { - HttpsURLConnection secure = (HttpsURLConnection) urlConnection; - SSLContext sslContext = config.getSSLContext(); - if (sslContext == null) { - try { - sslContext = SslUtils.getSSLContext(); - } catch (NoSuchAlgorithmException e) { - throw new IOException(e.getMessage()); - } catch (GeneralSecurityException e) { - throw new IOException(e.getMessage()); - } - } - secure.setSSLSocketFactory(sslContext.getSocketFactory()); - secure.setHostnameVerifier(config.getHostnameVerifier()); - } - return urlConnection; - } - - public void close() { - isClose.set(true); - } - - public Response prepareResponse(HttpResponseStatus status, HttpResponseHeaders headers, Collection bodyParts) { - return new JDKResponse(status, headers, bodyParts); - } - - private final class AsyncHttpUrlConnection implements Callable { - - private HttpURLConnection urlConnection; - private Request request; - private final AsyncHandler asyncHandler; - private final ListenableFuture future; - private int currentRedirectCount; - private AtomicBoolean isAuth = new AtomicBoolean(false); - private byte[] cachedBytes; - private int cachedBytesLenght; - private boolean terminate = true; - - public AsyncHttpUrlConnection(HttpURLConnection urlConnection, Request request, AsyncHandler asyncHandler, ListenableFuture future) { - this.urlConnection = urlConnection; - this.request = request; - this.asyncHandler = asyncHandler; - this.future = future; - this.request = request; - } - - public T call() throws Exception { - AsyncHandler.STATE state = AsyncHandler.STATE.ABORT; - try { - URI uri = null; - // Encoding with URLConnection is a bit bogus so we need to try both way before setting it - try { - uri = AsyncHttpProviderUtils.createUri(request.getRawUrl()); - } catch (IllegalArgumentException u) { - uri = AsyncHttpProviderUtils.createUri(request.getUrl()); - } - - configure(uri, urlConnection, request); - urlConnection.connect(); - - if (TransferCompletionHandler.class.isAssignableFrom(asyncHandler.getClass())) { - throw new IllegalStateException(TransferCompletionHandler.class.getName() + "not supported by this provider"); - } - - int statusCode = urlConnection.getResponseCode(); - - logger.debug("\n\nRequest {}\n\nResponse {}\n", request, statusCode); - - ResponseStatus status = new ResponseStatus(uri, urlConnection, JDKAsyncHttpProvider.this); - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(asyncHandler).request(request).responseStatus(status).build(); - for (ResponseFilter asyncFilter : config.getResponseFilters()) { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } - - // The request has changed - if (fc.replayRequest()) { - request = fc.getRequest(); - urlConnection = createUrlConnection(request); - terminate = false; - return call(); - } - - boolean redirectEnabled = (request.isRedirectEnabled() || config.isRedirectEnabled()); - if (redirectEnabled && (statusCode == 302 || statusCode == 301)) { - - if (currentRedirectCount++ < config.getMaxRedirects()) { - String location = urlConnection.getHeaderField("Location"); - URI redirUri = AsyncHttpProviderUtils.getRedirectUri(uri, location); - String newUrl = redirUri.toString(); - - if (!newUrl.equals(uri.toString())) { - RequestBuilder builder = new RequestBuilder(request); - - logger.debug("Redirecting to {}", newUrl); - - request = builder.setUrl(newUrl).build(); - urlConnection = createUrlConnection(request); - terminate = false; - return call(); - } - } else { - throw new MaxRedirectException("Maximum redirect reached: " + config.getMaxRedirects()); - } - } - - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - if (statusCode == 401 && !isAuth.getAndSet(true) && realm != null) { - String wwwAuth = urlConnection.getHeaderField("WWW-Authenticate"); - - logger.debug("Sending authentication to {}", request.getUrl()); - - Realm nr = new Realm.RealmBuilder().clone(realm) - .parseWWWAuthenticateHeader(wwwAuth) - .setUri(URI.create(request.getUrl()).getPath()) - .setMethodName(request.getMethod()) - .setUsePreemptiveAuth(true) - .build(); - RequestBuilder builder = new RequestBuilder(request); - request = builder.setRealm(nr).build(); - urlConnection = createUrlConnection(request); - terminate = false; - return call(); - } - - state = asyncHandler.onStatusReceived(status); - if (state == AsyncHandler.STATE.CONTINUE) { - state = asyncHandler.onHeadersReceived(new ResponseHeaders(uri, urlConnection, JDKAsyncHttpProvider.this)); - } - - if (state == AsyncHandler.STATE.CONTINUE) { - InputStream is = getInputStream(urlConnection); - String contentEncoding = urlConnection.getHeaderField("Content-Encoding"); - boolean isGZipped = contentEncoding == null ? false : "gzip".equalsIgnoreCase(contentEncoding); - if (isGZipped) { - is = new GZIPInputStream(is); - } - - int byteToRead = urlConnection.getContentLength(); - InputStream stream = is; - if (bufferResponseInMemory || byteToRead <= 0) { - int[] lengthWrapper = new int[1]; - byte[] bytes = AsyncHttpProviderUtils.readFully(is, lengthWrapper); - stream = new ByteArrayInputStream(bytes, 0, lengthWrapper[0]); - byteToRead = lengthWrapper[0]; - } - - if (byteToRead > 0) { - int minBytes = Math.min(8192, byteToRead); - byte[] bytes = new byte[minBytes]; - int leftBytes = minBytes < 8192 ? minBytes : byteToRead; - int read = 0; - while (leftBytes > -1) { - - read = stream.read(bytes); - if (read == -1) { - break; - } - - future.touch(); - - byte[] b = new byte[read]; - System.arraycopy(bytes, 0, b, 0, read); - leftBytes -= read; - asyncHandler.onBodyPartReceived(new ResponseBodyPart(uri, b, JDKAsyncHttpProvider.this, leftBytes > -1)); - } - } - - if (request.getMethod().equalsIgnoreCase("HEAD")) { - asyncHandler.onBodyPartReceived(new ResponseBodyPart(uri, "".getBytes(), JDKAsyncHttpProvider.this, true)); - } - } - - if (ProgressAsyncHandler.class.isAssignableFrom(asyncHandler.getClass())) { - ProgressAsyncHandler.class.cast(asyncHandler).onHeaderWriteCompleted(); - ProgressAsyncHandler.class.cast(asyncHandler).onContentWriteCompleted(); - } - try { - T t = asyncHandler.onCompleted(); - future.content(t); - future.done(null); - return t; - } catch (Throwable t) { - RuntimeException ex = new RuntimeException(); - ex.initCause(t); - throw ex; - } - } catch (Throwable t) { - logger.debug(t.getMessage(), t); - - if (IOException.class.isAssignableFrom(t.getClass()) && config.getIOExceptionFilters().size() > 0) { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(asyncHandler) - .request(request).ioException(IOException.class.cast(t)).build(); - - try { - fc = handleIoException(fc); - } catch (FilterException e) { - if (config.getMaxTotalConnections() != -1) { - maxConnections.decrementAndGet(); - } - future.done(null); - } - - if (fc.replayRequest()) { - request = fc.getRequest(); - urlConnection = createUrlConnection(request); - return call(); - } - } - - try { - future.abort(filterException(t)); - } catch (Throwable t2) { - logger.error(t2.getMessage(), t2); - } - } finally { - if (terminate) { - if (config.getMaxTotalConnections() != -1) { - maxConnections.decrementAndGet(); - } - urlConnection.disconnect(); - if (jdkNtlmDomain != null) { - System.setProperty(NTLM_DOMAIN, jdkNtlmDomain); - } - Authenticator.setDefault(jdkAuthenticator); - } - } - return null; - } - - private FilterContext handleIoException(FilterContext fc) throws FilterException { - for (IOExceptionFilter asyncFilter : config.getIOExceptionFilters()) { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } - return fc; - } - - private Throwable filterException(Throwable t) { - if (UnknownHostException.class.isAssignableFrom(t.getClass())) { - t = new ConnectException(t.getMessage()); - } - - if (SocketTimeoutException.class.isAssignableFrom(t.getClass())) { - int responseTimeoutInMs = config.getRequestTimeoutInMs(); - - if (request.getPerRequestConfig() != null && request.getPerRequestConfig().getRequestTimeoutInMs() != -1) { - responseTimeoutInMs = request.getPerRequestConfig().getRequestTimeoutInMs(); - } - t = new TimeoutException(String.format("No response received after %s", responseTimeoutInMs)); - } - - if (SSLHandshakeException.class.isAssignableFrom(t.getClass())) { - Throwable t2 = new ConnectException(); - t2.initCause(t); - t = t2; - } - - return t; - } - - private void configure(URI uri, HttpURLConnection urlConnection, Request request) throws IOException, AuthenticationException { - - PerRequestConfig conf = request.getPerRequestConfig(); - int requestTimeout = (conf != null && conf.getRequestTimeoutInMs() != 0) ? - conf.getRequestTimeoutInMs() : config.getRequestTimeoutInMs(); - - urlConnection.setConnectTimeout(config.getConnectionTimeoutInMs()); - - if (requestTimeout != -1) - urlConnection.setReadTimeout(requestTimeout); - - urlConnection.setInstanceFollowRedirects(false); - String host = uri.getHost(); - String method = request.getMethod(); - - if (request.getVirtualHost() != null) { - host = request.getVirtualHost(); - } - - if (uri.getPort() == -1 || request.getVirtualHost() != null) { - urlConnection.setRequestProperty("Host", host); - } else { - urlConnection.setRequestProperty("Host", host + ":" + uri.getPort()); - } - - - if (config.isCompressionEnabled()) { - urlConnection.setRequestProperty("Accept-Encoding", "gzip"); - } - - if (!method.equalsIgnoreCase("CONNECT")) { - FluentCaseInsensitiveStringsMap h = request.getHeaders(); - if (h != null) { - for (String name : h.keySet()) { - if (!"host".equalsIgnoreCase(name)) { - for (String value : h.get(name)) { - urlConnection.setRequestProperty(name, value); - if (name.equalsIgnoreCase("Expect")) { - throw new IllegalStateException("Expect: 100-Continue not supported"); - } - } - } - } - } - } - - String ka = config.getAllowPoolingConnection() ? "keep-alive" : "close"; - urlConnection.setRequestProperty("Connection", ka); - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, uri.getHost()); - if (!avoidProxy) { - urlConnection.setRequestProperty("Proxy-Connection", ka); - if (proxyServer.getPrincipal() != null) { - urlConnection.setRequestProperty("Proxy-Authorization", AuthenticatorUtils.computeBasicAuthentication(proxyServer)); - } - - if (proxyServer.getProtocol().equals(ProxyServer.Protocol.NTLM)) { - jdkNtlmDomain = System.getProperty(NTLM_DOMAIN); - System.setProperty(NTLM_DOMAIN, proxyServer.getNtlmDomain()); - } - } - - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - if (realm != null && realm.getUsePreemptiveAuth()) { - switch (realm.getAuthScheme()) { - case BASIC: - urlConnection.setRequestProperty("Authorization", - AuthenticatorUtils.computeBasicAuthentication(realm)); - break; - case DIGEST: - if (realm.getNonce() != null && !realm.getNonce().equals("")) { - try { - urlConnection.setRequestProperty("Authorization", - AuthenticatorUtils.computeDigestAuthentication(realm)); - } catch (NoSuchAlgorithmException e) { - throw new SecurityException(e); - } - } - break; - case NTLM: - jdkNtlmDomain = System.getProperty(NTLM_DOMAIN); - System.setProperty(NTLM_DOMAIN, realm.getDomain()); - break; - case NONE: - break; - default: - throw new IllegalStateException(String.format("Invalid Authentication %s", realm.toString())); - } - - } - - // Add default accept headers. - if (request.getHeaders().getFirstValue("Accept") == null) { - urlConnection.setRequestProperty("Accept", "*/*"); - } - - if (request.getHeaders().getFirstValue("User-Agent") != null) { - urlConnection.setRequestProperty("User-Agent", request.getHeaders().getFirstValue("User-Agent")); - } else if (config.getUserAgent() != null) { - urlConnection.setRequestProperty("User-Agent", config.getUserAgent()); - } else { - urlConnection.setRequestProperty("User-Agent", AsyncHttpProviderUtils.constructUserAgent(JDKAsyncHttpProvider.class)); - } - - if (request.getCookies() != null && !request.getCookies().isEmpty()) { - urlConnection.setRequestProperty("Cookie", AsyncHttpProviderUtils.encodeCookies(request.getCookies())); - } - - String reqType = request.getMethod(); - urlConnection.setRequestMethod(reqType); - - if ("POST".equals(reqType) || "PUT".equals(reqType)) { - urlConnection.setRequestProperty("Content-Length", "0"); - urlConnection.setDoOutput(true); - String bodyCharset = request.getBodyEncoding() == null ? DEFAULT_CHARSET : request.getBodyEncoding(); - - if (cachedBytes != null) { - urlConnection.setRequestProperty("Content-Length", String.valueOf(cachedBytesLenght)); - urlConnection.setFixedLengthStreamingMode(cachedBytesLenght); - urlConnection.getOutputStream().write(cachedBytes, 0, cachedBytesLenght); - } else if (request.getByteData() != null) { - urlConnection.setRequestProperty("Content-Length", String.valueOf(request.getByteData().length)); - urlConnection.setFixedLengthStreamingMode(request.getByteData().length); - - urlConnection.getOutputStream().write(request.getByteData()); - } else if (request.getStringData() != null) { - if (!request.getHeaders().containsKey("Content-Type")) { - urlConnection.setRequestProperty("Content-Type", "text/html;" + bodyCharset); - } - byte[] b = request.getStringData().getBytes(bodyCharset); - urlConnection.setRequestProperty("Content-Length", String.valueOf(b.length)); - urlConnection.getOutputStream().write(b); - } else if (request.getStreamData() != null) { - int[] lengthWrapper = new int[1]; - cachedBytes = AsyncHttpProviderUtils.readFully(request.getStreamData(), lengthWrapper); - cachedBytesLenght = lengthWrapper[0]; - urlConnection.setRequestProperty("Content-Length", String.valueOf(cachedBytesLenght)); - urlConnection.setFixedLengthStreamingMode(cachedBytesLenght); - - urlConnection.getOutputStream().write(cachedBytes, 0, cachedBytesLenght); - } else if (request.getParams() != null) { - StringBuilder sb = new StringBuilder(); - for (final Map.Entry> paramEntry : request.getParams()) { - final String key = paramEntry.getKey(); - for (final String value : paramEntry.getValue()) { - if (sb.length() > 0) { - sb.append("&"); - } - UTF8UrlEncoder.appendEncoded(sb, key); - sb.append("="); - UTF8UrlEncoder.appendEncoded(sb, value); - } - } - urlConnection.setRequestProperty("Content-Length", String.valueOf(sb.length())); - urlConnection.setFixedLengthStreamingMode(sb.length()); - - if (!request.getHeaders().containsKey("Content-Type")) { - urlConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); - } - urlConnection.getOutputStream().write(sb.toString().getBytes(bodyCharset)); - } else if (request.getParts() != null) { - int lenght = (int) request.getContentLength(); - if (lenght != -1) { - urlConnection.setRequestProperty("Content-Length", String.valueOf(lenght)); - urlConnection.setFixedLengthStreamingMode(lenght); - } - - if (lenght == -1) { - lenght = MAX_BUFFERED_BYTES; - } - - MultipartRequestEntity mre = AsyncHttpProviderUtils.createMultipartRequestEntity(request.getParts(), request.getParams()); - - urlConnection.setRequestProperty("Content-Type", mre.getContentType()); - urlConnection.setRequestProperty("Content-Length", String.valueOf(mre.getContentLength())); - - mre.writeRequest(urlConnection.getOutputStream()); - } else if (request.getEntityWriter() != null) { - int lenght = (int) request.getContentLength(); - if (lenght != -1) { - urlConnection.setRequestProperty("Content-Length", String.valueOf(lenght)); - urlConnection.setFixedLengthStreamingMode(lenght); - } - request.getEntityWriter().writeEntity(urlConnection.getOutputStream()); - } else if (request.getFile() != null) { - File file = request.getFile(); - if (!file.isFile()) { - throw new IOException(String.format(Thread.currentThread() - + "File %s is not a file or doesn't exist", file.getAbsolutePath())); - } - urlConnection.setRequestProperty("Content-Length", String.valueOf(file.length())); - urlConnection.setFixedLengthStreamingMode((int) file.length()); - - FileInputStream fis = new FileInputStream(file); - try { - OutputStream os = urlConnection.getOutputStream(); - for (final byte[] buffer = new byte[1024 * 16]; ; ) { - int read = fis.read(buffer); - if (read < 0) { - break; - } - os.write(buffer, 0, read); - } - } finally { - fis.close(); - } - } else if (request.getBodyGenerator() != null) { - Body body = request.getBodyGenerator().createBody(); - try { - int length = (int) body.getContentLength(); - if (length < 0) { - length = (int) request.getContentLength(); - } - if (length >= 0) { - urlConnection.setRequestProperty("Content-Length", String.valueOf(length)); - urlConnection.setFixedLengthStreamingMode(length); - } - OutputStream os = urlConnection.getOutputStream(); - for (ByteBuffer buffer = ByteBuffer.allocate(1024 * 8); ; ) { - buffer.clear(); - if (body.read(buffer) < 0) { - break; - } - os.write(buffer.array(), buffer.arrayOffset(), buffer.position()); - } - } finally { - try { - body.close(); - } catch (IOException e) { - logger.warn("Failed to close request body: {}", e.getMessage(), e); - } - } - } - } - } - } - - private Proxy configureProxyAndAuth(final ProxyServer proxyServer, final Realm realm) throws AuthenticationException { - - Proxy proxy = null; - if (proxyServer != null) { - - String proxyHost = proxyServer.getHost().startsWith("http://") - ? proxyServer.getHost().substring("http://".length()) : proxyServer.getHost(); - - SocketAddress addr = new InetSocketAddress(proxyHost, proxyServer.getPort()); - proxy = new Proxy(Proxy.Type.HTTP, addr); - } - - final boolean hasProxy = (proxyServer != null && proxyServer.getPrincipal() != null); - final boolean hasAuthentication = (realm != null && realm.getPrincipal() != null); - if (hasProxy || hasAuthentication) { - - Field f = null; - try { - f = Authenticator.class.getDeclaredField("theAuthenticator"); - - f.setAccessible(true); - jdkAuthenticator = (Authenticator) f.get(Authenticator.class); - } catch (NoSuchFieldException e) { - } catch (IllegalAccessException e) { - } - - - Authenticator.setDefault(new Authenticator() { - protected PasswordAuthentication getPasswordAuthentication() { - if (hasProxy && getRequestingHost().equals(proxyServer.getHost()) - && getRequestingPort() == proxyServer.getPort()) { - String password = ""; - if (proxyServer.getPassword() != null) { - password = proxyServer.getPassword(); - } - return new PasswordAuthentication(proxyServer.getPrincipal(), password.toCharArray()); - } - - if (hasAuthentication) { - return new PasswordAuthentication(realm.getPrincipal(), realm.getPassword().toCharArray()); - } - - return super.getPasswordAuthentication(); - } - }); - } else { - Authenticator.setDefault(null); - } - return proxy; - } - - private InputStream getInputStream(HttpURLConnection urlConnection) throws IOException { - if (urlConnection.getResponseCode() < 400) { - return urlConnection.getInputStream(); - } else { - InputStream ein = urlConnection.getErrorStream(); - return (ein != null) - ? ein : new ByteArrayInputStream(new byte[0]); - } - } - -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProviderConfig.java b/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProviderConfig.java deleted file mode 100644 index 2a8a0561f8..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProviderConfig.java +++ /dev/null @@ -1,43 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHttpProviderConfig; - -import java.util.Map; -import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; - -public class JDKAsyncHttpProviderConfig implements AsyncHttpProviderConfig { - - public static final String FORCE_RESPONSE_BUFFERING = "bufferResponseInMemory"; - - private final ConcurrentHashMap properties = new ConcurrentHashMap(); - - public AsyncHttpProviderConfig addProperty(String name, String value) { - properties.put(name, value); - return this; - } - - public String getProperty(String name) { - return properties.get(name); - } - - public String removeProperty(String name) { - return properties.remove(name); - } - - public Set> propertiesSet() { - return properties.entrySet(); - } -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/JDKDelegateFuture.java b/src/main/java/com/ning/http/client/providers/jdk/JDKDelegateFuture.java deleted file mode 100644 index 9553e02152..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/JDKDelegateFuture.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.ListenableFuture; - -import java.net.HttpURLConnection; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -public class JDKDelegateFuture extends JDKFuture { - - private final ListenableFuture delegateFuture; - - public JDKDelegateFuture(AsyncHandler asyncHandler, int responseTimeoutInMs, ListenableFuture delegateFuture, HttpURLConnection urlConnection) { - super(asyncHandler, responseTimeoutInMs, urlConnection); - this.delegateFuture = delegateFuture; - } - - public void done(Callable callable) { - delegateFuture.done(callable); - super.done(callable); - } - - public void abort(Throwable t) { - if (innerFuture != null) { - innerFuture.cancel(true); - } - delegateFuture.abort(t); - } - - public boolean cancel(boolean mayInterruptIfRunning) { - delegateFuture.cancel(mayInterruptIfRunning); - if (innerFuture != null) { - return innerFuture.cancel(mayInterruptIfRunning); - } else { - return false; - } - } - - public boolean isCancelled() { - if (innerFuture != null) { - return innerFuture.isCancelled(); - } else { - return false; - } - } - - public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { - V content = null; - try { - if (innerFuture != null) { - content = innerFuture.get(timeout, unit); - } - } catch (Throwable t) { - if (!contentProcessed.get() && timeout != -1 && ((System.currentTimeMillis() - touch.get()) <= responseTimeoutInMs)) { - return get(timeout, unit); - } - timedOut.set(true); - delegateFuture.abort(t); - } - - if (exception.get() != null) { - delegateFuture.abort(new ExecutionException(exception.get())); - } - delegateFuture.content(content); - delegateFuture.done(null); - return content; - } -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/JDKFuture.java b/src/main/java/com/ning/http/client/providers/jdk/JDKFuture.java deleted file mode 100644 index 4666459dc9..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/JDKFuture.java +++ /dev/null @@ -1,182 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.listenable.AbstractListenableFuture; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.net.HttpURLConnection; -import java.util.concurrent.Callable; -import java.util.concurrent.CancellationException; -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.AtomicLong; -import java.util.concurrent.atomic.AtomicReference; - - -public class JDKFuture extends AbstractListenableFuture { - - private final static Logger logger = LoggerFactory.getLogger(JDKFuture.class); - - protected Future innerFuture; - protected final AsyncHandler asyncHandler; - protected final int responseTimeoutInMs; - protected final AtomicBoolean cancelled = new AtomicBoolean(false); - protected final AtomicBoolean timedOut = new AtomicBoolean(false); - protected final AtomicBoolean isDone = new AtomicBoolean(false); - protected final AtomicReference exception = new AtomicReference(); - protected final AtomicLong touch = new AtomicLong(System.currentTimeMillis()); - protected final AtomicBoolean contentProcessed = new AtomicBoolean(false); - protected final HttpURLConnection urlConnection; - private boolean writeHeaders; - private boolean writeBody; - - public JDKFuture(AsyncHandler asyncHandler, int responseTimeoutInMs, HttpURLConnection urlConnection) { - this.asyncHandler = asyncHandler; - this.responseTimeoutInMs = responseTimeoutInMs; - this.urlConnection = urlConnection; - writeHeaders = true; - writeBody = true; - } - - protected void setInnerFuture(Future innerFuture) { - this.innerFuture = innerFuture; - } - - public void done(Callable callable) { - isDone.set(true); - super.done(); - } - - public void abort(Throwable t) { - exception.set(t); - if (innerFuture != null) { - innerFuture.cancel(true); - } - if (!timedOut.get() && !cancelled.get()) { - try { - asyncHandler.onThrowable(t); - } catch (Throwable te) { - logger.debug("asyncHandler.onThrowable", te); - } - } - super.done(); - } - - public void content(V v) { - } - - public boolean cancel(boolean mayInterruptIfRunning) { - if (!cancelled.get() && innerFuture != null) { - urlConnection.disconnect(); - try { - asyncHandler.onThrowable(new CancellationException()); - } catch (Throwable te) { - logger.debug("asyncHandler.onThrowable", te); - } - cancelled.set(true); - super.done(); - return innerFuture.cancel(mayInterruptIfRunning); - } else { - super.done(); - return false; - } - } - - public boolean isCancelled() { - if (innerFuture != null) { - return innerFuture.isCancelled(); - } else { - return false; - } - } - - public boolean isDone() { - contentProcessed.set(true); - return innerFuture.isDone(); - } - - public V get() throws InterruptedException, ExecutionException { - try { - return get(responseTimeoutInMs, TimeUnit.MILLISECONDS); - } catch (TimeoutException e) { - throw new ExecutionException(e); - } - } - - public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { - V content = null; - try { - if (innerFuture != null) { - content = innerFuture.get(timeout, unit); - } - } catch (TimeoutException t) { - if (!contentProcessed.get() && timeout != -1 && ((System.currentTimeMillis() - touch.get()) <= responseTimeoutInMs)) { - return get(timeout, unit); - } - - if (exception.get() == null) { - timedOut.set(true); - throw new ExecutionException(new TimeoutException(String.format("No response received after %s", responseTimeoutInMs))); - } - } catch (CancellationException ce) { - } - - if (exception.get() != null) { - throw new ExecutionException(exception.get()); - } - return content; - } - - /** - * Is the Future still valid - * - * @return true if response has expired and should be terminated. - */ - public boolean hasExpired() { - return responseTimeoutInMs != -1 && ((System.currentTimeMillis() - touch.get()) > responseTimeoutInMs); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void touch() { - touch.set(System.currentTimeMillis()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteHeaders(boolean writeHeaders) { - boolean b = this.writeHeaders; - this.writeHeaders = writeHeaders; - return b; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteBody(boolean writeBody) { - boolean b = this.writeBody; - this.writeBody = writeBody; - return b; - } -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/JDKResponse.java b/src/main/java/com/ning/http/client/providers/jdk/JDKResponse.java deleted file mode 100644 index 197fe7d59c..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/JDKResponse.java +++ /dev/null @@ -1,270 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import com.ning.http.util.AsyncHttpProviderUtils; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; -import java.util.Map; -import java.util.concurrent.atomic.AtomicBoolean; - - -public class JDKResponse implements Response { - private final static String DEFAULT_CHARSET = "ISO-8859-1"; - private final static String HEADERS_NOT_COMPUTED = "Response's headers hasn't been computed by your AsyncHandler."; - - private final URI uri; - private final Collection bodyParts; - private final HttpResponseHeaders headers; - private final HttpResponseStatus status; - private final List cookies = new ArrayList(); - private AtomicBoolean contentComputed = new AtomicBoolean(false); - private String content; - - public JDKResponse(HttpResponseStatus status, - HttpResponseHeaders headers, - Collection bodyParts) { - - this.bodyParts = bodyParts; - this.headers = headers; - this.status = status; - - uri = this.status.getUrl(); - } - - /* @Override */ - - public int getStatusCode() { - return status.getStatusCode(); - } - - /* @Override */ - - public String getStatusText() { - return status.getStatusText(); - } - - /* @Override */ - - public String getResponseBody() throws IOException { - return getResponseBody(DEFAULT_CHARSET); - } - - /* @Override */ - public byte[] getResponseBodyAsBytes() throws IOException { - return AsyncHttpProviderUtils.contentToByte(bodyParts); - } - - public String getResponseBody(String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - if (!contentComputed.get()) { - content = AsyncHttpProviderUtils.contentToString(bodyParts, charset); - } - return content; - } - - /* @Override */ - public InputStream getResponseBodyAsStream() throws IOException { - if (contentComputed.get()) { - return new ByteArrayInputStream(content.getBytes(DEFAULT_CHARSET)); - } - - if (bodyParts.size() > 0) { - return new ByteArrayCollectionInputStream(bodyParts.toArray(new HttpResponseBodyPart[bodyParts.size()])); - } else { - return new ByteArrayInputStream("".getBytes()); - } - } - - private static class ByteArrayCollectionInputStream extends InputStream { - - private final HttpResponseBodyPart[] parts; - - private int currentPos = 0; - private int bytePos = -1; - private byte[] active; - private int available = 0; - - public ByteArrayCollectionInputStream(HttpResponseBodyPart[] parts) { - this.parts = parts; - active = parts[0].getBodyPartBytes(); - computeLength(parts); - } - - private void computeLength(HttpResponseBodyPart[] parts) { - if (available == 0) { - for (HttpResponseBodyPart p : parts) { - available += p.getBodyPartBytes().length; - } - } - } - - @Override - public int available() throws IOException { - return available; - } - - @Override - public int read() throws IOException { - if (++bytePos >= active.length) { - // No more bytes, so step to the next array. - if (++currentPos >= parts.length) { - return -1; - } - - bytePos = 0; - active = parts[currentPos].getBodyPartBytes(); - } - - return active[bytePos] & 0xFF; - } - } - - /* @Override */ - - public String getResponseBodyExcerpt(int maxLength) throws IOException { - return getResponseBodyExcerpt(maxLength, DEFAULT_CHARSET); - } - - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - if (!contentComputed.get()) { - content = AsyncHttpProviderUtils.contentToString(bodyParts, charset == null ? DEFAULT_CHARSET : charset); - } - - return content.length() <= maxLength ? content : content.substring(0, maxLength); - } - - /* @Override */ - - public URI getUri() throws MalformedURLException { - return uri; - } - - /* @Override */ - - public String getContentType() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().getFirstValue("Content-Type"); - } - - /* @Override */ - - public String getHeader(String name) { - if (headers == null) { - throw new IllegalStateException(); - } - return headers.getHeaders().getFirstValue(name); - } - - /* @Override */ - - public List getHeaders(String name) { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().get(name); - } - - /* @Override */ - - public FluentCaseInsensitiveStringsMap getHeaders() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders(); - } - - /* @Override */ - - public boolean isRedirected() { - return (status.getStatusCode() >= 300) && (status.getStatusCode() <= 399); - } - - /* @Override */ - - public List getCookies() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - if (cookies.isEmpty()) { - for (Map.Entry> header : headers.getHeaders().entrySet()) { - if (header.getKey().equalsIgnoreCase("Set-Cookie")) { - // TODO: ask for parsed header - List v = header.getValue(); - for (String value : v) { - Cookie cookie = AsyncHttpProviderUtils.parseCookie(value); - cookies.add(cookie); - } - } - } - } - return Collections.unmodifiableList(cookies); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseStatus() { - return (bodyParts != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseHeaders() { - return (headers != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseBody() { - return (bodyParts != null && bodyParts.size() > 0 ? true : false); - } -} diff --git a/src/main/java/com/ning/http/client/providers/jdk/ResponseBodyPart.java b/src/main/java/com/ning/http/client/providers/jdk/ResponseBodyPart.java deleted file mode 100644 index 7fd42649b1..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/ResponseBodyPart.java +++ /dev/null @@ -1,81 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseBodyPart; - -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.nio.ByteBuffer; - -/** - * A callback class used when an HTTP response body is received. - */ -public class ResponseBodyPart extends HttpResponseBodyPart { - - private final byte[] chunk; - private final boolean isLast; - private boolean closeConnection; - - public ResponseBodyPart(URI uri, byte[] chunk, AsyncHttpProvider provider, boolean last) { - super(uri, provider); - this.chunk = chunk; - isLast = last; - } - - /** - * Return the response body's part bytes received. - * - * @return the response body's part bytes received. - */ - public byte[] getBodyPartBytes() { - return chunk; - } - - @Override - public int writeTo(OutputStream outputStream) throws IOException { - outputStream.write(chunk); - return chunk.length; - } - - @Override - public ByteBuffer getBodyByteBuffer() { - return ByteBuffer.wrap(chunk); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean isLast() { - return isLast; - } - - /** - * {@inheritDoc} - */ - @Override - public void markUnderlyingConnectionAsClosed() { - closeConnection = true; - } - - /** - * {@inheritDoc} - */ - @Override - public boolean closeUnderlyingConnection() { - return closeConnection; - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/jdk/ResponseHeaders.java b/src/main/java/com/ning/http/client/providers/jdk/ResponseHeaders.java deleted file mode 100644 index c4f3fe4865..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/ResponseHeaders.java +++ /dev/null @@ -1,60 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseHeaders; - -import java.net.HttpURLConnection; -import java.net.URI; -import java.util.List; -import java.util.Map; - -/** - * A class that represent the HTTP headers. - */ -public class ResponseHeaders extends HttpResponseHeaders { - - private final HttpURLConnection urlConnection; - private final FluentCaseInsensitiveStringsMap headers; - - public ResponseHeaders(URI uri, HttpURLConnection urlConnection, AsyncHttpProvider provider) { - super(uri, provider, false); - this.urlConnection = urlConnection; - headers = computerHeaders(); - } - - private FluentCaseInsensitiveStringsMap computerHeaders() { - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - - Map> uh = urlConnection.getHeaderFields(); - - for (Map.Entry> e : uh.entrySet()) { - if (e.getKey() != null) { - h.add(e.getKey(), e.getValue()); - } - } - return h; - } - - /** - * Return the HTTP header - * - * @return an {@link com.ning.http.client.FluentCaseInsensitiveStringsMap} - */ - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return headers; - } -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/jdk/ResponseStatus.java b/src/main/java/com/ning/http/client/providers/jdk/ResponseStatus.java deleted file mode 100644 index 7f27e2dc5d..0000000000 --- a/src/main/java/com/ning/http/client/providers/jdk/ResponseStatus.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.jdk; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseStatus; - -import java.io.IOException; -import java.net.HttpURLConnection; -import java.net.URI; - -/** - * A class that represent the HTTP response' status line (code + text) - */ -public class ResponseStatus extends HttpResponseStatus { - - private final HttpURLConnection urlConnection; - - public ResponseStatus(URI uri, HttpURLConnection urlConnection, AsyncHttpProvider provider) { - super(uri, provider); - this.urlConnection = urlConnection; - } - - /** - * Return the response status code - * - * @return the response status code - */ - public int getStatusCode() { - try { - return urlConnection.getResponseCode(); - } catch (IOException e) { - return 500; - } - } - - /** - * Return the response status text - * - * @return the response status text - */ - public String getStatusText() { - try { - return urlConnection.getResponseMessage(); - } catch (IOException e) { - return "Internal Error"; - } - } - - @Override - public String getProtocolName() { - return "http"; - } - - @Override - public int getProtocolMajorVersion() { - return 1; - } - - @Override - public int getProtocolMinorVersion() { - return 1; //TODO - } - - @Override - public String getProtocolText() { - return ""; //TODO - } - -} \ No newline at end of file diff --git a/src/main/java/com/ning/http/client/providers/netty/BodyChunkedInput.java b/src/main/java/com/ning/http/client/providers/netty/BodyChunkedInput.java deleted file mode 100644 index 9ea1de6609..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/BodyChunkedInput.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.Body; -import org.jboss.netty.buffer.ChannelBuffers; -import org.jboss.netty.handler.stream.ChunkedInput; - -import java.io.IOException; -import java.nio.ByteBuffer; - -/** - * Adapts a {@link Body} to Netty's {@link ChunkedInput}. - */ -class BodyChunkedInput - implements ChunkedInput { - - private final Body body; - - private final int chunkSize = 1024 * 8; - - private ByteBuffer nextChunk; - - private static final ByteBuffer EOF = ByteBuffer.allocate(0); - - public BodyChunkedInput(Body body) { - if (body == null) { - throw new IllegalArgumentException("no body specified"); - } - this.body = body; - } - - private ByteBuffer peekNextChuck() - throws IOException { - - if (nextChunk == null) { - ByteBuffer buffer = ByteBuffer.allocate(chunkSize); - if (body.read(buffer) < 0) { - nextChunk = EOF; - } else { - buffer.flip(); - nextChunk = buffer; - } - } - return nextChunk; - } - - public boolean hasNextChunk() - throws Exception { - return !isEndOfInput(); - } - - public Object nextChunk() - throws Exception { - ByteBuffer buffer = peekNextChuck(); - if (buffer == EOF) { - return null; - } - nextChunk = null; - return ChannelBuffers.wrappedBuffer(buffer); - } - - public boolean isEndOfInput() - throws Exception { - return peekNextChuck() == EOF; - } - - public void close() - throws Exception { - body.close(); - } - -} diff --git a/src/main/java/com/ning/http/client/providers/netty/BodyFileRegion.java b/src/main/java/com/ning/http/client/providers/netty/BodyFileRegion.java deleted file mode 100644 index 9679ba43f1..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/BodyFileRegion.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.RandomAccessBody; -import org.jboss.netty.channel.FileRegion; - -import java.io.IOException; -import java.nio.channels.WritableByteChannel; - -/** - * Adapts a {@link RandomAccessBody} to Netty's {@link FileRegion}. - */ -class BodyFileRegion - implements FileRegion { - - private final RandomAccessBody body; - - public BodyFileRegion(RandomAccessBody body) { - if (body == null) { - throw new IllegalArgumentException("no body specified"); - } - this.body = body; - } - - public long getPosition() { - return 0; - } - - public long getCount() { - return body.getContentLength(); - } - - public long transferTo(WritableByteChannel target, long position) - throws IOException { - return body.transferTo(position, Long.MAX_VALUE, target); - } - - public void releaseExternalResources() { - try { - body.close(); - } catch (IOException e) { - // we tried - } - } - -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProvider.java b/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProvider.java deleted file mode 100644 index a8caedb850..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProvider.java +++ /dev/null @@ -1,2375 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHandler.STATE; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.Body; -import com.ning.http.client.BodyGenerator; -import com.ning.http.client.ConnectionsPool; -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.MaxRedirectException; -import com.ning.http.client.PerRequestConfig; -import com.ning.http.client.ProgressAsyncHandler; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.RandomAccessBody; -import com.ning.http.client.Realm; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.IOExceptionFilter; -import com.ning.http.client.filter.ResponseFilter; -import com.ning.http.client.generators.InputStreamBodyGenerator; -import com.ning.http.client.listener.TransferCompletionHandler; -import com.ning.http.client.ntlm.NTLMEngine; -import com.ning.http.client.ntlm.NTLMEngineException; -import com.ning.http.client.providers.netty.spnego.SpnegoEngine; -import com.ning.http.client.websocket.WebSocketUpgradeHandler; -import com.ning.http.multipart.MultipartBody; -import com.ning.http.multipart.MultipartRequestEntity; -import com.ning.http.util.AsyncHttpProviderUtils; -import com.ning.http.util.AuthenticatorUtils; -import com.ning.http.util.CleanupChannelGroup; -import com.ning.http.util.ProxyUtils; -import com.ning.http.util.SslUtils; -import com.ning.http.util.UTF8UrlEncoder; -import org.jboss.netty.bootstrap.ClientBootstrap; -import org.jboss.netty.buffer.ChannelBuffer; -import org.jboss.netty.buffer.ChannelBufferOutputStream; -import org.jboss.netty.buffer.ChannelBuffers; -import org.jboss.netty.channel.Channel; -import org.jboss.netty.channel.ChannelFuture; -import org.jboss.netty.channel.ChannelFutureProgressListener; -import org.jboss.netty.channel.ChannelHandlerContext; -import org.jboss.netty.channel.ChannelPipeline; -import org.jboss.netty.channel.ChannelPipelineFactory; -import org.jboss.netty.channel.ChannelStateEvent; -import org.jboss.netty.channel.DefaultChannelFuture; -import org.jboss.netty.channel.ExceptionEvent; -import org.jboss.netty.channel.FileRegion; -import org.jboss.netty.channel.MessageEvent; -import org.jboss.netty.channel.SimpleChannelUpstreamHandler; -import org.jboss.netty.channel.group.ChannelGroup; -import org.jboss.netty.channel.socket.ClientSocketChannelFactory; -import org.jboss.netty.channel.socket.nio.NioClientSocketChannelFactory; -import org.jboss.netty.channel.socket.oio.OioClientSocketChannelFactory; -import org.jboss.netty.handler.codec.http.CookieEncoder; -import org.jboss.netty.handler.codec.http.DefaultCookie; -import org.jboss.netty.handler.codec.http.DefaultHttpChunkTrailer; -import org.jboss.netty.handler.codec.http.DefaultHttpRequest; -import org.jboss.netty.handler.codec.http.HttpChunk; -import org.jboss.netty.handler.codec.http.HttpChunkTrailer; -import org.jboss.netty.handler.codec.http.HttpClientCodec; -import org.jboss.netty.handler.codec.http.HttpContentCompressor; -import org.jboss.netty.handler.codec.http.HttpContentDecompressor; -import org.jboss.netty.handler.codec.http.HttpHeaders; -import org.jboss.netty.handler.codec.http.HttpMethod; -import org.jboss.netty.handler.codec.http.HttpRequest; -import org.jboss.netty.handler.codec.http.HttpRequestEncoder; -import org.jboss.netty.handler.codec.http.HttpResponse; -import org.jboss.netty.handler.codec.http.HttpResponseDecoder; -import org.jboss.netty.handler.codec.http.HttpVersion; -import org.jboss.netty.handler.codec.http.websocketx.WebSocket08FrameDecoder; -import org.jboss.netty.handler.codec.http.websocketx.WebSocket08FrameEncoder; -import org.jboss.netty.handler.codec.http.websocketx.WebSocketFrame; -import org.jboss.netty.handler.ssl.SslHandler; -import org.jboss.netty.handler.stream.ChunkedFile; -import org.jboss.netty.handler.stream.ChunkedWriteHandler; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.net.ssl.SSLEngine; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.RandomAccessFile; -import java.net.ConnectException; -import java.net.InetSocketAddress; -import java.net.MalformedURLException; -import java.net.URI; -import java.nio.channels.ClosedChannelException; -import java.nio.channels.FileChannel; -import java.nio.channels.WritableByteChannel; -import java.security.GeneralSecurityException; -import java.security.NoSuchAlgorithmException; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Iterator; -import java.util.List; -import java.util.Map.Entry; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.Future; -import java.util.concurrent.RejectedExecutionException; -import java.util.concurrent.Semaphore; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicBoolean; - -import static com.ning.http.util.AsyncHttpProviderUtils.DEFAULT_CHARSET; -import static org.jboss.netty.channel.Channels.pipeline; - -public class NettyAsyncHttpProvider extends SimpleChannelUpstreamHandler implements AsyncHttpProvider { - private final static String WEBSOCKET_KEY = "Sec-WebSocket-Key"; - private final static String HTTP_HANDLER = "httpHandler"; - protected final static String SSL_HANDLER = "sslHandler"; - private final static String HTTPS = "https"; - private final static String HTTP = "http"; - private static final String WEBSOCKET = "ws"; - private final static Logger log = LoggerFactory.getLogger(NettyAsyncHttpProvider.class); - private final ClientBootstrap plainBootstrap; - private final ClientBootstrap secureBootstrap; - private final ClientBootstrap webSocketBootstrap; - private final static int MAX_BUFFERED_BYTES = 8192; - private final AsyncHttpClientConfig config; - private final AtomicBoolean isClose = new AtomicBoolean(false); - private final ClientSocketChannelFactory socketChannelFactory; - - private final ChannelGroup openChannels = new - CleanupChannelGroup("asyncHttpClient") { - @Override - public boolean remove(Object o) { - boolean removed = super.remove(o); - if (removed && trackConnections) { - freeConnections.release(); - } - return removed; - } - }; - private final ConnectionsPool connectionsPool; - private Semaphore freeConnections = null; - private final NettyAsyncHttpProviderConfig asyncHttpProviderConfig; - private boolean executeConnectAsync = true; - public static final ThreadLocal IN_IO_THREAD = new ThreadLocalBoolean(); - private final boolean trackConnections; - private final boolean useRawUrl; - private final static NTLMEngine ntlmEngine = new NTLMEngine(); - private final static SpnegoEngine spnegoEngine = new SpnegoEngine(); - private final Protocol httpProtocol = new HttpProtocol(); - private final Protocol webSocketProtocol = new WebSocketProtocol(); - - public NettyAsyncHttpProvider(AsyncHttpClientConfig config) { - - if (config.getAsyncHttpProviderConfig() != null - && NettyAsyncHttpProviderConfig.class.isAssignableFrom(config.getAsyncHttpProviderConfig().getClass())) { - asyncHttpProviderConfig = NettyAsyncHttpProviderConfig.class.cast(config.getAsyncHttpProviderConfig()); - } else { - asyncHttpProviderConfig = new NettyAsyncHttpProviderConfig(); - } - - if (asyncHttpProviderConfig.getProperty(NettyAsyncHttpProviderConfig.USE_BLOCKING_IO) != null) { - socketChannelFactory = new OioClientSocketChannelFactory(config.executorService()); - } else { - ExecutorService e; - Object o = asyncHttpProviderConfig.getProperty(NettyAsyncHttpProviderConfig.BOSS_EXECUTOR_SERVICE); - if (o != null && ExecutorService.class.isAssignableFrom(o.getClass())) { - e = ExecutorService.class.cast(o); - } else { - e = Executors.newCachedThreadPool(); - } - int numWorkers = config.getIoThreadMultiplier() * Runtime.getRuntime().availableProcessors(); - log.debug("Number of application's worker threads is {}", numWorkers); - socketChannelFactory = new NioClientSocketChannelFactory(e, config.executorService(), numWorkers); - } - plainBootstrap = new ClientBootstrap(socketChannelFactory); - secureBootstrap = new ClientBootstrap(socketChannelFactory); - webSocketBootstrap = new ClientBootstrap(socketChannelFactory); - configureNetty(); - - this.config = config; - - // This is dangerous as we can't catch a wrong typed ConnectionsPool - ConnectionsPool cp = (ConnectionsPool) config.getConnectionsPool(); - if (cp == null && config.getAllowPoolingConnection()) { - cp = new NettyConnectionsPool(this); - } else if (cp == null) { - cp = new NonConnectionsPool(); - } - this.connectionsPool = cp; - - if (config.getMaxTotalConnections() != -1) { - trackConnections = true; - freeConnections = new Semaphore(config.getMaxTotalConnections()); - } else { - trackConnections = false; - } - - useRawUrl = config.isUseRawUrl(); - } - - @Override - public String toString() { - return String.format("NettyAsyncHttpProvider:\n\t- maxConnections: %d\n\t- openChannels: %s\n\t- connectionPools: %s", - config.getMaxTotalConnections() - freeConnections.availablePermits(), - openChannels.toString(), - connectionsPool.toString()); - } - - void configureNetty() { - if (asyncHttpProviderConfig != null) { - for (Entry entry : asyncHttpProviderConfig.propertiesSet()) { - plainBootstrap.setOption(entry.getKey(), entry.getValue()); - } - } - - plainBootstrap.setPipelineFactory(new ChannelPipelineFactory() { - - /* @Override */ - public ChannelPipeline getPipeline() throws Exception { - ChannelPipeline pipeline = pipeline(); - - pipeline.addLast(HTTP_HANDLER, new HttpClientCodec()); - - if (config.getRequestCompressionLevel() > 0) { - pipeline.addLast("deflater", new HttpContentCompressor(config.getRequestCompressionLevel())); - } - - if (config.isCompressionEnabled()) { - pipeline.addLast("inflater", new HttpContentDecompressor()); - } - pipeline.addLast("chunkedWriter", new ChunkedWriteHandler()); - pipeline.addLast("httpProcessor", NettyAsyncHttpProvider.this); - return pipeline; - } - }); - DefaultChannelFuture.setUseDeadLockChecker(false); - - if (asyncHttpProviderConfig != null) { - Object value = asyncHttpProviderConfig.getProperty(NettyAsyncHttpProviderConfig.EXECUTE_ASYNC_CONNECT); - if (value != null && Boolean.class.isAssignableFrom(value.getClass())) { - executeConnectAsync = Boolean.class.cast(value); - } else if (asyncHttpProviderConfig.getProperty(NettyAsyncHttpProviderConfig.DISABLE_NESTED_REQUEST) != null) { - DefaultChannelFuture.setUseDeadLockChecker(true); - } - } - - webSocketBootstrap.setPipelineFactory(new ChannelPipelineFactory() { - - /* @Override */ - public ChannelPipeline getPipeline() throws Exception { - ChannelPipeline pipeline = pipeline(); - pipeline.addLast("ws-decoder", new HttpResponseDecoder()); - pipeline.addLast("ws-encoder", new HttpRequestEncoder()); - pipeline.addLast("httpProcessor", NettyAsyncHttpProvider.this); - return pipeline; - } - }); - } - - void constructSSLPipeline(final NettyConnectListener cl) { - - secureBootstrap.setPipelineFactory(new ChannelPipelineFactory() { - - /* @Override */ - public ChannelPipeline getPipeline() throws Exception { - ChannelPipeline pipeline = pipeline(); - - try { - pipeline.addLast(SSL_HANDLER, new SslHandler(createSSLEngine())); - } catch (Throwable ex) { - abort(cl.future(), ex); - } - - pipeline.addLast(HTTP_HANDLER, new HttpClientCodec()); - - if (config.isCompressionEnabled()) { - pipeline.addLast("inflater", new HttpContentDecompressor()); - } - pipeline.addLast("chunkedWriter", new ChunkedWriteHandler()); - pipeline.addLast("httpProcessor", NettyAsyncHttpProvider.this); - return pipeline; - } - }); - - if (asyncHttpProviderConfig != null) { - for (Entry entry : asyncHttpProviderConfig.propertiesSet()) { - secureBootstrap.setOption(entry.getKey(), entry.getValue()); - } - } - } - - private Channel lookupInCache(URI uri) { - final Channel channel = connectionsPool.poll(AsyncHttpProviderUtils.getBaseUrl(uri)); - - if (channel != null) { - log.debug("Using cached Channel {}\n for uri {}\n", channel, uri); - - try { - // Always make sure the channel who got cached support the proper protocol. It could - // only occurs when a HttpMethod.CONNECT is used agains a proxy that require upgrading from http to - // https. - return verifyChannelPipeline(channel, uri.getScheme()); - } catch (Exception ex) { - log.debug(ex.getMessage(), ex); - } - } - return null; - } - - private SSLEngine createSSLEngine() throws IOException, GeneralSecurityException { - SSLEngine sslEngine = config.getSSLEngineFactory().newSSLEngine(); - if (sslEngine == null) { - sslEngine = SslUtils.getSSLEngine(); - } - return sslEngine; - } - - private Channel verifyChannelPipeline(Channel channel, String scheme) throws IOException, GeneralSecurityException { - - if (channel.getPipeline().get(SSL_HANDLER) != null && HTTP.equalsIgnoreCase(scheme)) { - channel.getPipeline().remove(SSL_HANDLER); - } else if (channel.getPipeline().get(HTTP_HANDLER) != null && HTTP.equalsIgnoreCase(scheme)) { - return channel; - } else if (channel.getPipeline().get(SSL_HANDLER) == null && HTTPS.equalsIgnoreCase(scheme)) { - channel.getPipeline().addFirst(SSL_HANDLER, new SslHandler(createSSLEngine())); - } - return channel; - } - - protected final void writeRequest(final Channel channel, - final AsyncHttpClientConfig config, - final NettyResponseFuture future, - final HttpRequest nettyRequest) { - try { - /** - * If the channel is dead because it was pooled and the remote server decided to close it, - * we just let it go and the closeChannel do it's work. - */ - if (!channel.isOpen() || !channel.isConnected()) { - return; - } - - Body body = null; - if (!future.getNettyRequest().getMethod().equals(HttpMethod.CONNECT)) { - BodyGenerator bg = future.getRequest().getBodyGenerator(); - if (bg != null) { - // Netty issue with chunking. - if (InputStreamBodyGenerator.class.isAssignableFrom(bg.getClass())) { - InputStreamBodyGenerator.class.cast(bg).patchNettyChunkingIssue(true); - } - - try { - body = bg.createBody(); - } catch (IOException ex) { - throw new IllegalStateException(ex); - } - long length = body.getContentLength(); - if (length >= 0) { - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, length); - } else { - nettyRequest.setHeader(HttpHeaders.Names.TRANSFER_ENCODING, HttpHeaders.Values.CHUNKED); - } - } else { - body = null; - } - } - - if (TransferCompletionHandler.class.isAssignableFrom(future.getAsyncHandler().getClass())) { - - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - for (String s : future.getNettyRequest().getHeaderNames()) { - for (String header : future.getNettyRequest().getHeaders(s)) { - h.add(s, header); - } - } - - TransferCompletionHandler.class.cast(future.getAsyncHandler()).transferAdapter( - new NettyTransferAdapter(h, nettyRequest.getContent(), future.getRequest().getFile())); - } - - // Leave it to true. - if (future.getAndSetWriteHeaders(true)) { - try { - channel.write(nettyRequest).addListener(new ProgressListener(true, future.getAsyncHandler(), future)); - } catch (Throwable cause) { - log.debug(cause.getMessage(), cause); - try { - channel.close(); - } catch (RuntimeException ex) { - log.debug(ex.getMessage(), ex); - } - return; - } - } - - if (future.getAndSetWriteBody(true)) { - if (!future.getNettyRequest().getMethod().equals(HttpMethod.CONNECT)) { - - if (future.getRequest().getFile() != null) { - final File file = future.getRequest().getFile(); - long fileLength = 0; - final RandomAccessFile raf = new RandomAccessFile(file, "r"); - - try { - fileLength = raf.length(); - - ChannelFuture writeFuture; - if (channel.getPipeline().get(SslHandler.class) != null) { - writeFuture = channel.write(new ChunkedFile(raf, 0, fileLength, 8192)); - } else { - final FileRegion region = new OptimizedFileRegion(raf, 0, fileLength); - writeFuture = channel.write(region); - } - writeFuture.addListener(new ProgressListener(false, future.getAsyncHandler(), future)); - } catch (IOException ex) { - if (raf != null) { - try { - raf.close(); - } catch (IOException e) { - } - } - throw ex; - } - } else if (body != null || future.getRequest().getParts() != null) { - /** - * TODO: AHC-78: SSL + zero copy isn't supported by the MultiPart class and pretty complex to implements. - */ - if (future.getRequest().getParts() != null) { - String boundary = future.getNettyRequest().getHeader("Content-Type"); - String length = future.getNettyRequest().getHeader("Content-Length"); - body = new MultipartBody(future.getRequest().getParts(), boundary, length); - } - - ChannelFuture writeFuture; - if (channel.getPipeline().get(SslHandler.class) == null && (body instanceof RandomAccessBody)) { - BodyFileRegion bodyFileRegion = new BodyFileRegion((RandomAccessBody) body); - writeFuture = channel.write(bodyFileRegion); - } else { - BodyChunkedInput bodyChunkedInput = new BodyChunkedInput(body); - writeFuture = channel.write(bodyChunkedInput); - } - - final Body b = body; - writeFuture.addListener(new ProgressListener(false, future.getAsyncHandler(), future) { - public void operationComplete(ChannelFuture cf) { - try { - b.close(); - } catch (IOException e) { - log.warn("Failed to close request body: {}", e.getMessage(), e); - } - super.operationComplete(cf); - } - }); - } - } - } - } catch (Throwable ioe) { - try { - channel.close(); - } catch (RuntimeException ex) { - log.debug(ex.getMessage(), ex); - } - } - - try { - future.touch(); - int delay = requestTimeout(config, future.getRequest().getPerRequestConfig()); - if (delay != -1 && !future.isDone() && !future.isCancelled()) { - ReaperFuture reaperFuture = new ReaperFuture(channel, future); - Future scheduledFuture = config.reaper().scheduleAtFixedRate(reaperFuture, 0, delay, TimeUnit.MILLISECONDS); - reaperFuture.setScheduledFuture(scheduledFuture); - future.setReaperFuture(reaperFuture); - } - } catch (RejectedExecutionException ex) { - abort(future, ex); - } - - } - - private static boolean isProxyServer(AsyncHttpClientConfig config, Request request) { - return request.getProxyServer() != null || config.getProxyServer() != null; - } - - protected final static HttpRequest buildRequest(AsyncHttpClientConfig config, Request request, URI uri, - boolean allowConnect, ChannelBuffer buffer) throws IOException { - - String method = request.getMethod(); - if (allowConnect && (isProxyServer(config, request) && HTTPS.equalsIgnoreCase(uri.getScheme()))) { - method = HttpMethod.CONNECT.toString(); - } - return construct(config, request, new HttpMethod(method), uri, buffer); - } - - @SuppressWarnings("deprecation") - private static HttpRequest construct(AsyncHttpClientConfig config, - Request request, - HttpMethod m, - URI uri, - ChannelBuffer buffer) throws IOException { - - String host = AsyncHttpProviderUtils.getHost(uri); - - if (request.getVirtualHost() != null) { - host = request.getVirtualHost(); - } - - HttpRequest nettyRequest; - if (m.equals(HttpMethod.CONNECT)) { - nettyRequest = new DefaultHttpRequest(HttpVersion.HTTP_1_0, m, AsyncHttpProviderUtils.getAuthority(uri)); - } else { - StringBuilder path = null; - if (isProxyServer(config, request)) - path = new StringBuilder(uri.toString()); - else { - path = new StringBuilder(uri.getRawPath()); - if (uri.getQuery() != null) { - path.append("?").append(uri.getRawQuery()); - } - } - nettyRequest = new DefaultHttpRequest(HttpVersion.HTTP_1_1, m, path.toString()); - } - boolean webSocket = uri.getScheme().equalsIgnoreCase(WEBSOCKET); - if (webSocket) { - nettyRequest.addHeader(HttpHeaders.Names.UPGRADE, HttpHeaders.Values.WEBSOCKET); - nettyRequest.addHeader(HttpHeaders.Names.CONNECTION, HttpHeaders.Values.UPGRADE); - nettyRequest.addHeader("Sec-WebSocket-Origin", "http://" + uri.getHost()); - nettyRequest.addHeader(WEBSOCKET_KEY, WebSocketUtil.getKey()); - nettyRequest.addHeader("Sec-WebSocket-Version", "8"); - } - - if (host != null) { - if (uri.getPort() == -1) { - nettyRequest.setHeader(HttpHeaders.Names.HOST, host); - } else if (request.getVirtualHost() != null) { - nettyRequest.setHeader(HttpHeaders.Names.HOST, host); - } else { - nettyRequest.setHeader(HttpHeaders.Names.HOST, host + ":" + uri.getPort()); - } - } else { - host = "127.0.0.1"; - } - - if (!m.equals(HttpMethod.CONNECT)) { - FluentCaseInsensitiveStringsMap h = request.getHeaders(); - if (h != null) { - for (String name : h.keySet()) { - if (!"host".equalsIgnoreCase(name)) { - for (String value : h.get(name)) { - nettyRequest.addHeader(name, value); - } - } - } - } - - if (config.isCompressionEnabled()) { - nettyRequest.setHeader(HttpHeaders.Names.ACCEPT_ENCODING, HttpHeaders.Values.GZIP); - } - } else { - List auth = request.getHeaders().get(HttpHeaders.Names.PROXY_AUTHORIZATION); - if (auth != null && auth.size() > 0 && auth.get(0).startsWith("NTLM")) { - nettyRequest.addHeader(HttpHeaders.Names.PROXY_AUTHORIZATION, auth.get(0)); - } - } - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - - if (realm != null && realm.getUsePreemptiveAuth()) { - - String domain = realm.getNtlmDomain(); - if (proxyServer != null && proxyServer.getNtlmDomain() != null) { - domain = proxyServer.getNtlmDomain(); - } - - String authHost = realm.getNtlmHost(); - if (proxyServer != null && proxyServer.getHost() != null) { - host = proxyServer.getHost(); - } - - switch (realm.getAuthScheme()) { - case BASIC: - nettyRequest.setHeader(HttpHeaders.Names.AUTHORIZATION, - AuthenticatorUtils.computeBasicAuthentication(realm)); - break; - case DIGEST: - if (realm.getNonce() != null && !realm.getNonce().equals("")) { - try { - nettyRequest.setHeader(HttpHeaders.Names.AUTHORIZATION, - AuthenticatorUtils.computeDigestAuthentication(realm)); - } catch (NoSuchAlgorithmException e) { - throw new SecurityException(e); - } - } - break; - case NTLM: - try { - nettyRequest.setHeader(HttpHeaders.Names.AUTHORIZATION, - ntlmEngine.generateType1Msg("NTLM " + domain, authHost)); - } catch (NTLMEngineException e) { - IOException ie = new IOException(); - ie.initCause(e); - throw ie; - } - break; - case KERBEROS: - case SPNEGO: - String challengeHeader = null; - String server = proxyServer == null ? host : proxyServer.getHost(); - try { - challengeHeader = spnegoEngine.generateToken(server); - } catch (Throwable e) { - IOException ie = new IOException(); - ie.initCause(e); - throw ie; - } - nettyRequest.setHeader(HttpHeaders.Names.AUTHORIZATION, "Negotiate " + challengeHeader); - break; - case NONE: - break; - default: - throw new IllegalStateException(String.format("Invalid Authentication %s", realm.toString())); - } - } - - if (!webSocket && !request.getHeaders().containsKey(HttpHeaders.Names.CONNECTION)) { - nettyRequest.setHeader(HttpHeaders.Names.CONNECTION, "keep-alive"); - } - - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, request); - if (!avoidProxy) { - if (!request.getHeaders().containsKey("Proxy-Connection")) { - nettyRequest.setHeader("Proxy-Connection", "keep-alive"); - } - - if (proxyServer.getPrincipal() != null) { - if (proxyServer.getNtlmDomain() != null && proxyServer.getNtlmDomain().length() > 0) { - - List auth = request.getHeaders().get(HttpHeaders.Names.PROXY_AUTHORIZATION); - if (!(auth != null && auth.size() > 0 && auth.get(0).startsWith("NTLM"))) { - try { - String msg = ntlmEngine.generateType1Msg(proxyServer.getNtlmDomain(), - proxyServer.getHost()); - nettyRequest.setHeader(HttpHeaders.Names.PROXY_AUTHORIZATION, "NTLM " + msg); - } catch (NTLMEngineException e) { - IOException ie = new IOException(); - ie.initCause(e); - throw ie; - } - } - } else { - nettyRequest.setHeader(HttpHeaders.Names.PROXY_AUTHORIZATION, - AuthenticatorUtils.computeBasicAuthentication(proxyServer)); - } - } - } - - // Add default accept headers. - if (request.getHeaders().getFirstValue("Accept") == null) { - nettyRequest.setHeader(HttpHeaders.Names.ACCEPT, "*/*"); - } - - if (request.getHeaders().getFirstValue("User-Agent") != null) { - nettyRequest.setHeader("User-Agent", request.getHeaders().getFirstValue("User-Agent")); - } else if (config.getUserAgent() != null) { - nettyRequest.setHeader("User-Agent", config.getUserAgent()); - } else { - nettyRequest.setHeader("User-Agent", AsyncHttpProviderUtils.constructUserAgent(NettyAsyncHttpProvider.class)); - } - - if (!m.equals(HttpMethod.CONNECT)) { - if (request.getCookies() != null && !request.getCookies().isEmpty()) { - CookieEncoder httpCookieEncoder = new CookieEncoder(false); - Iterator ic = request.getCookies().iterator(); - Cookie c; - org.jboss.netty.handler.codec.http.Cookie cookie; - while (ic.hasNext()) { - c = ic.next(); - cookie = new DefaultCookie(c.getName(), c.getValue()); - cookie.setPath(c.getPath()); - cookie.setMaxAge(c.getMaxAge()); - cookie.setDomain(c.getDomain()); - httpCookieEncoder.addCookie(cookie); - } - nettyRequest.setHeader(HttpHeaders.Names.COOKIE, httpCookieEncoder.encode()); - } - - String reqType = request.getMethod(); - if (!"GET".equals(reqType) && !"HEAD".equals(reqType) && !"OPTION".equals(reqType) && !"TRACE".equals(reqType)) { - - String bodyCharset = request.getBodyEncoding() == null ? DEFAULT_CHARSET : request.getBodyEncoding(); - - // We already have processed the body. - if (buffer != null && buffer.writerIndex() != 0) { - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, buffer.writerIndex()); - nettyRequest.setContent(buffer); - } else if (request.getByteData() != null) { - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(request.getByteData().length)); - nettyRequest.setContent(ChannelBuffers.wrappedBuffer(request.getByteData())); - } else if (request.getStringData() != null) { - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(request.getStringData().getBytes(bodyCharset).length)); - nettyRequest.setContent(ChannelBuffers.wrappedBuffer(request.getStringData().getBytes(bodyCharset))); - } else if (request.getStreamData() != null) { - int[] lengthWrapper = new int[1]; - byte[] bytes = AsyncHttpProviderUtils.readFully(request.getStreamData(), lengthWrapper); - int length = lengthWrapper[0]; - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(length)); - nettyRequest.setContent(ChannelBuffers.wrappedBuffer(bytes, 0, length)); - } else if (request.getParams() != null && !request.getParams().isEmpty()) { - StringBuilder sb = new StringBuilder(); - for (final Entry> paramEntry : request.getParams()) { - final String key = paramEntry.getKey(); - for (final String value : paramEntry.getValue()) { - if (sb.length() > 0) { - sb.append("&"); - } - UTF8UrlEncoder.appendEncoded(sb, key); - sb.append("="); - UTF8UrlEncoder.appendEncoded(sb, value); - } - } - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(sb.length())); - nettyRequest.setContent(ChannelBuffers.wrappedBuffer(sb.toString().getBytes(bodyCharset))); - - if (!request.getHeaders().containsKey(HttpHeaders.Names.CONTENT_TYPE)) { - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_TYPE, "application/x-www-form-urlencoded"); - } - - } else if (request.getParts() != null) { - int lenght = computeAndSetContentLength(request, nettyRequest); - - if (lenght == -1) { - lenght = MAX_BUFFERED_BYTES; - } - - MultipartRequestEntity mre = AsyncHttpProviderUtils.createMultipartRequestEntity(request.getParts(), request.getParams()); - - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_TYPE, mre.getContentType()); - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(mre.getContentLength())); - - /** - * TODO: AHC-78: SSL + zero copy isn't supported by the MultiPart class and pretty complex to implements. - */ - if (uri.toString().startsWith(HTTPS)) { - ChannelBuffer b = ChannelBuffers.dynamicBuffer(lenght); - mre.writeRequest(new ChannelBufferOutputStream(b)); - nettyRequest.setContent(b); - } - } else if (request.getEntityWriter() != null) { - int lenght = computeAndSetContentLength(request, nettyRequest); - - if (lenght == -1) { - lenght = MAX_BUFFERED_BYTES; - } - - ChannelBuffer b = ChannelBuffers.dynamicBuffer(lenght); - request.getEntityWriter().writeEntity(new ChannelBufferOutputStream(b)); - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, b.writerIndex()); - nettyRequest.setContent(b); - } else if (request.getFile() != null) { - File file = request.getFile(); - if (!file.isFile()) { - throw new IOException(String.format("File %s is not a file or doesn't exist", file.getAbsolutePath())); - } - nettyRequest.setHeader(HttpHeaders.Names.CONTENT_LENGTH, file.length()); - } - } - } - return nettyRequest; - } - - public void close() { - isClose.set(true); - try { - connectionsPool.destroy(); - openChannels.close(); - - for (Channel channel : openChannels) { - ChannelHandlerContext ctx = channel.getPipeline().getContext(NettyAsyncHttpProvider.class); - if (ctx.getAttachment() instanceof NettyResponseFuture) { - NettyResponseFuture future = (NettyResponseFuture) ctx.getAttachment(); - future.setReaperFuture(null); - } - } - - config.executorService().shutdown(); - config.reaper().shutdown(); - socketChannelFactory.releaseExternalResources(); - plainBootstrap.releaseExternalResources(); - secureBootstrap.releaseExternalResources(); - webSocketBootstrap.releaseExternalResources(); - } catch (Throwable t) { - log.warn("Unexpected error on close", t); - } - } - - /* @Override */ - - public Response prepareResponse(final HttpResponseStatus status, - final HttpResponseHeaders headers, - final Collection bodyParts) { - return new NettyResponse(status, headers, bodyParts); - } - - /* @Override */ - - public ListenableFuture execute(Request request, final AsyncHandler asyncHandler) throws IOException { - return doConnect(request, asyncHandler, null, true, executeConnectAsync, false); - } - - private void execute(final Request request, final NettyResponseFuture f, boolean useCache, boolean asyncConnect) throws IOException { - doConnect(request, f.getAsyncHandler(), f, useCache, asyncConnect, false); - } - - private void execute(final Request request, final NettyResponseFuture f, boolean useCache, boolean asyncConnect, boolean reclaimCache) throws IOException { - doConnect(request, f.getAsyncHandler(), f, useCache, asyncConnect, reclaimCache); - } - - private ListenableFuture doConnect(final Request request, final AsyncHandler asyncHandler, NettyResponseFuture f, - boolean useCache, boolean asyncConnect, boolean reclaimCache) throws IOException { - - if (isClose.get()) { - throw new IOException("Closed"); - } - - if (request.getUrl().startsWith(WEBSOCKET) && !validateWebSocketRequest(request, asyncHandler)) { - throw new IOException("WebSocket method must be a GET"); - } - - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - String requestUrl; - if (useRawUrl) { - requestUrl = request.getRawUrl(); - } else { - requestUrl = request.getUrl(); - } - URI uri = AsyncHttpProviderUtils.createUri(requestUrl); - Channel channel = null; - - if (useCache) { - if (f != null && f.reuseChannel() && f.channel() != null) { - channel = f.channel(); - } else { - channel = lookupInCache(uri); - } - } - - ChannelBuffer bufferedBytes = null; - if (f != null && f.getRequest().getFile() == null && - !f.getNettyRequest().getMethod().getName().equals(HttpMethod.CONNECT.getName())) { - bufferedBytes = f.getNettyRequest().getContent(); - } - - boolean useSSl = uri.getScheme().compareToIgnoreCase(HTTPS) == 0 && proxyServer == null; - if (channel != null && channel.isOpen() && channel.isConnected()) { - HttpRequest nettyRequest = buildRequest(config, request, uri, f == null ? false : f.isConnectAllowed(), bufferedBytes); - - if (f == null) { - f = newFuture(uri, request, asyncHandler, nettyRequest, config, this); - } else { - nettyRequest = buildRequest(config, request, uri, f.isConnectAllowed(), bufferedBytes); - f.setNettyRequest(nettyRequest); - } - f.setState(NettyResponseFuture.STATE.POOLED); - f.attachChannel(channel, false); - - log.debug("\nUsing cached Channel {}\n for request \n{}\n", channel, nettyRequest); - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).setAttachment(f); - - try { - writeRequest(channel, config, f, nettyRequest); - } catch (Exception ex) { - log.debug("writeRequest failure", ex); - if (useSSl && ex.getMessage() != null && ex.getMessage().contains("SSLEngine")) { - log.debug("SSLEngine failure", ex); - f = null; - } else { - try { - asyncHandler.onThrowable(ex); - } catch (Throwable t) { - log.warn("doConnect.writeRequest()", t); - } - IOException ioe = new IOException(ex.getMessage()); - ioe.initCause(ex); - throw ioe; - } - } - return f; - } - - // Do not throw an exception when we need an extra connection for a redirect. - if (!reclaimCache && !connectionsPool.canCacheConnection()) { - IOException ex = new IOException(String.format("Too many connections %s", config.getMaxTotalConnections())); - try { - asyncHandler.onThrowable(ex); - } catch (Throwable t) { - log.warn("!connectionsPool.canCacheConnection()", t); - } - throw ex; - } - - boolean acquiredConnection = false; - - if (trackConnections) { - if (!reclaimCache) { - if (!freeConnections.tryAcquire()) { - IOException ex = new IOException(String.format("Too many connections %s", config.getMaxTotalConnections())); - try { - asyncHandler.onThrowable(ex); - } catch (Throwable t) { - log.warn("!connectionsPool.canCacheConnection()", t); - } - throw ex; - } else { - acquiredConnection = true; - } - } - } - - NettyConnectListener c = new NettyConnectListener.Builder(config, request, asyncHandler, f, this, bufferedBytes).build(uri); - boolean avoidProxy = ProxyUtils.avoidProxy(proxyServer, uri.getHost()); - - if (useSSl) { - constructSSLPipeline(c); - } - - ChannelFuture channelFuture; - ClientBootstrap bootstrap = request.getUrl().startsWith(WEBSOCKET) ? webSocketBootstrap : (useSSl ? secureBootstrap : plainBootstrap); - bootstrap.setOption("connectTimeoutMillis", config.getConnectionTimeoutInMs()); - - // Do no enable this with win. - if (System.getProperty("os.name").toLowerCase().indexOf("win") == -1) { - bootstrap.setOption("reuseAddress", asyncHttpProviderConfig.getProperty(NettyAsyncHttpProviderConfig.REUSE_ADDRESS)); - } - - try { - if (request.getInetAddress() != null) { - channelFuture = bootstrap.connect(new InetSocketAddress(request.getInetAddress(), AsyncHttpProviderUtils.getPort(uri))); - } else if (proxyServer == null || avoidProxy) { - channelFuture = bootstrap.connect(new InetSocketAddress(AsyncHttpProviderUtils.getHost(uri), AsyncHttpProviderUtils.getPort(uri))); - } else { - channelFuture = bootstrap.connect(new InetSocketAddress(proxyServer.getHost(), proxyServer.getPort())); - } - } catch (Throwable t) { - if (acquiredConnection) { - freeConnections.release(); - } - abort(c.future(), t.getCause() == null ? t : t.getCause()); - return c.future(); - } - - boolean directInvokation = true; - if (IN_IO_THREAD.get() && DefaultChannelFuture.isUseDeadLockChecker()) { - directInvokation = false; - } - - if (directInvokation && !asyncConnect && request.getFile() == null) { - int timeOut = config.getConnectionTimeoutInMs() > 0 ? config.getConnectionTimeoutInMs() : Integer.MAX_VALUE; - if (!channelFuture.awaitUninterruptibly(timeOut, TimeUnit.MILLISECONDS)) { - if (acquiredConnection) { - freeConnections.release(); - } - channelFuture.cancel(); - abort(c.future(), new ConnectException(String.format("Connect operation to %s timeout %s", uri, timeOut))); - } - - try { - c.operationComplete(channelFuture); - } catch (Exception e) { - if (acquiredConnection) { - freeConnections.release(); - } - IOException ioe = new IOException(e.getMessage()); - ioe.initCause(e); - try { - asyncHandler.onThrowable(ioe); - } catch (Throwable t) { - log.warn("c.operationComplete()", t); - } - throw ioe; - } - } else { - channelFuture.addListener(c); - } - - log.debug("\nNon cached request \n{}\n\nusing Channel \n{}\n", c.future().getNettyRequest(), channelFuture.getChannel()); - - if (!c.future().isCancelled() || !c.future().isDone()) { - openChannels.add(channelFuture.getChannel()); - c.future().attachChannel(channelFuture.getChannel(), false); - } - return c.future(); - } - - protected static int requestTimeout(AsyncHttpClientConfig config, PerRequestConfig perRequestConfig) { - int result; - if (perRequestConfig != null) { - int prRequestTimeout = perRequestConfig.getRequestTimeoutInMs(); - result = (prRequestTimeout != 0 ? prRequestTimeout : config.getRequestTimeoutInMs()); - } else { - result = config.getRequestTimeoutInMs(); - } - return result; - } - - private void closeChannel(final ChannelHandlerContext ctx) { - connectionsPool.removeAll(ctx.getChannel()); - finishChannel(ctx); - } - - private void finishChannel(final ChannelHandlerContext ctx) { - ctx.setAttachment(new DiscardEvent()); - - // The channel may have already been removed if a timeout occurred, and this method may be called just after. - if (ctx.getChannel() == null) { - return; - } - - log.debug("Closing Channel {} ", ctx.getChannel()); - - - try { - ctx.getChannel().close(); - } catch (Throwable t) { - log.debug("Error closing a connection", t); - } - - if (ctx.getChannel() != null) { - openChannels.remove(ctx.getChannel()); - } - - } - - @Override - public void messageReceived(final ChannelHandlerContext ctx, MessageEvent e) throws Exception { - //call super to reset the read timeout - super.messageReceived(ctx, e); - IN_IO_THREAD.set(Boolean.TRUE); - if (ctx.getAttachment() == null) { - log.debug("ChannelHandlerContext wasn't having any attachment"); - } - - if (ctx.getAttachment() instanceof DiscardEvent) { - return; - } else if (ctx.getAttachment() instanceof AsyncCallable) { - if (e.getMessage() instanceof HttpChunk) { - HttpChunk chunk = (HttpChunk) e.getMessage(); - if (chunk.isLast()) { - AsyncCallable ac = (AsyncCallable) ctx.getAttachment(); - ac.call(); - } else { - return; - } - } else { - AsyncCallable ac = (AsyncCallable) ctx.getAttachment(); - ac.call(); - } - ctx.setAttachment(new DiscardEvent()); - return; - } else if (!(ctx.getAttachment() instanceof NettyResponseFuture)) { - try { - ctx.getChannel().close(); - } catch (Throwable t) { - log.trace("Closing an orphan channel {}", ctx.getChannel()); - } - return; - } - - Protocol p = (ctx.getPipeline().get(HttpClientCodec.class) != null ? httpProtocol : webSocketProtocol); - p.handle(ctx, e); - } - - private Realm kerberosChallenge(List proxyAuth, - Request request, - ProxyServer proxyServer, - FluentCaseInsensitiveStringsMap headers, - Realm realm, - NettyResponseFuture future) throws NTLMEngineException { - - URI uri = URI.create(request.getUrl()); - String host = request.getVirtualHost() == null ? AsyncHttpProviderUtils.getHost(uri) : request.getVirtualHost(); - String server = proxyServer == null ? host : proxyServer.getHost(); - try { - String challengeHeader = spnegoEngine.generateToken(server); - headers.remove(HttpHeaders.Names.AUTHORIZATION); - headers.add(HttpHeaders.Names.AUTHORIZATION, "Negotiate " + challengeHeader); - - Realm.RealmBuilder realmBuilder; - if (realm != null) { - realmBuilder = new Realm.RealmBuilder().clone(realm); - } else { - realmBuilder = new Realm.RealmBuilder(); - } - return realmBuilder.setUri(uri.getPath()) - .setMethodName(request.getMethod()) - .setScheme(Realm.AuthScheme.KERBEROS) - .build(); - } catch (Throwable throwable) { - if (proxyAuth.contains("NTLM")) { - return ntlmChallenge(proxyAuth, request, proxyServer, headers, realm, future); - } - abort(future, throwable); - return null; - } - } - - private Realm ntlmChallenge(List wwwAuth, - Request request, - ProxyServer proxyServer, - FluentCaseInsensitiveStringsMap headers, - Realm realm, - NettyResponseFuture future) throws NTLMEngineException { - - boolean useRealm = (proxyServer == null && realm != null); - - String ntlmDomain = useRealm ? realm.getNtlmDomain() : proxyServer.getNtlmDomain(); - String ntlmHost = useRealm ? realm.getNtlmHost() : proxyServer.getHost(); - String principal = useRealm ? realm.getPrincipal() : proxyServer.getPrincipal(); - String password = useRealm ? realm.getPassword() : proxyServer.getPassword(); - - Realm newRealm; - if (realm != null && !realm.isNtlmMessageType2Received()) { - String challengeHeader = ntlmEngine.generateType1Msg(ntlmDomain, ntlmHost); - - headers.add(HttpHeaders.Names.AUTHORIZATION, "NTLM " + challengeHeader); - newRealm = new Realm.RealmBuilder().clone(realm).setScheme(realm.getAuthScheme()) - .setUri(URI.create(request.getUrl()).getPath()) - .setMethodName(request.getMethod()) - .setNtlmMessageType2Received(true) - .build(); - future.getAndSetAuth(false); - } else { - headers.remove(HttpHeaders.Names.AUTHORIZATION); - - if (wwwAuth.get(0).startsWith("NTLM ")) { - String serverChallenge = wwwAuth.get(0).trim().substring("NTLM ".length()); - String challengeHeader = ntlmEngine.generateType3Msg(principal, password, - ntlmDomain, ntlmHost, serverChallenge); - - headers.add(HttpHeaders.Names.AUTHORIZATION, "NTLM " + challengeHeader); - } - - Realm.RealmBuilder realmBuilder; - Realm.AuthScheme authScheme; - if (realm != null) { - realmBuilder = new Realm.RealmBuilder().clone(realm); - authScheme = realm.getAuthScheme(); - } else { - realmBuilder = new Realm.RealmBuilder(); - authScheme = Realm.AuthScheme.NTLM; - } - newRealm = realmBuilder.setScheme(authScheme) - .setUri(URI.create(request.getUrl()).getPath()) - .setMethodName(request.getMethod()) - .build(); - } - - return newRealm; - } - - private Realm ntlmProxyChallenge(List wwwAuth, - Request request, - ProxyServer proxyServer, - FluentCaseInsensitiveStringsMap headers, - Realm realm, - NettyResponseFuture future) throws NTLMEngineException { - future.getAndSetAuth(false); - headers.remove(HttpHeaders.Names.PROXY_AUTHORIZATION); - - if (wwwAuth.get(0).startsWith("NTLM ")) { - String serverChallenge = wwwAuth.get(0).trim().substring("NTLM ".length()); - String challengeHeader = ntlmEngine.generateType3Msg(proxyServer.getPrincipal(), - proxyServer.getPassword(), - proxyServer.getNtlmDomain(), - proxyServer.getHost(), - serverChallenge); - headers.add(HttpHeaders.Names.PROXY_AUTHORIZATION, "NTLM " + challengeHeader); - } - Realm newRealm; - Realm.RealmBuilder realmBuilder; - if (realm != null) { - realmBuilder = new Realm.RealmBuilder().clone(realm); - } else { - realmBuilder = new Realm.RealmBuilder(); - } - newRealm = realmBuilder//.setScheme(realm.getAuthScheme()) - .setUri(URI.create(request.getUrl()).getPath()) - .setMethodName(request.getMethod()) - .build(); - - return newRealm; - } - - private void drainChannel(final ChannelHandlerContext ctx, final NettyResponseFuture future, final boolean keepAlive, final URI uri) { - ctx.setAttachment(new AsyncCallable(future) { - public Object call() throws Exception { - if (keepAlive && ctx.getChannel().isReadable() && connectionsPool.offer(AsyncHttpProviderUtils.getBaseUrl(uri), ctx.getChannel())) { - return null; - } - - finishChannel(ctx); - return null; - } - - @Override - public String toString() { - return String.format("Draining task for channel %s", ctx.getChannel()); - } - }); - } - - private FilterContext handleIoException(FilterContext fc, NettyResponseFuture future) { - for (IOExceptionFilter asyncFilter : config.getIOExceptionFilters()) { - try { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } catch (FilterException efe) { - abort(future, efe); - } - } - return fc; - } - - private void replayRequest(final NettyResponseFuture future, FilterContext fc, HttpResponse response, ChannelHandlerContext ctx) throws IOException { - final Request newRequest = fc.getRequest(); - future.setAsyncHandler(fc.getAsyncHandler()); - future.setState(NettyResponseFuture.STATE.NEW); - future.touch(); - - log.debug("\n\nReplaying Request {}\n for Future {}\n", newRequest, future); - drainChannel(ctx, future, future.getKeepAlive(), future.getURI()); - nextRequest(newRequest, future); - return; - } - - private List getAuthorizationToken(List> list, String headerAuth) { - ArrayList l = new ArrayList(); - for (Entry e : list) { - if (e.getKey().equalsIgnoreCase(headerAuth)) { - l.add(e.getValue().trim()); - } - } - return l; - } - - private void nextRequest(final Request request, final NettyResponseFuture future) throws IOException { - nextRequest(request, future, true); - } - - private void nextRequest(final Request request, final NettyResponseFuture future, final boolean useCache) throws IOException { - execute(request, future, useCache, true, true); - } - - private void abort(NettyResponseFuture future, Throwable t) { - Channel channel = future.channel(); - if (channel != null && openChannels.contains(channel)) { - closeChannel(channel.getPipeline().getContext(NettyAsyncHttpProvider.class)); - openChannels.remove(channel); - } - - if (!future.isCancelled() && !future.isDone()) { - log.debug("Aborting Future {}\n", future); - log.debug(t.getMessage(), t); - } - - future.abort(t); - } - - private void upgradeProtocol(ChannelPipeline p, String scheme) throws IOException, GeneralSecurityException { - if (p.get(HTTP_HANDLER) != null) { - p.remove(HTTP_HANDLER); - } - - if (scheme.startsWith(HTTPS)) { - if (p.get(SSL_HANDLER) == null) { - p.addFirst(HTTP_HANDLER, new HttpClientCodec()); - p.addFirst(SSL_HANDLER, new SslHandler(createSSLEngine())); - } else { - p.addAfter(SSL_HANDLER, HTTP_HANDLER, new HttpClientCodec()); - } - - } else { - p.addFirst(HTTP_HANDLER, new HttpClientCodec()); - } - } - - public void channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { - - if (isClose.get()) { - return; - } - - connectionsPool.removeAll(ctx.getChannel()); - try { - super.channelClosed(ctx, e); - } catch (Exception ex) { - log.trace("super.channelClosed", ex); - } - - log.debug("Channel Closed: {} with attachment {}", e.getChannel(), ctx.getAttachment()); - - if (ctx.getAttachment() instanceof AsyncCallable) { - AsyncCallable ac = (AsyncCallable) ctx.getAttachment(); - ctx.setAttachment(ac.future()); - ac.call(); - return; - } - - if (ctx.getAttachment() instanceof NettyResponseFuture) { - NettyResponseFuture future = (NettyResponseFuture) ctx.getAttachment(); - future.touch(); - - if (config.getIOExceptionFilters().size() > 0) { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(future.getAsyncHandler()) - .request(future.getRequest()).ioException(new IOException("Channel Closed")).build(); - fc = handleIoException(fc, future); - - if (fc.replayRequest() && !future.cannotBeReplay()) { - replayRequest(future, fc, null, ctx); - return; - } - } - - Protocol p = (ctx.getPipeline().get(HttpClientCodec.class) != null ? httpProtocol : webSocketProtocol); - p.onClose(ctx, e); - - if (future != null && !future.isDone() && !future.isCancelled()) { - if (!remotelyClosed(ctx.getChannel(), future)) { - abort(future, new IOException("Remotely Closed " + ctx.getChannel())); - } - } else { - closeChannel(ctx); - } - } - } - - protected boolean remotelyClosed(Channel channel, NettyResponseFuture future) { - - if (isClose.get()) { - return false; - } - - connectionsPool.removeAll(channel); - - if (future == null && channel.getPipeline().getContext(NettyAsyncHttpProvider.class).getAttachment() != null - && NettyResponseFuture.class.isAssignableFrom( - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).getAttachment().getClass())) { - future = (NettyResponseFuture) - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).getAttachment(); - } - - if (future == null || future.cannotBeReplay()) { - log.debug("Unable to recover future {}\n", future); - return false; - } - - future.setState(NettyResponseFuture.STATE.RECONNECTED); - - log.debug("Trying to recover request {}\n", future.getNettyRequest()); - - try { - nextRequest(future.getRequest(), future); - return true; - } catch (IOException iox) { - future.setState(NettyResponseFuture.STATE.CLOSED); - future.abort(iox); - log.error("Remotely Closed, unable to recover", iox); - } - return false; - } - - private void markAsDone(final NettyResponseFuture future, final ChannelHandlerContext ctx) throws MalformedURLException { - // We need to make sure everything is OK before adding the connection back to the pool. - try { - future.done(null); - } catch (Throwable t) { - // Never propagate exception once we know we are done. - log.debug(t.getMessage(), t); - } - - if (!future.getKeepAlive() || !ctx.getChannel().isReadable()) { - closeChannel(ctx); - } - } - - private void finishUpdate(final NettyResponseFuture future, final ChannelHandlerContext ctx, boolean lastValidChunk) throws IOException { - if (lastValidChunk && future.getKeepAlive()) { - drainChannel(ctx, future, future.getKeepAlive(), future.getURI()); - } else { - if (future.getKeepAlive() && ctx.getChannel().isReadable() && - connectionsPool.offer(AsyncHttpProviderUtils.getBaseUrl(future.getURI()), ctx.getChannel())) { - markAsDone(future, ctx); - return; - } - finishChannel(ctx); - } - markAsDone(future, ctx); - } - - @SuppressWarnings("unchecked") - private final boolean updateStatusAndInterrupt(AsyncHandler handler, HttpResponseStatus c) throws Exception { - return handler.onStatusReceived(c) != STATE.CONTINUE; - } - - @SuppressWarnings("unchecked") - private final boolean updateHeadersAndInterrupt(AsyncHandler handler, HttpResponseHeaders c) throws Exception { - return handler.onHeadersReceived(c) != STATE.CONTINUE; - } - - @SuppressWarnings("unchecked") - private final boolean updateBodyAndInterrupt(final NettyResponseFuture future, AsyncHandler handler, HttpResponseBodyPart c) throws Exception { - boolean state = handler.onBodyPartReceived(c) != STATE.CONTINUE; - if (c.closeUnderlyingConnection()) { - future.setKeepAlive(false); - } - return state; - } - - //Simple marker for stopping publishing bytes. - - final static class DiscardEvent { - } - - @Override - public void exceptionCaught(ChannelHandlerContext ctx, ExceptionEvent e) - throws Exception { - Channel channel = e.getChannel(); - Throwable cause = e.getCause(); - NettyResponseFuture future = null; - - if (log.isDebugEnabled()) { - log.debug("Unexpected I/O exception on channel {}", channel, cause); - } - - try { - - if (cause != null && ClosedChannelException.class.isAssignableFrom(cause.getClass())) { - return; - } - - if (ctx.getAttachment() instanceof NettyResponseFuture) { - future = (NettyResponseFuture) ctx.getAttachment(); - future.attachChannel(null, false); - future.touch(); - - if (IOException.class.isAssignableFrom(cause.getClass())) { - - if (config.getIOExceptionFilters().size() > 0) { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(future.getAsyncHandler()) - .request(future.getRequest()).ioException(new IOException("Channel Closed")).build(); - fc = handleIoException(fc, future); - - if (fc.replayRequest()) { - replayRequest(future, fc, null, ctx); - return; - } - } else { - // Close the channel so the recovering can occurs. - try { - ctx.getChannel().close(); - } catch (Throwable t) { - ; // Swallow. - } - return; - } - } - - if (abortOnReadCloseException(cause) || abortOnWriteCloseException(cause)) { - log.debug("Trying to recover from dead Channel: {}", channel); - return; - } - } else if (ctx.getAttachment() instanceof AsyncCallable) { - future = ((AsyncCallable) ctx.getAttachment()).future(); - } - } catch (Throwable t) { - cause = t; - } - - if (future != null) { - try { - log.debug("Was unable to recover Future: {}", future); - abort(future, cause); - } catch (Throwable t) { - log.error(t.getMessage(), t); - } - } - closeChannel(ctx); - ctx.sendUpstream(e); - - Protocol p = (ctx.getPipeline().get(HttpClientCodec.class) != null ? httpProtocol : webSocketProtocol); - p.onError(ctx, e); - } - - protected static boolean abortOnConnectCloseException(Throwable cause) { - try { - for (StackTraceElement element : cause.getStackTrace()) { - if (element.getClassName().equals("sun.nio.ch.SocketChannelImpl") - && element.getMethodName().equals("checkConnect")) { - return true; - } - } - - if (cause.getCause() != null) { - return abortOnConnectCloseException(cause.getCause()); - } - - } catch (Throwable t) { - } - return false; - } - - protected static boolean abortOnDisconnectException(Throwable cause) { - try { - for (StackTraceElement element : cause.getStackTrace()) { - if (element.getClassName().equals("org.jboss.netty.handler.ssl.SslHandler") - && element.getMethodName().equals("channelDisconnected")) { - return true; - } - } - - if (cause.getCause() != null) { - return abortOnConnectCloseException(cause.getCause()); - } - - } catch (Throwable t) { - } - return false; - } - - protected static boolean abortOnReadCloseException(Throwable cause) { - - for (StackTraceElement element : cause.getStackTrace()) { - if (element.getClassName().equals("sun.nio.ch.SocketDispatcher") - && element.getMethodName().equals("read")) { - return true; - } - } - - if (cause.getCause() != null) { - return abortOnReadCloseException(cause.getCause()); - } - - return false; - } - - protected static boolean abortOnWriteCloseException(Throwable cause) { - - for (StackTraceElement element : cause.getStackTrace()) { - if (element.getClassName().equals("sun.nio.ch.SocketDispatcher") - && element.getMethodName().equals("write")) { - return true; - } - } - - if (cause.getCause() != null) { - return abortOnReadCloseException(cause.getCause()); - } - - return false; - } - - private final static int computeAndSetContentLength(Request request, HttpRequest r) { - int length = (int) request.getContentLength(); - if (length == -1 && r.getHeader(HttpHeaders.Names.CONTENT_LENGTH) != null) { - length = Integer.valueOf(r.getHeader(HttpHeaders.Names.CONTENT_LENGTH)); - } - - if (length >= 0) { - r.setHeader(HttpHeaders.Names.CONTENT_LENGTH, String.valueOf(length)); - } - return length; - } - - public static NettyResponseFuture newFuture(URI uri, - Request request, - AsyncHandler asyncHandler, - HttpRequest nettyRequest, - AsyncHttpClientConfig config, - NettyAsyncHttpProvider provider) { - - NettyResponseFuture f = new NettyResponseFuture(uri, request, asyncHandler, nettyRequest, - requestTimeout(config, request.getPerRequestConfig()), config.getIdleConnectionTimeoutInMs(), provider); - - if (request.getHeaders().getFirstValue("Expect") != null - && request.getHeaders().getFirstValue("Expect").equalsIgnoreCase("100-Continue")) { - f.getAndSetWriteBody(false); - } - return f; - } - - private class ProgressListener implements ChannelFutureProgressListener { - - private final boolean notifyHeaders; - private final AsyncHandler asyncHandler; - private final NettyResponseFuture future; - - public ProgressListener(boolean notifyHeaders, AsyncHandler asyncHandler, NettyResponseFuture future) { - this.notifyHeaders = notifyHeaders; - this.asyncHandler = asyncHandler; - this.future = future; - } - - public void operationComplete(ChannelFuture cf) { - // The write operation failed. If the channel was cached, it means it got asynchronously closed. - // Let's retry a second time. - Throwable cause = cf.getCause(); - if (cause != null && future.getState() != NettyResponseFuture.STATE.NEW) { - - if (IllegalStateException.class.isAssignableFrom(cause.getClass())) { - log.debug(cause.getMessage(), cause); - try { - cf.getChannel().close(); - } catch (RuntimeException ex) { - log.debug(ex.getMessage(), ex); - } - return; - } - - if (ClosedChannelException.class.isAssignableFrom(cause.getClass()) - || abortOnReadCloseException(cause) - || abortOnWriteCloseException(cause)) { - - if (log.isDebugEnabled()) { - log.debug(cf.getCause() == null ? "" : cf.getCause().getMessage(), cf.getCause()); - } - - try { - cf.getChannel().close(); - } catch (RuntimeException ex) { - log.debug(ex.getMessage(), ex); - } - return; - } else { - future.abort(cause); - } - return; - } - future.touch(); - - /** - * We need to make sure we aren't in the middle of an authorization process before publishing events - * as we will re-publish again the same event after the authorization, causing unpredictable behavior. - */ - Realm realm = future.getRequest().getRealm() != null ? future.getRequest().getRealm() : NettyAsyncHttpProvider.this.getConfig().getRealm(); - boolean startPublishing = future.isInAuth() - || realm == null - || realm.getUsePreemptiveAuth() == true; - - if (startPublishing && ProgressAsyncHandler.class.isAssignableFrom(asyncHandler.getClass())) { - if (notifyHeaders) { - ProgressAsyncHandler.class.cast(asyncHandler).onHeaderWriteCompleted(); - } else { - ProgressAsyncHandler.class.cast(asyncHandler).onContentWriteCompleted(); - } - } - } - - public void operationProgressed(ChannelFuture cf, long amount, long current, long total) { - future.touch(); - if (ProgressAsyncHandler.class.isAssignableFrom(asyncHandler.getClass())) { - ProgressAsyncHandler.class.cast(asyncHandler).onContentWriteProgress(amount, current, total); - } - } - } - - /** - * Because some implementation of the ThreadSchedulingService do not clean up cancel task until they try to run - * them, we wrap the task with the future so the when the NettyResponseFuture cancel the reaper future - * this wrapper will release the references to the channel and the nettyResponseFuture immediately. Otherwise, - * the memory referenced this way will only be released after the request timeout period which can be arbitrary long. - */ - private final class ReaperFuture implements Future, Runnable { - private Future scheduledFuture; - private Channel channel; - private NettyResponseFuture nettyResponseFuture; - - public ReaperFuture(Channel channel, NettyResponseFuture nettyResponseFuture) { - this.channel = channel; - this.nettyResponseFuture = nettyResponseFuture; - } - - public void setScheduledFuture(Future scheduledFuture) { - this.scheduledFuture = scheduledFuture; - } - - /** - * @Override - */ - public synchronized boolean cancel(boolean mayInterruptIfRunning) { - //cleanup references to allow gc to reclaim memory independently - //of this Future lifecycle - this.channel = null; - this.nettyResponseFuture = null; - return this.scheduledFuture.cancel(mayInterruptIfRunning); - } - - /** - * @Override - */ - public Object get() throws InterruptedException, ExecutionException { - return this.scheduledFuture.get(); - } - - /** - * @Override - */ - public Object get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { - return this.scheduledFuture.get(timeout, unit); - } - - /** - * @Override - */ - public boolean isCancelled() { - return this.scheduledFuture.isCancelled(); - } - - /** - * @Override - */ - public boolean isDone() { - return this.scheduledFuture.isDone(); - } - - /** - * @Override - */ - public synchronized void run() { - if (isClose.get()) { - cancel(true); - return; - } - - if (this.nettyResponseFuture != null && this.nettyResponseFuture.hasExpired() - && !this.nettyResponseFuture.isDone() && !this.nettyResponseFuture.isCancelled()) { - log.debug("Request Timeout expired for {}\n", this.nettyResponseFuture); - - int requestTimeout = config.getRequestTimeoutInMs(); - PerRequestConfig p = this.nettyResponseFuture.getRequest().getPerRequestConfig(); - if (p != null && p.getRequestTimeoutInMs() != -1) { - requestTimeout = p.getRequestTimeoutInMs(); - } - - abort(this.nettyResponseFuture, new TimeoutException(String.format("No response received after %s", requestTimeout))); - - this.nettyResponseFuture = null; - this.channel = null; - } - - if (this.nettyResponseFuture == null || this.nettyResponseFuture.isDone() || this.nettyResponseFuture.isCancelled()) { - cancel(true); - } - } - } - - private abstract class AsyncCallable implements Callable { - - private final NettyResponseFuture future; - - public AsyncCallable(NettyResponseFuture future) { - this.future = future; - } - - abstract public Object call() throws Exception; - - public NettyResponseFuture future() { - return future; - } - } - - public static class ThreadLocalBoolean extends ThreadLocal { - - private final boolean defaultValue; - - public ThreadLocalBoolean() { - this(false); - } - - public ThreadLocalBoolean(boolean defaultValue) { - this.defaultValue = defaultValue; - } - - @Override - protected Boolean initialValue() { - return defaultValue ? Boolean.TRUE : Boolean.FALSE; - } - } - - public static class OptimizedFileRegion implements FileRegion { - - private final FileChannel file; - private final RandomAccessFile raf; - private final long position; - private final long count; - private long byteWritten; - - public OptimizedFileRegion(RandomAccessFile raf, long position, long count) { - this.raf = raf; - this.file = raf.getChannel(); - this.position = position; - this.count = count; - } - - public long getPosition() { - return position; - } - - public long getCount() { - return count; - } - - public long transferTo(WritableByteChannel target, long position) throws IOException { - long count = this.count - position; - if (count < 0 || position < 0) { - throw new IllegalArgumentException( - "position out of range: " + position + - " (expected: 0 - " + (this.count - 1) + ")"); - } - if (count == 0) { - return 0L; - } - - long bw = file.transferTo(this.position + position, count, target); - byteWritten += bw; - if (byteWritten == raf.length()) { - releaseExternalResources(); - } - return bw; - } - - public void releaseExternalResources() { - try { - file.close(); - } catch (IOException e) { - log.warn("Failed to close a file.", e); - } - - try { - raf.close(); - } catch (IOException e) { - log.warn("Failed to close a file.", e); - } - } - } - - private static class NettyTransferAdapter extends TransferCompletionHandler.TransferAdapter { - - private final ChannelBuffer content; - private final FileInputStream file; - private int byteRead = 0; - - public NettyTransferAdapter(FluentCaseInsensitiveStringsMap headers, ChannelBuffer content, File file) throws IOException { - super(headers); - this.content = content; - if (file != null) { - this.file = new FileInputStream(file); - } else { - this.file = null; - } - } - - @Override - public void getBytes(byte[] bytes) { - if (content.writableBytes() != 0) { - content.getBytes(byteRead, bytes); - byteRead += bytes.length; - } else if (file != null) { - try { - byteRead += file.read(bytes); - } catch (IOException e) { - log.error(e.getMessage(), e); - } - } - } - } - - protected AsyncHttpClientConfig getConfig() { - return config; - } - - private static class NonConnectionsPool implements ConnectionsPool { - - public boolean offer(String uri, Channel connection) { - return false; - } - - public Channel poll(String uri) { - return null; - } - - public boolean removeAll(Channel connection) { - return false; - } - - public boolean canCacheConnection() { - return true; - } - - public void destroy() { - } - } - - private static final boolean validateWebSocketRequest(Request request, AsyncHandler asyncHandler) { - if (request.getMethod() != "GET" || !WebSocketUpgradeHandler.class.isAssignableFrom(asyncHandler.getClass())) { - return false; - } - return true; - } - - private final class HttpProtocol implements Protocol { - @Override - public void handle(final ChannelHandlerContext ctx, final MessageEvent e) throws Exception { - final NettyResponseFuture future = (NettyResponseFuture) ctx.getAttachment(); - future.touch(); - - // The connect timeout occured. - if (future.isCancelled() || future.isDone()) { - finishChannel(ctx); - return; - } - - HttpRequest nettyRequest = future.getNettyRequest(); - AsyncHandler handler = future.getAsyncHandler(); - Request request = future.getRequest(); - HttpResponse response = null; - try { - if (e.getMessage() instanceof HttpResponse) { - response = (HttpResponse) e.getMessage(); - - log.debug("\n\nRequest {}\n\nResponse {}\n", nettyRequest, response); - - // Required if there is some trailing headers. - future.setHttpResponse(response); - - int statusCode = response.getStatus().getCode(); - - String ka = response.getHeader(HttpHeaders.Names.CONNECTION); - future.setKeepAlive(ka == null || ka.toLowerCase().equals("keep-alive")); - - List wwwAuth = getAuthorizationToken(response.getHeaders(), HttpHeaders.Names.WWW_AUTHENTICATE); - Realm realm = request.getRealm() != null ? request.getRealm() : config.getRealm(); - - HttpResponseStatus status = new ResponseStatus(future.getURI(), response, NettyAsyncHttpProvider.this); - HttpResponseHeaders responseHeaders = new ResponseHeaders(future.getURI(), response, NettyAsyncHttpProvider.this); - FilterContext fc = new FilterContext.FilterContextBuilder() - .asyncHandler(handler) - .request(request) - .responseStatus(status) - .responseHeaders(responseHeaders) - .build(); - - for (ResponseFilter asyncFilter : config.getResponseFilters()) { - try { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } catch (FilterException efe) { - abort(future, efe); - } - } - - // The handler may have been wrapped. - handler = fc.getAsyncHandler(); - future.setAsyncHandler(handler); - - // The request has changed - if (fc.replayRequest()) { - replayRequest(future, fc, response, ctx); - return; - } - - Realm newRealm = null; - ProxyServer proxyServer = request.getProxyServer() != null ? request.getProxyServer() : config.getProxyServer(); - final FluentCaseInsensitiveStringsMap headers = request.getHeaders(); - final RequestBuilder builder = new RequestBuilder(future.getRequest()); - - //if (realm != null && !future.getURI().getPath().equalsIgnoreCase(realm.getUri())) { - // builder.setUrl(future.getURI().toString()); - //} - - if (statusCode == 401 - && wwwAuth.size() > 0 - && !future.getAndSetAuth(true)) { - - future.setState(NettyResponseFuture.STATE.NEW); - // NTLM - if (!wwwAuth.contains("Kerberos") && (wwwAuth.contains("NTLM") || (wwwAuth.contains("Negotiate")))) { - newRealm = ntlmChallenge(wwwAuth, request, proxyServer, headers, realm, future); - // SPNEGO KERBEROS - } else if (wwwAuth.contains("Negotiate")) { - newRealm = kerberosChallenge(wwwAuth, request, proxyServer, headers, realm, future); - if (newRealm == null) return; - } else { - Realm.RealmBuilder realmBuilder; - if (realm != null) { - realmBuilder = new Realm.RealmBuilder().clone(realm).setScheme(realm.getAuthScheme()) - ; - } else { - realmBuilder = new Realm.RealmBuilder(); - } - newRealm = realmBuilder - .setUri(URI.create(request.getUrl()).getPath()) - .setMethodName(request.getMethod()) - .setUsePreemptiveAuth(true) - .parseWWWAuthenticateHeader(wwwAuth.get(0)) - .build(); - } - - final Realm nr = new Realm.RealmBuilder().clone(newRealm) - .setUri(request.getUrl()).build(); - - log.debug("Sending authentication to {}", request.getUrl()); - AsyncCallable ac = new AsyncCallable(future) { - public Object call() throws Exception { - drainChannel(ctx, future, future.getKeepAlive(), future.getURI()); - nextRequest(builder.setHeaders(headers).setRealm(nr).build(), future); - return null; - } - }; - - if (future.getKeepAlive() && response.isChunked()) { - // We must make sure there is no bytes left before executing the next request. - ctx.setAttachment(ac); - } else { - ac.call(); - } - return; - } - - if (statusCode == 100) { - future.getAndSetWriteHeaders(false); - future.getAndSetWriteBody(true); - writeRequest(ctx.getChannel(), config, future, nettyRequest); - return; - } - - List proxyAuth = getAuthorizationToken(response.getHeaders(), HttpHeaders.Names.PROXY_AUTHENTICATE); - if (statusCode == 407 - && proxyAuth.size() > 0 - && !future.getAndSetAuth(true)) { - - log.debug("Sending proxy authentication to {}", request.getUrl()); - - future.setState(NettyResponseFuture.STATE.NEW); - - if (!proxyAuth.contains("Kerberos") && (proxyAuth.get(0).contains("NTLM") || (proxyAuth.contains("Negotiate")))) { - newRealm = ntlmProxyChallenge(proxyAuth, request, proxyServer, headers, realm, future); - // SPNEGO KERBEROS - } else if (proxyAuth.contains("Negotiate")) { - newRealm = kerberosChallenge(proxyAuth, request, proxyServer, headers, realm, future); - if (newRealm == null) return; - } else { - newRealm = future.getRequest().getRealm(); - } - - Request req = builder.setHeaders(headers).setRealm(newRealm).build(); - future.setReuseChannel(true); - future.setConnectAllowed(true); - nextRequest(req, future); - return; - } - - if (future.getNettyRequest().getMethod().equals(HttpMethod.CONNECT) - && statusCode == 200) { - - log.debug("Connected to {}:{}", proxyServer.getHost(), proxyServer.getPort()); - - if (future.getKeepAlive()) { - future.attachChannel(ctx.getChannel(), true); - } - - try { - log.debug("Connecting to proxy {} for scheme {}", proxyServer, request.getUrl()); - upgradeProtocol(ctx.getChannel().getPipeline(), request.getUrl()); - } catch (Throwable ex) { - abort(future, ex); - } - Request req = builder.build(); - future.setReuseChannel(true); - future.setConnectAllowed(false); - nextRequest(req, future); - return; - } - - boolean redirectEnabled = request.isRedirectOverrideSet() ? request.isRedirectEnabled() : config.isRedirectEnabled(); - if (redirectEnabled && (statusCode == 302 - || statusCode == 301 - || statusCode == 303 - || statusCode == 307)) { - - if (future.incrementAndGetCurrentRedirectCount() < config.getMaxRedirects()) { - // We must allow 401 handling again. - future.getAndSetAuth(false); - - String location = response.getHeader(HttpHeaders.Names.LOCATION); - URI uri = AsyncHttpProviderUtils.getRedirectUri(future.getURI(), location); - boolean stripQueryString = config.isRemoveQueryParamOnRedirect(); - if (!uri.toString().equalsIgnoreCase(future.getURI().toString())) { - final RequestBuilder nBuilder = stripQueryString ? - new RequestBuilder(future.getRequest()).setQueryParameters(null) - : new RequestBuilder(future.getRequest()); - - if (!(statusCode < 302 || statusCode > 303) - && !(statusCode == 302 - && config.isStrict302Handling())) { - nBuilder.setMethod("GET"); - } - final URI initialConnectionUri = future.getURI(); - final boolean initialConnectionKeepAlive = future.getKeepAlive(); - future.setURI(uri); - final String newUrl = uri.toString(); - - log.debug("Redirecting to {}", newUrl); - for (String cookieStr : future.getHttpResponse().getHeaders(HttpHeaders.Names.SET_COOKIE)) { - Cookie c = AsyncHttpProviderUtils.parseCookie(cookieStr); - nBuilder.addOrReplaceCookie(c); - } - - for (String cookieStr : future.getHttpResponse().getHeaders(HttpHeaders.Names.SET_COOKIE2)) { - Cookie c = AsyncHttpProviderUtils.parseCookie(cookieStr); - nBuilder.addOrReplaceCookie(c); - } - - AsyncCallable ac = new AsyncCallable(future) { - public Object call() throws Exception { - if (initialConnectionKeepAlive && ctx.getChannel().isReadable() && - connectionsPool.offer(AsyncHttpProviderUtils.getBaseUrl(initialConnectionUri), ctx.getChannel())) { - return null; - } - finishChannel(ctx); - return null; - } - }; - - if (response.isChunked()) { - // We must make sure there is no bytes left before executing the next request. - ctx.setAttachment(ac); - } else { - ac.call(); - } - nextRequest(nBuilder.setUrl(newUrl).build(), future); - return; - } - } else { - throw new MaxRedirectException("Maximum redirect reached: " + config.getMaxRedirects()); - } - } - - if (!future.getAndSetStatusReceived(true) && updateStatusAndInterrupt(handler, status)) { - finishUpdate(future, ctx, response.isChunked()); - return; - } else if (updateHeadersAndInterrupt(handler, responseHeaders)) { - finishUpdate(future, ctx, response.isChunked()); - return; - } else if (!response.isChunked()) { - if (response.getContent().readableBytes() != 0) { - updateBodyAndInterrupt(future, handler, new ResponseBodyPart(future.getURI(), response, NettyAsyncHttpProvider.this, true)); - } - finishUpdate(future, ctx, false); - return; - } - - if (nettyRequest.getMethod().equals(HttpMethod.HEAD)) { - updateBodyAndInterrupt(future, handler, new ResponseBodyPart(future.getURI(), response, NettyAsyncHttpProvider.this, true)); - markAsDone(future, ctx); - drainChannel(ctx, future, future.getKeepAlive(), future.getURI()); - } - - } else if (e.getMessage() instanceof HttpChunk) { - HttpChunk chunk = (HttpChunk) e.getMessage(); - - if (handler != null) { - if (chunk.isLast() || updateBodyAndInterrupt(future, handler, - new ResponseBodyPart(future.getURI(), null, NettyAsyncHttpProvider.this, chunk, chunk.isLast()))) { - if (chunk instanceof DefaultHttpChunkTrailer) { - updateHeadersAndInterrupt(handler, new ResponseHeaders(future.getURI(), - future.getHttpResponse(), NettyAsyncHttpProvider.this, (HttpChunkTrailer) chunk)); - } - finishUpdate(future, ctx, !chunk.isLast()); - } - } - } - } catch (Exception t) { - if (IOException.class.isAssignableFrom(t.getClass()) && config.getIOExceptionFilters().size() > 0) { - FilterContext fc = new FilterContext.FilterContextBuilder().asyncHandler(future.getAsyncHandler()) - .request(future.getRequest()).ioException(IOException.class.cast(t)).build(); - fc = handleIoException(fc, future); - - if (fc.replayRequest()) { - replayRequest(future, fc, response, ctx); - return; - } - } - - try { - abort(future, t); - } finally { - finishUpdate(future, ctx, false); - throw t; - } - } - } - - @Override - public void onError(ChannelHandlerContext ctx, ExceptionEvent e) { - } - - @Override - public void onClose(ChannelHandlerContext ctx, ChannelStateEvent e) { - } - } - - private final class WebSocketProtocol implements Protocol { - - @Override - public void handle(ChannelHandlerContext ctx, MessageEvent e) throws Exception { - NettyResponseFuture future = NettyResponseFuture.class.cast(ctx.getAttachment()); - WebSocketUpgradeHandler h = WebSocketUpgradeHandler.class.cast(future.getAsyncHandler()); - Request request = future.getRequest(); - - if (e.getMessage() instanceof HttpResponse) { - HttpResponse response = (HttpResponse) e.getMessage(); - - HttpResponseStatus s = new ResponseStatus(future.getURI(), response, NettyAsyncHttpProvider.this); - HttpResponseHeaders responseHeaders = new ResponseHeaders(future.getURI(), response, NettyAsyncHttpProvider.this); - FilterContext fc = new FilterContext.FilterContextBuilder() - .asyncHandler(h) - .request(request) - .responseStatus(s) - .responseHeaders(responseHeaders) - .build(); - for (ResponseFilter asyncFilter : config.getResponseFilters()) { - try { - fc = asyncFilter.filter(fc); - if (fc == null) { - throw new NullPointerException("FilterContext is null"); - } - } catch (FilterException efe) { - abort(future, efe); - } - } - - // The handler may have been wrapped. - future.setAsyncHandler(fc.getAsyncHandler()); - - // The request has changed - if (fc.replayRequest()) { - replayRequest(future, fc, response, ctx); - return; - } - - final org.jboss.netty.handler.codec.http.HttpResponseStatus status = - new org.jboss.netty.handler.codec.http.HttpResponseStatus(101, "Web Socket Protocol Handshake"); - - final boolean validStatus = response.getStatus().equals(status); - final boolean validUpgrade = response.getHeader(HttpHeaders.Names.UPGRADE) != null; - String c = response.getHeader(HttpHeaders.Names.CONNECTION); - final boolean validConnection = c == null ? false : c.equals(HttpHeaders.Values.UPGRADE); - - s = new ResponseStatus(future.getURI(), response, NettyAsyncHttpProvider.this); - final boolean statusReceived = h.onStatusReceived(s) == STATE.UPGRADE; - - if (!validStatus || !validUpgrade || !validConnection || !statusReceived) { - throw new IOException("Invalid handshake response"); - } - - String accept = response.getHeader("Sec-WebSocket-Accept"); - String key = WebSocketUtil.getAcceptKey(future.getNettyRequest().getHeader(WEBSOCKET_KEY)); - if (accept == null || !accept.equals(key)) { - throw new IOException(String.format("Invalid challenge. Actual: %s. Expected: %s", accept, key)); - } - - ctx.getPipeline().replace("ws-decoder", "ws-decoder", new WebSocket08FrameDecoder(false, false)); - ctx.getPipeline().replace("ws-encoder", "ws-encoder", new WebSocket08FrameEncoder(true)); - if (h.onHeadersReceived(responseHeaders) == STATE.CONTINUE) { - h.onSuccess(new NettyWebSocket(ctx.getChannel())); - } - future.done(null); - } else if (e.getMessage() instanceof WebSocketFrame) { - final WebSocketFrame frame = (WebSocketFrame) e.getMessage(); - - HttpChunk webSocketChunk = new HttpChunk() { - private ChannelBuffer content; - - @Override - public boolean isLast() { - return false; - } - - @Override - public ChannelBuffer getContent() { - return content; - } - - @Override - public void setContent(ChannelBuffer content) { - this.content = content; - } - }; - - webSocketChunk.setContent(ChannelBuffers.wrappedBuffer(frame.getBinaryData())); - ResponseBodyPart rp = new ResponseBodyPart(future.getURI(), null, NettyAsyncHttpProvider.this, webSocketChunk, true); - h.onBodyPartReceived(rp); - - NettyWebSocket webSocket = NettyWebSocket.class.cast(h.onCompleted()); - webSocket.onMessage(rp.getBodyPartBytes()); - webSocket.onTextMessage(frame.getBinaryData().toString("UTF-8")); - } else { - log.error("Invalid attachment {}", ctx.getAttachment()); - } - } - - @Override - public void onError(ChannelHandlerContext ctx, ExceptionEvent e) { - try { - log.trace("onError {}", e); - if (!NettyResponseFuture.class.isAssignableFrom(ctx.getAttachment().getClass())) { - return; - } - - NettyResponseFuture nettyResponse = NettyResponseFuture.class.cast(ctx.getAttachment()); - WebSocketUpgradeHandler h = WebSocketUpgradeHandler.class.cast(nettyResponse.getAsyncHandler()); - - NettyWebSocket webSocket = NettyWebSocket.class.cast(h.onCompleted()); - webSocket.onError(e.getCause()); - webSocket.close(); - } catch (Throwable t) { - log.error("onError", t); - } - } - - @Override - public void onClose(ChannelHandlerContext ctx, ChannelStateEvent e) { - log.trace("onClose {}", e); - if (!NettyResponseFuture.class.isAssignableFrom(ctx.getAttachment().getClass())) { - return; - } - - try { - NettyResponseFuture nettyResponse = NettyResponseFuture.class.cast(ctx.getAttachment()); - WebSocketUpgradeHandler h = WebSocketUpgradeHandler.class.cast(nettyResponse.getAsyncHandler()); - NettyWebSocket webSocket = NettyWebSocket.class.cast(h.onCompleted()); - - webSocket.close(); - } catch (Throwable t) { - log.error("onError", t); - } - } - } -} - diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProviderConfig.java b/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProviderConfig.java deleted file mode 100644 index 7c976149e6..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProviderConfig.java +++ /dev/null @@ -1,106 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHttpProviderConfig; - -import java.util.Map; -import java.util.Set; -import java.util.concurrent.ConcurrentHashMap; - -/** - * This class can be used to pass Netty's internal configuration options. See Netty documentation for more information. - */ -public class NettyAsyncHttpProviderConfig implements AsyncHttpProviderConfig { - - /** - * Use Netty's blocking IO stategy. - */ - public final static String USE_BLOCKING_IO = "useBlockingIO"; - - /** - * Use direct {@link java.nio.ByteBuffer} - */ - public final static String USE_DIRECT_BYTEBUFFER = "bufferFactory"; - - /** - * Execute the connect operation asynchronously. - */ - public final static String EXECUTE_ASYNC_CONNECT = "asyncConnect"; - - /** - * Allow nested request from any {@link com.ning.http.client.AsyncHandler} - */ - public final static String DISABLE_NESTED_REQUEST = "disableNestedRequest"; - - /** - * Allow configuring the Netty's boss executor service. - */ - public final static String BOSS_EXECUTOR_SERVICE = "bossExecutorService"; - - /** - * See {@link java.net.Socket#setReuseAddress(boolean)} - */ - public final static String REUSE_ADDRESS = "reuseAddress"; - - private final ConcurrentHashMap properties = new ConcurrentHashMap(); - - public NettyAsyncHttpProviderConfig() { - properties.put(REUSE_ADDRESS, "false"); - } - - /** - * Add a property that will be used when the AsyncHttpClient initialize its {@link com.ning.http.client.AsyncHttpProvider} - * - * @param name the name of the property - * @param value the value of the property - * @return this instance of AsyncHttpProviderConfig - */ - public NettyAsyncHttpProviderConfig addProperty(String name, Object value) { - properties.put(name, value); - return this; - } - - /** - * Return the value associated with the property's name - * - * @param name - * @return this instance of AsyncHttpProviderConfig - */ - public Object getProperty(String name) { - return properties.get(name); - } - - /** - * Remove the value associated with the property's name - * - * @param name - * @return true if removed - */ - public Object removeProperty(String name) { - return properties.remove(name); - } - - /** - * Return the curent entry set. - * - * @return a the curent entry set. - */ - public Set> propertiesSet() { - return properties.entrySet(); - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyConnectListener.java b/src/main/java/com/ning/http/client/providers/netty/NettyConnectListener.java deleted file mode 100644 index 301399c36e..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyConnectListener.java +++ /dev/null @@ -1,150 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Request; -import com.ning.http.util.AllowAllHostnameVerifier; -import org.jboss.netty.buffer.ChannelBuffer; -import org.jboss.netty.channel.Channel; -import org.jboss.netty.channel.ChannelFuture; -import org.jboss.netty.channel.ChannelFutureListener; -import org.jboss.netty.handler.codec.http.HttpRequest; -import org.jboss.netty.handler.ssl.SslHandler; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import javax.net.ssl.HostnameVerifier; -import java.io.IOException; -import java.net.ConnectException; -import java.net.InetSocketAddress; -import java.net.URI; -import java.nio.channels.ClosedChannelException; -import java.util.concurrent.atomic.AtomicBoolean; - - -/** - * Non Blocking connect. - */ -final class NettyConnectListener implements ChannelFutureListener { - private final static Logger logger = LoggerFactory.getLogger(NettyConnectListener.class); - private final AsyncHttpClientConfig config; - private final NettyResponseFuture future; - private final HttpRequest nettyRequest; - private final AtomicBoolean handshakeDone = new AtomicBoolean(false); - - private NettyConnectListener(AsyncHttpClientConfig config, - NettyResponseFuture future, - HttpRequest nettyRequest) { - this.config = config; - this.future = future; - this.nettyRequest = nettyRequest; - } - - public NettyResponseFuture future() { - return future; - } - - public final void operationComplete(ChannelFuture f) throws Exception { - if (f.isSuccess()) { - Channel channel = f.getChannel(); - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).setAttachment(future); - SslHandler sslHandler = (SslHandler) channel.getPipeline().get(NettyAsyncHttpProvider.SSL_HANDLER); - if (!handshakeDone.getAndSet(true) && (sslHandler != null)) { - ((SslHandler) channel.getPipeline().get(NettyAsyncHttpProvider.SSL_HANDLER)).handshake().addListener(this); - return; - } - - HostnameVerifier v = config.getHostnameVerifier(); - if (sslHandler != null && !AllowAllHostnameVerifier.class.isAssignableFrom(v.getClass())) { - // TODO: channel.getRemoteAddress()).getHostName() is very expensive. Should cache the result. - if (!v.verify(InetSocketAddress.class.cast(channel.getRemoteAddress()).getHostName(), - sslHandler.getEngine().getSession())) { - throw new ConnectException("HostnameVerifier exception."); - } - } - - future.provider().writeRequest(f.getChannel(), config, future, nettyRequest); - } else { - Throwable cause = f.getCause(); - - logger.debug("Trying to recover a dead cached channel {} with a retry value of {} ", f.getChannel(), future.canRetry()); - if (future.canRetry() && cause != null && (NettyAsyncHttpProvider.abortOnDisconnectException(cause) - || ClosedChannelException.class.isAssignableFrom(cause.getClass()) - || future.getState() != NettyResponseFuture.STATE.NEW)) { - - logger.debug("Retrying {} ", nettyRequest); - if (future.provider().remotelyClosed(f.getChannel(), future)) { - return; - } - } - - logger.debug("Failed to recover from exception: {} with channel {}", cause, f.getChannel()); - - boolean printCause = f.getCause() != null && cause.getMessage() != null; - ConnectException e = new ConnectException(printCause ? cause.getMessage() + " to " + future.getURI().toString() : future.getURI().toString()); - if (cause != null) { - e.initCause(cause); - } - future.abort(e); - } - } - - public static class Builder { - private final AsyncHttpClientConfig config; - - private final Request request; - private final AsyncHandler asyncHandler; - private NettyResponseFuture future; - private final NettyAsyncHttpProvider provider; - private final ChannelBuffer buffer; - - public Builder(AsyncHttpClientConfig config, Request request, AsyncHandler asyncHandler, - NettyAsyncHttpProvider provider, ChannelBuffer buffer) { - - this.config = config; - this.request = request; - this.asyncHandler = asyncHandler; - this.future = null; - this.provider = provider; - this.buffer = buffer; - } - - public Builder(AsyncHttpClientConfig config, Request request, AsyncHandler asyncHandler, - NettyResponseFuture future, NettyAsyncHttpProvider provider, ChannelBuffer buffer) { - - this.config = config; - this.request = request; - this.asyncHandler = asyncHandler; - this.future = future; - this.provider = provider; - this.buffer = buffer; - } - - public NettyConnectListener build(final URI uri) throws IOException { - HttpRequest nettyRequest = NettyAsyncHttpProvider.buildRequest(config, request, uri, true, buffer); - if (future == null) { - future = NettyAsyncHttpProvider.newFuture(uri, request, asyncHandler, nettyRequest, config, provider); - } else { - future.setNettyRequest(nettyRequest); - future.setRequest(request); - } - return new NettyConnectListener(config, future, nettyRequest); - } - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyConnectionsPool.java b/src/main/java/com/ning/http/client/providers/netty/NettyConnectionsPool.java deleted file mode 100644 index 18e582774a..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyConnectionsPool.java +++ /dev/null @@ -1,267 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.ConnectionsPool; -import org.jboss.netty.channel.Channel; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.ArrayList; -import java.util.List; -import java.util.Set; -import java.util.Timer; -import java.util.TimerTask; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ConcurrentLinkedQueue; -import java.util.concurrent.atomic.AtomicBoolean; - -/** - * A simple implementation of {@link com.ning.http.client.ConnectionsPool} based on a {@link java.util.concurrent.ConcurrentHashMap} - */ -public class NettyConnectionsPool implements ConnectionsPool { - - private final static Logger log = LoggerFactory.getLogger(NettyConnectionsPool.class); - private final ConcurrentHashMap> connectionsPool = new ConcurrentHashMap>(); - private final ConcurrentHashMap channel2IdleChannel = new ConcurrentHashMap(); - private final AtomicBoolean isClosed = new AtomicBoolean(false); - private final Timer idleConnectionDetector = new Timer(true); - private final boolean sslConnectionPoolEnabled; - private final int maxTotalConnections; - private final int maxConnectionPerHost; - private final long maxIdleTime; - - public NettyConnectionsPool(NettyAsyncHttpProvider provider) { - this.maxTotalConnections = provider.getConfig().getMaxTotalConnections(); - this.maxConnectionPerHost = provider.getConfig().getMaxConnectionPerHost(); - this.sslConnectionPoolEnabled = provider.getConfig().isSslConnectionPoolEnabled(); - this.maxIdleTime = provider.getConfig().getIdleConnectionInPoolTimeoutInMs(); - this.idleConnectionDetector.schedule(new IdleChannelDetector(), maxIdleTime, maxIdleTime); - } - - private static class IdleChannel { - final String uri; - final Channel channel; - final long start; - - IdleChannel(String uri, Channel channel) { - this.uri = uri; - this.channel = channel; - this.start = System.currentTimeMillis(); - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (!(o instanceof IdleChannel)) return false; - - IdleChannel that = (IdleChannel) o; - - if (channel != null ? !channel.equals(that.channel) : that.channel != null) return false; - - return true; - } - - @Override - public int hashCode() { - return channel != null ? channel.hashCode() : 0; - } - } - - private class IdleChannelDetector extends TimerTask { - @Override - public void run() { - try { - if (isClosed.get()) return; - - if (log.isDebugEnabled()) { - Set keys = connectionsPool.keySet(); - - for (String s : keys) { - log.debug("Entry count for : {} : {}", s, connectionsPool.get(s).size()); - } - } - - List channelsInTimeout = new ArrayList(); - long currentTime = System.currentTimeMillis(); - - for (IdleChannel idleChannel : channel2IdleChannel.values()) { - long age = currentTime - idleChannel.start; - if (age > maxIdleTime) { - - log.debug("Adding Candidate Idle Channel {}", idleChannel.channel); - - // store in an unsynchronized list to minimize the impact on the ConcurrentHashMap. - channelsInTimeout.add(idleChannel); - } - } - long endConcurrentLoop = System.currentTimeMillis(); - - for (IdleChannel idleChannel : channelsInTimeout) { - Object attachment = idleChannel.channel.getPipeline().getContext(NettyAsyncHttpProvider.class).getAttachment(); - if (attachment != null) { - if (NettyResponseFuture.class.isAssignableFrom(attachment.getClass())) { - NettyResponseFuture future = (NettyResponseFuture) attachment; - - if (!future.isDone() && !future.isCancelled()) { - log.debug("Future not in appropriate state %s\n", future); - continue; - } - } - } - - if (remove(idleChannel)) { - log.debug("Closing Idle Channel {}", idleChannel.channel); - close(idleChannel.channel); - } - } - - log.trace(String.format("%d channel open, %d idle channels closed (times: 1st-loop=%d, 2nd-loop=%d).\n", - connectionsPool.size(), channelsInTimeout.size(), endConcurrentLoop - currentTime, System.currentTimeMillis() - endConcurrentLoop)); - } catch (Throwable t) { - log.error("uncaught exception!", t); - } - } - } - - /** - * {@inheritDoc} - */ - public boolean offer(String uri, Channel channel) { - if (isClosed.get()) return false; - - if (!sslConnectionPoolEnabled && uri.startsWith("https")) { - return false; - } - - log.debug("Adding uri: {} for channel {}", uri, channel); - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).setAttachment(new NettyAsyncHttpProvider.DiscardEvent()); - - ConcurrentLinkedQueue idleConnectionForHost = connectionsPool.get(uri); - if (idleConnectionForHost == null) { - ConcurrentLinkedQueue newPool = new ConcurrentLinkedQueue(); - idleConnectionForHost = connectionsPool.putIfAbsent(uri, newPool); - if (idleConnectionForHost == null) idleConnectionForHost = newPool; - } - - boolean added; - int size = idleConnectionForHost.size(); - if (maxConnectionPerHost == -1 || size < maxConnectionPerHost) { - IdleChannel idleChannel = new IdleChannel(uri, channel); - synchronized (idleConnectionForHost) { - added = idleConnectionForHost.add(idleChannel); - - if (channel2IdleChannel.put(channel, idleChannel) != null) { - log.error("Channel {} already exists in the connections pool!", channel); - } - } - } else { - log.debug("Maximum number of requests per host reached {} for {}", maxConnectionPerHost, uri); - added = false; - } - return added; - } - - /** - * {@inheritDoc} - */ - public Channel poll(String uri) { - if (!sslConnectionPoolEnabled && uri.startsWith("https")) { - return null; - } - - IdleChannel idleChannel = null; - ConcurrentLinkedQueue idleConnectionForHost = connectionsPool.get(uri); - if (idleConnectionForHost != null) { - boolean poolEmpty = false; - while (!poolEmpty && idleChannel == null) { - if (idleConnectionForHost.size() > 0) { - synchronized (idleConnectionForHost) { - idleChannel = idleConnectionForHost.poll(); - if (idleChannel != null) { - channel2IdleChannel.remove(idleChannel.channel); - } - } - } - - if (idleChannel == null) { - poolEmpty = true; - } else if (!idleChannel.channel.isConnected() || !idleChannel.channel.isOpen()) { - idleChannel = null; - log.trace("Channel not connected or not opened!"); - } - } - } - return idleChannel != null ? idleChannel.channel : null; - } - - private boolean remove(IdleChannel pooledChannel) { - if (pooledChannel == null || isClosed.get()) return false; - - boolean isRemoved = false; - ConcurrentLinkedQueue pooledConnectionForHost = connectionsPool.get(pooledChannel.uri); - if (pooledConnectionForHost != null) { - isRemoved = pooledConnectionForHost.remove(pooledChannel); - } - isRemoved |= channel2IdleChannel.remove(pooledChannel.channel) != null; - return isRemoved; - } - - /** - * {@inheritDoc} - */ - public boolean removeAll(Channel channel) { - return !isClosed.get() && remove(channel2IdleChannel.get(channel)); - } - - /** - * {@inheritDoc} - */ - public boolean canCacheConnection() { - if (!isClosed.get() && maxTotalConnections != -1 && channel2IdleChannel.size() >= maxTotalConnections) { - return false; - } else { - return true; - } - } - - /** - * {@inheritDoc} - */ - public void destroy() { - if (isClosed.getAndSet(true)) return; - - // stop timer - idleConnectionDetector.cancel(); - idleConnectionDetector.purge(); - - for (Channel channel : channel2IdleChannel.keySet()) { - close(channel); - } - connectionsPool.clear(); - channel2IdleChannel.clear(); - } - - private void close(Channel channel) { - try { - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).setAttachment(new NettyAsyncHttpProvider.DiscardEvent()); - channel.close(); - } catch (Throwable t) { - // noop - } - } - - public final String toString() { - return String.format("NettyConnectionPool: {pool-size: %d}", channel2IdleChannel.size()); - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyResponse.java b/src/main/java/com/ning/http/client/providers/netty/NettyResponse.java deleted file mode 100644 index 5af231d626..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyResponse.java +++ /dev/null @@ -1,225 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import com.ning.http.util.AsyncHttpProviderUtils; -import org.jboss.netty.buffer.ChannelBuffer; -import org.jboss.netty.buffer.ChannelBufferInputStream; -import org.jboss.netty.buffer.ChannelBuffers; - -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.List; -import java.util.Map; - -/** - * Wrapper around the {@link com.ning.http.client.Response} API. - */ -public class NettyResponse implements Response { - private final static String DEFAULT_CHARSET = "ISO-8859-1"; - private final static String HEADERS_NOT_COMPUTED = "Response's headers hasn't been computed by your AsyncHandler."; - - private final URI uri; - private final Collection bodyParts; - private final HttpResponseHeaders headers; - private final HttpResponseStatus status; - private final List cookies = new ArrayList(); - - public NettyResponse(HttpResponseStatus status, - HttpResponseHeaders headers, - Collection bodyParts) { - - this.status = status; - this.headers = headers; - this.bodyParts = bodyParts; - uri = status.getUrl(); - } - - /* @Override */ - - public int getStatusCode() { - return status.getStatusCode(); - } - - /* @Override */ - - public String getStatusText() { - return status.getStatusText(); - } - - /* @Override */ - public byte[] getResponseBodyAsBytes() throws IOException { - return AsyncHttpProviderUtils.contentToByte(bodyParts); - } - - /* @Override */ - public String getResponseBody() throws IOException { - return getResponseBody(null); - } - - public String getResponseBody(String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - return AsyncHttpProviderUtils.contentToString(bodyParts, charset); - } - - /* @Override */ - public InputStream getResponseBodyAsStream() throws IOException { - ChannelBuffer buf = ChannelBuffers.dynamicBuffer(); - for (HttpResponseBodyPart bp : bodyParts) { - // Ugly. TODO - // (1) We must remove the downcast, - // (2) we need a CompositeByteArrayInputStream to avoid - // copying the bytes. - if (bp.getClass().isAssignableFrom(ResponseBodyPart.class)) { - buf.writeBytes(bp.getBodyPartBytes()); - } - } - return new ChannelBufferInputStream(buf); - } - - /* @Override */ - - public String getResponseBodyExcerpt(int maxLength) throws IOException { - return getResponseBodyExcerpt(maxLength, null); - } - - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException { - String contentType = getContentType(); - if (contentType != null && charset == null) { - charset = AsyncHttpProviderUtils.parseCharset(contentType); - } - - if (charset == null) { - charset = DEFAULT_CHARSET; - } - - String response = AsyncHttpProviderUtils.contentToString(bodyParts, charset); - return response.length() <= maxLength ? response : response.substring(0, maxLength); - } - - /* @Override */ - - public URI getUri() throws MalformedURLException { - return uri; - } - - /* @Override */ - - public String getContentType() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().getFirstValue("Content-Type"); - } - - /* @Override */ - - public String getHeader(String name) { - if (headers == null) { - throw new IllegalStateException(); - } - return headers.getHeaders().getFirstValue(name); - } - - /* @Override */ - - public List getHeaders(String name) { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders().get(name); - } - - /* @Override */ - - public FluentCaseInsensitiveStringsMap getHeaders() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - return headers.getHeaders(); - } - - /* @Override */ - - public boolean isRedirected() { - return (status.getStatusCode() >= 300) && (status.getStatusCode() <= 399); - } - - /* @Override */ - - public List getCookies() { - if (headers == null) { - throw new IllegalStateException(HEADERS_NOT_COMPUTED); - } - if (cookies.isEmpty()) { - for (Map.Entry> header : headers.getHeaders().entrySet()) { - if (header.getKey().equalsIgnoreCase("Set-Cookie")) { - // TODO: ask for parsed header - List v = header.getValue(); - for (String value : v) { - Cookie cookie = AsyncHttpProviderUtils.parseCookie(value); - cookies.add(cookie); - } - } - } - } - return Collections.unmodifiableList(cookies); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseStatus() { - return (status != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseHeaders() { - return (headers != null ? true : false); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean hasResponseBody() { - return (bodyParts != null && bodyParts.size() > 0 ? true : false); - } - -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyResponseFuture.java b/src/main/java/com/ning/http/client/providers/netty/NettyResponseFuture.java deleted file mode 100755 index bb58421dcb..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyResponseFuture.java +++ /dev/null @@ -1,484 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.Request; -import com.ning.http.client.listenable.AbstractListenableFuture; -import org.jboss.netty.channel.Channel; -import org.jboss.netty.handler.codec.http.HttpRequest; -import org.jboss.netty.handler.codec.http.HttpResponse; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.net.MalformedURLException; -import java.net.URI; -import java.util.concurrent.Callable; -import java.util.concurrent.CancellationException; -import java.util.concurrent.CountDownLatch; -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.AtomicInteger; -import java.util.concurrent.atomic.AtomicLong; -import java.util.concurrent.atomic.AtomicReference; - -/** - * A {@link Future} that can be used to track when an asynchronous HTTP request has been fully processed. - * - * @param - */ -public final class NettyResponseFuture extends AbstractListenableFuture { - - private final static Logger logger = LoggerFactory.getLogger(NettyResponseFuture.class); - public final static String MAX_RETRY = "com.ning.http.client.providers.netty.maxRetry"; - - enum STATE { - NEW, - POOLED, - RECONNECTED, - CLOSED, - } - - private final CountDownLatch latch = new CountDownLatch(1); - private final AtomicBoolean isDone = new AtomicBoolean(false); - private final AtomicBoolean isCancelled = new AtomicBoolean(false); - private AsyncHandler asyncHandler; - private final int responseTimeoutInMs; - private final int idleConnectionTimeoutInMs; - private Request request; - private HttpRequest nettyRequest; - private final AtomicReference content = new AtomicReference(); - private URI uri; - private boolean keepAlive = true; - private HttpResponse httpResponse; - private final AtomicReference exEx = new AtomicReference(); - private final AtomicInteger redirectCount = new AtomicInteger(); - private volatile Future reaperFuture; - private final AtomicBoolean inAuth = new AtomicBoolean(false); - private final AtomicBoolean statusReceived = new AtomicBoolean(false); - private final AtomicLong touch = new AtomicLong(System.currentTimeMillis()); - private final long start = System.currentTimeMillis(); - private final NettyAsyncHttpProvider asyncHttpProvider; - private final AtomicReference state = new AtomicReference(STATE.NEW); - private final AtomicBoolean contentProcessed = new AtomicBoolean(false); - private Channel channel; - private boolean reuseChannel = false; - private final AtomicInteger currentRetry = new AtomicInteger(0); - private final int maxRetry; - private boolean writeHeaders; - private boolean writeBody; - private final AtomicBoolean throwableCalled = new AtomicBoolean(false); - private boolean allowConnect = false; - - public NettyResponseFuture(URI uri, - Request request, - AsyncHandler asyncHandler, - HttpRequest nettyRequest, - int responseTimeoutInMs, - int idleConnectionTimeoutInMs, - NettyAsyncHttpProvider asyncHttpProvider) { - - this.asyncHandler = asyncHandler; - this.responseTimeoutInMs = responseTimeoutInMs; - this.idleConnectionTimeoutInMs = idleConnectionTimeoutInMs; - this.request = request; - this.nettyRequest = nettyRequest; - this.uri = uri; - this.asyncHttpProvider = asyncHttpProvider; - - if (System.getProperty(MAX_RETRY) != null) { - maxRetry = Integer.valueOf(System.getProperty(MAX_RETRY)); - } else { - maxRetry = asyncHttpProvider.getConfig().getMaxRequestRetry(); - } - writeHeaders = true; - writeBody = true; - } - - protected URI getURI() throws MalformedURLException { - return uri; - } - - protected void setURI(URI uri) { - this.uri = uri; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean isDone() { - return isDone.get(); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean isCancelled() { - return isCancelled.get(); - } - - void setAsyncHandler(AsyncHandler asyncHandler) { - this.asyncHandler = asyncHandler; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean cancel(boolean force) { - cancelReaper(); - - if (isCancelled.get()) return false; - - try { - channel.getPipeline().getContext(NettyAsyncHttpProvider.class).setAttachment(new NettyAsyncHttpProvider.DiscardEvent()); - channel.close(); - } catch (Throwable t) { - // Ignore - } - if (!throwableCalled.getAndSet(true)) { - try { - asyncHandler.onThrowable(new CancellationException()); - } catch (Throwable t) { - logger.warn("cancel", t); - } - } - latch.countDown(); - isCancelled.set(true); - super.done(); - return true; - } - - /** - * Is the Future still valid - * - * @return true if response has expired and should be terminated. - */ - public boolean hasExpired() { - long now = System.currentTimeMillis(); - return idleConnectionTimeoutInMs != -1 && ((now - touch.get()) >= idleConnectionTimeoutInMs) - || responseTimeoutInMs != -1 && ((now - start) >= responseTimeoutInMs); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public V get() throws InterruptedException, ExecutionException { - try { - return get(responseTimeoutInMs, TimeUnit.MILLISECONDS); - } catch (TimeoutException e) { - cancelReaper(); - throw new ExecutionException(e); - } - } - - void cancelReaper() { - if (reaperFuture != null) { - reaperFuture.cancel(true); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public V get(long l, TimeUnit tu) throws InterruptedException, TimeoutException, ExecutionException { - if (!isDone() && !isCancelled()) { - boolean expired = false; - if (l == -1) { - latch.await(); - } else { - expired = !latch.await(l, tu); - } - - if (expired) { - isCancelled.set(true); - TimeoutException te = new TimeoutException(String.format("No response received after %s", l)); - if (!throwableCalled.getAndSet(true)) { - try { - asyncHandler.onThrowable(te); - } catch (Throwable t) { - logger.debug("asyncHandler.onThrowable", t); - } finally { - cancelReaper(); - throw new ExecutionException(te); - } - } - } - isDone.set(true); - - ExecutionException e = exEx.getAndSet(null); - if (e != null) { - throw e; - } - } - return getContent(); - } - - V getContent() throws ExecutionException { - ExecutionException e = exEx.getAndSet(null); - if (e != null) { - throw e; - } - - V update = content.get(); - // No more retry - currentRetry.set(maxRetry); - if (exEx.get() == null && !contentProcessed.getAndSet(true)) { - try { - update = asyncHandler.onCompleted(); - } catch (Throwable ex) { - if (!throwableCalled.getAndSet(true)) { - try { - asyncHandler.onThrowable(ex); - } catch (Throwable t) { - logger.debug("asyncHandler.onThrowable", t); - } finally { - cancelReaper(); - throw new RuntimeException(ex); - } - } - } - content.compareAndSet(null, update); - } - return update; - } - - public final void done(Callable callable) { - try { - cancelReaper(); - - if (exEx.get() != null) { - return; - } - getContent(); - isDone.set(true); - if (callable != null) { - try { - callable.call(); - } catch (Exception ex) { - throw new RuntimeException(ex); - } - } - } catch (ExecutionException t) { - return; - } catch (RuntimeException t) { - exEx.compareAndSet(null, new ExecutionException(t)); - } finally { - latch.countDown(); - } - super.done(); - } - - public final void abort(final Throwable t) { - cancelReaper(); - - if (isDone.get() || isCancelled.get()) return; - - exEx.compareAndSet(null, new ExecutionException(t)); - if (!throwableCalled.getAndSet(true)) { - try { - asyncHandler.onThrowable(t); - } catch (Throwable te) { - logger.debug("asyncHandler.onThrowable", te); - } finally { - isCancelled.set(true); - } - } - latch.countDown(); - super.done(); - } - - public void content(V v) { - content.set(v); - } - - protected final Request getRequest() { - return request; - } - - public final HttpRequest getNettyRequest() { - return nettyRequest; - } - - protected final void setNettyRequest(HttpRequest nettyRequest) { - this.nettyRequest = nettyRequest; - } - - protected final AsyncHandler getAsyncHandler() { - return asyncHandler; - } - - protected final boolean getKeepAlive() { - return keepAlive; - } - - protected final void setKeepAlive(final boolean keepAlive) { - this.keepAlive = keepAlive; - } - - protected final HttpResponse getHttpResponse() { - return httpResponse; - } - - protected final void setHttpResponse(final HttpResponse httpResponse) { - this.httpResponse = httpResponse; - } - - protected int incrementAndGetCurrentRedirectCount() { - return redirectCount.incrementAndGet(); - } - - protected void setReaperFuture(Future reaperFuture) { - cancelReaper(); - this.reaperFuture = reaperFuture; - } - - protected boolean isInAuth() { - return inAuth.get(); - } - - protected boolean getAndSetAuth(boolean inDigestAuth) { - return inAuth.getAndSet(inDigestAuth); - } - - protected STATE getState() { - return state.get(); - } - - protected void setState(STATE state) { - this.state.set(state); - } - - public boolean getAndSetStatusReceived(boolean sr) { - return statusReceived.getAndSet(sr); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void touch() { - touch.set(System.currentTimeMillis()); - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteHeaders(boolean writeHeaders) { - boolean b = this.writeHeaders; - this.writeHeaders = writeHeaders; - return b; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public boolean getAndSetWriteBody(boolean writeBody) { - boolean b = this.writeBody; - this.writeBody = writeBody; - return b; - } - - protected NettyAsyncHttpProvider provider() { - return asyncHttpProvider; - } - - protected void attachChannel(Channel channel) { - this.channel = channel; - } - - public void setReuseChannel(boolean reuseChannel) { - this.reuseChannel = reuseChannel; - } - - public boolean isConnectAllowed() { - return allowConnect; - } - - public void setConnectAllowed(boolean allowConnect) { - this.allowConnect = allowConnect; - } - - protected void attachChannel(Channel channel, boolean reuseChannel) { - this.channel = channel; - this.reuseChannel = reuseChannel; - } - - protected Channel channel() { - return channel; - } - - protected boolean reuseChannel() { - return reuseChannel; - } - - protected boolean canRetry() { - if (currentRetry.incrementAndGet() > maxRetry) { - return false; - } - return true; - } - - public void setRequest(Request request) { - this.request = request; - } - - /** - * Return true if the {@link Future} cannot be recovered. There is some scenario where a connection can be - * closed by an unexpected IOException, and in some situation we can recover from that exception. - * - * @return true if that {@link Future} cannot be recovered. - */ - public boolean cannotBeReplay() { - return isDone() - || !canRetry() - || isCancelled() - || (channel() != null && channel().isOpen() && uri.getScheme().compareToIgnoreCase("https") != 0) - || isInAuth(); - } - - @Override - public String toString() { - return "NettyResponseFuture{" + - "currentRetry=" + currentRetry + - ",\n\tisDone=" + isDone + - ",\n\tisCancelled=" + isCancelled + - ",\n\tasyncHandler=" + asyncHandler + - ",\n\tresponseTimeoutInMs=" + responseTimeoutInMs + - ",\n\tnettyRequest=" + nettyRequest + - ",\n\tcontent=" + content + - ",\n\turi=" + uri + - ",\n\tkeepAlive=" + keepAlive + - ",\n\thttpResponse=" + httpResponse + - ",\n\texEx=" + exEx + - ",\n\tredirectCount=" + redirectCount + - ",\n\treaperFuture=" + reaperFuture + - ",\n\tinAuth=" + inAuth + - ",\n\tstatusReceived=" + statusReceived + - ",\n\ttouch=" + touch + - '}'; - } - -} diff --git a/src/main/java/com/ning/http/client/providers/netty/NettyWebSocket.java b/src/main/java/com/ning/http/client/providers/netty/NettyWebSocket.java deleted file mode 100644 index 77c6e3acd6..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/NettyWebSocket.java +++ /dev/null @@ -1,128 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.websocket.WebSocket; -import com.ning.http.client.websocket.WebSocketByteListener; -import com.ning.http.client.websocket.WebSocketListener; -import com.ning.http.client.websocket.WebSocketTextListener; -import org.jboss.netty.channel.Channel; -import org.jboss.netty.handler.codec.http.websocketx.BinaryWebSocketFrame; -import org.jboss.netty.handler.codec.http.websocketx.PingWebSocketFrame; -import org.jboss.netty.handler.codec.http.websocketx.PongWebSocketFrame; -import org.jboss.netty.handler.codec.http.websocketx.TextWebSocketFrame; - -import java.util.concurrent.ConcurrentLinkedQueue; - -import static org.jboss.netty.buffer.ChannelBuffers.wrappedBuffer; - -public class NettyWebSocket implements WebSocket { - - private final Channel channel; - private final ConcurrentLinkedQueue listeners = new ConcurrentLinkedQueue(); - - public NettyWebSocket(Channel channel) { - this.channel = channel; - } - - @Override - public WebSocket sendMessage(byte[] message) { - channel.write(new BinaryWebSocketFrame(wrappedBuffer(message))); - return this; - } - - @Override - public WebSocket stream(byte[] fragment, boolean last) { - throw new UnsupportedOperationException("Streaming currently only supported by the Grizzly provider."); - } - - @Override - public WebSocket stream(byte[] fragment, int offset, int len, boolean last) { - throw new UnsupportedOperationException("Streaming currently only supported by the Grizzly provider."); - } - - @Override - public WebSocket sendTextMessage(String message) { - channel.write(new TextWebSocketFrame(message)); - return this; - } - - @Override - public WebSocket streamText(String fragment, boolean last) { - throw new UnsupportedOperationException("Streaming currently only supported by the Grizzly provider."); - } - - @Override - public WebSocket sendPing(byte[] payload) { - channel.write(new PingWebSocketFrame(wrappedBuffer(payload))); - return this; - } - - @Override - public WebSocket sendPong(byte[] payload) { - channel.write(new PongWebSocketFrame(wrappedBuffer(payload))); - return this; - } - - @Override - public WebSocket addWebSocketListener(WebSocketListener l) { - listeners.add(l); - return this; - } - - @Override - public boolean isOpen() { - return channel.isOpen(); - } - - @Override - public void close() { - onClose(); - channel.close(); - } - - protected void onMessage(byte[] message) { - for (WebSocketListener l : listeners) { - if (WebSocketByteListener.class.isAssignableFrom(l.getClass())) { - WebSocketByteListener.class.cast(l).onMessage(message); - } - } - } - - protected void onTextMessage(String message) { - for (WebSocketListener l : listeners) { - if (WebSocketTextListener.class.isAssignableFrom(l.getClass())) { - WebSocketTextListener.class.cast(l).onMessage(message); - } - } - } - - protected void onError(Throwable t) { - for (WebSocketListener l : listeners) { - l.onError(t); - } - } - - protected void onClose() { - for (WebSocketListener l : listeners) { - l.onClose(this); - } - } - - @Override - public String toString() { - return "NettyWebSocket{" + - "channel=" + channel + - '}'; - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/Protocol.java b/src/main/java/com/ning/http/client/providers/netty/Protocol.java deleted file mode 100644 index 3e8e9862c4..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/Protocol.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import org.jboss.netty.channel.ChannelHandlerContext; -import org.jboss.netty.channel.ChannelStateEvent; -import org.jboss.netty.channel.ExceptionEvent; -import org.jboss.netty.channel.MessageEvent; - -public interface Protocol { - - void handle(ChannelHandlerContext ctx, MessageEvent e) throws Exception; - - void onError(ChannelHandlerContext ctx, ExceptionEvent e); - - void onClose(ChannelHandlerContext ctx, ChannelStateEvent e); -} diff --git a/src/main/java/com/ning/http/client/providers/netty/ResponseBodyPart.java b/src/main/java/com/ning/http/client/providers/netty/ResponseBodyPart.java deleted file mode 100644 index 8279c76d77..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/ResponseBodyPart.java +++ /dev/null @@ -1,120 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseBodyPart; -import org.jboss.netty.buffer.ChannelBuffer; -import org.jboss.netty.handler.codec.http.HttpChunk; -import org.jboss.netty.handler.codec.http.HttpResponse; - -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.nio.ByteBuffer; -import java.util.concurrent.atomic.AtomicReference; - -/** - * A callback class used when an HTTP response body is received. - */ -public class ResponseBodyPart extends HttpResponseBodyPart { - - private final HttpChunk chunk; - private final HttpResponse response; - private final AtomicReference bytes = new AtomicReference(null); - private final boolean isLast; - private boolean closeConnection = false; - - public ResponseBodyPart(URI uri, HttpResponse response, AsyncHttpProvider provider, boolean last) { - super(uri, provider); - isLast = last; - this.chunk = null; - this.response = response; - } - - public ResponseBodyPart(URI uri, HttpResponse response, AsyncHttpProvider provider, HttpChunk chunk, boolean last) { - super(uri, provider); - this.chunk = chunk; - this.response = response; - isLast = last; - } - - /** - * Return the response body's part bytes received. - * - * @return the response body's part bytes received. - */ - public byte[] getBodyPartBytes() { - - if (bytes.get() != null) { - return bytes.get(); - } - - ChannelBuffer b = chunk != null ? chunk.getContent() : response.getContent(); - int read = b.readableBytes(); - int index = b.readerIndex(); - - byte[] rb = new byte[read]; - b.readBytes(rb); - bytes.set(rb); - b.readerIndex(index); - return bytes.get(); - } - - public int writeTo(OutputStream outputStream) throws IOException { - ChannelBuffer b = chunk != null ? chunk.getContent() : response.getContent(); - int read = b.readableBytes(); - int index = b.readerIndex(); - if (read > 0) { - b.readBytes(outputStream, read); - } - b.readerIndex(index); - return read; - } - - @Override - public ByteBuffer getBodyByteBuffer() { - return ByteBuffer.wrap(getBodyPartBytes()); - } - - /** - * {@inheritDoc} - */ - @Override - public boolean isLast() { - return isLast; - } - - /** - * {@inheritDoc} - */ - @Override - public void markUnderlyingConnectionAsClosed() { - closeConnection = true; - } - - /** - * {@inheritDoc} - */ - @Override - public boolean closeUnderlyingConnection() { - return closeConnection; - } - - protected HttpChunk chunk() { - return chunk; - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/ResponseHeaders.java b/src/main/java/com/ning/http/client/providers/netty/ResponseHeaders.java deleted file mode 100644 index 0db2b32334..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/ResponseHeaders.java +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseHeaders; -import org.jboss.netty.handler.codec.http.HttpChunkTrailer; -import org.jboss.netty.handler.codec.http.HttpResponse; - -import java.net.URI; - -/** - * A class that represent the HTTP headers. - */ -public class ResponseHeaders extends HttpResponseHeaders { - - private final HttpChunkTrailer trailingHeaders; - private final HttpResponse response; - private final FluentCaseInsensitiveStringsMap headers; - - public ResponseHeaders(URI uri, HttpResponse response, AsyncHttpProvider provider) { - super(uri, provider, false); - this.trailingHeaders = null; - this.response = response; - headers = computerHeaders(); - } - - public ResponseHeaders(URI uri, HttpResponse response, AsyncHttpProvider provider, HttpChunkTrailer traillingHeaders) { - super(uri, provider, true); - this.trailingHeaders = traillingHeaders; - this.response = response; - headers = computerHeaders(); - } - - private FluentCaseInsensitiveStringsMap computerHeaders() { - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - for (String s : response.getHeaderNames()) { - for (String header : response.getHeaders(s)) { - h.add(s, header); - } - } - - if (trailingHeaders != null && trailingHeaders.getHeaderNames().size() > 0) { - for (final String s : trailingHeaders.getHeaderNames()) { - for (String header : response.getHeaders(s)) { - h.add(s, header); - } - } - } - - return h; - } - - /** - * Return the HTTP header - * - * @return an {@link com.ning.http.client.FluentCaseInsensitiveStringsMap} - */ - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return headers; - } -} diff --git a/src/main/java/com/ning/http/client/providers/netty/ResponseStatus.java b/src/main/java/com/ning/http/client/providers/netty/ResponseStatus.java deleted file mode 100644 index 12024ecaa6..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/ResponseStatus.java +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.HttpResponseStatus; -import org.jboss.netty.handler.codec.http.HttpResponse; - -import java.net.URI; - -/** - * A class that represent the HTTP response' status line (code + text) - */ -public class ResponseStatus extends HttpResponseStatus { - - private final HttpResponse response; - - public ResponseStatus(URI uri, HttpResponse response, AsyncHttpProvider provider) { - super(uri, provider); - this.response = response; - } - - /** - * Return the response status code - * - * @return the response status code - */ - public int getStatusCode() { - return response.getStatus().getCode(); - } - - /** - * Return the response status text - * - * @return the response status text - */ - public String getStatusText() { - return response.getStatus().getReasonPhrase(); - } - - @Override - public String getProtocolName() { - return response.getProtocolVersion().getProtocolName(); - } - - @Override - public int getProtocolMajorVersion() { - return response.getProtocolVersion().getMajorVersion(); - } - - @Override - public int getProtocolMinorVersion() { - return response.getProtocolVersion().getMinorVersion(); - } - - @Override - public String getProtocolText() { - return response.getProtocolVersion().getText(); - } - -} diff --git a/src/main/java/com/ning/http/client/providers/netty/WebSocketUtil.java b/src/main/java/com/ning/http/client/providers/netty/WebSocketUtil.java deleted file mode 100644 index c2a452e66f..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/WebSocketUtil.java +++ /dev/null @@ -1,73 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.providers.netty; - -import com.ning.http.util.Base64; -import org.jboss.netty.util.CharsetUtil; - -import java.io.UnsupportedEncodingException; -import java.security.MessageDigest; -import java.security.NoSuchAlgorithmException; - -public final class WebSocketUtil { - public static final String MAGIC_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; - - public static String getKey() { - byte[] nonce = createRandomBytes(16); - return base64Encode(nonce); - } - - public static String getAcceptKey(String key) throws UnsupportedEncodingException { - String acceptSeed = key + MAGIC_GUID; - byte[] sha1 = sha1(acceptSeed.getBytes("US-ASCII")); - return base64Encode(sha1); - } - - public static byte[] md5(byte[] bytes) { - try { - MessageDigest md = MessageDigest.getInstance("MD5"); - return md.digest(bytes); - } catch (NoSuchAlgorithmException e) { - throw new InternalError("MD5 not supported on this platform"); - } - } - - public static byte[] sha1(byte[] bytes) { - try { - MessageDigest md = MessageDigest.getInstance("SHA1"); - return md.digest(bytes); - } catch (NoSuchAlgorithmException e) { - throw new InternalError("SHA-1 not supported on this platform"); - } - } - - public static String base64Encode(byte[] bytes) { - return Base64.encode(bytes); - } - - public static byte[] createRandomBytes(int size) { - byte[] bytes = new byte[size]; - - for (int i = 0; i < size; i++) { - bytes[i] = (byte) createRandomNumber(0, 255); - } - - return bytes; - } - - public static int createRandomNumber(int min, int max) { - return (int) (Math.random() * max + min); - } - -} - diff --git a/src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoEngine.java b/src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoEngine.java deleted file mode 100644 index ef777569a5..0000000000 --- a/src/main/java/com/ning/http/client/providers/netty/spnego/SpnegoEngine.java +++ /dev/null @@ -1,178 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -/* - * ==================================================================== - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * . - */ - -package com.ning.http.client.providers.netty.spnego; - -import com.ning.http.util.Base64; -import org.ietf.jgss.GSSContext; -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; - -import java.io.IOException; - -/** - * SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication - * scheme. - * - * @since 4.1 - */ -public class SpnegoEngine { - private static final String SPNEGO_OID = "1.3.6.1.5.5.2"; - private static final String KERBEROS_OID = "1.2.840.113554.1.2.2"; - - private final Logger log = LoggerFactory.getLogger(getClass()); - - private final SpnegoTokenGenerator spnegoGenerator; - - private GSSContext gssContext = null; - - /** - * base64 decoded challenge * - */ - private byte[] token; - - private Oid negotiationOid = null; - - public SpnegoEngine(final SpnegoTokenGenerator spnegoGenerator) { - this.spnegoGenerator = spnegoGenerator; - } - - public SpnegoEngine() { - this(null); - } - - public String generateToken(String server) throws Throwable { - - try { - log.debug("init {}", server); - /* Using the SPNEGO OID is the correct method. - * Kerberos v5 works for IIS but not JBoss. Unwrapping - * the initial token when using SPNEGO OID looks like what is - * described here... - * - * http://msdn.microsoft.com/en-us/library/ms995330.aspx - * - * Another helpful URL... - * - * http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/tsec_SPNEGO_token.html - * - * Unfortunately SPNEGO is JRE >=1.6. - */ - - /** Try SPNEGO by default, fall back to Kerberos later if error */ - negotiationOid = new Oid(SPNEGO_OID); - - boolean tryKerberos = false; - try { - GSSManager manager = GSSManager.getInstance(); - GSSName serverName = manager.createName("HTTP@" + server, GSSName.NT_HOSTBASED_SERVICE); - gssContext = manager.createContext( - serverName.canonicalize(negotiationOid), negotiationOid, null, - GSSContext.DEFAULT_LIFETIME); - gssContext.requestMutualAuth(true); - gssContext.requestCredDeleg(true); - } catch (GSSException ex) { - log.error("generateToken", ex); - // BAD MECH means we are likely to be using 1.5, fall back to Kerberos MECH. - // Rethrow any other exception. - if (ex.getMajor() == GSSException.BAD_MECH) { - log.debug("GSSException BAD_MECH, retry with Kerberos MECH"); - tryKerberos = true; - } else { - throw ex; - } - - } - if (tryKerberos) { - /* Kerberos v5 GSS-API mechanism defined in RFC 1964.*/ - log.debug("Using Kerberos MECH {}", KERBEROS_OID); - negotiationOid = new Oid(KERBEROS_OID); - GSSManager manager = GSSManager.getInstance(); - GSSName serverName = manager.createName("HTTP@" + server, GSSName.NT_HOSTBASED_SERVICE); - gssContext = manager.createContext( - serverName.canonicalize(negotiationOid), negotiationOid, null, - GSSContext.DEFAULT_LIFETIME); - gssContext.requestMutualAuth(true); - gssContext.requestCredDeleg(true); - } - - // TODO suspicious: this will always be null because no value has been assigned before. Assign directly? - if (token == null) { - token = new byte[0]; - } - - token = gssContext.initSecContext(token, 0, token.length); - if (token == null) { - throw new Exception("GSS security context initialization failed"); - } - - /* - * IIS accepts Kerberos and SPNEGO tokens. Some other servers Jboss, Glassfish? - * seem to only accept SPNEGO. Below wraps Kerberos into SPNEGO token. - */ - if (spnegoGenerator != null && negotiationOid.toString().equals(KERBEROS_OID)) { - token = spnegoGenerator.generateSpnegoDERObject(token); - } - - gssContext.dispose(); - - String tokenstr = new String(Base64.encode(token)); - log.debug("Sending response '{}' back to the server", tokenstr); - - return tokenstr; - } catch (GSSException gsse) { - log.error("generateToken", gsse); - if (gsse.getMajor() == GSSException.DEFECTIVE_CREDENTIAL - || gsse.getMajor() == GSSException.CREDENTIALS_EXPIRED) - throw new Exception(gsse.getMessage(), gsse); - if (gsse.getMajor() == GSSException.NO_CRED) - throw new Exception(gsse.getMessage(), gsse); - if (gsse.getMajor() == GSSException.DEFECTIVE_TOKEN - || gsse.getMajor() == GSSException.DUPLICATE_TOKEN - || gsse.getMajor() == GSSException.OLD_TOKEN) - throw new Exception(gsse.getMessage(), gsse); - // other error - throw new Exception(gsse.getMessage()); - } catch (IOException ex) { - throw new Exception(ex.getMessage()); - } - } -} diff --git a/src/main/java/com/ning/http/client/simple/HeaderMap.java b/src/main/java/com/ning/http/client/simple/HeaderMap.java deleted file mode 100644 index f081e2ff38..0000000000 --- a/src/main/java/com/ning/http/client/simple/HeaderMap.java +++ /dev/null @@ -1,115 +0,0 @@ -package com.ning.http.client.simple; - -/* - * Copyright (c) 2010 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -import com.ning.http.client.FluentCaseInsensitiveStringsMap; - -import java.util.Collection; -import java.util.List; -import java.util.Map; -import java.util.Set; - -/** - * A map containing headers with the sole purpose of being given to - * {@link SimpleAHCTransferListener#onHeaders(String, HeaderMap)}. - * - * @author Benjamin Hanzelmann - */ -public class HeaderMap implements Map> { - - private FluentCaseInsensitiveStringsMap headers; - - public HeaderMap(FluentCaseInsensitiveStringsMap headers) { - this.headers = headers; - } - - public Set keySet() { - return headers.keySet(); - } - - public Set>> entrySet() { - return headers.entrySet(); - } - - public int size() { - return headers.size(); - } - - public boolean isEmpty() { - return headers.isEmpty(); - } - - public boolean containsKey(Object key) { - return headers.containsKey(key); - } - - public boolean containsValue(Object value) { - return headers.containsValue(value); - } - - /** - * @see FluentCaseInsensitiveStringsMap#getFirstValue(String) - */ - public String getFirstValue(String key) { - return headers.getFirstValue(key); - } - - /** - * @see FluentCaseInsensitiveStringsMap#getJoinedValue(String, String) - */ - public String getJoinedValue(String key, String delimiter) { - return headers.getJoinedValue(key, delimiter); - } - - public List get(Object key) { - return headers.get(key); - } - - /** - * Only read access is supported. - */ - public List put(String key, List value) { - throw new UnsupportedOperationException("Only read access is supported."); - } - - /** - * Only read access is supported. - */ - public List remove(Object key) { - throw new UnsupportedOperationException("Only read access is supported."); - } - - /** - * Only read access is supported. - */ - public void putAll(Map> t) { - throw new UnsupportedOperationException("Only read access is supported."); - - } - - /** - * Only read access is supported. - */ - public void clear() { - throw new UnsupportedOperationException("Only read access is supported."); - } - - /** - * Only read access is supported. - */ - public Collection> values() { - return headers.values(); - } - -} diff --git a/src/main/java/com/ning/http/client/simple/SimpleAHCTransferListener.java b/src/main/java/com/ning/http/client/simple/SimpleAHCTransferListener.java deleted file mode 100644 index 39d780c32f..0000000000 --- a/src/main/java/com/ning/http/client/simple/SimpleAHCTransferListener.java +++ /dev/null @@ -1,79 +0,0 @@ -package com.ning.http.client.simple; - -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -import com.ning.http.client.SimpleAsyncHttpClient; - -/** - * A simple transfer listener for use with the {@link SimpleAsyncHttpClient}. - *

- * Note: This listener does not cover requests failing before a connection is - * established. For error handling, see - * {@link com.ning.http.client.SimpleAsyncHttpClient.Builder#setDefaultThrowableHandler(com.ning.http.client.ThrowableHandler)} - * - * @author Benjamin Hanzelmann - */ -public interface SimpleAHCTransferListener { - - /** - * This method is called after the connection status is received. - * - * @param url the url for the connection. - * @param statusCode the received status code. - * @param statusText the received status text. - */ - void onStatus(String url, int statusCode, String statusText); - - /** - * This method is called after the response headers are received. - * - * @param url the url for the connection. - * @param headers the received headers, never {@code null}. - */ - void onHeaders(String url, HeaderMap headers); - - /** - * This method is called when bytes of the responses body are received. - * - * @param url the url for the connection. - * @param amount the number of transferred bytes so far. - * @param current the number of transferred bytes since the last call to this - * method. - * @param total the total number of bytes to be transferred. This is taken - * from the Content-Length-header and may be unspecified (-1). - */ - void onBytesReceived(String url, long amount, long current, long total); - - /** - * This method is called when bytes are sent. - * - * @param url the url for the connection. - * @param amount the number of transferred bytes so far. - * @param current the number of transferred bytes since the last call to this - * method. - * @param total the total number of bytes to be transferred. This is taken - * from the Content-Length-header and may be unspecified (-1). - */ - void onBytesSent(String url, long amount, long current, long total); - - /** - * This method is called when the request is completed. - * - * @param url the url for the connection. - * @param statusCode the received status code. - * @param statusText the received status text. - */ - void onCompleted(String url, int statusCode, String statusText); - -} diff --git a/src/main/java/com/ning/http/client/webdav/WebDavCompletionHandlerBase.java b/src/main/java/com/ning/http/client/webdav/WebDavCompletionHandlerBase.java deleted file mode 100644 index d0a483db6d..0000000000 --- a/src/main/java/com/ning/http/client/webdav/WebDavCompletionHandlerBase.java +++ /dev/null @@ -1,189 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.webdav; - -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.w3c.dom.Document; -import org.w3c.dom.Element; -import org.w3c.dom.Node; -import org.w3c.dom.NodeList; -import org.xml.sax.SAXException; - -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.ParserConfigurationException; -import java.io.IOException; -import java.io.InputStream; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; - -/** - * Simple {@link AsyncHandler} that add support for WebDav's response manipulation. - * - * @param - */ -public abstract class WebDavCompletionHandlerBase implements AsyncHandler { - private final Logger logger = LoggerFactory.getLogger(AsyncCompletionHandlerBase.class); - - private final Collection bodies = - Collections.synchronizedCollection(new ArrayList()); - private HttpResponseStatus status; - private HttpResponseHeaders headers; - - /** - * {@inheritDoc} - */ - /* @Override */ - public final STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - bodies.add(content); - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public final STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - this.status = status; - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public final STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - this.headers = headers; - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public final T onCompleted() throws Exception { - if (status != null) { - Response response = status.provider().prepareResponse(status, headers, bodies); - Document document = null; - if (status.getStatusCode() == 207) { - document = readXMLResponse(response.getResponseBodyAsStream()); - } - return onCompleted(new WebDavResponse(status.provider().prepareResponse(status, headers, bodies), document)); - } else { - throw new IllegalStateException("Status is null"); - } - } - - /** - * {@inheritDoc} - */ - /* @Override */ - public void onThrowable(Throwable t) { - logger.debug(t.getMessage(), t); - } - - /** - * Invoked once the HTTP response has been fully read. - * - * @param response The {@link com.ning.http.client.Response} - * @return Type of the value that will be returned by the associated {@link java.util.concurrent.Future} - */ - abstract public T onCompleted(WebDavResponse response) throws Exception; - - - private class HttpStatusWrapper extends HttpResponseStatus { - - private final HttpResponseStatus wrapper; - - private final String statusText; - - private final int statusCode; - - public HttpStatusWrapper(HttpResponseStatus wrapper, String statusText, int statusCode) { - super(wrapper.getUrl(), wrapper.provider()); - this.wrapper = wrapper; - this.statusText = statusText; - this.statusCode = statusCode; - } - - @Override - public int getStatusCode() { - return (statusText == null ? wrapper.getStatusCode() : statusCode); - } - - @Override - public String getStatusText() { - return (statusText == null ? wrapper.getStatusText() : statusText); - } - - @Override - public String getProtocolName() { - return wrapper.getProtocolName(); - } - - @Override - public int getProtocolMajorVersion() { - return wrapper.getProtocolMajorVersion(); - } - - @Override - public int getProtocolMinorVersion() { - return wrapper.getProtocolMinorVersion(); - } - - @Override - public String getProtocolText() { - return wrapper.getStatusText(); - } - } - - private Document readXMLResponse(InputStream stream) { - DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); - Document document = null; - try { - document = factory.newDocumentBuilder().parse(stream); - parse(document); - } catch (SAXException e) { - logger.error(e.getMessage(), e); - throw new RuntimeException(e); - } catch (IOException e) { - logger.error(e.getMessage(), e); - throw new RuntimeException(e); - } catch (ParserConfigurationException e) { - logger.error(e.getMessage(), e); - throw new RuntimeException(e); - } - return document; - } - - private void parse(Document document) { - Element element = document.getDocumentElement(); - NodeList statusNode = element.getElementsByTagName("status"); - for (int i = 0; i < statusNode.getLength(); i++) { - Node node = statusNode.item(i); - - String value = node.getFirstChild().getNodeValue(); - int statusCode = Integer.valueOf(value.substring(value.indexOf(" "), value.lastIndexOf(" ")).trim()); - String statusText = value.substring(value.lastIndexOf(" ")); - status = new HttpStatusWrapper(status, statusText, statusCode); - } - } -} diff --git a/src/main/java/com/ning/http/client/webdav/WebDavResponse.java b/src/main/java/com/ning/http/client/webdav/WebDavResponse.java deleted file mode 100644 index c77cee0320..0000000000 --- a/src/main/java/com/ning/http/client/webdav/WebDavResponse.java +++ /dev/null @@ -1,115 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.webdav; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.Response; -import org.w3c.dom.Document; - -import java.io.IOException; -import java.io.InputStream; -import java.net.MalformedURLException; -import java.net.URI; -import java.util.List; - -/** - * Customized {@link Response} which add support for getting the response's body as an XML document (@link WebDavResponse#getBodyAsXML} - */ -public class WebDavResponse implements Response { - - private final Response response; - private final Document document; - - public WebDavResponse(Response response, Document document) { - this.response = response; - this.document = document; - } - - public int getStatusCode() { - return response.getStatusCode(); - } - - public String getStatusText() { - return response.getStatusText(); - } - - /* @Override */ - public byte[] getResponseBodyAsBytes() throws IOException { - return response.getResponseBodyAsBytes(); - } - - public InputStream getResponseBodyAsStream() throws IOException { - return response.getResponseBodyAsStream(); - } - - public String getResponseBodyExcerpt(int maxLength) throws IOException { - return response.getResponseBodyExcerpt(maxLength); - } - - public String getResponseBodyExcerpt(int maxLength, String charset) throws IOException { - return response.getResponseBodyExcerpt(maxLength, charset); - } - - public String getResponseBody() throws IOException { - return response.getResponseBody(); - } - - public String getResponseBody(String charset) throws IOException { - return response.getResponseBody(charset); - } - - public URI getUri() throws MalformedURLException { - return response.getUri(); - } - - public String getContentType() { - return response.getContentType(); - } - - public String getHeader(String name) { - return response.getHeader(name); - } - - public List getHeaders(String name) { - return response.getHeaders(name); - } - - public FluentCaseInsensitiveStringsMap getHeaders() { - return response.getHeaders(); - } - - public boolean isRedirected() { - return response.isRedirected(); - } - - public List getCookies() { - return response.getCookies(); - } - - public boolean hasResponseStatus() { - return response.hasResponseStatus(); - } - - public boolean hasResponseHeaders() { - return response.hasResponseHeaders(); - } - - public boolean hasResponseBody() { - return response.hasResponseBody(); - } - - public Document getBodyAsXML() { - return document; - } -} diff --git a/src/main/java/com/ning/http/client/websocket/DefaultWebSocketListener.java b/src/main/java/com/ning/http/client/websocket/DefaultWebSocketListener.java deleted file mode 100644 index 4db626b0d6..0000000000 --- a/src/main/java/com/ning/http/client/websocket/DefaultWebSocketListener.java +++ /dev/null @@ -1,132 +0,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved. - * - * The contents of this file are subject to the terms of either the GNU - * General Public License Version 2 only ("GPL") or the Common Development - * and Distribution License("CDDL") (collectively, the "License"). You - * may not use this file except in compliance with the License. You can - * obtain a copy of the License at - * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html - * or packager/legal/LICENSE.txt. See the License for the specific - * language governing permissions and limitations under the License. - * - * When distributing the software, include this License Header Notice in each - * file and include the License file at packager/legal/LICENSE.txt. - * - * GPL Classpath Exception: - * Oracle designates this particular file as subject to the "Classpath" - * exception as provided by Oracle in the GPL Version 2 section of the License - * file that accompanied this code. - * - * Modifications: - * If applicable, add the following below the License Header, with the fields - * enclosed by brackets [] replaced by your own identifying information: - * "Portions Copyright [year] [name of copyright owner]" - * - * Contributor(s): - * If you wish your version of this file to be governed by only the CDDL or - * only the GPL Version 2, indicate your decision by adding "[Contributor] - * elects to include this software in this distribution under the [CDDL or GPL - * Version 2] license." If you don't indicate a single choice of license, a - * recipient has the option to distribute your version of this file under - * either the CDDL, the GPL Version 2 or to extend the choice of license to - * its licensees as provided above. However, if you add GPL Version 2 code - * and therefore, elected the GPL Version 2 license, then the option applies - * only if the new code is made subject to such option by the copyright - * holder. - */ -package com.ning.http.client.websocket; - -/** - * Default WebSocketListener implementation. Most methods are no-ops. This - * allows for quick override customization without clutter of methods that the - * developer isn't interested in dealing with. - * - * @since 1.7.0 - */ -public class DefaultWebSocketListener implements WebSocketByteListener, WebSocketTextListener, WebSocketPingListener, WebSocketPongListener { - - protected WebSocket webSocket; - - // -------------------------------------- Methods from WebSocketByteListener - - /** - * {@inheritDoc} - */ - @Override - public void onMessage(byte[] message) { - } - - /** - * {@inheritDoc} - */ - @Override - public void onFragment(byte[] fragment, boolean last) { - } - - - // -------------------------------------- Methods from WebSocketPingListener - - /** - * {@inheritDoc} - */ - @Override - public void onPing(byte[] message) { - } - - - // -------------------------------------- Methods from WebSocketPongListener - - /** - * {@inheritDoc} - */ - @Override - public void onPong(byte[] message) { - } - - - // -------------------------------------- Methods from WebSocketTextListener - - - /** - * {@inheritDoc} - */ - @Override - public void onMessage(String message) { - } - - /** - * {@inheritDoc} - */ - @Override - public void onFragment(String fragment, boolean last) { - } - - - // ------------------------------------------ Methods from WebSocketListener - - /** - * {@inheritDoc} - */ - @Override - public void onOpen(WebSocket websocket) { - this.webSocket = websocket; - } - - /** - * {@inheritDoc} - */ - @Override - public void onClose(WebSocket websocket) { - this.webSocket = null; - } - - /** - * {@inheritDoc} - */ - @Override - public void onError(Throwable t) { - } -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocket.java b/src/main/java/com/ning/http/client/websocket/WebSocket.java deleted file mode 100644 index 4608f47d94..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocket.java +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A Websocket client - */ -public interface WebSocket { - - /** - * Send a byte message. - * @param message a byte message - * @return this - */ - WebSocket sendMessage(byte[] message); - - /** - * Allows streaming of multiple binary fragments. - * - * @param fragment binary fragment. - * @param last flag indicating whether or not this is the last fragment. - * - * @return this. - */ - WebSocket stream(byte[] fragment, boolean last); - - /** - * Allows streaming of multiple binary fragments. - * - * @param fragment binary fragment. - * @param offset starting offset. - * @param len length. - * @param last flag indicating whether or not this is the last fragment. - * @return - */ - WebSocket stream(byte[] fragment, int offset, int len, boolean last); - - /** - * Send a text message - * @param message a text message - * @return this. - */ - WebSocket sendTextMessage(String message); - - /** - * Allows streaming of multiple text fragments. - * - * @param fragment text fragment. - * @param last flag indicating whether or not this is the last fragment. - * @return this. - */ - WebSocket streamText(String fragment, boolean last); - - /** - * Send a ping with an optional payload - * (limited to 125 bytes or less). - * - * @param payload the ping payload. - * - * @return this. - */ - WebSocket sendPing(byte[] payload); - - /** - * Send a ping with an optional payload - * (limited to 125 bytes or less). - * - * @param payload the pong payload. - * @return this. - */ - WebSocket sendPong(byte[] payload); - - /** - * Add a {@link WebSocketListener} - * @param l a {@link WebSocketListener} - * @return this - */ - WebSocket addWebSocketListener(WebSocketListener l); - - /** - * Returns true if the WebSocket is open/connected. - * - * @return true if the WebSocket is open/connected. - */ - boolean isOpen(); - - /** - * Close the WebSocket. - */ - void close(); -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketByteListener.java b/src/main/java/com/ning/http/client/websocket/WebSocketByteListener.java deleted file mode 100644 index e4f9362f1a..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketByteListener.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A {@link WebSocketListener} for bytes - */ -public interface WebSocketByteListener extends WebSocketListener { - - /** - * Invoked when bytes are available. - * @param message a byte array. - */ - void onMessage(byte[] message); - - - /** - * Invoked when bytes of a fragmented message are available. - * - * @param fragment byte[] fragment. - * @param last if this fragment is the last in the series. - */ - void onFragment(byte[] fragment, boolean last); - -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketListener.java b/src/main/java/com/ning/http/client/websocket/WebSocketListener.java deleted file mode 100644 index e193254cc4..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketListener.java +++ /dev/null @@ -1,38 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A generic {@link WebSocketListener} for WebSocket events. Use the appropriate listener for receiving message bytes. - */ -public interface WebSocketListener { - - /** - * Invoked when the {@link WebSocket} is open. - * @param websocket - */ - void onOpen(WebSocket websocket); - - /** - * Invoked when the {@link WebSocket} is close. - * @param websocket - */ - void onClose(WebSocket websocket); - - /** - * Invoked when the {@link WebSocket} is open. - * @param t a {@link Throwable} - */ - void onError(Throwable t); - -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketPingListener.java b/src/main/java/com/ning/http/client/websocket/WebSocketPingListener.java deleted file mode 100644 index 5980c67b9e..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketPingListener.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A WebSocket's Ping Listener - */ -public interface WebSocketPingListener extends WebSocketListener { - - /** - * Invoked when a ping message is received - * @param message a byte array - */ - void onPing(byte[] message); - -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketPongListener.java b/src/main/java/com/ning/http/client/websocket/WebSocketPongListener.java deleted file mode 100644 index 559abc97b3..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketPongListener.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A WebSocket's Pong Listener - */ -public interface WebSocketPongListener extends WebSocketListener { - - /** - * Invoked when a pong message is received - * @param message a byte array - */ - void onPong(byte[] message); - -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketTextListener.java b/src/main/java/com/ning/http/client/websocket/WebSocketTextListener.java deleted file mode 100644 index 1b56319a85..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketTextListener.java +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -/** - * A {@link WebSocketListener} for text message - */ -public interface WebSocketTextListener extends WebSocketListener { - - /** - * Invoked when WebSocket text message are received. - * @param message a {@link String} message - */ - void onMessage(String message); - - /** - * Invoked when WebSocket text fragments are received. - * - * @param fragment text fragment - * @param last if this fragment is the last of the series. - */ - void onFragment(String fragment, boolean last); - -} diff --git a/src/main/java/com/ning/http/client/websocket/WebSocketUpgradeHandler.java b/src/main/java/com/ning/http/client/websocket/WebSocketUpgradeHandler.java deleted file mode 100644 index 9854486400..0000000000 --- a/src/main/java/com/ning/http/client/websocket/WebSocketUpgradeHandler.java +++ /dev/null @@ -1,188 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.UpgradeHandler; - -import java.util.concurrent.ConcurrentLinkedQueue; -import java.util.concurrent.atomic.AtomicBoolean; - -/** - * An {@link AsyncHandler} which is able to execute WebSocket upgrade. Use the Builder for configuring WebSocket options. - */ -public class WebSocketUpgradeHandler implements UpgradeHandler, AsyncHandler { - - private WebSocket webSocket; - private final ConcurrentLinkedQueue l; - private final String protocol; - private final long maxByteSize; - private final long maxTextSize; - private final AtomicBoolean ok = new AtomicBoolean(false); - - private WebSocketUpgradeHandler(Builder b) { - l = b.l; - protocol = b.protocol; - maxByteSize = b.maxByteSize; - maxTextSize = b.maxTextSize; - } - - /** - * {@inheritDoc} - */ - @Override - public final void onThrowable(Throwable t) { - onFailure(t); - } - - /** - * {@inheritDoc} - */ - @Override - public final STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - @Override - public final STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - if (responseStatus.getStatusCode() == 101) { - return STATE.UPGRADE; - } else { - throw new IllegalStateException("Invalid upgrade protocol, status should be 101 but was " + responseStatus.getStatusCode()); - } - } - - /** - * {@inheritDoc} - */ - @Override - public final STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - /** - * {@inheritDoc} - */ - @Override - public final WebSocket onCompleted() throws Exception { - if (webSocket == null) { - throw new IllegalStateException("WebSocket is null"); - } - return webSocket; - } - - /** - * {@inheritDoc} - */ - @Override - public final void onSuccess(WebSocket webSocket) { - this.webSocket = webSocket; - for (WebSocketListener w : l) { - webSocket.addWebSocketListener(w); - w.onOpen(webSocket); - } - ok.set(true); - } - - /** - * {@inheritDoc} - */ - @Override - public final void onFailure(Throwable t) { - for (WebSocketListener w : l) { - if (!ok.get() && webSocket != null) { - webSocket.addWebSocketListener(w); - } - w.onError(t); - } - } - - /** - * Build a {@link WebSocketUpgradeHandler} - */ - public final static class Builder { - private ConcurrentLinkedQueue l = new ConcurrentLinkedQueue(); - private String protocol = ""; - private long maxByteSize = 8192; - private long maxTextSize = 8192; - - /** - * Add a {@link WebSocketListener} that will be added to the {@link WebSocket} - * - * @param listener a {@link WebSocketListener} - * @return this - */ - public Builder addWebSocketListener(WebSocketListener listener) { - l.add(listener); - return this; - } - - /** - * Remove a {@link WebSocketListener} - * - * @param listener a {@link WebSocketListener} - * @return this - */ - public Builder removeWebSocketListener(WebSocketListener listener) { - l.remove(listener); - return this; - } - - /** - * Set the WebSocket protocol. - * - * @param protocol the WebSocket protocol. - * @return this - */ - public Builder setProtocol(String protocol) { - this.protocol = protocol; - return this; - } - - /** - * Set the max size of the WebSocket byte message that will be sent. - * - * @param maxByteSize max size of the WebSocket byte message - * @return this - */ - public Builder setMaxByteSize(long maxByteSize) { - this.maxByteSize = maxByteSize; - return this; - } - - /** - * Set the max size of the WebSocket text message that will be sent. - * - * @param maxTextSize max size of the WebSocket byte message - * @return this - */ - public Builder setMaxTextSize(long maxTextSize) { - this.maxTextSize = maxTextSize; - return this; - } - - /** - * Build a {@link WebSocketUpgradeHandler} - * @return a {@link WebSocketUpgradeHandler} - */ - public WebSocketUpgradeHandler build() { - return new WebSocketUpgradeHandler(this); - } - } -} diff --git a/src/main/java/com/ning/http/multipart/ByteArrayPartSource.java b/src/main/java/com/ning/http/multipart/ByteArrayPartSource.java deleted file mode 100644 index 80ae3f59e3..0000000000 --- a/src/main/java/com/ning/http/multipart/ByteArrayPartSource.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.InputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class ByteArrayPartSource implements PartSource { - - /** - * Name of the source file. - */ - private final String fileName; - - /** - * Byte array of the source file. - */ - private final byte[] bytes; - - /** - * Constructor for ByteArrayPartSource. - * - * @param fileName the name of the file these bytes represent - * @param bytes the content of this part - */ - public ByteArrayPartSource(String fileName, byte[] bytes) { - this.fileName = fileName; - this.bytes = bytes; - } - - /** - * @see PartSource#getLength() - */ - public long getLength() { - return bytes.length; - } - - /** - * @see PartSource#getFileName() - */ - public String getFileName() { - return fileName; - } - - /** - * @see PartSource#createInputStream() - */ - public InputStream createInputStream() throws IOException { - return new ByteArrayInputStream(bytes); - } - -} diff --git a/src/main/java/com/ning/http/multipart/FilePart.java b/src/main/java/com/ning/http/multipart/FilePart.java deleted file mode 100644 index 5548085f08..0000000000 --- a/src/main/java/com/ning/http/multipart/FilePart.java +++ /dev/null @@ -1,234 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.File; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class FilePart extends PartBase { - - /** - * Default content encoding of file attachments. - */ - public static final String DEFAULT_CONTENT_TYPE = "application/octet-stream"; - - /** - * Default charset of file attachments. - */ - public static final String DEFAULT_CHARSET = "ISO-8859-1"; - - /** - * Default transfer encoding of file attachments. - */ - public static final String DEFAULT_TRANSFER_ENCODING = "binary"; - - /** - * Attachment's file name - */ - protected static final String FILE_NAME = "; filename="; - - /** - * Attachment's file name as a byte array - */ - private static final byte[] FILE_NAME_BYTES = - MultipartEncodingUtil.getAsciiBytes(FILE_NAME); - - /** - * Source of the file part. - */ - private PartSource source; - - /** - * FilePart Constructor. - * - * @param name the name for this part - * @param partSource the source for this part - * @param contentType the content type for this part, if null the - * {@link #DEFAULT_CONTENT_TYPE default} is used - * @param charset the charset encoding for this part, if null the - * {@link #DEFAULT_CHARSET default} is used - */ - public FilePart(String name, PartSource partSource, String contentType, String charset) { - - super( - name, - contentType == null ? DEFAULT_CONTENT_TYPE : contentType, - charset == null ? "ISO-8859-1" : charset, - DEFAULT_TRANSFER_ENCODING - ); - - if (partSource == null) { - throw new IllegalArgumentException("Source may not be null"); - } - this.source = partSource; - } - - /** - * FilePart Constructor. - * - * @param name the name for this part - * @param partSource the source for this part - */ - public FilePart(String name, PartSource partSource) { - this(name, partSource, null, null); - } - - /** - * FilePart Constructor. - * - * @param name the name of the file part - * @param file the file to post - * @throws java.io.FileNotFoundException if the file is not a normal - * file or if it is not readable. - */ - public FilePart(String name, File file) - throws FileNotFoundException { - this(name, new FilePartSource(file), null, null); - } - - /** - * FilePart Constructor. - * - * @param name the name of the file part - * @param file the file to post - * @param contentType the content type for this part, if null the - * {@link #DEFAULT_CONTENT_TYPE default} is used - * @param charset the charset encoding for this part, if null the - * {@link #DEFAULT_CHARSET default} is used - * @throws FileNotFoundException if the file is not a normal - * file or if it is not readable. - */ - public FilePart(String name, File file, String contentType, String charset) - throws FileNotFoundException { - this(name, new FilePartSource(file), contentType, charset); - } - - /** - * FilePart Constructor. - * - * @param name the name of the file part - * @param fileName the file name - * @param file the file to post - * @throws FileNotFoundException if the file is not a normal - * file or if it is not readable. - */ - public FilePart(String name, String fileName, File file) - throws FileNotFoundException { - this(name, new FilePartSource(fileName, file), null, null); - } - - /** - * FilePart Constructor. - * - * @param name the name of the file part - * @param fileName the file name - * @param file the file to post - * @param contentType the content type for this part, if null the - * {@link #DEFAULT_CONTENT_TYPE default} is used - * @param charset the charset encoding for this part, if null the - * {@link #DEFAULT_CHARSET default} is used - * @throws FileNotFoundException if the file is not a normal - * file or if it is not readable. - */ - public FilePart(String name, String fileName, File file, String contentType, String charset) - throws FileNotFoundException { - this(name, new FilePartSource(fileName, file), contentType, charset); - } - - /** - * Write the disposition header to the output stream - * - * @param out The output stream - * @throws java.io.IOException If an IO problem occurs - */ - protected void sendDispositionHeader(OutputStream out) - throws IOException { - super.sendDispositionHeader(out); - String filename = this.source.getFileName(); - if (filename != null) { - out.write(FILE_NAME_BYTES); - out.write(QUOTE_BYTES); - out.write(MultipartEncodingUtil.getAsciiBytes(filename)); - out.write(QUOTE_BYTES); - } - } - - /** - * Write the data in "source" to the specified stream. - * - * @param out The output stream. - * @throws IOException if an IO problem occurs. - */ - protected void sendData(OutputStream out) throws IOException { - if (lengthOfData() == 0) { - - // this file contains no data, so there is nothing to send. - // we don't want to create a zero length buffer as this will - // cause an infinite loop when reading. - return; - } - - byte[] tmp = new byte[4096]; - InputStream instream = source.createInputStream(); - try { - int len; - while ((len = instream.read(tmp)) >= 0) { - out.write(tmp, 0, len); - } - } finally { - // we're done with the stream, close it - instream.close(); - } - } - - public void setStalledTime(long ms) { - _stalledTime = ms; - } - - public long getStalledTime() { - return _stalledTime; - } - - /** - * Returns the source of the file part. - * - * @return The source. - */ - protected PartSource getSource() { - return this.source; - } - - /** - * Return the length of the data. - * - * @return The length. - * @throws IOException if an IO problem occurs - */ - protected long lengthOfData() throws IOException { - return source.getLength(); - } - - private long _stalledTime = -1; - -} diff --git a/src/main/java/com/ning/http/multipart/FilePartSource.java b/src/main/java/com/ning/http/multipart/FilePartSource.java deleted file mode 100644 index 3f652047cc..0000000000 --- a/src/main/java/com/ning/http/multipart/FilePartSource.java +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.ByteArrayInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class FilePartSource implements PartSource { - - /** - * File part file. - */ - private File file = null; - - /** - * File part file name. - */ - private String fileName = null; - - /** - * Constructor for FilePartSource. - * - * @param file the FilePart source File. - * @throws java.io.FileNotFoundException if the file does not exist or - * cannot be read - */ - public FilePartSource(File file) throws FileNotFoundException { - this.file = file; - if (file != null) { - if (!file.isFile()) { - throw new FileNotFoundException("File is not a normal file."); - } - if (!file.canRead()) { - throw new FileNotFoundException("File is not readable."); - } - this.fileName = file.getName(); - } - } - - /** - * Constructor for FilePartSource. - * - * @param fileName the file name of the FilePart - * @param file the source File for the FilePart - * @throws FileNotFoundException if the file does not exist or - * cannot be read - */ - public FilePartSource(String fileName, File file) - throws FileNotFoundException { - this(file); - if (fileName != null) { - this.fileName = fileName; - } - } - - /** - * Return the length of the file - * - * @return the length of the file. - * @see PartSource#getLength() - */ - public long getLength() { - if (this.file != null) { - return this.file.length(); - } else { - return 0; - } - } - - /** - * Return the current filename - * - * @return the filename. - * @see PartSource#getFileName() - */ - public String getFileName() { - return (fileName == null) ? "noname" : fileName; - } - - /** - * Return a new {@link java.io.FileInputStream} for the current filename. - * - * @return the new input stream. - * @throws java.io.IOException If an IO problem occurs. - * @see PartSource#createInputStream() - */ - public InputStream createInputStream() throws IOException { - if (this.file != null) { - return new FileInputStream(this.file); - } else { - return new ByteArrayInputStream(new byte[]{}); - } - } - - public File getFile() { - return file; - } - - -} diff --git a/src/main/java/com/ning/http/multipart/FilePartStallHandler.java b/src/main/java/com/ning/http/multipart/FilePartStallHandler.java deleted file mode 100644 index 460aea8b6c..0000000000 --- a/src/main/java/com/ning/http/multipart/FilePartStallHandler.java +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.multipart; - -import java.util.Timer; -import java.util.TimerTask; - -/** - * @author Gail Hernandez - */ -public class FilePartStallHandler extends TimerTask { - public FilePartStallHandler(long waitTime, FilePart filePart) { - _waitTime = waitTime; - _failed = false; - _written = false; - } - - public void completed() { - if(_waitTime > 0) { - _timer.cancel(); - } - } - - public boolean isFailed() { - return _failed; - } - - public void run() { - if(!_written) { - _failed = true; - _timer.cancel(); - } - _written = false; - } - - public void start() { - if(_waitTime > 0) { - _timer = new Timer(); - _timer.scheduleAtFixedRate(this, _waitTime, _waitTime); - } - } - - public void writeHappened() { - _written = true; - } - - private long _waitTime; - private Timer _timer; - private boolean _failed; - private boolean _written; -} diff --git a/src/main/java/com/ning/http/multipart/FileUploadStalledException.java b/src/main/java/com/ning/http/multipart/FileUploadStalledException.java deleted file mode 100644 index 6549929868..0000000000 --- a/src/main/java/com/ning/http/multipart/FileUploadStalledException.java +++ /dev/null @@ -1,22 +0,0 @@ -/* -* Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. -* -* This program is licensed to you under the Apache License Version 2.0, -* and you may not use this file except in compliance with the Apache License Version 2.0. -* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the Apache License Version 2.0 is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. -*/ -package com.ning.http.multipart; - -import java.io.IOException; - -/** - * @author Gail Hernandez - */ -public class FileUploadStalledException extends IOException { - -} diff --git a/src/main/java/com/ning/http/multipart/MultipartBody.java b/src/main/java/com/ning/http/multipart/MultipartBody.java deleted file mode 100644 index 88ee5da2ea..0000000000 --- a/src/main/java/com/ning/http/multipart/MultipartBody.java +++ /dev/null @@ -1,593 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.multipart; - -import com.ning.http.client.RandomAccessBody; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.RandomAccessFile; -import java.nio.ByteBuffer; -import java.nio.channels.FileChannel; -import java.nio.channels.WritableByteChannel; -import java.util.ArrayList; -import java.util.List; - -public class MultipartBody implements RandomAccessBody { - - private byte[] boundary; - private long contentLength; - private List parts; - private List files; - private int startPart; - private final static Logger logger = LoggerFactory.getLogger(MultipartBody.class); - ByteArrayInputStream currentStream; - int currentStreamPosition; - boolean endWritten; - boolean doneWritingParts; - FileLocation fileLocation; - FilePart currentFilePart; - FileChannel currentFileChannel; - - enum FileLocation {NONE, START, MIDDLE, END} - - public MultipartBody(List parts, String boundary, String contentLength) { - this.boundary = MultipartEncodingUtil.getAsciiBytes(boundary.substring("multipart/form-data; boundary=".length())); - this.contentLength = Long.parseLong(contentLength); - this.parts = parts; - - files = new ArrayList(); - - startPart = 0; - currentStreamPosition = -1; - endWritten = false; - doneWritingParts = false; - fileLocation = FileLocation.NONE; - currentFilePart = null; - } - - public void close() throws IOException { - for (RandomAccessFile file : files) { - file.close(); - } - } - - public long getContentLength() { - return contentLength; - } - - public long read(ByteBuffer buffer) throws IOException { - try { - int overallLength = 0; - - int maxLength = buffer.capacity(); - - if (startPart == parts.size() && endWritten) { - return overallLength; - } - - boolean full = false; - while (!full && !doneWritingParts) { - com.ning.http.client.Part part = null; - if (startPart < parts.size()) { - part = parts.get(startPart); - } - if (currentFileChannel != null) { - overallLength += currentFileChannel.read(buffer); - - if (currentFileChannel.position() == currentFileChannel.size()) { - currentFileChannel.close(); - currentFileChannel = null; - } - - if (overallLength == maxLength) { - full = true; - } - } else if (currentStreamPosition > -1) { - overallLength += writeToBuffer(buffer, maxLength - overallLength); - - if (overallLength == maxLength) { - full = true; - } - if (startPart == parts.size() && currentStream.available() == 0) { - doneWritingParts = true; - } - } else if (part instanceof StringPart) { - StringPart currentPart = (StringPart) part; - - initializeStringPart(currentPart); - - startPart++; - } else if (part instanceof com.ning.http.client.StringPart) { - StringPart currentPart = generateClientStringpart(part); - - initializeStringPart(currentPart); - - startPart++; - } else if (part instanceof FilePart) { - if (fileLocation == FileLocation.NONE) { - currentFilePart = (FilePart) part; - initializeFilePart(currentFilePart); - } else if (fileLocation == FileLocation.START) { - initializeFileBody(currentFilePart); - } else if (fileLocation == FileLocation.MIDDLE) { - initializeFileEnd(currentFilePart); - } else if (fileLocation == FileLocation.END) { - startPart++; - if (startPart == parts.size() && currentStream.available() == 0) { - doneWritingParts = true; - } - } - } else if (part instanceof com.ning.http.client.FilePart) { - if (fileLocation == FileLocation.NONE) { - currentFilePart = generateClientFilePart(part); - initializeFilePart(currentFilePart); - } else if (fileLocation == FileLocation.START) { - initializeFileBody(currentFilePart); - } else if (fileLocation == FileLocation.MIDDLE) { - initializeFileEnd(currentFilePart); - } else if (fileLocation == FileLocation.END) { - startPart++; - if (startPart == parts.size() && currentStream.available() == 0) { - doneWritingParts = true; - } - } - } else if (part instanceof com.ning.http.client.ByteArrayPart) { - com.ning.http.client.ByteArrayPart bytePart = - (com.ning.http.client.ByteArrayPart) part; - - if (fileLocation == FileLocation.NONE) { - currentFilePart = - generateClientByteArrayPart(bytePart); - - initializeFilePart(currentFilePart); - } else if (fileLocation == FileLocation.START) { - initializeByteArrayBody(currentFilePart); - } else if (fileLocation == FileLocation.MIDDLE) { - initializeFileEnd(currentFilePart); - } else if (fileLocation == FileLocation.END) { - startPart++; - if (startPart == parts.size() && currentStream.available() == 0) { - doneWritingParts = true; - } - } - } - } - - if (doneWritingParts) { - if (currentStreamPosition == -1) { - ByteArrayOutputStream endWriter = new ByteArrayOutputStream(); - - Part.sendMessageEnd(endWriter, boundary); - - initializeBuffer(endWriter); - } - - if (currentStreamPosition > -1) { - overallLength += writeToBuffer(buffer, maxLength - overallLength); - - if (currentStream.available() == 0) { - currentStream.close(); - currentStreamPosition = -1; - endWritten = true; - } - } - } - return overallLength; - - } catch (Exception e) { - logger.info("read exception", e); - return 0; - } - } - - private void initializeByteArrayBody(FilePart filePart) - throws IOException { - - ByteArrayOutputStream output = generateByteArrayBody(filePart); - - initializeBuffer(output); - - fileLocation = FileLocation.MIDDLE; - } - - private void initializeFileEnd(FilePart currentPart) - throws IOException { - - ByteArrayOutputStream output = generateFileEnd(currentPart); - - initializeBuffer(output); - - fileLocation = FileLocation.END; - - } - - private void initializeFileBody(FilePart currentPart) - throws IOException { - - if (FilePartSource.class.isAssignableFrom(currentPart.getSource().getClass())) { - - FilePartSource source = (FilePartSource) currentPart.getSource(); - - File file = source.getFile(); - - RandomAccessFile raf = new RandomAccessFile(file, "r"); - files.add(raf); - - currentFileChannel = raf.getChannel(); - - } else { - PartSource partSource = currentPart.getSource(); - - InputStream stream = partSource.createInputStream(); - - byte[] bytes = new byte[(int) partSource.getLength()]; - - stream.read(bytes); - - currentStream = new ByteArrayInputStream(bytes); - - currentStreamPosition = 0; - } - - fileLocation = FileLocation.MIDDLE; - } - - private void initializeFilePart(FilePart filePart) - throws IOException { - - filePart.setPartBoundary(boundary); - - ByteArrayOutputStream output = generateFileStart(filePart); - - initializeBuffer(output); - - fileLocation = FileLocation.START; - } - - private void initializeStringPart(StringPart currentPart) - throws IOException { - currentPart.setPartBoundary(boundary); - - ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); - - Part.sendPart(outputStream, currentPart, boundary); - - initializeBuffer(outputStream); - } - - private int writeToBuffer(ByteBuffer buffer, int length) - throws IOException { - - int available = currentStream.available(); - - int writeLength = Math.min(available, length); - - byte[] bytes = new byte[writeLength]; - - currentStream.read(bytes); - - buffer.put(bytes); - - if (available <= length) { - currentStream.close(); - currentStreamPosition = -1; - } else { - currentStreamPosition += writeLength; - } - - return writeLength; - } - - private void initializeBuffer(ByteArrayOutputStream outputStream) - throws IOException { - - currentStream = new ByteArrayInputStream(outputStream.toByteArray()); - - currentStreamPosition = 0; - - } - - public long transferTo(long position, long count, WritableByteChannel target) - throws IOException { - - long overallLength = 0; - - if (startPart == parts.size()) { - return contentLength; - } - - int tempPart = startPart; - - for (com.ning.http.client.Part part : parts) { - if (part instanceof Part) { - overallLength += handleMultiPart(target, (Part) part); - } else { - overallLength += handleClientPart(target, part); - } - - tempPart++; - } - ByteArrayOutputStream endWriter = - new ByteArrayOutputStream(); - - Part.sendMessageEnd(endWriter, boundary); - - overallLength += writeToTarget(target, endWriter); - - startPart = tempPart; - - return overallLength; - } - - private long handleClientPart( - WritableByteChannel target, com.ning.http.client.Part part) throws IOException { - - if (part.getClass().equals(com.ning.http.client.StringPart.class)) { - StringPart currentPart = generateClientStringpart(part); - - return handleStringPart(target, currentPart); - } else if (part.getClass().equals(com.ning.http.client.FilePart.class)) { - FilePart filePart = generateClientFilePart(part); - - return handleFilePart(target, filePart); - } else if (part.getClass().equals(com.ning.http.client.ByteArrayPart.class)) { - com.ning.http.client.ByteArrayPart bytePart = (com.ning.http.client.ByteArrayPart) part; - - FilePart filePart = generateClientByteArrayPart(bytePart); - - return handleByteArrayPart(target, filePart, bytePart.getData()); - } - - return 0; - } - - private FilePart generateClientByteArrayPart( - com.ning.http.client.ByteArrayPart bytePart) { - ByteArrayPartSource source = new ByteArrayPartSource(bytePart.getFileName(), bytePart.getData()); - - FilePart filePart = new FilePart(bytePart.getName(), source, bytePart.getMimeType(), bytePart.getCharSet()); - return filePart; - } - - private FilePart generateClientFilePart(com.ning.http.client.Part part) - throws FileNotFoundException { - com.ning.http.client.FilePart currentPart = (com.ning.http.client.FilePart) part; - - FilePart filePart = new FilePart(currentPart.getName(), currentPart.getFile(), currentPart.getMimeType(), currentPart.getCharSet()); - return filePart; - } - - private StringPart generateClientStringpart(com.ning.http.client.Part part) { - com.ning.http.client.StringPart stringPart = (com.ning.http.client.StringPart) part; - - StringPart currentPart = new StringPart(stringPart.getName(), stringPart.getValue(), stringPart.getCharset()); - return currentPart; - } - - private long handleByteArrayPart(WritableByteChannel target, - FilePart filePart, byte[] data) throws IOException { - - ByteArrayOutputStream output = generateByteArrayBody(filePart); - return writeToTarget(target, output); - } - - private ByteArrayOutputStream generateByteArrayBody(FilePart filePart) - throws IOException { - ByteArrayOutputStream output = new ByteArrayOutputStream(); - Part.sendPart(output, filePart, boundary); - return output; - } - - private long handleFileEnd(WritableByteChannel target, FilePart filePart) - throws IOException { - - ByteArrayOutputStream endOverhead = generateFileEnd(filePart); - - return this.writeToTarget(target, endOverhead); - } - - private ByteArrayOutputStream generateFileEnd(FilePart filePart) - throws IOException { - ByteArrayOutputStream endOverhead = new ByteArrayOutputStream(); - - filePart.sendEnd(endOverhead); - return endOverhead; - } - - private long handleFileHeaders(WritableByteChannel target, FilePart filePart) throws IOException { - filePart.setPartBoundary(boundary); - - ByteArrayOutputStream overhead = generateFileStart(filePart); - - return writeToTarget(target, overhead); - } - - private ByteArrayOutputStream generateFileStart(FilePart filePart) - throws IOException { - ByteArrayOutputStream overhead = new ByteArrayOutputStream(); - - filePart.setPartBoundary(boundary); - - filePart.sendStart(overhead); - filePart.sendDispositionHeader(overhead); - filePart.sendContentTypeHeader(overhead); - filePart.sendTransferEncodingHeader(overhead); - filePart.sendEndOfHeader(overhead); - return overhead; - } - - private long handleFilePart(WritableByteChannel target, FilePart filePart) throws IOException { - FilePartStallHandler handler = new FilePartStallHandler( - filePart.getStalledTime(), filePart); - - handler.start(); - - if (FilePartSource.class.isAssignableFrom(filePart.getSource().getClass())) { - int length = 0; - - length += handleFileHeaders(target, filePart); - FilePartSource source = (FilePartSource) filePart.getSource(); - - File file = source.getFile(); - - RandomAccessFile raf = new RandomAccessFile(file, "r"); - files.add(raf); - - FileChannel fc = raf.getChannel(); - - long l = file.length(); - int fileLength = 0; - long nWrite = 0; - synchronized (fc) { - while (fileLength != l) { - if(handler.isFailed()) { - logger.debug("Stalled error"); - throw new FileUploadStalledException(); - } - try { - nWrite = fc.transferTo(fileLength, l, target); - - if (nWrite == 0) { - logger.info("Waiting for writing..."); - try { - fc.wait(50); - } catch (InterruptedException e) { - logger.trace(e.getMessage(), e); - } - } - else { - handler.writeHappened(); - } - } catch (IOException ex) { - String message = ex.getMessage(); - - // http://bugs.sun.com/view_bug.do?bug_id=5103988 - if (message != null && message.equalsIgnoreCase("Resource temporarily unavailable")) { - try { - fc.wait(1000); - } catch (InterruptedException e) { - logger.trace(e.getMessage(), e); - } - logger.warn("Experiencing NIO issue http://bugs.sun.com/view_bug.do?bug_id=5103988. Retrying"); - continue; - } else { - throw ex; - } - } - fileLength += nWrite; - } - } - handler.completed(); - - fc.close(); - - length += handleFileEnd(target, filePart); - - return length; - } else { - return handlePartSource(target, filePart); - } - } - - private long handlePartSource(WritableByteChannel target, FilePart filePart) throws IOException { - - int length = 0; - - length += handleFileHeaders(target, filePart); - - PartSource partSource = filePart.getSource(); - - InputStream stream = partSource.createInputStream(); - - try { - int nRead = 0; - while (nRead != -1) { - // Do not buffer the entire monster in memory. - byte[] bytes = new byte[8192]; - nRead = stream.read(bytes); - if (nRead > 0) { - ByteArrayOutputStream bos = new ByteArrayOutputStream(nRead); - bos.write(bytes, 0, nRead); - writeToTarget(target, bos); - } - } - } finally { - stream.close(); - } - length += handleFileEnd(target, filePart); - - return length; - } - - private long handleStringPart(WritableByteChannel target, StringPart currentPart) throws IOException { - - currentPart.setPartBoundary(boundary); - - ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); - - Part.sendPart(outputStream, currentPart, boundary); - - return writeToTarget(target, outputStream); - } - - private long handleMultiPart(WritableByteChannel target, Part currentPart) throws IOException { - - currentPart.setPartBoundary(boundary); - - if (currentPart.getClass().equals(StringPart.class)) { - return handleStringPart(target, (StringPart) currentPart); - } else if (currentPart.getClass().equals(FilePart.class)) { - FilePart filePart = (FilePart) currentPart; - - return handleFilePart(target, filePart); - } - return 0; - } - - private long writeToTarget(WritableByteChannel target, ByteArrayOutputStream byteWriter) - throws IOException { - - int written = 0; - int maxSpin = 0; - synchronized (byteWriter) { - ByteBuffer message = ByteBuffer.wrap(byteWriter.toByteArray()); - while ((target.isOpen()) && (written < byteWriter.size())) { - long nWrite = target.write(message); - written += nWrite; - if (nWrite == 0 && maxSpin++ < 10) { - logger.info("Waiting for writing..."); - try { - byteWriter.wait(1000); - } catch (InterruptedException e) { - logger.trace(e.getMessage(), e); - } - } else { - if (maxSpin >= 10) { - throw new IOException("Unable to write on channel " + target); - } - maxSpin = 0; - } - } - } - return written; - } - -} diff --git a/src/main/java/com/ning/http/multipart/MultipartEncodingUtil.java b/src/main/java/com/ning/http/multipart/MultipartEncodingUtil.java deleted file mode 100644 index 1185100ec4..0000000000 --- a/src/main/java/com/ning/http/multipart/MultipartEncodingUtil.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.UnsupportedEncodingException; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class MultipartEncodingUtil { - - public static byte[] getAsciiBytes(String data) { - try { - return data.getBytes("US-ASCII"); - } catch (UnsupportedEncodingException e) { - throw new RuntimeException(e); - } - } - - public static String getAsciiString(final byte[] data) { - if (data == null) { - throw new IllegalArgumentException("Parameter may not be null"); - } - - try { - return new String(data, "US-ASCII"); - } catch (UnsupportedEncodingException e) { - throw new RuntimeException(e); - } - } - - public static byte[] getBytes(final String data, String charset) { - - if (data == null) { - throw new IllegalArgumentException("data may not be null"); - } - - if (charset == null || charset.length() == 0) { - throw new IllegalArgumentException("charset may not be null or empty"); - } - - try { - return data.getBytes(charset); - } catch (UnsupportedEncodingException e) { - throw new IllegalArgumentException(String.format("Unsupported encoding: %s", charset)); - } - } -} diff --git a/src/main/java/com/ning/http/multipart/MultipartRequestEntity.java b/src/main/java/com/ning/http/multipart/MultipartRequestEntity.java deleted file mode 100644 index 0d93447a22..0000000000 --- a/src/main/java/com/ning/http/multipart/MultipartRequestEntity.java +++ /dev/null @@ -1,148 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import com.ning.http.client.FluentStringsMap; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.IOException; -import java.io.OutputStream; -import java.util.Random; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class MultipartRequestEntity implements RequestEntity { - - /** - * The Content-Type for multipart/form-data. - */ - private static final String MULTIPART_FORM_CONTENT_TYPE = "multipart/form-data"; - - /** - * The pool of ASCII chars to be used for generating a multipart boundary. - */ - private static byte[] MULTIPART_CHARS = MultipartEncodingUtil.getAsciiBytes( - "-_1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"); - - /** - * Generates a random multipart boundary string. - * - * @return - */ - private static byte[] generateMultipartBoundary() { - Random rand = new Random(); - byte[] bytes = new byte[rand.nextInt(11) + 30]; // a random size from 30 to 40 - for (int i = 0; i < bytes.length; i++) { - bytes[i] = MULTIPART_CHARS[rand.nextInt(MULTIPART_CHARS.length)]; - } - return bytes; - } - - private final Logger log = LoggerFactory.getLogger(MultipartRequestEntity.class); - - /** - * The MIME parts as set by the constructor - */ - protected Part[] parts; - - private byte[] multipartBoundary; - - private FluentStringsMap methodParams; - - /** - * Creates a new multipart entity containing the given parts. - * - * @param parts The parts to include. - * @param methodParams The params of the HttpMethod using this entity. - */ - public MultipartRequestEntity(Part[] parts, FluentStringsMap methodParams) { - if (parts == null) { - throw new IllegalArgumentException("parts cannot be null"); - } - if (methodParams == null) { - methodParams = new FluentStringsMap(); - } - this.parts = parts; - this.methodParams = methodParams; - } - - /** - * Returns the MIME boundary string that is used to demarcate boundaries of - * this part. The first call to this method will implicitly create a new - * boundary string. To create a boundary string first the - * HttpMethodParams.MULTIPART_BOUNDARY parameter is considered. Otherwise - * a random one is generated. - * - * @return The boundary string of this entity in ASCII encoding. - */ - protected byte[] getMultipartBoundary() { - if (multipartBoundary == null) { - String temp = methodParams.get("") == null ? null : methodParams.get("").iterator().next(); - if (temp != null) { - multipartBoundary = MultipartEncodingUtil.getAsciiBytes(temp); - } else { - multipartBoundary = generateMultipartBoundary(); - } - } - return multipartBoundary; - } - - /** - * Returns true if all parts are repeatable, false otherwise. - */ - public boolean isRepeatable() { - for (int i = 0; i < parts.length; i++) { - if (!parts[i].isRepeatable()) { - return false; - } - } - return true; - } - - /* (non-Javadoc) - * @see org.apache.commons.httpclient.methods.RequestEntity#writeRequest(java.io.OutputStream) - */ - public void writeRequest(OutputStream out) throws IOException { - Part.sendParts(out, parts, getMultipartBoundary()); - } - - /* (non-Javadoc) - * @see org.apache.commons.httpclient.methods.RequestEntity#getContentLength() - */ - public long getContentLength() { - try { - return Part.getLengthOfParts(parts, getMultipartBoundary()); - } catch (Exception e) { - log.error("An exception occurred while getting the length of the parts", e); - return 0; - } - } - - /* (non-Javadoc) - * @see org.apache.commons.httpclient.methods.RequestEntity#getContentType() - */ - public String getContentType() { - StringBuffer buffer = new StringBuffer(MULTIPART_FORM_CONTENT_TYPE); - buffer.append("; boundary="); - buffer.append(MultipartEncodingUtil.getAsciiString(getMultipartBoundary())); - return buffer.toString(); - } - -} diff --git a/src/main/java/com/ning/http/multipart/Part.java b/src/main/java/com/ning/http/multipart/Part.java deleted file mode 100644 index f1d5d30807..0000000000 --- a/src/main/java/com/ning/http/multipart/Part.java +++ /dev/null @@ -1,456 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.OutputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public abstract class Part implements com.ning.http.client.Part { - - /** - * The boundary - */ - protected static final String BOUNDARY = "----------------314159265358979323846"; - - /** - * The default boundary to be used if etBoundaryBytes(byte[]) has not - * been called. - */ - private static final byte[] DEFAULT_BOUNDARY_BYTES = MultipartEncodingUtil.getAsciiBytes(BOUNDARY); - - /** - * Carriage return/linefeed - */ - protected static final String CRLF = "\r\n"; - - /** - * Carriage return/linefeed as a byte array - */ - static final byte[] CRLF_BYTES = MultipartEncodingUtil.getAsciiBytes(CRLF); - - /** - * Content dispostion characters - */ - protected static final String QUOTE = "\""; - - /** - * Content dispostion as a byte array - */ - static final byte[] QUOTE_BYTES = MultipartEncodingUtil.getAsciiBytes(QUOTE); - - /** - * Extra characters - */ - protected static final String EXTRA = "--"; - - /** - * Extra characters as a byte array - */ - static final byte[] EXTRA_BYTES = MultipartEncodingUtil.getAsciiBytes(EXTRA); - - /** - * Content dispostion characters - */ - protected static final String CONTENT_DISPOSITION = "Content-Disposition: form-data; name="; - - /** - * Content dispostion as a byte array - */ - static final byte[] CONTENT_DISPOSITION_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_DISPOSITION); - - /** - * Content type header - */ - protected static final String CONTENT_TYPE = "Content-Type: "; - - /** - * Content type header as a byte array - */ - static final byte[] CONTENT_TYPE_BYTES = MultipartEncodingUtil.getAsciiBytes(CONTENT_TYPE); - - /** - * Content charset - */ - protected static final String CHARSET = "; charset="; - - /** - * Content charset as a byte array - */ - static final byte[] CHARSET_BYTES = MultipartEncodingUtil.getAsciiBytes(CHARSET); - - /** - * Content type header - */ - protected static final String CONTENT_TRANSFER_ENCODING = "Content-Transfer-Encoding: "; - - /** - * Content type header as a byte array - */ - static final byte[] CONTENT_TRANSFER_ENCODING_BYTES = - MultipartEncodingUtil.getAsciiBytes(CONTENT_TRANSFER_ENCODING); - - /** - * Return the boundary string. - * - * @return the boundary string - * @deprecated uses a constant string. Rather use {@link #getPartBoundary} - */ - public static String getBoundary() { - return BOUNDARY; - } - - /** - * The ASCII bytes to use as the multipart boundary. - */ - private byte[] boundaryBytes; - - /** - * Return the name of this part. - * - * @return The name. - */ - public abstract String getName(); - - /** - * Returns the content type of this part. - * - * @return the content type, or null to exclude the content type header - */ - public abstract String getContentType(); - - /** - * Return the character encoding of this part. - * - * @return the character encoding, or null to exclude the character - * encoding header - */ - public abstract String getCharSet(); - - /** - * Return the transfer encoding of this part. - * - * @return the transfer encoding, or null to exclude the transfer encoding header - */ - public abstract String getTransferEncoding(); - - /** - * Gets the part boundary to be used. - * - * @return the part boundary as an array of bytes. - * @since 3.0 - */ - protected byte[] getPartBoundary() { - if (boundaryBytes == null) { - // custom boundary bytes have not been set, use the default. - return DEFAULT_BOUNDARY_BYTES; - } else { - return boundaryBytes; - } - } - - /** - * Sets the part boundary. Only meant to be used by - * {@link Part#sendParts(java.io.OutputStream, Part[], byte[])} - * and {@link Part#getLengthOfParts(Part[], byte[])} - * - * @param boundaryBytes An array of ASCII bytes. - * @since 3.0 - */ - void setPartBoundary(byte[] boundaryBytes) { - this.boundaryBytes = boundaryBytes; - } - - /** - * Tests if this part can be sent more than once. - * - * @return true if {@link #sendData(java.io.OutputStream)} can be successfully called - * more than once. - * @since 3.0 - */ - public boolean isRepeatable() { - return true; - } - - /** - * Write the start to the specified output stream - * - * @param out The output stream - * @throws java.io.IOException If an IO problem occurs. - */ - protected void sendStart(OutputStream out) throws IOException { - out.write(EXTRA_BYTES); - out.write(getPartBoundary()); - out.write(CRLF_BYTES); - } - - /** - * Write the content disposition header to the specified output stream - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected void sendDispositionHeader(OutputStream out) throws IOException { - out.write(CONTENT_DISPOSITION_BYTES); - out.write(QUOTE_BYTES); - out.write(MultipartEncodingUtil.getAsciiBytes(getName())); - out.write(QUOTE_BYTES); - } - - /** - * Write the content type header to the specified output stream - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected void sendContentTypeHeader(OutputStream out) throws IOException { - String contentType = getContentType(); - if (contentType != null) { - out.write(CRLF_BYTES); - out.write(CONTENT_TYPE_BYTES); - out.write(MultipartEncodingUtil.getAsciiBytes(contentType)); - String charSet = getCharSet(); - if (charSet != null) { - out.write(CHARSET_BYTES); - out.write(MultipartEncodingUtil.getAsciiBytes(charSet)); - } - } - } - - /** - * Write the content transfer encoding header to the specified - * output stream - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected void sendTransferEncodingHeader(OutputStream out) throws IOException { - String transferEncoding = getTransferEncoding(); - if (transferEncoding != null) { - out.write(CRLF_BYTES); - out.write(CONTENT_TRANSFER_ENCODING_BYTES); - out.write(MultipartEncodingUtil.getAsciiBytes(transferEncoding)); - } - } - - /** - * Write the end of the header to the output stream - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected void sendEndOfHeader(OutputStream out) throws IOException { - out.write(CRLF_BYTES); - out.write(CRLF_BYTES); - } - - /** - * Write the data to the specified output stream - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected abstract void sendData(OutputStream out) throws IOException; - - /** - * Return the length of the main content - * - * @return long The length. - * @throws IOException If an IO problem occurs - */ - protected abstract long lengthOfData() throws IOException; - - /** - * Write the end data to the output stream. - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - protected void sendEnd(OutputStream out) throws IOException { - out.write(CRLF_BYTES); - } - - /** - * Write all the data to the output stream. - * If you override this method make sure to override - * #length() as well - * - * @param out The output stream - * @throws IOException If an IO problem occurs. - */ - public void send(OutputStream out) throws IOException { - sendStart(out); - sendDispositionHeader(out); - sendContentTypeHeader(out); - sendTransferEncodingHeader(out); - sendEndOfHeader(out); - sendData(out); - sendEnd(out); - } - - - /** - * Return the full length of all the data. - * If you override this method make sure to override - * #send(OutputStream) as well - * - * @return long The length. - * @throws IOException If an IO problem occurs - */ - public long length() throws IOException { - if (lengthOfData() < 0) { - return -1; - } - ByteArrayOutputStream overhead = new ByteArrayOutputStream(); - sendStart(overhead); - sendDispositionHeader(overhead); - sendContentTypeHeader(overhead); - sendTransferEncodingHeader(overhead); - sendEndOfHeader(overhead); - sendEnd(overhead); - return overhead.size() + lengthOfData(); - } - - /** - * Return a string representation of this object. - * - * @return A string representation of this object. - * @see java.lang.Object#toString() - */ - public String toString() { - return this.getName(); - } - - /** - * Write all parts and the last boundary to the specified output stream. - * - * @param out The stream to write to. - * @param parts The parts to write. - * @throws IOException If an I/O error occurs while writing the parts. - */ - public static void sendParts(OutputStream out, final Part[] parts) - throws IOException { - sendParts(out, parts, DEFAULT_BOUNDARY_BYTES); - } - - /** - * Write all parts and the last boundary to the specified output stream. - * - * @param out The stream to write to. - * @param parts The parts to write. - * @param partBoundary The ASCII bytes to use as the part boundary. - * @throws IOException If an I/O error occurs while writing the parts. - * @since 3.0 - */ - public static void sendParts(OutputStream out, Part[] parts, byte[] partBoundary) - throws IOException { - - if (parts == null) { - throw new IllegalArgumentException("Parts may not be null"); - } - if (partBoundary == null || partBoundary.length == 0) { - throw new IllegalArgumentException("partBoundary may not be empty"); - } - for (Part part : parts) { - // set the part boundary before the part is sent - part.setPartBoundary(partBoundary); - part.send(out); - } - out.write(EXTRA_BYTES); - out.write(partBoundary); - out.write(EXTRA_BYTES); - out.write(CRLF_BYTES); - } - - public static void sendMessageEnd(OutputStream out, byte[] partBoundary) - throws IOException { - - if (partBoundary == null || partBoundary.length == 0) { - throw new IllegalArgumentException("partBoundary may not be empty"); - } - - out.write(EXTRA_BYTES); - out.write(partBoundary); - out.write(EXTRA_BYTES); - out.write(CRLF_BYTES); - } - - /** - * Write all parts and the last boundary to the specified output stream. - * - * @param out The stream to write to. - * @param part The part to write. - * @throws IOException If an I/O error occurs while writing the parts. - * @since N/A - */ - public static void sendPart(OutputStream out, Part part, byte[] partBoundary) - throws IOException { - - if (part == null) { - throw new IllegalArgumentException("Parts may not be null"); - } - - part.setPartBoundary(partBoundary); - part.send(out); - } - - /** - * Return the total sum of all parts and that of the last boundary - * - * @param parts The parts. - * @return The total length - * @throws IOException If an I/O error occurs while writing the parts. - */ - public static long getLengthOfParts(Part[] parts) - throws IOException { - return getLengthOfParts(parts, DEFAULT_BOUNDARY_BYTES); - } - - /** - * Gets the length of the multipart message including the given parts. - * - * @param parts The parts. - * @param partBoundary The ASCII bytes to use as the part boundary. - * @return The total length - * @throws IOException If an I/O error occurs while writing the parts. - * @since 3.0 - */ - public static long getLengthOfParts(Part[] parts, byte[] partBoundary) throws IOException { - if (parts == null) { - throw new IllegalArgumentException("Parts may not be null"); - } - long total = 0; - for (Part part : parts) { - // set the part boundary before we calculate the part's length - part.setPartBoundary(partBoundary); - long l = part.length(); - if (l < 0) { - return -1; - } - total += l; - } - total += EXTRA_BYTES.length; - total += partBoundary.length; - total += EXTRA_BYTES.length; - total += CRLF_BYTES.length; - return total; - } -} diff --git a/src/main/java/com/ning/http/multipart/PartBase.java b/src/main/java/com/ning/http/multipart/PartBase.java deleted file mode 100644 index 415bb49186..0000000000 --- a/src/main/java/com/ning/http/multipart/PartBase.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public abstract class PartBase extends Part { - - /** - * Name of the file part. - */ - private String name; - - /** - * Content type of the file part. - */ - private String contentType; - - /** - * Content encoding of the file part. - */ - private String charSet; - - /** - * The transfer encoding. - */ - private String transferEncoding; - - /** - * Constructor. - * - * @param name The name of the part - * @param contentType The content type, or null - * @param charSet The character encoding, or null - * @param transferEncoding The transfer encoding, or null - */ - public PartBase(String name, String contentType, String charSet, String transferEncoding) { - - if (name == null) { - throw new IllegalArgumentException("Name must not be null"); - } - this.name = name; - this.contentType = contentType; - this.charSet = charSet; - this.transferEncoding = transferEncoding; - } - - /** - * Returns the name. - * - * @return The name. - */ - public String getName() { - return this.name; - } - - /** - * Returns the content type of this part. - * - * @return String The name. - */ - public String getContentType() { - return this.contentType; - } - - /** - * Return the character encoding of this part. - * - * @return String The name. - */ - public String getCharSet() { - return this.charSet; - } - - /** - * Returns the transfer encoding of this part. - * - * @return String The name. - */ - public String getTransferEncoding() { - return transferEncoding; - } - - /** - * Sets the character encoding. - * - * @param charSet the character encoding, or null to exclude the character - * encoding header - */ - public void setCharSet(String charSet) { - this.charSet = charSet; - } - - /** - * Sets the content type. - * - * @param contentType the content type, or null to exclude the content type header - */ - public void setContentType(String contentType) { - this.contentType = contentType; - } - - /** - * Sets the part name. - * - * @param name - */ - public void setName(String name) { - if (name == null) { - throw new IllegalArgumentException("Name must not be null"); - } - this.name = name; - } - - /** - * Sets the transfer encoding. - * - * @param transferEncoding the transfer encoding, or null to exclude the - * transfer encoding header - */ - public void setTransferEncoding(String transferEncoding) { - this.transferEncoding = transferEncoding; - } - -} diff --git a/src/main/java/com/ning/http/multipart/PartSource.java b/src/main/java/com/ning/http/multipart/PartSource.java deleted file mode 100644 index eecf859c3f..0000000000 --- a/src/main/java/com/ning/http/multipart/PartSource.java +++ /dev/null @@ -1,52 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.IOException; -import java.io.InputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public interface PartSource { - - /** - * Gets the number of bytes contained in this source. - * - * @return a value >= 0 - */ - long getLength(); - - /** - * Gets the name of the file this source represents. - * - * @return the fileName used for posting a MultiPart file part - */ - String getFileName(); - - /** - * Gets a new InputStream for reading this source. This method can be - * called more than once and should therefore return a new stream every - * time. - * - * @return a new InputStream - * @throws java.io.IOException if an error occurs when creating the InputStream - */ - InputStream createInputStream() throws IOException; - -} diff --git a/src/main/java/com/ning/http/multipart/RequestEntity.java b/src/main/java/com/ning/http/multipart/RequestEntity.java deleted file mode 100644 index d0f6bbe069..0000000000 --- a/src/main/java/com/ning/http/multipart/RequestEntity.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.IOException; -import java.io.OutputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public interface RequestEntity { - - /** - * Tests if {@link #writeRequest(java.io.OutputStream)} can be called more than once. - * - * @return true if the entity can be written to {@link java.io.OutputStream} more than once, - * false otherwise. - */ - boolean isRepeatable(); - - /** - * Writes the request entity to the given stream. - * - * @param out - * @throws java.io.IOException - */ - void writeRequest(OutputStream out) throws IOException; - - /** - * Gets the request entity's length. This method should return a non-negative value if the content - * length is known or a negative value if it is not. In the latter case the - * EntityEnclosingMethod will use chunk encoding to - * transmit the request entity. - * - * @return a non-negative value when content length is known or a negative value when content length - * is not known - */ - long getContentLength(); - - /** - * Gets the entity's content type. This content type will be used as the value for the - * "Content-Type" header. - * - * @return the entity's content type - */ - String getContentType(); - -} diff --git a/src/main/java/com/ning/http/multipart/StringPart.java b/src/main/java/com/ning/http/multipart/StringPart.java deleted file mode 100644 index 431362c8bb..0000000000 --- a/src/main/java/com/ning/http/multipart/StringPart.java +++ /dev/null @@ -1,130 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.multipart; - -import java.io.IOException; -import java.io.OutputStream; - -/** - * This class is an adaptation of the Apache HttpClient implementation - * - * @link http://hc.apache.org/httpclient-3.x/ - */ -public class StringPart extends PartBase { - - /** - * Default content encoding of string parameters. - */ - public static final String DEFAULT_CONTENT_TYPE = "text/plain"; - - /** - * Default charset of string parameters - */ - public static final String DEFAULT_CHARSET = "US-ASCII"; - - /** - * Default transfer encoding of string parameters - */ - public static final String DEFAULT_TRANSFER_ENCODING = "8bit"; - - /** - * Contents of this StringPart. - */ - private byte[] content; - - /** - * The String value of this part. - */ - private String value; - - /** - * Constructor. - * - * @param name The name of the part - * @param value the string to post - * @param charset the charset to be used to encode the string, if null - * the {@link #DEFAULT_CHARSET default} is used - */ - public StringPart(String name, String value, String charset) { - - super( - name, - DEFAULT_CONTENT_TYPE, - charset == null ? DEFAULT_CHARSET : charset, - DEFAULT_TRANSFER_ENCODING - ); - if (value == null) { - throw new IllegalArgumentException("Value may not be null"); - } - if (value.indexOf(0) != -1) { - // See RFC 2048, 2.8. "8bit Data" - throw new IllegalArgumentException("NULs may not be present in string parts"); - } - this.value = value; - } - - /** - * Constructor. - * - * @param name The name of the part - * @param value the string to post - */ - public StringPart(String name, String value) { - this(name, value, null); - } - - /** - * Gets the content in bytes. Bytes are lazily created to allow the charset to be changed - * after the part is created. - * - * @return the content in bytes - */ - private byte[] getContent() { - if (content == null) { - content = MultipartEncodingUtil.getBytes(value, getCharSet()); - } - return content; - } - - /** - * Writes the data to the given OutputStream. - * - * @param out the OutputStream to write to - * @throws java.io.IOException if there is a write error - */ - protected void sendData(OutputStream out) throws IOException { - out.write(getContent()); - } - - /** - * Return the length of the data. - * - * @return The length of the data. - * @throws IOException If an IO problem occurs - */ - protected long lengthOfData() throws IOException { - return getContent().length; - } - - /* (non-Javadoc) - * @see org.apache.commons.httpclient.methods.multipart.BasePart#setCharSet(java.lang.String) - */ - public void setCharSet(String charSet) { - super.setCharSet(charSet); - this.content = null; - } - -} diff --git a/src/main/java/com/ning/http/util/AllowAllHostnameVerifier.java b/src/main/java/com/ning/http/util/AllowAllHostnameVerifier.java deleted file mode 100644 index 0223cc1ee6..0000000000 --- a/src/main/java/com/ning/http/util/AllowAllHostnameVerifier.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLSession; - -public class AllowAllHostnameVerifier implements HostnameVerifier { - public boolean verify(String s, SSLSession sslSession) { - return true; - } -} diff --git a/src/main/java/com/ning/http/util/AsyncHttpProviderUtils.java b/src/main/java/com/ning/http/util/AsyncHttpProviderUtils.java deleted file mode 100644 index 0a6759c678..0000000000 --- a/src/main/java/com/ning/http/util/AsyncHttpProviderUtils.java +++ /dev/null @@ -1,533 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -import com.ning.http.client.AsyncHttpProvider; -import com.ning.http.client.ByteArrayPart; -import com.ning.http.client.Cookie; -import com.ning.http.client.FilePart; -import com.ning.http.client.FluentStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.Part; -import com.ning.http.client.StringPart; -import com.ning.http.multipart.ByteArrayPartSource; -import com.ning.http.multipart.MultipartRequestEntity; -import com.ning.http.multipart.PartSource; - -import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; -import java.io.UnsupportedEncodingException; -import java.net.URI; -import java.text.ParseException; -import java.text.SimpleDateFormat; -import java.util.Collection; -import java.util.List; -import java.util.Locale; - -/** - * {@link com.ning.http.client.AsyncHttpProvider} common utilities. - *

- * The cookies's handling code is from the Netty framework. - */ -public class AsyncHttpProviderUtils { - - public final static String DEFAULT_CHARSET = "ISO-8859-1"; - - private final static String BODY_NOT_COMPUTED = "Response's body hasn't been computed by your AsyncHandler."; - - - protected final static ThreadLocal simpleDateFormat = new ThreadLocal() { - protected SimpleDateFormat[] initialValue() { - - return new SimpleDateFormat[] - { - new SimpleDateFormat("EEE MMM d HH:mm:ss yyyy", Locale.US), //ASCTIME - new SimpleDateFormat("EEEE, dd-MMM-yy HH:mm:ss zzz", Locale.US), //RFC1036 - new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US), - new SimpleDateFormat("EEE, dd-MMM-yyyy HH:mm:ss z", Locale.US), - new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss Z", Locale.US), - new SimpleDateFormat("EEE, dd-MMM-yyyy HH:mm:ss Z", Locale.US), - new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss zzz", Locale.US) // RFC1123 - - }; - } - }; - - public final static SimpleDateFormat[] get() { - return simpleDateFormat.get(); - } - - - //space ' ' - static final byte SP = 32; - - //tab ' ' - static final byte HT = 9; - - /** - * Carriage return - */ - static final byte CR = 13; - - /** - * Equals '=' - */ - static final byte EQUALS = 61; - - /** - * Line feed character - */ - static final byte LF = 10; - - /** - * carriage return line feed - */ - static final byte[] CRLF = new byte[]{CR, LF}; - - /** - * Colon ':' - */ - static final byte COLON = 58; - - /** - * Semicolon ';' - */ - static final byte SEMICOLON = 59; - - /** - * comma ',' - */ - static final byte COMMA = 44; - - static final byte DOUBLE_QUOTE = '"'; - - static final String PATH = "Path"; - - static final String EXPIRES = "Expires"; - - static final String MAX_AGE = "Max-Age"; - - static final String DOMAIN = "Domain"; - - static final String SECURE = "Secure"; - - static final String HTTPONLY = "HTTPOnly"; - - static final String COMMENT = "Comment"; - - static final String COMMENTURL = "CommentURL"; - - static final String DISCARD = "Discard"; - - static final String PORT = "Port"; - - static final String VERSION = "Version"; - - public final static URI createUri(String u) { - URI uri = URI.create(u); - final String scheme = uri.getScheme(); - if (scheme == null || !scheme.equalsIgnoreCase("http") && !scheme.equalsIgnoreCase("https") && !scheme.equalsIgnoreCase("ws") - && !scheme.equalsIgnoreCase("wss")) { - throw new IllegalArgumentException("The URI scheme, of the URI " + u - + ", must be equal (ignoring case) to 'http', 'https', 'ws', or 'wss'"); - } - - String path = uri.getPath(); - if (path == null) { - throw new IllegalArgumentException("The URI path, of the URI " + uri - + ", must be non-null"); - } else if (path.length() > 0 && path.charAt(0) != '/') { - throw new IllegalArgumentException("The URI path, of the URI " + uri - + ". must start with a '/'"); - } else if (path.length() == 0) { - return URI.create(u + "/"); - } - - return uri; - } - - public static String getBaseUrl(String url) { - return getBaseUrl(createUri(url)); - } - - public final static String getBaseUrl(URI uri) { - String url = uri.getScheme() + "://" + uri.getAuthority(); - int port = uri.getPort(); - if (port == -1) { - port = getPort(uri); - url += ":" + port; - } - return url; - } - - public final static String getAuthority(URI uri) { - String url = uri.getAuthority(); - int port = uri.getPort(); - if (port == -1) { - port = getPort(uri); - url += ":" + port; - } - return url; - } - - public final static String contentToString(Collection bodyParts, String charset) throws UnsupportedEncodingException { - return new String(contentToByte(bodyParts), charset); - } - - public final static byte[] contentToByte(Collection bodyParts) throws UnsupportedEncodingException { - if (bodyParts.size() == 1) { - return bodyParts.iterator().next().getBodyPartBytes(); - - } else { - int size = 0; - for (HttpResponseBodyPart body : bodyParts) { - size += body.getBodyPartBytes().length; - } - byte[] bytes = new byte[size]; - int offset = 0; - for (HttpResponseBodyPart body : bodyParts) { - byte[] bodyBytes = body.getBodyPartBytes(); - System.arraycopy(bodyBytes, 0, bytes, offset, bodyBytes.length); - offset += bodyBytes.length; - } - - return bytes; - } - } - - public final static String getHost(URI uri) { - String host = uri.getHost(); - if (host == null) { - host = uri.getAuthority(); - } - return host; - } - - public final static URI getRedirectUri(URI uri, String location) { - if(location == null) - throw new IllegalArgumentException("URI " + uri + " was redirected to null location"); - URI newUri = uri.resolve(location); - - String scheme = newUri.getScheme(); - - if (scheme == null || !scheme.equalsIgnoreCase("http") && !scheme.equalsIgnoreCase("https")) { - throw new IllegalArgumentException("The URI scheme, of the URI " + newUri - + ", must be equal (ignoring case) to 'http' or 'https'"); - } - - return newUri; - } - - public final static int getPort(URI uri) { - int port = uri.getPort(); - if (port == -1) - port = uri.getScheme().equals("http") ? 80 : 443; - return port; - } - - /** - * This is quite ugly as our internal names are duplicated, but we build on top of HTTP Client implementation. - * - * @param params - * @param methodParams - * @return a MultipartRequestEntity. - * @throws java.io.FileNotFoundException - */ - public final static MultipartRequestEntity createMultipartRequestEntity(List params, FluentStringsMap methodParams) throws FileNotFoundException { - com.ning.http.multipart.Part[] parts = new com.ning.http.multipart.Part[params.size()]; - int i = 0; - - for (Part part : params) { - if (part instanceof com.ning.http.multipart.Part) { - parts[i] = (com.ning.http.multipart.Part) part; - } else if (part instanceof StringPart) { - parts[i] = new com.ning.http.multipart.StringPart(part.getName(), - ((StringPart) part).getValue(), - ((StringPart) part).getCharset()); - } else if (part instanceof FilePart) { - parts[i] = new com.ning.http.multipart.FilePart(part.getName(), - ((FilePart) part).getFile(), - ((FilePart) part).getMimeType(), - ((FilePart) part).getCharSet()); - - } else if (part instanceof ByteArrayPart) { - PartSource source = new ByteArrayPartSource(((ByteArrayPart) part).getFileName(), ((ByteArrayPart) part).getData()); - parts[i] = new com.ning.http.multipart.FilePart(part.getName(), - source, - ((ByteArrayPart) part).getMimeType(), - ((ByteArrayPart) part).getCharSet()); - - } else if (part == null) { - throw new NullPointerException("Part cannot be null"); - } else { - throw new IllegalArgumentException(String.format("Unsupported part type for multipart parameter %s", - part.getName())); - } - ++i; - } - return new MultipartRequestEntity(parts, methodParams); - } - - public final static byte[] readFully(InputStream in, int[] lengthWrapper) throws IOException { - // just in case available() returns bogus (or -1), allocate non-trivial chunk - byte[] b = new byte[Math.max(512, in.available())]; - int offset = 0; - while (true) { - int left = b.length - offset; - int count = in.read(b, offset, left); - if (count < 0) { // EOF - break; - } - offset += count; - if (count == left) { // full buffer, need to expand - b = doubleUp(b); - } - } - // wish Java had Tuple return type... - lengthWrapper[0] = offset; - return b; - } - - private static byte[] doubleUp(byte[] b) { - int len = b.length; - byte[] b2 = new byte[len + len]; - System.arraycopy(b, 0, b2, 0, len); - return b2; - } - - public static String encodeCookies(Collection cookies) { - StringBuilder sb = new StringBuilder(); - - for (Cookie cookie : cookies) { - if (cookie.getVersion() >= 1) { - add(sb, '$' + VERSION, 1); - } - - add(sb, cookie.getName(), cookie.getValue()); - - if (cookie.getPath() != null) { - add(sb, '$' + PATH, cookie.getPath()); - } - - if (cookie.getDomain() != null) { - add(sb, '$' + DOMAIN, cookie.getDomain()); - } - - if (cookie.getVersion() >= 1) { - if (!cookie.getPorts().isEmpty()) { - sb.append('$'); - sb.append(PORT); - sb.append((char) EQUALS); - sb.append((char) DOUBLE_QUOTE); - for (int port : cookie.getPorts()) { - sb.append(port); - sb.append((char) COMMA); - } - sb.setCharAt(sb.length() - 1, (char) DOUBLE_QUOTE); - sb.append((char) SEMICOLON); - } - } - } - - sb.setLength(sb.length() - 1); - return sb.toString(); - } - - private static void add(StringBuilder sb, String name, String val) { - if (val == null) { - addQuoted(sb, name, ""); - return; - } - - for (int i = 0; i < val.length(); i++) { - char c = val.charAt(i); - switch (c) { - case '\t': - case ' ': - case '"': - case '(': - case ')': - case ',': - case '/': - case ':': - case ';': - case '<': - case '=': - case '>': - case '?': - case '@': - case '[': - case '\\': - case ']': - case '{': - case '}': - addQuoted(sb, name, val); - return; - } - } - - addUnquoted(sb, name, val); - } - - private static void addUnquoted(StringBuilder sb, String name, String val) { - sb.append(name); - sb.append((char) EQUALS); - sb.append(val); - sb.append((char) SEMICOLON); - } - - private static void addQuoted(StringBuilder sb, String name, String val) { - if (val == null) { - val = ""; - } - - sb.append(name); - sb.append((char) EQUALS); - sb.append((char) DOUBLE_QUOTE); - sb.append(val.replace("\\", "\\\\").replace("\"", "\\\"")); - sb.append((char) DOUBLE_QUOTE); - sb.append((char) SEMICOLON); - } - - private static void add(StringBuilder sb, String name, int val) { - sb.append(name); - sb.append((char) EQUALS); - sb.append(val); - sb.append((char) SEMICOLON); - } - - public static String constructUserAgent(Class httpProvider) { - StringBuffer b = new StringBuffer("AsyncHttpClient/1.0") - .append(" ") - .append("(") - .append(httpProvider.getSimpleName()) - .append(" - ") - .append(System.getProperty("os.name")) - .append(" - ") - .append(System.getProperty("os.version")) - .append(" - ") - .append(System.getProperty("java.version")) - .append(" - ") - .append(Runtime.getRuntime().availableProcessors()) - .append(" core(s))"); - return b.toString(); - } - - public static String parseCharset(String contentType) { - for (String part : contentType.split(";")) { - if (part.trim().startsWith("charset=")) { - String[] val = part.split("="); - if (val.length > 1) { - return val[1].trim(); - } - } - } - return null; - } - - public static Cookie parseCookie(String value) { - String[] fields = value.split(";\\s*"); - String[] cookie = fields[0].split("="); - String cookieName = cookie[0]; - String cookieValue = (cookie.length == 1) ? null : cookie[1]; - - int maxAge = -1; - String path = null; - String domain = null; - boolean secure = false; - - boolean maxAgeSet = false; - boolean expiresSet = false; - - for (int j = 1; j < fields.length; j++) { - if ("secure".equalsIgnoreCase(fields[j])) { - secure = true; - } else if (fields[j].indexOf('=') > 0) { - String[] f = fields[j].split("="); - if (f.length == 1) continue; // Add protection against null field values - - // favor 'max-age' field over 'expires' - if (!maxAgeSet && "max-age".equalsIgnoreCase(f[0])) { - try { - maxAge = Integer.valueOf(removeQuote(f[1])); - } catch (NumberFormatException e1) { - // ignore failure to parse -> treat as session cookie - // invalidate a previously parsed expires-field - maxAge = -1; - } - maxAgeSet = true; - } else if (!maxAgeSet && !expiresSet && "expires".equalsIgnoreCase(f[0])) { - try { - maxAge = convertExpireField(f[1]); - } catch (Exception e) { - // original behavior, is this correct at all (expires field with max-age semantics)? - try { - maxAge = Integer.valueOf(f[1]); - } catch (NumberFormatException e1) { - // ignore failure to parse -> treat as session cookie - } - } - expiresSet = true; - } else if ("domain".equalsIgnoreCase(f[0])) { - domain = f[1]; - } else if ("path".equalsIgnoreCase(f[0])) { - path = f[1]; - } - } - } - - if (maxAge < -1) { - maxAge = -1; - } - - return new Cookie(domain, cookieName, cookieValue, path, maxAge, secure); - } - - private static int convertExpireField(String timestring) throws Exception { - Exception exception = null; - for (SimpleDateFormat sdf : simpleDateFormat.get()) { - try { - long expire = sdf.parse(removeQuote(timestring.trim())).getTime(); - return (int) ((expire - System.currentTimeMillis()) / 1000); - } catch (ParseException e) { - exception = e; - } catch (NumberFormatException e) { - exception = e; - } - } - - throw exception; - } - - private final static String removeQuote(String s) { - if (s.startsWith("\"")) { - s = s.substring(1); - } - - if (s.endsWith("\"")) { - s = s.substring(0, s.length() - 1); - } - return s; - } - - public static void checkBodyParts(int statusCode, Collection bodyParts) { - if (bodyParts == null || bodyParts.size() == 0) { - - // We allow empty body on 204 - if (statusCode == 204) return; - - throw new IllegalStateException(BODY_NOT_COMPUTED); - } - } -} diff --git a/src/main/java/com/ning/http/util/AuthenticatorUtils.java b/src/main/java/com/ning/http/util/AuthenticatorUtils.java deleted file mode 100644 index c1220f256e..0000000000 --- a/src/main/java/com/ning/http/util/AuthenticatorUtils.java +++ /dev/null @@ -1,59 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Realm; - -import java.io.UnsupportedEncodingException; -import java.security.NoSuchAlgorithmException; - -public final class AuthenticatorUtils { - - public static String computeBasicAuthentication(Realm realm) throws UnsupportedEncodingException { - String s = realm.getPrincipal() + ":" + realm.getPassword(); - return "Basic " + Base64.encode(s.getBytes(realm.getEncoding())); - } - - public static String computeBasicAuthentication(ProxyServer proxyServer) throws UnsupportedEncodingException { - String s = proxyServer.getPrincipal() + ":" + proxyServer.getPassword(); - return "Basic " + Base64.encode(s.getBytes(proxyServer.getEncoding())); - } - - public static String computeDigestAuthentication(Realm realm) throws NoSuchAlgorithmException, UnsupportedEncodingException { - - StringBuilder builder = new StringBuilder().append("Digest "); - construct(builder, "username", realm.getPrincipal()); - construct(builder, "realm", realm.getRealmName()); - construct(builder, "nonce", realm.getNonce()); - construct(builder, "uri", realm.getUri()); - builder.append("algorithm").append('=').append(realm.getAlgorithm()).append(", "); - - construct(builder, "response", realm.getResponse()); - if (realm.getOpaque() != null && realm.getOpaque() != null && realm.getOpaque().equals("") == false) - construct(builder, "opaque", realm.getOpaque()); - builder.append("qop").append('=').append(realm.getQop()).append(", "); - builder.append("nc").append('=').append(realm.getNc()).append(", "); - construct(builder, "cnonce", realm.getCnonce(), true); - - return new String(builder.toString().getBytes("ISO_8859_1")); - } - - private static StringBuilder construct(StringBuilder builder, String name, String value) { - return construct(builder, name, value, false); - } - - private static StringBuilder construct(StringBuilder builder, String name, String value, boolean tail) { - return builder.append(name).append('=').append('"').append(value).append(tail ? "\"" : "\", "); - } -} diff --git a/src/main/java/com/ning/http/util/Base64.java b/src/main/java/com/ning/http/util/Base64.java deleted file mode 100644 index fe5d54829e..0000000000 --- a/src/main/java/com/ning/http/util/Base64.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -/** - * Implements the "base64" binary encoding scheme as defined by - * RFC 2045. - *

- * Portions of code here are taken from Apache Pivot - */ -public final class Base64 { - private static final char[] lookup = new char[64]; - private static final byte[] reverseLookup = new byte[256]; - - static { - // Populate the lookup array - - for (int i = 0; i < 26; i++) { - lookup[i] = (char) ('A' + i); - } - - for (int i = 26, j = 0; i < 52; i++, j++) { - lookup[i] = (char) ('a' + j); - } - - for (int i = 52, j = 0; i < 62; i++, j++) { - lookup[i] = (char) ('0' + j); - } - - lookup[62] = '+'; - lookup[63] = '/'; - - // Populate the reverse lookup array - - for (int i = 0; i < 256; i++) { - reverseLookup[i] = -1; - } - - for (int i = 'Z'; i >= 'A'; i--) { - reverseLookup[i] = (byte) (i - 'A'); - } - - for (int i = 'z'; i >= 'a'; i--) { - reverseLookup[i] = (byte) (i - 'a' + 26); - } - - for (int i = '9'; i >= '0'; i--) { - reverseLookup[i] = (byte) (i - '0' + 52); - } - - reverseLookup['+'] = 62; - reverseLookup['/'] = 63; - reverseLookup['='] = 0; - } - - /** - * This class is not instantiable. - */ - private Base64() { - } - - /** - * Encodes the specified data into a base64 string. - * - * @param bytes The unencoded raw data. - */ - public static String encode(byte[] bytes) { - // always sequence of 4 characters for each 3 bytes; padded with '='s as necessary: - StringBuilder buf = new StringBuilder(((bytes.length + 2) / 3) * 4); - - // first, handle complete chunks (fast loop) - int i = 0; - for (int end = bytes.length - 2; i < end; ) { - int chunk = ((bytes[i++] & 0xFF) << 16) - | ((bytes[i++] & 0xFF) << 8) - | (bytes[i++] & 0xFF); - buf.append(lookup[chunk >> 18]); - buf.append(lookup[(chunk >> 12) & 0x3F]); - buf.append(lookup[(chunk >> 6) & 0x3F]); - buf.append(lookup[chunk & 0x3F]); - } - - // then leftovers, if any - int len = bytes.length; - if (i < len) { // 1 or 2 extra bytes? - int chunk = ((bytes[i++] & 0xFF) << 16); - buf.append(lookup[chunk >> 18]); - if (i < len) { // 2 bytes - chunk |= ((bytes[i] & 0xFF) << 8); - buf.append(lookup[(chunk >> 12) & 0x3F]); - buf.append(lookup[(chunk >> 6) & 0x3F]); - } else { // 1 byte - buf.append(lookup[(chunk >> 12) & 0x3F]); - buf.append('='); - } - buf.append('='); - } - return buf.toString(); - } - - /** - * Decodes the specified base64 string back into its raw data. - * - * @param encoded The base64 encoded string. - */ - public static byte[] decode(String encoded) { - int padding = 0; - - for (int i = encoded.length() - 1; encoded.charAt(i) == '='; i--) { - padding++; - } - - int length = encoded.length() * 6 / 8 - padding; - byte[] bytes = new byte[length]; - - for (int i = 0, index = 0, n = encoded.length(); i < n; i += 4) { - int word = reverseLookup[encoded.charAt(i)] << 18; - word += reverseLookup[encoded.charAt(i + 1)] << 12; - word += reverseLookup[encoded.charAt(i + 2)] << 6; - word += reverseLookup[encoded.charAt(i + 3)]; - - for (int j = 0; j < 3 && index + j < length; j++) { - bytes[index + j] = (byte) (word >> (8 * (2 - j))); - } - - index += 3; - } - - return bytes; - } -} diff --git a/src/main/java/com/ning/http/util/CleanupChannelGroup.java b/src/main/java/com/ning/http/util/CleanupChannelGroup.java deleted file mode 100644 index d0ea020cb0..0000000000 --- a/src/main/java/com/ning/http/util/CleanupChannelGroup.java +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -/* - * Copyright 2010 Bruno de Carvalho - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.ning.http.util; - -import org.jboss.netty.channel.Channel; -import org.jboss.netty.channel.ChannelFuture; -import org.jboss.netty.channel.group.ChannelGroup; -import org.jboss.netty.channel.group.ChannelGroupFuture; -import org.jboss.netty.channel.group.DefaultChannelGroup; -import org.jboss.netty.channel.group.DefaultChannelGroupFuture; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.ArrayList; -import java.util.Collection; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.locks.ReentrantReadWriteLock; - -/** - * Extension of {@link DefaultChannelGroup} that's used mainly as a cleanup container, where {@link #close()} is only - * supposed to be called once. - * - * @author Bruno de Carvalho - */ -public class CleanupChannelGroup extends DefaultChannelGroup { - - private final static Logger logger = LoggerFactory.getLogger(CleanupChannelGroup.class); - - // internal vars -------------------------------------------------------------------------------------------------- - - private final AtomicBoolean closed; - private final ReentrantReadWriteLock lock; - - // constructors --------------------------------------------------------------------------------------------------- - - public CleanupChannelGroup() { - this.closed = new AtomicBoolean(false); - this.lock = new ReentrantReadWriteLock(); - } - - public CleanupChannelGroup(String name) { - super(name); - this.closed = new AtomicBoolean(false); - this.lock = new ReentrantReadWriteLock(); - } - - // DefaultChannelGroup -------------------------------------------------------------------------------------------- - - @Override - public ChannelGroupFuture close() { - this.lock.writeLock().lock(); - try { - if (!this.closed.getAndSet(true)) { - // First time close() is called. - return super.close(); - } else { - Collection futures = new ArrayList(); - logger.debug("CleanupChannelGroup Already closed"); - return new DefaultChannelGroupFuture(ChannelGroup.class.cast(this), futures); - } - } finally { - this.lock.writeLock().unlock(); - } - } - - @Override - public boolean add(Channel channel) { - // Synchronization must occur to avoid add() and close() overlap (thus potentially leaving one channel open). - // This could also be done by synchronizing the method itself but using a read lock here (rather than a - // synchronized() block) allows multiple concurrent calls to add(). - this.lock.readLock().lock(); - try { - if (this.closed.get()) { - // Immediately close channel, as close() was already called. - channel.close(); - return false; - } - - return super.add(channel); - } finally { - this.lock.readLock().unlock(); - } - } -} diff --git a/src/main/java/com/ning/http/util/DateUtil.java b/src/main/java/com/ning/http/util/DateUtil.java deleted file mode 100644 index 54def8d8c1..0000000000 --- a/src/main/java/com/ning/http/util/DateUtil.java +++ /dev/null @@ -1,234 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -/* - * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/util/DateUtil.java,v 1.2 2004/12/24 20:36:13 olegk Exp $ - * $Revision: 480424 $ - * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $ - * - * ==================================================================== - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ==================================================================== - * - * This software consists of voluntary contributions made by many - * individuals on behalf of the Apache Software Foundation. For more - * information on the Apache Software Foundation, please see - * . - * - */ - -import java.text.ParseException; -import java.text.SimpleDateFormat; -import java.util.Arrays; -import java.util.Calendar; -import java.util.Collection; -import java.util.Date; -import java.util.Iterator; -import java.util.Locale; -import java.util.TimeZone; - -/** - * A utility class for parsing and formatting HTTP dates as used in cookies and - * other headers. This class handles dates as defined by RFC 2616 section - * 3.3.1 as well as some other common non-standard formats. - * - * @author Christopher Brown - * @author Michael Becke - */ -public class DateUtil { - - /** - * Date format pattern used to parse HTTP date headers in RFC 1123 format. - */ - public static final String PATTERN_RFC1123 = "EEE, dd MMM yyyy HH:mm:ss zzz"; - - /** - * Date format pattern used to parse HTTP date headers in RFC 1036 format. - */ - public static final String PATTERN_RFC1036 = "EEEE, dd-MMM-yy HH:mm:ss zzz"; - - /** - * Date format pattern used to parse HTTP date headers in ANSI C - * asctime() format. - */ - public static final String PATTERN_ASCTIME = "EEE MMM d HH:mm:ss yyyy"; - - private static final Collection DEFAULT_PATTERNS = Arrays.asList( - new String[]{PATTERN_ASCTIME, PATTERN_RFC1036, PATTERN_RFC1123}); - - private static final Date DEFAULT_TWO_DIGIT_YEAR_START; - - static { - Calendar calendar = Calendar.getInstance(); - calendar.set(2000, Calendar.JANUARY, 1, 0, 0); - DEFAULT_TWO_DIGIT_YEAR_START = calendar.getTime(); - } - - private static final TimeZone GMT = TimeZone.getTimeZone("GMT"); - - /** - * Parses a date value. The formats used for parsing the date value are retrieved from - * the default http params. - * - * @param dateValue the date value to parse - * @return the parsed date - * @throws DateParseException if the value could not be parsed using any of the - * supported date formats - */ - public static Date parseDate(String dateValue) throws DateParseException { - return parseDate(dateValue, null, null); - } - - /** - * Parses the date value using the given date formats. - * - * @param dateValue the date value to parse - * @param dateFormats the date formats to use - * @return the parsed date - * @throws DateParseException if none of the dataFormats could parse the dateValue - */ - public static Date parseDate(String dateValue, Collection dateFormats) - throws DateParseException { - return parseDate(dateValue, dateFormats, null); - } - - /** - * Parses the date value using the given date formats. - * - * @param dateValue the date value to parse - * @param dateFormats the date formats to use - * @param startDate During parsing, two digit years will be placed in the range - * startDate to startDate + 100 years. This value may - * be null. When null is given as a parameter, year - * 2000 will be used. - * @return the parsed date - * @throws DateParseException if none of the dataFormats could parse the dateValue - */ - public static Date parseDate( - String dateValue, - Collection dateFormats, - Date startDate - ) throws DateParseException { - - if (dateValue == null) { - throw new IllegalArgumentException("dateValue is null"); - } - if (dateFormats == null) { - dateFormats = DEFAULT_PATTERNS; - } - if (startDate == null) { - startDate = DEFAULT_TWO_DIGIT_YEAR_START; - } - // trim single quotes around date if present - // see issue #5279 - if (dateValue.length() > 1 - && dateValue.startsWith("'") - && dateValue.endsWith("'") - ) { - dateValue = dateValue.substring(1, dateValue.length() - 1); - } - - SimpleDateFormat dateParser = null; - Iterator formatIter = dateFormats.iterator(); - - while (formatIter.hasNext()) { - String format = (String) formatIter.next(); - if (dateParser == null) { - dateParser = new SimpleDateFormat(format, Locale.US); - dateParser.setTimeZone(TimeZone.getTimeZone("GMT")); - dateParser.set2DigitYearStart(startDate); - } else { - dateParser.applyPattern(format); - } - try { - return dateParser.parse(dateValue); - } catch (ParseException pe) { - // ignore this exception, we will try the next format - } - } - - // we were unable to parse the date - throw new DateParseException("Unable to parse the date " + dateValue); - } - - /** - * Formats the given date according to the RFC 1123 pattern. - * - * @param date The date to format. - * @return An RFC 1123 formatted date string. - * @see #PATTERN_RFC1123 - */ - public static String formatDate(Date date) { - return formatDate(date, PATTERN_RFC1123); - } - - /** - * Formats the given date according to the specified pattern. The pattern - * must conform to that used by the {@link java.text.SimpleDateFormat simple date - * format} class. - * - * @param date The date to format. - * @param pattern The pattern to use for formatting the date. - * @return A formatted date string. - * @throws IllegalArgumentException If the given date pattern is invalid. - * @see java.text.SimpleDateFormat - */ - public static String formatDate(Date date, String pattern) { - if (date == null) throw new IllegalArgumentException("date is null"); - if (pattern == null) throw new IllegalArgumentException("pattern is null"); - - SimpleDateFormat formatter = new SimpleDateFormat(pattern, Locale.US); - formatter.setTimeZone(GMT); - return formatter.format(date); - } - - /** - * This class should not be instantiated. - */ - private DateUtil() { - } - - public static class DateParseException extends Exception { - - /** - * - */ - public DateParseException() { - super(); - } - - /** - * @param message the exception message - */ - public DateParseException(String message) { - super(message); - } - - } - -} diff --git a/src/main/java/com/ning/http/util/ProxyUtils.java b/src/main/java/com/ning/http/util/ProxyUtils.java deleted file mode 100644 index a3bd9f58e4..0000000000 --- a/src/main/java/com/ning/http/util/ProxyUtils.java +++ /dev/null @@ -1,149 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -import com.ning.http.client.ProxyServer; -import com.ning.http.client.ProxyServer.Protocol; -import com.ning.http.client.Request; - -import java.net.URI; -import java.util.List; -import java.util.Properties; - -/** - * Utilities for Proxy handling. - * - * @author cstamas - */ -public class ProxyUtils { - - private static final String PROPERTY_PREFIX = "com.ning.http.client.AsyncHttpClientConfig.proxy."; - - /** - * The host to use as proxy. - */ - public static final String PROXY_HOST = "http.proxyHost"; - - /** - * The port to use for the proxy. - */ - public static final String PROXY_PORT = "http.proxyPort"; - - /** - * The protocol to use. Is mapped to the {@link Protocol} enum. - */ - public static final String PROXY_PROTOCOL = PROPERTY_PREFIX + "protocol"; - - /** - * A specification of non-proxy hosts. See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html - */ - public static final String PROXY_NONPROXYHOSTS = "http.nonProxyHosts"; - - /** - * The username to use for authentication for the proxy server. - */ - public static final String PROXY_USER = PROPERTY_PREFIX + "user"; - - /** - * The password to use for authentication for the proxy server. - */ - public static final String PROXY_PASSWORD = PROPERTY_PREFIX + "password"; - - /** - * Checks whether proxy should be used according to nonProxyHosts settings of it, or we want to go directly to - * target host. If null proxy is passed in, this method returns true -- since there is NO proxy, we - * should avoid to use it. Simple hostname pattern matching using "*" are supported, but only as prefixes. - * See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html - * - * @param proxyServer - * @param request - * @return true if we have to avoid proxy use (obeying non-proxy hosts settings), false otherwise. - */ - public static boolean avoidProxy(final ProxyServer proxyServer, final Request request) { - return avoidProxy(proxyServer, AsyncHttpProviderUtils.getHost(URI.create(request.getUrl()))); - } - - /** - * Checks whether proxy should be used according to nonProxyHosts settings of it, or we want to go directly to - * target host. If null proxy is passed in, this method returns true -- since there is NO proxy, we - * should avoid to use it. Simple hostname pattern matching using "*" are supported, but only as prefixes. - * See http://download.oracle.com/javase/1.4.2/docs/guide/net/properties.html - * - * @param proxyServer - * @param target the hostname - * @return true if we have to avoid proxy use (obeying non-proxy hosts settings), false otherwise. - */ - public static boolean avoidProxy(final ProxyServer proxyServer, final String target) { - if (proxyServer != null) { - final String targetHost = target.toLowerCase(); - - List nonProxyHosts = proxyServer.getNonProxyHosts(); - - if (nonProxyHosts != null && nonProxyHosts.size() > 0) { - for (String nonProxyHost : nonProxyHosts) { - if (nonProxyHost.startsWith("*") && nonProxyHost.length() > 1 - && targetHost.endsWith(nonProxyHost.substring(1).toLowerCase())) { - return true; - } else if (nonProxyHost.equalsIgnoreCase(targetHost)) { - return true; - } - } - } - - return false; - } else { - return true; - } - } - - /** - * Creates a proxy server instance from the given properties. - *

- * Currently the default http.* proxy properties are supported as well as properties specific for AHC. - * - * @param properties the properties to evaluate. Must not be null. - * @return a ProxyServer instance or null, if no valid properties were set. - * @see Networking Properties - * @see #PROXY_HOST - * @see #PROXY_PORT - * @see #PROXY_PROTOCOL - * @see #PROXY_NONPROXYHOSTS - */ - public static ProxyServer createProxy(Properties properties) { - String host = System.getProperty(PROXY_HOST); - - if (host != null) { - int port = Integer.valueOf(System.getProperty(PROXY_PORT, "80")); - - Protocol protocol; - try { - protocol = Protocol.valueOf(System.getProperty(PROXY_PROTOCOL, "HTTP")); - } catch (IllegalArgumentException e) { - protocol = Protocol.HTTP; - } - - ProxyServer proxyServer = new ProxyServer(protocol, host, port, System.getProperty(PROXY_USER), System.getProperty(PROXY_PASSWORD)); - - String nonProxyHosts = System.getProperties().getProperty(PROXY_NONPROXYHOSTS); - if (nonProxyHosts != null) { - for (String spec : nonProxyHosts.split("\\|")) { - proxyServer.addNonProxyHost(spec); - } - } - - return proxyServer; - } - - return null; - } -} diff --git a/src/main/java/com/ning/http/util/SslUtils.java b/src/main/java/com/ning/http/util/SslUtils.java deleted file mode 100644 index 2a54b44de6..0000000000 --- a/src/main/java/com/ning/http/util/SslUtils.java +++ /dev/null @@ -1,168 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.util; - -import javax.net.ssl.KeyManager; -import javax.net.ssl.KeyManagerFactory; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLEngine; -import javax.net.ssl.TrustManager; -import javax.net.ssl.TrustManagerFactory; -import javax.net.ssl.X509TrustManager; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.security.GeneralSecurityException; -import java.security.KeyStore; -import java.security.SecureRandom; -import java.security.Security; - -/** - * This class is a copy of http://github.com/sonatype/wagon-ning/raw/master/src/main/java/org/apache/maven/wagon/providers/http/SslUtils.java - */ -public class SslUtils { - - public static SSLEngine getSSLEngine() - throws GeneralSecurityException, IOException { - SSLEngine engine = null; - - SSLContext context = getSSLContext(); - if (context != null) { - engine = context.createSSLEngine(); - engine.setUseClientMode(true); - } - - return engine; - } - - public static SSLContext getSSLContext() - throws GeneralSecurityException, IOException { - SSLConfig config = new SSLConfig(); - if (config.keyStoreLocation == null || config.trustStoreLocation == null) { - return getLooseSSLContext(); - } else { - return getStrictSSLContext(config); - } - } - - static SSLContext getStrictSSLContext(SSLConfig config) - throws GeneralSecurityException, IOException { - KeyStore keyStore = KeyStore.getInstance(config.keyStoreType); - InputStream keystoreInputStream = new FileInputStream(config.keyStoreLocation); - try { - keyStore.load(keystoreInputStream, (config.keyStorePassword == null) ? null - : config.keyStorePassword.toCharArray()); - } finally { - keystoreInputStream.close(); - } - - KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(config.keyManagerAlgorithm); - keyManagerFactory.init(keyStore, (config.keyManagerPassword == null) ? null - : config.keyManagerPassword.toCharArray()); - KeyManager[] keyManagers = keyManagerFactory.getKeyManagers(); - - KeyStore trustStore = KeyStore.getInstance(config.trustStoreType); - InputStream truststoreInputStream = new FileInputStream(config.trustStoreLocation); - try { - trustStore.load(truststoreInputStream, (config.trustStorePassword == null) ? null - : config.trustStorePassword.toCharArray()); - } finally { - truststoreInputStream.close(); - } - - TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(config.trustManagerAlgorithm); - trustManagerFactory.init(trustStore); - TrustManager[] trustManagers = trustManagerFactory.getTrustManagers(); - - SSLContext context = SSLContext.getInstance("TLS"); - context.init(keyManagers, trustManagers, null); - - return context; - } - - static SSLContext getLooseSSLContext() - throws GeneralSecurityException { - SSLContext sslContext = SSLContext.getInstance("TLS"); - sslContext.init(null, new TrustManager[]{LooseTrustManager.INSTANCE}, new SecureRandom()); - return sslContext; - } - - static class LooseTrustManager - implements X509TrustManager { - - public static final LooseTrustManager INSTANCE = new LooseTrustManager(); - - public java.security.cert.X509Certificate[] getAcceptedIssuers() { - return null; - } - - public void checkClientTrusted(java.security.cert.X509Certificate[] certs, String authType) { - } - - public void checkServerTrusted(java.security.cert.X509Certificate[] certs, String authType) { - } - } - - private final static class SSLConfig { - - public String keyStoreLocation; - - public String keyStoreType = "JKS"; - - public String keyStorePassword = "changeit"; - - public String keyManagerAlgorithm = "SunX509"; - - public String keyManagerPassword = "changeit"; - - public String trustStoreLocation; - - public String trustStoreType = "JKS"; - - public String trustStorePassword = "changeit"; - - public String trustManagerAlgorithm = "SunX509"; - - public SSLConfig() { - keyStoreLocation = System.getProperty("javax.net.ssl.keyStore"); - keyStorePassword = System.getProperty("javax.net.ssl.keyStorePassword", "changeit"); - keyStoreType = System.getProperty("javax.net.ssl.keyStoreType", KeyStore.getDefaultType()); - keyManagerAlgorithm = Security.getProperty("ssl.KeyManagerFactory.algorithm"); - - if (keyManagerAlgorithm == null) { - keyManagerAlgorithm = "SunX509"; - } - - keyManagerPassword = System.getProperty("javax.net.ssl.keyStorePassword", "changeit"); - - trustStoreLocation = System.getProperty("javax.net.ssl.trustStore"); - if (trustStoreLocation == null) { - trustStoreLocation = keyStoreLocation; - trustStorePassword = keyStorePassword; - trustStoreType = keyStoreType; - } else { - trustStorePassword = System.getProperty("javax.net.ssl.trustStorePassword", "changeit"); - trustStoreType = System.getProperty("javax.net.ssl.trustStoreType", KeyStore.getDefaultType()); - } - trustManagerAlgorithm = Security.getProperty("ssl.TrustManagerFactory.algorithm"); - - if (trustManagerAlgorithm == null) { - trustManagerAlgorithm = "SunX509"; - } - } - } - -} diff --git a/src/main/java/com/ning/http/util/UTF8Codec.java b/src/main/java/com/ning/http/util/UTF8Codec.java deleted file mode 100644 index 29ee4cc20c..0000000000 --- a/src/main/java/com/ning/http/util/UTF8Codec.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.util; - -import java.io.UnsupportedEncodingException; - -/** - * Wrapper class for more convenient (and possibly more efficient in future) - * UTF-8 encoding and decoding. - */ -public class UTF8Codec { - private final static String ENCODING_UTF8 = "UTF-8"; - - // When we move to JDK 1.6+, we can do this: - /* - import java.nio.charset.Charset; - - private final static Charset utf8; - static { - utf8 = Charset.forName("UTF-8"); - } - - public static byte[] toUTF8(String input) { - return input.getBytes(utf8); - } - - public static String fromUTF8(byte[] input) { - return fromUTF8(input, 0, input.length); - } - - public static String fromUTF8(byte[] input, int offset, int len) { - return new String(input, offset, len, utf8); - } - */ - - // But until then (with 1.5) - public static byte[] toUTF8(String input) { - try { - return input.getBytes(ENCODING_UTF8); - } catch (UnsupportedEncodingException e) { // never happens, but since it's declared... - throw new IllegalStateException(); - } - } - - public static String fromUTF8(byte[] input) { - return fromUTF8(input, 0, input.length); - } - - public static String fromUTF8(byte[] input, int offset, int len) { - try { - return new String(input, offset, len, ENCODING_UTF8); - } catch (UnsupportedEncodingException e) { // never happens - throw new IllegalStateException(); - } - } -} diff --git a/src/main/java/com/ning/http/util/UTF8UrlEncoder.java b/src/main/java/com/ning/http/util/UTF8UrlEncoder.java deleted file mode 100644 index a7d463f4fc..0000000000 --- a/src/main/java/com/ning/http/util/UTF8UrlEncoder.java +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.util; - -/** - * Convenience class that encapsulates details of "percent encoding" - * (as per RFC-3986, see [http://www.ietf.org/rfc/rfc3986.txt]). - */ -public class UTF8UrlEncoder { - private static final boolean encodeSpaceUsingPlus = System.getProperty("com.com.ning.http.util.UTF8UrlEncoder.encodeSpaceUsingPlus") == null ? false : true; - - /** - * Encoding table used for figuring out ascii characters that must be escaped - * (all non-Ascii characers need to be encoded anyway) - */ - private final static int[] SAFE_ASCII = new int[128]; - - static { - for (int i = 'a'; i <= 'z'; ++i) { - SAFE_ASCII[i] = 1; - } - for (int i = 'A'; i <= 'Z'; ++i) { - SAFE_ASCII[i] = 1; - } - for (int i = '0'; i <= '9'; ++i) { - SAFE_ASCII[i] = 1; - } - SAFE_ASCII['-'] = 1; - SAFE_ASCII['.'] = 1; - SAFE_ASCII['_'] = 1; - SAFE_ASCII['~'] = 1; - } - - private final static char[] HEX = "0123456789ABCDEF".toCharArray(); - - private UTF8UrlEncoder() { - } - - public static String encode(String input) { - StringBuilder sb = new StringBuilder(input.length() + 16); - appendEncoded(sb, input); - return sb.toString(); - } - - public static StringBuilder appendEncoded(StringBuilder sb, String input) { - final int[] safe = SAFE_ASCII; - - for (int i = 0, len = input.length(); i < len; ++i) { - char c = input.charAt(i); - if (c <= 127) { - if (safe[c] != 0) { - sb.append(c); - } else { - appendSingleByteEncoded(sb, c); - } - } else { - appendMultiByteEncoded(sb, c); - } - } - return sb; - } - - private final static void appendSingleByteEncoded(StringBuilder sb, int value) { - - if (encodeSpaceUsingPlus && value == 32) { - sb.append('+'); - return; - } - - sb.append('%'); - sb.append(HEX[value >> 4]); - sb.append(HEX[value & 0xF]); - } - - private final static void appendMultiByteEncoded(StringBuilder sb, int value) { - // two or three bytes? (ignoring surrogate pairs for now, which would yield 4 bytes) - if (value < 0x800) { - appendSingleByteEncoded(sb, (0xc0 | (value >> 6))); - appendSingleByteEncoded(sb, (0x80 | (value & 0x3f))); - } else { - appendSingleByteEncoded(sb, (0xe0 | (value >> 12))); - appendSingleByteEncoded(sb, (0x80 | ((value >> 6) & 0x3f))); - appendSingleByteEncoded(sb, (0x80 | (value & 0x3f))); - } - } - -} diff --git a/src/site/apt/auth.apt b/src/site/apt/auth.apt deleted file mode 100644 index 567830b3a6..0000000000 --- a/src/site/apt/auth.apt +++ /dev/null @@ -1,39 +0,0 @@ - ------ - Async Http Client - Configuring Authentication: BASIC, DIGEST or NTLM - ------ - Jeanfrancois Arcand - ------ - 2012 - -Configuring Authentication: BASIC, DIGEST or NTLM - - Configuring authentication with AsyncHttpClient is simple. You can configure it at the <<>> level using the - <<>>: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -Realm realm = new Realm.RealmBuilder() - .setPrincipal(user) - .setPassword(admin) - .setUsePreemptiveAuth(true) - .setScheme(AuthScheme.BASIC) - .build(); -client.prepareGet("http://.../").setRealm(realm).execute(); -+-----+ - - You can also set the realm at the AsyncHttpClientConfig level: - -+-----+ -Builder builder = new AsyncHttpClientConfig.Builder(); -Realm realm = new Realm.RealmBuilder() - .setPrincipal(user) - .setPassword(admin) - .setUsePreemptiveAuth(true) - .setScheme(AuthScheme.BASIC) - .build(); -builder.setRealm(realm).build(); -AsyncHttpClient client = new AsyncHttpClient(builder.build()); -+-----+ - - The authentication type supported are <<>>, <<>> and <<>>. You can also customize your own - authentication mechanism by using the Response Filter. diff --git a/src/site/apt/configuring.apt b/src/site/apt/configuring.apt deleted file mode 100644 index 6eecccc888..0000000000 --- a/src/site/apt/configuring.apt +++ /dev/null @@ -1,50 +0,0 @@ - ------ - Async Http Client - Configuring the AsyncHttpClient - ------ - Jeanfrancois Arcand - ------ - 2012 - -Configuring the AsyncHttpClient. - - You can configure the <<>> class using the <<>>'s Builder: - -+-----+ -Builder builder = new AsyncHttpClientConfig.Builder(); -builder.setCompressionEnabled(true) - .setAllowPoolingConnection(true) - .setRequestTimesout(30000) - .build(); - -AsyncHttpClient client = new AsyncHttpClient(builder.build()); -+-----+ - - You can set the ExecutorServices as well if you don't want to use the default, which is a cached threads pool: - -+-----+ -Builder builder = new AsyncHttpClientConfig.Builder(); -builder.setExecutorService(myOwnThreadPool); -AsyncHttpClient client = new AsyncHttpClient(builder.build()); -+-----+ - - You can also configure the connection pool the library is using and implement your own polling strategy: - -+-----+ -Builder builder = new AsyncHttpClientConfig.Builder(); -builder.setConnectionsPool(new ConnectionsPoo() { - public boolean offer(U uri, V connection) {...} - - public V poll(U uri) {...} - - public boolean removeAll(V connection) {...} - - public boolean canCacheConnection() {...} - - public void destroy() {...} -}); -AsyncHttpClient client = new AsyncHttpClient(builder.build()); -+-----+ - - It is recommended to use the default connections pool for performance reason, but you are always free to design a better one. - - You can also set the SSL information, Filters, etc. Those topics will be covered inside their own section. diff --git a/src/site/apt/filters.apt b/src/site/apt/filters.apt deleted file mode 100644 index 797b071e1b..0000000000 --- a/src/site/apt/filters.apt +++ /dev/null @@ -1,151 +0,0 @@ - ------ - Async Http Client - Using Filters - ------ - Jeanfrancois Arcand - ------ - 2012 - -Using Filters - - The library supports three types of <<>> who can intercept, transform, decorate and replay transactions: - <<>>, <<>> and <<>>. - -* Request Filter - - Request Filters are useful if you need to manipulate the Request or AsyncHandler object before the request is made. As an example, you can throttle requests using the following RequestFilter implementation: - -+-----+ -public class ThrottleRequestFilter implements RequestFilter { - private final int maxConnections; - private final Semaphore available; - private final int maxWait; - - public ThrottleRequestFilter(int maxConnections) { - this.maxConnections = maxConnections; - this.maxWait = Integer.MAX_VALUE; - available = new Semaphore(maxConnections, true); - } - - public ThrottleRequestFilter(int maxConnections, int maxWait) { - this.maxConnections = maxConnections; - this.maxWait = maxWait; - available = new Semaphore(maxConnections, true); - } - - public FilterContext filter(FilterContext ctx) throws FilterException { - try { - if (!available.tryAcquire(maxWait, TimeUnit.MILLISECONDS)) - throw new FilterException(String.format("No slot available for Request %s with AsyncHandler %s", - ctx.getRequest(), - ctx.getAsyncHandler())); - } - } catch (InterruptedException e) { - throw new FilterException( String.format("Interrupted Request %s with AsyncHandler %s", - ctx.getRequest(), - ctx.getAsyncHandler())); - } - - return new FilterContext(new AsyncHandlerWrapper(ctx.getAsyncHandler()), ctx.getRequest()); - } - -} - -private class AsyncHandlerWrapper implements AsyncHandler { - private final AsyncHandler asyncHandler; - - public AsyncHandlerWrapper(AsyncHandler asyncHandler) { - this.asyncHandler = asyncHandler; - } - - public void onThrowable(Throwable t) { - asyncHandler.onThrowable(t); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - return asyncHandler.onBodyPartReceived(bodyPart); - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - return asyncHandler.onStatusReceived(responseStatus); - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return asyncHandler.onHeadersReceived(headers); } - - public T onCompleted() throws Exception { - available.release(); - return asyncHandler.onCompleted(); - } -} -+-----+ - - In the above, we decorate the original <<>> and use semaphore to throttle requests. - To add <<>>, all you need to do is to configure it on the <<>>: - -+-----+ -AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); -b.addRequestFilter(new ThrottleRequestFilter(100)); -AsyncHttpClient c = new AsyncHttpClient(b.build()); -+-----+ - - * Response Filter - - Like with <<>>, you can also filter the <<>>'s bytes before an <<>> gets called. - <<>> are always invoked before the library executes the logic for authentication, proxy challenging, - redirection etc. That means an application can takes control of those operations at any moment using a <<>>. - - As an example, the following <<>> redirect request from <<>> to <<>> in case - <<<.ca>>> is not responding: - -+-----+ -AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); -b.addResponseFilter(new ResponseFilter() { - public FilterContext filter(FilterContext ctx) throws FilterException { - if (ctx.getResponseStatus().getStatusCode() == 503) { - return new FilterContext.FilterContextBuilder(ctx) - .request(new RequestBuilder("GET") - .setUrl("http://google.com/").build()) - .build(); - } - } -}); -AsyncHttpClient c = new AsyncHttpClient(b.build()); -+-----+ - -* IOException Filter - - The AsyncHttpClient library support <<>> that can be used to replay a request in case server a - server goes down or unresponsive, a network outage occurs, or nay kind of I/O abnormal situation. - - In those cases, the library will catch the <<>> and delegate the <<>> handling to the <<>>. - - As an example, the following filter will resume an interrupted download instead of restarting downloading the file - from the beginning: - -+-----+ -AsyncHttpClient c = new AsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .addIOExceptionFilter(new ResumableIOExceptionFilter()).build()); - -Response r = c.prepareGet("http://host:port/LargeFile.avi").execute(new AsyncHandler(){...}).get(); -+-----+ - - The <<>> is defined as - -+-----+ -public class ResumableIOExceptionFilter implements IOExceptionFilter { - public FilterContext filter(FilterContext ctx) throws FilterException { - if (ctx.getIOException() != null ) { - Request request = new RequestBuilder(ctx.getRequest()).setRangeOffset(file.length()); - return new FilterContext.FilterContextBuilder(ctx) - .request(request) - .replayRequest(true) - .build(); - } - return ctx; - } -} -+-----+ - -In the above we just catch any <<>> and replay the request using the <<>> header to tell the remote -server to restart sending bytes at that position. This way we don't need to re download the entire file. diff --git a/src/site/apt/oauth.apt b/src/site/apt/oauth.apt deleted file mode 100644 index fb8e9bab22..0000000000 --- a/src/site/apt/oauth.apt +++ /dev/null @@ -1,26 +0,0 @@ - ------ - Async Http Client - Using OAuth - ------ - Jeanfrancois Arcand - ------ - 2012 - -Using OAuth - - You can use the library to pull data from any OAuth site (like Twitter). This is as simple as: - -+-----+ -private static final String CONSUMER_KEY = "dpf43f3p2l4k3l03"; -private static final String CONSUMER_SECRET = "kd94hf93k423k f44"; -public static final String TOKEN_KEY = "nnch734d00sl2jdk"; -public static final String TOKEN_SECRET = "pfkkdhi9sl3r4s00"; -public static final String NONCE = "kllo9940pd9333jh"; -final static long TIMESTAMP = 1191242096; - -public void oAuth() { -ConsumerKey consumer = new ConsumerKey(CONSUMER_KEY, CONSUMER_SECRET); -RequestToken user = new RequestToken(TOKEN_KEY, TOKEN_SECRET); -OAuthSignatureCalculator calc = new OAuthSignatureCalculator(consumer, user); -AsyncHttpClient client = new AsyncHttpClient(); -Response response = client.prepareGet("http://.../").setSignatureCalculator(calc).execute().get(); -+-----+ diff --git a/src/site/apt/performances.apt b/src/site/apt/performances.apt deleted file mode 100644 index 6d26b77af0..0000000000 --- a/src/site/apt/performances.apt +++ /dev/null @@ -1,22 +0,0 @@ - ------ - Async Http Client - Limiting the number of connections to improve raw performance - ------ - Jeanfrancois Arcand - ------ - 2012 - -Limiting the number of connections to improve raw performance - - By default the library uses a connection pool and re-use connections as needed. It is important to not let the - connection pool grow too large as it takes resources in memory. One way consist of setting the maximum number of - connection per host or in total: - -+-----+ -AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder() - .setMaximumConnectionsPerHost(10) - .setMaximumConnectionsTotal(100) - .build(); -AsyncHttpClient c = new AsyncHttpClient(config); -+-----+ - - There is no magic number, so you will need to try it and decide which one gives the best result. diff --git a/src/site/apt/providers.apt b/src/site/apt/providers.apt deleted file mode 100644 index 1ececa1037..0000000000 --- a/src/site/apt/providers.apt +++ /dev/null @@ -1,38 +0,0 @@ - ------ - Async Http Client - Switching Provider - ------ - Jeanfrancois Arcand - ------ - 2012 - -Switching Provider - - By default, the <<>> is using the powerful {{{http://netty.io/}Netty}}'s framework as the - HTTP processor. There might be environment where you can't use Netty. Fortunately, the <<>> library - supports two other http runtime: the <<>>, which build around the <<>>, and - <<>> which build on top of the - {{{http://hc.apache.org/httpcomponents-client-ga/index.html}Apache HttpClient}}. - - To change provider, all you need to do is: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(new ApacheAsyncHttpProvider(new AsyncHttpClientConfig.Builder().build())); -+-----+ - - Same for the JDK: - -+-----+ -AsyncHttpclient client = new AsyncHttpClient(new JDKAsyncHttpProvider(new AsyncHttpClientConfig.Builder().build())); -+-----+ - - Also every <<>> can be configured with their native functionality. - - As an example, you can switch the <<>> to use blocking I/O instead of NIO: - -+-----+ -NettyAsyncHttpProviderConfig config = new NettyAsyncHttpProviderConfig(); -config.setProperty(NettyAsyncHttpProviderConfig.USE_BLOCKING_IO, "true"); - -AsyncHttpClientConfig c = new AsyncHttpClientConfig().setAsyncHttpClientProviderConfig(config).build(); -AsyncHttpClient client = new AsyncHttpClient(new NettyAsyncHttpProvider(config)); -+-----+ diff --git a/src/site/apt/proxy.apt b/src/site/apt/proxy.apt deleted file mode 100644 index d62a0ebb48..0000000000 --- a/src/site/apt/proxy.apt +++ /dev/null @@ -1,63 +0,0 @@ - ------ - Async Http Client - Configuring a Proxy - ------ - Jeanfrancois Arcand - ------ - 2012 - -Configuring a Proxy - - The AsyncHttpClient library supports proxy, proxy authentication and proxy tunneling. - Just need to create a <<>> instance: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -Future f = client.prepareGet("http://....) - .setProxyServer(new ProxyServer("127.0.0.1", 8080)) - .execute(); -+-----+ - - If you need to use an SSL tunnel, all you need to do is: - -+-----+ -ProxyServer ps = new ProxyServer(ProxyServer.Protocol.HTTPS, "127.0.0.1", 8080); -AsyncHttpClient asyncHttpClient = new AsyncHttpClient(); -RequestBuilder rb = new RequestBuilder("GET") - .setProxyServer(ps) - .setUrl("https://twitpic.com/"); -Future responseFuture = asyncHttpClient.executeRequest(rb.build(), new AsyncCompletionHandlerBase() { - @Override - public void onThrowable(Throwable t) {} - - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - -}); -Response r = responseFuture.get(); -+-----+ - - You can also set the authentication token on the <<>> instance: - -+-----+ -ProxyServer ps = new ProxyServer(ProxyServer.Protocol.HTTPS, "127.0.0.1", 8080, "admin", "password"); -AsyncHttpClient asyncHttpClient = new AsyncHttpClient(); -RequestBuilder rb = new RequestBuilder("GET") - .setProxyServer(ps) - .setUrl("https://twitpic.com/"); -Future responseFuture = asyncHttpClient.executeRequest(rb.build(), new AsyncCompletionHandlerBase() { - @Override - public void onThrowable(Throwable t) {} - - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - -}); -Response r = responseFuture.get(); -+-----+ - - You can also set the <<>> at the <<>> level. In that case, all request will share - the same proxy information. diff --git a/src/site/apt/request.apt b/src/site/apt/request.apt deleted file mode 100644 index 09e6e358d4..0000000000 --- a/src/site/apt/request.apt +++ /dev/null @@ -1,180 +0,0 @@ - ------ - Async Http Client - Executing request - ------ - Jeanfrancois Arcand - ------ - 2012 - -Executing request synchronously or asynchronously. - - The first thing to decide when using the library is if your application can handle asynchronous response or not. - If not, the library has been designed using the Future API, hence you can always execute synchronous call by blocking - on the <<>> method: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -Response response = client.prepareGet(("http://sonatype.com/").execute().get(); -+-----+ - - The above means the request will block until the full Response has been received. It also made your application's - blocking, waiting for the response to comes back. This could be potentially an issue to block for every request, - specially when doing <<>> or <<>> operations where you don't necessarily need to wait for the response. - A simple way consist of not calling the <<>> - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -Response response = client.preparePut(("http://sonatype.com/myFile.avi").execute(); -+-----+ - - A better way than above would consist of using an AsyncHandler. The AynchHandler API is fairly simple and just - consists of 5 methods to implements: - -+-----+ -public interface AsyncHandler { - void onThrowable(Throwable t); - - STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) - throws Exception; - - STATE onStatusReceived(HttpResponseStatus responseStatus) - throws Exception; - - STATE onHeadersReceived(HttpResponseHeaders headers) - throws Exception; - - T onCompleted() throws Exception; -} -+-----+ - -* Creating a Request object - - The AsynHttpClient uses the builder pattern when it is time to create Request object. The simplest way consist of: - -+-----+ -RequestBuilder builder = new RequestBuilder("PUT"); -Request request = builder..setUrl("http://") - .addHeader("name", "value") - .setBody(new File("myUpload.avi")) - .build(); -AsyncHttpClient client = new AsyncHttpClient(); -client.execute(request, new AsyncHandler<...>() { -..... -} ); -+-----+ - - If you need to work with File, the library supports the {{{./zero-bytes-copy.html}zero copy in memory concept}}, - e.g the File can be uploaded or downloaded without loading its associated bytes in memory, preventing out of memory - errors in case you need to upload or download many large files. Although the library support the following: - -+-----+ -Request request = builder.setUrl("http://") - .addHeader("name", "value") - .setBody(myInputStream)) - .build(); -+-----+ - - it is discouraged to use <<>> as the library will need to buffer bytes in memory in order to determine - the length of the stream, and instead highly recommended to either use a File or the <<>> API to avoid - loading unnecessary bytes in memory: - -+-----+ -public interface BodyGenerator { - Body createBody() throws IOException; -} -+-----+ - - where a Body is defined as: - -+-----+ -public interface Body { - long getContentLength(); - - long read(ByteBuffer buffer) - throws IOException; - - void close() throws IOException; -} -+-----+ - - This way the library will never read unnecessary bytes in memory, which could significantly improve the performance - your application. - - The <<>> can also be used to create per <<>> configuration, - like setting a Proxy or request timeout: - -+-----+ -PerRequestConfig requestConfig = new PerRequestConfig(); -requestConfig.setRequestTimeoutInMs(5 * 1000); -requestConfig.setProxy(new ProxyServer(...)); -Future responseFuture = client.prepareGet("http://").setPerRequestConfig(requestConfig).execute(); -+-----+ - -* Creating a Response object - - The AsyncHandler is typed, e.g you can return any object from the <<>>. One useful object - of the library is the <<>> object and it's associate builder. You can incrementally create a <<>> - object using the <<>> method: - -+-----+ -MyAsyncHandler asyncHandler = new MyAsyncHanfler() { - private final Response.ResponseBuilder builder = new Response.ResponseBuilder(); - - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - builder.accumulate(content); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - builder.accumulate(status); - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - builder.accumulate(headers); - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return builder.build(); - } - -} - -Response response = client.prepareGet("http://sonatype.com/").execute(asyncHandler).get(); -+-----+ - - One thing to consider when creating a <<>> object is the size of the response body. By default, - a <<>> object will accumulate all response's bytes in memory, and that could potentially create an out of - memory error. If you are planning to use the API for downloading large files, it is not recommended to accumulate - bytes in memory and instead flush the bytes on disk as soon as they are available. Note that you can still use the - <<>> object, except you don't accumulate the response's bytes as demonstrated below: - -+-----+ -MyAsyncHandler asyncHandler = new MyAsyncHanfler() { - private final Response.ResponseBuilder builder = new Response.ResponseBuilder(); - - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - content.write(myOutputStream); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - builder.accumulate(status); return STATE.CONTINUE; - } - - public STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - builder.accumulate(headers); - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return builder.build(); - } - -} - -Response response = client.prepareGet("http://sonatype.com/").execute(asyncHandler).get(); -+-----+ - - Note that in the above scenario invoking <<>> or <<>> will - return an <<>> because the body wasn't accumulated by the <<>> object. diff --git a/src/site/apt/resumable-download.apt b/src/site/apt/resumable-download.apt deleted file mode 100644 index 22ba329a9e..0000000000 --- a/src/site/apt/resumable-download.apt +++ /dev/null @@ -1,75 +0,0 @@ - ------ - Async Http Client - Resumable Dowload - ------ - Jeanfrancois Arcand - ------ - 2012 - -Uploading file: Progress Listener - - The AsyncHttpClient supports resumable download in two different scenarios: - - * <<>>: If an <<>> occurs (for whatever reason), you can configure the library to restart - the download automatically without having to restart the download from the beginning. - - * <<>>: If your application or the JVM goes down during a file download, the library can also restart the - download automatically when the same download is requested. - - - You can configure the <<>> Library to survive <<> using the <<>>: - -+-----+ -AsyncHttpClient c = new AsyncHttpClient(new AsyncHttpClientConfig.Builder() - .addIOExceptionFilter(new ResumableIOExceptionFilter()).build()); -ResumableAsyncHandler a = new ResumableAsyncHandler(new ResumableRandomAccessFileListener()); -a.setResumableListener(new ResumableRandomAccessFileListener(new RandomAccessFile("file.avi", "rw"))); -Response r = c.prepareGet("http://host:port/file.avi").execute(a).get(); -+-----+ - - If you need something more high level and configurable, you can use a <<>>, and or implement - a <<>>: - -+-----+ -AsyncHttpClient c = new AsyncHttpClient(); -ResumableAsyncHandler a = new ResumableAsyncHandler(new PropertiesBasedResumableProcessor()); -a.setResumableListener(new ResumableRandomAccessFileListener(new RandomAccessFile("file.avi", "rw"))); -Response r = c.prepareGet( "http://localhost:8081/file.AVI" ).execute( a ).get(); -+-----+ - - You can also simply use a <<>> (or use the <<>>, - which does what's described below): - -+-----+ -public interface ResumableListener { - public void onBytesReceived(ByteBuffer byteBuffer) throws IOException; - - public void onAllBytesReceived(); - - public long length(); -} -+-----+ - - As simple as: - -+-----+ -AsyncHttpClient c = new AsyncHttpClient(); -final RandomAccessFile file = new RandomAccessFile("file.avi", "rw"); -ResumableAsyncHandler a = new ResumableAsyncHandler(); -a.setResumableListener(new ResumableListener() { - - public void onBytesReceived(ByteBuffer byteBuffer) throws IOException { - file.seek(file.length()); - file.write(byteBuffer.array()); - } - - public void onAllBytesReceived() { - file.close(); - } - - public long length() { - return file.length(); - } - -}); -Response r = c.prepareGet( "http://localhost:8081/file.AVI" ).execute( a ).get(); -+-----+ diff --git a/src/site/apt/ssl.apt b/src/site/apt/ssl.apt deleted file mode 100644 index 9c7e5db94e..0000000000 --- a/src/site/apt/ssl.apt +++ /dev/null @@ -1,40 +0,0 @@ - ------ - Async Http Client - Configuring SSL - ------ - Jeanfrancois Arcand - ------ - 2012 - -Configuring SSL - - Configuring the library to support SSL is simple. By default you don't have to configure anything if you don't need to use your own certificates etc. - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -Response response = client.prepareGet(("https://sonatype.com/").execute().get(); -+-----+ - - The library will detect it's an SSL request and appropriately locate the key store, trust store etc. - If you need to configure those objects, all you need to do is to create an <<>> and set it using the - <<>>'s Builder as showed below: - -+-----+ -InputStream keyStoreStream = .... -char[] keyStorePassword = "changeit".toCharArray(); -KeyStore ks = KeyStore.getInstance("JKS"); -ks.load(keyStoreStream, keyStorePassword); - -char[] certificatePassword = "changeit".toCharArray(); -KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509"); -kmf.init(ks, certificatePassword); - -KeyManager[] keyManagers = kmf.getKeyManagers(); -TrustManager[] trustManagers = new TrustManager[]{DUMMY_TRUST_MANAGER}; -SecureRandom secureRandom = new SecureRandom(); - -SSLContext sslContext = SSLContext.getInstance("TLS"); -sslContext.init(keyManagers, trustManagers, secureRandom); -Builder builder = new AsyncHttpClientConfig.Builder(); -builder.setSSLContext(myOwnThreadPool); -AsyncHttpClient client = new AsyncHttpClient(builder.build()); -+-----+ diff --git a/src/site/apt/transfer-listener.apt b/src/site/apt/transfer-listener.apt deleted file mode 100644 index 399ea96492..0000000000 --- a/src/site/apt/transfer-listener.apt +++ /dev/null @@ -1,34 +0,0 @@ - ------ - Async Http Client - TransferListener - ------ - Jeanfrancois Arcand - ------ - 2012 - -TransferListener - - In some scenario an application may need to manipulate the received bytes in more than one place, e.g. saves the bytes - on disk but also accumulate it for checksum checking later. In that case, instead of using an <<>> and - mixes logic inside an <<>>, it is recommended to use the <<>> - simple API: - -+-----+ -public interface TransferListener { - public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers); - public void onResponseHeadersReceived (FluentCaseInsensitiveStringsMap headers); - public void onBytesReceived(ByteBuffer buffer) throws IOException; - public void onBytesSent(ByteBuffer buffer); - public void onRequestResponseCompleted(); - public void onThrowable(Throwable t); -} -+-----+ - - All you need to do in that case is to create a <<>> and add as many <<>> - as you need: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -TransferCompletionHandler tl = new TransferCompletionHandler(); -tl.addTransferListener(new TransferListener(){...}); -Response response = httpClient.prepareGet("http://.../").execute(tl).get(); -+-----+ diff --git a/src/site/apt/upload.apt b/src/site/apt/upload.apt deleted file mode 100644 index 65da26e440..0000000000 --- a/src/site/apt/upload.apt +++ /dev/null @@ -1,32 +0,0 @@ - ------ - Async Http Client - Uploading file: Progress Listener - ------ - Jeanfrancois Arcand - ------ - 2012 - -Uploading file: Progress Listener - - When uploading bytes, an application might need to take some action depending on where the upload status is. - - The AsyncHttpClient library support a special <<>> called <<>> that can be used to - track the upload operation: - -+-----+ -public interface ProgressAsyncHandler extends AsyncHandler { - STATE onHeaderWriteCompleted(); - STATE onContentWriteCompleted(); - STATE onContentWriteProgress(long amount, long current, long total); -} -+-----+ - - The methods are called in the following order: - - * <<>>: invoked when the headers has been flushed to the remote server - - * <<>>: as soon as some response's body bytes are written. Might be invoked many times. - - * <<>>: invoked when the response has been sent or aborted. - - - Like with <<>>, you can always always abort the processing at any moment in the upload process. diff --git a/src/site/apt/webdav.apt b/src/site/apt/webdav.apt deleted file mode 100644 index e20d3fa2b7..0000000000 --- a/src/site/apt/webdav.apt +++ /dev/null @@ -1,25 +0,0 @@ - ------ - Async Http Client - Using the WebDav protocol - ------ - Jeanfrancois Arcand - ------ - 2012 - -Using the WebDav protocol - - The <<>> has build in support for the WebDav protocol. The API can be used the same way normal HTTP - request are made, and everything discussed in this documentation works with WebDAV as well: - -+-----+ -AsyncHttpClient c = new AsyncHttpClient(); -Request mkcolRequest = new RequestBuilder("MKCOL").setUrl("http://host:port/folder1").build(); -Response response = c.executeRequest(mkcolRequest).get(); -+-----+ - - or - -+-----+ -AsyncHttpClient c = new AsyncHttpClient(); -Request propFindRequest = new RequestBuilder("PROPFIND").setUrl("http://host:port).build(); -Response response = c.executeRequest(propFindRequest, new AsyncHandler(){...}).get(); -+-----+ diff --git a/src/site/apt/zero-bytes-copy.apt b/src/site/apt/zero-bytes-copy.apt deleted file mode 100644 index 7b58469fbe..0000000000 --- a/src/site/apt/zero-bytes-copy.apt +++ /dev/null @@ -1,45 +0,0 @@ - ------ - Async Http Client - Zero Bytes Copy - ------ - Jeanfrancois Arcand - ------ - 2012 - -Zero Bytes Copy - - When uploading or downloading bytes, it is important to try to avoid buffering bytes in memory. - -* Upload - - On the upload side, the mechanism is enabled by default when setting the <<>>'s body to a File: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -File file = new File("file.avi"); -Future f = client.preparePut("http://localhost/").setBody(file).execute(); -+-----+ - - If you can't use a File, the recommended way is to use a <<>>. It is strongly recommended to avoid - using <<>> as the library will unfortunately buffer the entire content in memory in order to set the - <<>>, which can cause out of memory error. - -* Download - - On the download side, you can use the <<>> to avoid loading bytes in memory and - unnecessary copy: - -+-----+ -AsyncHttpClient client = new AsyncHttpClient(); -File tmp = new File("zeroCopy.txt"); -final FileOutputStream stream = new FileOutputStream(tmp); -Future f = client.prepareGet("http://localhost/largefile.avi").execute(new AsyncHandler() { - public void onThrowable(Throwable t) { } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - bodyPart.writeTo(stream); - return STATE.CONTINUE; - } - -{ .... } }); -Response resp = f.get(); -+-----+ diff --git a/src/site/site.xml b/src/site/site.xml deleted file mode 100644 index 1602c44f3f..0000000000 --- a/src/site/site.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - org.apache.maven.skins - maven-fluido-skin - 1.1 - - - - - true - false - - jfarcand - true - true - - - - - - - - -

- - - - - - - - - - - - - - - - - - - diff --git a/src/site/xdoc/index.xml.vm b/src/site/xdoc/index.xml.vm deleted file mode 100644 index 6860f4dd76..0000000000 --- a/src/site/xdoc/index.xml.vm +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Async Http Client - Home - Jeanfrancois Arcand - - - -
-

Welcome to the Async Http Client!

-

The Async Http Client library purpose is to allow Java applications to - easily execute HTTP requests and asynchronously process the HTTP responses. - The library also supports the WebSocket Protocol.

-
- -
-

The Async HTTP Client library is simple to use. First, in order to add it to your Maven project, simply add - this dependency:

- - ${project.groupId} - ${project.artifactId} - ${project.version} -]]> -
- -
diff --git a/src/test/java/com/ning/http/client/RealmTest.java b/src/test/java/com/ning/http/client/RealmTest.java deleted file mode 100644 index f1aac2fcf9..0000000000 --- a/src/test/java/com/ning/http/client/RealmTest.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client; - -import com.ning.http.client.Realm.AuthScheme; -import com.ning.http.client.Realm.RealmBuilder; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class RealmTest { - @Test(groups = "fast") - public void testClone() { - RealmBuilder builder = new RealmBuilder(); - builder.setPrincipal( "user" ).setPassword( "pass" ); - builder.setEnconding( "enc" ).setUsePreemptiveAuth( true ); - builder.setRealmName( "realm" ).setAlgorithm( "algo" ); - builder.setScheme( AuthScheme.BASIC ); - Realm orig = builder.build(); - - Realm clone = new RealmBuilder().clone( orig ).build(); - Assert.assertEquals( clone.getPrincipal(), orig.getPrincipal() ); - Assert.assertEquals( clone.getPassword(), orig.getPassword() ); - Assert.assertEquals( clone.getEncoding(), orig.getEncoding() ); - Assert.assertEquals( clone.getUsePreemptiveAuth(), orig.getUsePreemptiveAuth() ); - Assert.assertEquals( clone.getRealmName(), orig.getRealmName() ); - Assert.assertEquals( clone.getAlgorithm(), orig.getAlgorithm() ); - Assert.assertEquals( clone.getAuthScheme(), orig.getAuthScheme() ); - } -} diff --git a/src/test/java/com/ning/http/client/async/AbstractBasicTest.java b/src/test/java/com/ning/http/client/async/AbstractBasicTest.java deleted file mode 100644 index 9fc2c05090..0000000000 --- a/src/test/java/com/ning/http/client/async/AbstractBasicTest.java +++ /dev/null @@ -1,251 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.Assert; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.ServerSocket; -import java.util.Enumeration; - -public abstract class AbstractBasicTest { - protected final Logger log = LoggerFactory.getLogger(AbstractBasicTest.class); - protected Server server; - protected int port1; - protected int port2; - - public final static int TIMEOUT = 30; - - public static class EchoHandler extends AbstractHandler { - - /* @Override */ - public void handle(String pathInContext, - Request request, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - if (httpRequest.getHeader("X-HEAD") != null) { - httpResponse.setContentLength(1); - } - - if (httpRequest.getHeader("X-ISO") != null) { - httpResponse.setContentType("text/html; charset=ISO-8859-1"); - } else { - httpResponse.setContentType("text/html; charset=utf-8"); - } - - if (request.getMethod().equalsIgnoreCase("OPTIONS")) { - httpResponse.addHeader("Allow","GET,HEAD,POST,OPTIONS,TRACE"); - }; - - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("LockThread")) { - try { - Thread.sleep(40 * 1000); - } catch (InterruptedException ex) { - } - } - - if (param.startsWith("X-redirect")) { - httpResponse.sendRedirect(httpRequest.getHeader("X-redirect")); - return; - } - httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); - } - - Enumeration i = httpRequest.getParameterNames(); - - StringBuilder requestBody = new StringBuilder(); - while (i.hasMoreElements()) { - param = i.nextElement().toString(); - httpResponse.addHeader("X-" + param, httpRequest.getParameter(param)); - requestBody.append(param); - requestBody.append("_"); - } - - String pathInfo = httpRequest.getPathInfo(); - if (pathInfo != null) - httpResponse.addHeader("X-pathInfo", pathInfo); - - String queryString = httpRequest.getQueryString(); - if (queryString != null) - httpResponse.addHeader("X-queryString", queryString); - - httpResponse.addHeader("X-KEEP-ALIVE", httpRequest.getRemoteAddr() + ":" + httpRequest.getRemotePort()); - - javax.servlet.http.Cookie[] cs = httpRequest.getCookies(); - if (cs != null) { - for (javax.servlet.http.Cookie c : cs) { - httpResponse.addCookie(c); - } - } - - if (requestBody.length() > 0) { - httpResponse.getOutputStream().write(requestBody.toString().getBytes()); - } - - int size = 16384; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - int read = 0; - while (read > -1) { - read = httpRequest.getInputStream().read(bytes); - if (read > 0) { - httpResponse.getOutputStream().write(bytes, 0, read); - } - } - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - server.stop(); - } - - protected int findFreePort() throws IOException { - ServerSocket socket = null; - - try { - socket = new ServerSocket(0); - - return socket.getLocalPort(); - } - finally { - if (socket != null) { - socket.close(); - } - } - } - - protected String getTargetUrl() { - return String.format("http://127.0.0.1:%d/foo/test", port1); - } - - protected String getTargetUrl2() { - return String.format("https://127.0.0.1:%d/foo/test", port2); - } - - public AbstractHandler configureHandler() throws Exception { - return new EchoHandler(); - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - - port1 = findFreePort(); - port2 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - listener = new SelectChannelConnector(); - listener.setHost("127.0.0.1"); - listener.setPort(port2); - - server.addConnector(listener); - - server.setHandler(configureHandler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - public static class AsyncCompletionHandlerAdapter extends AsyncCompletionHandler { - public Runnable runnable; - - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - } - - public static class AsyncHandlerAdapter implements AsyncHandler { - - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception", t); - } - - /* @Override */ - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - return STATE.CONTINUE; - } - - /* @Override */ - public STATE onStatusReceived(final HttpResponseStatus responseStatus) throws Exception { - return STATE.CONTINUE; - } - - /* @Override */ - public STATE onHeadersReceived(final HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - /* @Override */ - public String onCompleted() throws Exception { - return ""; - } - - } - - public abstract AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config); - -} diff --git a/src/test/java/com/ning/http/client/async/AsyncProvidersBasicTest.java b/src/test/java/com/ning/http/client/async/AsyncProvidersBasicTest.java deleted file mode 100755 index 41421e46ef..0000000000 --- a/src/test/java/com/ning/http/client/async/AsyncProvidersBasicTest.java +++ /dev/null @@ -1,1623 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpClientConfig.Builder; -import com.ning.http.client.AsyncHttpClientConfigBean; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.MaxRedirectException; -import com.ning.http.client.Part; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.StringPart; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.io.ByteArrayInputStream; -import java.io.IOException; -import java.io.OutputStream; -import java.net.ConnectException; -import java.net.HttpURLConnection; -import java.net.URL; -import java.nio.channels.UnresolvedAddressException; -import java.util.Arrays; -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.CancellationException; -import java.util.concurrent.CountDownLatch; -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.AtomicInteger; -import java.util.concurrent.atomic.AtomicReference; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; - - -public abstract class AsyncProvidersBasicTest extends AbstractBasicTest { - private static final String UTF_8 = "text/html;charset=UTF-8"; - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncProviderEncodingTest() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - Request request = new RequestBuilder("GET").setUrl("http://foo.com/foo.html?q=+%20x").build(); - String requestUrl = request.getUrl(); - Assert.assertEquals(requestUrl, "http://foo.com/foo.html?q=%20%20x"); - Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { - @Override - public String onCompleted(Response response) throws Exception { - return response.getUri().toString(); - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - }); - String url = responseFuture.get(); - Assert.assertEquals(url, "http://foo.com/foo.html?q=%20%20x"); - p.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncProviderEncodingTest2() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - Request request = new RequestBuilder("GET").setUrl("http://foo.com/foo.html") - .addQueryParameter("q", "a b") - .build(); - - Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { - @Override - public String onCompleted(Response response) throws Exception { - return response.getUri().toString(); - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - }); - String url = responseFuture.get(); - Assert.assertEquals(url, "http://foo.com/foo.html?q=a%20b"); - p.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void emptyRequestURI() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - Request request = new RequestBuilder("GET").setUrl("http://foo.com/") - .build(); - - Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { - @Override - public String onCompleted(Response response) throws Exception { - return response.getUri().toString(); - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - }); - String url = responseFuture.get(); - Assert.assertEquals(url, "http://foo.com/"); - p.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncProviderContentLenghtGETTest() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch l = new CountDownLatch(1); - URL url = new URL(getTargetUrl()); - final HttpURLConnection connection = (HttpURLConnection) url.openConnection(); - connection.connect(); - - Request request = new RequestBuilder("GET").setUrl(getTargetUrl()).build(); - p.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - int contentLenght = -1; - if (response.getHeader("content-length") != null) { - contentLenght = Integer.valueOf(response.getHeader("content-length")); - } - int ct = connection.getContentLength(); - assertEquals(contentLenght, ct); - } finally { - l.countDown(); - } - return response; - } - - @Override - public void onThrowable(Throwable t) { - try { - Assert.fail("Unexpected exception", t); - } finally { - l.countDown(); - } - } - - - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - - p.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncContentTypeGETTest() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("GET").setUrl(getTargetUrl()).build(); - p.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getContentType(), UTF_8); - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - p.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncHeaderGETTest() throws Throwable { - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("GET").setUrl(getTargetUrl()).build(); - n.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getContentType(), UTF_8); - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - n.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncHeaderPOSTTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Test1", "Test1"); - h.add("Test2", "Test2"); - h.add("Test3", "Test3"); - h.add("Test4", "Test4"); - h.add("Test5", "Test5"); - Request request = new RequestBuilder("GET").setUrl(getTargetUrl()).setHeaders(h).build(); - - n.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - System.out.println(">>>>> " + response.getStatusText()); - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - assertEquals(response.getHeader("X-Test" + i), "Test" + i); - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - n.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncParamPOSTTest() throws Throwable { - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - Map> m = new HashMap>(); - for (int i = 0; i < 5; i++) { - m.put("param_" + i, Arrays.asList("value_" + i)); - } - Request request = new RequestBuilder("POST").setUrl(getTargetUrl()).setHeaders(h).setParameters(m).build(); - n.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - } - - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - n.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncStatusHEADTest() throws Throwable { - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("HEAD").setUrl(getTargetUrl()).build(); - Response response = n.executeRequest(request, new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - } finally { - l.countDown(); - } - return response; - } - }).get(); - - try { - String s = response.getResponseBody(); - Assert.assertEquals("",s); - } catch (IllegalStateException ex) { - fail(); - } - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - n.close(); - - } - - // TODO: fix test - @Test(groups = {"standalone", "default_provider", "async"}, enabled = false) - public void asyncStatusHEADContentLenghtTest() throws Throwable { - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder() - .setRequestTimeoutInMs(120 * 1000).build()); - - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("HEAD") - .setUrl(getTargetUrl()) - .build(); - - n.executeRequest(request, new AsyncCompletionHandlerAdapter() { - @Override - public Response onCompleted(Response response) throws Exception { - Assert.fail(); - return response; - } - - @Override - public void onThrowable(Throwable t) { - try { - assertEquals(t.getClass(), IOException.class); - assertEquals(t.getMessage(), "No response received. Connection timed out"); - } finally { - l.countDown(); - } - - } - }).get(); - - if (!l.await(10 * 5 * 1000, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - n.close(); - - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncNullSchemeTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - try { - c.prepareGet("www.sun.com").execute(); - Assert.fail(); - } catch (IllegalArgumentException ex) { - Assert.assertTrue(true); - } - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetTransferEncodingTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch l = new CountDownLatch(1); - - c.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("Transfer-Encoding"), "chunked"); - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetHeadersTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Test1", "Test1"); - h.add("Test2", "Test2"); - h.add("Test3", "Test3"); - h.add("Test4", "Test4"); - h.add("Test5", "Test5"); - c.prepareGet(getTargetUrl()).setHeaders(h).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - assertEquals(response.getHeader("X-Test" + i), "Test" + i); - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetCookieTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Test1", "Test1"); - h.add("Test2", "Test2"); - h.add("Test3", "Test3"); - h.add("Test4", "Test4"); - h.add("Test5", "Test5"); - - final Cookie coo = new Cookie("/", "foo", "value", "/", -1, false); - c.prepareGet(getTargetUrl()).setHeaders(h).addCookie(coo).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - List cookies = response.getCookies(); - assertEquals(cookies.size(), 1); - assertEquals(cookies.get(0).toString(), coo.toString()); - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostDefaultContentType() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - c.preparePost(getTargetUrl()).addParameter("foo", "bar").execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - FluentCaseInsensitiveStringsMap h = response.getHeaders(); - assertEquals(h.getJoinedValue("X-Content-Type", ", "), "application/x-www-form-urlencoded"); - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostBodyIsoTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - Response r = c.preparePost(getTargetUrl()).addHeader("X-ISO", "true").setBody("\u017D\u017D\u017D\u017D\u017D\u017D").execute().get(); - assertEquals(r.getResponseBody().getBytes("ISO-8859-1"),"\u017D\u017D\u017D\u017D\u017D\u017D".getBytes("ISO-8859-1")); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostBytesTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostInputStreamTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - ByteArrayInputStream is = new ByteArrayInputStream(sb.toString().getBytes()); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(is).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPutInputStreamTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - ByteArrayInputStream is = new ByteArrayInputStream(sb.toString().getBytes()); - - c.preparePut(getTargetUrl()).setHeaders(h).setBody(is).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostEntityWriterTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - final StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - byte[] bytes = sb.toString().getBytes(); - h.add("Content-Length", String.valueOf(bytes.length)); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(new Request.EntityWriter() { - - /* @Override */ - public void writeEntity(OutputStream out) throws IOException { - out.write(sb.toString().getBytes("UTF-8")); - } - }).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - } - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostMultiPartTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - - Part p = new StringPart("foo", "bar"); - - c.preparePost(getTargetUrl()).addBodyPart(p).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - String xContentType = response.getHeader("X-Content-Type"); - String boundary = xContentType.substring( - (xContentType.indexOf("boundary") + "boundary".length() + 1)); - - String s = response.getResponseBodyExcerpt(boundary.length() + "--".length()).substring("--".length()); - assertEquals(boundary, s); - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostBasicGZIPTest() throws Throwable { - - AsyncHttpClientConfig cf = new AsyncHttpClientConfig.Builder().setCompressionEnabled(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cf); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-Accept-Encoding"), "gzip"); - } finally { - l.countDown(); - } - return response; - } - }).get(); - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostProxyTest() throws Throwable { - - AsyncHttpClientConfig cf = new AsyncHttpClientConfig.Builder().setProxyServer(new ProxyServer("127.0.0.1", port2)).build(); - AsyncHttpClient c = getAsyncHttpClient(cf); - - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - Response response = c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandler() { - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - - @Override - public void onThrowable(Throwable t) { - } - }).get(); - - - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-Proxy-Connection"), "keep-alive"); - c.close(); - } - - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncRequestVirtualServerPOSTTest() throws Throwable { - AsyncHttpClient n = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - Map> m = new HashMap>(); - for (int i = 0; i < 5; i++) { - m.put("param_" + i, Arrays.asList("value_" + i)); - } - Request request = new RequestBuilder("POST") - .setUrl(getTargetUrl()) - .setHeaders(h) - .setParameters(m) - .setVirtualHost("localhost:" + port1) - .build(); - - Response response = n.executeRequest(request, new AsyncCompletionHandlerAdapter()).get(); - - assertEquals(response.getStatusCode(), 200); - if (response.getHeader("X-Host").startsWith("localhost")) { - assertEquals(response.getHeader("X-Host"), "localhost:" + port1); - } else { - assertEquals(response.getHeader("X-Host"), "127.0.0.1:" + port1); - } - n.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPutTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - Response response = c.preparePut(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter()).get(); - - assertEquals(response.getStatusCode(), 200); - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostLatchBytesTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - for (int i = 1; i < 5; i++) { - System.out.println(">>>>> " + response.getHeader("X-param_" + i)); - assertEquals(response.getHeader("X-param_" + i), "value_" + i); - - } - return response; - } finally { - l.countDown(); - } - } - }); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostDelayCancelTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - h.add("LockThread", "true"); - StringBuilder sb = new StringBuilder(); - sb.append("LockThread=true"); - - Future future = c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter(){ - @Override - public void onThrowable(Throwable t) { - } - }); - future.cancel(true); - Response response = future.get(TIMEOUT, TimeUnit.SECONDS); - Assert.assertNull(response); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostDelayBytesTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - h.add("LockThread", "true"); - StringBuilder sb = new StringBuilder(); - sb.append("LockThread=true"); - - try { - Future future = c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - @Override - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - }); - - future.get(10, TimeUnit.SECONDS); - } catch (ExecutionException ex) { - if (ex.getCause() != null && TimeoutException.class.isAssignableFrom(ex.getCause().getClass())) { - Assert.assertTrue(true); - } - } catch (TimeoutException te) { - Assert.assertTrue(true); - } catch (IllegalStateException ex) { - Assert.assertTrue(false); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostNullBytesTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - Future future = c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter()); - - Response response = future.get(); - Assert.assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - c.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostListenerBytesTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - StringBuilder sb = new StringBuilder(); - for (int i = 0; i < 5; i++) { - sb.append("param_"); - sb.append(i); - sb.append("=value_"); - sb.append(i); - sb.append("&"); - } - sb.deleteCharAt(sb.length() - 1); - - final CountDownLatch l = new CountDownLatch(1); - - c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - } finally { - l.countDown(); - } - return response; - } - }); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Latch time out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncConnectInvalidFuture() throws Throwable { - - int dummyPort = findFreePort(); - AsyncHttpClient c = getAsyncHttpClient(null); - final AtomicInteger count = new AtomicInteger(); - for (int i = 0; i < 20; i++) { - try { - Response response = c.preparePost(String.format("http://127.0.0.1:%d/", dummyPort)).execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public void onThrowable(Throwable t) { - count.incrementAndGet(); - } - }).get(); - assertNull(response, "Should have thrown ExecutionException"); - } catch (ExecutionException ex) { - Throwable cause = ex.getCause(); - if (!(cause instanceof ConnectException)) { - fail("Should have been caused by ConnectException, not by " + cause.getClass().getName()); - } - } - } - assertEquals(count.get(), 20); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncConnectInvalidPortFuture() throws Throwable { - - int dummyPort = findFreePort(); - AsyncHttpClient c = getAsyncHttpClient(null); - try { - Response response = c.preparePost(String.format("http://127.0.0.1:%d/", dummyPort)).execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - }).get(); - assertNull(response, "Should have thrown ExecutionException"); - } catch (ExecutionException ex) { - Throwable cause = ex.getCause(); - if (!(cause instanceof ConnectException)) { - fail("Should have been caused by ConnectException, not by " + cause.getClass().getName()); - } - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncConnectInvalidPort() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - // pick a random unused local port - int port = findFreePort(); - - try { - Response response = c.preparePost(String.format("http://127.0.0.1:%d/", port)).execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - }).get(); - assertNull(response, "No ExecutionException was thrown"); - } catch (ExecutionException ex) { - assertEquals(ex.getCause().getClass(), ConnectException.class); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncConnectInvalidHandlerPort() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - int port = findFreePort(); - - c.prepareGet(String.format("http://127.0.0.1:%d/", port)).execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public void onThrowable(Throwable t) { - try { - assertEquals(t.getClass(), ConnectException.class); - } finally { - l.countDown(); - } - } - }); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - c.close(); - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncConnectInvalidHandlerHost() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - - c.prepareGet("http://null.apache.org:9999/").execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public void onThrowable(Throwable t) { - if (t != null) { - if (t.getClass().equals(ConnectException.class)) { - l.countDown(); - } else if (t.getClass().equals(UnresolvedAddressException.class)) { - l.countDown(); - } - } - } - }); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - c.close(); - } - - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncConnectInvalidFuturePort() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - final AtomicBoolean called = new AtomicBoolean(false); - final AtomicBoolean rightCause = new AtomicBoolean(false); - // pick a random unused local port - int port = findFreePort(); - - try { - Response response = c.prepareGet(String.format("http://127.0.0.1:%d/", port)).execute(new AsyncCompletionHandlerAdapter() { - @Override - public void onThrowable(Throwable t) { - called.set(true); - if (t instanceof ConnectException) { - rightCause.set(true); - } - } - }).get(); - assertNull(response, "No ExecutionException was thrown"); - } catch (ExecutionException ex) { - assertEquals(ex.getCause().getClass(), ConnectException.class); - } - assertTrue(called.get(), "onThrowable should get called."); - assertTrue(rightCause.get(), "onThrowable should get called with ConnectionException"); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncContentLenghtGETTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - Response response = c.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public void onThrowable(Throwable t) { - Assert.fail("Unexpected exception", t); - } - }).get(); - - Assert.assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncResponseBodyTooLarge() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - Response response = c.preparePost(getTargetUrl()).setBody("0123456789").execute(new AsyncCompletionHandlerAdapter() { - - @Override - public void onThrowable(Throwable t) { - Assert.fail("Unexpected exception", t); - } - }).get(); - - Assert.assertNotNull(response.getResponseBodyExcerpt(Integer.MAX_VALUE)); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncResponseEmptyBody() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - Response response = c.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public void onThrowable(Throwable t) { - Assert.fail("Unexpected exception", t); - } - }).get(); - - assertEquals(response.getResponseBody(),""); - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "asyncAPI"}) - public void asyncAPIContentLenghtGETTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(1); - - client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - assertEquals(response.getStatusCode(), 200); - } finally { - l.countDown(); - } - return response; - } - - @Override - public void onThrowable(Throwable t) { - } - }); - - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider", "asyncAPI"}) - public void asyncAPIHandlerExceptionTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(1); - - client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerAdapter() { - @Override - public Response onCompleted(Response response) throws Exception { - throw new IllegalStateException("FOO"); - } - - @Override - public void onThrowable(Throwable t) { - try { - if (t.getMessage() != null) { - assertEquals(t.getMessage(), "FOO"); - } - } finally { - l.countDown(); - } - } - }); - - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetDelayHandlerTest() throws Throwable { - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("LockThread", "true"); - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(5 * 1000).build()); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(1); - - client.prepareGet(getTargetUrl()).setHeaders(h).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - Assert.fail("Must not receive a response"); - } finally { - l.countDown(); - } - return response; - } - - @Override - public void onThrowable(Throwable t) { - try { - if (t instanceof TimeoutException) { - Assert.assertTrue(true); - } else { - Assert.fail("Unexpected exception", t); - } - } finally { - l.countDown(); - } - } - }); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetQueryStringTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(1); - - AsyncCompletionHandler handler = new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - try { - Assert.assertTrue(response.getHeader("X-pathInfo") != null); - Assert.assertTrue(response.getHeader("X-queryString") != null); - } finally { - l.countDown(); - } - return response; - } - }; - - Request req = new RequestBuilder("GET") - .setUrl(getTargetUrl() + "?foo=bar").build(); - - client.executeRequest(req, handler).get(); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoGetKeepAliveHandlerTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(2); - - AsyncCompletionHandler handler = new AsyncCompletionHandlerAdapter() { - - String remoteAddr = null; - - @Override - public Response onCompleted(Response response) throws Exception { - assertEquals(response.getStatusCode(), 200); - if (remoteAddr == null) { - remoteAddr = response.getHeader("X-KEEP-ALIVE"); - l.countDown(); - } else { - assertEquals(response.getHeader("X-KEEP-ALIVE"), remoteAddr); - l.countDown(); - } - - return response; - } - }; - - client.prepareGet(getTargetUrl()).execute(handler).get(); - client.prepareGet(getTargetUrl()).execute(handler); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncDoGetMaxRedirectTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(new Builder().setMaximumNumberOfRedirects(0).setFollowRedirects(true).build()); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(1); - - AsyncCompletionHandler handler = new AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws Exception { - Assert.fail("Should not be here"); - return response; - } - - @Override - public void onThrowable(Throwable t) { - t.printStackTrace(); - try { - assertEquals(t.getClass(), MaxRedirectException.class); - } finally { - l.countDown(); - } - } - }; - - client.prepareGet("http://google.com/").execute(handler); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncDoGetNestedTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new Builder().build()); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(2); - - final AsyncCompletionHandlerAdapter handler = new AsyncCompletionHandlerAdapter() { - - private final static int MAX_NESTED = 2; - - private AtomicInteger nestedCount = new AtomicInteger(0); - - @Override - public Response onCompleted(Response response) throws Exception { - try { - if (nestedCount.getAndIncrement() < MAX_NESTED) { - System.out.println("Executing a nested request: " + nestedCount); - client.prepareGet("http://google.com/").execute(this); - } - } finally { - l.countDown(); - } - return response; - } - - @Override - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - }; - - - client.prepareGet("http://www.google.com/").execute(handler); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - client.close(); - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncDoGetStreamAndBodyTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new Builder().build()); - Response r = client.prepareGet("http://www.google.com/").execute().get(); - - r.getResponseBody(); - r.getResponseBodyAsStream(); - - client.close(); - } - - @Test(groups = {"online", "default_provider", "async"}) - public void asyncUrlWithoutPathTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new Builder().build()); - Response r = client.prepareGet("http://www.google.com/").execute().get(); - - r.getResponseBody(); - r.getResponseBodyAsStream(); - - client.close(); - } - - @Test(groups = {"default_provider", "async"}) - public void optionsTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new Builder().build()); - Response r = client.prepareOptions(getTargetUrl()).execute().get(); - - assertEquals(r.getStatusCode(), 200); - assertEquals(r.getHeader("Allow"), "GET,HEAD,POST,OPTIONS,TRACE"); - - client.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void testAwsS3() throws Exception { - final AsyncHttpClient c = getAsyncHttpClient(new Builder().build()); - Response response = c.prepareGet("http://test.s3.amazonaws.com/").execute().get(); - if (response.getResponseBody() == null || response.getResponseBody().equals("")) { - fail("No response Body"); - } else { - assertEquals(response.getStatusCode(), 403); - } - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void testAsyncHttpProviderConfig() throws Exception { - - final AsyncHttpClient c = getAsyncHttpClient(new Builder().setAsyncHttpClientProviderConfig(getProviderConfig()).build()); - Response response = c.prepareGet("http://test.s3.amazonaws.com/").execute().get(); - if (response.getResponseBody() == null || response.getResponseBody().equals("")) { - fail("No response Body"); - } else { - assertEquals(response.getStatusCode(), 403); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void idleRequestTimeoutTest() throws Exception { - AsyncHttpClient c = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder().setIdleConnectionInPoolTimeoutInMs(5000).setRequestTimeoutInMs(10000).build()); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - h.add("LockThread", "true"); - - long t1 = System.currentTimeMillis(); - try { - c.prepareGet(getTargetUrl()).setHeaders(h).setUrl(getTargetUrl()).execute(new AsyncHandlerAdapter() { - - /* @Override */ - public void onThrowable(Throwable t) { -// t.printStackTrace(); - } - - }).get(); - Assert.fail(); - } catch (Throwable ex) { - final long elapsedTime = System.currentTimeMillis() - t1; - System.out.println("EXPIRED: " + (elapsedTime)); - Assert.assertNotNull(ex.getCause()); - Assert.assertTrue(elapsedTime >= 10000 && elapsedTime <= 25000); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider", "async"}) - public void asyncDoPostCancelTest() throws Throwable { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - h.add("LockThread", "true"); - StringBuilder sb = new StringBuilder(); - sb.append("LockThread=true"); - - final AtomicReference ex = new AtomicReference(); - ex.set(null); - try { - Future future = c.preparePost(getTargetUrl()).setHeaders(h).setBody(sb.toString()).execute(new AsyncCompletionHandlerAdapter() { - - @Override - public void onThrowable(Throwable t) { - if (t instanceof CancellationException) { - ex.set((CancellationException)t); - } - t.printStackTrace(); - } - - }); - - future.cancel(true); - } catch (IllegalStateException ise) { - fail(); - } - Assert.assertNotNull(ex.get()); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}, expectedExceptions = IllegalArgumentException.class) - public void getShouldNotAllowBody() throws IllegalArgumentException, IOException { - AsyncHttpClient c = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder builder = c.prepareGet(getTargetUrl()); - builder.setBody("Boo!"); - builder.execute(); - } - - @Test(groups = {"standalone", "default_provider"}, expectedExceptions = IllegalArgumentException.class) - public void headShouldNotAllowBody() throws IllegalArgumentException, IOException { - AsyncHttpClient c = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder builder = c.prepareHead(getTargetUrl()); - builder.setBody("Boo!"); - builder.execute(); - } - - protected String getBrokenTargetUrl() { - return String.format("http:127.0.0.1:%d/foo/test", port1); - } - - @Test(groups = {"standalone", "default_provider"}) - public void invalidUri() throws Exception { - AsyncHttpClient c = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder builder = c.prepareGet(getBrokenTargetUrl()); - Response r = c.executeRequest(builder.build()).get(); - assertEquals(200, r.getStatusCode()); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncHttpClientConfigBeanTest() throws Exception { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfigBean().setUserAgent("test")); - AsyncHttpClient.BoundRequestBuilder builder = c.prepareGet(getTargetUrl()); - Response r = c.executeRequest(builder.build()).get(); - assertEquals(200, r.getStatusCode()); - } - - @Test(groups = {"default_provider", "async"}) - public void bodyAsByteTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new Builder().build()); - Response r = client.prepareGet(getTargetUrl()).execute().get(); - - assertEquals(r.getStatusCode(), 200); - assertEquals(r.getResponseBodyAsBytes(), new byte[]{}); - - client.close(); - } - - @Test(groups = {"default_provider", "async"}) - public void mirrorByteTest() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - Response r = client.preparePost(getTargetUrl()).setBody("MIRROR").execute().get(); - - assertEquals(r.getStatusCode(), 200); - assertEquals(new String(r.getResponseBodyAsBytes(), "UTF-8"), "MIRROR"); - - client.close(); - } - - protected abstract AsyncHttpProviderConfig getProviderConfig(); -} diff --git a/src/test/java/com/ning/http/client/async/AsyncStreamHandlerTest.java b/src/test/java/com/ning/http/client/async/AsyncStreamHandlerTest.java deleted file mode 100644 index 8e77bdd99d..0000000000 --- a/src/test/java/com/ning/http/client/async/AsyncStreamHandlerTest.java +++ /dev/null @@ -1,550 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.util.Arrays; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicBoolean; - -public abstract class AsyncStreamHandlerTest extends AbstractBasicTest { - private final static String RESPONSE = "param_1_"; - private final static String UTF8 = "text/html;charset=utf-8"; - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamGETTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(null); - - c.prepareGet(getTargetUrl()).execute(new AsyncHandlerAdapter() { - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - try { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.ABORT; - } finally { - l.countDown(); - } - } - - @Override - public void onThrowable(Throwable t) { - try { - Assert.fail("", t); - } finally { - l.countDown(); - } - } - }); - - if (!l.await(5, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamPOSTTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - Map> m = new HashMap>(); - m.put("param_1", Arrays.asList("value_1")); - - AsyncHttpClient c = getAsyncHttpClient(null); - - c.preparePost(getTargetUrl()).setParameters(m).execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - try { - String r = builder.toString().trim(); - Assert.assertEquals(r, RESPONSE); - return r; - } finally { - l.countDown(); - } - } - }); - - if (!l.await(10, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamInterruptTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - Map> m = new HashMap>(); - m.put("param_1", Arrays.asList("value_1")); - - final AtomicBoolean a = new AtomicBoolean(true); - AsyncHttpClient c = getAsyncHttpClient(null); - - c.preparePost(getTargetUrl()).setParameters(m).execute(new AsyncHandlerAdapter() { - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.ABORT; - } - - @Override - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - a.set(false); - Assert.fail("Interrupted not working"); - return STATE.ABORT; - } - - @Override - public void onThrowable(Throwable t) { - try { - Assert.fail("", t); - } finally { - l.countDown(); - } - } - }); - - l.await(5, TimeUnit.SECONDS); - Assert.assertTrue(a.get()); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamFutureTest() throws Throwable { - Map> m = new HashMap>(); - m.put("param_1", Arrays.asList("value_1")); - AsyncHttpClient c = getAsyncHttpClient(null); - - Future f = c.preparePost(getTargetUrl()).setParameters(m).execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - String r = builder.toString().trim(); - Assert.assertEquals(r, RESPONSE); - return r; - } - - @Override - public void onThrowable(Throwable t) { - Assert.fail("", t); - } - }); - - try { - String r = f.get(5, TimeUnit.SECONDS); - Assert.assertNotNull(r); - Assert.assertEquals(r.trim(), RESPONSE); - } catch (TimeoutException ex) { - Assert.fail(); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamThrowableRefusedTest() throws Throwable { - - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(null); - - c.prepareGet(getTargetUrl()).execute(new AsyncHandlerAdapter() { - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - throw new RuntimeException("FOO"); - } - - @Override - - public void onThrowable(Throwable t) { - try { - if (t.getMessage() != null) { - Assert.assertEquals(t.getMessage(), "FOO"); - } - } finally { - l.countDown(); - } - } - }); - - - if (!l.await(10, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncStreamReusePOSTTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - Map> m = new HashMap>(); - m.put("param_1", Arrays.asList("value_1")); - AsyncHttpClient c = getAsyncHttpClient(null); - - c.preparePost(getTargetUrl()).setParameters(m).execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - try { - String r = builder.toString().trim(); - Assert.assertEquals(r, RESPONSE); - return r; - } finally { - l.countDown(); - } - - } - }); - - if (!l.await(20, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - - // Let do the same again - c.preparePost(getTargetUrl()).setParameters(m).execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), UTF8); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - try { - String r = builder.toString().trim(); - Assert.assertEquals(r, RESPONSE); - return r; - } finally { - l.countDown(); - } - } - }); - - if (!l.await(20, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void asyncStream301WithBody() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(null); - c.prepareGet("http://google.com/").execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("content-type", ", ").toLowerCase(), "text/html; charset=utf-8"); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - String r = builder.toString(); - Assert.assertTrue(r.contains("301 Moved")); - l.countDown(); - return r; - } - }); - - if (!l.await(20, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void asyncStream301RedirectWithBody() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build()); - c.prepareGet("http://google.com/").execute(new AsyncHandlerAdapter() { - private StringBuilder builder = new StringBuilder(); - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getFirstValue( "server" ), "gws"); - // This assertion below is not an invariant, since implicitly contains locale-dependant settings - // and fails when run in country having own localized Google site and it's locale relies on something - // other than ISO-8859-1. - // In Hungary for example, http://google.com/ redirects to http://www.google.hu/, a localized - // Google site, that uses ISO-8892-2 encoding (default for HU). Similar is true for other - // non-ISO-8859-1 using countries that have "localized" google, like google.hr, google.rs, google.cz, google.sk etc. - // - // Assert.assertEquals(h.getJoinedValue("content-type", ", "), "text/html; charset=ISO-8859-1"); - return STATE.CONTINUE; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.append(new String(content.getBodyPartBytes())); - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - String r = builder.toString(); - Assert.assertTrue(!r.contains("301 Moved")); - l.countDown(); - - return r; - } - }); - - if (!l.await(20, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}, timeOut = 3000, description = "Test behavior of 'read only status line' scenario.") - public void asyncStreamJustStatusLine() throws Throwable { - final int STATUS = 0; - final int COMPLETED = 1; - final int OTHER = 2; - final boolean[] whatCalled = new boolean[]{false, false, false}; - final CountDownLatch latch = new CountDownLatch(1); - AsyncHttpClient client = getAsyncHttpClient(null); - Future statusCode = client.prepareGet(getTargetUrl()).execute(new AsyncHandler() { - private int status = -1; - - /* @Override */ - public void onThrowable(Throwable t) { - whatCalled[OTHER] = true; - latch.countDown(); - } - - /* @Override */ - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - whatCalled[OTHER] = true; - latch.countDown(); - return STATE.ABORT; - } - - /* @Override */ - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - whatCalled[STATUS] = true; - System.out.println(responseStatus); - status = responseStatus.getStatusCode(); - latch.countDown(); - return STATE.ABORT; - } - - /* @Override */ - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - whatCalled[OTHER] = true; - latch.countDown(); - return STATE.ABORT; - } - - /* @Override */ - public Integer onCompleted() throws Exception { - whatCalled[COMPLETED] = true; - latch.countDown(); - return status; - } - }); - - if (!latch.await(2, TimeUnit.SECONDS)) { - Assert.fail("Timeout"); - return; - } - Integer status = statusCode.get(TIMEOUT, TimeUnit.SECONDS); - Assert.assertEquals((int) status, 200, "Expected status code failed."); - - if (!whatCalled[STATUS]) { - Assert.fail("onStatusReceived not called."); - } - if (!whatCalled[COMPLETED]) { - Assert.fail("onCompleted not called."); - } - if (whatCalled[OTHER]) { - Assert.fail("Other method of AsyncHandler got called."); - } - client.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void asyncOptionsTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(null); - c.prepareOptions("http://www.apache.org/").execute(new AsyncHandlerAdapter() { - - @Override - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - FluentCaseInsensitiveStringsMap h = content.getHeaders(); - Assert.assertNotNull(h); - Assert.assertEquals(h.getJoinedValue("Allow", ", "), "GET,HEAD,POST,OPTIONS,TRACE"); - return STATE.ABORT; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - return STATE.CONTINUE; - } - - @Override - public String onCompleted() throws Exception { - try { - return "OK"; - } finally { - l.countDown(); - } - } - }); - - if (!l.await(20, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void closeConnectionTest() throws Throwable { - final CountDownLatch l = new CountDownLatch(1); - AsyncHttpClient c = getAsyncHttpClient(null); - - Response r = c.prepareGet(getTargetUrl()).execute(new AsyncHandler() { - - private Response.ResponseBuilder builder = new Response.ResponseBuilder(); - - public STATE onHeadersReceived(HttpResponseHeaders content) throws Exception { - builder.accumulate(content); - return STATE.CONTINUE; - } - - public void onThrowable(Throwable t) { - } - - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - builder.accumulate(content); - - if (content.isLast()) { - content.markUnderlyingConnectionAsClosed(); - } - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - builder.accumulate(responseStatus); - - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return builder.build(); - } - }).get(); - - Assert.assertNotNull(r); - Assert.assertEquals(r.getStatusCode(), 200); - c.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/AsyncStreamLifecycleTest.java b/src/test/java/com/ning/http/client/async/AsyncStreamLifecycleTest.java deleted file mode 100644 index faeaee7cc2..0000000000 --- a/src/test/java/com/ning/http/client/async/AsyncStreamLifecycleTest.java +++ /dev/null @@ -1,161 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import org.eclipse.jetty.continuation.Continuation; -import org.eclipse.jetty.continuation.ContinuationSupport; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.AfterClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.PrintWriter; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.LinkedBlockingQueue; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertFalse; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; - -/** - * Tests default asynchronous life cycle. - * - * @author Hubert Iwaniuk - */ -public abstract class AsyncStreamLifecycleTest extends AbstractBasicTest { - private ExecutorService executorService = Executors.newFixedThreadPool(2); - - @AfterClass - @Override - public void tearDownGlobal() throws Exception { - super.tearDownGlobal(); - executorService.shutdownNow(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new AbstractHandler() { - public void handle(String s, Request request, HttpServletRequest req, final HttpServletResponse resp) - throws IOException, ServletException { - resp.setContentType("text/plain;charset=utf-8"); - resp.setStatus(200); - final Continuation continuation = ContinuationSupport.getContinuation(req); - continuation.suspend(); - final PrintWriter writer = resp.getWriter(); - executorService.submit(new Runnable() { - public void run() { - try { - Thread.sleep(100); - } catch (InterruptedException e) { - log.error("Failed to sleep for 100 ms.", e); - } - log.info("Delivering part1."); - writer.write("part1"); - writer.flush(); - } - }); - executorService.submit(new Runnable() { - public void run() { - try { - Thread.sleep(200); - } catch (InterruptedException e) { - log.error("Failed to sleep for 200 ms.", e); - } - log.info("Delivering part2."); - writer.write("part2"); - writer.flush(); - continuation.complete(); - } - }); - request.setHandled(true); - } - }; - } - - //TODO Netty only. - - @Test(groups = {"standalone", "default_provider"}) - public void testStream() throws IOException { - AsyncHttpClient ahc = getAsyncHttpClient(null); - final AtomicBoolean err = new AtomicBoolean(false); - final LinkedBlockingQueue queue = new LinkedBlockingQueue(); - final AtomicBoolean status = new AtomicBoolean(false); - final AtomicInteger headers = new AtomicInteger(0); - final CountDownLatch latch = new CountDownLatch(1); - ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build(), new AsyncHandler() { - public void onThrowable(Throwable t) { - fail("Got throwable.", t); - err.set(true); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart e) throws Exception { - String s = new String(e.getBodyPartBytes()); - log.info("got part: {}", s); - if (s.equals("")) { - //noinspection ThrowableInstanceNeverThrown - log.warn("Sampling stacktrace.", - new Throwable("trace that, we should not get called for empty body.")); - } - queue.put(s); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus e) throws Exception { - status.set(true); - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders e) throws Exception { - if (headers.incrementAndGet() == 2) { - throw new Exception("Analyze this."); - } - return STATE.CONTINUE; - } - - public Object onCompleted() throws Exception { - latch.countDown(); - return null; - } - }); - try { - assertTrue(latch.await(1, TimeUnit.SECONDS), "Latch failed."); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } - assertFalse(err.get()); - assertEquals(queue.size(), 2); - assertTrue(queue.contains("part1")); - assertTrue(queue.contains("part2")); - assertTrue(status.get()); - assertEquals(headers.get(), 1); - ahc.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/AuthTimeoutTest.java b/src/test/java/com/ning/http/client/async/AuthTimeoutTest.java deleted file mode 100644 index 37b83eff80..0000000000 --- a/src/test/java/com/ning/http/client/async/AuthTimeoutTest.java +++ /dev/null @@ -1,294 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Realm; -import com.ning.http.client.Response; -import org.apache.log4j.ConsoleAppender; -import org.apache.log4j.Level; -import org.apache.log4j.Logger; -import org.apache.log4j.PatternLayout; -import org.eclipse.jetty.security.ConstraintMapping; -import org.eclipse.jetty.security.ConstraintSecurityHandler; -import org.eclipse.jetty.security.HashLoginService; -import org.eclipse.jetty.security.LoginService; -import org.eclipse.jetty.security.authentication.BasicAuthenticator; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.util.security.Constraint; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.OutputStream; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashSet; -import java.util.List; -import java.util.Set; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.fail; - -public abstract class AuthTimeoutTest - extends AbstractBasicTest { - - private final static String user = "user"; - - private final static String admin = "admin"; - - protected AsyncHttpClient client; - - public void setUpServer(String auth) - throws Exception { - server = new Server(); - Logger root = Logger.getRootLogger(); - root.setLevel(Level.DEBUG); - root.addAppender(new ConsoleAppender(new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN))); - - port1 = findFreePort(); - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - LoginService loginService = new HashLoginService("MyRealm", "src/test/resources/realm.properties"); - server.addBean(loginService); - - Constraint constraint = new Constraint(); - constraint.setName(auth); - constraint.setRoles(new String[]{user, admin}); - constraint.setAuthenticate(true); - - ConstraintMapping mapping = new ConstraintMapping(); - mapping.setConstraint(constraint); - mapping.setPathSpec("/*"); - - Set knownRoles = new HashSet(); - knownRoles.add(user); - knownRoles.add(admin); - - ConstraintSecurityHandler security = new ConstraintSecurityHandler(); - - List cm = new ArrayList(); - cm.add(mapping); - - security.setConstraintMappings(cm, knownRoles); - security.setAuthenticator(new BasicAuthenticator()); - security.setLoginService(loginService); - security.setStrict(false); - security.setHandler(configureHandler()); - - server.setHandler(security); - server.start(); - log.info("Local HTTP server started successfully"); - } - - private class SimpleHandler - extends AbstractHandler { - public void handle(String s, Request r, HttpServletRequest request, HttpServletResponse response) - throws IOException, ServletException { - - // NOTE: handler sends less bytes than are given in Content-Length, which should lead to timeout - - OutputStream out = response.getOutputStream(); - if (request.getHeader("X-Content") != null) { - String content = request.getHeader("X-Content"); - response.setHeader("Content-Length", String.valueOf(content.getBytes("UTF-8").length)); - out.write(content.substring(1).getBytes("UTF-8")); - out.flush(); - out.close(); - return; - } - - response.setStatus(200); - out.flush(); - out.close(); - } - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void basicAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__BASIC_AUTH); - - Future f = execute(false); - try { - f.get(); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void basicPreemptiveAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__BASIC_AUTH); - - Future f = execute(true); - try { - f.get(); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void digestAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__DIGEST_AUTH); - - Future f = execute(false); - try { - f.get(); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void digestPreemptiveAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__DIGEST_AUTH); - - Future f = execute(true); - try { - f.get(); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void basicFutureAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__BASIC_AUTH); - - Future f = execute(false); - try { - f.get(1, TimeUnit.SECONDS); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void basicFuturePreemptiveAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__BASIC_AUTH); - - Future f = execute(true); - try { - f.get(1, TimeUnit.SECONDS); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void digestFutureAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__DIGEST_AUTH); - - Future f = execute(false); - try { - f.get(1, TimeUnit.SECONDS); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = false) - public void digestFuturePreemptiveAuthTimeoutTest() - throws Exception { - setUpServer(Constraint.__DIGEST_AUTH); - - Future f = execute(true); - try { - f.get(1, TimeUnit.SECONDS); - fail("expected timeout"); - } - catch (Exception e) { - inspectException(e); - } - client.close(); - } - - protected void inspectException(Throwable t) { - assertNotNull(t.getCause()); - assertEquals(t.getCause().getClass(), IOException.class); - if (!t.getCause().getMessage().startsWith("Remotely Closed")){ - fail(); - }; - } - - protected Future execute(boolean preemptive) - throws IOException { - client = - getAsyncHttpClient( - new AsyncHttpClientConfig.Builder().setIdleConnectionInPoolTimeoutInMs(2000).setConnectionTimeoutInMs(20000).setRequestTimeoutInMs(2000).build()); - AsyncHttpClient.BoundRequestBuilder r = - client.prepareGet(getTargetUrl()).setRealm(realm(preemptive)).setHeader("X-Content", - "Test"); - Future f = r.execute(); - return f; - } - - private Realm realm(boolean preemptive) { - return (new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).setUsePreemptiveAuth(preemptive).build(); - } - - @Override - protected String getTargetUrl() { - return "http://127.0.0.1/" + port1 + "/"; - } - - @Override - public AbstractHandler configureHandler() - throws Exception { - return new SimpleHandler(); - } -} diff --git a/src/test/java/com/ning/http/client/async/BasicAuthTest.java b/src/test/java/com/ning/http/client/async/BasicAuthTest.java deleted file mode 100644 index bbdefbd3e7..0000000000 --- a/src/test/java/com/ning/http/client/async/BasicAuthTest.java +++ /dev/null @@ -1,510 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Realm; -import com.ning.http.client.Response; -import com.ning.http.client.SimpleAsyncHttpClient; -import com.ning.http.client.consumers.AppendableBodyConsumer; -import com.ning.http.client.generators.InputStreamBodyGenerator; -import org.apache.log4j.ConsoleAppender; -import org.apache.log4j.Level; -import org.apache.log4j.Logger; -import org.apache.log4j.PatternLayout; -import org.eclipse.jetty.security.ConstraintMapping; -import org.eclipse.jetty.security.ConstraintSecurityHandler; -import org.eclipse.jetty.security.HashLoginService; -import org.eclipse.jetty.security.LoginService; -import org.eclipse.jetty.security.authentication.BasicAuthenticator; -import org.eclipse.jetty.security.authentication.DigestAuthenticator; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.util.security.Constraint; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.ByteArrayInputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.net.URL; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashSet; -import java.util.List; -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 static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class BasicAuthTest extends AbstractBasicTest { - - protected final static String MY_MESSAGE = "my message"; - protected final static String user = "user"; - protected final static String admin = "admin"; - - private Server server2; - - @BeforeClass(alwaysRun = true) - @Override - public void setUpGlobal() throws Exception { - server = new Server(); - Logger root = Logger.getRootLogger(); - root.setLevel(Level.DEBUG); - root.addAppender(new ConsoleAppender( - new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN))); - - port1 = findFreePort(); - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - LoginService loginService = new HashLoginService("MyRealm", "src/test/resources/realm.properties"); - server.addBean(loginService); - - Constraint constraint = new Constraint(); - constraint.setName(Constraint.__BASIC_AUTH); - constraint.setRoles(new String[]{user, admin}); - constraint.setAuthenticate(true); - - ConstraintMapping mapping = new ConstraintMapping(); - mapping.setConstraint(constraint); - mapping.setPathSpec("/*"); - - List cm = new ArrayList(); - cm.add(mapping); - - Set knownRoles = new HashSet(); - knownRoles.add(user); - knownRoles.add(admin); - - ConstraintSecurityHandler security = new ConstraintSecurityHandler(); - security.setConstraintMappings(cm, knownRoles); - security.setAuthenticator(new BasicAuthenticator()); - security.setLoginService(loginService); - security.setStrict(false); - security.setHandler(configureHandler()); - - server.setHandler(security); - server.start(); - log.info("Local HTTP server started successfully"); - } - - private String getFileContent(final File file) { - FileInputStream in = null; - try { - if (file.exists() && file.canRead()) { - final StringBuilder sb = new StringBuilder(128); - final byte[] b = new byte[512]; - int read; - in = new FileInputStream(file); - while ((read = in.read(b)) != -1) { - sb.append(new String(b, 0, read, "UTF-8")); - } - return sb.toString(); - } - throw new IllegalArgumentException("File does not exist or cannot be read: " - + file.getCanonicalPath()); - } catch (IOException ioe) { - throw new IllegalStateException(ioe); - } finally { - if (in != null) { - try { - in.close(); - } catch (IOException ignored) { - } - } - } - - } - - private void setUpSecondServer() throws Exception { - server2 = new Server(); - port2 = findFreePort(); - - SelectChannelConnector connector = new SelectChannelConnector(); - connector.setHost("127.0.0.1"); - connector.setPort(port2); - - server2.addConnector(connector); - - LoginService loginService = new HashLoginService("MyRealm", "src/test/resources/realm.properties"); - server2.addBean(loginService); - - Constraint constraint = new Constraint(); - constraint.setName(Constraint.__DIGEST_AUTH); - constraint.setRoles(new String[]{user, admin}); - constraint.setAuthenticate(true); - - ConstraintMapping mapping = new ConstraintMapping(); - mapping.setConstraint(constraint); - mapping.setPathSpec("/*"); - - Set knownRoles = new HashSet(); - knownRoles.add(user); - knownRoles.add(admin); - - ConstraintSecurityHandler security = new ConstraintSecurityHandler() { - - @Override - public void handle(String arg0, Request arg1, HttpServletRequest arg2, HttpServletResponse arg3) - throws IOException, ServletException { - System.err.println("request in security handler"); - System.err.println("Authorization: " + arg2.getHeader("Authorization")); - System.err.println("RequestUri: " + arg2.getRequestURI()); - super.handle(arg0, arg1, arg2, arg3); - } - }; - - List cm = new ArrayList(); - cm.add(mapping); - - security.setConstraintMappings(cm, knownRoles); - security.setAuthenticator(new DigestAuthenticator()); - security.setLoginService(loginService); - security.setStrict(true); - security.setHandler(new RedirectHandler()); - - server2.setHandler(security); - server2.start(); - } - - private void stopSecondServer() throws Exception { - server2.stop(); - } - - private class RedirectHandler extends AbstractHandler { - - private AtomicBoolean redirectOnce = new AtomicBoolean(false); - - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - - System.err.println("redirecthandler"); - System.err.println("request: " + request.getRequestURI()); - if ("/uff".equals(request.getRequestURI())) { - - System.err.println("redirect to /bla"); - response.setStatus(302); - response.setHeader("Location", "/bla"); - response.getOutputStream().flush(); - response.getOutputStream().close(); - - return; - - } else { - System.err.println("got redirected" + request.getRequestURI()); - response.addHeader("X-Auth", request.getHeader("Authorization")); - response.addHeader("X-Content-Length", String.valueOf(request.getContentLength())); - response.setStatus(200); - response.getOutputStream().write("content".getBytes("UTF-8")); - response.getOutputStream().flush(); - response.getOutputStream().close(); - } - } - } - - private class SimpleHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - - if (request.getHeader("X-401") != null) { - response.setStatus(401); - response.getOutputStream().flush(); - response.getOutputStream().close(); - - return; - } - response.addHeader("X-Auth", request.getHeader("Authorization")); - response.addHeader("X-Content-Length", String.valueOf(request.getContentLength())); - response.setStatus(200); - - - int size = 10 * 1024; - if (request.getContentLength() > 0) { - size = request.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - int read = request.getInputStream().read(bytes); - if (read > 0) { - response.getOutputStream().write(bytes, 0, read); - } - } - response.getOutputStream().flush(); - response.getOutputStream().close(); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl()) - .setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void redirectAndBasicAuthTest() throws Exception, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = null; - try { - setUpSecondServer(); - client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setFollowRedirects(true).setMaximumNumberOfRedirects(10).build()); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl2()) - // .setHeader( "X-302", "/bla" ) - .setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - - } finally { - if (client != null) client.close(); - stopSecondServer(); - } - } - - @Override - protected String getTargetUrl() { - return "http://127.0.0.1/" + port1 + "/"; - } - - protected String getTargetUrl2() { - return "http://127.0.0.1/" + port2 + "/uff"; - } - - @Test(groups = {"standalone", "default_provider"}) - public void basic401Test() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl()) - .setHeader("X-401", "401").setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(new AsyncHandler() { - - private HttpResponseStatus status; - - - public void onThrowable(Throwable t) { - - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - this.status = responseStatus; - - if (status.getStatusCode() != 200) { - return STATE.ABORT; - } - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - public Integer onCompleted() throws Exception { - return status.getStatusCode(); - } - }); - Integer statusCode = f.get(10, TimeUnit.SECONDS); - assertNotNull(statusCode); - assertEquals(statusCode.intValue(), 401); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthTestPreemtiveTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl()) - .setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).setUsePreemptiveAuth(true).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthNegativeTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl()) - .setRealm((new Realm.RealmBuilder()).setPrincipal("fake").setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), 401); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthInputStreamTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - ByteArrayInputStream is = new ByteArrayInputStream("test".getBytes()); - AsyncHttpClient.BoundRequestBuilder r = client.preparePost(getTargetUrl()) - .setBody(is).setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(30, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "test"); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthFileTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - final String fileContent = getFileContent(file); - - AsyncHttpClient.BoundRequestBuilder r = client.preparePost(getTargetUrl()) - .setBody(file).setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), fileContent); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthAsyncConfigTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder() - .setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()).build()); - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - final String fileContent = getFileContent(file); - - AsyncHttpClient.BoundRequestBuilder r = client.preparePost(getTargetUrl()).setBody(file); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), fileContent); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicAuthFileNoKeepAliveTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setAllowPoolingConnection(false).build()); - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - final String fileContent = getFileContent(file); - - AsyncHttpClient.BoundRequestBuilder r = client.preparePost(getTargetUrl()) - .setBody(file).setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), fileContent); - client.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new SimpleHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void StringBufferBodyConsumerTest() throws Throwable { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder() - .setRealmPrincipal(user) - .setRealmPassword(admin) - .setUrl(getTargetUrl()) - .setHeader("Content-Type", "text/html").build(); - - StringBuilder s = new StringBuilder(); - Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())), new AppendableBodyConsumer(s)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(s.toString(), MY_MESSAGE); - assertEquals(response.getStatusCode(), HttpServletResponse.SC_OK); - assertNotNull(response.getHeader("X-Auth")); - - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void noneAuthTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet(getTargetUrl()) - .setRealm((new Realm.RealmBuilder()).setPrincipal(user).setPassword(admin).build()); - - Future f = r.execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertNotNull(resp.getHeader("X-Auth")); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } -} - diff --git a/src/test/java/com/ning/http/client/async/BasicHttpsTest.java b/src/test/java/com/ning/http/client/async/BasicHttpsTest.java deleted file mode 100644 index bcd508e2d6..0000000000 --- a/src/test/java/com/ning/http/client/async/BasicHttpsTest.java +++ /dev/null @@ -1,358 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig.Builder; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.ssl.SslSocketConnector; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.annotations.AfterClass; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.net.ssl.KeyManager; -import javax.net.ssl.KeyManagerFactory; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLHandshakeException; -import javax.net.ssl.TrustManager; -import javax.net.ssl.X509TrustManager; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.net.ConnectException; -import java.net.ServerSocket; -import java.net.URL; -import java.security.KeyStore; -import java.security.SecureRandom; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; -import java.util.Enumeration; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertTrue; - -public abstract class BasicHttpsTest extends AbstractBasicTest { - - protected final Logger log = LoggerFactory.getLogger(BasicHttpsTest.class); - - public static class EchoHandler extends AbstractHandler { - - /* @Override */ - public void handle(String pathInContext, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws ServletException, IOException { - - httpResponse.setContentType("text/html; charset=utf-8"); - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("LockThread")) { - try { - Thread.sleep(40 * 1000); - } catch (InterruptedException ex) { // nothing to do here - } - } - - httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); - } - - Enumeration i = httpRequest.getParameterNames(); - - StringBuilder requestBody = new StringBuilder(); - while (i.hasMoreElements()) { - param = i.nextElement().toString(); - httpResponse.addHeader("X-" + param, httpRequest.getParameter(param)); - requestBody.append(param); - requestBody.append("_"); - } - - String pathInfo = httpRequest.getPathInfo(); - if (pathInfo != null) - httpResponse.addHeader("X-pathInfo", pathInfo); - - String queryString = httpRequest.getQueryString(); - if (queryString != null) - httpResponse.addHeader("X-queryString", queryString); - - httpResponse.addHeader("X-KEEP-ALIVE", httpRequest.getRemoteAddr() + ":" + httpRequest.getRemotePort()); - - javax.servlet.http.Cookie[] cs = httpRequest.getCookies(); - if (cs != null) { - for (javax.servlet.http.Cookie c : cs) { - httpResponse.addCookie(c); - } - } - - if (requestBody.length() > 0) { - httpResponse.getOutputStream().write(requestBody.toString().getBytes()); - } - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - //noinspection ResultOfMethodCallIgnored - int read = httpRequest.getInputStream().read(bytes); - httpResponse.getOutputStream().write(bytes, 0, read); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - - } - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - server.stop(); - } - - @AfterMethod(alwaysRun = true) - public void tearDownProps() throws Exception { - System.clearProperty("javax.net.ssl.keyStore"); - System.clearProperty("javax.net.ssl.trustStore"); - } - - protected String getTargetUrl() { - return String.format("https://127.0.0.1:%d/foo/test", port1); - } - - public AbstractHandler configureHandler() throws Exception { - return new EchoHandler(); - } - - protected int findFreePort() throws IOException { - ServerSocket socket = null; - - try { - socket = new ServerSocket(0); - - return socket.getLocalPort(); - } - finally { - if (socket != null) { - socket.close(); - } - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - port1 = findFreePort(); - SslSocketConnector connector = new SslSocketConnector(); - connector.setHost("127.0.0.1"); - connector.setPort(port1); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL cacertsUrl = cl.getResource("ssltest-cacerts.jks"); - String trustStoreFile = new File(cacertsUrl.toURI()).getAbsolutePath(); - connector.setTruststore(trustStoreFile); - connector.setTrustPassword("changeit"); - connector.setTruststoreType("JKS"); - - log.info("SSL certs path: {}", trustStoreFile); - - // override system properties - URL keystoreUrl = cl.getResource("ssltest-keystore.jks"); - String keyStoreFile = new File(keystoreUrl.toURI()).getAbsolutePath(); - connector.setKeystore(keyStoreFile); - connector.setKeyPassword("changeit"); - connector.setKeystoreType("JKS"); - - log.info("SSL keystore path: {}", keyStoreFile); - - server.addConnector(connector); - - server.setHandler(configureHandler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"standalone", "default_provider"}) - public void zeroCopyPostTest() throws Throwable { - - final AsyncHttpClient client = getAsyncHttpClient(new Builder().setSSLContext(createSSLContext()).build()); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - Future f = client.preparePost(getTargetUrl()).setBody(file).setHeader("Content-Type", "text/html").execute(); - Response resp = f.get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "This is a simple test file"); - } - - @Test(groups = {"standalone", "default_provider"}) - public void multipleSSLRequestsTest() throws Throwable { - final AsyncHttpClient c = getAsyncHttpClient(new Builder().setSSLContext(createSSLContext()).build()); - - String body = "hello there"; - - // once - Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - - // twice - response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void multipleSSLWithoutCacheTest() throws Throwable { - final AsyncHttpClient c = getAsyncHttpClient(new Builder().setSSLContext(createSSLContext()).setAllowSslConnectionPool(false).build()); - - String body = "hello there"; - c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute(); - - c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute(); - - Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(); - - assertEquals(response.getResponseBody(), body); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void reconnectsAfterFailedCertificationPath() throws Throwable { - final AsyncHttpClient c = getAsyncHttpClient(new Builder().setSSLContext(createSSLContext()).build()); - - final String body = "hello there"; - - TRUST_SERVER_CERT.set(false); - try { - // first request fails because server certificate is rejected - try { - c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - } - catch (final ExecutionException e) { - Throwable cause = e.getCause(); - if (cause instanceof ConnectException) { - assertNotNull(cause.getCause()); - assertTrue(cause.getCause() instanceof SSLHandshakeException); - } else { - assertTrue(cause instanceof SSLHandshakeException); - } - } - - TRUST_SERVER_CERT.set(true); - - // second request should succeed - final Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - } - finally { - TRUST_SERVER_CERT.set(true); - } - c.close(); - } - - private static SSLContext createSSLContext() { - try { - InputStream keyStoreStream = BasicHttpsTest.class.getResourceAsStream("ssltest-cacerts.jks"); - char[] keyStorePassword = "changeit".toCharArray(); - KeyStore ks = KeyStore.getInstance("JKS"); - ks.load(keyStoreStream, keyStorePassword); - - // Set up key manager factory to use our key store - char[] certificatePassword = "changeit".toCharArray(); - KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509"); - kmf.init(ks, certificatePassword); - - // Initialize the SSLContext to work with our key managers. - KeyManager[] keyManagers = kmf.getKeyManagers(); - TrustManager[] trustManagers = new TrustManager[]{DUMMY_TRUST_MANAGER}; - SecureRandom secureRandom = new SecureRandom(); - - SSLContext sslContext = SSLContext.getInstance("TLS"); - sslContext.init(keyManagers, trustManagers, secureRandom); - - return sslContext; - } - catch (Exception e) { - throw new Error("Failed to initialize the server-side SSLContext", e); - } - } - - private static final AtomicBoolean TRUST_SERVER_CERT = new AtomicBoolean(true); - private static final TrustManager DUMMY_TRUST_MANAGER = new X509TrustManager() { - public X509Certificate[] getAcceptedIssuers() { - return new X509Certificate[0]; - } - - public void checkClientTrusted( - X509Certificate[] chain, String authType) throws CertificateException { - } - - public void checkServerTrusted( - X509Certificate[] chain, String authType) throws CertificateException { - if (!TRUST_SERVER_CERT.get()) { - throw new CertificateException("Server certificate not trusted."); - } - } - }; - - -} diff --git a/src/test/java/com/ning/http/client/async/BodyChunkTest.java b/src/test/java/com/ning/http/client/async/BodyChunkTest.java deleted file mode 100644 index 8db2bfb649..0000000000 --- a/src/test/java/com/ning/http/client/async/BodyChunkTest.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.generators.InputStreamBodyGenerator; -import org.testng.annotations.Test; - -import java.io.ByteArrayInputStream; -import java.util.concurrent.Future; - -import static org.testng.Assert.assertEquals; - -public abstract class BodyChunkTest extends AbstractBasicTest { - - private final static String MY_MESSAGE = "my message"; - - @Test(groups = {"standalone", "default_provider"}) - public void negativeContentTypeTest() throws Throwable { - - AsyncHttpClientConfig.Builder confbuilder = new AsyncHttpClientConfig.Builder(); - confbuilder = confbuilder.setConnectionTimeoutInMs(100); - confbuilder = confbuilder.setMaximumConnectionsTotal(50); - confbuilder = confbuilder.setRequestTimeoutInMs(5 * 60 * 1000); // 5 minutes - - // Create client - AsyncHttpClient client = getAsyncHttpClient(confbuilder.build()); - - RequestBuilder requestBuilder = new RequestBuilder("POST") - .setUrl(getTargetUrl()) - .setHeader("Content-Type", "message/rfc822"); - - requestBuilder.setBody(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes()))); - - Future future = client.executeRequest(requestBuilder.build()); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getResponseBody(), MY_MESSAGE); - - client.close(); - } - -} - - diff --git a/src/test/java/com/ning/http/client/async/BodyDeferringAsyncHandlerTest.java b/src/test/java/com/ning/http/client/async/BodyDeferringAsyncHandlerTest.java deleted file mode 100644 index 48e1836a65..0000000000 --- a/src/test/java/com/ning/http/client/async/BodyDeferringAsyncHandlerTest.java +++ /dev/null @@ -1,284 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.BodyDeferringAsyncHandler; -import com.ning.http.client.BodyDeferringAsyncHandler.BodyDeferringInputStream; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.Assert; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.PipedInputStream; -import java.io.PipedOutputStream; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class BodyDeferringAsyncHandlerTest extends AbstractBasicTest { - - // not a half gig ;) for test shorter run's sake - protected static final int HALF_GIG = 100000; - - public static class SlowAndBigHandler extends AbstractHandler { - - public void handle(String pathInContext, Request request, - HttpServletRequest httpRequest, HttpServletResponse httpResponse) - throws IOException, ServletException { - - // 512MB large download - // 512 * 1024 * 1024 = 536870912 - httpResponse.setStatus(200); - httpResponse.setContentLength(HALF_GIG); - httpResponse.setContentType("application/octet-stream"); - - httpResponse.flushBuffer(); - - final boolean wantFailure = httpRequest - .getHeader("X-FAIL-TRANSFER") != null; - final boolean wantSlow = httpRequest.getHeader("X-SLOW") != null; - - OutputStream os = httpResponse.getOutputStream(); - for (int i = 0; i < HALF_GIG; i++) { - os.write(i % 255); - - if (wantSlow) { - try { - Thread.sleep(300); - } catch (InterruptedException ex) { - // nuku - } - } - - if (wantFailure) { - if (i > HALF_GIG / 2) { - // kaboom - // yes, response is commited, but Jetty does aborts and - // drops connection - httpResponse.sendError(500); - break; - } - } - } - - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - // a /dev/null but counting how many bytes it ditched - public static class CountingOutputStream extends OutputStream { - private int byteCount = 0; - - @Override - public void write(int b) throws IOException { - // /dev/null - byteCount++; - } - - public int getByteCount() { - return byteCount; - } - } - - // simple stream copy just to "consume". It closes streams. - public static void copy(InputStream in, OutputStream out) - throws IOException { - byte[] buf = new byte[1024]; - int len; - while ((len = in.read(buf)) > 0) { - out.write(buf, 0, len); - } - out.flush(); - out.close(); - in.close(); - } - - public AbstractHandler configureHandler() throws Exception { - return new SlowAndBigHandler(); - } - - public AsyncHttpClientConfig getAsyncHttpClientConfig() { - // for this test brevity's sake, we are limiting to 1 retries - return new AsyncHttpClientConfig.Builder().setMaxRequestRetry(0) - .setRequestTimeoutInMs(10000).build(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void deferredSimple() throws IOException, ExecutionException, - TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(getAsyncHttpClientConfig()); - AsyncHttpClient.BoundRequestBuilder r = client - .prepareGet("http://127.0.0.1/" + port1 + "/deferredSimple"); - - CountingOutputStream cos = new CountingOutputStream(); - BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); - Future f = r.execute(bdah); - Response resp = bdah.getResponse(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals( - true, - resp.getHeader("content-length").equals( - String.valueOf(HALF_GIG))); - // we got headers only, it's probably not all yet here (we have BIG file - // downloading) - assertEquals(true, HALF_GIG >= cos.getByteCount()); - - // now be polite and wait for body arrival too (otherwise we would be - // dropping the "line" on server) - f.get(); - // it all should be here now - assertEquals(true, HALF_GIG == cos.getByteCount()); - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }, enabled = false) - public void deferredSimpleWithFailure() throws IOException, - ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(getAsyncHttpClientConfig()); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet( - "http://127.0.0.1/" + port1 + "/deferredSimpleWithFailure") - .addHeader("X-FAIL-TRANSFER", Boolean.TRUE.toString()); - - CountingOutputStream cos = new CountingOutputStream(); - BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); - Future f = r.execute(bdah); - Response resp = bdah.getResponse(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals( - true, - resp.getHeader("content-length").equals( - String.valueOf(HALF_GIG))); - // we got headers only, it's probably not all yet here (we have BIG file - // downloading) - assertEquals(true, HALF_GIG >= cos.getByteCount()); - - // now be polite and wait for body arrival too (otherwise we would be - // dropping the "line" on server) - try { - f.get(); - Assert.fail("get() should fail with IOException!"); - } catch (Exception e) { - // good - } - // it's incomplete, there was an error - assertEquals(false, HALF_GIG == cos.getByteCount()); - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void deferredInputStreamTrick() throws IOException, - ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(getAsyncHttpClientConfig()); - AsyncHttpClient.BoundRequestBuilder r = client - .prepareGet("http://127.0.0.1/" + port1 - + "/deferredInputStreamTrick"); - - PipedOutputStream pos = new PipedOutputStream(); - PipedInputStream pis = new PipedInputStream(pos); - BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pos); - - Future f = r.execute(bdah); - - BodyDeferringInputStream is = new BodyDeferringInputStream(f, bdah, pis); - - Response resp = is.getAsapResponse(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals( - true, - resp.getHeader("content-length").equals( - String.valueOf(HALF_GIG))); - // "consume" the body, but our code needs input stream - CountingOutputStream cos = new CountingOutputStream(); - copy(is, cos); - - // now we don't need to be polite, since consuming and closing - // BodyDeferringInputStream does all. - // it all should be here now - assertEquals(true, HALF_GIG == cos.getByteCount()); - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void deferredInputStreamTrickWithFailure() throws IOException, - ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(getAsyncHttpClientConfig()); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet( - "http://127.0.0.1/" + port1 - + "/deferredInputStreamTrickWithFailure").addHeader( - "X-FAIL-TRANSFER", Boolean.TRUE.toString()); - - PipedOutputStream pos = new PipedOutputStream(); - PipedInputStream pis = new PipedInputStream(pos); - BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(pos); - - Future f = r.execute(bdah); - - BodyDeferringInputStream is = new BodyDeferringInputStream(f, bdah, pis); - - Response resp = is.getAsapResponse(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals( - true, - resp.getHeader("content-length").equals( - String.valueOf(HALF_GIG))); - // "consume" the body, but our code needs input stream - CountingOutputStream cos = new CountingOutputStream(); - try { - copy(is, cos); - Assert.fail("InputStream consumption should fail with IOException!"); - } catch (IOException e) { - // good! - } - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testConnectionRefused() throws IOException, ExecutionException, - TimeoutException, InterruptedException { - int newPortWithoutAnyoneListening = findFreePort(); - AsyncHttpClient client = getAsyncHttpClient(getAsyncHttpClientConfig()); - AsyncHttpClient.BoundRequestBuilder r = client - .prepareGet("http://127.0.0.1/" + newPortWithoutAnyoneListening - + "/testConnectionRefused"); - - CountingOutputStream cos = new CountingOutputStream(); - BodyDeferringAsyncHandler bdah = new BodyDeferringAsyncHandler(cos); - r.execute(bdah); - try { - bdah.getResponse(); - Assert.fail("IOException should be thrown here!"); - } catch (IOException e) { - // good - } - - client.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/ByteBufferCapacityTest.java b/src/test/java/com/ning/http/client/async/ByteBufferCapacityTest.java deleted file mode 100644 index ea8e7134fb..0000000000 --- a/src/test/java/com/ning/http/client/async/ByteBufferCapacityTest.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.util.Enumeration; -import java.util.UUID; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.*; - -public abstract class ByteBufferCapacityTest extends AbstractBasicTest { - private static final File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc-tests-" - + UUID.randomUUID().toString().substring(0, 8)); - - private class BasicHandler extends AbstractHandler { - - public void handle(String s, - org.eclipse.jetty.server.Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); - } - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - final InputStream in = httpRequest.getInputStream(); - final OutputStream out = httpResponse.getOutputStream(); - int read; - while ((read = in.read(bytes)) != -1) { - out.write(bytes, 0, read); - } - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new BasicHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicByteBufferTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - final AtomicBoolean completed = new AtomicBoolean(false); - - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 * 100 * 10 / bytes.length) + 1; - File largeFile = createTempFile(bytes, (int) repeats); - final AtomicInteger byteReceived = new AtomicInteger(); - - try { - Response response = c.preparePut(getTargetUrl()).setBody(largeFile) - .execute(new AsyncCompletionHandlerAdapter() { - /* @Override */ - public STATE onBodyPartReceived(final HttpResponseBodyPart content) throws Exception { - byteReceived.addAndGet(content.getBodyByteBuffer().capacity()); - return super.onBodyPartReceived(content); - } - - }).get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(byteReceived.get(), largeFile.length()); - assertEquals(response.getResponseBody().length(), largeFile.length()); - - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - public String getTargetUrl() { - return String.format("http://127.0.0.1:%d/foo/test", port1); - } - - public static File createTempFile(byte[] pattern, int repeat) - throws IOException { - TMP.mkdirs(); - TMP.deleteOnExit(); - File tmpFile = File.createTempFile("tmpfile-", ".data", TMP); - write(pattern, repeat, tmpFile); - - return tmpFile; - } - - public static void write(byte[] pattern, int repeat, File file) - throws IOException { - file.deleteOnExit(); - file.getParentFile().mkdirs(); - FileOutputStream out = null; - try { - out = new FileOutputStream(file); - for (int i = 0; i < repeat; i++) { - out.write(pattern); - } - } - finally { - if (out != null) { - out.close(); - } - } - } -} diff --git a/src/test/java/com/ning/http/client/async/ChunkingTest.java b/src/test/java/com/ning/http/client/async/ChunkingTest.java deleted file mode 100644 index 1860da24d1..0000000000 --- a/src/test/java/com/ning/http/client/async/ChunkingTest.java +++ /dev/null @@ -1,175 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.generators.InputStreamBodyGenerator; -import org.testng.annotations.Test; - -import java.io.BufferedInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.InputStream; -import java.net.URL; -import java.util.Random; - -import static org.testng.Assert.assertNotNull; -import static org.testng.AssertJUnit.assertEquals; -import static org.testng.AssertJUnit.assertTrue; -import static org.testng.FileAssert.fail; - -/** - * Test that the url fetcher is able to communicate via a proxy - * - * @author dominict - */ -abstract public class ChunkingTest extends AbstractBasicTest { - // So we can just test the returned data is the image, - // and doesn't contain the chunked delimeters. - public static byte[] LARGE_IMAGE_BYTES; - - static { - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - InputStream instream = null; - try { - ClassLoader cl = ChunkingTest.class.getClassLoader(); - // override system properties - URL url = cl.getResource("300k.png"); - File sourceFile = new File(url.toURI()); - instream = new FileInputStream(sourceFile); - byte[] buf = new byte[8092]; - int len = 0; - while ((len = instream.read(buf)) > 0) { - baos.write(buf, 0, len); - } - LARGE_IMAGE_BYTES = baos.toByteArray(); - } - catch (Throwable e) { - LARGE_IMAGE_BYTES = new byte[265495]; - Random x = new Random(); - x.nextBytes(LARGE_IMAGE_BYTES); - } - } - - /** - * Tests that the custom chunked stream result in success and - * content returned that is unchunked - */ - @Test() - public void testCustomChunking() throws Throwable { - doTest(true); - } - - - private void doTest(boolean customChunkedInputStream) throws Exception { - AsyncHttpClient c = null; - try { - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setAllowPoolingConnection(true); - bc.setMaximumConnectionsPerHost(1); - bc.setMaximumConnectionsTotal(1); - bc.setConnectionTimeoutInMs(1000); - bc.setRequestTimeoutInMs(1000); - bc.setFollowRedirects(true); - - - c = getAsyncHttpClient(bc.build()); - - RequestBuilder builder = new RequestBuilder("POST"); - builder.setUrl(getTargetUrl()); - if (customChunkedInputStream) { - // made buff in stream big enough to mark. - builder.setBody(new InputStreamBodyGenerator(new BufferedInputStream(new FileInputStream(getTestFile()), 400000))); - } else { - // made buff in stream big enough to mark. - builder.setBody(new InputStreamBodyGenerator(new BufferedInputStream(new FileInputStream(getTestFile()), 400000))); - } - com.ning.http.client.Request r = builder.build(); - Response res = null; - - try { - ListenableFuture response = c.executeRequest(r); - res = response.get(); - assertNotNull(res.getResponseBodyAsStream()); - if (500 == res.getStatusCode()) { - System.out.println("=============="); - System.out.println("500 response from call"); - System.out.println("Headers:" + res.getHeaders()); - System.out.println("=============="); - System.out.flush(); - assertEquals("Should have 500 status code", 500, res.getStatusCode()); - assertTrue("Should have failed due to chunking", res.getHeader("X-Exception").contains("invalid.chunk.length")); - fail("HARD Failing the test due to provided InputStreamBodyGenerator, chunking incorrectly:" + res.getHeader("X-Exception")); - } else { - assertEquals(LARGE_IMAGE_BYTES, readInputStreamToBytes(res.getResponseBodyAsStream())); - } - } - catch (Exception e) { - - fail("Exception Thrown:" + e.getMessage()); - } - } - finally { - if (c != null) c.close(); - } - } - - private byte[] readInputStreamToBytes(InputStream stream) { - byte[] data = new byte[0]; - ByteArrayOutputStream buffer = new ByteArrayOutputStream(); - try { - int nRead; - byte[] tmp = new byte[8192]; - - while ((nRead = stream.read(tmp, 0, tmp.length)) != -1) { - buffer.write(tmp, 0, nRead); - } - buffer.flush(); - data = buffer.toByteArray(); - } - catch (Exception e) { - - } - finally { - try { - stream.close(); - } catch (Exception e2) { - } - return data; - } - } - - private static File getTestFile() { - String testResource1 = "300k.png"; - - File testResource1File = null; - try { - ClassLoader cl = ChunkingTest.class.getClassLoader(); - URL url = cl.getResource(testResource1); - testResource1File = new File(url.toURI()); - } catch (Throwable e) { - // TODO Auto-generated catch block - fail("unable to find " + testResource1); - } - - return testResource1File; - } - -} diff --git a/src/test/java/com/ning/http/client/async/ComplexClientTest.java b/src/test/java/com/ning/http/client/async/ComplexClientTest.java deleted file mode 100644 index 6b7a30ffa5..0000000000 --- a/src/test/java/com/ning/http/client/async/ComplexClientTest.java +++ /dev/null @@ -1,68 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Response; -import org.testng.annotations.Test; - -import java.util.concurrent.TimeUnit; - -import static org.testng.Assert.assertEquals; - -public abstract class ComplexClientTest extends AbstractBasicTest { - - @Test(groups = {"standalone", "default_provider"}) - public void multipleRequestsTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - String body = "hello there"; - - // once - Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - - // twice - response = c.preparePost(getTargetUrl()) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void urlWithoutSlashTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - String body = "hello there"; - - // once - Response response = c.preparePost(String.format("http://127.0.0.1:%d/foo/test", port1)) - .setBody(body) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - c.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/ConnectionPoolTest.java b/src/test/java/com/ning/http/client/async/ConnectionPoolTest.java deleted file mode 100644 index 8f02356c90..0000000000 --- a/src/test/java/com/ning/http/client/async/ConnectionPoolTest.java +++ /dev/null @@ -1,362 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ConnectionsPool; -import com.ning.http.client.Response; -import org.jboss.netty.channel.Channel; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.io.IOException; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.fail; - -public abstract class ConnectionPoolTest extends AbstractBasicTest { - protected final Logger log = LoggerFactory.getLogger(AbstractBasicTest.class); - - @Test(groups = {"standalone", "default_provider"}) - public void testMaxTotalConnections() { - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setAllowPoolingConnection(true) - .setMaximumConnectionsTotal(1) - .build() - ); - - String url = getTargetUrl(); - int i; - Exception exception = null; - for (i = 0; i < 3; i++) { - try { - log.info("{} requesting url [{}]...", i, url); - Response response = client.prepareGet(url).execute().get(); - log.info("{} response [{}].", i, response); - } catch (Exception ex) { - exception = ex; - } - } - assertNull(exception); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testMaxTotalConnectionsException() { - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setAllowPoolingConnection(true) - .setMaximumConnectionsTotal(1) - .build() - ); - - String url = getTargetUrl(); - int i; - Exception exception = null; - for (i = 0; i < 20; i++) { - try { - log.info("{} requesting url [{}]...", i, url); - - if (i < 5) { - client.prepareGet(url).execute().get(); - } else { - client.prepareGet(url).execute(); - } - } catch (Exception ex) { - exception = ex; - break; - } - } - assertNotNull(exception); - assertNotNull(exception.getMessage()); - assertEquals(exception.getMessage(),"Too many connections 1"); - } - - @Test(groups = {"standalone", "default_provider", "async"}, enabled = true, invocationCount = 10, alwaysRun = true) - public void asyncDoGetKeepAliveHandlerTest_channelClosedDoesNotFail() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - // Use a l in case the assert fail - final CountDownLatch l = new CountDownLatch(2); - - final Map remoteAddresses = new - ConcurrentHashMap(); - - AsyncCompletionHandler handler = new - AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws - Exception { - System.out.println("ON COMPLETED INVOKED " + - response.getHeader("X-KEEP-ALIVE")); - try { - assertEquals(response.getStatusCode(), 200); - remoteAddresses.put(response.getHeader("X-KEEP-ALIVE"), true); - } finally { - l.countDown(); - } - return response; - } - }; - - client.prepareGet(getTargetUrl()).execute(handler).get(); - server.stop(); - server.start(); - client.prepareGet(getTargetUrl()).execute(handler); - - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timed out"); - } - - assertEquals(remoteAddresses.size(), 2); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testInvalidConnectionsPool() { - - ConnectionsPool cp = new ConnectionsPool() { - - public boolean offer(String key, Channel connection) { - return false; - } - - public Channel poll(String connection) { - return null; - } - - public boolean removeAll(Channel connection) { - return false; - } - - public boolean canCacheConnection() { - return false; - } - - public void destroy() { - - } - }; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionsPool(cp) - .build() - ); - - Exception exception = null; - try { - client.prepareGet(getTargetUrl()).execute().get(TIMEOUT, TimeUnit.SECONDS); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNotNull(exception); - assertEquals(exception.getMessage(), "Too many connections -1"); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testValidConnectionsPool() { - - ConnectionsPool cp = new ConnectionsPool() { - - public boolean offer(String key, Channel connection) { - return true; - } - - public Channel poll(String connection) { - return null; - } - - public boolean removeAll(Channel connection) { - return false; - } - - public boolean canCacheConnection() { - return true; - } - - public void destroy() { - - } - }; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionsPool(cp) - .build() - ); - - Exception exception = null; - try { - client.prepareGet(getTargetUrl()).execute().get(TIMEOUT, TimeUnit.SECONDS); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNull(exception); - client.close(); - } - - - @Test(groups = {"standalone", "default_provider"}) - public void multipleMaxConnectionOpenTest() throws Throwable { - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setAllowPoolingConnection(true) - .setConnectionTimeoutInMs(5000).setMaximumConnectionsTotal(1).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - String body = "hello there"; - - // once - Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - - // twice - Exception exception = null; - try { - c.preparePost(String.format("http://127.0.0.1:%d/foo/test", port2)).setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); - fail("Should throw exception. Too many connections issued."); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNotNull(exception); - assertEquals(exception.getMessage(), "Too many connections 1"); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void multipleMaxConnectionOpenTestWithQuery() throws Throwable { - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setAllowPoolingConnection(true) - .setConnectionTimeoutInMs(5000).setMaximumConnectionsTotal(1).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - String body = "hello there"; - - // once - Response response = c.preparePost(getTargetUrl() + "?foo=bar") - .setBody(body) - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), "foo_" + body); - - // twice - Exception exception = null; - try { - response = c.preparePost(getTargetUrl()).setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNull(exception); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - c.close(); - } - - /** - * This test just make sure the hack used to catch disconnected channel under win7 doesn't throw any exception. - * The onComplete method must be only called once. - * - * @throws Throwable if something wrong happens. - */ - @Test(groups = {"standalone", "default_provider"}) - public void win7DisconnectTest() throws Throwable { - final AtomicInteger count = new AtomicInteger(0); - - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - AsyncCompletionHandler handler = new - AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws - Exception { - - count.incrementAndGet(); - StackTraceElement e = new StackTraceElement("sun.nio.ch.SocketDispatcher", "read0", null, -1); - IOException t = new IOException(); - t.setStackTrace(new StackTraceElement[]{e}); - throw t; - } - }; - - try { - client.prepareGet(getTargetUrl()).execute(handler).get(); - fail("Must have received an exception"); - } catch (ExecutionException ex) { - assertNotNull(ex); - assertNotNull(ex.getCause()); - assertEquals(ex.getCause().getCause().getClass(), IOException.class); - assertEquals(count.get(), 1); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void asyncHandlerOnThrowableTest() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final AtomicInteger count = new AtomicInteger(); - final String THIS_IS_NOT_FOR_YOU = "This is not for you"; - final CountDownLatch latch = new CountDownLatch(16); - for (int i = 0; i < 16; i++) { - client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerBase() { - @Override - public Response onCompleted(Response response) throws Exception { - throw new Exception(THIS_IS_NOT_FOR_YOU); - } - }); - - client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandlerBase() { - /* @Override */ - public void onThrowable(Throwable t) { - if (t.getMessage() != null && t.getMessage().equalsIgnoreCase(THIS_IS_NOT_FOR_YOU)) { - count.incrementAndGet(); - } - } - - @Override - public Response onCompleted(Response response) throws Exception { - latch.countDown(); - return response; - } - }); - } - latch.await(TIMEOUT, TimeUnit.SECONDS); - assertEquals(count.get(), 0); - client.close(); - } - -} - diff --git a/src/test/java/com/ning/http/client/async/DigestAuthTest.java b/src/test/java/com/ning/http/client/async/DigestAuthTest.java deleted file mode 100644 index 293139e107..0000000000 --- a/src/test/java/com/ning/http/client/async/DigestAuthTest.java +++ /dev/null @@ -1,169 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Realm; -import com.ning.http.client.Response; -import org.apache.log4j.ConsoleAppender; -import org.apache.log4j.Level; -import org.apache.log4j.Logger; -import org.apache.log4j.PatternLayout; -import org.eclipse.jetty.security.ConstraintMapping; -import org.eclipse.jetty.security.ConstraintSecurityHandler; -import org.eclipse.jetty.security.HashLoginService; -import org.eclipse.jetty.security.LoginService; -import org.eclipse.jetty.security.authentication.DigestAuthenticator; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.util.security.Constraint; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.HashSet; -import java.util.List; -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 static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class DigestAuthTest extends AbstractBasicTest { - - private final static String user = "user"; - private final static String admin = "admin"; - - @BeforeClass(alwaysRun = true) - @Override - public void setUpGlobal() throws Exception { - server = new Server(); - Logger root = Logger.getRootLogger(); - root.setLevel(Level.DEBUG); - root.addAppender(new ConsoleAppender( - new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN))); - - port1 = findFreePort(); - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - LoginService loginService = new HashLoginService("MyRealm", "src/test/resources/realm.properties"); - server.addBean(loginService); - - Constraint constraint = new Constraint(); - constraint.setName(Constraint.__BASIC_AUTH); - constraint.setRoles(new String[]{user, admin}); - constraint.setAuthenticate(true); - - ConstraintMapping mapping = new ConstraintMapping(); - mapping.setConstraint(constraint); - mapping.setPathSpec("/*"); - - List cm = new ArrayList(); - cm.add(mapping); - - Set knownRoles = new HashSet(); - knownRoles.add(user); - knownRoles.add(admin); - - ConstraintSecurityHandler security = new ConstraintSecurityHandler(); - security.setConstraintMappings(cm, knownRoles); - security.setAuthenticator(new DigestAuthenticator()); - security.setLoginService(loginService); - security.setStrict(false); - - security.setHandler(configureHandler()); - server.setHandler(security); - server.start(); - log.info("Local HTTP server started successfully"); - } - - private class SimpleHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - - response.addHeader("X-Auth", request.getHeader("Authorization")); - response.setStatus(200); - response.getOutputStream().flush(); - response.getOutputStream().close(); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void digestAuthTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet("http://127.0.0.1/" + port1 + "/") - .setRealm((new Realm.RealmBuilder()).setPrincipal(user) - .setPassword(admin) - .setRealmName("MyRealm") - .setScheme(Realm.AuthScheme.DIGEST).build()); - - Future f = r.execute(); - Response resp = f.get(60, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertNotNull(resp.getHeader("X-Auth")); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void digestAuthTestWithoutScheme() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet("http://127.0.0.1/" + port1 + "/") - .setRealm((new Realm.RealmBuilder()).setPrincipal(user) - .setPassword(admin) - .setRealmName("MyRealm").build()); - - Future f = r.execute(); - Response resp = f.get(60, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertNotNull(resp.getHeader("X-Auth")); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void digestAuthNegativeTest() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - AsyncHttpClient.BoundRequestBuilder r = client.prepareGet("http://127.0.0.1/" + port1 + "/") - .setRealm((new Realm.RealmBuilder()).setPrincipal("fake").setPassword(admin).setScheme(Realm.AuthScheme.DIGEST).build()); - - Future f = r.execute(); - Response resp = f.get(20, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), 401); - client.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new SimpleHandler(); - } -} diff --git a/src/test/java/com/ning/http/client/async/EmptyBodyTest.java b/src/test/java/com/ning/http/client/async/EmptyBodyTest.java deleted file mode 100644 index 873e1bba88..0000000000 --- a/src/test/java/com/ning/http/client/async/EmptyBodyTest.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.InputStream; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.LinkedBlockingQueue; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertFalse; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.assertNotNull; - -import static org.testng.Assert.fail; - -/** - * Tests case where response doesn't have body. - * - * @author Hubert Iwaniuk - */ -public abstract class EmptyBodyTest extends AbstractBasicTest { - private class NoBodyResponseHandler extends AbstractHandler { - public void handle( - String s, - Request request, - HttpServletRequest req, - HttpServletResponse resp) - throws IOException, ServletException { - - if (!req.getMethod().equalsIgnoreCase("PUT")) { - resp.setStatus(HttpServletResponse.SC_OK); - } else { - resp.setStatus(204); - } - request.setHandled(true); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new NoBodyResponseHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testEmptyBody() throws IOException { - AsyncHttpClient ahc = getAsyncHttpClient(null); - final AtomicBoolean err = new AtomicBoolean(false); - final LinkedBlockingQueue queue = new LinkedBlockingQueue(); - final AtomicBoolean status = new AtomicBoolean(false); - final AtomicInteger headers = new AtomicInteger(0); - final CountDownLatch latch = new CountDownLatch(1); - ahc.executeRequest(ahc.prepareGet(getTargetUrl()).build(), new AsyncHandler() { - public void onThrowable(Throwable t) { - fail("Got throwable.", t); - err.set(true); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart e) throws Exception { - String s = new String(e.getBodyPartBytes()); - log.info("got part: {}", s); - if (s.equals("")) { - //noinspection ThrowableInstanceNeverThrown - log.warn("Sampling stacktrace.", - new Throwable("trace that, we should not get called for empty body.")); - } - queue.put(s); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus e) throws Exception { - status.set(true); - return AsyncHandler.STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders e) throws Exception { - if (headers.incrementAndGet() == 2) { - throw new Exception("Analyze this."); - } - return STATE.CONTINUE; - } - - public Object onCompleted() throws Exception { - latch.countDown(); - return null; - } - }); - try { - assertTrue(latch.await(1, TimeUnit.SECONDS), "Latch failed."); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } - assertFalse(err.get()); - assertEquals(queue.size(), 0); - assertTrue(status.get()); - assertEquals(headers.get(), 1); - ahc.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testPutEmptyBody() throws Throwable { - AsyncHttpClient ahc = getAsyncHttpClient(null); - Response response = ahc.preparePut(getTargetUrl()).setBody("String").execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 204); - assertEquals(response.getResponseBody(), ""); - assertTrue(InputStream.class.isAssignableFrom(response.getResponseBodyAsStream().getClass())); - assertEquals(response.getResponseBodyAsStream().read(), -1); - - ahc.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/Expect100ContinueTest.java b/src/test/java/com/ning/http/client/async/Expect100ContinueTest.java deleted file mode 100644 index 8ebb82d34c..0000000000 --- a/src/test/java/com/ning/http/client/async/Expect100ContinueTest.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.IOException; -import java.net.URL; -import java.util.concurrent.Future; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -/** - * Test the Expect: 100-Continue. - */ -public abstract class Expect100ContinueTest extends AbstractBasicTest { - - private class ZeroCopyHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - final int read = httpRequest.getInputStream().read(bytes); - httpResponse.getOutputStream().write(bytes, 0, read); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void Expect100Continue() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - - ClassLoader cl = getClass().getClassLoader(); - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - Future f = client.preparePut("http://127.0.0.1/" + port1 + "/").setHeader("Expect", "100-continue").setBody(file).execute(); - Response resp = f.get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "This is a simple test file"); - client.close(); - - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new ZeroCopyHandler(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/FilePartLargeFileTest.java b/src/test/java/com/ning/http/client/async/FilePartLargeFileTest.java deleted file mode 100644 index 87dd3aa377..0000000000 --- a/src/test/java/com/ning/http/client/async/FilePartLargeFileTest.java +++ /dev/null @@ -1,160 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClient.BoundRequestBuilder; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.FilePart; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.Assert; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.ServletInputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.net.URL; -import java.util.UUID; - -import static org.testng.FileAssert.fail; - -public abstract class FilePartLargeFileTest - extends AbstractBasicTest { - - private File largeFile; - - @Test(groups = {"standalone", "default_provider"}, enabled = true) - public void testPutImageFile() - throws Exception { - largeFile = getTestFile(); - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(100 * 6000).build(); - AsyncHttpClient client = getAsyncHttpClient(config); - BoundRequestBuilder rb = client.preparePut(getTargetUrl()); - - rb.addBodyPart(new FilePart("test", largeFile, "application/octet-stream" , "UTF-8")); - - Response response = rb.execute().get(); - Assert.assertEquals(200, response.getStatusCode()); - - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}, enabled = true) - public void testPutLargeTextFile() - throws Exception { - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 * 1024 / bytes.length) + 1; - largeFile = createTempFile(bytes, (int) repeats); - - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient client = getAsyncHttpClient(config); - BoundRequestBuilder rb = client.preparePut(getTargetUrl()); - - rb.addBodyPart(new FilePart("test", largeFile, "application/octet-stream" , "UTF-8")); - - Response response = rb.execute().get(); - Assert.assertEquals(200, response.getStatusCode()); - client.close(); - } - - private static File getTestFile() { - String testResource1 = "300k.png"; - - File testResource1File = null; - try { - ClassLoader cl = ChunkingTest.class.getClassLoader(); - URL url = cl.getResource(testResource1); - testResource1File = new File(url.toURI()); - } catch (Throwable e) { - // TODO Auto-generated catch block - fail("unable to find " + testResource1); - } - - return testResource1File; - } - - @AfterMethod - public void after() { - largeFile.delete(); - } - - @Override - public AbstractHandler configureHandler() - throws Exception { - return new AbstractHandler() { - - public void handle(String arg0, Request arg1, HttpServletRequest req, HttpServletResponse resp) - throws IOException, ServletException { - - ServletInputStream in = req.getInputStream(); - byte[] b = new byte[8192]; - - int count = -1; - int total = 0; - while ((count = in.read(b)) != -1) { - b = new byte[8192]; - total += count; - } - System.err.println("consumed " + total + " bytes."); - - resp.setStatus(200); - resp.addHeader("X-TRANFERED", String.valueOf(total)); - resp.getOutputStream().flush(); - resp.getOutputStream().close(); - - arg1.setHandled(true); - - } - }; - } - - private static final File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc-tests-" - + UUID.randomUUID().toString().substring(0, 8)); - - public static File createTempFile(byte[] pattern, int repeat) - throws IOException { - TMP.mkdirs(); - TMP.deleteOnExit(); - File tmpFile = File.createTempFile("tmpfile-", ".data", TMP); - tmpFile.deleteOnExit(); - write(pattern, repeat, tmpFile); - - return tmpFile; - } - - public static void write(byte[] pattern, int repeat, File file) - throws IOException { - file.deleteOnExit(); - file.getParentFile().mkdirs(); - FileOutputStream out = null; - try { - out = new FileOutputStream(file); - for (int i = 0; i < repeat; i++) { - out.write(pattern); - } - } - finally { - if (out != null) { - out.close(); - } - } - } - -} diff --git a/src/test/java/com/ning/http/client/async/FilterTest.java b/src/test/java/com/ning/http/client/async/FilterTest.java deleted file mode 100644 index 6932087dac..0000000000 --- a/src/test/java/com/ning/http/client/async/FilterTest.java +++ /dev/null @@ -1,250 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.extra.ThrottleRequestFilter; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.ResponseFilter; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Enumeration; -import java.util.List; -import java.util.concurrent.Future; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.fail; - -public abstract class FilterTest extends AbstractBasicTest { - - private class BasicHandler extends AbstractHandler { - - public void handle(String s, - org.eclipse.jetty.server.Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - httpResponse.addHeader(param, httpRequest.getHeader(param)); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new BasicHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.addRequestFilter(new ThrottleRequestFilter(100)); - - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - Response response = c.preparePost(getTargetUrl()) - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void loadThrottleTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.addRequestFilter(new ThrottleRequestFilter(10)); - - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - List> futures = new ArrayList>(); - for (int i = 0; i < 200; i++) { - futures.add(c.preparePost(getTargetUrl()).execute()); - } - - for (Future f : futures) { - Response r = f.get(); - assertNotNull(f.get()); - assertEquals(r.getStatusCode(), 200); - } - - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void maxConnectionsText() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.addRequestFilter(new ThrottleRequestFilter(0, 1000)); - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - try { - Response response = c.preparePost(getTargetUrl()) - .execute().get(); - fail("Should have timed out"); - } catch (IOException ex) { - assertNotNull(ex); - assertEquals(ex.getCause().getClass(), FilterException.class); - } - c.close(); - } - - public String getTargetUrl() { - return String.format("http://127.0.0.1:%d/foo/test", port1); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicResponseFilterTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.addResponseFilter(new ResponseFilter() { - - public FilterContext filter(FilterContext ctx) throws FilterException { - return ctx; - } - - }); - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - try { - Response response = c.preparePost(getTargetUrl()) - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void replayResponseFilterTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - final AtomicBoolean replay = new AtomicBoolean(true); - - b.addResponseFilter(new ResponseFilter() { - - public FilterContext filter(FilterContext ctx) throws FilterException { - - if (replay.getAndSet(false)) { - Request request = new RequestBuilder(ctx.getRequest()).addHeader("X-Replay", "true").build(); - return new FilterContext.FilterContextBuilder().asyncHandler(ctx.getAsyncHandler()).request(request).replayRequest(true).build(); - } - return ctx; - } - - }); - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - try { - Response response = c.preparePost(getTargetUrl()) - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-Replay"), "true"); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void replayStatusCodeResponseFilterTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - final AtomicBoolean replay = new AtomicBoolean(true); - - b.addResponseFilter(new ResponseFilter() { - - public FilterContext filter(FilterContext ctx) throws FilterException { - - if (ctx.getResponseStatus() != null && ctx.getResponseStatus().getStatusCode() == 200 && replay.getAndSet(false)) { - Request request = new RequestBuilder(ctx.getRequest()).addHeader("X-Replay", "true").build(); - return new FilterContext.FilterContextBuilder().asyncHandler(ctx.getAsyncHandler()).request(request).replayRequest(true).build(); - } - return ctx; - } - - }); - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - try { - Response response = c.preparePost(getTargetUrl()) - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-Replay"), "true"); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void replayHeaderResponseFilterTest() throws Throwable { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - final AtomicBoolean replay = new AtomicBoolean(true); - - b.addResponseFilter(new ResponseFilter() { - - public FilterContext filter(FilterContext ctx) throws FilterException { - - if (ctx.getResponseHeaders() != null - && ctx.getResponseHeaders().getHeaders().getFirstValue("Ping").equals("Pong") - && replay.getAndSet(false)) { - - Request request = new RequestBuilder(ctx.getRequest()).addHeader("Ping", "Pong").build(); - return new FilterContext.FilterContextBuilder() - .asyncHandler(ctx.getAsyncHandler()) - .request(request) - .replayRequest(true) - .build(); - } - return ctx; - } - - }); - AsyncHttpClient c = getAsyncHttpClient(b.build()); - - try { - Response response = c.preparePost(getTargetUrl()).addHeader("Ping", "Pong") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("Ping"), "Pong"); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/FluentCaseInsensitiveStringsMapTest.java b/src/test/java/com/ning/http/client/async/FluentCaseInsensitiveStringsMapTest.java deleted file mode 100644 index 69e90e4e34..0000000000 --- a/src/test/java/com/ning/http/client/async/FluentCaseInsensitiveStringsMapTest.java +++ /dev/null @@ -1,624 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import org.testng.annotations.Test; - -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.Map; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; - -public class FluentCaseInsensitiveStringsMapTest { - @Test - public void emptyTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - assertTrue(map.keySet().isEmpty()); - } - - @Test - public void normalTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void nameCaseTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("fOO", "bAr"); - map.add("Baz", Arrays.asList("fOo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("fOO", "Baz"))); - - assertEquals(map.getFirstValue("fOO"), "bAr"); - assertEquals(map.getJoinedValue("fOO", ", "), "bAr"); - assertEquals(map.get("fOO"), Arrays.asList("bAr")); - assertEquals(map.getFirstValue("foo"), "bAr"); - assertEquals(map.getJoinedValue("foo", ", "), "bAr"); - assertEquals(map.get("foo"), Arrays.asList("bAr")); - assertEquals(map.getFirstValue("FOO"), "bAr"); - assertEquals(map.getJoinedValue("FOO", ", "), "bAr"); - assertEquals(map.get("FOO"), Arrays.asList("bAr")); - - assertEquals(map.getFirstValue("Baz"), "fOo"); - assertEquals(map.getJoinedValue("Baz", ", "), "fOo, bar"); - assertEquals(map.get("Baz"), Arrays.asList("fOo", "bar")); - assertEquals(map.getFirstValue("baz"), "fOo"); - assertEquals(map.getJoinedValue("baz", ", "), "fOo, bar"); - assertEquals(map.get("baz"), Arrays.asList("fOo", "bar")); - assertEquals(map.getFirstValue("BAZ"), "fOo"); - assertEquals(map.getJoinedValue("BAZ", ", "), "fOo, bar"); - assertEquals(map.get("BAZ"), Arrays.asList("fOo", "bar")); - } - - @Test - public void sameKeyMultipleTimesTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "baz,foo"); - map.add("Foo", Arrays.asList("bar")); - map.add("fOO", "bla", "blubb"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo, bar, bla, blubb"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo", "bar", "bla", "blubb")); - assertEquals(map.getFirstValue("Foo"), "baz,foo"); - assertEquals(map.getJoinedValue("Foo", ", "), "baz,foo, bar, bla, blubb"); - assertEquals(map.get("Foo"), Arrays.asList("baz,foo", "bar", "bla", "blubb")); - assertEquals(map.getFirstValue("fOO"), "baz,foo"); - assertEquals(map.getJoinedValue("fOO", ", "), "baz,foo, bar, bla, blubb"); - assertEquals(map.get("fOO"), Arrays.asList("baz,foo", "bar", "bla", "blubb")); - } - - @Test - public void emptyValueTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", ""); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), ""); - assertEquals(map.getJoinedValue("foo", ", "), ""); - assertEquals(map.get("foo"), Arrays.asList("")); - } - - @Test - public void nullValueTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", (String) null); - - assertEquals(map.getFirstValue("foo"), ""); - assertEquals(map.getJoinedValue("foo", ", "), ""); - assertEquals(map.get("foo").size(), 1); - } - - @Test - public void mapConstructorTest() { - Map> headerMap = new LinkedHashMap>(); - - headerMap.put("foo", Arrays.asList("baz,foo")); - headerMap.put("baz", Arrays.asList("bar")); - headerMap.put("bar", Arrays.asList("bla", "blubb")); - - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(headerMap); - - headerMap.remove("foo"); - headerMap.remove("bar"); - headerMap.remove("baz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo")); - assertEquals(map.getFirstValue("baz"), "bar"); - assertEquals(map.getJoinedValue("baz", ", "), "bar"); - assertEquals(map.get("baz"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "bla"); - assertEquals(map.getJoinedValue("bar", ", "), "bla, blubb"); - assertEquals(map.get("bar"), Arrays.asList("bla", "blubb")); - } - - @Test - public void mapConstructorNullTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap((Map>) null); - - assertEquals(map.keySet().size(), 0); - } - - @Test - public void copyConstructorTest() { - FluentCaseInsensitiveStringsMap srcHeaders = new FluentCaseInsensitiveStringsMap(); - - srcHeaders.add("foo", "baz,foo"); - srcHeaders.add("baz", Arrays.asList("bar")); - srcHeaders.add("bar", "bla", "blubb"); - - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(srcHeaders); - - srcHeaders.delete("foo"); - srcHeaders.delete("bar"); - srcHeaders.delete("baz"); - assertTrue(srcHeaders.keySet().isEmpty()); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo")); - assertEquals(map.getFirstValue("baz"), "bar"); - assertEquals(map.getJoinedValue("baz", ", "), "bar"); - assertEquals(map.get("baz"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "bla"); - assertEquals(map.getJoinedValue("bar", ", "), "bla, blubb"); - assertEquals(map.get("bar"), Arrays.asList("bla", "blubb")); - } - - @Test - public void copyConstructorNullTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap((FluentCaseInsensitiveStringsMap) null); - - assertEquals(map.keySet().size(), 0); - } - - @Test - public void deleteTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete("bAz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteUndefinedKeyTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete("bar"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteNullTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete(null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteAllArrayTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll("bAz", "Boo"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteAllCollectionTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll(Arrays.asList("bAz", "fOO")); - - assertEquals(map.keySet(), Collections.emptyList()); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteAllNullArrayTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll((String[]) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteAllNullCollectionTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll((Collection) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("Foo", "blub", "bla"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("Foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "blub"); - assertEquals(map.getJoinedValue("foo", ", "), "blub, bla"); - assertEquals(map.get("foo"), Arrays.asList("blub", "bla")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceUndefinedTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("bar", Arrays.asList("blub")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - assertEquals(map.getFirstValue("bar"), "blub"); - assertEquals(map.getJoinedValue("bar", ", "), "blub"); - assertEquals(map.get("bar"), Arrays.asList("blub")); - } - - @Test - public void replaceNullTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace(null, Arrays.asList("blub")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceValueWithNullTest() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("baZ", (Collection) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void replaceAllMapTest1() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll(new FluentCaseInsensitiveStringsMap().add("Bar", "baz").add("Boo", "blub", "bla")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "Bar", "baz", "Boo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "baz"); - assertEquals(map.getJoinedValue("bar", ", "), "baz"); - assertEquals(map.get("bar"), Arrays.asList("baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - assertEquals(map.getFirstValue("Boo"), "blub"); - assertEquals(map.getJoinedValue("Boo", ", "), "blub, bla"); - assertEquals(map.get("Boo"), Arrays.asList("blub", "bla")); - } - - @Test - public void replaceAllTest2() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - LinkedHashMap> newValues = new LinkedHashMap>(); - - newValues.put("Bar", Arrays.asList("baz")); - newValues.put("Foo", null); - map.replaceAll(newValues); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("Bar", "baz"))); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - assertEquals(map.getFirstValue("bar"), "baz"); - assertEquals(map.getJoinedValue("bar", ", "), "baz"); - assertEquals(map.get("bar"), Arrays.asList("baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceAllNullTest1() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll((FluentCaseInsensitiveStringsMap) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceAllNullTest2() { - FluentCaseInsensitiveStringsMap map = new FluentCaseInsensitiveStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll((Map>) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } -} diff --git a/src/test/java/com/ning/http/client/async/FluentStringsMapTest.java b/src/test/java/com/ning/http/client/async/FluentStringsMapTest.java deleted file mode 100644 index d6c6795985..0000000000 --- a/src/test/java/com/ning/http/client/async/FluentStringsMapTest.java +++ /dev/null @@ -1,754 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.FluentStringsMap; -import org.testng.annotations.Test; - -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.Map; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; - -public class FluentStringsMapTest { - @Test - public void emptyTest() { - FluentStringsMap map = new FluentStringsMap(); - - assertTrue(map.keySet().isEmpty()); - } - - @Test - public void normalTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("fOO", "bAr"); - map.add("Baz", Arrays.asList("fOo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("fOO", "Baz"))); - - assertEquals(map.getFirstValue("fOO"), "bAr"); - assertEquals(map.getJoinedValue("fOO", ", "), "bAr"); - assertEquals(map.get("fOO"), Arrays.asList("bAr")); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - - assertEquals(map.getFirstValue("Baz"), "fOo"); - assertEquals(map.getJoinedValue("Baz", ", "), "fOo, bar"); - assertEquals(map.get("Baz"), Arrays.asList("fOo", "bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void addNullTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("fOO", "bAr"); - map.add(null, Arrays.asList("fOo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("fOO"))); - - assertEquals(map.getFirstValue("fOO"), "bAr"); - assertEquals(map.getJoinedValue("fOO", ", "), "bAr"); - assertEquals(map.get("fOO"), Arrays.asList("bAr")); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - - assertNull(map.getFirstValue(null)); - assertNull(map.getJoinedValue("Baz", ", ")); - assertNull(map.get(null)); - } - - @Test - public void sameKeyMultipleTimesTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "baz,foo"); - map.add("foo", Arrays.asList("bar")); - map.add("foo", "bla", "blubb"); - map.add("fOO", "duh"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "fOO"))); - - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo, bar, bla, blubb"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo", "bar", "bla", "blubb")); - assertEquals(map.getFirstValue("fOO"), "duh"); - assertEquals(map.getJoinedValue("fOO", ", "), "duh"); - assertEquals(map.get("fOO"), Arrays.asList("duh")); - } - - @Test - public void emptyValueTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", ""); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), ""); - assertEquals(map.getJoinedValue("foo", ", "), ""); - assertEquals(map.get("foo"), Arrays.asList("")); - } - - @Test - public void nullValueTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", (String) null); - - assertEquals(map.getFirstValue("foo"), ""); - assertEquals(map.getJoinedValue("foo", ", "), ""); - assertEquals(map.get("foo").size(), 1); - } - - @Test - public void mapConstructorTest() { - Map> headerMap = new LinkedHashMap>(); - - headerMap.put("foo", Arrays.asList("baz,foo")); - headerMap.put("baz", Arrays.asList("bar")); - headerMap.put("bar", Arrays.asList("bla", "blubb")); - - FluentStringsMap map = new FluentStringsMap(headerMap); - - headerMap.remove("foo"); - headerMap.remove("bar"); - headerMap.remove("baz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo")); - assertEquals(map.getFirstValue("baz"), "bar"); - assertEquals(map.getJoinedValue("baz", ", "), "bar"); - assertEquals(map.get("baz"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "bla"); - assertEquals(map.getJoinedValue("bar", ", "), "bla, blubb"); - assertEquals(map.get("bar"), Arrays.asList("bla", "blubb")); - } - - @Test - public void mapConstructorNullTest() { - FluentStringsMap map = new FluentStringsMap((Map>) null); - - assertEquals(map.keySet().size(), 0); - } - - @Test - public void copyConstructorTest() { - FluentStringsMap srcHeaders = new FluentStringsMap(); - - srcHeaders.add("foo", "baz,foo"); - srcHeaders.add("baz", Arrays.asList("bar")); - srcHeaders.add("bar", "bla", "blubb"); - - FluentStringsMap map = new FluentStringsMap(srcHeaders); - - srcHeaders.delete("foo"); - srcHeaders.delete("bar"); - srcHeaders.delete("baz"); - assertTrue(srcHeaders.keySet().isEmpty()); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "baz,foo"); - assertEquals(map.getJoinedValue("foo", ", "), "baz,foo"); - assertEquals(map.get("foo"), Arrays.asList("baz,foo")); - assertEquals(map.getFirstValue("baz"), "bar"); - assertEquals(map.getJoinedValue("baz", ", "), "bar"); - assertEquals(map.get("baz"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "bla"); - assertEquals(map.getJoinedValue("bar", ", "), "bla, blubb"); - assertEquals(map.get("bar"), Arrays.asList("bla", "blubb")); - } - - @Test - public void copyConstructorNullTest() { - FluentStringsMap map = new FluentStringsMap((FluentStringsMap) null); - - assertEquals(map.keySet().size(), 0); - } - - @Test - public void deleteTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete("baz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteTestDifferentCase() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete("bAz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteUndefinedKeyTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete("bar"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteNullTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.delete(null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteAllArrayTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll("baz", "Boo"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteAllArrayDifferentCaseTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll("Foo", "baz"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteAllCollectionTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll(Arrays.asList("baz", "foo")); - - assertEquals(map.keySet(), Collections.emptyList()); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void deleteAllCollectionDifferentCaseTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll(Arrays.asList("bAz", "fOO")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteAllNullArrayTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll((String[]) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void deleteAllNullCollectionTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.deleteAll((Collection) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceArrayTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("foo", "blub", "bla"); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "blub"); - assertEquals(map.getJoinedValue("foo", ", "), "blub, bla"); - assertEquals(map.get("foo"), Arrays.asList("blub", "bla")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceCollectionTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("foo", Arrays.asList("blub", "bla")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "blub"); - assertEquals(map.getJoinedValue("foo", ", "), "blub, bla"); - assertEquals(map.get("foo"), Arrays.asList("blub", "bla")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceDifferentCaseTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("Foo", Arrays.asList("blub", "bla")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "Foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - assertEquals(map.getFirstValue("Foo"), "blub"); - assertEquals(map.getJoinedValue("Foo", ", "), "blub, bla"); - assertEquals(map.get("Foo"), Arrays.asList("blub", "bla")); - } - - @Test - public void replaceUndefinedTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("bar", Arrays.asList("blub")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz", "bar"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - assertEquals(map.getFirstValue("bar"), "blub"); - assertEquals(map.getJoinedValue("bar", ", "), "blub"); - assertEquals(map.get("bar"), Arrays.asList("blub")); - } - - @Test - public void replaceNullTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace(null, Arrays.asList("blub")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceValueWithNullTest() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replace("baz", (Collection) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertNull(map.getFirstValue("baz")); - assertNull(map.getJoinedValue("baz", ", ")); - assertNull(map.get("baz")); - } - - @Test - public void replaceAllMapTest1() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll(new FluentStringsMap().add("bar", "baz").add("Foo", "blub", "bla")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz", "Foo"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "baz"); - assertEquals(map.getJoinedValue("bar", ", "), "baz"); - assertEquals(map.get("bar"), Arrays.asList("baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - assertEquals(map.getFirstValue("Foo"), "blub"); - assertEquals(map.getJoinedValue("Foo", ", "), "blub, bla"); - assertEquals(map.get("Foo"), Arrays.asList("blub", "bla")); - } - - @Test - public void replaceAllTest2() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - LinkedHashMap> newValues = new LinkedHashMap>(); - - newValues.put("bar", Arrays.asList("baz")); - newValues.put("foo", null); - map.replaceAll(newValues); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("bar", "baz"))); - assertNull(map.getFirstValue("foo")); - assertNull(map.getJoinedValue("foo", ", ")); - assertNull(map.get("foo")); - assertEquals(map.getFirstValue("bar"), "baz"); - assertEquals(map.getJoinedValue("bar", ", "), "baz"); - assertEquals(map.get("bar"), Arrays.asList("baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceAllNullTest1() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll((FluentStringsMap) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } - - @Test - public void replaceAllNullTest2() { - FluentStringsMap map = new FluentStringsMap(); - - map.add("foo", "bar"); - map.add("bar", "foo, bar", "baz"); - map.add("baz", Arrays.asList("foo", "bar")); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - - map.replaceAll((Map>) null); - - assertEquals(map.keySet(), new LinkedHashSet(Arrays.asList("foo", "bar", "baz"))); - assertEquals(map.getFirstValue("foo"), "bar"); - assertEquals(map.getJoinedValue("foo", ", "), "bar"); - assertEquals(map.get("foo"), Arrays.asList("bar")); - assertEquals(map.getFirstValue("bar"), "foo, bar"); - assertEquals(map.getJoinedValue("bar", ", "), "foo, bar, baz"); - assertEquals(map.get("bar"), Arrays.asList("foo, bar", "baz")); - assertEquals(map.getFirstValue("baz"), "foo"); - assertEquals(map.getJoinedValue("baz", ", "), "foo, bar"); - assertEquals(map.get("baz"), Arrays.asList("foo", "bar")); - } -} diff --git a/src/test/java/com/ning/http/client/async/FollowingThreadTest.java b/src/test/java/com/ning/http/client/async/FollowingThreadTest.java deleted file mode 100644 index b8de801eb9..0000000000 --- a/src/test/java/com/ning/http/client/async/FollowingThreadTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import org.testng.annotations.Test; - -import java.io.IOException; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.TimeoutException; - - -/** - * Simple stress test for exercising the follow redirect. - */ -public abstract class FollowingThreadTest extends AbstractBasicTest { - - private final static int COUNT = 10; - - @Test(timeOut = 30 * 1000, groups = {"online", "default_provider", "scalability"}) - public void testFollowRedirect() throws IOException, ExecutionException, TimeoutException, InterruptedException { - - final CountDownLatch countDown = new CountDownLatch(COUNT); - ExecutorService pool = Executors.newCachedThreadPool(); - for (int i = 0; i < COUNT; i++) { - pool.submit(new Runnable() { - - private int status; - - public void run() { - final CountDownLatch l = new CountDownLatch(1); - final AsyncHttpClient ahc = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build()); - try { - ahc.prepareGet("http://www.google.com/").execute(new AsyncHandler() { - - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - System.out.println(new String(bodyPart.getBodyPartBytes())); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - status = responseStatus.getStatusCode(); - System.out.println(responseStatus.getStatusText()); - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - public Integer onCompleted() throws Exception { - l.countDown(); - return status; - } - }); - - l.await(); - } catch (Exception e) { - e.printStackTrace(); - } finally { - ahc.close(); - countDown.countDown(); - } - } - }); - } - countDown.await(); - } - -} \ No newline at end of file diff --git a/src/test/java/com/ning/http/client/async/Head302Test.java b/src/test/java/com/ning/http/client/async/Head302Test.java deleted file mode 100644 index c84f827dce..0000000000 --- a/src/test/java/com/ning/http/client/async/Head302Test.java +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.omg.CORBA.TIMEOUT; -import org.testng.Assert; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.BrokenBarrierException; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -/** - * Tests HEAD request that gets 302 response. - * - * @author Hubert Iwaniuk - */ -public abstract class Head302Test extends AbstractBasicTest { - /** - * Handler that does Found (302) in response to HEAD method. - */ - private class Head302handler extends AbstractHandler { - public void handle(String s, - org.eclipse.jetty.server.Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - if ("HEAD".equalsIgnoreCase(request.getMethod())) { - if (request.getPathInfo().endsWith("_moved")) { - response.setStatus(HttpServletResponse.SC_OK); - } else { - response.setStatus(HttpServletResponse.SC_FOUND); // 302 - response.setHeader("Location", request.getPathInfo() + "_moved"); - } - } else { // this handler is to handle HEAD reqeust - response.setStatus(HttpServletResponse.SC_FORBIDDEN); - } - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void testHEAD302() throws IOException, BrokenBarrierException, InterruptedException, ExecutionException, TimeoutException { - AsyncHttpClient client = getAsyncHttpClient(null); - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("HEAD").setUrl("http://127.0.0.1/" + port1 + "/Test").build(); - - client.executeRequest(request, new AsyncCompletionHandlerBase() { - @Override - public Response onCompleted(Response response) throws Exception { - l.countDown(); - return super.onCompleted(response); - } - }).get(3, TimeUnit.SECONDS); - - if (!l.await(TIMEOUT, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - client.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new Head302handler(); - } -} diff --git a/src/test/java/com/ning/http/client/async/HostnameVerifierTest.java b/src/test/java/com/ning/http/client/async/HostnameVerifierTest.java deleted file mode 100644 index e2bff473b1..0000000000 --- a/src/test/java/com/ning/http/client/async/HostnameVerifierTest.java +++ /dev/null @@ -1,339 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig.Builder; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.ssl.SslSocketConnector; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.annotations.AfterClass; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.net.ssl.*; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.IOException; -import java.io.InputStream; -import java.net.ConnectException; -import java.net.ServerSocket; -import java.net.URL; -import java.security.KeyStore; -import java.security.SecureRandom; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; -import java.util.Enumeration; -import java.util.concurrent.Future; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class HostnameVerifierTest extends AbstractBasicTest { - - protected final Logger log = LoggerFactory.getLogger(HostnameVerifierTest.class); - - public static class EchoHandler extends AbstractHandler { - - /* @Override */ - public void handle(String pathInContext, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws ServletException, IOException { - - httpResponse.setContentType("text/html; charset=utf-8"); - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("LockThread")) { - try { - Thread.sleep(40 * 1000); - } catch (InterruptedException ex) { // nothing to do here - } - } - - httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); - } - - Enumeration i = httpRequest.getParameterNames(); - - StringBuilder requestBody = new StringBuilder(); - while (i.hasMoreElements()) { - param = i.nextElement().toString(); - httpResponse.addHeader("X-" + param, httpRequest.getParameter(param)); - requestBody.append(param); - requestBody.append("_"); - } - - String pathInfo = httpRequest.getPathInfo(); - if (pathInfo != null) - httpResponse.addHeader("X-pathInfo", pathInfo); - - String queryString = httpRequest.getQueryString(); - if (queryString != null) - httpResponse.addHeader("X-queryString", queryString); - - httpResponse.addHeader("X-KEEP-ALIVE", httpRequest.getRemoteAddr() + ":" + httpRequest.getRemotePort()); - - javax.servlet.http.Cookie[] cs = httpRequest.getCookies(); - if (cs != null) { - for (javax.servlet.http.Cookie c : cs) { - httpResponse.addCookie(c); - } - } - - if (requestBody.length() > 0) { - httpResponse.getOutputStream().write(requestBody.toString().getBytes()); - } - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - //noinspection ResultOfMethodCallIgnored - int read = httpRequest.getInputStream().read(bytes); - httpResponse.getOutputStream().write(bytes, 0, read); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - - } - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - server.stop(); - } - - @AfterMethod(alwaysRun = true) - public void tearDownProps() throws Exception { - System.clearProperty("javax.net.ssl.keyStore"); - System.clearProperty("javax.net.ssl.trustStore"); - } - - protected String getTargetUrl() { - return String.format("https://127.0.0.1:%d/foo/test", port1); - } - - public AbstractHandler configureHandler() throws Exception { - return new EchoHandler(); - } - - protected int findFreePort() throws IOException { - ServerSocket socket = null; - - try { - socket = new ServerSocket(0); - - return socket.getLocalPort(); - } finally { - if (socket != null) { - socket.close(); - } - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - port1 = findFreePort(); - SslSocketConnector connector = new SslSocketConnector(); - connector.setHost("127.0.0.1"); - connector.setPort(port1); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL cacertsUrl = cl.getResource("ssltest-cacerts.jks"); - String trustStoreFile = new File(cacertsUrl.toURI()).getAbsolutePath(); - connector.setTruststore(trustStoreFile); - connector.setTrustPassword("changeit"); - connector.setTruststoreType("JKS"); - - log.info("SSL certs path: {}", trustStoreFile); - - // override system properties - URL keystoreUrl = cl.getResource("ssltest-keystore.jks"); - String keyStoreFile = new File(keystoreUrl.toURI()).getAbsolutePath(); - connector.setKeystore(keyStoreFile); - connector.setKeyPassword("changeit"); - connector.setKeystoreType("JKS"); - - log.info("SSL keystore path: {}", keyStoreFile); - - server.addConnector(connector); - - server.setHandler(configureHandler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"standalone", "default_provider"}) - public void positiveHostnameVerifierTest() throws Throwable { - - final AsyncHttpClient client = getAsyncHttpClient(new Builder().setHostnameVerifier(new PositiveHostVerifier()).setSSLContext(createSSLContext()).build()); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - Future f = client.preparePost(getTargetUrl()).setBody(file).setHeader("Content-Type", "text/html").execute(); - Response resp = f.get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "This is a simple test file"); - } - - @Test(groups = {"standalone", "default_provider"}) - public void negativeHostnameVerifierTest() throws Throwable { - - final AsyncHttpClient client = getAsyncHttpClient(new Builder().setHostnameVerifier(new NegativeHostVerifier()).setSSLContext(createSSLContext()).build()); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - try { - Future f = client.preparePost(getTargetUrl()).setBody(file).setHeader("Content-Type", "text/html").execute(); - } catch (ConnectException ex) { - assertEquals(ConnectException.class, ex.getClass()); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void remoteIDHostnameVerifierTest() throws Throwable { - - final AsyncHttpClient client = getAsyncHttpClient(new Builder().setHostnameVerifier(new CheckHost("bouette")).setSSLContext(createSSLContext()).build()); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - try { - Future f = client.preparePost(getTargetUrl()).setBody(file).setHeader("Content-Type", "text/html").execute(); - } catch (ConnectException ex) { - assertEquals(ConnectException.class, ex.getClass()); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void remotePosHostnameVerifierTest() throws Throwable { - - final AsyncHttpClient client = getAsyncHttpClient(new Builder().setHostnameVerifier(new CheckHost("localhost")).setSSLContext(createSSLContext()).build()); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - try { - Future f = client.preparePost(getTargetUrl()).setBody(file).setHeader("Content-Type", "text/html").execute(); - } catch (ConnectException ex) { - assertEquals(ConnectException.class, ex.getClass()); - } - } - - public static class PositiveHostVerifier implements HostnameVerifier { - - public boolean verify(String s, SSLSession sslSession) { - return true; - } - } - - public static class NegativeHostVerifier implements HostnameVerifier { - - public boolean verify(String s, SSLSession sslSession) { - return true; - } - } - - public static class CheckHost implements HostnameVerifier { - - private final String hostName; - - public CheckHost(String hostName) { - this.hostName = hostName; - } - - public boolean verify(String s, SSLSession sslSession) { - - if (s != null && s.equalsIgnoreCase(hostName)) { - return true; - } - - return false; - } - } - - private static SSLContext createSSLContext() { - try { - InputStream keyStoreStream = HostnameVerifierTest.class.getResourceAsStream("ssltest-cacerts.jks"); - char[] keyStorePassword = "changeit".toCharArray(); - KeyStore ks = KeyStore.getInstance("JKS"); - ks.load(keyStoreStream, keyStorePassword); - - // Set up key manager factory to use our key store - char[] certificatePassword = "changeit".toCharArray(); - KeyManagerFactory kmf = KeyManagerFactory.getInstance("SunX509"); - kmf.init(ks, certificatePassword); - - // Initialize the SSLContext to work with our key managers. - KeyManager[] keyManagers = kmf.getKeyManagers(); - TrustManager[] trustManagers = new TrustManager[]{DUMMY_TRUST_MANAGER}; - SecureRandom secureRandom = new SecureRandom(); - - SSLContext sslContext = SSLContext.getInstance("TLS"); - sslContext.init(keyManagers, trustManagers, secureRandom); - - return sslContext; - } catch (Exception e) { - throw new Error("Failed to initialize the server-side SSLContext", e); - } - } - - private static final AtomicBoolean TRUST_SERVER_CERT = new AtomicBoolean(true); - private static final TrustManager DUMMY_TRUST_MANAGER = new X509TrustManager() { - public X509Certificate[] getAcceptedIssuers() { - return new X509Certificate[0]; - } - - public void checkClientTrusted( - X509Certificate[] chain, String authType) throws CertificateException { - } - - public void checkServerTrusted( - X509Certificate[] chain, String authType) throws CertificateException { - if (!TRUST_SERVER_CERT.get()) { - throw new CertificateException("Server certificate not trusted."); - } - } - }; - - -} diff --git a/src/test/java/com/ning/http/client/async/HttpToHttpsRedirectTest.java b/src/test/java/com/ning/http/client/async/HttpToHttpsRedirectTest.java deleted file mode 100644 index 7cd04b99bc..0000000000 --- a/src/test/java/com/ning/http/client/async/HttpToHttpsRedirectTest.java +++ /dev/null @@ -1,199 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.server.ssl.SslSocketConnector; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.IOException; -import java.net.URI; -import java.net.URL; -import java.util.Enumeration; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class HttpToHttpsRedirectTest extends AbstractBasicTest { - private final AtomicBoolean isSet = new AtomicBoolean(false); - - private class Relative302Handler extends AbstractHandler { - - - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - String param; - httpResponse.setContentType("text/html; charset=utf-8"); - Enumeration e = httpRequest.getHeaderNames(); - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("X-redirect") && !isSet.getAndSet(true)) { - httpResponse.addHeader("Location", httpRequest.getHeader(param)); - httpResponse.setStatus(302); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - return; - } - } - - if (r.getScheme().equalsIgnoreCase("https")) { - httpResponse.addHeader("X-httpToHttps", "PASS"); - isSet.getAndSet(false); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - - port1 = findFreePort(); - port2 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - server.addConnector(listener); - - SslSocketConnector connector = new SslSocketConnector(); - connector.setHost("127.0.0.1"); - connector.setPort(port2); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL cacertsUrl = cl.getResource("ssltest-cacerts.jks"); - String trustStoreFile = new File(cacertsUrl.toURI()).getAbsolutePath(); - connector.setTruststore(trustStoreFile); - connector.setTrustPassword("changeit"); - connector.setTruststoreType("JKS"); - - log.info("SSL certs path: {}", trustStoreFile); - - // override system properties - URL keystoreUrl = cl.getResource("ssltest-keystore.jks"); - String keyStoreFile = new File(keystoreUrl.toURI()).getAbsolutePath(); - connector.setKeystore(keyStoreFile); - connector.setKeyPassword("changeit"); - connector.setKeystoreType("JKS"); - - log.info("SSL keystore path: {}", keyStoreFile); - - server.addConnector(connector); - - server.setHandler(new Relative302Handler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - private String getBaseUrl(URI uri) { - String url = uri.toString(); - int port = uri.getPort(); - if (port == -1) { - port = getPort(uri); - url = url.substring(0, url.length() - 1) + ":" + port; - } - return url.substring(0, url.lastIndexOf(":") + String.valueOf(port).length() + 1); - } - - private static int getPort(URI uri) { - int port = uri.getPort(); - if (port == -1) - port = uri.getScheme().equals("http") ? 80 : 443; - return port; - } - - @Test(groups = {"standalone", "default_provider"}) - public void httpToHttpsRedirect() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setMaximumNumberOfRedirects(5).setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", getTargetUrl2()) - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-httpToHttps"), "PASS"); - c.close(); - } - - public String getTargetUrl2() { - return String.format("https://127.0.0.1:%d/foo/test", port2); - } - - @Test(groups = {"standalone", "default_provider"}) - public void httpToHttpsProperConfig() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setMaximumNumberOfRedirects(5).setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", getTargetUrl2() + "/test2") - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-httpToHttps"), "PASS"); - - // Test if the internal channel is downgraded to clean http. - response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", getTargetUrl2() + "/foo2") - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getHeader("X-httpToHttps"), "PASS"); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void relativeLocationUrl() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setMaximumNumberOfRedirects(5).setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", "/foo/test") - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 302); - assertEquals(response.getUri().toString(), getTargetUrl()); - c.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/IdleStateHandlerTest.java b/src/test/java/com/ning/http/client/async/IdleStateHandlerTest.java deleted file mode 100644 index 2ccd40e2d6..0000000000 --- a/src/test/java/com/ning/http/client/async/IdleStateHandlerTest.java +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.fail; - -public abstract class IdleStateHandlerTest extends AbstractBasicTest { - private final AtomicBoolean isSet = new AtomicBoolean(false); - - private class IdleStateHandler extends AbstractHandler { - - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - try { - Thread.sleep(20 * 1000); - } - catch (InterruptedException e) { - e.printStackTrace(); - } - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - - port1 = findFreePort(); - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - server.addConnector(listener); - - server.setHandler(new IdleStateHandler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"online", "default_provider"}) - public void idleStateTest() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setIdleConnectionInPoolTimeoutInMs(10 * 1000).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - try { - c.prepareGet(getTargetUrl()).execute().get(); - } catch (ExecutionException e) { - fail("Should allow to finish processing request.", e); - } finally { - c.close(); - } - } -} diff --git a/src/test/java/com/ning/http/client/async/InputStreamTest.java b/src/test/java/com/ning/http/client/async/InputStreamTest.java deleted file mode 100644 index 70ceb4b48e..0000000000 --- a/src/test/java/com/ning/http/client/async/InputStreamTest.java +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.InputStream; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -public abstract class InputStreamTest extends AbstractBasicTest { - - private class InputStreamHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - if ("POST".equalsIgnoreCase(request.getMethod())) { - byte[] b = new byte[3]; - request.getInputStream().read(b, 0, 3); - - response.setStatus(HttpServletResponse.SC_OK); - response.addHeader("X-Param", new String(b)); - } else { // this handler is to handle POST request - response.sendError(HttpServletResponse.SC_FORBIDDEN); - } - response.getOutputStream().flush(); - response.getOutputStream().close(); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void testInvalidInputStream() throws IOException, ExecutionException, TimeoutException, InterruptedException { - - AsyncHttpClient c = getAsyncHttpClient(null); - FluentCaseInsensitiveStringsMap h = new FluentCaseInsensitiveStringsMap(); - h.add("Content-Type", "application/x-www-form-urlencoded"); - - InputStream is = new InputStream() { - - public int readAllowed; - - @Override - public int available() { - return 1; // Fake - } - - @Override - public int read() throws IOException { - int fakeCount = readAllowed++; - if (fakeCount == 0) { - return (int) 'a'; - } else if (fakeCount == 1) { - return (int) 'b'; - } else if (fakeCount == 2) { - return (int) 'c'; - } else { - return -1; - } - - } - }; - - Response resp = c.preparePost(getTargetUrl()).setHeaders(h).setBody(is).execute().get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("X-Param"), "abc"); - c.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new InputStreamHandler(); - } -} diff --git a/src/test/java/com/ning/http/client/async/ListenableFutureTest.java b/src/test/java/com/ning/http/client/async/ListenableFutureTest.java deleted file mode 100644 index 6de42566a9..0000000000 --- a/src/test/java/com/ning/http/client/async/ListenableFutureTest.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.Response; -import org.testng.annotations.Test; - -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Executors; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.assertEquals; - -public abstract class ListenableFutureTest extends AbstractBasicTest { - - @Test(groups = {"standalone", "default_provider"}) - public void testListenableFuture() throws Throwable { - final AtomicInteger statusCode = new AtomicInteger(500); - AsyncHttpClient ahc = getAsyncHttpClient(null); - final CountDownLatch latch = new CountDownLatch(1); - final ListenableFuture future = ahc.prepareGet(getTargetUrl()).execute(); - future.addListener(new Runnable(){ - - public void run() { - try { - statusCode.set(future.get().getStatusCode()); - latch.countDown(); - } catch (InterruptedException e) { - e.printStackTrace(); - } catch (ExecutionException e) { - e.printStackTrace(); - } - } - }, Executors.newFixedThreadPool(1)); - - latch.await(10, TimeUnit.SECONDS); - assertEquals(statusCode.get(), 200); - ahc.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/MaxConnectionsInThreads.java b/src/test/java/com/ning/http/client/async/MaxConnectionsInThreads.java deleted file mode 100644 index 01484c610d..0000000000 --- a/src/test/java/com/ning/http/client/async/MaxConnectionsInThreads.java +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.servlet.ServletContextHandler; -import org.eclipse.jetty.servlet.ServletHolder; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.OutputStream; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.ArrayList; -import java.util.List; - -import static org.testng.AssertJUnit.assertTrue; - -abstract public class MaxConnectionsInThreads extends AbstractBasicTest { - - private static URI servletEndpointUri; - - @Test(groups = {"online", "default_provider"}) - public void testMaxConnectionsWithinThreads() { - - String[] urls = new String[]{ - servletEndpointUri.toString(), - servletEndpointUri.toString()}; - - - final AsyncHttpClient client = - getAsyncHttpClient(new AsyncHttpClientConfig.Builder() - .setConnectionTimeoutInMs(1000) - .setRequestTimeoutInMs(5000) - .setAllowPoolingConnection(true) - .setMaximumConnectionsTotal(1) - .setMaximumConnectionsPerHost(1) - .build()); - - - final Boolean[] caughtError = new Boolean[]{Boolean.FALSE}; - List ts = new ArrayList(); - for (int i = 0; i < urls.length; i++) { - final String url = urls[i]; - Thread t = new Thread() { - public void run() { - try { - client.prepareGet(url).execute(); - } catch (IOException e) { - // assert that 2nd request fails, because maxTotalConnections=1 - // System.out.println(i); - caughtError[0] = true; - System.err.println("============"); - e.printStackTrace(); - System.err.println("============"); - - } - } - }; - t.start(); - ts.add(t); - } - - for (Thread t : ts) { - try { - t.join(); - } catch (InterruptedException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - } - - - // Let the threads finish - try { - Thread.sleep(4500); - } catch (InterruptedException e1) { - // TODO Auto-generated catch block - e1.printStackTrace(); - } - - assertTrue("Max Connections should have been reached", caughtError[0]); - - - boolean errorInNotThread = false; - for (int i = 0; i < urls.length; i++) { - final String url = urls[i]; - try { - client.prepareGet(url).execute(); - // client.prepareGet(url).execute(); - } catch (IOException e) { - // assert that 2nd request fails, because maxTotalConnections=1 - // System.out.println(i); - errorInNotThread = true; - System.err.println("============"); - e.printStackTrace(); - System.err.println("============"); - } - } - // Let the request finish - try { - Thread.sleep(2500); - } catch (InterruptedException e1) { - // TODO Auto-generated catch block - e1.printStackTrace(); - } - assertTrue("Max Connections should have been reached", errorInNotThread); - - - client.close(); - - - } - - @Override - @BeforeClass - public void setUpGlobal() throws Exception { - - server = new Server(); - - port1 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - - ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); - - context.setContextPath("/"); - server.setHandler(context); - - context.addServlet(new ServletHolder(new MockTimeoutHttpServlet()), "/timeout/*"); - - server.start(); - - String endpoint = "http://127.0.0.1/" + port1 + "/timeout/"; - servletEndpointUri = new URI(endpoint); - - } - - public String getTargetUrl() { - String s = "http://127.0.0.1/" + port1 + "/timeout/"; - try { - servletEndpointUri = new URI(s); - } catch (URISyntaxException e) { - e.printStackTrace(); - } - return s; - } - - public static class MockTimeoutHttpServlet extends HttpServlet { - private static final String contentType = "text/plain"; - public static long DEFAULT_TIMEOUT = 2000; - - public void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { - res.setStatus(200); - res.addHeader("Content-Type", contentType); - long sleepTime = DEFAULT_TIMEOUT; - try { - sleepTime = Integer.parseInt(req.getParameter("timeout")); - - } - catch (NumberFormatException e) { - sleepTime = DEFAULT_TIMEOUT; - } - - try { - System.out.println("======================================="); - System.out.println("Servlet is sleeping for: " + sleepTime); - System.out.println("======================================="); - System.out.flush(); - Thread.sleep(sleepTime); - System.out.println("======================================="); - System.out.println("Servlet is awake for"); - System.out.println("======================================="); - System.out.flush(); - } - catch (Exception e) { - - } - - res.setHeader("XXX", "TripleX"); - - byte[] retVal = "1".getBytes(); - OutputStream os = res.getOutputStream(); - - res.setContentLength(retVal.length); - os.write(retVal); - os.close(); - } - } -} diff --git a/src/test/java/com/ning/http/client/async/MaxTotalConnectionTest.java b/src/test/java/com/ning/http/client/async/MaxTotalConnectionTest.java deleted file mode 100644 index ad47d1ceac..0000000000 --- a/src/test/java/com/ning/http/client/async/MaxTotalConnectionTest.java +++ /dev/null @@ -1,155 +0,0 @@ -/* -* Copyright 2010 Ning, Inc. -* -* Ning licenses this file to you under the Apache License, version 2.0 -* (the "License"); you may not use this file except in compliance with the -* License. You may obtain a copy of the License at: -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -* License for the specific language governing permissions and limitations -* under the License. -*/ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; - -public abstract class MaxTotalConnectionTest extends AbstractBasicTest { - protected final Logger log = LoggerFactory.getLogger(AbstractBasicTest.class); - - @Test(groups = {"standalone", "default_provider"}) - public void testMaxTotalConnectionsExceedingException() { - String[] urls = new String[]{ - "http://google.com/", - "http://github.com/"}; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionTimeoutInMs(1000) - .setRequestTimeoutInMs(5000) - .setAllowPoolingConnection(false) - .setMaximumConnectionsTotal(1) - .setMaximumConnectionsPerHost(1) - .build() - ); - - boolean caughtError = false; - for (int i = 0; i < urls.length; i++) { - try { - client.prepareGet(urls[i]).execute(); - } catch (IOException e) { - // assert that 2nd request fails, because maxTotalConnections=1 - Assert.assertEquals(1, i); - caughtError = true; - } - } - Assert.assertTrue(caughtError); - client.close(); - } - - @Test - public void testMaxTotalConnections() { - String[] urls = new String[]{ - "http://google.com/", - "http://lenta.ru/"}; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionTimeoutInMs(1000) - .setRequestTimeoutInMs(5000) - .setAllowPoolingConnection(false) - .setMaximumConnectionsTotal(2) - .setMaximumConnectionsPerHost(1) - .build() - ); - - for (String url : urls) { - try { - client.prepareGet(url).execute(); - } catch (IOException e) { - Assert.fail("Smth wrong with connections handling!"); - } - } - client.close(); - } - - - /** - * JFA: Disable this test for 1.2.0 release as it can easily fail because a request may complete - * before the second one is made, hence failing. The issue occurs frequently on Linux. - */ - @Test(enabled = false) - public void testMaxTotalConnectionsCorrectExceptionHandling() { - String[] urls = new String[]{ - "http://google.com/", - "http://github.com/"}; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionTimeoutInMs(1000) - .setRequestTimeoutInMs(5000) - .setAllowPoolingConnection(false) - .setMaximumConnectionsTotal(1) - .setMaximumConnectionsPerHost(1) - .build() - ); - - List futures = new ArrayList(); - boolean caughtError = false; - for (int i = 0; i < urls.length; i++) { - try { - Future future = client.prepareGet(urls[i]).execute(); - if (future != null) { - futures.add(future); - } - } catch (IOException e) { - // assert that 2nd request fails, because maxTotalConnections=1 - Assert.assertEquals(i, 1); - caughtError = true; - } - } - Assert.assertTrue(caughtError); - - // get results of executed requests - for (Future future : futures) { - try { - Object res = future.get(); - } catch (InterruptedException e) { - log.error("Error!", e); - } catch (ExecutionException e) { - log.error("Error!", e); - } - } - - // try to execute once again, expecting that 1 connection is released - caughtError = false; - for (int i = 0; i < urls.length; i++) { - try { - client.prepareGet(urls[i]).execute(); - } catch (IOException e) { - // assert that 2nd request fails, because maxTotalConnections=1 - Assert.assertEquals(i, 1); - caughtError = true; - } - } - Assert.assertTrue(caughtError); - client.close(); - } -} - - diff --git a/src/test/java/com/ning/http/client/async/MultipartUploadTest.java b/src/test/java/com/ning/http/client/async/MultipartUploadTest.java deleted file mode 100644 index 580af9ba03..0000000000 --- a/src/test/java/com/ning/http/client/async/MultipartUploadTest.java +++ /dev/null @@ -1,484 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ByteArrayPart; -import com.ning.http.client.FilePart; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.StringPart; -import com.ning.http.util.AsyncHttpProviderUtils; -import org.apache.commons.fileupload.FileItemIterator; -import org.apache.commons.fileupload.FileItemStream; -import org.apache.commons.fileupload.FileUploadException; -import org.apache.commons.fileupload.servlet.ServletFileUpload; -import org.apache.commons.fileupload.util.Streams; -import org.apache.commons.io.FileUtils; -import org.apache.commons.io.IOUtils; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.servlet.ServletContextHandler; -import org.eclipse.jetty.servlet.ServletHolder; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.Writer; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.UUID; -import java.util.zip.GZIPInputStream; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; - -/** - * @author dominict - */ -public abstract class MultipartUploadTest extends AbstractBasicTest { - private String BASE_URL; - - private String servletEndpointRedirectUrl; - public static byte GZIPTEXT[] = new byte[]{31, -117, 8, 8, 11, 43, 79, 75, 0, 3, 104, 101, 108, 108, 111, 46, 116, 120, 116, 0, -53, 72, -51, -55, -55, -25, 2, 0, 32, 48, 58, 54, 6, 0, 0, 0}; - - @BeforeClass - public void setUp() throws Exception { - server = new Server(); - - port1 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - listener.setHost("localhost"); - listener.setPort(port1); - - server.addConnector(listener); - - ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); - context.setContextPath("/"); - context.addServlet(new ServletHolder(new MockMultipartUploadServlet()), "/upload/*"); - - server.setHandler(context); - server.start(); - - servletEndpointRedirectUrl = "http://localhost/" + ":" + port1; - } - - @AfterClass - public void stop() { - try { - - if (server != null) { - server.stop(); - } - - } catch (Exception e) { - System.err.print("Error stopping servlet tester"); - e.printStackTrace(); - } - - } - - private File getClasspathFile(String file) throws FileNotFoundException { - ClassLoader cl = null; - try { - cl = Thread.currentThread().getContextClassLoader(); - } catch (Throwable ex) { - } - if (cl == null) { - cl = MultipartUploadTest.class.getClassLoader(); - } - URL resourceUrl = cl.getResource(file); - - try { - return new File(new URI(resourceUrl.toString()).getSchemeSpecificPart()); - } catch (URISyntaxException e) { - throw new FileNotFoundException(file); - } - } - - /** - * Tests that the streaming of a file works. - */ - @Test (enabled = true) - public void testSendingSmallFilesAndByteArray() { - String expectedContents = "filecontent: hello"; - String expectedContents2 = "gzipcontent: hello"; - String expectedContents3 = "filecontent: hello2"; - String testResource1 = "textfile.txt"; - String testResource2 = "gzip.txt.gz"; - String testResource3 = "textfile2.txt"; - - File testResource1File = null; - try { - testResource1File = getClasspathFile(testResource1); - } catch (FileNotFoundException e) { - // TODO Auto-generated catch block - fail("unable to find " + testResource1); - } - - File testResource2File = null; - try { - testResource2File = getClasspathFile(testResource2); - } catch (FileNotFoundException e) { - // TODO Auto-generated catch block - fail("unable to find " + testResource2); - } - - - File testResource3File = null; - try { - testResource3File = getClasspathFile(testResource3); - } catch (FileNotFoundException e) { - // TODO Auto-generated catch block - fail("unable to find " + testResource3); - } - - List testFiles = new ArrayList(); - testFiles.add(testResource1File); - testFiles.add(testResource2File); - testFiles.add(testResource3File); - - List expected = new ArrayList(); - expected.add(expectedContents); - expected.add(expectedContents2); - expected.add(expectedContents3); - - List gzipped = new ArrayList(); - gzipped.add(false); - gzipped.add(true); - gzipped.add(false); - - - boolean tmpFileCreated = false; - File tmpFile = null; - FileOutputStream os = null; - try { - tmpFile = File.createTempFile("textbytearray", ".txt"); - os = new FileOutputStream(tmpFile); - IOUtils.write(expectedContents.getBytes("UTF-8"), os); - tmpFileCreated = true; - - testFiles.add(tmpFile); - expected.add(expectedContents); - gzipped.add(false); - - - } catch (FileNotFoundException e1) { - // TODO Auto-generated catch block - e1.printStackTrace(); - } catch (IOException e1) { - // TODO Auto-generated catch block - e1.printStackTrace(); - } finally { - if (os != null) { - IOUtils.closeQuietly(os); - } - } - - if (!tmpFileCreated) { - fail("Unable to test ByteArrayMultiPart, as unable to write to filesystem the tmp test content"); - } - - - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setFollowRedirects(true); - - - AsyncHttpClient c = new AsyncHttpClient(bc.build()); - - try { - - RequestBuilder builder = new RequestBuilder("POST"); - builder.setUrl(servletEndpointRedirectUrl + "/upload/bob"); - builder.addBodyPart(new FilePart("file1", testResource1File, "text/plain", "UTF-8")); - builder.addBodyPart(new FilePart("file2", testResource2File, "application/x-gzip", null)); - builder.addBodyPart(new StringPart("Name", "Dominic")); - builder.addBodyPart(new FilePart("file3", testResource3File, "text/plain", "UTF-8")); - - builder.addBodyPart(new StringPart("Age", "3", AsyncHttpProviderUtils.DEFAULT_CHARSET)); - builder.addBodyPart(new StringPart("Height", "shrimplike", AsyncHttpProviderUtils.DEFAULT_CHARSET)); - builder.addBodyPart(new StringPart("Hair", "ridiculous", AsyncHttpProviderUtils.DEFAULT_CHARSET)); - - builder.addBodyPart(new ByteArrayPart("file4", "bytearray.txt", expectedContents.getBytes("UTF-8") ,"text/plain", "UTF-8")); - - - com.ning.http.client.Request r = builder.build(); - - Response res = c.executeRequest(r).get(); - - assertEquals(200, res.getStatusCode()); - - testSentFile(expected, testFiles, res, gzipped); - - c.close(); - } catch (Exception e) { - e.printStackTrace(); - fail("Download Exception"); - } finally { - FileUtils.deleteQuietly(tmpFile); - } - } - - - /** - * Test that the files were sent, based on the response from the servlet - * - * @param expectedContents - * @param sourceFiles - * @param r - * @param deflate - */ - private void testSentFile(List expectedContents, List sourceFiles, - Response r, List deflate) { - String content = null; - try { - content = r.getResponseBody(); - assertNotNull("===>" + content); - System.out.println(content); - } catch (IOException e) { - fail("Unable to obtain content"); - } - - String[] contentArray = content.split("\\|\\|"); - // TODO: this fail on win32 - assertEquals(2, contentArray.length); - - String tmpFiles = contentArray[1]; - assertNotNull(tmpFiles); - assertTrue(tmpFiles.trim().length() > 2); - tmpFiles = tmpFiles.substring(1, tmpFiles.length() - 1); - - String[] responseFiles = tmpFiles.split(","); - assertNotNull(responseFiles); - assertEquals( sourceFiles.size(), responseFiles.length); - - - System.out.println(Arrays.toString(responseFiles)); - //assertTrue("File should exist: " + tmpFile.getAbsolutePath(),tmpFile.exists()); - - int i = 0; - for (File sourceFile : sourceFiles) { - - FileInputStream instream = null; - File tmp = null; - try { - - ByteArrayOutputStream baos = new ByteArrayOutputStream(); - byte[] sourceBytes = null; - try { - instream = new FileInputStream(sourceFile); - byte[] buf = new byte[8092]; - int len = 0; - while ((len = instream.read(buf)) > 0) { - baos.write(buf, 0, len); - } - System.out.println("================"); - System.out.println("Length of file: " + baos.toByteArray().length); - System.out.println("Contents: " + Arrays.toString(baos.toByteArray())); - System.out.println("================"); - System.out.flush(); - sourceBytes = baos.toByteArray(); - } finally { - IOUtils.closeQuietly(instream); - } - - - tmp = new File(responseFiles[i].trim()); - System.out.println("=============================="); - System.out.println(tmp.getAbsolutePath()); - System.out.println("=============================="); - System.out.flush(); - assertTrue(tmp.exists()); - - - instream = new FileInputStream(tmp); - ByteArrayOutputStream baos2 = new ByteArrayOutputStream(); - byte[] buf = new byte[8092]; - int len = 0; - while ((len = instream.read(buf)) > 0) { - baos2.write(buf, 0, len); - } - IOUtils.closeQuietly(instream); - - assertEquals(sourceBytes, baos2.toByteArray()); - - if (!deflate.get(i)) { - - String helloString = new String(baos2.toByteArray()); - assertEquals(expectedContents.get(i), helloString); - } else { - instream = new FileInputStream(tmp); - - GZIPInputStream deflater = new GZIPInputStream(instream); - ByteArrayOutputStream baos3 = new ByteArrayOutputStream(); - byte[] buf3 = new byte[8092]; - int len3 = 0; - while ((len3 = deflater.read(buf3)) > 0) { - baos3.write(buf3, 0, len3); - } - - String helloString = new String(baos3.toByteArray()); - - assertEquals(expectedContents.get(i), helloString); - - } - } catch (Exception e) { - e.printStackTrace(); - fail("Download Exception"); - } finally { - if (tmp != null) FileUtils.deleteQuietly(tmp); - IOUtils.closeQuietly(instream); - i++; - } - } - } - - /** - * Takes the content that is being passed to it, and streams to a file on disk - * - * @author dominict - */ - public static class MockMultipartUploadServlet extends HttpServlet { - /** - * - */ - private static final long serialVersionUID = 1L; - private int filesProcessed = 0; - private int stringsProcessed = 0; - - - public MockMultipartUploadServlet() { - - } - - public synchronized void resetFilesProcessed() { - filesProcessed = 0; - } - - private synchronized int incrementFilesProcessed() { - return ++filesProcessed; - - } - - public int getFilesProcessed() { - return filesProcessed; - } - - public synchronized void resetStringsProcessed() { - stringsProcessed = 0; - } - - private synchronized int incrementStringsProcessed() { - return ++stringsProcessed; - - } - - public int getStringsProcessed() { - return stringsProcessed; - } - - @Override - public void service(HttpServletRequest request, HttpServletResponse response) - throws ServletException, IOException { - // Check that we have a file upload request - boolean isMultipart = ServletFileUpload.isMultipartContent(request); - if (isMultipart) { - List files = new ArrayList(); - ServletFileUpload upload = new ServletFileUpload(); - // Parse the request - FileItemIterator iter = null; - try { - iter = upload.getItemIterator(request); - while (iter.hasNext()) { - FileItemStream item = iter.next(); - String name = item.getFieldName(); - InputStream stream = null; - try { - stream = item.openStream(); - - if (item.isFormField()) { - System.out.println("Form field " + name + " with value " - + Streams.asString(stream) + " detected."); - incrementStringsProcessed(); - } else { - System.out.println("File field " + name + " with file name " - + item.getName() + " detected."); - // Process the input stream - OutputStream os = null; - try { - File tmpFile = File.createTempFile(UUID.randomUUID().toString() + "_MockUploadServlet", ".tmp"); - tmpFile.deleteOnExit(); - os = new FileOutputStream(tmpFile); - byte[] buffer = new byte[4096]; - int bytesRead; - while ((bytesRead = stream.read(buffer)) != -1) { - os.write(buffer, 0, bytesRead); - } - incrementFilesProcessed(); - files.add(tmpFile.getAbsolutePath()); - } finally { - IOUtils.closeQuietly(os); - } - } - } finally { - IOUtils.closeQuietly(stream); - } - } - } catch (FileUploadException e) { - - } - Writer w = response.getWriter(); - w.write(Integer.toString(getFilesProcessed())); - resetFilesProcessed(); - resetStringsProcessed(); - w.write("||"); - w.write(files.toString()); - w.close(); - } else { - Writer w = response.getWriter(); - w.write(Integer.toString(getFilesProcessed())); - resetFilesProcessed(); - resetStringsProcessed(); - w.write("||"); - w.close(); - } - - } - - } - - -} diff --git a/src/test/java/com/ning/http/client/async/MultipleHeaderTest.java b/src/test/java/com/ning/http/client/async/MultipleHeaderTest.java deleted file mode 100644 index 6bf0b416b9..0000000000 --- a/src/test/java/com/ning/http/client/async/MultipleHeaderTest.java +++ /dev/null @@ -1,209 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import org.testng.Assert; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.OutputStreamWriter; -import java.net.ServerSocket; -import java.net.Socket; -import java.util.concurrent.Callable; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -/** - * @author Hubert Iwaniuk - */ -public abstract class MultipleHeaderTest extends AbstractBasicTest{ - private ExecutorService executorService; - private ServerSocket serverSocket; - private Future voidFuture; - - @Test(groups = {"standalone", "default_provider"}) - public void testMultipleOtherHeaders() - throws IOException, ExecutionException, TimeoutException, InterruptedException { - final String[] xffHeaders = new String[]{null, null}; - - AsyncHttpClient ahc = getAsyncHttpClient(null); - Request req = new RequestBuilder("GET").setUrl("http://localhost/" + port1 + "/MultiOther").build(); - final CountDownLatch latch = new CountDownLatch(1); - ahc.executeRequest(req, new AsyncHandler() { - public void onThrowable(Throwable t) { - t.printStackTrace(System.out); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart objectHttpResponseBodyPart) throws Exception { - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus objectHttpResponseStatus) throws Exception { - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders response) throws Exception { - int i = 0; - for (String header : response.getHeaders().get("X-Forwarded-For")) { - xffHeaders[i++] = header; - } - latch.countDown(); - return STATE.CONTINUE; - } - - public Void onCompleted() throws Exception { - return null; - } - }).get(3, TimeUnit.SECONDS); - - if (!latch.await(2, TimeUnit.SECONDS)) { - Assert.fail("Time out"); - } - Assert.assertNotNull(xffHeaders[0]); - Assert.assertNotNull(xffHeaders[1]); - try { - Assert.assertEquals(xffHeaders[0], "abc"); - Assert.assertEquals(xffHeaders[1], "def"); - } catch (AssertionError ex) { - Assert.assertEquals(xffHeaders[1], "abc"); - Assert.assertEquals(xffHeaders[0], "def"); - } - ahc.close(); - } - - - @Test(groups = {"standalone", "default_provider"}) - public void testMultipleEntityHeaders() - throws IOException, ExecutionException, TimeoutException, InterruptedException { - final String[] clHeaders = new String[]{null, null}; - - AsyncHttpClient ahc = getAsyncHttpClient(null); - Request req = new RequestBuilder("GET").setUrl("http://localhost/" + port1 + "/MultiEnt").build(); - final CountDownLatch latch = new CountDownLatch(1); - ahc.executeRequest(req, new AsyncHandler() { - public void onThrowable(Throwable t) { - t.printStackTrace(System.out); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart objectHttpResponseBodyPart) throws Exception { - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus objectHttpResponseStatus) throws Exception { - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders response) throws Exception { - try { - int i = 0; - for (String header : response.getHeaders().get("Content-Length")) { - clHeaders[i++] = header; - } - } finally { - latch.countDown(); - } - return STATE.CONTINUE; - } - - public Void onCompleted() throws Exception { - return null; - } - }).get(3, TimeUnit.SECONDS); - - if (!latch.await(2, TimeUnit.SECONDS)) { - Assert.fail("Time out"); - } - Assert.assertNotNull(clHeaders[0]); - Assert.assertNotNull(clHeaders[1]); - - // We can predict the order - try { - Assert.assertEquals(clHeaders[0], "2"); - Assert.assertEquals(clHeaders[1], "1"); - } catch (Throwable ex) { - Assert.assertEquals(clHeaders[0], "1"); - Assert.assertEquals(clHeaders[1], "2"); - } - ahc.close(); - - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - port1 = findFreePort(); - - serverSocket = new ServerSocket(port1); - executorService = Executors.newFixedThreadPool(1); - voidFuture = executorService.submit(new Callable() { - public Void call() throws Exception { - Socket socket; - while ((socket = serverSocket.accept()) != null) { - InputStream inputStream = socket.getInputStream(); - BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream)); - String req = reader.readLine().split(" ")[1]; - int i = inputStream.available(); - long l = inputStream.skip(i); - Assert.assertEquals(l, i); - socket.shutdownInput(); - if (req.endsWith("MultiEnt")) { - OutputStreamWriter outputStreamWriter = new OutputStreamWriter(socket.getOutputStream()); - outputStreamWriter.append("HTTP/1.0 200 OK\n" + - "Connection: close\n" + - "Content-Type: text/plain; charset=iso-8859-1\n" + - "Content-Length: 2\n" + - "Content-Length: 1\n" + - "\n0\n"); - outputStreamWriter.flush(); - socket.shutdownOutput(); - } else if (req.endsWith("MultiOther")) { - OutputStreamWriter outputStreamWriter = new OutputStreamWriter(socket.getOutputStream()); - outputStreamWriter.append("HTTP/1.0 200 OK\n" + - "Connection: close\n" + - "Content-Type: text/plain; charset=iso-8859-1\n" + - "Content-Length: 1\n" + - "X-Forwarded-For: abc\n" + - "X-Forwarded-For: def\n" + - "\n0\n"); - outputStreamWriter.flush(); - socket.shutdownOutput(); - } - } - return null; - } - }); - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - voidFuture.cancel(true); - executorService.shutdownNow(); - serverSocket.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/NoNullResponseTest.java b/src/test/java/com/ning/http/client/async/NoNullResponseTest.java deleted file mode 100644 index cc9f0890e3..0000000000 --- a/src/test/java/com/ning/http/client/async/NoNullResponseTest.java +++ /dev/null @@ -1,86 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClient.BoundRequestBuilder; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.testng.Assert; -import org.testng.annotations.Test; - -import javax.net.ssl.SSLContext; -import javax.net.ssl.TrustManager; -import javax.net.ssl.X509TrustManager; -import java.security.GeneralSecurityException; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; - -public abstract class NoNullResponseTest extends AbstractBasicTest { - private static final String VERISIGN_HTTPS_URL = "https://www.verisign.com/"; - - @Test(invocationCount = 4, groups = {"online", "default_provider"}) - public void multipleSslRequestsWithDelayAndKeepAlive() throws Throwable { - final AsyncHttpClient client = create(); - final BoundRequestBuilder builder = client.prepareGet(VERISIGN_HTTPS_URL); - final Response response1 = builder.execute().get(); - Thread.sleep(5000); - final Response response2 = builder.execute().get(); - if (response2 != null) { - System.out.println("Success (2nd response was not null)."); - } else { - System.out.println("Failed (2nd response was null)."); - } - Assert.assertNotNull(response1); - Assert.assertNotNull(response2); - client.close(); - } - - private AsyncHttpClient create() throws GeneralSecurityException { - final AsyncHttpClientConfig.Builder configBuilder = new AsyncHttpClientConfig.Builder() - .setCompressionEnabled(true) - .setFollowRedirects(true) - .setSSLContext(getSSLContext()) - .setAllowPoolingConnection(true) - .setConnectionTimeoutInMs(10000) - .setIdleConnectionInPoolTimeoutInMs(60000) - .setRequestTimeoutInMs(10000) - .setMaximumConnectionsPerHost(-1) - .setMaximumConnectionsTotal(-1); - return getAsyncHttpClient(configBuilder.build()); - } - - private SSLContext getSSLContext() throws GeneralSecurityException { - final SSLContext sslContext = SSLContext.getInstance("TLS"); - sslContext.init(null, new TrustManager[]{new MockTrustManager()}, null); - return sslContext; - } - - private static class MockTrustManager implements X509TrustManager { - public X509Certificate[] getAcceptedIssuers() { - throw new UnsupportedOperationException(); - } - - public void checkClientTrusted(final X509Certificate[] chain, final String authType) throws CertificateException { - throw new UnsupportedOperationException(); - } - - public void checkServerTrusted(final X509Certificate[] chain, final String authType) throws CertificateException { - // Do nothing. - } - } -} diff --git a/src/test/java/com/ning/http/client/async/NonAsciiContentLengthTest.java b/src/test/java/com/ning/http/client/async/NonAsciiContentLengthTest.java deleted file mode 100644 index 80acc7942f..0000000000 --- a/src/test/java/com/ning/http/client/async/NonAsciiContentLengthTest.java +++ /dev/null @@ -1,96 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClient.BoundRequestBuilder; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.ServletInputStream; -import javax.servlet.ServletOutputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; - -import static org.testng.Assert.assertEquals; - -public abstract class NonAsciiContentLengthTest extends AbstractBasicTest { - - - public void setUpServer() throws Exception { - server = new Server(); - port1 = findFreePort(); - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - server.addConnector(listener); - server.setHandler(new AbstractHandler() { - - public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) - throws IOException, ServletException { - int MAX_BODY_SIZE = 1024; //Can only handle bodies of up to 1024 bytes. - byte[] b = new byte[MAX_BODY_SIZE]; - int offset = 0; - int numBytesRead; - ServletInputStream is = request.getInputStream(); - try { - while ((numBytesRead = is.read(b, offset, MAX_BODY_SIZE - offset)) != -1) { - offset += numBytesRead; - } - } finally { - is.close(); - } - assertEquals(request.getContentLength(), offset); - response.setStatus(200); - response.setCharacterEncoding(request.getCharacterEncoding()); - response.setContentLength(request.getContentLength()); - ServletOutputStream os = response.getOutputStream(); - try { - os.write(b, 0, offset); - } finally { - os.close(); - } - } - }); - server.start(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testNonAsciiContentLength() throws Exception { - setUpServer(); - execute("test"); - execute("\u4E00"); // Unicode CJK ideograph for one - } - - protected void execute(String body) throws IOException, InterruptedException, ExecutionException { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - BoundRequestBuilder r = client.preparePost(getTargetUrl()).setBody(body).setBodyEncoding("UTF-8"); - Future f = r.execute(); - Response resp = f.get(); - assertEquals(resp.getStatusCode(), 200); - assertEquals(body, resp.getResponseBody("UTF-8")); - client.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/PerRequestRelative302Test.java b/src/test/java/com/ning/http/client/async/PerRequestRelative302Test.java deleted file mode 100644 index 756a258339..0000000000 --- a/src/test/java/com/ning/http/client/async/PerRequestRelative302Test.java +++ /dev/null @@ -1,188 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.ConnectException; -import java.net.URI; -import java.util.Enumeration; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertTrue; - -public abstract class PerRequestRelative302Test extends AbstractBasicTest { - private final AtomicBoolean isSet = new AtomicBoolean(false); - - private class Relative302Handler extends AbstractHandler { - - - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - String param; - httpResponse.setContentType("text/html; charset=utf-8"); - Enumeration e = httpRequest.getHeaderNames(); - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("X-redirect") && !isSet.getAndSet(true)) { - httpResponse.addHeader("Location", httpRequest.getHeader(param)); - httpResponse.setStatus(302); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - return; - } - } - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - - port1 = findFreePort(); - port2 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - server.addConnector(listener); - - server.setHandler(new Relative302Handler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"online", "default_provider"}) - public void redirected302Test() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - // once - Response response = c.prepareGet(getTargetUrl()) - .setFollowRedirects(true) - .setHeader("X-redirect", "http://www.microsoft.com/") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - - String anyMicrosoftPage = "http://www.microsoft.com[^:]*:80"; - String baseUrl = getBaseUrl(response.getUri()); - - c.close(); - - assertTrue(baseUrl.matches(anyMicrosoftPage), "response does not show redirection to " + anyMicrosoftPage); - } - - @Test(groups = {"online", "default_provider"}) - public void notRedirected302Test() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - - // once - Response response = c.prepareGet(getTargetUrl()) - .setFollowRedirects(false) - .setHeader("X-redirect", "http://www.microsoft.com/") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 302); - - c.close(); - } - - private String getBaseUrl(URI uri) { - String url = uri.toString(); - int port = uri.getPort(); - if (port == -1) { - port = getPort(uri); - url = url.substring(0, url.length() - 1) + ":" + port; - } - return url.substring(0, url.lastIndexOf(":") + String.valueOf(port).length() + 1); - } - - private static int getPort(URI uri) { - int port = uri.getPort(); - if (port == -1) - port = uri.getScheme().equals("http") ? 80 : 443; - return port; - } - - @Test(groups = {"standalone", "default_provider"}) - public void redirected302InvalidTest() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - // If the test hit a proxy, no ConnectException will be thrown and instead of 404 will be returned. - try { - Response response = c.preparePost(getTargetUrl()) - .setFollowRedirects(true) - .setHeader("X-redirect", String.format("http://127.0.0.1:%d/", port2)) - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 404); - } catch (ExecutionException ex) { - assertEquals(ex.getCause().getClass(), ConnectException.class); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void relativeLocationUrl() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.preparePost(getTargetUrl()) - .setFollowRedirects(true) - .setHeader("X-redirect", "/foo/test") - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 302); - assertEquals(response.getUri().toString(), getTargetUrl()); - c.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/PerRequestTimeoutTest.java b/src/test/java/com/ning/http/client/async/PerRequestTimeoutTest.java deleted file mode 100644 index e50bee78de..0000000000 --- a/src/test/java/com/ning/http/client/async/PerRequestTimeoutTest.java +++ /dev/null @@ -1,195 +0,0 @@ -/* -* Copyright 2010 Ning, Inc. -* -* Ning licenses this file to you under the Apache License, version 2.0 -* (the "License"); you may not use this file except in compliance with the -* License. You may obtain a copy of the License at: -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -* License for the specific language governing permissions and limitations -* under the License. -*/ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.PerRequestConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.continuation.Continuation; -import org.eclipse.jetty.continuation.ContinuationSupport; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; - -/** - * Per request timeout configuration test. - * - * @author Hubert Iwaniuk - */ -public abstract class PerRequestTimeoutTest extends AbstractBasicTest { - private static final String MSG = "Enough is enough."; - - protected String getExpectedTimeoutMessage() { - return "No response received after 100"; - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new SlowHandler(); - } - - private class SlowHandler extends AbstractHandler { - public void handle(String target, Request baseRequest, HttpServletRequest request, final HttpServletResponse response) throws IOException, ServletException { - response.setStatus(HttpServletResponse.SC_OK); - final Continuation continuation = ContinuationSupport.getContinuation(request); - continuation.suspend(); - new Thread(new Runnable() { - public void run() { - try { - Thread.sleep(1500); - response.getOutputStream().print(MSG); - response.getOutputStream().flush(); - } catch (InterruptedException e) { - log.error(e.getMessage(), e); - } catch (IOException e) { - log.error(e.getMessage(), e); - } - } - }).start(); - new Thread(new Runnable() { - public void run() { - try { - Thread.sleep(3000); - response.getOutputStream().print(MSG); - response.getOutputStream().flush(); - continuation.complete(); - } catch (InterruptedException e) { - log.error(e.getMessage(), e); - } catch (IOException e) { - log.error(e.getMessage(), e); - } - } - }).start(); - baseRequest.setHandled(true); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void testRequestTimeout() throws IOException { - AsyncHttpClient client = getAsyncHttpClient(null); - PerRequestConfig requestConfig = new PerRequestConfig(); - requestConfig.setRequestTimeoutInMs(100); - Future responseFuture = - client.prepareGet(getTargetUrl()).setPerRequestConfig(requestConfig).execute(); - try { - Response response = responseFuture.get(2000, TimeUnit.MILLISECONDS); - assertNull(response); - client.close(); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } catch (ExecutionException e) { - assertTrue(e.getCause() instanceof TimeoutException); - assertEquals(e.getCause().getMessage(), getExpectedTimeoutMessage()); - } catch (TimeoutException e) { - fail("Timeout.", e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testGlobalDefaultPerRequestInfiniteTimeout() throws IOException { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(100).build()); - PerRequestConfig requestConfig = new PerRequestConfig(); - requestConfig.setRequestTimeoutInMs(-1); - Future responseFuture = - client.prepareGet(getTargetUrl()).setPerRequestConfig(requestConfig).execute(); - try { - Response response = responseFuture.get(); - assertNotNull(response); - client.close(); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } catch (ExecutionException e) { - assertTrue(e.getCause() instanceof TimeoutException); - assertEquals(e.getCause().getMessage(), getExpectedTimeoutMessage()); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testGlobalRequestTimeout() throws IOException { - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(100).build()); - Future responseFuture = client.prepareGet(getTargetUrl()).execute(); - try { - Response response = responseFuture.get(2000, TimeUnit.MILLISECONDS); - assertNull(response); - client.close(); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } catch (ExecutionException e) { - assertTrue(e.getCause() instanceof TimeoutException); - assertEquals(e.getCause().getMessage(), getExpectedTimeoutMessage()); - } catch (TimeoutException e) { - fail("Timeout.", e); - } - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testGlobalIdleTimeout() throws IOException { - final long times[] = new long[]{-1, -1}; - - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setIdleConnectionInPoolTimeoutInMs(2000).build()); - Future responseFuture = client.prepareGet(getTargetUrl()).execute(new AsyncCompletionHandler() { - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - - @Override - public STATE onBodyPartReceived(HttpResponseBodyPart content) throws Exception { - times[0] = System.currentTimeMillis(); - return super.onBodyPartReceived(content); - } - - @Override - public void onThrowable(Throwable t) { - times[1] = System.currentTimeMillis(); - super.onThrowable(t); - } - }); - try { - Response response = responseFuture.get(); - assertNotNull(response); - assertEquals(response.getResponseBody(), MSG + MSG); - } catch (InterruptedException e) { - fail("Interrupted.", e); - } catch (ExecutionException e) { - log.info(String.format("\n@%dms Last body part received\n@%dms Connection killed\n %dms difference.", - times[0], times[1], (times[1] - times[0]))); - fail("Timeouted on idle.", e); - } - client.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/PostRedirectGetTest.java b/src/test/java/com/ning/http/client/async/PostRedirectGetTest.java deleted file mode 100644 index 658673384b..0000000000 --- a/src/test/java/com/ning/http/client/async/PostRedirectGetTest.java +++ /dev/null @@ -1,221 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.filter.FilterContext; -import com.ning.http.client.filter.FilterException; -import com.ning.http.client.filter.ResponseFilter; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.Assert; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.Future; -import java.util.concurrent.atomic.AtomicInteger; - -public abstract class PostRedirectGetTest extends AbstractBasicTest { - - - // ------------------------------------------------------ Test Configuration - - - @Override - public AbstractHandler configureHandler() throws Exception { - return new PostRedirectGetHandler(); - } - - // ------------------------------------------------------------ Test Methods - - @Test(groups = {"standalone", "post_redirect_get"}) - public void postRedirectGet302Test() throws Exception { - doTestPositive(302); - } - - @Test(groups = {"standalone", "post_redirect_get"}) - public void postRedirectGet302StrictTest() throws Exception { - doTestNegative(302, true); - } - - @Test(groups = {"standalone", "post_redirect_get"}) - public void postRedirectGet303Test() throws Exception { - doTestPositive(303); - } - - @Test(groups = {"standalone", "post_redirect_get"}) - public void postRedirectGet301Test() throws Exception { - doTestNegative(301, false); - } - - @Test(groups = {"standalone", "post_redirect_get"}) - public void postRedirectGet307Test() throws Exception { - doTestNegative(307, false); - } - - - // --------------------------------------------------------- Private Methods - - - private void doTestNegative(final int status, boolean strict) throws Exception { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setFollowRedirects(true). - setStrict302Handling(strict). - addResponseFilter(new ResponseFilter() { - @Override - public FilterContext filter(FilterContext ctx) throws FilterException { - // pass on the x-expect-get and remove the x-redirect - // headers if found in the response - ctx.getResponseHeaders().getHeaders().get("x-expect-post"); - ctx.getRequest().getHeaders().add("x-expect-post", "true"); - ctx.getRequest().getHeaders().remove("x-redirect"); - return ctx; - } - }).build()); - Request request = new RequestBuilder("POST").setUrl(getTargetUrl()) - .addParameter("q", "a b") - .addHeader("x-redirect", +status + "@" + "http://localhost/" + port1 + "/foo/bar/baz") - .addHeader("x-negative", "true") - .build(); - Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { - - @Override - public Integer onCompleted(Response response) throws Exception { - return response.getStatusCode(); - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - }); - int statusCode = responseFuture.get(); - Assert.assertEquals(statusCode, 200); - p.close(); - } - - - private void doTestPositive(final int status) throws Exception { - AsyncHttpClient p = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setFollowRedirects(true). - addResponseFilter(new ResponseFilter() { - @Override - public FilterContext filter(FilterContext ctx) throws FilterException { - // pass on the x-expect-get and remove the x-redirect - // headers if found in the response - ctx.getResponseHeaders().getHeaders().get("x-expect-get"); - ctx.getRequest().getHeaders().add("x-expect-get", "true"); - ctx.getRequest().getHeaders().remove("x-redirect"); - return ctx; - } - }).build()); - Request request = new RequestBuilder("POST").setUrl(getTargetUrl()) - .addParameter("q", "a b") - .addHeader("x-redirect", +status + "@" + "http://localhost/" + port1 + "/foo/bar/baz") - .build(); - Future responseFuture = p.executeRequest(request, new AsyncCompletionHandler() { - - @Override - public Integer onCompleted(Response response) throws Exception { - return response.getStatusCode(); - } - - /* @Override */ - public void onThrowable(Throwable t) { - t.printStackTrace(); - Assert.fail("Unexpected exception: " + t.getMessage(), t); - } - - }); - int statusCode = responseFuture.get(); - Assert.assertEquals(statusCode, 200); - p.close(); - } - - - // ---------------------------------------------------------- Nested Classes - - - public static class PostRedirectGetHandler extends AbstractHandler { - - final AtomicInteger counter = new AtomicInteger(); - - /* @Override */ - public void handle(String pathInContext, - org.eclipse.jetty.server.Request request, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - final boolean expectGet = (httpRequest.getHeader("x-expect-get") != null); - final boolean expectPost = (httpRequest.getHeader("x-expect-post") != null); - if (expectGet) { - final String method = request.getMethod(); - if (!"GET".equals(method)) { - httpResponse.sendError(500, "Incorrect method. Expected GET, received " + method); - return; - } - httpResponse.setStatus(200); - httpResponse.getOutputStream().write("OK".getBytes()); - httpResponse.getOutputStream().flush(); - return; - } else if (expectPost) { - final String method = request.getMethod(); - if (!"POST".equals(method)) { - httpResponse.sendError(500, "Incorrect method. Expected POST, received " + method); - return; - } - httpResponse.setStatus(200); - httpResponse.getOutputStream().write("OK".getBytes()); - httpResponse.getOutputStream().flush(); - return; - } - - String header = httpRequest.getHeader("x-redirect"); - if (header != null) { - // format for header is | - String[] parts = header.split("@"); - int redirectCode; - try { - redirectCode = Integer.parseInt(parts[0]); - } catch (Exception ex) { - ex.printStackTrace(); - httpResponse.sendError(500, "Unable to parse redirect code"); - return; - } - httpResponse.setStatus(redirectCode); - if (httpRequest.getHeader("x-negative") == null) { - httpResponse.addHeader("x-expect-get", "true"); - } else { - httpResponse.addHeader("x-expect-post", "true"); - } - httpResponse.setContentLength(0); - httpResponse.addHeader("Location", parts[1] + counter.getAndIncrement()); - httpResponse.getOutputStream().flush(); - return; - } - - - httpResponse.sendError(500); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } -} diff --git a/src/test/java/com/ning/http/client/async/PostWithQSTest.java b/src/test/java/com/ning/http/client/async/PostWithQSTest.java deleted file mode 100644 index d99498bd18..0000000000 --- a/src/test/java/com/ning/http/client/async/PostWithQSTest.java +++ /dev/null @@ -1,129 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.ServletInputStream; -import javax.servlet.ServletOutputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -/** - * Tests POST request with Query String. - * - * @author Hubert Iwaniuk - */ -public abstract class PostWithQSTest extends AbstractBasicTest { - - /** - * POST with QS server part. - */ - private class PostWithQSHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - if ("POST".equalsIgnoreCase(request.getMethod())) { - String qs = request.getQueryString(); - if (qs != null && !qs.equals("") && request.getContentLength() == 3) { - ServletInputStream is = request.getInputStream(); - response.setStatus(HttpServletResponse.SC_OK); - byte buf[] = new byte[is.available()]; - is.readLine(buf, 0, is.available()); - ServletOutputStream os = response.getOutputStream(); - os.println(new String(buf)); - os.flush(); - os.close(); - } else { - response.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE); - } - } else { // this handler is to handle POST request - response.sendError(HttpServletResponse.SC_FORBIDDEN); - } - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void postWithQS() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/?a=b").setBody("abc".getBytes()).execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void postWithNulParamQS() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/?a=").setBody("abc".getBytes()).execute(new AsyncCompletionHandlerBase() { - - /* @Override */ - public STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - if (!status.getUrl().toURL().toString().equals("http://127.0.0.1/" + port1 + "/?a")) { - throw new IOException(status.getUrl().toURL().toString()); - } - return super.onStatusReceived(status); - } - - }); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void postWithNulParamsQS() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/?a=b&c&d=e").setBody("abc".getBytes()).execute(new AsyncCompletionHandlerBase() { - - /* @Override */ - public STATE onStatusReceived(final HttpResponseStatus status) throws Exception { - if (!status.getUrl().toURL().toString().equals("http://127.0.0.1/" + port1 + "/?a=b&c&d=e")) { - throw new IOException("failed to parse the query properly"); - } - return super.onStatusReceived(status); - } - - }); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - client.close(); - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new PostWithQSHandler(); - } -} diff --git a/src/test/java/com/ning/http/client/async/ProviderUtil.java b/src/test/java/com/ning/http/client/async/ProviderUtil.java deleted file mode 100644 index 70f79dc94c..0000000000 --- a/src/test/java/com/ning/http/client/async/ProviderUtil.java +++ /dev/null @@ -1,50 +0,0 @@ -/* -* Copyright 2010 Ning, Inc. -* -* Ning licenses this file to you under the Apache License, version 2.0 -* (the "License"); you may not use this file except in compliance with the -* License. You may obtain a copy of the License at: -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -* License for the specific language governing permissions and limitations -* under the License. -*/ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.providers.apache.ApacheAsyncHttpProvider; -import com.ning.http.client.providers.jdk.JDKAsyncHttpProvider; - -public class ProviderUtil { - - - public static AsyncHttpClient nettyProvider(AsyncHttpClientConfig config) { - if (config == null) { - return new AsyncHttpClient(); - } else { - return new AsyncHttpClient(config); - } - } - - public static AsyncHttpClient apacheProvider(AsyncHttpClientConfig config) { - if (config == null) { - return new AsyncHttpClient(new ApacheAsyncHttpProvider(new AsyncHttpClientConfig.Builder().build())); - } else { - return new AsyncHttpClient(new ApacheAsyncHttpProvider(config)); - } - } - - public static AsyncHttpClient jdkProvider(AsyncHttpClientConfig config) { - if (config == null) { - return new AsyncHttpClient(new JDKAsyncHttpProvider(new AsyncHttpClientConfig.Builder().build())); - } else { - return new AsyncHttpClient(new JDKAsyncHttpProvider(config)); - } - } - -} diff --git a/src/test/java/com/ning/http/client/async/ProxyTest.java b/src/test/java/com/ning/http/client/async/ProxyTest.java deleted file mode 100644 index 941897ce0c..0000000000 --- a/src/test/java/com/ning/http/client/async/ProxyTest.java +++ /dev/null @@ -1,246 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import static org.testng.Assert.*; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Response; -import com.ning.http.client.ProxyServer.Protocol; -import com.ning.http.util.ProxyUtils; - -import java.io.IOException; -import java.net.ConnectException; -import java.util.Properties; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -/** - * Proxy usage tests. - * - * @author Hubert Iwaniuk - */ -public abstract class ProxyTest extends AbstractBasicTest { - private class ProxyHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - if ("GET".equalsIgnoreCase(request.getMethod())) { - response.addHeader("target", r.getUri().getPath()); - response.setStatus(HttpServletResponse.SC_OK); - } else { // this handler is to handle POST request - response.sendError(HttpServletResponse.SC_FORBIDDEN); - } - r.setHandled(true); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new ProxyHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testRequestLevelProxy() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - String target = "http://127.0.0.1:1234/"; - Future f = client - .prepareGet(target) - .setProxyServer(new ProxyServer("127.0.0.1", port1)) - .execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("target"), "/"); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testGlobalProxy() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClientConfig cfg - = new AsyncHttpClientConfig.Builder().setProxyServer(new ProxyServer("127.0.0.1", port1)).build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - String target = "http://127.0.0.1:1234/"; - Future f = client - .prepareGet(target) - .execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("target"), "/"); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testBothProxies() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClientConfig cfg - = new AsyncHttpClientConfig.Builder().setProxyServer(new ProxyServer("127.0.0.1", port1 - 1)).build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - String target = "http://127.0.0.1:1234/"; - Future f = client - .prepareGet(target) - .setProxyServer(new ProxyServer("127.0.0.1", port1)) - .execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("target"), "/"); - client.close(); - } - - - @Test(groups = {"standalone", "default_provider"}) - public void testNonProxyHosts() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClientConfig cfg - = new AsyncHttpClientConfig.Builder().setProxyServer(new ProxyServer("127.0.0.1", port1 - 1)).build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - try { - - String target = "http://127.0.0.1:1234/"; - client.prepareGet(target) - .setProxyServer(new ProxyServer("127.0.0.1", port1).addNonProxyHost("127.0.0.1")) - .execute().get(); - assertFalse(true); - } catch (Throwable e) { - assertNotNull(e.getCause()); - assertEquals(e.getCause().getClass(), ConnectException.class); - } - - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testProxyProperties() throws IOException, ExecutionException, TimeoutException, InterruptedException { - Properties originalProps = System.getProperties(); - try { - Properties props = new Properties(); - props.putAll(originalProps); - - System.setProperties(props); - - System.setProperty("http.proxyHost", "127.0.0.1"); - System.setProperty("http.proxyPort", String.valueOf(port1)); - System.setProperty("http.nonProxyHosts", "localhost"); - - AsyncHttpClientConfig cfg = new AsyncHttpClientConfig.Builder().setUseProxyProperties(true).build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - - String target = "http://127.0.0.1:1234/"; - Future f = client.prepareGet(target).execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("target"), "/"); - - target = "http://localhost:1234/"; - f = client.prepareGet(target).execute(); - try { - resp = f.get(3, TimeUnit.SECONDS); - fail("should not be able to connect"); - } catch (ExecutionException e) { - // ok, no proxy used - } - - client.close(); - } finally { - System.setProperties(originalProps); - } - } - - @Test(groups = { "standalone", "default_provider" }) - public void testIgnoreProxyPropertiesByDefault() throws IOException, ExecutionException, TimeoutException, InterruptedException { - Properties originalProps = System.getProperties(); - try { - Properties props = new Properties(); - props.putAll(originalProps); - - System.setProperties(props); - - System.setProperty("http.proxyHost", "127.0.0.1"); - System.setProperty("http.proxyPort", String.valueOf(port1)); - System.setProperty("http.nonProxyHosts", "localhost"); - - AsyncHttpClientConfig cfg = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - - String target = "http://127.0.0.1:1234/"; - Future f = client.prepareGet(target).execute(); - try { - f.get(3, TimeUnit.SECONDS); - fail("should not be able to connect"); - } catch (ExecutionException e) { - // ok, no proxy used - } - - client.close(); - } finally { - System.setProperties(originalProps); - } - } - - @Test(groups = { "standalone", "default_provider" }) - public void testProxyActivationProperty() throws IOException, ExecutionException, TimeoutException, InterruptedException { - Properties originalProps = System.getProperties(); - try { - Properties props = new Properties(); - props.putAll(originalProps); - - System.setProperties(props); - - System.setProperty("http.proxyHost", "127.0.0.1"); - System.setProperty("http.proxyPort", String.valueOf(port1)); - System.setProperty("http.nonProxyHosts", "localhost"); - System.setProperty("com.ning.http.client.AsyncHttpClientConfig.useProxyProperties", "true"); - - AsyncHttpClientConfig cfg = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient client = getAsyncHttpClient(cfg); - - String target = "http://127.0.0.1:1234/"; - Future f = client.prepareGet(target).execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("target"), "/"); - - target = "http://localhost:1234/"; - f = client.prepareGet(target).execute(); - try { - resp = f.get(3, TimeUnit.SECONDS); - fail("should not be able to connect"); - } catch (ExecutionException e) { - // ok, no proxy used - } - - client.close(); - } finally { - System.setProperties(originalProps); - } - } - -} diff --git a/src/test/java/com/ning/http/client/async/ProxyyTunnellingTest.java b/src/test/java/com/ning/http/client/async/ProxyyTunnellingTest.java deleted file mode 100644 index f1dd8a631b..0000000000 --- a/src/test/java/com/ning/http/client/async/ProxyyTunnellingTest.java +++ /dev/null @@ -1,170 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandlerBase; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ProxyServer; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.SimpleAsyncHttpClient; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.handler.ProxyHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.server.ssl.SslSocketConnector; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import java.io.File; -import java.io.IOException; -import java.net.URL; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -/** - * Proxy usage tests. - */ -public abstract class ProxyyTunnellingTest extends AbstractBasicTest { - - private Server server2; - - public AbstractHandler configureHandler() throws Exception { - ProxyHandler proxy = new ProxyHandler(); - return proxy; - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - server2 = new Server(); - - port1 = findFreePort(); - port2 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - SslSocketConnector connector = new SslSocketConnector(); - connector.setHost("127.0.0.1"); - connector.setPort(port2); - - ClassLoader cl = getClass().getClassLoader(); - URL keystoreUrl = cl.getResource("ssltest-keystore.jks"); - String keyStoreFile = new File(keystoreUrl.toURI()).getAbsolutePath(); - connector.setKeystore(keyStoreFile); - connector.setKeyPassword("changeit"); - connector.setKeystoreType("JKS"); - - server2.addConnector(connector); - - server.setHandler(configureHandler()); - server.start(); - - server2.setHandler(new EchoHandler()); - server2.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"online", "default_provider"}) - public void testRequestProxy() throws IOException, InterruptedException, ExecutionException, TimeoutException { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.setFollowRedirects(true); - - ProxyServer ps = new ProxyServer(ProxyServer.Protocol.HTTPS, "127.0.0.1", port1); - - AsyncHttpClientConfig config = b.build(); - AsyncHttpClient asyncHttpClient = getAsyncHttpClient(config); - - RequestBuilder rb = new RequestBuilder("GET").setProxyServer(ps).setUrl(getTargetUrl2()); - Future responseFuture = asyncHttpClient.executeRequest(rb.build(), new AsyncCompletionHandlerBase() { - - public void onThrowable(Throwable t) { - t.printStackTrace(); - log.debug(t.getMessage(), t); - } - - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - }); - Response r = responseFuture.get(); - assertEquals(r.getStatusCode(), 200); - assertEquals(r.getHeader("server"), "Jetty(8.1.1.v20120215)"); - - asyncHttpClient.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void testConfigProxy() throws IOException, InterruptedException, ExecutionException, TimeoutException { - AsyncHttpClientConfig.Builder b = new AsyncHttpClientConfig.Builder(); - b.setFollowRedirects(true); - - ProxyServer ps = new ProxyServer(ProxyServer.Protocol.HTTPS, "127.0.0.1", port1); - b.setProxyServer(ps); - - AsyncHttpClientConfig config = b.build(); - AsyncHttpClient asyncHttpClient = getAsyncHttpClient(config); - - RequestBuilder rb = new RequestBuilder("GET").setUrl(getTargetUrl2()); - Future responseFuture = asyncHttpClient.executeRequest(rb.build(), new AsyncCompletionHandlerBase() { - - public void onThrowable(Throwable t) { - t.printStackTrace(); - log.debug(t.getMessage(), t); - } - - @Override - public Response onCompleted(Response response) throws Exception { - return response; - } - }); - Response r = responseFuture.get(); - assertEquals(r.getStatusCode(), 200); - assertEquals(r.getHeader("server"), "Jetty(8.1.1.v20120215)"); - - asyncHttpClient.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void testSimpleAHCConfigProxy() throws IOException, InterruptedException, ExecutionException, TimeoutException { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder() - .setProxyProtocol(ProxyServer.Protocol.HTTPS) - .setProxyHost("127.0.0.1") - .setProxyPort(port1) - .setFollowRedirects(true) - .setUrl(getTargetUrl2()) - .setHeader("Content-Type", "text/html").build(); - - StringBuffer s = new StringBuffer(); - Response r = client.get().get(); - - assertEquals(r.getStatusCode(), 200); - assertEquals(r.getHeader("server"), "Jetty(8.1.1.v20120215)"); - - client.close(); - } -} - diff --git a/src/test/java/com/ning/http/client/async/PutLargeFileTest.java b/src/test/java/com/ning/http/client/async/PutLargeFileTest.java deleted file mode 100644 index 27cc6b61f6..0000000000 --- a/src/test/java/com/ning/http/client/async/PutLargeFileTest.java +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClient.BoundRequestBuilder; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.Assert; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.ServletInputStream; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.util.UUID; - -/** - * @author Benjamin Hanzelmann - */ -public abstract class PutLargeFileTest - extends AbstractBasicTest { - - private File largeFile; - - @Test(groups = {"standalone", "default_provider"}, enabled = true) - public void testPutLargeFile() - throws Exception { - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 * 1024 * 100 / bytes.length) + 1; - largeFile = createTempFile(bytes, (int) repeats); - int timeout = (int) (largeFile.length() / 1000); - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().setConnectionTimeoutInMs(timeout).build(); - AsyncHttpClient client = getAsyncHttpClient(config); - BoundRequestBuilder rb = client.preparePut(getTargetUrl()); - - rb.setBody(largeFile); - - Response response = rb.execute().get(); - Assert.assertEquals(200, response.getStatusCode()); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testPutSmallFile() - throws Exception { - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 / bytes.length) + 1; - int timeout = (5000); - largeFile = createTempFile(bytes, (int) repeats); - - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder().build(); - AsyncHttpClient client = getAsyncHttpClient(config); - BoundRequestBuilder rb = client.preparePut(getTargetUrl()); - - rb.setBody(largeFile); - - Response response = rb.execute().get(); - Assert.assertEquals(200, response.getStatusCode()); - client.close(); - } - - @AfterMethod - public void after() { - largeFile.delete(); - } - - @Override - public AbstractHandler configureHandler() - throws Exception { - return new AbstractHandler() { - - public void handle(String arg0, Request arg1, HttpServletRequest req, HttpServletResponse resp) - throws IOException, ServletException { - - ServletInputStream in = req.getInputStream(); - byte[] b = new byte[8092]; - - int count = -1; - int total = 0; - while ((count = in.read(b)) != -1) { - total += count; - } - - System.err.println("consumed " + total + " bytes."); - - resp.setStatus(200); - resp.getOutputStream().flush(); - resp.getOutputStream().close(); - - arg1.setHandled(true); - - } - }; - } - - private static final File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc-tests-" - + UUID.randomUUID().toString().substring(0, 8)); - - public static File createTempFile(byte[] pattern, int repeat) - throws IOException { - TMP.mkdirs(); - TMP.deleteOnExit(); - File tmpFile = File.createTempFile("tmpfile-", ".data", TMP); - tmpFile.deleteOnExit(); - write(pattern, repeat, tmpFile); - - return tmpFile; - } - - public static void write(byte[] pattern, int repeat, File file) - throws IOException { - file.deleteOnExit(); - file.getParentFile().mkdirs(); - FileOutputStream out = null; - try { - out = new FileOutputStream(file); - for (int i = 0; i < repeat; i++) { - out.write(pattern); - } - } - finally { - if (out != null) { - out.close(); - } - } - } - -} diff --git a/src/test/java/com/ning/http/client/async/QueryParametersTest.java b/src/test/java/com/ning/http/client/async/QueryParametersTest.java deleted file mode 100644 index 028a9543d4..0000000000 --- a/src/test/java/com/ning/http/client/async/QueryParametersTest.java +++ /dev/null @@ -1,130 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.slf4j.LoggerFactory; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.URLDecoder; -import java.net.URLEncoder; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -/** - * Testing query parameters support. - * - * @author Hubert Iwaniuk - */ -public abstract class QueryParametersTest extends AbstractBasicTest { - private class QueryStringHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest request, - HttpServletResponse response) throws IOException, ServletException { - if ("GET".equalsIgnoreCase(request.getMethod())) { - String qs = request.getQueryString(); - if (qs != null && !qs.equals("")) { - for (String qnv : qs.split("&")) { - String nv[] = qnv.split("="); - response.addHeader(nv[0], nv[1]); - } - response.setStatus(HttpServletResponse.SC_OK); - } else { - response.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE); - } - } else { // this handler is to handle POST request - response.sendError(HttpServletResponse.SC_FORBIDDEN); - } - r.setHandled(true); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new QueryStringHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testQueryParameters() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient client = getAsyncHttpClient(null); - Future f = client - .prepareGet("http://127.0.0.1/" + port1) - .addQueryParameter("a", "1") - .addQueryParameter("b", "2") - .execute(); - Response resp = f.get(3, TimeUnit.SECONDS); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getHeader("a"), "1"); - assertEquals(resp.getHeader("b"), "2"); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testUrlRequestParametersEncoding() throws IOException, ExecutionException, InterruptedException { - String URL = getTargetUrl() + "?q="; - String REQUEST_PARAM = "github github \ngithub"; - - AsyncHttpClient client = getAsyncHttpClient(null); - String requestUrl2 = URL + URLEncoder.encode(REQUEST_PARAM, "UTF-8"); - LoggerFactory.getLogger(QueryParametersTest.class).info("Executing request [{}] ...", requestUrl2); - Response response = client.prepareGet(requestUrl2).execute().get(); - String s = URLDecoder.decode(response.getHeader("q"), "UTF-8"); - assertEquals(s, REQUEST_PARAM); - client.close(); - } - - - @Test(groups = {"standalone", "default_provider"}) - public void urlWithColonTest_Netty() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - String query = "test:colon:"; - Response response = c.prepareGet(String.format("http://127.0.0.1:%d/foo/test/colon?q=%s", port1, query)) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getHeader("q"), URLEncoder.encode(query, "UTF-8")); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void urlWithColonTest_JDK() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - String query = "test:colon:"; - Response response = c.prepareGet(String.format("http://127.0.0.1:%d/foo/test/colon?q=%s", port1, query)) - .setHeader("Content-Type", "text/html") - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getHeader("q"), URLEncoder.encode(query, "UTF-8")); - c.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/RC10KTest.java b/src/test/java/com/ning/http/client/async/RC10KTest.java deleted file mode 100644 index 51a1e09602..0000000000 --- a/src/test/java/com/ning/http/client/async/RC10KTest.java +++ /dev/null @@ -1,153 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; - -/** - * Reverse C10K Problem test. - * - * @author Hubert Iwaniuk - */ -public abstract class RC10KTest extends AbstractBasicTest { - private static final int C10K = 1000; - private static final String ARG_HEADER = "Arg"; - private static final int SRV_COUNT = 10; - protected List servers = new ArrayList(SRV_COUNT); - private int[] ports; - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - ports = new int[SRV_COUNT]; - for (int i = 0; i < SRV_COUNT; i++) { - ports[i] = createServer(); - } - log.info("Local HTTP servers started successfully"); - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - for (Server srv : servers) { - srv.stop(); - } - } - - private int createServer() throws Exception { - Server srv = new Server(); - Connector listener = new SelectChannelConnector(); - listener.setHost("127.0.0.1"); - int port = findFreePort(); - listener.setPort(port); - srv.addConnector(listener); - srv.setHandler(configureHandler()); - srv.start(); - servers.add(srv); - return port; - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new AbstractHandler() { - public void handle(String s, Request r, HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException { - resp.setContentType("text/pain"); - String arg = s.substring(1); - resp.setHeader(ARG_HEADER, arg); - resp.setStatus(200); - resp.getOutputStream().print(arg); - resp.getOutputStream().flush(); - resp.getOutputStream().close(); - } - }; - } - - @Test(timeOut = 10 * 60 * 1000, groups = "scalability") - public void rc10kProblem() throws IOException, ExecutionException, TimeoutException, InterruptedException { - AsyncHttpClient ahc = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder().setMaximumConnectionsPerHost(C10K).setAllowPoolingConnection(true).build()); - List> resps = new ArrayList>(C10K); - int i = 0; - while (i < C10K) { - resps.add(ahc.prepareGet(String.format("http://127.0.0.1:%d/%d", ports[i % SRV_COUNT], i)).execute(new MyAsyncHandler(i++))); - } - i = 0; - for (Future fResp : resps) { - Integer resp = fResp.get(); - assertNotNull(resp); - assertEquals(resp.intValue(), i++); - } - ahc.close(); - } - - private class MyAsyncHandler implements AsyncHandler { - private String arg; - private AtomicInteger result = new AtomicInteger(-1); - - public MyAsyncHandler(int i) { - arg = String.format("%d", i); - } - - public void onThrowable(Throwable t) { - log.warn("onThrowable called.", t); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart event) throws Exception { - String s = new String(event.getBodyPartBytes()); - result.compareAndSet(-1, new Integer(s.trim().equals("") ? "-1" : s)); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus event) throws Exception { - assertEquals(event.getStatusCode(), 200); - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders event) throws Exception { - assertEquals(event.getHeaders().getJoinedValue(ARG_HEADER, ", "), arg); - return STATE.CONTINUE; - } - - public Integer onCompleted() throws Exception { - return result.get(); - } - } -} diff --git a/src/test/java/com/ning/http/client/async/RedirectConnectionUsageTest.java b/src/test/java/com/ning/http/client/async/RedirectConnectionUsageTest.java deleted file mode 100644 index 6cc687e49f..0000000000 --- a/src/test/java/com/ning/http/client/async/RedirectConnectionUsageTest.java +++ /dev/null @@ -1,187 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.servlet.ServletContextHandler; -import org.eclipse.jetty.servlet.ServletHolder; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.io.OutputStream; -import java.util.Date; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.FileAssert.fail; - -/** - * Test for multithreaded url fetcher calls that use two separate - * sets of ssl certificates. This then tests that the certificate - * settings do not clash (override each other), resulting in the - * peer not authenticated exception - * - * @author dominict - */ -public abstract class RedirectConnectionUsageTest extends AbstractBasicTest{ - private String BASE_URL; - - private String servletEndpointRedirectUrl; - - @BeforeClass - public void setUp() throws Exception { - server = new Server(); - - port1 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - listener.setHost("localhost"); - listener.setPort(port1); - - server.addConnector(listener); - - - ServletContextHandler context = new ServletContextHandler(ServletContextHandler.SESSIONS); - - context.setContextPath("/"); - server.setHandler(context); - - context.addServlet(new ServletHolder(new MockRedirectHttpServlet()), "/redirect/*"); - context.addServlet(new ServletHolder(new MockFullResponseHttpServlet()), "/*"); - - server.start(); - - BASE_URL = "http://localhost/" + ":" + port1; - servletEndpointRedirectUrl = BASE_URL + "/redirect"; - - } - - @AfterClass - public void tearDown() { - try { - if (server != null) { - server.stop(); - } - - } catch (Exception e) { - System.err.print("Error stopping servlet tester"); - e.printStackTrace(); - } - } - - /** - * Tests that after a redirect the final url in the response - * reflect the redirect - */ - @Test - public void testGetRedirectFinalUrl() { - - AsyncHttpClient c = null; - try { - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setAllowPoolingConnection(true); - bc.setMaximumConnectionsPerHost(1); - bc.setMaximumConnectionsTotal(1); - bc.setConnectionTimeoutInMs(1000); - bc.setRequestTimeoutInMs(1000); - bc.setFollowRedirects(true); - - c = getAsyncHttpClient(bc.build()); - - RequestBuilder builder = new RequestBuilder("GET"); - builder.setUrl(servletEndpointRedirectUrl); - - com.ning.http.client.Request r = builder.build(); - - try { - ListenableFuture response = c.executeRequest(r); - Response res = null; - res = response.get(); - assertNotNull(res.getResponseBody()); - assertEquals(BASE_URL + "/overthere", BASE_URL + "/overthere", res.getUri().toString()); - - } catch (Exception e) { - System.err.print("============"); - e.printStackTrace(); - System.err.print("============"); - System.err.flush(); - fail("Should not get here, The request threw an exception"); - } - - - } - finally { - // can hang here - if (c != null) c.close(); - } - - - } - - protected abstract AsyncHttpProviderConfig getProviderConfig(); - - - class MockRedirectHttpServlet extends HttpServlet { - public void service(HttpServletRequest req, HttpServletResponse res) - throws ServletException, IOException { - res.sendRedirect("/overthere"); - } - - } - - class MockFullResponseHttpServlet extends HttpServlet { - - private static final String contentType = "text/xml"; - private static final String xml = ""; - - public void service(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { - String xmlToReturn = String.format(xml, new Object[]{new Date().toString()}); - - res.setStatus(200, "Complete, XML Being Returned"); - res.addHeader("Content-Type", contentType); - res.addHeader("X-Method", req.getMethod()); - res.addHeader("MultiValue", "1"); - res.addHeader("MultiValue", "2"); - res.addHeader("MultiValue", "3"); - - OutputStream os = res.getOutputStream(); - - byte[] retVal = xmlToReturn.getBytes(); - res.setContentLength(retVal.length); - os.write(retVal); - os.close(); - } - } - - -} diff --git a/src/test/java/com/ning/http/client/async/Relative302Test.java b/src/test/java/com/ning/http/client/async/Relative302Test.java deleted file mode 100644 index e8a72640b4..0000000000 --- a/src/test/java/com/ning/http/client/async/Relative302Test.java +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.ConnectException; -import java.net.URI; -import java.util.Enumeration; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertTrue; - -public abstract class Relative302Test extends AbstractBasicTest { - private final AtomicBoolean isSet = new AtomicBoolean(false); - - private class Relative302Handler extends AbstractHandler { - - - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - String param; - httpResponse.setContentType("text/html; charset=utf-8"); - Enumeration e = httpRequest.getHeaderNames(); - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - - if (param.startsWith("X-redirect") && !isSet.getAndSet(true)) { - httpResponse.addHeader("Location", httpRequest.getHeader(param)); - httpResponse.setStatus(302); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - return; - } - } - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - server = new Server(); - - port1 = findFreePort(); - port2 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - - listener.setHost("127.0.0.1"); - listener.setPort(port1); - server.addConnector(listener); - - server.setHandler(new Relative302Handler()); - server.start(); - log.info("Local HTTP server started successfully"); - } - - @Test(groups = {"online", "default_provider"}) - public void redirected302Test() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - // once - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", "http://www.google.com/") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - - String anyGoogleSubdomain = "http://www.google.[a-z]{1,}:80"; - String baseUrl = getBaseUrl( response.getUri() ); - - assertTrue(baseUrl.matches( anyGoogleSubdomain ), "response does not show redirection to " + anyGoogleSubdomain); - - c.close(); - } - - private String getBaseUrl(URI uri) { - String url = uri.toString(); - int port = uri.getPort(); - if (port == -1) { - port = getPort(uri); - url = url.substring(0, url.length() - 1) + ":" + port; - } - return url.substring(0, url.lastIndexOf(":") + String.valueOf(port).length() + 1); - } - - private static int getPort(URI uri) { - int port = uri.getPort(); - if (port == -1) - port = uri.getScheme().equals("http") ? 80 : 443; - return port; - } - - @Test(groups = {"standalone", "default_provider"}) - public void redirected302InvalidTest() throws Throwable { - isSet.getAndSet(false); - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - // If the test hit a proxy, no ConnectException will be thrown and instead of 404 will be returned. - try { - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", String.format("http://127.0.0.1:%d/", port2)) - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 404); - } catch (ExecutionException ex) { - assertEquals(ex.getCause().getClass(), ConnectException.class); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void absolutePathRedirectTest() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - String redirectTarget = "/bar/test"; - String destinationUrl = new URI(getTargetUrl()).resolve(redirectTarget).toString(); - - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", redirectTarget) - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getUri().toString(), destinationUrl); - - log.debug("{} was redirected to {}", redirectTarget, destinationUrl); - - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void relativePathRedirectTest() throws Throwable { - isSet.getAndSet(false); - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - String redirectTarget = "bar/test1"; - String destinationUrl = new URI(getTargetUrl()).resolve(redirectTarget).toString(); - - Response response = c.prepareGet(getTargetUrl()) - .setHeader("X-redirect", redirectTarget) - .execute().get(); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getUri().toString(), destinationUrl); - - log.debug("{} was redirected to {}", redirectTarget, destinationUrl); - - c.close(); - } -} diff --git a/src/test/java/com/ning/http/client/async/RemoteSiteTest.java b/src/test/java/com/ning/http/client/async/RemoteSiteTest.java deleted file mode 100644 index 17f7cff736..0000000000 --- a/src/test/java/com/ning/http/client/async/RemoteSiteTest.java +++ /dev/null @@ -1,279 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.util.AsyncHttpProviderUtils; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.io.InputStream; -import java.net.URLEncoder; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.TimeUnit; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.AssertJUnit.assertTrue; - -/** - * Unit tests for remote site. - *

- * see http://github.com/MSch/ning-async-http-client-bug/tree/master - * - * @author Martin Schurrer - */ -public abstract class RemoteSiteTest extends AbstractBasicTest{ - - public static final String URL = "http://google.com/?q="; - public static final String REQUEST_PARAM = "github github \n" + - "github"; - - @Test(groups = {"online", "default_provider"}) - public void testGoogleCom() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - // Works - Response response = c.prepareGet("http://www.google.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - } - - @Test(groups = {"online", "default_provider"}) - public void testMailGoogleCom() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - - Response response = c.prepareGet("http://mail.google.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - } - - @Test(groups = {"online", "default_provider"}) - public void testMicrosoftCom() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - - // Works - Response response = c.prepareGet("http://microsoft.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - assertEquals(response.getStatusCode(), 301); - } - - @Test(groups = {"online", "default_provider"}) - public void testWwwMicrosoftCom() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - - Response response = c.prepareGet("http://www.microsoft.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - assertEquals(response.getStatusCode(), 302); - } - - @Test(groups = {"online", "default_provider"}) - public void testUpdateMicrosoftCom() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - - Response response = c.prepareGet("http://update.microsoft.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - assertEquals(response.getStatusCode(), 302); - } - - @Test(groups = {"online", "default_provider"}) - public void testGoogleComWithTimeout() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(10000).build()); - - // Works - Response response = c.prepareGet("http://google.com/").execute().get(10,TimeUnit.SECONDS); - assertNotNull(response); - assertEquals(response.getStatusCode(), 301); - } - - @Test(groups = {"online", "default_provider"}) - public void asyncStatusHEADContentLenghtTest() throws Throwable { - AsyncHttpClient p = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build()); - - final CountDownLatch l = new CountDownLatch(1); - Request request = new RequestBuilder("HEAD") - .setUrl("http://www.google.com/") - .build(); - - p.executeRequest(request, new AsyncCompletionHandlerAdapter() { - @Override - public Response onCompleted(Response response) throws Exception { - Assert.assertEquals(response.getStatusCode(), 200); - l.countDown(); - return response; - } - }).get(); - - if (!l.await(5, TimeUnit.SECONDS)) { - Assert.fail("Timeout out"); - } - p.close(); - } - - @Test(groups = {"online", "default_provider"}, enabled = false) - public void invalidStreamTest2() throws Throwable { - AsyncHttpClientConfig config = new AsyncHttpClientConfig.Builder() - .setRequestTimeoutInMs(10000) - .setFollowRedirects(true) - .setAllowPoolingConnection(false) - .setMaximumNumberOfRedirects(6) - .build(); - - AsyncHttpClient c = getAsyncHttpClient(config); - try { - Response response = c.prepareGet("http://bit.ly/aUjTtG").execute().get(); - if (response != null) { - System.out.println(response); - } - } catch (Throwable t) { - t.printStackTrace(); - assertNotNull(t.getCause()); - assertEquals(t.getCause().getMessage(), "invalid version format: ICY"); - } - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void asyncFullBodyProperlyRead() throws Throwable { - final AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - Response r = client.prepareGet("http://www.cyberpresse.ca/").execute().get(); - - InputStream stream = r.getResponseBodyAsStream(); - int available = stream.available(); - int[] lengthWrapper = new int[1]; - byte[] bytes = AsyncHttpProviderUtils.readFully(stream, lengthWrapper); - int byteToRead = lengthWrapper[0]; - - Assert.assertEquals(available, byteToRead); - client.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void testUrlRequestParametersEncoding() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - String requestUrl2 = URL + URLEncoder.encode(REQUEST_PARAM, "UTF-8"); - log.info(String.format("Executing request [%s] ...", requestUrl2)); - Response response = client.prepareGet(requestUrl2).execute().get(); - Assert.assertEquals(response.getStatusCode(), 301); - } - - /** - * See https://issues.sonatype.org/browse/AHC-61 - * @throws Throwable - */ - @Test(groups = {"online", "default_provider"}) - public void testAHC60() throws Throwable { - AsyncHttpClient client = getAsyncHttpClient(null); - Response response = client.prepareGet("http://www.meetup.com/stackoverflow/Mountain-View-CA/").execute().get(); - Assert.assertEquals(response.getStatusCode(), 200); - } - - @Test(groups = {"online", "default_provider"}) - public void stripQueryStringTest() throws Throwable { - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.prepareGet("http://www.freakonomics.com/?p=55846") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - - - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void stripQueryStringNegativeTest() throws Throwable { - - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder() - .setRemoveQueryParamsOnRedirect(false).setFollowRedirects(true).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - Response response = c.prepareGet("http://www.freakonomics.com/?p=55846") - .execute().get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 301); - - - c.close(); - } - - @Test(groups = {"online", "default_provider"}) - public void evilCoookieTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - RequestBuilder builder2 = new RequestBuilder("GET"); - builder2.setFollowRedirects(true); - builder2.setUrl("http://www.google.com/"); - builder2.addHeader("Content-Type", "text/plain"); - builder2.addCookie(new com.ning.http.client.Cookie(".google.com", "evilcookie", "test", "/", 10, false)); - com.ning.http.client.Request request2 = builder2.build(); - Response response = c.executeRequest(request2).get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - c.close(); - } - - @Test(groups = {"online", "default_provider"}, enabled = false) - public void testAHC62Com() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().setFollowRedirects(true).build()); - // Works - Response response = c.prepareGet("http://api.crunchbase.com/v/1/financial-organization/kinsey-hills-group.js").execute(new AsyncHandler() { - - private Response.ResponseBuilder builder = new Response.ResponseBuilder(); - - public void onThrowable(Throwable t) { - t.printStackTrace(); - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - System.out.println(bodyPart.getBodyPartBytes().length); - builder.accumulate(bodyPart); - - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - builder.accumulate(responseStatus); - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - builder.accumulate(headers); - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return builder.build(); - } - }).get(10, TimeUnit.SECONDS); - assertNotNull(response); - assertTrue(response.getResponseBody().length() >= 3870); - } - -} - diff --git a/src/test/java/com/ning/http/client/async/RequestBuilderTest.java b/src/test/java/com/ning/http/client/async/RequestBuilderTest.java deleted file mode 100644 index 52714d3ed9..0000000000 --- a/src/test/java/com/ning/http/client/async/RequestBuilderTest.java +++ /dev/null @@ -1,108 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async; - -import com.ning.http.client.FluentStringsMap; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import org.testng.annotations.Test; - -import java.io.IOException; -import java.io.UnsupportedEncodingException; -import java.util.concurrent.ExecutionException; - -import static org.testng.Assert.assertEquals; - -public class RequestBuilderTest { - - private final static String SAFE_CHARS = - "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890-_~."; - private final static String HEX_CHARS = "0123456789ABCDEF"; - - @Test(groups = {"standalone", "default_provider"}) - public void testEncodesQueryParameters() throws UnsupportedEncodingException { - String[] values = new String[]{ - "abcdefghijklmnopqrstuvwxyz", - "ABCDEFGHIJKQLMNOPQRSTUVWXYZ", - "1234567890", "1234567890", - "`~!@#$%^&*()", "`~!@#$%^&*()", - "_+-=,.<>/?", "_+-=,.<>/?", - ";:'\"[]{}\\| ", ";:'\"[]{}\\| " - }; - - /* as per RFC-5849 (Oauth), and RFC-3986 (percent encoding) we MUST - * encode everything except for "safe" characters; and nothing but them. - * Safe includes ascii letters (upper and lower case), digits (0 - 9) - * and FOUR special characters: hyphen ('-'), underscore ('_'), - * tilde ('~') and period ('.')). Everything else must be percent-encoded, - * byte-by-byte, using UTF-8 encoding (meaning three-byte Unicode/UTF-8 - * code points are encoded as three three-letter percent-encode entities). - */ - for (String value : values) { - RequestBuilder builder = new RequestBuilder("GET"). - setUrl("http://example.com/"). - addQueryParameter("name", value); - - StringBuilder sb = new StringBuilder(); - for (int i = 0, len = value.length(); i < len; ++i) { - char c = value.charAt(i); - if (SAFE_CHARS.indexOf(c) >= 0) { - sb.append(c); - } else { - int hi = (c >> 4); - int lo = c & 0xF; - sb.append('%').append(HEX_CHARS.charAt(hi)).append(HEX_CHARS.charAt(lo)); - } - } - String expValue = sb.toString(); - Request request = builder.build(); - assertEquals(request.getUrl(), "http://example.com/?name=" + expValue); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void testChaining() throws IOException, ExecutionException, InterruptedException { - Request request = new RequestBuilder("GET") - .setUrl("http://foo.com/") - .addQueryParameter("x", "value") - .build(); - - Request request2 = new RequestBuilder(request).build(); - - assertEquals(request2.getUrl(), request.getUrl()); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testParsesQueryParams() throws IOException, ExecutionException, InterruptedException { - Request request = new RequestBuilder("GET") - .setUrl("http://foo.com/?param1=value1") - .addQueryParameter("param2", "value2") - .build(); - - assertEquals(request.getUrl(), "http://foo.com/?param1=value1¶m2=value2"); - FluentStringsMap params = request.getQueryParams(); - assertEquals(params.size(), 2); - assertEquals(params.get("param1").get(0), "value1"); - assertEquals(params.get("param2").get(0), "value2"); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testUserProvidedRequestMethod() { - Request req = new RequestBuilder("ABC").setUrl("http://foo.com/").build(); - assertEquals(req.getMethod(), "ABC"); - assertEquals(req.getUrl(), "http://foo.com/"); - } -} diff --git a/src/test/java/com/ning/http/client/async/RetryNonBlockingIssue.java b/src/test/java/com/ning/http/client/async/RetryNonBlockingIssue.java deleted file mode 100644 index 247fe8c2a3..0000000000 --- a/src/test/java/com/ning/http/client/async/RetryNonBlockingIssue.java +++ /dev/null @@ -1,331 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ListenableFuture; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; -import org.eclipse.jetty.server.Connector; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.servlet.ServletContextHandler; -import org.eclipse.jetty.servlet.ServletHolder; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.BeforeMethod; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.ServerSocket; -import java.net.URI; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.UUID; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ExecutionException; - -import static org.testng.Assert.assertTrue; - - -public class RetryNonBlockingIssue { - - private URI servletEndpointUri; - - private Server server; - - private int port1; - - public static int findFreePort() throws IOException { - ServerSocket socket = null; - - try { - // 0 is open a socket on any free port - socket = new ServerSocket(0); - return socket.getLocalPort(); - } finally { - if (socket != null) { - socket.close(); - } - } - } - - - @BeforeMethod - public void setUp() throws Exception { - server = new Server(); - - port1 = findFreePort(); - - Connector listener = new SelectChannelConnector(); - listener.setHost("127.0.0.1"); - listener.setPort(port1); - - server.addConnector(listener); - - - ServletContextHandler context = new - ServletContextHandler(ServletContextHandler.SESSIONS); - - context.setContextPath("/"); - server.setHandler(context); - context.addServlet(new ServletHolder(new - MockExceptionServlet()), "/*"); - - server.start(); - - servletEndpointUri = new URI("http://127.0.0.1/" + port1 + "/"); - } - - @AfterMethod - public void stop() { - - try { - if (server != null) server.stop(); - } catch (Exception e) { - } - - - } - - private ListenableFuture testMethodRequest(AsyncHttpClient - fetcher, int requests, String action, String id) throws IOException { - RequestBuilder builder = new RequestBuilder("GET"); - builder.addQueryParameter(action, "1"); - - builder.addQueryParameter("maxRequests", "" + requests); - builder.addQueryParameter("id", id); - builder.setUrl(servletEndpointUri.toString()); - com.ning.http.client.Request r = builder.build(); - return fetcher.executeRequest(r); - - } - - /** - * Tests that a head request can be made - * - * @throws IOException - * @throws ExecutionException - * @throws InterruptedException - */ - @Test - public void testRetryNonBlocking() throws IOException, InterruptedException, - ExecutionException { - AsyncHttpClient c = null; - List> res = new - ArrayList>(); - try { - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setAllowPoolingConnection(true); - bc.setMaximumConnectionsTotal(100); - bc.setConnectionTimeoutInMs(60000); - bc.setRequestTimeoutInMs(30000); - - NettyAsyncHttpProviderConfig config = new - NettyAsyncHttpProviderConfig(); - - bc.setAsyncHttpClientProviderConfig(config); - c = new AsyncHttpClient(bc.build()); - - for (int i = 0; i < 32; i++) { - res.add(testMethodRequest(c, 3, "servlet", UUID.randomUUID().toString())); - } - - StringBuilder b = new StringBuilder(); - for (ListenableFuture r : res) { - Response theres = r.get(); - b.append("==============\r\n"); - b.append("Response Headers\r\n"); - Map> heads = theres.getHeaders(); - b.append(heads + "\r\n"); - b.append("==============\r\n"); - assertTrue(heads.size() > 0); - } - System.out.println(b.toString()); - System.out.flush(); - - } - finally { - if (c != null) c.close(); - } - } - - @Test - public void testRetryNonBlockingAsyncConnect() throws IOException, InterruptedException, - ExecutionException { - AsyncHttpClient c = null; - List> res = new - ArrayList>(); - try { - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setAllowPoolingConnection(true); - bc.setMaximumConnectionsTotal(100); - bc.setConnectionTimeoutInMs(60000); - bc.setRequestTimeoutInMs(30000); - - NettyAsyncHttpProviderConfig config = new - NettyAsyncHttpProviderConfig(); - config.addProperty(NettyAsyncHttpProviderConfig.EXECUTE_ASYNC_CONNECT, "true"); - - bc.setAsyncHttpClientProviderConfig(config); - c = new AsyncHttpClient(bc.build()); - - for (int i = 0; i < 32; i++) { - res.add(testMethodRequest(c, 3, "servlet", UUID.randomUUID().toString())); - } - - StringBuilder b = new StringBuilder(); - for (ListenableFuture r : res) { - Response theres = r.get(); - b.append("==============\r\n"); - b.append("Response Headers\r\n"); - Map> heads = theres.getHeaders(); - b.append(heads + "\r\n"); - b.append("==============\r\n"); - assertTrue(heads.size() > 0); - } - System.out.println(b.toString()); - System.out.flush(); - - } - finally { - if (c != null) c.close(); - } - } - - @Test - public void testRetryBlocking() throws IOException, InterruptedException, - ExecutionException { - AsyncHttpClient c = null; - List> res = new - ArrayList>(); - try { - AsyncHttpClientConfig.Builder bc = - new AsyncHttpClientConfig.Builder(); - - bc.setAllowPoolingConnection(true); - bc.setMaximumConnectionsTotal(100); - bc.setConnectionTimeoutInMs(30000); - bc.setRequestTimeoutInMs(30000); - - NettyAsyncHttpProviderConfig config = new - NettyAsyncHttpProviderConfig(); - config.addProperty(NettyAsyncHttpProviderConfig.USE_BLOCKING_IO, "true"); - - bc.setAsyncHttpClientProviderConfig(config); - c = new AsyncHttpClient(bc.build()); - - for (int i = 0; i < 32; i++) { - res.add(testMethodRequest(c, 3, "servlet", UUID.randomUUID().toString())); - } - - StringBuilder b = new StringBuilder(); - for (ListenableFuture r : res) { - Response theres = r.get(); - b.append("==============\r\n"); - b.append("Response Headers\r\n"); - Map> heads = theres.getHeaders(); - b.append(heads + "\r\n"); - b.append("==============\r\n"); - assertTrue(heads.size() > 0); - - } - System.out.println(b.toString()); - System.out.flush(); - - } - finally { - if (c != null) c.close(); - } - } - - public class MockExceptionServlet extends HttpServlet { - - private Map requests = new - ConcurrentHashMap(); - - private synchronized int increment(String id) { - int val = 0; - if (requests.containsKey(id)) { - Integer i = requests.get(id); - val = i + 1; - requests.put(id, val); - } else { - requests.put(id, 1); - val = 1; - } - System.out.println("REQUESTS: " + requests); - return val; - } - - public void service(HttpServletRequest req, HttpServletResponse res) - throws ServletException, IOException { - String maxRequests = req.getParameter("maxRequests"); - int max = 0; - try { - max = Integer.parseInt(maxRequests); - } - catch (NumberFormatException e) { - max = 3; - } - String id = req.getParameter("id"); - int requestNo = increment(id); - String servlet = req.getParameter("servlet"); - String io = req.getParameter("io"); - String error = req.getParameter("500"); - - - if (requestNo >= max) { - res.setHeader("Success-On-Attempt", "" + requestNo); - res.setHeader("id", id); - if (servlet != null && servlet.trim().length() > 0) - res.setHeader("type", "servlet"); - if (error != null && error.trim().length() > 0) - res.setHeader("type", "500"); - if (io != null && io.trim().length() > 0) - res.setHeader("type", "io"); - res.setStatus(200); - res.setContentLength(0); - return; - } - - - res.setStatus(200); - res.setContentLength(100); - res.setContentType("application/octet-stream"); - - res.flushBuffer(); - - if (servlet != null && servlet.trim().length() > 0) - throw new ServletException("Servlet Exception"); - - if (io != null && io.trim().length() > 0) - throw new IOException("IO Exception"); - - if (error != null && error.trim().length() > 0) - res.sendError(500, "servlet process was 500"); - } - - } -} - diff --git a/src/test/java/com/ning/http/client/async/SimpleAsyncClientErrorBehaviourTest.java b/src/test/java/com/ning/http/client/async/SimpleAsyncClientErrorBehaviourTest.java deleted file mode 100644 index 4206f6b96d..0000000000 --- a/src/test/java/com/ning/http/client/async/SimpleAsyncClientErrorBehaviourTest.java +++ /dev/null @@ -1,95 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import static org.testng.Assert.*; - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.util.concurrent.Future; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; - -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import com.ning.http.client.SimpleAsyncHttpClient; -import com.ning.http.client.SimpleAsyncHttpClient.ErrorDocumentBehaviour; -import com.ning.http.client.consumers.OutputStreamBodyConsumer; - -/** - * @author Benjamin Hanzelmann - * - */ -public class SimpleAsyncClientErrorBehaviourTest extends AbstractBasicTest { - - @Test(groups = {"standalone", "default_provider"}) - public void testAccumulateErrorBody() throws Throwable { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl() + "/nonexistent").setErrorDocumentBehaviour( ErrorDocumentBehaviour.ACCUMULATE ).build(); - - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - Future future = client.get(new OutputStreamBodyConsumer(o)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 404); - assertEquals(o.toString(), ""); - assertTrue(response.getResponseBody().startsWith("")); - - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testOmitErrorBody() throws Throwable { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl() + "/nonexistent").setErrorDocumentBehaviour( ErrorDocumentBehaviour.OMIT ).build(); - - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - Future future = client.get(new OutputStreamBodyConsumer(o)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 404); - assertEquals(o.toString(), ""); - assertEquals(response.getResponseBody(), ""); - client.close(); - } - - @Override - public AsyncHttpClient getAsyncHttpClient( AsyncHttpClientConfig config ) - { - // disabled - return null; - } - - @Override - public AbstractHandler configureHandler() - throws Exception - { - return new AbstractHandler() { - - public void handle( String target, org.eclipse.jetty.server.Request baseRequest, - HttpServletRequest request, HttpServletResponse response ) - throws IOException, ServletException - { - response.sendError( 404 ); - baseRequest.setHandled( true ); - } - }; - } - -} diff --git a/src/test/java/com/ning/http/client/async/SimpleAsyncHttpClientTest.java b/src/test/java/com/ning/http/client/async/SimpleAsyncHttpClientTest.java deleted file mode 100644 index 2a6cfcfd15..0000000000 --- a/src/test/java/com/ning/http/client/async/SimpleAsyncHttpClientTest.java +++ /dev/null @@ -1,290 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.ByteArrayPart; -import com.ning.http.client.Response; -import com.ning.http.client.SimpleAsyncHttpClient; -import com.ning.http.client.consumers.AppendableBodyConsumer; -import com.ning.http.client.consumers.OutputStreamBodyConsumer; -import com.ning.http.client.generators.FileBodyGenerator; -import com.ning.http.client.generators.InputStreamBodyGenerator; -import com.ning.http.client.simple.HeaderMap; -import com.ning.http.client.simple.SimpleAHCTransferListener; -import org.testng.annotations.Test; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.File; -import java.io.IOException; -import java.util.concurrent.Future; - -import static junit.framework.Assert.assertTrue; -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.fail; -import static org.testng.AssertJUnit.assertNotNull; -import static org.testng.AssertJUnit.assertNotSame; - -public abstract class SimpleAsyncHttpClientTest extends AbstractBasicTest { - - private final static String MY_MESSAGE = "my message"; - - @Test(groups = { "standalone", "default_provider" }) - public void inpuStreamBodyConsumerTest() throws Throwable { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setIdleConnectionInPoolTimeoutInMs(100).setMaximumConnectionsTotal(50) - .setRequestTimeoutInMs(5 * 60 * 1000).setUrl(getTargetUrl()).setHeader("Content-Type", "text/html").build(); - - Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes()))); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(response.getResponseBody(), MY_MESSAGE); - - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void StringBufferBodyConsumerTest() throws Throwable { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setIdleConnectionInPoolTimeoutInMs(100).setMaximumConnectionsTotal(50) - .setRequestTimeoutInMs(5 * 60 * 1000).setUrl(getTargetUrl()).setHeader("Content-Type", "text/html").build(); - - StringBuilder s = new StringBuilder(); - Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())), new AppendableBodyConsumer(s)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(s.toString(), MY_MESSAGE); - - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void ByteArrayOutputStreamBodyConsumerTest() throws Throwable { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setIdleConnectionInPoolTimeoutInMs(100).setMaximumConnectionsTotal(50) - .setRequestTimeoutInMs(5 * 60 * 1000).setUrl(getTargetUrl()).setHeader("Content-Type", "text/html").build(); - - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())), new OutputStreamBodyConsumer(o)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(o.toString(), MY_MESSAGE); - - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void RequestByteArrayOutputStreamBodyConsumerTest() throws Throwable { - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl()).build(); - - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - Future future = client.post(new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())), new OutputStreamBodyConsumer(o)); - - System.out.println("waiting for response"); - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(o.toString(), MY_MESSAGE); - - client.close(); - } - - /** - * See https://issues.sonatype.org/browse/AHC-5 - */ - @Test(groups = { "standalone", "default_provider" }, enabled = true) - public void testPutZeroBytesFileTest() throws Throwable { - System.err.println("setting up client"); - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setIdleConnectionInPoolTimeoutInMs(100).setMaximumConnectionsTotal(50) - .setRequestTimeoutInMs(5 * 1000).setUrl(getTargetUrl() + "/testPutZeroBytesFileTest.txt").setHeader("Content-Type", "text/plain").build(); - - File tmpfile = File.createTempFile("testPutZeroBytesFile", ".tmp"); - tmpfile.deleteOnExit(); - - Future future = client.put(new FileBodyGenerator(tmpfile)); - - System.out.println("waiting for response"); - Response response = future.get(); - - tmpfile.delete(); - - assertEquals(response.getStatusCode(), 200); - - client.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testDerive() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().build(); - SimpleAsyncHttpClient derived = client.derive().build(); - - assertNotSame(derived, client); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testDeriveOverrideURL() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl("http://invalid.url/").build(); - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - - InputStreamBodyGenerator generator = new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())); - OutputStreamBodyConsumer consumer = new OutputStreamBodyConsumer(o); - - SimpleAsyncHttpClient derived = client.derive().setUrl(getTargetUrl()).build(); - - Future future = derived.post(generator, consumer); - - Response response = future.get(); - assertEquals(response.getStatusCode(), 200); - assertEquals(o.toString(), MY_MESSAGE); - - client.close(); - derived.close(); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testSimpleTransferListener() throws Exception { - - SimpleAHCTransferListener listener = new SimpleAHCTransferListener() { - - public void onStatus(String url, int statusCode, String statusText) { - assertEquals(statusCode, 200); - assertEquals(url, getTargetUrl()); - } - - public void onHeaders(String url, HeaderMap headers) { - assertEquals(url, getTargetUrl()); - assertNotNull(headers); - assertTrue(!headers.isEmpty()); - assertEquals(headers.getFirstValue("X-Custom"), "custom"); - } - - public void onCompleted(String url, int statusCode, String statusText) { - assertEquals(statusCode, 200); - assertEquals(url, getTargetUrl()); - } - - public void onBytesSent(String url, long amount, long current, long total) { - assertEquals(url, getTargetUrl()); - assertEquals(total, MY_MESSAGE.getBytes().length); - } - - public void onBytesReceived(String url, long amount, long current, long total) { - assertEquals(url, getTargetUrl()); - assertEquals(total, -1); - } - }; - - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl()).setHeader("Custom", "custom").setListener(listener).build(); - ByteArrayOutputStream o = new ByteArrayOutputStream(10); - - InputStreamBodyGenerator generator = new InputStreamBodyGenerator(new ByteArrayInputStream(MY_MESSAGE.getBytes())); - OutputStreamBodyConsumer consumer = new OutputStreamBodyConsumer(o); - - Future future = client.post(generator, consumer); - - Response response = future.get(); - client.close(); - assertEquals(response.getStatusCode(), 200); - assertEquals(o.toString(), MY_MESSAGE); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testNullUrl() throws Exception { - try { - new SimpleAsyncHttpClient.Builder().build().derive().build(); - assertTrue(true); - } catch (NullPointerException ex) { - fail(); - } - } - - @Test(groups = { "standalone", "default_provider" }) - public void testCloseDerivedValidMaster() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl()).build(); - SimpleAsyncHttpClient derived = client.derive().build(); - - derived.get().get(); - - derived.close(); - - Response response = client.get().get(); - - assertEquals(response.getStatusCode(), 200); - } - - @Test(groups = { "standalone", "default_provider" }) - public void testCloseMasterInvalidDerived() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl()).build(); - SimpleAsyncHttpClient derived = client.derive().build(); - - client.close(); - - try { - derived.get().get(); - fail("Expected closed AHC"); - } catch (IOException e) { - // expected - } - } - - @Test(groups = { "standalone", "default_provider" }) - public void testMultiPartPut() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl() + "/multipart").build(); - - Response response = client.put(new ByteArrayPart("baPart", "fileName", "testMultiPart".getBytes("utf-8"), "application/test", "utf-8")).get(); - - String body = response.getResponseBody(); - String contentType = response.getHeader("X-Content-Type"); - - assertTrue(contentType.contains("multipart/form-data")); - - String boundary = contentType.substring(contentType.lastIndexOf("=") + 1); - - assertTrue(body.startsWith("--" + boundary)); - assertTrue(body.trim().endsWith("--" + boundary + "--")); - assertTrue(body.contains("Content-Disposition:")); - assertTrue(body.contains("Content-Type: application/test")); - assertTrue(body.contains("name=\"baPart")); - assertTrue(body.contains("filename=\"fileName")); - - } - - @Test(groups = { "standalone", "default_provider" }) - public void testMultiPartPost() throws Exception { - SimpleAsyncHttpClient client = new SimpleAsyncHttpClient.Builder().setUrl(getTargetUrl() + "/multipart").build(); - - Response response = client.post(new ByteArrayPart("baPart", "fileName", "testMultiPart".getBytes("utf-8"), "application/test", "utf-8")).get(); - - String body = response.getResponseBody(); - String contentType = response.getHeader("X-Content-Type"); - - assertTrue(contentType.contains("multipart/form-data")); - - String boundary = contentType.substring(contentType.lastIndexOf("=") + 1); - - assertTrue(body.startsWith("--" + boundary)); - assertTrue(body.trim().endsWith("--" + boundary + "--")); - assertTrue(body.contains("Content-Disposition:")); - assertTrue(body.contains("Content-Type: application/test")); - assertTrue(body.contains("name=\"baPart")); - assertTrue(body.contains("filename=\"fileName")); - - } - -} diff --git a/src/test/java/com/ning/http/client/async/TransferListenerTest.java b/src/test/java/com/ning/http/client/async/TransferListenerTest.java deleted file mode 100644 index e2b80690c7..0000000000 --- a/src/test/java/com/ning/http/client/async/TransferListenerTest.java +++ /dev/null @@ -1,285 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.Response; -import com.ning.http.client.generators.FileBodyGenerator; -import com.ning.http.client.listener.TransferCompletionHandler; -import com.ning.http.client.listener.TransferListener; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.nio.ByteBuffer; -import java.util.Enumeration; -import java.util.UUID; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.concurrent.atomic.AtomicReference; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.fail; - -public abstract class TransferListenerTest extends AbstractBasicTest { - private static final File TMP = new File(System.getProperty("java.io.tmpdir"), "ahc-tests-" - + UUID.randomUUID().toString().substring(0, 8)); - - private class BasicHandler extends AbstractHandler { - - public void handle(String s, - org.eclipse.jetty.server.Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - Enumeration e = httpRequest.getHeaderNames(); - String param; - while (e.hasMoreElements()) { - param = e.nextElement().toString(); - httpResponse.addHeader("X-" + param, httpRequest.getHeader(param)); - } - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - httpRequest.getInputStream().read(bytes); - httpResponse.getOutputStream().write(bytes); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - httpResponse.getOutputStream().close(); - } - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new BasicHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicGetTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - final AtomicReference throwable = new AtomicReference(); - final AtomicReference hSent = new AtomicReference(); - final AtomicReference hRead = new AtomicReference(); - final AtomicReference bb = new AtomicReference(); - final AtomicBoolean completed = new AtomicBoolean(false); - - TransferCompletionHandler tl = new TransferCompletionHandler(); - tl.addTransferListener(new TransferListener() { - - public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers) { - hSent.set(headers); - } - - public void onResponseHeadersReceived(FluentCaseInsensitiveStringsMap headers) { - hRead.set(headers); - } - - public void onBytesReceived(ByteBuffer buffer) { - bb.set(buffer); - } - - public void onBytesSent(ByteBuffer buffer) { - } - - public void onRequestResponseCompleted() { - completed.set(true); - } - - public void onThrowable(Throwable t) { - throwable.set(t); - } - }); - - try { - Response response = c.prepareGet(getTargetUrl()) - .execute(tl).get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertNotNull(hRead.get()); - assertNotNull(hSent.get()); - assertNotNull(bb.get()); - assertNull(throwable.get()); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicPutTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - final AtomicReference throwable = new AtomicReference(); - final AtomicReference hSent = new AtomicReference(); - final AtomicReference hRead = new AtomicReference(); - final AtomicInteger bbReceivedLenght = new AtomicInteger(0); - final AtomicInteger bbSentLenght = new AtomicInteger(0); - - final AtomicBoolean completed = new AtomicBoolean(false); - - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 * 100 * 10 / bytes.length) + 1; - File largeFile = createTempFile(bytes, (int) repeats); - - TransferCompletionHandler tl = new TransferCompletionHandler(); - tl.addTransferListener(new TransferListener() { - - public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers) { - hSent.set(headers); - } - - public void onResponseHeadersReceived(FluentCaseInsensitiveStringsMap headers) { - hRead.set(headers); - } - - public void onBytesReceived(ByteBuffer buffer) { - bbReceivedLenght.addAndGet(buffer.capacity()); - } - - public void onBytesSent(ByteBuffer buffer) { - bbSentLenght.addAndGet(buffer.capacity()); - } - - public void onRequestResponseCompleted() { - completed.set(true); - } - - public void onThrowable(Throwable t) { - throwable.set(t); - } - }); - - try { - Response response = c.preparePut(getTargetUrl()).setBody(largeFile) - .execute(tl).get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertNotNull(hRead.get()); - assertNotNull(hSent.get()); - assertEquals(bbReceivedLenght.get(), largeFile.length()); - assertEquals(bbSentLenght.get(), largeFile.length()); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicPutBodyTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(null); - - final AtomicReference throwable = new AtomicReference(); - final AtomicReference hSent = new AtomicReference(); - final AtomicReference hRead = new AtomicReference(); - final AtomicInteger bbReceivedLenght = new AtomicInteger(0); - final AtomicInteger bbSentLenght = new AtomicInteger(0); - - final AtomicBoolean completed = new AtomicBoolean(false); - - byte[] bytes = "RatherLargeFileRatherLargeFileRatherLargeFileRatherLargeFile".getBytes("UTF-16"); - long repeats = (1024 * 100 * 10 / bytes.length) + 1; - File largeFile = createTempFile(bytes, (int) repeats); - - TransferCompletionHandler tl = new TransferCompletionHandler(); - tl.addTransferListener(new TransferListener() { - - public void onRequestHeadersSent(FluentCaseInsensitiveStringsMap headers) { - hSent.set(headers); - } - - public void onResponseHeadersReceived(FluentCaseInsensitiveStringsMap headers) { - hRead.set(headers); - } - - public void onBytesReceived(ByteBuffer buffer) { - bbReceivedLenght.addAndGet(buffer.capacity()); - } - - public void onBytesSent(ByteBuffer buffer) { - bbSentLenght.addAndGet(buffer.capacity()); - } - - public void onRequestResponseCompleted() { - completed.set(true); - } - - public void onThrowable(Throwable t) { - throwable.set(t); - } - }); - - try { - Response response = c.preparePut(getTargetUrl()).setBody(new FileBodyGenerator(largeFile)) - .execute(tl).get(); - - assertNotNull(response); - assertEquals(response.getStatusCode(), 200); - assertNotNull(hRead.get()); - assertNotNull(hSent.get()); - assertEquals(bbReceivedLenght.get(), largeFile.length()); - assertEquals(bbSentLenght.get(), largeFile.length()); - } catch (IOException ex) { - fail("Should have timed out"); - } - c.close(); - } - - public String getTargetUrl() { - return String.format("http://127.0.0.1:%d/foo/test", port1); - } - - public static File createTempFile(byte[] pattern, int repeat) - throws IOException { - TMP.mkdirs(); - TMP.deleteOnExit(); - File tmpFile = File.createTempFile("tmpfile-", ".data", TMP); - write(pattern, repeat, tmpFile); - - return tmpFile; - } - - public static void write(byte[] pattern, int repeat, File file) - throws IOException { - file.deleteOnExit(); - file.getParentFile().mkdirs(); - FileOutputStream out = null; - try { - out = new FileOutputStream(file); - for (int i = 0; i < repeat; i++) { - out.write(pattern); - } - } - finally { - if (out != null) { - out.close(); - } - } - } -} diff --git a/src/test/java/com/ning/http/client/async/WebDavBasicTest.java b/src/test/java/com/ning/http/client/async/WebDavBasicTest.java deleted file mode 100644 index 77b69dcf67..0000000000 --- a/src/test/java/com/ning/http/client/async/WebDavBasicTest.java +++ /dev/null @@ -1,184 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import com.ning.http.client.webdav.WebDavCompletionHandlerBase; -import com.ning.http.client.webdav.WebDavResponse; -import org.apache.catalina.Context; -import org.apache.catalina.Engine; -import org.apache.catalina.Host; -import org.apache.catalina.Wrapper; -import org.apache.catalina.connector.Connector; -import org.apache.catalina.startup.Embedded; -import org.apache.coyote.http11.Http11NioProtocol; -import org.testng.annotations.AfterClass; -import org.testng.annotations.AfterMethod; -import org.testng.annotations.BeforeClass; -import org.testng.annotations.Test; - -import java.io.File; -import java.io.IOException; -import java.util.concurrent.ExecutionException; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertTrue; - - -public abstract class WebDavBasicTest extends AbstractBasicTest { - - public Embedded embedded; - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - - port1 = findFreePort(); - embedded = new Embedded(); - String path = new File(".").getAbsolutePath(); - embedded.setCatalinaHome(path); - - Engine engine = embedded.createEngine(); - engine.setDefaultHost("127.0.0.1"); - - Host host = embedded.createHost("127.0.0.1", path); - engine.addChild(host); - - Context c = embedded.createContext("/", path); - c.setReloadable(false); - Wrapper w = c.createWrapper(); - w.addMapping("/*"); - w.setServletClass(org.apache.catalina.servlets.WebdavServlet.class.getName()); - w.addInitParameter("readonly", "false"); - w.addInitParameter("listings", "true"); - - w.setLoadOnStartup(0); - - c.addChild(w); - host.addChild(c); - - Connector connector = embedded.createConnector("127.0.0.1", port1, Http11NioProtocol.class.getName()); - connector.setContainer(host); - embedded.addEngine(engine); - embedded.addConnector(connector); - embedded.start(); - } - - protected String getTargetUrl() { - return String.format("http://127.0.0.1:%s/folder1", port1); - } - - @AfterMethod(alwaysRun = true) - public void clean() throws InterruptedException, Exception { - AsyncHttpClient c = getAsyncHttpClient(null); - - Request deleteRequest = new RequestBuilder("DELETE").setUrl(getTargetUrl()).build(); - c.executeRequest(deleteRequest).get(); - } - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws InterruptedException, Exception { - embedded.stop(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void mkcolWebDavTest1() throws InterruptedException, IOException, ExecutionException { - - AsyncHttpClient c = getAsyncHttpClient(null); - Request mkcolRequest = new RequestBuilder("MKCOL").setUrl(getTargetUrl()).build(); - Response response = c.executeRequest(mkcolRequest).get(); - - assertEquals(response.getStatusCode(), 201); - - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void mkcolWebDavTest2() throws InterruptedException, IOException, ExecutionException { - - AsyncHttpClient c = getAsyncHttpClient(null); - - Request mkcolRequest = new RequestBuilder("MKCOL").setUrl(getTargetUrl() + "/folder2").build(); - Response response = c.executeRequest(mkcolRequest).get(); - assertEquals(response.getStatusCode(), 409); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void basicPropFindWebDavTest() throws InterruptedException, IOException, ExecutionException { - - AsyncHttpClient c = getAsyncHttpClient(null); - Request propFindRequest = new RequestBuilder("PROPFIND").setUrl(getTargetUrl()).build(); - Response response = c.executeRequest(propFindRequest).get(); - - assertEquals(response.getStatusCode(), 404); - c.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void propFindWebDavTest() throws InterruptedException, IOException, ExecutionException { - - AsyncHttpClient c = getAsyncHttpClient(null); - - Request mkcolRequest = new RequestBuilder("MKCOL").setUrl(getTargetUrl()).build(); - Response response = c.executeRequest(mkcolRequest).get(); - assertEquals(response.getStatusCode(), 201); - - Request putRequest = new RequestBuilder("PUT").setUrl(String.format("http://127.0.0.1:%s/folder1/Test.txt", port1)).setBody("this is a test").build(); - response = c.executeRequest(putRequest).get(); - assertEquals(response.getStatusCode(), 201); - - Request propFindRequest = new RequestBuilder("PROPFIND").setUrl(String.format("http://127.0.0.1:%s/folder1/Test.txt", port1)).build(); - response = c.executeRequest(propFindRequest).get(); - - assertEquals(response.getStatusCode(), 207); - assertTrue(response.getResponseBody().contains("HTTP/1.1 200 OK")); - c.close(); - - } - - @Test(groups = {"standalone", "default_provider"}) - public void propFindCompletionHandlerWebDavTest() throws InterruptedException, IOException, ExecutionException { - - AsyncHttpClient c = getAsyncHttpClient(null); - - Request mkcolRequest = new RequestBuilder("MKCOL").setUrl(getTargetUrl()).build(); - Response response = c.executeRequest(mkcolRequest).get(); - assertEquals(response.getStatusCode(), 201); - - Request propFindRequest = new RequestBuilder("PROPFIND").setUrl(getTargetUrl()).build(); - WebDavResponse webDavResponse = c.executeRequest(propFindRequest, new WebDavCompletionHandlerBase() { - /** - * {@inheritDoc} - */ - /* @Override */ - public void onThrowable(Throwable t) { - - t.printStackTrace(); - } - - @Override - public WebDavResponse onCompleted(WebDavResponse response) throws Exception { - return response; - } - }).get(); - - assertNotNull(webDavResponse); - assertEquals(webDavResponse.getStatusCode(), 200); - c.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/ZeroCopyFileTest.java b/src/test/java/com/ning/http/client/async/ZeroCopyFileTest.java deleted file mode 100644 index 64efdb4c29..0000000000 --- a/src/test/java/com/ning/http/client/async/ZeroCopyFileTest.java +++ /dev/null @@ -1,218 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.HttpResponseBodyPart; -import com.ning.http.client.HttpResponseHeaders; -import com.ning.http.client.HttpResponseStatus; -import com.ning.http.client.Response; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.handler.AbstractHandler; -import org.testng.annotations.Test; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.File; -import java.io.FileOutputStream; -import java.io.IOException; -import java.net.URISyntaxException; -import java.net.URL; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.Future; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicBoolean; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNotNull; -import static org.testng.Assert.assertNull; -import static org.testng.Assert.assertTrue; - -/** - * Zero copy test which use FileChannel.transfer under the hood . The same SSL test is also covered in {@link com.ning.http.client.async.BasicHttpsTest} - */ -public abstract class ZeroCopyFileTest extends AbstractBasicTest { - - private class ZeroCopyHandler extends AbstractHandler { - public void handle(String s, - Request r, - HttpServletRequest httpRequest, - HttpServletResponse httpResponse) throws IOException, ServletException { - - int size = 10 * 1024; - if (httpRequest.getContentLength() > 0) { - size = httpRequest.getContentLength(); - } - byte[] bytes = new byte[size]; - if (bytes.length > 0) { - httpRequest.getInputStream().read(bytes); - httpResponse.getOutputStream().write(bytes); - } - - httpResponse.setStatus(200); - httpResponse.getOutputStream().flush(); - } - } - - @Test(groups = {"standalone", "default_provider"}) - public void zeroCopyPostTest() throws IOException, ExecutionException, TimeoutException, InterruptedException, URISyntaxException { - AsyncHttpClient client = getAsyncHttpClient(null); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - final AtomicBoolean headerSent = new AtomicBoolean(false); - final AtomicBoolean operationCompleted = new AtomicBoolean(false); - - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/").setBody(file).execute(new AsyncCompletionHandler() { - - public STATE onHeaderWriteCompleted() { - headerSent.set(true); - return STATE.CONTINUE; - } - - public STATE onContentWriteCompleted() { - operationCompleted.set(true); - return STATE.CONTINUE; - } - - @Override - public Object onCompleted(Response response) throws Exception { - return response; - } - }); - Response resp = f.get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "This is a simple test file"); - assertTrue(operationCompleted.get()); - assertTrue(headerSent.get()); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void zeroCopyPutTest() throws IOException, ExecutionException, TimeoutException, InterruptedException, URISyntaxException { - AsyncHttpClient client = getAsyncHttpClient(null); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - Future f = client.preparePut("http://127.0.0.1/" + port1 + "/").setBody(file).execute(); - Response resp = f.get(); - assertNotNull(resp); - assertEquals(resp.getStatusCode(), HttpServletResponse.SC_OK); - assertEquals(resp.getResponseBody(), "This is a simple test file"); - client.close(); - - } - - @Override - public AbstractHandler configureHandler() throws Exception { - return new ZeroCopyHandler(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void zeroCopyFileTest() throws IOException, ExecutionException, TimeoutException, InterruptedException, URISyntaxException { - AsyncHttpClient client = getAsyncHttpClient(null); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - File tmp = new File(System.getProperty("java.io.tmpdir") + File.separator + "zeroCopy.txt"); - tmp.deleteOnExit(); - final FileOutputStream stream = new FileOutputStream(tmp); - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/").setBody(file).execute(new AsyncHandler() { - public void onThrowable(Throwable t) { - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - bodyPart.writeTo(stream); - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return null; - } - }); - Response resp = f.get(); - stream.close(); - assertNull(resp); - assertEquals(file.length(), tmp.length()); - client.close(); - - } - - - @Test(groups = {"standalone", "default_provider"}) - public void zeroCopyFileWithBodyManipulationTest() throws IOException, ExecutionException, TimeoutException, InterruptedException, URISyntaxException { - AsyncHttpClient client = getAsyncHttpClient(null); - - ClassLoader cl = getClass().getClassLoader(); - // override system properties - URL url = cl.getResource("SimpleTextFile.txt"); - File file = new File(url.toURI()); - - File tmp = new File(System.getProperty("java.io.tmpdir") + File.separator + "zeroCopy.txt"); - tmp.deleteOnExit(); - final FileOutputStream stream = new FileOutputStream(tmp); - Future f = client.preparePost("http://127.0.0.1/" + port1 + "/").setBody(file).execute(new AsyncHandler() { - public void onThrowable(Throwable t) { - } - - public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { - bodyPart.writeTo(stream); - - if (bodyPart.getBodyPartBytes().length == 0) { - return STATE.ABORT; - } - - return STATE.CONTINUE; - } - - public STATE onStatusReceived(HttpResponseStatus responseStatus) throws Exception { - return STATE.CONTINUE; - } - - public STATE onHeadersReceived(HttpResponseHeaders headers) throws Exception { - return STATE.CONTINUE; - } - - public Response onCompleted() throws Exception { - return null; - } - }); - Response resp = f.get(); - stream.close(); - assertNull(resp); - assertEquals(file.length(), tmp.length()); - client.close(); - - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncProviderBasicTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncProviderBasicTest.java deleted file mode 100644 index c718e2e031..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncProviderBasicTest.java +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.Response; -import com.ning.http.client.async.AsyncProvidersBasicTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProviderConfig; -import com.ning.http.client.providers.grizzly.TransportCustomizer; -import org.glassfish.grizzly.filterchain.FilterChainBuilder; -import org.glassfish.grizzly.nio.transport.TCPNIOTransport; -import org.glassfish.grizzly.strategies.SameThreadIOStrategy; -import org.testng.Assert; -import org.testng.annotations.Test; - -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.TimeUnit; - -import static com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProviderConfig.Property.TRANSPORT_CUSTOMIZER; -import static org.testng.Assert.assertEquals; - -public class GrizzlyAsyncProviderBasicTest extends AsyncProvidersBasicTest { - - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Override - @Test - public void asyncHeaderPOSTTest() throws Throwable { - super.asyncHeaderPOSTTest(); //To change body of overridden methods use File | Settings | File Templates. - } - - @Override - protected AsyncHttpProviderConfig getProviderConfig() { - final GrizzlyAsyncHttpProviderConfig config = new GrizzlyAsyncHttpProviderConfig(); - config.addProperty(TRANSPORT_CUSTOMIZER, new TransportCustomizer() { - @Override - public void customize(TCPNIOTransport transport, FilterChainBuilder builder) { - transport.setTcpNoDelay(true); - transport.setIOStrategy(SameThreadIOStrategy.getInstance()); - } - }); - return config; - } - - @Test(groups = {"standalone", "default_provider", "async"}, enabled = false) - public void asyncDoPostBasicGZIPTest() throws Throwable { - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamHandlerTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamHandlerTest.java deleted file mode 100644 index c9bb4de004..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamHandlerTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AsyncStreamHandlerTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyAsyncStreamHandlerTest extends AsyncStreamHandlerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamLifecycleTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamLifecycleTest.java deleted file mode 100644 index b2d376d690..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAsyncStreamLifecycleTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AsyncStreamLifecycleTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyAsyncStreamLifecycleTest extends AsyncStreamLifecycleTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAuthTimeoutTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAuthTimeoutTest.java deleted file mode 100644 index c0224564ca..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyAuthTimeoutTest.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AuthTimeoutTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyAuthTimeoutTest extends AuthTimeoutTest { - - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicAuthTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicAuthTest.java deleted file mode 100644 index 4f0dc2634e..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicAuthTest.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BasicAuthTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyBasicAuthTest extends BasicAuthTest { - - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicHttpsTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicHttpsTest.java deleted file mode 100644 index d5e27c68f2..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBasicHttpsTest.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BasicHttpsTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyBasicHttpsTest extends BasicHttpsTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Override - public void zeroCopyPostTest() throws Throwable { - super.zeroCopyPostTest(); //To change body of overridden methods use File | Settings | File Templates. - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyChunkTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyChunkTest.java deleted file mode 100644 index 643628e64f..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyChunkTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BodyChunkTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyBodyChunkTest extends BodyChunkTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyDeferringAsyncHandlerTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyDeferringAsyncHandlerTest.java deleted file mode 100644 index 889f49ad89..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyBodyDeferringAsyncHandlerTest.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BodyDeferringAsyncHandlerTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyBodyDeferringAsyncHandlerTest extends BodyDeferringAsyncHandlerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyByteBufferCapacityTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyByteBufferCapacityTest.java deleted file mode 100644 index b875ce10f4..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyByteBufferCapacityTest.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ByteBufferCapacityTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import org.testng.annotations.Test; - -public class GrizzlyByteBufferCapacityTest extends ByteBufferCapacityTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Test(groups = {"standalone", "default_provider"}, enabled=false) - public void basicByteBufferTest() throws Throwable { - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyChunkingTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyChunkingTest.java deleted file mode 100644 index 153f80c80b..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyChunkingTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ChunkingTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyChunkingTest extends ChunkingTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyComplexClientTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyComplexClientTest.java deleted file mode 100644 index 0b8b4a9d18..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyComplexClientTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ComplexClientTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyComplexClientTest extends ComplexClientTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyConnectionPoolTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyConnectionPoolTest.java deleted file mode 100644 index 37395056c1..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyConnectionPoolTest.java +++ /dev/null @@ -1,223 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncCompletionHandler; -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.ConnectionsPool; -import com.ning.http.client.Response; -import com.ning.http.client.async.ConnectionPoolTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import org.glassfish.grizzly.Connection; -import org.testng.annotations.Test; - -import java.io.IOException; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.atomic.AtomicInteger; - -import static org.testng.Assert.*; - -public class GrizzlyConnectionPoolTest extends ConnectionPoolTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Override - @Test - public void testMaxTotalConnectionsException() { - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setAllowPoolingConnection(true) - .setMaximumConnectionsTotal(1) - .build() - ); - - String url = getTargetUrl(); - int i; - Exception exception = null; - for (i = 0; i < 20; i++) { - try { - log.info("{} requesting url [{}]...", i, url); - - if (i < 5) { - client.prepareGet(url).execute().get(); - } else { - client.prepareGet(url).execute(); - } - } catch (Exception ex) { - exception = ex; - break; - } - } - assertNotNull(exception); - assertNotNull(exception.getMessage()); - - } - - @Override - public void testValidConnectionsPool() { - ConnectionsPool cp = new ConnectionsPool() { - - public boolean offer(String key, Connection connection) { - return true; - } - - public Connection poll(String connection) { - return null; - } - - public boolean removeAll(Connection connection) { - return false; - } - - public boolean canCacheConnection() { - return true; - } - - public void destroy() { - - } - }; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionsPool(cp) - .build() - ); - - Exception exception = null; - try { - client.prepareGet(getTargetUrl()).execute().get(TIMEOUT, TimeUnit.SECONDS); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNull(exception); - client.close(); - } - - @Test(groups = {"standalone", "default_provider"}) - public void testInvalidConnectionsPool() { - - ConnectionsPool cp = new ConnectionsPool() { - - public boolean offer(String key, Connection connection) { - return false; - } - - public Connection poll(String connection) { - return null; - } - - public boolean removeAll(Connection connection) { - return false; - } - - public boolean canCacheConnection() { - return false; - } - - public void destroy() { - - } - }; - - AsyncHttpClient client = getAsyncHttpClient( - new AsyncHttpClientConfig.Builder() - .setConnectionsPool(cp) - .build() - ); - - Exception exception = null; - try { - client.prepareGet(getTargetUrl()).execute().get(TIMEOUT, TimeUnit.SECONDS); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNotNull(exception); - client.close(); - } - - @Override - @Test - public void multipleMaxConnectionOpenTest() throws Throwable { - AsyncHttpClientConfig cg = new AsyncHttpClientConfig.Builder().setAllowPoolingConnection(true) - .setConnectionTimeoutInMs(5000).setMaximumConnectionsTotal(1).build(); - AsyncHttpClient c = getAsyncHttpClient(cg); - - String body = "hello there"; - - // once - Response response = c.preparePost(getTargetUrl()) - .setBody(body) - .execute().get(TIMEOUT, TimeUnit.SECONDS); - - assertEquals(response.getResponseBody(), body); - - // twice - Exception exception = null; - try { - c.preparePost(String.format("http://127.0.0.1:%d/foo/test", port2)).setBody(body).execute().get(TIMEOUT, TimeUnit.SECONDS); - fail("Should throw exception. Too many connections issued."); - } catch (Exception ex) { - ex.printStackTrace(); - exception = ex; - } - assertNotNull(exception); - c.close(); - } - - - @Override - @Test - public void win7DisconnectTest() throws Throwable { - final AtomicInteger count = new AtomicInteger(0); - - AsyncHttpClient client = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - AsyncCompletionHandler handler = new - AsyncCompletionHandlerAdapter() { - - @Override - public Response onCompleted(Response response) throws - Exception { - - count.incrementAndGet(); - StackTraceElement e = new StackTraceElement("sun.nio.ch.SocketDispatcher", "read0", null, -1); - IOException t = new IOException(); - t.setStackTrace(new StackTraceElement[]{e}); - throw t; - } - }; - - try { - client.prepareGet(getTargetUrl()).execute(handler).get(); - fail("Must have received an exception"); - } catch (ExecutionException ex) { - assertNotNull(ex); - assertNotNull(ex.getCause()); - assertEquals(ex.getCause().getClass(), IOException.class); - assertEquals(count.get(), 1); - } - client.close(); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyDigestAuthTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyDigestAuthTest.java deleted file mode 100644 index 95f2f8879a..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyDigestAuthTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.DigestAuthTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyDigestAuthTest extends DigestAuthTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyEmptyBodyTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyEmptyBodyTest.java deleted file mode 100644 index a6a88a4239..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyEmptyBodyTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.EmptyBodyTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyEmptyBodyTest extends EmptyBodyTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyErrorResponseTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyErrorResponseTest.java deleted file mode 100644 index 33c0ff2e7b..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyErrorResponseTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ErrorResponseTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyErrorResponseTest extends ErrorResponseTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyExpectContinue100Test.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyExpectContinue100Test.java deleted file mode 100644 index 09307e7185..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyExpectContinue100Test.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.Expect100ContinueTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyExpectContinue100Test extends Expect100ContinueTest{ - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFilterTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFilterTest.java deleted file mode 100644 index 19a7d7ce21..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFilterTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.FilterTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyFilterTest extends FilterTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFollowingThreadTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFollowingThreadTest.java deleted file mode 100644 index 9835a67d79..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyFollowingThreadTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.FollowingThreadTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyFollowingThreadTest extends FollowingThreadTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHead302Test.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHead302Test.java deleted file mode 100644 index a84023b1a2..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHead302Test.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.Head302Test; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyHead302Test extends Head302Test { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHttpToHttpsRedirectTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHttpToHttpsRedirectTest.java deleted file mode 100644 index c6ea5c47d5..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyHttpToHttpsRedirectTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.HttpToHttpsRedirectTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyHttpToHttpsRedirectTest extends HttpToHttpsRedirectTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyIdleStateHandlerTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyIdleStateHandlerTest.java deleted file mode 100644 index 1096adab69..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyIdleStateHandlerTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.IdleStateHandlerTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyIdleStateHandlerTest extends IdleStateHandlerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyInputStreamTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyInputStreamTest.java deleted file mode 100644 index 6702035939..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyInputStreamTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.InputStreamTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyInputStreamTest extends InputStreamTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyListenableFutureTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyListenableFutureTest.java deleted file mode 100644 index 285e612721..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyListenableFutureTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ListenableFutureTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyListenableFutureTest extends ListenableFutureTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxConnectionsInThreadsTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxConnectionsInThreadsTest.java deleted file mode 100644 index d9a95eace4..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxConnectionsInThreadsTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MaxConnectionsInThreads; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyMaxConnectionsInThreadsTest extends MaxConnectionsInThreads { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxTotalConnectionTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxTotalConnectionTest.java deleted file mode 100644 index eeb1c08bf4..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMaxTotalConnectionTest.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MaxTotalConnectionTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyMaxTotalConnectionTest extends MaxTotalConnectionTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMultipleHeaderTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMultipleHeaderTest.java deleted file mode 100644 index 9635878ac9..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyMultipleHeaderTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MultipleHeaderTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyMultipleHeaderTest extends MultipleHeaderTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNoNullResponseTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNoNullResponseTest.java deleted file mode 100644 index 2c4fac2577..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNoNullResponseTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.NoNullResponseTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyNoNullResponseTest extends NoNullResponseTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNonAsciiContentLengthTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNonAsciiContentLengthTest.java deleted file mode 100644 index 9ab8b96c3b..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyNonAsciiContentLengthTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.NonAsciiContentLengthTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyNonAsciiContentLengthTest extends NonAsciiContentLengthTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyParamEncodingTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyParamEncodingTest.java deleted file mode 100644 index 98fe02b2e7..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyParamEncodingTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ParamEncodingTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyParamEncodingTest extends ParamEncodingTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestRelative302Test.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestRelative302Test.java deleted file mode 100644 index e52d331e14..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestRelative302Test.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PerRequestRelative302Test; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyPerRequestRelative302Test extends PerRequestRelative302Test { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestTimeoutTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestTimeoutTest.java deleted file mode 100644 index 0a7a16eb7e..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPerRequestTimeoutTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PerRequestTimeoutTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyPerRequestTimeoutTest extends PerRequestTimeoutTest { - - @Override - protected String getExpectedTimeoutMessage() { - return "Timeout exceeded"; - } - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostRedirectGetTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostRedirectGetTest.java deleted file mode 100644 index 54a6c78c24..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostRedirectGetTest.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PostRedirectGetTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyPostRedirectGetTest extends PostRedirectGetTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostWithQSTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostWithQSTest.java deleted file mode 100644 index d9dd8b19b9..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPostWithQSTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PostWithQSTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyPostWithQSTest extends PostWithQSTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTest.java deleted file mode 100644 index 1bfbc7f472..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProxyTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyProxyTest extends ProxyTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTunnelingTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTunnelingTest.java deleted file mode 100644 index 9033261a2c..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyProxyTunnelingTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProxyyTunnellingTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyProxyTunnelingTest extends ProxyyTunnellingTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPutLargeFileTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPutLargeFileTest.java deleted file mode 100644 index c26efc51fc..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyPutLargeFileTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PutLargeFileTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyPutLargeFileTest extends PutLargeFileTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyQueryParametersTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyQueryParametersTest.java deleted file mode 100644 index 8ee03ce466..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyQueryParametersTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.QueryParametersTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyQueryParametersTest extends QueryParametersTest{ - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRC10KTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRC10KTest.java deleted file mode 100644 index 837b10c43a..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRC10KTest.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.RC10KTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyRC10KTest extends RC10KTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRedirectConnectionUsageTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRedirectConnectionUsageTest.java deleted file mode 100644 index 5397cf5fa1..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRedirectConnectionUsageTest.java +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.async.RedirectConnectionUsageTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProviderConfig; -import com.ning.http.client.providers.grizzly.TransportCustomizer; -import org.glassfish.grizzly.filterchain.FilterChainBuilder; -import org.glassfish.grizzly.nio.transport.TCPNIOTransport; -import org.glassfish.grizzly.strategies.SameThreadIOStrategy; - -import static com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProviderConfig.Property.TRANSPORT_CUSTOMIZER; - -public class GrizzlyRedirectConnectionUsageTest extends RedirectConnectionUsageTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Override - protected AsyncHttpProviderConfig getProviderConfig() { - final GrizzlyAsyncHttpProviderConfig config = new GrizzlyAsyncHttpProviderConfig(); - config.addProperty(TRANSPORT_CUSTOMIZER, new TransportCustomizer() { - @Override - public void customize(TCPNIOTransport transport, FilterChainBuilder builder) { - if (System.getProperty("blockingio") != null) { - transport.configureBlocking(true); - } - transport.setIOStrategy(SameThreadIOStrategy.getInstance()); - } - }); - return config; - } -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRelative302Test.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRelative302Test.java deleted file mode 100644 index 684f758353..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRelative302Test.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.Relative302Test; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyRelative302Test extends Relative302Test { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRemoteSiteTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRemoteSiteTest.java deleted file mode 100644 index 23b8b217bb..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRemoteSiteTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.RemoteSiteTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyRemoteSiteTest extends RemoteSiteTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRetryRequestTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRetryRequestTest.java deleted file mode 100644 index 20b7cca957..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyRetryRequestTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.RetryRequestTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyRetryRequestTest extends RetryRequestTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlySimpleAsyncHttpClientTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlySimpleAsyncHttpClientTest.java deleted file mode 100644 index 34709e2d62..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlySimpleAsyncHttpClientTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.SimpleAsyncHttpClientTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlySimpleAsyncHttpClientTest extends SimpleAsyncHttpClientTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyTransferListenerTest.java b/src/test/java/com/ning/http/client/async/grizzly/GrizzlyTransferListenerTest.java deleted file mode 100644 index 90181ac0a5..0000000000 --- a/src/test/java/com/ning/http/client/async/grizzly/GrizzlyTransferListenerTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.TransferListenerTest; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; - -public class GrizzlyTransferListenerTest extends TransferListenerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyAsyncHttpProviderTest.java b/src/test/java/com/ning/http/client/async/netty/NettyAsyncHttpProviderTest.java deleted file mode 100644 index 0ee45a5752..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyAsyncHttpProviderTest.java +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.Response; -import com.ning.http.client.async.AbstractBasicTest; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; -import org.testng.annotations.Test; - -import java.util.concurrent.Executors; - -import static org.testng.Assert.assertEquals; - -public class NettyAsyncHttpProviderTest extends AbstractBasicTest { - - @Test - public void bossThreadPoolExecutor() throws Throwable { - NettyAsyncHttpProviderConfig conf = new NettyAsyncHttpProviderConfig(); - conf.addProperty(NettyAsyncHttpProviderConfig.BOSS_EXECUTOR_SERVICE, Executors.newSingleThreadExecutor()); - - AsyncHttpClientConfig cf = new AsyncHttpClientConfig.Builder().setAsyncHttpClientProviderConfig(conf).build(); - AsyncHttpClient c = getAsyncHttpClient(cf); - - Response r = c.prepareGet(getTargetUrl()).execute().get(); - assertEquals(r.getStatusCode(), 200); - } - - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyAsyncProviderBasicTest.java b/src/test/java/com/ning/http/client/async/netty/NettyAsyncProviderBasicTest.java deleted file mode 100644 index 4292c85f6f..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyAsyncProviderBasicTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.async.AsyncProvidersBasicTest; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; - -public class NettyAsyncProviderBasicTest extends AsyncProvidersBasicTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - - @Override - protected AsyncHttpProviderConfig getProviderConfig() { - final NettyAsyncHttpProviderConfig config = - new NettyAsyncHttpProviderConfig(); - config.addProperty("tcpNoDelay", true); - return config; - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamHandlerTest.java b/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamHandlerTest.java deleted file mode 100644 index 7319d3209d..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamHandlerTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AsyncStreamHandlerTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyAsyncStreamHandlerTest extends AsyncStreamHandlerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamLifecycleTest.java b/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamLifecycleTest.java deleted file mode 100644 index fe1fc56293..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyAsyncStreamLifecycleTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AsyncStreamLifecycleTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyAsyncStreamLifecycleTest extends AsyncStreamLifecycleTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyAuthTimeoutTest.java b/src/test/java/com/ning/http/client/async/netty/NettyAuthTimeoutTest.java deleted file mode 100644 index e99c586fd1..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyAuthTimeoutTest.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AuthTimeoutTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyAuthTimeoutTest extends AuthTimeoutTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyBasicAuthTest.java b/src/test/java/com/ning/http/client/async/netty/NettyBasicAuthTest.java deleted file mode 100644 index 0dc441b15d..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyBasicAuthTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BasicAuthTest; -import com.ning.http.client.async.ProviderUtil; -import org.testng.annotations.Test; - -import java.util.concurrent.ExecutionException; -import java.util.concurrent.TimeoutException; - -public class NettyBasicAuthTest extends BasicAuthTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - - @Override - @Test - public void redirectAndBasicAuthTest() throws Exception, ExecutionException, TimeoutException, InterruptedException { - super.redirectAndBasicAuthTest(); //To change body of overridden methods use File | Settings | File Templates. - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyBasicHttpsTest.java b/src/test/java/com/ning/http/client/async/netty/NettyBasicHttpsTest.java deleted file mode 100644 index 1b205a900e..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyBasicHttpsTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BasicHttpsTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyBasicHttpsTest extends BasicHttpsTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyBodyChunkTest.java b/src/test/java/com/ning/http/client/async/netty/NettyBodyChunkTest.java deleted file mode 100644 index 7f06d611cb..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyBodyChunkTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BodyChunkTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyBodyChunkTest extends BodyChunkTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyBodyDeferringAsyncHandlerTest.java b/src/test/java/com/ning/http/client/async/netty/NettyBodyDeferringAsyncHandlerTest.java deleted file mode 100644 index 8e71e559fb..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyBodyDeferringAsyncHandlerTest.java +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.BodyDeferringAsyncHandlerTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyBodyDeferringAsyncHandlerTest extends - BodyDeferringAsyncHandlerTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyByteBufferCapacityTest.java b/src/test/java/com/ning/http/client/async/netty/NettyByteBufferCapacityTest.java deleted file mode 100644 index 0d1d9ef43b..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyByteBufferCapacityTest.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.AbstractBasicTest; -import com.ning.http.client.async.ByteBufferCapacityTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyByteBufferCapacityTest extends ByteBufferCapacityTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyChunkingTest.java b/src/test/java/com/ning/http/client/async/netty/NettyChunkingTest.java deleted file mode 100644 index c41b876fc8..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyChunkingTest.java +++ /dev/null @@ -1,13 +0,0 @@ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ChunkingTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyChunkingTest extends ChunkingTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyComplexClientTest.java b/src/test/java/com/ning/http/client/async/netty/NettyComplexClientTest.java deleted file mode 100644 index bc13266c08..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyComplexClientTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ComplexClientTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyComplexClientTest extends ComplexClientTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyConnectionPoolTest.java b/src/test/java/com/ning/http/client/async/netty/NettyConnectionPoolTest.java deleted file mode 100644 index 3c1720e2cc..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyConnectionPoolTest.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ConnectionPoolTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyConnectionPoolTest extends ConnectionPoolTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyDigestAuthTest.java b/src/test/java/com/ning/http/client/async/netty/NettyDigestAuthTest.java deleted file mode 100644 index 78f5b31da2..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyDigestAuthTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.DigestAuthTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyDigestAuthTest extends DigestAuthTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyEmptyBodyTest.java b/src/test/java/com/ning/http/client/async/netty/NettyEmptyBodyTest.java deleted file mode 100644 index d054056481..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyEmptyBodyTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.EmptyBodyTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyEmptyBodyTest extends EmptyBodyTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyErrorResponseTest.java b/src/test/java/com/ning/http/client/async/netty/NettyErrorResponseTest.java deleted file mode 100644 index 80bcdc71ac..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyErrorResponseTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ErrorResponseTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyErrorResponseTest extends ErrorResponseTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyExpect100ContinueTest.java b/src/test/java/com/ning/http/client/async/netty/NettyExpect100ContinueTest.java deleted file mode 100644 index 6da18e7800..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyExpect100ContinueTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.Expect100ContinueTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyExpect100ContinueTest extends Expect100ContinueTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyFilePartLargeFileTest.java b/src/test/java/com/ning/http/client/async/netty/NettyFilePartLargeFileTest.java deleted file mode 100644 index 108c6ef4e5..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyFilePartLargeFileTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.FilePartLargeFileTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyFilePartLargeFileTest extends FilePartLargeFileTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyFilterTest.java b/src/test/java/com/ning/http/client/async/netty/NettyFilterTest.java deleted file mode 100644 index df3b65a952..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyFilterTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.FilterTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyFilterTest extends FilterTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyFollowingThreadTest.java b/src/test/java/com/ning/http/client/async/netty/NettyFollowingThreadTest.java deleted file mode 100644 index 0a8ee879e6..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyFollowingThreadTest.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.FollowingThreadTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyFollowingThreadTest extends FollowingThreadTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} - diff --git a/src/test/java/com/ning/http/client/async/netty/NettyHead302Test.java b/src/test/java/com/ning/http/client/async/netty/NettyHead302Test.java deleted file mode 100644 index b6e319f9fe..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyHead302Test.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.Head302Test; -import com.ning.http.client.async.ProviderUtil; - -public class NettyHead302Test extends Head302Test { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyHostnameVerifierTest.java b/src/test/java/com/ning/http/client/async/netty/NettyHostnameVerifierTest.java deleted file mode 100644 index d3897390db..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyHostnameVerifierTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.HostnameVerifierTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyHostnameVerifierTest extends HostnameVerifierTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyHttpToHttpsRedirectTest.java b/src/test/java/com/ning/http/client/async/netty/NettyHttpToHttpsRedirectTest.java deleted file mode 100644 index ca7d73917c..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyHttpToHttpsRedirectTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.HttpToHttpsRedirectTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyHttpToHttpsRedirectTest extends HttpToHttpsRedirectTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyIdleStateHandlerTest.java b/src/test/java/com/ning/http/client/async/netty/NettyIdleStateHandlerTest.java deleted file mode 100644 index 45d927879f..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyIdleStateHandlerTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.IdleStateHandlerTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyIdleStateHandlerTest extends IdleStateHandlerTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyInputStreamTest.java b/src/test/java/com/ning/http/client/async/netty/NettyInputStreamTest.java deleted file mode 100644 index 4d894bb6d5..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyInputStreamTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.InputStreamTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyInputStreamTest extends InputStreamTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyListenableFutureTest.java b/src/test/java/com/ning/http/client/async/netty/NettyListenableFutureTest.java deleted file mode 100644 index 3d4208736b..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyListenableFutureTest.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ListenableFutureTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyListenableFutureTest extends ListenableFutureTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyMaxConnectionsInThreads.java b/src/test/java/com/ning/http/client/async/netty/NettyMaxConnectionsInThreads.java deleted file mode 100644 index c0caf08e8f..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyMaxConnectionsInThreads.java +++ /dev/null @@ -1,24 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2010-2012 Sonatype, Inc. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * and Apache License v2.0 which accompanies this distribution. - * The Eclipse Public License is available at - * http://www.eclipse.org/legal/epl-v10.html - * The Apache License v2.0 is available at - * http://www.apache.org/licenses/LICENSE-2.0.html - * You may elect to redistribute this code under either of these licenses. - *******************************************************************************/ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MaxConnectionsInThreads; -import com.ning.http.client.async.ProviderUtil; - -public class NettyMaxConnectionsInThreads extends MaxConnectionsInThreads { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyMaxTotalConnectionTest.java b/src/test/java/com/ning/http/client/async/netty/NettyMaxTotalConnectionTest.java deleted file mode 100644 index 6ebfc78c37..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyMaxTotalConnectionTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MaxTotalConnectionTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyMaxTotalConnectionTest extends MaxTotalConnectionTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyMultipartUploadTest.java b/src/test/java/com/ning/http/client/async/netty/NettyMultipartUploadTest.java deleted file mode 100644 index 1219230844..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyMultipartUploadTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MultipartUploadTest; -import com.ning.http.client.async.ProviderUtil; - -/** - * @author dominict - */ -public class NettyMultipartUploadTest extends MultipartUploadTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyMultipleHeaderTest.java b/src/test/java/com/ning/http/client/async/netty/NettyMultipleHeaderTest.java deleted file mode 100644 index 044b66c7e2..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyMultipleHeaderTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.MultipleHeaderTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyMultipleHeaderTest extends MultipleHeaderTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyNoNullResponseTest.java b/src/test/java/com/ning/http/client/async/netty/NettyNoNullResponseTest.java deleted file mode 100644 index ae74b2a27d..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyNoNullResponseTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.NoNullResponseTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyNoNullResponseTest extends NoNullResponseTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyNonAsciiContentLengthTest.java b/src/test/java/com/ning/http/client/async/netty/NettyNonAsciiContentLengthTest.java deleted file mode 100644 index 227dc1b7e9..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyNonAsciiContentLengthTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.NonAsciiContentLengthTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyNonAsciiContentLengthTest extends NonAsciiContentLengthTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyParamEncodingTest.java b/src/test/java/com/ning/http/client/async/netty/NettyParamEncodingTest.java deleted file mode 100644 index 4af58fb989..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyParamEncodingTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ParamEncodingTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyParamEncodingTest extends ParamEncodingTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyPerRequestRelative302Test.java b/src/test/java/com/ning/http/client/async/netty/NettyPerRequestRelative302Test.java deleted file mode 100644 index 0c941b7cde..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyPerRequestRelative302Test.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PerRequestRelative302Test; -import com.ning.http.client.async.ProviderUtil; - -public class NettyPerRequestRelative302Test extends PerRequestRelative302Test { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyPerRequestTimeoutTest.java b/src/test/java/com/ning/http/client/async/netty/NettyPerRequestTimeoutTest.java deleted file mode 100644 index 6b74df734b..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyPerRequestTimeoutTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PerRequestTimeoutTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyPerRequestTimeoutTest extends PerRequestTimeoutTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyPostRedirectGetTest.java b/src/test/java/com/ning/http/client/async/netty/NettyPostRedirectGetTest.java deleted file mode 100644 index da85212abf..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyPostRedirectGetTest.java +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright (c) 2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PostRedirectGetTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyPostRedirectGetTest extends PostRedirectGetTest { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyPostWithQSTest.java b/src/test/java/com/ning/http/client/async/netty/NettyPostWithQSTest.java deleted file mode 100644 index 40ea0a09c6..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyPostWithQSTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.PostWithQSTest; -import com.ning.http.client.async.ProviderUtil; - -public class NettyPostWithQSTest extends PostWithQSTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyProxyTest.java b/src/test/java/com/ning/http/client/async/netty/NettyProxyTest.java deleted file mode 100644 index 2a3326320a..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyProxyTest.java +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.ProxyTest; - -public class NettyProxyTest extends ProxyTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - -} - - - diff --git a/src/test/java/com/ning/http/client/async/netty/NettyProxyTunnellingTest.java b/src/test/java/com/ning/http/client/async/netty/NettyProxyTunnellingTest.java deleted file mode 100644 index b0a8f6fa1d..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyProxyTunnellingTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.ProxyyTunnellingTest; - -public class NettyProxyTunnellingTest extends ProxyyTunnellingTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyPutLargeFileTest.java b/src/test/java/com/ning/http/client/async/netty/NettyPutLargeFileTest.java deleted file mode 100644 index e2deb01594..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyPutLargeFileTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.PutLargeFileTest; - -public class NettyPutLargeFileTest extends PutLargeFileTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyQueryParametersTest.java b/src/test/java/com/ning/http/client/async/netty/NettyQueryParametersTest.java deleted file mode 100644 index fcbf8e4708..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyQueryParametersTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.QueryParametersTest; - -public class NettyQueryParametersTest extends QueryParametersTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyRC10KTest.java b/src/test/java/com/ning/http/client/async/netty/NettyRC10KTest.java deleted file mode 100644 index e230b74d3d..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyRC10KTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.RC10KTest; - -public class NettyRC10KTest extends RC10KTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyRedirectConnectionUsageTest.java b/src/test/java/com/ning/http/client/async/netty/NettyRedirectConnectionUsageTest.java deleted file mode 100644 index 201b13e28a..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyRedirectConnectionUsageTest.java +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.AsyncHttpProviderConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.RedirectConnectionUsageTest; -import com.ning.http.client.providers.netty.NettyAsyncHttpProviderConfig; - -public class NettyRedirectConnectionUsageTest extends RedirectConnectionUsageTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - - @Override - protected AsyncHttpProviderConfig getProviderConfig() { - final NettyAsyncHttpProviderConfig config = - new NettyAsyncHttpProviderConfig(); - if (System.getProperty("blockingio") != null) { - config.addProperty(NettyAsyncHttpProviderConfig.USE_BLOCKING_IO, "true"); - } - return config; - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyRelative302Test.java b/src/test/java/com/ning/http/client/async/netty/NettyRelative302Test.java deleted file mode 100644 index ab0c059d55..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyRelative302Test.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.Relative302Test; - -public class NettyRelative302Test extends Relative302Test { - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyRemoteSiteTest.java b/src/test/java/com/ning/http/client/async/netty/NettyRemoteSiteTest.java deleted file mode 100644 index 9e3d1292ce..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyRemoteSiteTest.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.RemoteSiteTest; - -public class NettyRemoteSiteTest extends RemoteSiteTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } - - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyRetryRequestTest.java b/src/test/java/com/ning/http/client/async/netty/NettyRetryRequestTest.java deleted file mode 100644 index 2adeb73fe0..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyRetryRequestTest.java +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ - -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.RetryRequestTest; - -public class NettyRetryRequestTest extends RetryRequestTest{ - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettySimpleAsyncHttpClientTest.java b/src/test/java/com/ning/http/client/async/netty/NettySimpleAsyncHttpClientTest.java deleted file mode 100644 index 249e0ebbdf..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettySimpleAsyncHttpClientTest.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.SimpleAsyncHttpClientTest; - -public class NettySimpleAsyncHttpClientTest extends SimpleAsyncHttpClientTest { - - /** - * Not Used with {@link com.ning.http.client.SimpleAsyncHttpClient} - * @param config - * @return - */ - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return null; - } - -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyTransferListenerTest.java b/src/test/java/com/ning/http/client/async/netty/NettyTransferListenerTest.java deleted file mode 100644 index 7a08f95eef..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyTransferListenerTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.TransferListenerTest; - -public class NettyTransferListenerTest extends TransferListenerTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyWebDavBasicTest.java b/src/test/java/com/ning/http/client/async/netty/NettyWebDavBasicTest.java deleted file mode 100644 index 73edd30f95..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyWebDavBasicTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.WebDavBasicTest; - -public class NettyWebDavBasicTest extends WebDavBasicTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/async/netty/NettyZeroCopyFileTest.java b/src/test/java/com/ning/http/client/async/netty/NettyZeroCopyFileTest.java deleted file mode 100644 index c1cc524802..0000000000 --- a/src/test/java/com/ning/http/client/async/netty/NettyZeroCopyFileTest.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.async.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.async.TransferListenerTest; -import com.ning.http.client.async.ZeroCopyFileTest; - -public class NettyZeroCopyFileTest extends ZeroCopyFileTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/oauth/TestSignatureCalculator.java b/src/test/java/com/ning/http/client/oauth/TestSignatureCalculator.java deleted file mode 100644 index e75a1e981a..0000000000 --- a/src/test/java/com/ning/http/client/oauth/TestSignatureCalculator.java +++ /dev/null @@ -1,53 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.client.oauth; - -import org.testng.Assert; -import org.testng.annotations.Test; - -import com.ning.http.client.FluentStringsMap; - -public class TestSignatureCalculator -{ - private static final String CONSUMER_KEY = "dpf43f3p2l4k3l03"; - - private static final String CONSUMER_SECRET = "kd94hf93k423kf44"; - - public static final String TOKEN_KEY = "nnch734d00sl2jdk"; - - public static final String TOKEN_SECRET = "pfkkdhi9sl3r4s00"; - - public static final String NONCE = "kllo9940pd9333jh"; - - final static long TIMESTAMP = 1191242096; - - // based on the reference test case from - // http://oauth.pbwiki.com/TestCases - @Test(groups="fast") - public void test() - { - ConsumerKey consumer = new ConsumerKey(CONSUMER_KEY, CONSUMER_SECRET); - RequestToken user = new RequestToken(TOKEN_KEY, TOKEN_SECRET); - OAuthSignatureCalculator calc = new OAuthSignatureCalculator(consumer, user); - FluentStringsMap queryParams = new FluentStringsMap(); - queryParams.add("file", "vacation.jpg"); - queryParams.add("size", "original"); - String url = "http://photos.example.net/photos"; - String sig = calc.calculateSignature("GET", url, TIMESTAMP, NONCE, null, queryParams); - - Assert.assertEquals("tR3+Ty81lMeYAr/Fid0kMTYa/WM=", sig); - } -} diff --git a/src/test/java/com/ning/http/client/providers/netty/NettyAsyncResponseTest.java b/src/test/java/com/ning/http/client/providers/netty/NettyAsyncResponseTest.java deleted file mode 100644 index c49eee8dc2..0000000000 --- a/src/test/java/com/ning/http/client/providers/netty/NettyAsyncResponseTest.java +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -package com.ning.http.client.providers.netty; - -import com.ning.http.client.Cookie; -import com.ning.http.client.FluentCaseInsensitiveStringsMap; -import com.ning.http.client.HttpResponseHeaders; -import org.testng.annotations.Test; - -import java.text.SimpleDateFormat; -import java.util.Date; -import java.util.List; -import java.util.Locale; -import java.util.TimeZone; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertTrue; - -/** - * @author Benjamin Hanzelmann - */ -public class NettyAsyncResponseTest { - - @Test(groups = "standalone") - public void testCookieParseExpires() { - // e.g. "Sun, 06-Feb-2012 03:45:24 GMT"; - SimpleDateFormat sdf = new SimpleDateFormat("EEE, dd-MMM-yyyy HH:mm:ss z", Locale.US); - sdf.setTimeZone(TimeZone.getTimeZone("GMT")); - - Date date = new Date(System.currentTimeMillis() + 60000); // sdf.parse( dateString ); - final String cookieDef = String.format("efmembercheck=true; expires=%s; path=/; domain=.eclipse.org", sdf.format(date)); - - NettyResponse response = new NettyResponse(new ResponseStatus(null, null, null), new HttpResponseHeaders(null, null, false) { - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return new FluentCaseInsensitiveStringsMap().add("Set-Cookie", cookieDef); - } - }, null); - - List cookies = response.getCookies(); - assertEquals(cookies.size(), 1); - - Cookie cookie = cookies.get(0); - assertTrue(cookie.getMaxAge() > 55 && cookie.getMaxAge() < 61, ""); - } - - @Test(groups = "standalone") - public void testCookieParseMaxAge() { - final String cookieDef = "efmembercheck=true; max-age=60; path=/; domain=.eclipse.org"; - NettyResponse response = new NettyResponse(new ResponseStatus(null, null, null), new HttpResponseHeaders(null, null, false) { - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return new FluentCaseInsensitiveStringsMap().add("Set-Cookie", cookieDef); - } - }, null); - List cookies = response.getCookies(); - assertEquals(cookies.size(), 1); - - Cookie cookie = cookies.get(0); - assertEquals(cookie.getMaxAge(), 60); - } - - @Test(groups = "standalone") - public void testCookieParseWeirdExpiresValue() { - final String cookieDef = "efmembercheck=true; expires=60; path=/; domain=.eclipse.org"; - NettyResponse response = new NettyResponse(new ResponseStatus(null, null, null), new HttpResponseHeaders(null, null, false) { - @Override - public FluentCaseInsensitiveStringsMap getHeaders() { - return new FluentCaseInsensitiveStringsMap().add("Set-Cookie", cookieDef); - } - }, null); - - List cookies = response.getCookies(); - assertEquals(cookies.size(), 1); - - Cookie cookie = cookies.get(0); - assertEquals(cookie.getMaxAge(), 60); - } - -} diff --git a/src/test/java/com/ning/http/client/resumable/MapResumableProcessor.java b/src/test/java/com/ning/http/client/resumable/MapResumableProcessor.java deleted file mode 100644 index 2e5734969f..0000000000 --- a/src/test/java/com/ning/http/client/resumable/MapResumableProcessor.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.ning.http.client.resumable; - -import com.ning.http.client.resumable.ResumableAsyncHandler.ResumableProcessor; - -import java.util.HashMap; -import java.util.Map; - -/** - * @author Benjamin Hanzelmann - */ -public class MapResumableProcessor - implements ResumableProcessor { - - Map map = new HashMap(); - - public void put(String key, long transferredBytes) { - map.put(key, transferredBytes); - } - - public void remove(String key) { - map.remove(key); - } - - /** - * NOOP - */ - public void save(Map map) { - - } - - /** - * NOOP - */ - public Map load() { - return map; - } -} \ No newline at end of file diff --git a/src/test/java/com/ning/http/client/resumable/PropertiesBasedResumableProcesserTest.java b/src/test/java/com/ning/http/client/resumable/PropertiesBasedResumableProcesserTest.java deleted file mode 100644 index 41d0d68947..0000000000 --- a/src/test/java/com/ning/http/client/resumable/PropertiesBasedResumableProcesserTest.java +++ /dev/null @@ -1,40 +0,0 @@ -package com.ning.http.client.resumable; - -/* - * Copyright (c) 2010 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -import org.testng.annotations.Test; - -import java.util.Map; - -import static org.testng.Assert.assertEquals; - -/** - * @author Benjamin Hanzelmann - */ -public class PropertiesBasedResumableProcesserTest { - @Test (enabled = false) - public void testSaveLoad() - throws Exception { - PropertiesBasedResumableProcessor p = new PropertiesBasedResumableProcessor(); - p.put("http://localhost/test.url", 15L); - p.put("http://localhost/test2.url", 50L); - p.save(null); - p = new PropertiesBasedResumableProcessor(); - Map m = p.load(); - assertEquals(m.size(), 2); - assertEquals(m.get("http://localhost/test.url"), Long.valueOf(15L)); - assertEquals(m.get("http://localhost/test2.url"), Long.valueOf(50L)); - } - -} diff --git a/src/test/java/com/ning/http/client/resumable/ResumableAsyncHandlerTest.java b/src/test/java/com/ning/http/client/resumable/ResumableAsyncHandlerTest.java deleted file mode 100644 index 8c9160eb37..0000000000 --- a/src/test/java/com/ning/http/client/resumable/ResumableAsyncHandlerTest.java +++ /dev/null @@ -1,45 +0,0 @@ -package com.ning.http.client.resumable; - -/* - * Copyright (c) 2010 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ - -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import com.ning.http.client.Response; -import org.testng.annotations.Test; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertNull; - -/** - * @author Benjamin Hanzelmann - */ -public class ResumableAsyncHandlerTest { - @Test - public void testAdjustRange() { - MapResumableProcessor proc = new MapResumableProcessor(); - - ResumableAsyncHandler h = new ResumableAsyncHandler(proc); - Request request = new RequestBuilder("GET").setUrl("http://test/url").build(); - Request newRequest = h.adjustRequestRange(request); - assertEquals(newRequest.getUrl(), request.getUrl()); - String rangeHeader = newRequest.getHeaders().getFirstValue("Range"); - assertNull(rangeHeader); - - proc.put("http://test/url", 5000); - newRequest = h.adjustRequestRange(request); - assertEquals(newRequest.getUrl(), request.getUrl()); - rangeHeader = newRequest.getHeaders().getFirstValue("Range"); - assertEquals(rangeHeader, "bytes=5000-"); - } -} diff --git a/src/test/java/com/ning/http/client/websocket/AbstractBasicTest.java b/src/test/java/com/ning/http/client/websocket/AbstractBasicTest.java deleted file mode 100644 index a3bf5a6382..0000000000 --- a/src/test/java/com/ning/http/client/websocket/AbstractBasicTest.java +++ /dev/null @@ -1,107 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import org.eclipse.jetty.server.Request; -import org.eclipse.jetty.server.Server; -import org.eclipse.jetty.server.handler.HandlerWrapper; -import org.eclipse.jetty.server.nio.SelectChannelConnector; -import org.eclipse.jetty.websocket.WebSocketFactory; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.testng.annotations.AfterClass; -import org.testng.annotations.BeforeClass; - -import javax.servlet.ServletException; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.net.ServerSocket; - -public abstract class AbstractBasicTest extends Server { - - public abstract class WebSocketHandler extends HandlerWrapper implements WebSocketFactory.Acceptor { - private final WebSocketFactory _webSocketFactory = new WebSocketFactory(this, 32 * 1024); - - public WebSocketHandler(){ - _webSocketFactory.setMaxIdleTime(10000); - } - - public WebSocketFactory getWebSocketFactory() { - return _webSocketFactory; - } - - /* ------------------------------------------------------------ */ - @Override - public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { - if (_webSocketFactory.acceptWebSocket(request, response) || response.isCommitted()) - return; - super.handle(target, baseRequest, request, response); - } - - /* ------------------------------------------------------------ */ - public boolean checkOrigin(HttpServletRequest request, String origin) { - return true; - } - - } - - protected final Logger log = LoggerFactory.getLogger(AbstractBasicTest.class); - protected int port1; - SelectChannelConnector _connector; - - @AfterClass(alwaysRun = true) - public void tearDownGlobal() throws Exception { - stop(); - } - - protected int findFreePort() throws IOException { - ServerSocket socket = null; - - try { - socket = new ServerSocket(0); - - return socket.getLocalPort(); - } finally { - if (socket != null) { - socket.close(); - } - } - } - - protected String getTargetUrl() { - return String.format("ws://127.0.0.1:%d/", port1); - } - - @BeforeClass(alwaysRun = true) - public void setUpGlobal() throws Exception { - port1 = findFreePort(); - _connector = new SelectChannelConnector(); - _connector.setPort(port1); - - addConnector(_connector); - WebSocketHandler _wsHandler = getWebSocketHandler(); - - setHandler(_wsHandler); - - start(); - log.info("Local HTTP server started successfully"); - } - - public abstract WebSocketHandler getWebSocketHandler() ; - - public abstract AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config); - -} diff --git a/src/test/java/com/ning/http/client/websocket/ByteMessageTest.java b/src/test/java/com/ning/http/client/websocket/ByteMessageTest.java deleted file mode 100644 index 0566cd9ad4..0000000000 --- a/src/test/java/com/ning/http/client/websocket/ByteMessageTest.java +++ /dev/null @@ -1,249 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import org.testng.annotations.Test; - -import javax.servlet.http.HttpServletRequest; -import java.io.IOException; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.atomic.AtomicReference; - -import static org.testng.Assert.assertEquals; - -public abstract class ByteMessageTest extends AbstractBasicTest { - - private final class EchoByteWebSocket implements org.eclipse.jetty.websocket.WebSocket, org.eclipse.jetty.websocket.WebSocket.OnBinaryMessage { - - private Connection connection; - - @Override - public void onOpen(Connection connection) { - this.connection = connection; - connection.setMaxBinaryMessageSize(1000); - } - - @Override - public void onClose(int i, String s) { - connection.close(); - } - - @Override - public void onMessage(byte[] bytes, int i, int i1) { - try { - connection.sendMessage(bytes, i, i1); - } catch (IOException e) { - try { - connection.sendMessage("FAIL"); - } catch (IOException e1) { - e1.printStackTrace(); - } - } - } - } - - @Override - public WebSocketHandler getWebSocketHandler() { - return new WebSocketHandler() { - @Override - public org.eclipse.jetty.websocket.WebSocket doWebSocketConnect(HttpServletRequest httpServletRequest, String s) { - return new EchoByteWebSocket(); - } - }; - } - - @Test - public void echoByte() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(new byte[0]); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketByteListener() { - - @Override - public void onOpen(WebSocket websocket) { - } - - @Override - public void onClose(WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - - @Override - public void onMessage(byte[] message) { - text.set(message); - latch.countDown(); - } - - @Override - public void onFragment(byte[] fragment, boolean last) { - } - }).build()).get(); - - websocket.sendMessage("ECHO".getBytes()); - - latch.await(); - assertEquals(text.get(), "ECHO".getBytes()); - } - - @Test - public void echoTwoMessagesTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(2); - final AtomicReference text = new AtomicReference(null); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketByteListener() { - - @Override - public void onOpen(WebSocket websocket) { - } - - @Override - public void onClose(WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - - @Override - public void onMessage(byte[] message) { - if (text.get() == null) { - text.set(message); - } else { - byte[] n = new byte[text.get().length + message.length]; - System.arraycopy(text.get(), 0, n, 0, text.get().length); - System.arraycopy(message, 0, n, text.get().length, message.length); - text.set(n); - } - latch.countDown(); - } - - @Override - public void onFragment(byte[] fragment, boolean last) { - } - }).build()).get(); - - websocket.sendMessage("ECHO".getBytes()).sendMessage("ECHO".getBytes()); - - latch.await(); - assertEquals(text.get(), "ECHOECHO".getBytes()); - } - - @Test - public void echoOnOpenMessagesTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(2); - final AtomicReference text = new AtomicReference(null); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketByteListener() { - - @Override - public void onOpen(WebSocket websocket) { - websocket.sendMessage("ECHO".getBytes()).sendMessage("ECHO".getBytes()); - } - - @Override - public void onClose(WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - - @Override - public void onMessage(byte[] message) { - if (text.get() == null) { - text.set(message); - } else { - byte[] n = new byte[text.get().length + message.length]; - System.arraycopy(text.get(), 0, n, 0, text.get().length); - System.arraycopy(message, 0, n, text.get().length, message.length); - text.set(n); - } - latch.countDown(); - } - - @Override - public void onFragment(byte[] fragment, boolean last) { - } - }).build()).get(); - - latch.await(); - assertEquals(text.get(), "ECHOECHO".getBytes()); - } - - - public void echoFragments() throws Exception { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(null); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketByteListener() { - - @Override - public void onOpen(WebSocket websocket) { - } - - @Override - public void onClose(WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - - @Override - public void onMessage(byte[] message) { - if (text.get() == null) { - text.set(message); - } else { - byte[] n = new byte[text.get().length + message.length]; - System.arraycopy(text.get(), 0, n, 0, text.get().length); - System.arraycopy(message, 0, n, text.get().length, message.length); - text.set(n); - } - latch.countDown(); - } - - @Override - public void onFragment(byte[] fragment, boolean last) { - } - }).build()).get(); - websocket.stream("ECHO".getBytes(), false); - websocket.stream("ECHO".getBytes(), true); - latch.await(); - assertEquals(text.get(), "ECHOECHO".getBytes()); - } -} diff --git a/src/test/java/com/ning/http/client/websocket/TextMessageTest.java b/src/test/java/com/ning/http/client/websocket/TextMessageTest.java deleted file mode 100644 index 769d2ff3f7..0000000000 --- a/src/test/java/com/ning/http/client/websocket/TextMessageTest.java +++ /dev/null @@ -1,389 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import org.testng.annotations.Test; - -import javax.servlet.http.HttpServletRequest; -import java.io.IOException; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.atomic.AtomicReference; - -import static org.testng.Assert.assertEquals; -import static org.testng.Assert.assertTrue; -import static org.testng.Assert.fail; - -public abstract class TextMessageTest extends AbstractBasicTest { - - private final class EchoTextWebSocket implements org.eclipse.jetty.websocket.WebSocket, org.eclipse.jetty.websocket.WebSocket.OnTextMessage { - - private Connection connection; - - @Override - public void onOpen(Connection connection) { - this.connection = connection; - connection.setMaxTextMessageSize(1000); - } - - @Override - public void onClose(int i, String s) { - connection.close(); - } - - @Override - public void onMessage(String s) { - try { - connection.sendMessage(s); - } catch (IOException e) { - try { - connection.sendMessage("FAIL"); - } catch (IOException e1) { - e1.printStackTrace(); - } - } - } - } - - @Override - public WebSocketHandler getWebSocketHandler() { - return new WebSocketHandler() { - @Override - public org.eclipse.jetty.websocket.WebSocket doWebSocketConnect(HttpServletRequest httpServletRequest, String s) { - return new EchoTextWebSocket(); - } - }; - } - - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return null; //To change body of implemented methods use File | Settings | File Templates. - } - - @Test(timeOut = 60000) - public void onOpen() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - text.set("OnOpen"); - latch.countDown(); - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - - latch.await(); - assertEquals(text.get(), "OnOpen"); - } - - @Test(timeOut = 60000) - public void onEmptyListenerTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - - WebSocket websocket = null; - try { - websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().build()).get(); - } catch (Throwable t) { - fail(); - } - assertTrue(websocket != null); - } - - @Test(timeOut = 60000) - public void onFailureTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = null; - Throwable t = null; - try { - websocket = c.prepareGet("ws://abcdefg") - .execute(new WebSocketUpgradeHandler.Builder().build()).get(); - } catch (Throwable t2) { - t = t2; - } - assertTrue(t != null); - } - - @Test(timeOut = 60000) - public void onTimeoutCloseTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - text.set("OnClose"); - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - latch.await(); - assertEquals(text.get(), "OnClose"); - } - - @Test(timeOut = 60000) - public void onClose() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketListener() { - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - text.set("OnClose"); - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - websocket.close(); - - latch.await(); - assertEquals(text.get(), "OnClose"); - } - - @Test(timeOut = 60000) - public void echoText() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - text.set(message); - latch.countDown(); - } - - @Override - public void onFragment(String fragment, boolean last) { - } - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - websocket.sendTextMessage("ECHO"); - - latch.await(); - assertEquals(text.get(), "ECHO"); - } - - @Test(timeOut = 60000) - public void echoDoubleListenerText() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(2); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - text.set(message); - latch.countDown(); - } - - @Override - public void onFragment(String fragment, boolean last) { - } - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - text.set(text.get() + message); - latch.countDown(); - } - - @Override - public void onFragment(String fragment, boolean last) { - } - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - websocket.sendTextMessage("ECHO"); - - latch.await(); - assertEquals(text.get(), "ECHOECHO"); - } - - @Test - public void echoTwoMessagesTest() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(2); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - text.set(text.get() + message); - latch.countDown(); - } - - @Override - public void onFragment(String fragment, boolean last) { - } - - boolean t = false; - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - websocket.sendTextMessage("ECHO").sendTextMessage("ECHO"); - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - latch.await(); - assertEquals(text.get(), "ECHOECHO"); - } - - - public void echoFragments() throws Throwable { - AsyncHttpClient c = getAsyncHttpClient(new AsyncHttpClientConfig.Builder().build()); - final CountDownLatch latch = new CountDownLatch(1); - final AtomicReference text = new AtomicReference(""); - - WebSocket websocket = c.prepareGet(getTargetUrl()) - .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(new WebSocketTextListener() { - - @Override - public void onMessage(String message) { - text.set(message); - latch.countDown(); - } - - @Override - public void onFragment(String fragment, boolean last) { - } - - @Override - public void onOpen(com.ning.http.client.websocket.WebSocket websocket) { - } - - @Override - public void onClose(com.ning.http.client.websocket.WebSocket websocket) { - latch.countDown(); - } - - @Override - public void onError(Throwable t) { - t.printStackTrace(); - latch.countDown(); - } - }).build()).get(); - - websocket.streamText("ECHO", false); - websocket.streamText("ECHO", true); - - latch.await(); - assertEquals(text.get(), "ECHOECHO"); - } - -} diff --git a/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyByteMessageTest.java b/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyByteMessageTest.java deleted file mode 100644 index 5497ba0e6e..0000000000 --- a/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyByteMessageTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import com.ning.http.client.websocket.ByteMessageTest; -import org.testng.annotations.Test; - -public class GrizzlyByteMessageTest extends ByteMessageTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Test(timeOut = 60000) - @Override - public void echoFragments() throws Exception { - super.echoFragments(); - } -} diff --git a/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyTextMessageTest.java b/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyTextMessageTest.java deleted file mode 100644 index bef60cb991..0000000000 --- a/src/test/java/com/ning/http/client/websocket/grizzly/GrizzlyTextMessageTest.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket.grizzly; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.providers.grizzly.GrizzlyAsyncHttpProvider; -import com.ning.http.client.websocket.ByteMessageTest; -import org.testng.annotations.Test; - -public class GrizzlyTextMessageTest extends ByteMessageTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - if (config == null) { - config = new AsyncHttpClientConfig.Builder().build(); - } - return new AsyncHttpClient(new GrizzlyAsyncHttpProvider(config), config); - } - - @Test(timeOut = 60000) - @Override - public void echoFragments() throws Exception { - super.echoFragments(); //To change body of overridden methods use File | Settings | File Templates. - } -} diff --git a/src/test/java/com/ning/http/client/websocket/netty/NettyByteMessageTest.java b/src/test/java/com/ning/http/client/websocket/netty/NettyByteMessageTest.java deleted file mode 100644 index 23e01d43c3..0000000000 --- a/src/test/java/com/ning/http/client/websocket/netty/NettyByteMessageTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.websocket.ByteMessageTest; - -public class NettyByteMessageTest extends ByteMessageTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/client/websocket/netty/NettyTextMessageTest.java b/src/test/java/com/ning/http/client/websocket/netty/NettyTextMessageTest.java deleted file mode 100644 index 2a34358dfb..0000000000 --- a/src/test/java/com/ning/http/client/websocket/netty/NettyTextMessageTest.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.client.websocket.netty; - -import com.ning.http.client.AsyncHttpClient; -import com.ning.http.client.AsyncHttpClientConfig; -import com.ning.http.client.async.ProviderUtil; -import com.ning.http.client.websocket.TextMessageTest; - -public class NettyTextMessageTest extends TextMessageTest { - @Override - public AsyncHttpClient getAsyncHttpClient(AsyncHttpClientConfig config) { - return ProviderUtil.nettyProvider(config); - } -} diff --git a/src/test/java/com/ning/http/util/ProxyUtilsTest.java b/src/test/java/com/ning/http/util/ProxyUtilsTest.java deleted file mode 100644 index 1ccd206a80..0000000000 --- a/src/test/java/com/ning/http/util/ProxyUtilsTest.java +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved. - * - * This program is licensed to you under the Apache License Version 2.0, - * and you may not use this file except in compliance with the Apache License Version 2.0. - * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the Apache License Version 2.0 is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under. - */ -package com.ning.http.util; - -import com.ning.http.client.ProxyServer; -import com.ning.http.client.Request; -import com.ning.http.client.RequestBuilder; -import org.testng.Assert; -import org.testng.annotations.Test; - -public class ProxyUtilsTest { - @Test(groups = "fast") - public void testBasics() { - ProxyServer proxyServer; - Request req; - - // should avoid, there is no proxy (is null) - req = new RequestBuilder("GET").setUrl("http://somewhere.com/foo").build(); - Assert.assertTrue(ProxyUtils.avoidProxy(null, req)); - - // should avoid, it's in non-proxy hosts - req = new RequestBuilder("GET").setUrl("http://somewhere.com/foo").build(); - proxyServer = new ProxyServer("foo", 1234); - proxyServer.addNonProxyHost("somewhere.com"); - Assert.assertTrue(ProxyUtils.avoidProxy(proxyServer, req)); - - // should avoid, it's in non-proxy hosts (with "*") - req = new RequestBuilder("GET").setUrl("http://sub.somewhere.com/foo").build(); - proxyServer = new ProxyServer("foo", 1234); - proxyServer.addNonProxyHost("*.somewhere.com"); - Assert.assertTrue(ProxyUtils.avoidProxy(proxyServer, req)); - - // should use it - req = new RequestBuilder("GET").setUrl("http://sub.somewhere.com/foo").build(); - proxyServer = new ProxyServer("foo", 1234); - proxyServer.addNonProxyHost("*.somewhere.org"); - Assert.assertFalse(ProxyUtils.avoidProxy(proxyServer, req)); - } -} diff --git a/src/test/java/com/ning/http/util/TestUTF8UrlCodec.java b/src/test/java/com/ning/http/util/TestUTF8UrlCodec.java deleted file mode 100644 index e675a1a611..0000000000 --- a/src/test/java/com/ning/http/util/TestUTF8UrlCodec.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright 2010 Ning, Inc. - * - * Ning licenses this file to you under the Apache License, version 2.0 - * (the "License"); you may not use this file except in compliance with the - * License. You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - */ -package com.ning.http.util; - -import org.testng.Assert; -import org.testng.annotations.Test; - -public class TestUTF8UrlCodec -{ - @Test(groups="fast") - public void testBasics() - { - Assert.assertEquals(UTF8UrlEncoder.encode("foobar"), "foobar"); - Assert.assertEquals(UTF8UrlEncoder.encode("a&b"), "a%26b"); - Assert.assertEquals(UTF8UrlEncoder.encode("a+b"), "a%2Bb"); - } -} diff --git a/src/test/resources/ssltest-keystore.jks b/src/test/resources/ssltest-keystore.jks deleted file mode 100644 index a95b7c5f4f..0000000000 Binary files a/src/test/resources/ssltest-keystore.jks and /dev/null differ